cisco.dnac.lan_automation_v2 模块 – LAN 自动化 V2 资源模块

注意

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

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

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

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

cisco.dnac 6.14.0 中的新增功能

概要 

管理资源 LAN 自动化 V2 的创建操作。
调用 V2 LAN 自动化启动 API，该 API 基于提供的超时或特定设备列表（或两者）支持可选的自动停止处理功能。当满足任一条件时，停止处理将自动执行，无需专门调用停止 API。如果未提供超时或设备列表，则 V2 API 的行为类似于 V1，用户需要调用停止 API 来停止 LAN 自动化处理。使用 V2 API，用户还可以指定可以进行 LAN 自动化的设备级别。

注意

此模块具有相应的 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 自动化 V2 的有效负载。
discoveredDeviceSiteNameHierarchy 字符串	已发现设备的站点名称。
discoveryDevices 列表 / 元素=字典	LAN 自动化 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 自动化 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，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center LAN 自动化 LANAutomationStartV2 文档: LANAutomationStartV2 API 的完整参考。

示例 

- name: Create
  cisco.dnac.lan_automation_v2:
    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)