cisco.dnac.lan_automation_create_v1 模块 – LAN 自动化创建 V1 资源模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。

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

cisco.dnac 6.0.0 中的新增功能

概要

  • 管理资源 LAN 自动化创建 V1 的创建操作。

  • 调用此 API 以针对给定站点启动 LAN 自动化。

注意

此模块具有相应的 操作插件。

要求

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

  • 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 自动化创建的有效负载。

discoveredDeviceSiteNameHierarchy

字符串

已发现的设备站点名称。

hostNameFileId

字符串

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

hostNamePrefix

字符串

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

ipPools

列表 / 元素=字典

LAN 自动化创建的 ipPools。

ipPoolName

字符串

IP 池的名称。

ipPoolRole

字符串

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

isisDomainPwd

字符串

纯文本格式的 IS-IS 域密码。

mulitcastEnabled

布尔值

启用下层本机组播。

选项

  • 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_v1，

  • 使用的路径为 post /dna/intent/api/v1/lan-automation，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center LAN 自动化 LANAutomationStartV1 文档

LANAutomationStartV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.lan_automation_create_v1:
    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
      hostNameFileId: string
      hostNamePrefix: string
      ipPools:
      - ipPoolName: string
        ipPoolRole: string
      isisDomainPwd: string
      mulitcastEnabled: true
      peerDeviceManagmentIPAddress: string
      primaryDeviceInterfaceNames:
      - string
      primaryDeviceManagmentIPAddress: string
      redistributeIsisToBgp: true

返回值

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

键

描述

dnac_response

字典

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

返回：始终

示例： {"response": {"id": "string", "message": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)