cisco.dnac.accesspoint_workflow_manager module -- Manage Cisco Catalyst Center access points
Note
This module is part of the cisco.dnac collection (version 6.44.0).
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.accesspoint_workflow_manager.
New in cisco.dnac 6.17.0
Synopsis
Manage access point configurations in Cisco Catalyst Center.
Configure individual AP settings including radio interfaces, controller assignments, and location parameters.
Perform bulk configuration updates across multiple access points of the same series.
Execute lifecycle operations including AP reboot and factory reset for up to 100 devices.
Provision access points to sites and assign RF profiles (HIGH, LOW, TYPICAL, or custom).
Support advanced radio configurations for 2.4GHz, 5GHz, 6GHz, XOR, and TRI radio interfaces.
Compare current configurations with desired state to apply only necessary changes.
Identify access points using MAC address, hostname, or management IP address.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.8
Parameters
Parameter |
Comments |
|---|---|
List of details of AP being managed. |
|
|
|
Administrative status for the 2.4GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 2.4GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 2.4GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 2.4GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 2.4GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 1 to 14. For example: 3. |
|
Specifies the power assignment mode for the 2.4GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 2.4GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
Configuration options for the 5GHz radio interface. Note: Updating access point radio configuration varies based on each model. Refer to the respective access point documentation before updating the radio configuration. |
|
Administrative status for the 5GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 5GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 5GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 5GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 5GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 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. For example: 36. |
|
|
|
Specifies the power assignment mode for the 5 GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 5 GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Administrative status for the 6GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 6GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 6GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 6GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 6GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 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. For example: 53. |
|
|
|
Specifies the power assignment mode for the 6GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 6GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
Status of the AP configuration. Accepts "Enabled" or "Disabled". For example, "Enabled". |
|
|
|
|
|
Current AP name that needs to be changed along with the new AP name. For example, "Test2". |
|
When enabling the verify flag "config_verify" to see only the filter field of the AP details in the output. (eg. "id,hostname,family,type,mac_address,management_ip_address,ap_ethernet_mac_address") |
|
|
|
|
|
Current AP name that needs to be changed along with the new AP name. For example, "Test2". |
|
|
|
|
|
|
|
Common fields to change AP is a dict which contains below data which is needed to update all listed access points. |
|
|
|
Administrative status for the 2.4GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 2.4GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 2.4GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 2.4GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 2.4GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 1 to 14. For example: 3. |
|
Specifies the power assignment mode for the 2.4GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 2.4GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Administrative status for the 5GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 5GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 5GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 5GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 5GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 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. For example: 36. |
|
Specifies the power assignment mode for the 5GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 5GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Administrative status for the 6GHz radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the 6GHz radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the 6GHz radio interface. For example, "other". |
|
|
|
Specifies the channel assignment for the 6GHz radio interface. If the channel assignment is set to "Global", the channel_number is not required. When a channel_number is provided, the channel assignment defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom channel number for the 6GHz radio interface. When a channel number is provided, the channel assignment defaults to "Custom". Valid values range from 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. For example: 53. |
|
Specifies the power assignment mode for the 6GHz radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the 6GHz radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
Status of the AP configuration. Accepts "Enabled" or "Disabled". For example, "Enabled". |
|
|
|
|
|
|
|
|
|
Priority order for failover in AP configuration. Accepts "Low", "Medium", "High", or "Critical". |
|
|
|
Brightness level of the AP's LED. Accepts values from 1 to 8. For example, 3. |
|
Specifies led status for the access point accepts "Enabled" or "Disabled". When a led brightness level is provided, the led status defaults to "Enabled". For example, "Enabled". |
|
Location name of the AP. Provide this data if a change is required. For example, "Bangalore". |
|
|
|
IP address of the primary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.3". |
|
|
|
IP address of the secondary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.3". |
|
|
|
IP address of the tertiary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.2". |
|
|
|
Administrative status for the TRI radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the TRI radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the TRI radio interface. For example, "other". |
|
|
|
|
|
Custom channel number configured for the TRI radio interface. For Custom, it accepts values like 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. (eg. Custom) For example, 36. |
|
|
|
|
|
Specifies the power assignment mode for the TRI radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the TRI radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Administrative status for the XOR radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the XOR radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the XOR radio interface. For example, "other". |
|
|
|
|
|
Custom channel number configured for the XOR radio interface. - For "Custom" mode and a radio band of "2.4 GHz", valid values are from 1 to 14. - For "Custom" mode and a radio band of "5 GHz", valid values are 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. - For "Custom" mode and a radio band of "6 GHz", valid values are 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. For example, 6. |
|
|
|
Specifies the power assignment mode for the XOR radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the XOR radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
|
|
|
|
|
|
|
|
A list of hostnames used to identify the access points for factory reset. |
|
A list of MAC addresses used to identify the access points for factory reset. |
|
A list of management IP addresses used to identify the access points for factory reset. |
|
Priority order for failover in AP configuration. Accepts "Low", "Medium", "High", or "Critical". |
|
|
|
Choices: |
|
Brightness level of the AP's LED. Accepts values from 1 to 8. For example, 3. |
|
Specifies led status for the access point accepts "Enabled" or "Disabled". When a led brightness level is provided, the led status defaults to "Enabled". For example, "Enabled". |
|
Location name of the AP. Provide this data if a change is required. For example, "Bangalore". |
|
|
|
|
|
|
|
IP address of the primary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.3". |
|
|
|
A list of hostnames used to identify the access points for rebooting. |
|
A list of MAC addresses used to identify the access points for rebooting. |
|
A list of management IP addresses used to identify the access points for rebooting. |
|
|
|
|
|
IP address of the secondary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.3". |
|
Current site details where the Access Point is located. |
|
Floor details of the current site. |
|
Name of the floor. For example, "FLOOR1". |
|
Parent name of the floor in the site hierarchy. For example, "Global/USA/New York/BLDNYC". |
|
|
|
IP address of the tertiary wireless LAN controller (WLC) managing the Access Point (AP). |
|
IP address of the primary wireless LAN controller. For example, "10.0.0.2". |
|
|
|
Administrative status for the TRI radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the TRI radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the TRI radio interface. For example, "other". |
|
|
|
|
|
Custom channel number configured for the TRI radio interface. For Custom, it accepts values like 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. (eg. Custom) For example, 36. |
|
|
|
|
|
Specifies the power assignment mode for the TRI radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the TRI radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Administrative status for the XOR radio interface. For example, "Enabled". |
|
Name or type of antenna cable used for the XOR radio interface. For example, "other". |
|
|
|
Name or type of antenna used for the XOR radio interface. For example, "other". |
|
|
|
|
|
Custom channel number configured for the XOR radio interface. - For "Custom" mode and a radio band of "2.4 GHz", valid values are from 1 to 14. - For "Custom" mode and a radio band of "5 GHz", valid values are 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. - For "Custom" mode and a radio band of "6 GHz", valid values are 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. For example, 6. |
|
|
|
Specifies the power assignment mode for the XOR radio interface. If the power assignment mode is set to "Global", the power level is not required. When a power level is provided, the power assignment mode automatically defaults to "Custom". Accepts "Global" or "Custom". For example: "Global". |
|
Defines the custom power level for the XOR radio interface. When a power level is provided, the power assignment mode automatically defaults to "Custom". Valid values range from 1 to 8. For example: 3. |
|
|
|
|
|
Indicates whether configuration verification is enabled. This flag is always set to false. As a result, some field changes may not exhibit idempotent behavior due to Access Point reboots. Choices: |
|
The number of times to retry resynchronization. Default: :ansible-option-default:`1200` |
|
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: |
|
The hostname of the Cisco Catalyst Center. |
|
Flag to enable/disable playbook execution logging. When true and dnac_log_file_path is provided, - Create the log file at the execution location with the specified name. When true and dnac_log_file_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac_log_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac_log_append" flag. Choices: |
|
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. Choices: |
|
Governs logging. Logs are recorded if dnac_log is True. If path is not specified, - When 'dnac_log_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac_log_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac_log_append' is True, the file opens in append mode. - When 'dnac_log_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. Default: :ansible-option-default:`"dnac.log"` |
|
Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. Default: :ansible-option-default:`"WARNING"` |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"` |
|
The interval, in seconds, for polling Cisco Catalyst Center. Default: :ansible-option-default:`2` |
|
The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"` |
|
Time in seconds between Provision and AP updated execution Default: :ansible-option-default:`5` |
|
The desired state of the device replacement workflow. Choices: |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
Make sure to install the required Python dependencies by executing pip install dnacentersdk.
SDK Method used are
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
Paths used are
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
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK
The parameters starting with dnac_ are used by the Cisco Catalyst Center Python SDK to establish the connection
See Also
See also
- Cisco DNAC Ansible Collection Documentation
Complete guide to using the Cisco DNAC Ansible collection.
- Cisco DNAC API Documentation
Official API documentation for Cisco DNAC.
Examples
- name: Provision/Move/Update Wireless Access Point Configuration
hosts: dnac_servers
connection: local
gather_facts: false # This space must be "no." It was set to false due to formatting errors.
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"
power_level: 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
power_level: 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
power_level: 4
5ghz_radio:
admin_status: "Enabled"
antenna_name: "C-ANT9103-5GHz"
channel_number: 40
power_level: 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
power_level: 2
5ghz_radio:
admin_status: "Enabled"
antenna_name: "AIR-ANT2513P4M-N-5GHz"
radio_role_assignment: "Client-Serving"
channel_number: 36
power_level: 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
power_level: 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
power_level: 3
5ghz_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 44
power_level: 3
channel_width: "20 MHz"
xor_radio:
admin_status: "Enabled"
radio_role_assignment: "Client-Serving"
channel_number: 1
power_level: 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A list of dictionaries containing details about the AP updates and verification results, as returned by the Catalyst Center Python SDK Returned: always |
|
A dictionary with provision status returned by the Catalyst Center Python SDK Returned: always |
|
A dictionary with reboot status of AP returned by the Catalyst Center Python SDK Returned: always |
|
A dictionary with bulk update status of AP returned by the Catalyst Center Python SDK Returned: always |
|
A dictionary with factory reset status of AP returned by the Catalyst Center Python SDK Returned: always |