cisco.dnac.accesspoint_workflow_manager 模块 – 自动化批量 AP 配置更改。
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您正在使用 ansible
包,您可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:cisco.dnac.accesspoint_workflow_manager
。
cisco.dnac 6.17.0 中的新功能
概要
自动化接入点 (AP) 的批量配置更改。
修改 AP 显示名称、AP 名称或其他参数。
筛选特定的设备详细信息,例如选择主机名与“NFW-AP1-9130AXE”匹配的设备。
将输入详细信息与当前 AP 配置进行比较,并将所需的更改仅应用于相关的 AP。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.7.2
python >= 3.8
参数
参数 |
注释 |
---|---|
正在管理的 AP 的详细信息列表。 |
|
2.4GHz 无线电接口的配置选项。 |
|
2.4GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 2.4GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
指定 2.4GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,10。 |
|
用于 2.4GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
2.4GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,2。 |
|
2.4GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 2.4GHz 无线电接口配置的自定义信道号。例如,6。 |
|
2.4GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 2.4GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
2.4GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。例如,“Auto”。 |
|
5GHz 无线电接口的配置选项。 |
|
5GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 5GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
5GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,5。 |
|
用于 5GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
5GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,3。 |
|
5GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 5GHz 无线电接口配置的自定义信道号。例如,36。 |
|
5GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 5GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
5GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。例如,“Auto”。xor 系列接入点插槽 1 不需要此字段 |
|
6GHz 无线电接口的配置选项。 |
|
6GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 6GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
6GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,30。 |
|
用于 6GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
6GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,10。 |
|
6GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 6GHz 无线电接口配置的自定义信道号。例如,6。 |
|
6GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 6GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
6GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。 |
|
AP 配置状态。接受“启用”或“禁用”。例如,“启用”。 |
|
当启用验证标志“config_verify”时,输出中将仅显示 AP 配置的过滤字段。(例如,“mac_address,eth_mac,ap_name,led_brightness_level,led_status,location,radioDTOs”) |
|
定义接入点 (AP) 的操作模式。可能的值包括“Local”、“Monitor”、“Sniffer”或“Bridge”。例如,“Local”。 |
|
需要更改的当前 AP 名称以及新的 AP 名称。例如,“Test2”。 |
|
当启用验证标志“config_verify”时,输出中将仅显示 AP 详细信息的过滤字段。(例如,“id,hostname,family,type,mac_address,management_ip_address,ap_ethernet_mac_address”) |
|
对同一系列的多个接入点 (AP) 执行批量更新,这些接入点由以下一个或多个参数标识:- mac_address - hostname - management_ip_address。必须至少指定其中一个参数来标识要更新的 AP。 |
|
AP 标识符是字典列表,其中包含用于标识要批量更新的接入点的 MAC 地址、主机名或管理 IP 地址,并使用 AP 名称更新接入点。 |
|
需要更改的当前 AP 名称以及新的 AP 名称。例如,“Test2”。 |
|
用于标识设备的主机名。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
用于标识设备的 MAC 地址。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
用于标识设备的管理 IP 地址。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
要更改 AP 的公共字段是一个字典,其中包含以下需要更新所有列出的接入点的数据。 |
|
2.4GHz 无线电接口的配置选项。 |
|
2.4GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 2.4GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
指定 2.4GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,10。 |
|
用于 2.4GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
2.4GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,2。 |
|
2.4GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 2.4GHz 无线电接口配置的自定义信道号。例如,6。 |
|
2.4GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 2.4GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
2.4GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。例如,“Auto”。 |
|
5GHz 无线电接口的配置选项。 |
|
5GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 5GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
5GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,5。 |
|
用于 5GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
5GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,3。 |
|
5GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 5GHz 无线电接口配置的自定义信道号。例如,36。 |
|
5GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 5GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
5GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。例如,“Auto”。xor 系列接入点插槽 1 不需要此字段 |
|
6GHz 无线电接口的配置选项。 |
|
6GHz 无线电接口的管理状态。例如,“Enabled”。 |
|
用于 6GHz 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
6GHz 无线电接口的天线增益值,以分贝 (dB) 为单位,有效值范围为 0 到 40。例如,30。 |
|
用于 6GHz 无线电接口的天线的名称或类型。例如,“other”。 |
|
6GHz 无线电接口的电缆损耗,以 dB 为单位。有效值为 0 到 40。此值必须小于天线增益。例如,10。 |
|
6GHz 无线电接口的信道分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 6GHz 无线电接口配置的自定义信道号。例如,6。 |
|
6GHz 无线电接口的功率分配模式。接受“Global”或“Custom”。例如,“Custom”。 |
|
为 6GHz 无线电接口配置的自定义功率级别。例如,3。 |
|
6GHz 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。 |
|
AP 配置状态。接受“启用”或“禁用”。例如,“启用”。 |
|
定义接入点 (AP) 的操作模式。可能的值包括“Local”、“Monitor”、“Sniffer”或“Bridge”。例如,“Local”。 |
|
2.4GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
5GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
6GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
AP 配置中故障转移的优先级顺序。接受“Low”、“Medium”、“High”或“Critical”。 |
|
配置是否将接入点位置自动设置为分配给接入点的站点。接受“启用”或“禁用”。如果设置为“启用”,则无需其他位置配置。 |
|
AP LED 的亮度级别。接受 1 到 8 的值。例如,3。 |
|
AP LED 的状态。接受“启用”或“禁用”。例如,“启用”。 |
|
AP 的位置名称。如果需要更改,请提供此数据。例如,“Bangalore”。 |
|
管理接入点 (AP) 的主无线 LAN 控制器 (WLC) 的名称或标识符。例如,“SJ-EWLC-1”。 |
|
管理接入点 (AP) 的主无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.3”。 |
|
管理接入点 (AP) 的辅助无线 LAN 控制器 (WLC) 的名称或标识符。要仅修改主控制器,请将辅助和三级控制器的名称设置为“从站点继承/清除”。 |
|
管理接入点 (AP) 的辅助无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.3”。 |
|
管理接入点 (AP) 的三级无线 LAN 控制器 (WLC) 的名称或标识符。要仅修改主控制器,请将辅助和三级控制器的名称设置为“从站点继承/清除”。 |
|
管理接入点 (AP) 的三级无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.2”。 |
|
TRI 无线电接口的配置选项。 |
|
TRI 无线电接口的管理状态。例如,“启用”。 |
|
用于 TRI 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
TRI 无线电接口的天线增益值(以分贝 (dB) 为单位),有效值范围为 0 到 40。例如,16。 |
|
用于 TRI 无线电接口的天线的名称或类型。例如,“other”。 |
|
TRI 无线电接口的电缆损耗(以 dB 为单位)。有效值为 0 到 40。此值必须小于天线增益。例如,6。 |
|
TRI 无线电接口的信道分配模式。接受“Global”或“Custom”。对于“Custom”,它接受 36、40、44、48、52、56、60、64、100、104、108、112、116、120、124、128、132、136、140、144、149、153、157、161、165、169、173 等值。(例如,“Custom”) |
|
为 TRI 无线电接口配置的自定义信道号。例如,6。 |
|
为 TRI 无线电接口配置的信道宽度。接受值“20 MHz”、“40 MHz”、“80 MHz”、“160 MHz”或“320 MHz”。例如,20 MHz。 |
|
为 TRI 无线电接口配置的操作模式。指定接入点 (AP) 如何管理其双无线电功能。例如,“Auto”。 |
|
TRI 无线电接口的功率分配模式。接受“Global”或“Custom”。在“Custom”中,它接受 1 到 8 的值。 |
|
为 TRI 无线电接口配置的自定义功率级别。例如,3。 |
|
TRI 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。如果 radio_role_assignment 为“client-serving”,则只能更改功率级别和信道级别。 |
|
XOR 无线电接口的配置选项。 |
|
XOR 无线电接口的管理状态。例如,“启用”。 |
|
用于 XOR 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
XOR 无线电接口的天线增益值(以分贝 (dB) 为单位),有效值范围为 0 到 40。例如,14。 |
|
用于 XOR 无线电接口的天线的名称或类型。例如,“other”。 |
|
XOR 无线电接口的电缆损耗(以 dB 为单位)。有效值为 0 到 40。此值必须小于天线增益。例如,5。 |
|
XOR 无线电接口的信道分配模式。接受“Global”或“Custom”。- 对于“Custom”模式和“2.4 GHz”的无线电频段,有效值为 1 到 14。- 对于“Custom”模式和“5 GHz”的无线电频段,有效值为 36、40、44、48、52、56、60、64、100、104、108、112、116、120、124、128、132、136、140、144、149、153、157、161、165、169、173。- 对于“Custom”模式和“6 GHz”的无线电频段,有效值为 1、5、9、13、17、21、25、29、33、37、41、45、49、53、57、61、65、69、73、77、81、85、89、93、97、101、105、109、113、117、121、125、129、133、137、141、145、149、153、157、161、165、169、173、177、181、185、189、193、197、201、205、209、213、217、221、225、229、233。例如,“Custom”。 |
|
为 XOR 无线电接口配置的自定义信道号。例如,6。 |
|
为 XOR 无线电接口配置的信道宽度。接受值“20 MHz”、“40 MHz”、“80 MHz”、“160 MHz”或“320 MHz”。例如,20 MHz。 |
|
XOR 无线电接口的功率分配模式。接受“Global”或“Custom”。在“Custom”模式下,有效值范围为 1 到 8。 |
|
为 XOR 无线电接口配置的自定义功率级别。例如,3。 |
|
如果将无线电角色分配设置为“Client-serving”模式,则应启用无线电频段。接受“2.4 GHz”、“5 GHz”或“6 GHz”。 |
|
XOR 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。如果“radio_role_assignment”设置为“Client-serving”,则只能更改功率级别和信道号。此外,如果在无线电频段中选择了 5 GHz 频段,则无法修改功率级别。例如,“Auto”。 |
|
2.4GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
5GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
6GHz 频段的 Clean Air 频谱智能 (SI) 功能状态。指示是否启用或禁用 Clean Air 频谱智能。例如,“启用”。 |
|
恢复一个或多个接入点 (AP) 的出厂设置,这些接入点由其 MAC 地址、主机名或管理 IP 地址标识。至少需要以下参数之一:- mac_addresses - hostnames - management_ip_addresses |
|
用于标识要恢复出厂设置的接入点的主机名列表。 |
|
用于标识要恢复出厂设置的接入点的 MAC 地址列表。 |
|
用于标识要恢复出厂设置的接入点的管理 IP 地址列表。 |
|
AP 配置中故障转移的优先级顺序。接受“Low”、“Medium”、“High”或“Critical”。 |
|
用于标识设备的主机名。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
配置是否将接入点位置自动设置为分配给接入点的站点。接受“启用”或“禁用”。如果设置为“启用”,则无需其他位置配置。 |
|
AP LED 的亮度级别。接受 1 到 8 的值。例如,3。 |
|
AP LED 的状态。接受“启用”或“禁用”。例如,“启用”。 |
|
AP 的位置名称。如果需要更改,请提供此数据。例如,“Bangalore”。 |
|
用于标识设备的 MAC 地址。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
用于标识设备的管理 IP 地址。如果提供,则无法修改。要标识特定的接入点,至少需要以下参数之一:- mac_address - hostname - management_ip_address |
|
管理接入点 (AP) 的主无线 LAN 控制器 (WLC) 的名称或标识符。例如,“SJ-EWLC-1”。 |
|
管理接入点 (AP) 的主无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.3”。 |
|
重新启动一个或多个接入点 (AP),这些接入点由其 MAC 地址、主机名或管理 IP 地址标识。至少需要以下参数之一:- mac_addresses - hostnames - management_ip_addresses |
|
用于标识要重新启动的接入点的主机名列表。 |
|
用于标识要重新启动的接入点的 MAC 地址列表。 |
|
用于标识要重新启动的接入点的管理 IP 地址列表。 |
|
指定接入点的射频 (RF) 配置文件名称。它可以是标准配置文件“HIGH”、“LOW”、“TYPICAL”之一,也可以是已创建的自定义配置文件。例如,“HIGH”。 |
|
管理接入点 (AP) 的辅助无线 LAN 控制器 (WLC) 的名称或标识符。要仅修改主控制器,请将辅助和三级控制器的名称设置为“从站点继承/清除”。 |
|
管理接入点 (AP) 的辅助无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.3”。 |
|
接入点所在的当前站点详细信息。 |
|
当前站点的楼层详细信息。 |
|
楼层的名称。例如,“FLOOR1”。 |
|
站点层次结构中楼层的父名称。例如,“Global/USA/New York/BLDNYC”。 |
|
管理接入点 (AP) 的三级无线 LAN 控制器 (WLC) 的名称或标识符。要仅修改主控制器,请将辅助和三级控制器的名称设置为“从站点继承/清除”。 |
|
管理接入点 (AP) 的三级无线 LAN 控制器 (WLC) 的 IP 地址。 |
|
主无线 LAN 控制器的 IP 地址。例如,“10.0.0.2”。 |
|
TRI 无线电接口的配置选项。 |
|
TRI 无线电接口的管理状态。例如,“启用”。 |
|
用于 TRI 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
TRI 无线电接口的天线增益值(以分贝 (dB) 为单位),有效值范围为 0 到 40。例如,16。 |
|
用于 TRI 无线电接口的天线的名称或类型。例如,“other”。 |
|
TRI 无线电接口的电缆损耗(以 dB 为单位)。有效值为 0 到 40。此值必须小于天线增益。例如,6。 |
|
TRI 无线电接口的信道分配模式。接受“Global”或“Custom”。对于“Custom”,它接受 36、40、44、48、52、56、60、64、100、104、108、112、116、120、124、128、132、136、140、144、149、153、157、161、165、169、173 等值。(例如,“Custom”) |
|
为 TRI 无线电接口配置的自定义信道号。例如,6。 |
|
为 TRI 无线电接口配置的信道宽度。接受值“20 MHz”、“40 MHz”、“80 MHz”、“160 MHz”或“320 MHz”。例如,20 MHz。 |
|
为 TRI 无线电接口配置的操作模式。指定接入点 (AP) 如何管理其双无线电功能。例如,“Auto”。 |
|
TRI 无线电接口的功率分配模式。接受“Global”或“Custom”。在“Custom”中,它接受 1 到 8 的值。 |
|
为 TRI 无线电接口配置的自定义功率级别。例如,3。 |
|
TRI 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。如果 radio_role_assignment 为“client-serving”,则只能更改功率级别和信道级别。 |
|
XOR 无线电接口的配置选项。 |
|
XOR 无线电接口的管理状态。例如,“启用”。 |
|
用于 XOR 无线电接口的天线电缆的名称或类型。例如,“other”。 |
|
XOR 无线电接口的天线增益值(以分贝 (dB) 为单位),有效值范围为 0 到 40。例如,14。 |
|
用于 XOR 无线电接口的天线的名称或类型。例如,“other”。 |
|
XOR 无线电接口的电缆损耗(以 dB 为单位)。有效值为 0 到 40。此值必须小于天线增益。例如,5。 |
|
XOR 无线电接口的信道分配模式。接受“Global”或“Custom”。- 对于“Custom”模式和“2.4 GHz”的无线电频段,有效值为 1 到 14。- 对于“Custom”模式和“5 GHz”的无线电频段,有效值为 36、40、44、48、52、56、60、64、100、104、108、112、116、120、124、128、132、136、140、144、149、153、157、161、165、169、173。- 对于“Custom”模式和“6 GHz”的无线电频段,有效值为 1、5、9、13、17、21、25、29、33、37、41、45、49、53、57、61、65、69、73、77、81、85、89、93、97、101、105、109、113、117、121、125、129、133、137、141、145、149、153、157、161、165、169、173、177、181、185、189、193、197、201、205、209、213、217、221、225、229、233。例如,“Custom”。 |
|
为 XOR 无线电接口配置的自定义信道号。例如,6。 |
|
为 XOR 无线电接口配置的信道宽度。接受值“20 MHz”、“40 MHz”、“80 MHz”、“160 MHz”或“320 MHz”。例如,20 MHz。 |
|
XOR 无线电接口的功率分配模式。接受“Global”或“Custom”。在“Custom”模式下,有效值范围为 1 到 8。 |
|
为 XOR 无线电接口配置的自定义功率级别。例如,3。 |
|
如果将无线电角色分配设置为“Client-serving”模式,则应启用无线电频段。接受“2.4 GHz”、“5 GHz”或“6 GHz”。 |
|
XOR 无线电接口的角色分配模式。接受“Auto”、“Client-serving”或“Monitor”。如果“radio_role_assignment”设置为“Client-serving”,则只能更改功率级别和信道号。此外,如果在无线电频段中选择了 5 GHz 频段,则无法修改功率级别。例如,“Auto”。 |
|
设置为 True 以在应用 playbook 配置后验证 Cisco Catalyst Center 配置。 选择
|
|
重试重新同步的次数。 默认值: |
|
指示是否在 Cisco Catalyst Center SDK 中启用了调试。 选择
|
|
Cisco Catalyst Center 的主机名。 |
|
用于启用/禁用 playbook 执行日志记录的标志。 如果为 true 且提供了 dnac_log_file_path, - 则使用指定的名称在执行位置创建日志文件。 如果为 true 且未提供 dnac_log_file_path, - 则在执行位置创建名为 “dnac.log” 的日志文件。 如果为 false, - 则禁用日志记录。 如果日志文件不存在, - 则根据“dnac_log_append”标志在追加或写入模式下创建它。 如果日志文件存在, - 则根据“dnac_log_append”标志覆盖或追加它。 选择
|
|
确定文件的模式。设置为 True 表示“追加”模式。设置为 False 表示“写入”模式。 选择
|
|
控制日志记录。如果 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。 默认值: |
|
设置日志级别的阈值。级别等于或高于此阈值的消息将被记录。级别按严重程度顺序排列 [CRITICAL, ERROR, WARNING, INFO, DEBUG]。 CRITICAL 表示导致程序停止的严重错误。仅显示 CRITICAL 消息。 ERROR 表示阻止功能运行的问题。显示 ERROR 和 CRITICAL 消息。 WARNING 表示潜在的未来问题。显示 WARNING、ERROR 和 CRITICAL 消息。 INFO 跟踪正常操作。显示 INFO、WARNING、ERROR 和 CRITICAL 消息。 DEBUG 提供详细的诊断信息。显示所有日志消息。 默认值: |
|
用于在 Cisco Catalyst Center 进行身份验证的密码。 |
|
指定与 Cisco Catalyst Center 关联的端口号。 默认值: |
|
轮询 Cisco Catalyst Center 的间隔(以秒为单位)。 默认值: |
|
用于在 Cisco Catalyst Center 进行身份验证的用户名。 默认值: |
|
用于启用或禁用 SSL 证书验证的标志。 选择
|
|
指定 SDK 应使用的 Cisco Catalyst Center 版本。 默认值: |
|
Provision 和 AP 更新执行之间的间隔时间(以秒为单位) 默认值: |
|
设备替换工作流程的所需状态。 选择
|
|
Cisco Catalyst Center SDK 用于启用针对 JSON 模式验证请求体的标志。 选择
|
说明
注意
请务必通过执行 pip install dnacentersdk 安装所需的 Python 依赖项。
使用的 SDK 方法包括
devices.get_device_list
wireless.get_access_point_configuration
sites.get_site
sda.get_device_info
sites.assign_devices_to_site
wireless.ap_provision
wireless.configure_access_points
sites.get_membership
使用的路径包括
GET /dna/intent/api/v1/network-device
GET /dna/intent/api/v1/site
GET /dna/intent/api/v1/business/sda/device
POST /dna/intent/api/v1/wireless/ap-provision
GET /dna/intent/api/v1/membership/{siteId}
GET /dna/intent/api/v1/wireless/accesspoint-configuration/details/{task_id}
POST /dna/intent/api/v2/wireless/accesspoint-configuration
POST /dna/intent/api/v1/assign-device-to-site/{siteId}/device
不支持
check_mode
该插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用来自 Cisco Catalyst Center SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco Catalyst Center Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNAC Ansible Collection 文档
使用 Cisco DNAC Ansible Collection 的完整指南。
- Cisco DNAC API 文档
Cisco DNAC 的官方 API 文档。
示例
- name: Provision/Move/Update Wireless Access Point Configuration
hosts: dnac_servers
connection: local
gather_facts: no
vars_files:
- "credentials.yml"
tasks:
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
2.4ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-2.4GHz"
radio_role_assignment: "Client-Serving"
powerlevel: 5
channel_number: 7
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
2.4ghz_radio:
admin_status: "Enabled"
power_assignment_mode: "Global"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
2.4ghz_radio:
admin_status: "Enabled"
channel_assignment_mode: "Global"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
5ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-5GHz"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
5ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-5GHz"
radio_role_assignment: "Client-Serving"
channel_number: 44
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
5ghz_radio:
admin_status: "Enabled"
antenna_name: "C-ANT9104-Single-D0-5GHz"
channel_number: 52
powerlevel: 5
channel_width: "40 MHz"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
2.4ghz_radio:
admin_status: "Enabled"
antenna_name: "C-ANT9103-2.4GHz"
channel_number: 9
powerlevel: 4
5ghz_radio:
admin_status: "Enabled"
antenna_name: "C-ANT9103-5GHz"
channel_number: 40
powerlevel: 3
channel_width: "20 MHz"
register: output_list
- name: Provisioning and Re-provisiong Access Point Site details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
rf_profile: "HIGH"
site:
floor:
name: "FLOOR1"
parent_name: "Global/USA/New York/BLDNYC"
register: output_list
- name: Updating Access Point Update / Controller Name
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- mac_address: a4:88:73:d4:d6:60
ap_name: "Cisco_Test_AP_T003"
admin_status: "Enabled"
led_status: "Enabled"
led_brightness_level: 1
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
primary_controller_name: "NY-EWLC-1"
primary_ip_address:
address: "204.192.6.200"
secondary_controller_name: "NY-EWLC-20"
secondary_ip_address:
address: "fe80::202:b3ff:fe1e:8324"
tertiary_controller_name: "SJ-EWLC-20"
tertiary_ip_address:
address: "fe80::202:b3ff:fe1e:8325"
register: output_list
- name: Updating Access Point Update / remove tertiary_controller_name
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- mac_address: a4:88:73:d4:d6:60
ap_name: "Cisco_Test_AP_T003"
admin_status: "Enabled"
led_status: "Enabled"
led_brightness_level: 1
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
primary_controller_name: "NY-EWLC-10"
primary_ip_address:
address: "fe80::202:b3ff:fe1e:8329"
secondary_controller_name: "NY-EWLC-20"
secondary_ip_address:
address: "fe80::202:b3ff:fe1e:8324"
tertiary_controller_name: "Inherit from site / Clear"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: False
state: merged
config:
- mac_address: 90:e9:5e:03:f3:40
rf_profile: "HIGH"
site:
floor:
name: "FLOOR1"
parent_name: "Global/USA/New York/BLDNYC"
ap_name: "LTTS-test2"
admin_status: "Enabled"
led_status: "Enabled"
led_brightness_level: 5
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
2.4ghz_radio:
admin_status: "Enabled"
antenna_name: "C-ANT9104-2.4GHz"
radio_role_assignment: "Client-Serving"
channel_number: 5
powerlevel: 2
5ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-5GHz"
radio_role_assignment: "Client-Serving"
channel_number: 36
powerlevel: 2
channel_width: "40 MHz"
register: output_list
- name: Updating Access Point Site / Configuration details
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- mac_address: 6c:d6:e3:75:5a:e0
ap_name: "LTTS_Test_9120_T2"
admin_status: "Enabled"
led_status: "Enabled"
led_brightness_level: 2
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
primary_controller_name: "NY-IAC-EWLC.cisco.local"
primary_ip_address:
address: "204.192.6.200"
secondary_controller_name: "Inherit from site / Clear"
tertiary_controller_name: "Inherit from site / Clear"
xor_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 4
radio_band: "2.4 GHz"
channel_width: "40 MHz"
5ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-5GHz"
radio_role_assignment: "Client-Serving"
channel_number: 40
powerlevel: 2
channel_width: "80 MHz"
register: output_list
- name: Updating Access Point Configuration
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- mac_address: e4:38:7e:42:bc:00
ap_name: "LTTS_Test_9166_T3"
admin_status: "Enabled"
led_status: "Enabled"
led_brightness_level: 3
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
primary_controller_name: "NY-IAC-EWLC"
primary_ip_address:
address: "204.192.6.200"
secondary_controller_name: "Inherit from site / Clear"
tertiary_controller_name: "Inherit from site / Clear"
2.4ghz_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 3
powerlevel: 3
5ghz_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 44
powerlevel: 3
channel_width: "20 MHz"
xor_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 1
powerlevel: 3
radio_band: "6 GHz"
channel_width: "40 MHz"
register: output_list
- name: Reboot single or multiple access point
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- reboot_aps:
mac_addresses:
- "6c:d6:e3:75:5a:e0"
- "e4:38:7e:42:bc:00"
register: output_list
- name: Reboot single or multiple access point by hostname
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- reboot_aps:
hostnames:
- "cisco_Test_9166_T3"
- "cisco_Test_9120_T1"
register: output_list
- name: Factory reset single or multiple access point
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- factory_reset_aps:
mac_addresses:
- "6c:d6:e3:75:5a:e0"
- "e4:38:7e:42:bc:00"
register: output_list
- name: Bulk update Access Point Configurations
cisco.dnac.accesspoint_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
dnac_log_level: DEBUG
config_verify: True
state: merged
config:
- bulk_update_aps:
ap_identifier:
- mac_address: e4:38:7e:42:bc:40
ap_name: "Cisco_9166_T2"
- mac_address: a4:88:73:d0:53:60
ap_name: "Cisco_9120_T2"
common_fields_to_change:
admin_status: "Disabled"
led_status: "Enabled"
led_brightness_level: 1
ap_mode: "Local"
is_assigned_site_as_location: "Enabled"
failover_priority: "Low"
clean_air_si_2.4ghz: "Enabled"
clean_air_si_5ghz: "Enabled"
clean_air_si_6ghz: "Disabled"
primary_controller_name: "SJ-EWLC-1"
primary_ip_address:
address: "204.192.4.200"
secondary_controller_name: "Inherit from site / Clear"
tertiary_controller_name: "Inherit from site / Clear"
返回值
常见的返回值记录在此处:此处,以下是此模块特有的字段
键 |
描述 |
---|---|
一个字典列表,其中包含有关 AP 更新和验证结果的详细信息,由 Catalyst Center Python SDK 返回 返回:始终 示例: |
|
一个字典,其中包含 Catalyst Center Python SDK 返回的 Provision 状态 返回:始终 示例: |
|
一个字典,其中包含 Catalyst Center Python SDK 返回的 AP 重启状态 返回:始终 示例: |
|
一个字典,其中包含 Catalyst Center Python SDK 返回的 AP 批量更新状态 返回:始终 示例: |
|
一个字典,其中包含 Catalyst Center Python SDK 返回的 AP 出厂重置状态 返回:始终 示例: |