cisco.dnac.provision_intent 模块 – 配置功能的资源模块

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.dnac.provision_intent。

cisco.dnac 6.6.0 中的新增功能

概要 

管理与有线和无线配置相关的操作
重新配置已配置设备的 API
取消配置已配置设备的 API

要求 

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

dnacentersdk == 2.4.5
python >= 3.9

参数 

参数	注释
config 列表 / 元素=字典 / 必填	被管理设备的详细信息列表。
dynamic_interfaces 列表 / 元素=字典	控制器的接口详细信息
interface_gateway 字符串	分配给接口的 IP 地址
interface_ip_address 字符串	分配给接口的 IP 地址
interface_name 字符串	分配给接口的 IP 地址
interface_netmask_in_c_i_d_r 整数	分配给接口的 IP 地址
lag_or_port_number 整数	分配给接口的 IP 地址
vlan_id 整数	分配给接口的 IP 地址
managed_ap_locations 列表 / 元素=字符串	为 AP 分配的站点位置
management_ip_address 字符串 / 必填	管理 IP 地址。
site_name 字符串	需要添加设备的站点名称。
config_verify 布尔值	设置为 True 以在应用 playbook 配置后验证 Cisco Catalyst Center 配置。选项 `false` ← (默认) `true`
dnac_api_task_timeout 整数	定义用于检索任务详细信息的 API 调用的超时时间（秒）。如果在此期间未收到任务详细信息，则流程将结束，并记录超时通知。默认值： `1200`
dnac_debug 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用调试。选项 `false` ← (默认) `true`
dnac_host 字符串 / 必填	Cisco DNA Center 主机名。
dnac_log 布尔值	启用/禁用 playbook 执行日志记录的标志。如果为 true 且提供了 dnac_log_file_path，则 - 在执行位置创建具有指定名称的日志文件。如果为 true 且未提供 dnac_log_file_path，则 - 在执行位置创建名为“dnac.log”的日志文件。如果为 false，则 - 日志记录被禁用。如果日志文件不存在，则 - 根据“dnac_log_append”标志以追加或写入模式创建它。如果日志文件存在，则 - 根据“dnac_log_append”标志将其覆盖或追加。选项 `false` ← (默认) `true`
dnac_log_append 布尔值	确定文件的模式。设置为 True 表示“追加”模式。设置为 False 表示“写入”模式。选项 `false` `true` ← (默认)
dnac_log_file_path 字符串	控制日志记录。如果 dnac_log 为 True，则记录日志。如果未指定路径，则 - 当“dnac_log_append”为 True 时，在当前 Ansible 目录中生成“dnac.log”；追加日志。- 当“dnac_log_append”为 False 时，生成“dnac.log”；覆盖日志。如果指定了路径，则 - 当“dnac_log_append”为 True 时，文件以追加模式打开。- 当“dnac_log_append”为 False 时，文件以写入 (w) 模式打开。- 在共享文件场景中，如果没有追加模式，则每次模块执行后都会覆盖内容。- 对于共享日志文件，将追加设置为 False 用于第一个模块（覆盖）；对于后续模块，将追加设置为 True。默认值： `"dnac.log"`
dnac_log_level 字符串	设置日志级别的阈值。级别等于或高于此级别的消息将被记录。级别按严重性顺序排列 [CRITICAL、ERROR、WARNING、INFO、DEBUG]。 CRITICAL 表示严重的错误会停止程序。仅显示 CRITICAL 消息。 ERROR 表示阻止函数执行的问题。显示 ERROR 和 CRITICAL 消息。 WARNING 表示潜在的未来问题。显示 WARNING、ERROR 和 CRITICAL 消息。 INFO 追踪正常运行。显示 INFO、WARNING、ERROR 和 CRITICAL 消息。 DEBUG 提供详细的诊断信息。显示所有日志消息。默认值： `"WARNING"`
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 字符串	Cisco DNA Center 端口。默认值： `"443"`
dnac_task_poll_interval 整数	指定连续调用 API 以检索任务详细信息之间的间隔（秒）。默认值： `2`
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。默认值： `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
dnac_version 字符串	告知 SDK 使用哪个版本的 Cisco DNA Center。默认值： `"2.2.3.3"`
state 字符串	模块完成后的 DNAC 状态。选项 `"merged"` ← (默认值) `"deleted"`
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法为 sites.Sites.get_site、devices.Devices.get_network_device_by_ip、task.Task.get_task_by_id、sda.Sda.get_provisioned_wired_device、sda.Sda.re_provision_wired_device、sda.Sda.provision_wired_device、wireless.Wireless.provision
使用的路径为 get /dna/intent/api/v1/site get /dna/intent/api/v1/network-device/ip-address/{ipAddress} get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/business/sda/provision-device put /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/wireless/provision
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

示例 

- name: Create/Modify a new provision
  cisco.dnac.provision_intent:
    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}}"
    dnac_log: True
    state: merged
    config:
        - site_name: string
          management_ip_address: string
          managed_ap_locations: list
          dynamic_interfaces:
            - vlan_id: integer
              interface_name: string
              interface_ip_address: string
              interface_gateway: string
              interface_netmask_in_c_i_d_r: integer
              lag_or_port_number: integer

返回值 

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

键	描述
response_1 字典	返回包含配置详细信息的字典。返回：始终示例： `"{\n \"response\":\n {\n \"response\": String,\n \"version\": String\n },\n \"msg\": String\n}\n"`
response_2 列表 / 元素=字符串	包含 Cisco DNAC Python SDK 返回的响应的列表。返回：始终示例： `["{\n \"response\": []", "\n \"msg\": String\n}\n"]`
response_3 字典	包含 Cisco DNAC Python SDK 返回的现有详细信息的字典。返回：始终示例： `"{\n \"response\": String,\n \"msg\": String\n}\n"`

作者

Abinash Mishra (@abimishr)