cisco.dnac.provision_workflow_manager 模块 – 用于配置相关功能的资源模块

注意

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

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

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

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

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 字符串	接口的名称。
interface_netmask_in_c_i_d_r 字符串	接口的 CIDR 格式子网掩码（例如，24 代表 255.255.255.0）。
lag_or_port_number 字符串	端口号或 LAG（链路聚合组）标识符。
vlan_id 字符串	与接口关联的 VLAN ID。
force_provisioning 布尔值	确定是否强制重新配置设备。无法将设备重新配置到不同的站点。为了使“force_provisioning”生效，“provisioning”选项不应设置为“false”。仅适用于有线设备。设置为“true”强制重新配置，即使设备已配置。设置为“false”跳过对已配置设备的配置。选项 `false` ← (默认) `true`
managed_ap_locations 列表 / 元素=字符串	为 AP 分配的站点的地址。这是配置无线设备的必要条件。
management_ip_address 字符串 / 必需	设备的管理 IP 地址。
primary_managed_ap_locations 列表 / 元素=字符串	分配给主控管理型接入点 (AP) 的站点位置列表。如果未设置托管 AP 位置，则配置无线设备时需要此参数。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。
provisioning 布尔值	指定用户打算仅执行站点分配还是对有线设备进行完全配置。设置为“false”仅执行站点分配。设置为“true”继续配置到站点。选项 `false` `true` ← (默认)
rolling_ap_upgrade 字典	分阶段执行接入点 (AP) 滚动升级的配置选项。允许在升级过程中控制 AP 的逐步重启。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。
ap_reboot_percentage 整数	在升级期间同时重启的 AP 百分比。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。必须是 5、15 或 25，表示一次重启的 AP 比例。
enable_rolling_ap_upgrade 布尔值	启用或禁用滚动 AP 升级功能。如果设置为“true”，则 AP 将根据指定的重启百分比分批升级。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。选项 `false` ← (默认) `true`
secondary_managed_ap_locations 列表 / 元素=字符串	分配给辅助管理型接入点 (AP) 的站点位置列表。如果未设置托管 AP 位置，则配置无线设备时需要此参数。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。
site_name_hierarchy 字符串 / 必需	将添加设备的站点的名称。此参数是配置设备并将其分配到站点的必要条件。
skip_ap_provision 布尔值	如果设置为“true”，则在工作流期间将跳过接入点 (AP) 配置。在当前操作不需要 AP 配置时使用此选项。在 Cisco Catalyst 2.3.7.6 及更高版本中受支持。选项 `false` ← (默认) `true`
config_verify 布尔值	设置为 true 以在应用 playbook 配置后验证 Cisco Catalyst Center 配置。选项 `false` ← (默认) `true`
dnac_api_task_timeout 整数	定义以秒为单位的 API 调用超时时间以检索任务详细信息。如果在此期间未收到任务详细信息，则进程将结束，并将记录超时通知。默认值： `1200`
dnac_debug 布尔值	指示 Cisco Catalyst Center SDK 中是否启用了调试。选项 `false` ← (默认) `true`
dnac_host 字符串 / 必需	Cisco Catalyst Center 的主机名。
dnac_log 布尔值	启用/禁用 playbook 执行日志记录的标志。当为 true 并提供 dnac_log_file_path 时，- 在执行位置创建具有指定名称的日志文件。如果 `dnac_log` 为真且未提供 `dnac_log_file_path`，则 - 在执行位置创建名为“dnac.log”的日志文件。如果为假，则 - 日志记录被禁用。如果日志文件不存在，则 - 根据“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) 模式打开。 - 在共享文件场景中，如果没有追加模式，则每次模块执行后都会覆盖内容。 - 对于共享日志文件，请将第一个模块的 append 设置为 False（以覆盖）；对于后续模块，请将 append 设置为 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 Catalyst Center 身份验证的密码。
dnac_port 字符串	指定与 Cisco Catalyst Center 关联的端口号。默认值： `"443"`
dnac_task_poll_interval 整数	指定连续调用 API 以检索任务详细信息之间的间隔（秒）。默认值： `2`
dnac_username 别名：user 字符串	Cisco Catalyst Center 身份验证的用户名。默认值： `"admin"`
dnac_verify 布尔值	启用或禁用 SSL 证书验证的标志。选项 `false` `true` ← (默认)
dnac_version 字符串	指定 SDK 应使用的 Cisco Catalyst Center 版本。默认值： `"2.2.3.3"`
state 字符串	模块完成后的 Cisco Catalyst Center 状态。选项 `"merged"` ← (默认) `"deleted"`
validate_response_schema 布尔值	用于 Cisco Catalyst 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
在 v6.16.0 中添加了“配置”选项
在 v6.16.0 中添加了无线设备的配置和重新配置
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco Catalyst Center SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco Catalyst Center Python SDK 用于建立连接。

示例 

- name: Provision a wireless device to a site
  cisco.dnac.provision_workflow_manager:
    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_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          managed_ap_locations:
            - Global/USA/San Francisco/BGL_18/Test_Floor2
          dynamic_interfaces:
            - vlan_id: 1866
              interface_name: Vlan1866
              interface_ip_address: 204.192.6.200
              interface_gateway: 204.192.6.1

- name: Provision a wireless device to a site for version - 2.3.7.6
  cisco.dnac.provision_workflow_manager:
    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_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          primary_managed_ap_Locations:
            - Global/USA/San Francisco/BGL_18/Test_Floor2
          secondary_managed_ap_locations:
            - Global/USA/San Francisco/BGL_18/Test_Floor1
          dynamic_interfaces:
            - interface_name: Vlan1866
              vlan_id: 1866
              interface_ip_address: 204.192.6.200
              interface_gateway: 204.192.6.1
          skip_ap_provision: false
          rolling_ap_upgrade:
            enable_rolling_ap_upgrade: false
            ap_reboot_percentage: 5

- name: Provision a wired device to a site
  cisco.dnac.provision_workflow_manager:
    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_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40

- name: Re-Provision a wired device to a site forcefully
  cisco.dnac.provision_workflow_manager:
    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_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          force_provisioning: true

- name: Assign a wired device to a site
  cisco.dnac.provision_workflow_manager:
    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_hierarchy: Global/USA/San Francisco/BGL_18
          management_ip_address: 204.192.3.40
          provisioning: false

- name: Provision a wireless device to a site
  cisco.dnac.provision_workflow_manager:
    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_verify: true
    config:
        - site_name_hierarchy: Global/USA/RTP/BLD11
          management_ip_address: 204.192.12.201
          managed_ap_locations:
            - Global/USA/RTP/BLD11/BLD11_FLOOR1

- name: Unprovision a device from a site
  cisco.dnac.provision_workflow_manager:
    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: deleted
    config_verify: true
    config:
        - management_ip_address: 204.1.2.2

返回值 

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

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

作者

Abinash Mishra (@abimishr) Madhan Sankaranarayanan (@madhansansel) Syed Khadeer Ahmed(@syed-khadeerahmed) Ajith Andrew J (@ajithandrewj)