cisco.dnac.lan_automation 模块 – 局域网自动化的资源模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在剧本中使用它，请指定： cisco.dnac.lan_automation。

cisco.dnac 6.14.0 中的新增功能

概要

  • 此模块表示模块 lan_automation_v2 的别名

注意

此模块具有相应的 action 插件。

要求

执行此模块的主机需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

用于 Cisco DNA Center SDK 以启用调试的标志。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认： 443

dnac_username

别名：user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认： "admin"

dnac_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

字符串

告知 SDK 使用哪个版本的 Cisco DNA Center。

默认： "2.3.7.6"

payload

列表 / 元素=字典

Lan Automation V2 的有效负载。

discoveredDeviceSiteNameHierarchy

字符串

已发现设备的站点名称。

discoveryDevices

列表 / 元素=字典

Lan Automation V2 的 discoveryDevices。

deviceHostName

字符串

设备的主机名。

deviceManagementIPAddress

字符串

设备的管理 IP 地址。

deviceSerialNumber

字符串

设备的序列号。

deviceSiteNameHierarchy

字符串

设备的站点名称层次结构，必须是 discoveredDeviceSiteNameHierarchy 的子站点，如果它不是区域类型，则相同。

discoveryLevel

整数

在主种子设备以下的级别，此会话将通过该级别对新设备进行 LAN 自动化，级别 + 种子 = 层次。级别支持的范围是 1-5，默认级别是 2。

discoveryTimeout

整数

以分钟为单位的发现超时。在此时间之前，不会触发停止处理。在此发现超时之后联系的任何设备都不会被处理，并且会尝试重置和重新加载设备，以将其恢复到 PnP 代理状态，然后才能完成处理。支持的超时范围（以分钟为单位）是 20-10080。如果同时提供了超时和发现设备列表，则将尝试停止处理，以先发生者为准。用户始终可以使用 LAN 自动化删除 API 来强制停止处理。

hostNameFileId

字符串

使用 /dna/intent/api/v1/file/namespace/nw_orch API 获取已在 nw_orch 命名空间中上传的文件的文件 ID。

hostNamePrefix

字符串

分配给已发现设备的主机名前缀。

ipPools

列表 / 元素=字典

Lan Automation V2 的 ipPools。

ipPoolName

字符串

IP 池的名称。

ipPoolRole

字符串

IP 池的角色。支持的角色是 MAIN_POOL 和 PHYSICAL_LINK_POOL。

isisDomainPwd

字符串

纯文本中的 IS-IS 域密码。

multicastEnabled

布尔值

启用下层本机组播。

选项

  • false

  • true

peerDeviceManagmentIPAddress

字符串

对等种子管理 IP 地址。

primaryDeviceInterfaceNames

列表 / 元素=字符串

主种子设备上连接已发现设备的接口列表。

primaryDeviceManagmentIPAddress

字符串

主种子管理 IP 地址。

redistributeIsisToBgp

布尔值

将 LAN 自动化汇总路由通告到 BGP。

选项

  • false

  • true

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求主体的标志。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 lan_automation.LanAutomation.lan_automation_start_v2，

  • 使用的路径是 post /dna/intent/api/v2/lan-automation，

  • 需要注意的是，此模块是 lan_automation_v2 的别名

  • 不支持 check_mode

  • 插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 局域网自动化的文档 LANAutomationStartV2

LANAutomationStartV2 API 的完整参考。

示例

- name: Create
  cisco.dnac.lan_automation:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    payload:
    - discoveredDeviceSiteNameHierarchy: string
      discoveryDevices:
      - deviceHostName: string
        deviceManagementIPAddress: string
        deviceSerialNumber: string
        deviceSiteNameHierarchy: string
      discoveryLevel: 0
      discoveryTimeout: 0
      hostNameFileId: string
      hostNamePrefix: string
      ipPools:
      - ipPoolName: string
        ipPoolRole: string
      isisDomainPwd: string
      multicastEnabled: true
      peerDeviceManagmentIPAddress: string
      primaryDeviceInterfaceNames:
      - string
      primaryDeviceManagmentIPAddress: string
      redistributeIsisToBgp: true

返回值

常见的返回值已在此处记录，以下是此模块独有的字段

键

描述

dnac_response

字典

包含Cisco DNAC Python SDK返回的响应的字典或列表

返回值：始终

示例： {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)