cisco.dnac.accesspoint_workflow_manager module – Automates bulk AP configuration changes.

Note

This module is part of the cisco.dnac collection (version 6.22.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

• Automates bulk configuration changes for Access Points (APs).

• Modify AP display names, AP names, or other parameters.

• Filter specific device details, such as selecting devices with hostnames matching “NFW-AP1-9130AXE”.

• Compares input details with current AP configurations and applies desired changes only to relevant APs.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.7.2

• python >= 3.8

Parameters

Parameter	Comments
config list / elements=dictionary / required	List of details of AP being managed.
2.4ghz_radio dictionary	Configuration options for the 2.4GHz radio interface.
admin_status string	Administrative status for the 2.4GHz radio interface. For example, “Enabled”.
antenna_cable_name string	Name or type of antenna cable used for the 2.4GHz radio interface. For example, “other”.
antenna_gain integer	Specifies the antenna gain value in decibels (dB) for the 2.4GHz radio interface, valid values range from 0 to 40. For example, 10.
antenna_name string	Name or type of antenna used for the 2.4GHz radio interface. For example, “other”.
cable_loss integer	Cable loss in dB for the 2.4GHz radio interface. Valid values are from 0 to 40. This value must be less than the antenna gain. For example, 2.
channel_assignment_mode string	Mode of channel assignment for the 2.4GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
channel_number integer	Custom channel number configured for the 2.4GHz radio interface. For example, 6.
power_assignment_mode string	Mode of power assignment for the 2.4GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
power_level integer	Custom power level configured for the 2.4GHz radio interface. For example, 3.
radio_role_assignment string	Role assignment mode for the 2.4GHz radio interface. Accepts “Auto”, “Client-serving”, or “Monitor”. For example, Auto.
5ghz_radio dictionary	Configuration options for the 5GHz radio interface.
admin_status string	Administrative status for the 5GHz radio interface. For example, “Enabled”.
antenna_cable_name string	Name or type of antenna cable used for the 5GHz radio interface. For example, “other”.
antenna_gain integer	Antenna gain value in decibels (dB) for the 5GHz radio interface, valid values range from 0 to 40. For example, 5.
antenna_name string	Name or type of antenna used for the 5GHz radio interface. For example, “other”.
cable_loss integer	Cable loss in dB for the 5GHz radio interface. Valid values are from 0 to 40. This value must be less than the antenna gain. For example, 3.
channel_assignment_mode string	Mode of channel assignment for the 5GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
channel_number integer	Custom channel number configured for the 5GHz radio interface. For example, 36.
power_assignment_mode string	Mode of power assignment for the 5GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
power_level integer	Custom power level configured for the 5GHz radio interface. For example, 3.
radio_role_assignment string	Role assignment mode for the 5GHz radio interface. Accepts “Auto”, “Client-serving”, or “Monitor”. For example, “Auto”. This field not required for xor series access point slot 1
6ghz_radio dictionary	Configuration options for the 6GHz radio interface.
admin_status string	Administrative status for the 6GHz radio interface. For example, “Enabled”.
antenna_cable_name string	Name or type of antenna cable used for the 6GHz radio interface. For example, “other”.
antenna_gain integer	Antenna gain value in decibels (dB) for the 6GHz radio interface, valid values range from 0 to 40. For example, 30.
antenna_name string	Name or type of antenna used for the 6GHz radio interface. For example, “other”.
cable_loss integer	Cable loss in dB for the 6GHz radio interface. Valid values are from 0 to 40. This value must be less than the antenna gain. For example, 10.
channel_assignment_mode string	Mode of channel assignment for the 6GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
channel_number integer	Custom channel number configured for the 6GHz radio interface. For example, 6.
power_assignment_mode string	Mode of power assignment for the 6GHz radio interface. Accepts “Global” or “Custom”. For example, “Custom”.
power_level integer	Custom power level configured for the 6GHz radio interface. For example, 3.
radio_role_assignment string	Role assignment mode for the 6GHz radio interface. Accepts “Auto”, “Client-serving”, or “Monitor”.
admin_status string	Status of the AP configuration. Accepts “Enabled” or “Disabled”. For example, “Enabled”.
ap_config_selected_fields string	When enable the verify flag “config_verify” to see only the filter field of the AP configuration in the output. (eg. “mac_address,eth_mac,ap_name,led_brightness_level,led_status,location,radioDTOs”)
ap_mode string	Defines the mode of operation for the Access Point (AP). Possible values include “Local”, “Monitor”, “Sniffer”, or “Bridge”. For example, “Local”.
ap_name string	Current AP name that needs to be changed along with the new AP name. For example, “Test2”.
ap_selected_fields string	When enable 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”)
clean_air_si_2.4ghz string	Clean Air Spectrum Intelligence (SI) feature status for the 2.4GHz band. Indicates whether. For example, “Enabled”. Clean Air Spectrum Intelligence is enabled or disabled.
clean_air_si_5ghz string	Clean Air Spectrum Intelligence (SI) feature status for the 5GHz band. Indicates whether. For example, “Enabled”. Clean Air Spectrum Intelligence is enabled or disabled.
clean_air_si_6ghz string	Clean Air Spectrum Intelligence (SI) feature status for the 6GHz band. Indicates whether. For example, “Enabled”. Clean Air Spectrum Intelligence is enabled or disabled.
factory_reset_aps dictionary	Factory reset one or more access points (APs) identified by their MAC addresses, hostnames, or management IP addresses. At least one of the following parameters is required: - mac_addresses - hostnames - management_ip_addresses
hostnames list / elements=string	A list of hostnames used to identify the access points for factory reset.
mac_addresses list / elements=string	A list of MAC addresses used to identify the access points for factory reset.
management_ip_addresses list / elements=string	A list of management IP addresses used to identify the access points for factory reset.
failover_priority string	Priority order for failover in AP configuration. Accepts “Low”, “Medium”, “High”, or “Critical”.
hostname string / required	The Host Name used to identify the device. If provided, it cannot be modified. To identify the specific access point, at least one of the following parameters is required. - mac_address - hostname - management_ip_address
is_assigned_site_as_location string	Configures whether the access point location is automatically set to the site assigned to the access point. Accepts “Enabled” or “Disabled”. If set to “Enabled”, no additional location configuration is required.
led_brightness_level integer	Brightness level of the AP’s LED. Accepts values from 1 to 8. For example, 3.
led_status string	State of the AP’s LED. Accepts “Enabled” or “Disabled”. For example, “Enabled”.
location string	Location name of the AP. Provide this data if a change is required. For example, “Bangalore”.
mac_address string / required	The MAC address used to identify the device. If provided, it cannot be modified. To identify the specific access point, at least one of the following parameters is required. - mac_address - hostname - management_ip_address
management_ip_address string / required	The Management IP Address used to identify the device. If provided, it cannot be modified. To identify the specific access point, at least one of the following parameters is required. - mac_address - hostname - management_ip_address
primary_controller_name string	Name or identifier of the primary wireless LAN controller (WLC) managing the Access Point (AP). For example, “SJ-EWLC-1”.
primary_ip_address dictionary	IP address of the primary wireless LAN controller (WLC) managing the Access Point (AP).
address string	IP address of the primary wireless LAN controller. For example, “10.0.0.3”.
reboot_aps dictionary	Reboot one or more access points (APs) identified by their MAC addresses, hostnames, or management IP addresses. At least one of the following parameters is required: - mac_addresses - hostnames - management_ip_addresses
hostnames list / elements=string	A list of hostnames used to identify the access points for rebooting.
mac_addresses list / elements=string	A list of MAC addresses used to identify the access points for rebooting.
management_ip_addresses list / elements=string	A list of management IP addresses used to identify the access points for rebooting.
rf_profile string	Specifies the Radio Frequency (RF) profile name for the Access Point. It can be one of the standard profiles “HIGH”, “LOW”, “TYPICAL”, or a custom profile that has been created. For example, “HIGH”.
secondary_controller_name string	Name or identifier of the secondary wireless LAN controller (WLC) managing the Access Point (AP). To modify only the primary controller, set the secondary and tertiary controller names to “Inherit from site / Clear”.
secondary_ip_address dictionary	IP address of the secondary wireless LAN controller (WLC) managing the Access Point (AP).
address string	IP address of the primary wireless LAN controller. For example, “10.0.0.3”.
site dictionary	Current site details where the Access Point is located.
floor dictionary	Floor details of the current site.
name string	Name of the floor. For example, “FLOOR1”.
parent_name string	Parent name of the floor in the site hierarchy. For example, “Global/USA/New York/BLDNYC”.
tertiary_controller_name string	Name or identifier of the tertiary wireless LAN controller (WLC) managing the Access Point (AP). To modify only the primary controller, set the secondary and tertiary controller names to “Inherit from site / Clear”.
tertiary_ip_address dictionary	IP address of the tertiary wireless LAN controller (WLC) managing the Access Point (AP).
address string	IP address of the primary wireless LAN controller. For example, “10.0.0.2”.
tri_radio dictionary	Configuration options for the TRI radio interface.
admin_status string	Administrative status for the TRI radio interface. For example, “Enabled”.
antenna_cable_name string	Name or type of antenna cable used for the TRI radio interface. For example, “other”.
antenna_gain integer	Antenna gain value in decibels (dB) for the TRI radio interface, valid values range from 0 to 40. For example, 16.
antenna_name string	Name or type of antenna used for the TRI radio interface. For example, “other”.
cable_loss integer	Cable loss in dB for the TRI radio interface. Valid values are from 0 to 40. This value must be less than the antenna gain. For example, 6.
channel_assignment_mode string	Mode of channel assignment for the TRI radio interface. Accepts “Global” or “Custom”. 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)
channel_number integer	Custom channel number configured for the TRI radio interface. For example, 6.
channel_width string	Width of the channel configured for the TRI radio interface. Accepts values “20 MHz”, “40 MHz”, “80 MHz”, “160 MHz”, or “320 MHz”. . For example, 20 MHz.
dual_radio_mode string	Mode of operation configured for the TRI radio interface. Specifies how the access point (AP) manages its dual radio functionality. eg . Auto
power_assignment_mode string	Mode of power assignment for the TRI radio interface. Accepts “Global” or “Custom”. In Custom, it accepts values 1 to 8.
power_level integer	Custom power level configured for the TRI radio interface. For example, 3.
radio_role_assignment string	Role assignment mode for the TRI radio interface. Accepts “Auto”, “Client-serving”, or “Monitor”. If radio_role_assignment is “client-serving”, then only power-level and channel-level can be changed.
xor_radio dictionary	Configuration options for the XOR radio interface.
admin_status string	Administrative status for the XOR radio interface. For example, “Enabled”.
antenna_cable_name string	Name or type of antenna cable used for the XOR radio interface. For example, “other”.
antenna_gain integer	Antenna gain value in decibels (dB) for the XOR radio interface, valid values range from 0 to 40. For example, 14.
antenna_name string	Name or type of antenna used for the XOR radio interface. For example, “other”.
cable_loss integer	Cable loss in dB for the XOR radio interface. Valid values are from 0 to 40. This value must be less than the antenna gain. For example, 5.
channel_assignment_mode string	Mode of channel assignment for the XOR radio interface. Accepts “Global” or “Custom”. - 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, “Custom”.
channel_number integer	Custom channel number configured for the XOR radio interface. For example, 6.
channel_width string	Width of the channel configured for the XOR radio interface. Accepts values “20 MHz”, “40 MHz”, “80 MHz”, “160 MHz” or “320 MHz”. For example, 20 MHz.
power_assignment_mode string	Mode of power assignment for the XOR radio interface. Accepts “Global” or “Custom.” In “Custom” mode, valid values range from 1 to 8.
power_level integer	Custom power level configured for the XOR radio interface. For example, 3.
radio_band string	Radio band should be enabled if the radio role assignment is set to “Client-serving” mode. Accepts “2.4 GHz” or “5 GHz” or “6 GHz”.
radio_role_assignment string	Role assignment mode for the XOR radio interface. Accepts “Auto”, “Client-serving”, or “Monitor” If “radio_role_assignment” is set to “Client-serving” only the power level and channel number can be changed. Additionally, if the 5 GHz band is selected in the radio band, the power level cannot be modified. For example, “Auto”.
config_verify boolean	Set to True to verify the Cisco Catalyst Center configuration after applying the playbook config. Choices: false ← (default) true
dnac_api_task_timeout integer	The number of times to retry resynchronization. Default: 1200
dnac_debug boolean	Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: false ← (default) true
dnac_host string / required	The hostname of the Cisco Catalyst Center.
dnac_log boolean	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: false ← (default) true
dnac_log_append boolean	Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices: false true ← (default)
dnac_log_file_path string	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: "dnac.log"
dnac_log_level string	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: "WARNING"
dnac_password string	The password for authentication at the Cisco Catalyst Center.
dnac_port string	Specifies the port number associated with the Cisco Catalyst Center. Default: "443"
dnac_task_poll_interval integer	The interval, in seconds, for polling Cisco Catalyst Center. Default: 2
dnac_username aliases: user string	The username for authentication at the Cisco Catalyst Center. Default: "admin"
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
dnac_version string	Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: "2.2.3.3"
next_task_after_interval integer	Time in second between Provision and AP updated execution Default: 5
state string	The desired state of the device replacement workflow. Choices: "merged" ← (default) "deleted"
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: false true ← (default)

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_mode

• The 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: 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
response_1 dictionary	A list of dictionaries containing details about the AP updates and verification results, as returned by the Catalyst Center Python SDK Returned: always Sample: {"response": [{"changed": true, "response": {"ap_config_update_status": "The update for AP Config Cisco_Test_9120_T1 has been successfully verified."}}]}
response_2 dictionary	A dictionary with provision status returned by the Catalyst Center Python SDK Returned: always Sample: {"response": [{"changed": true, "response": {"ap_provision_update_status": "AP provision for the site 'Global/Chennai/LTTS/FLOOR1' has been successfully verified."}}]}
response_3 dictionary	A dictionary with reboot status of AP returned by the Catalyst Center Python SDK Returned: always Sample: {"response": {"accesspoints_updates": {"ap_reboot_status": "AP ['6c:d6:e3:69:49:b4', '68:49:92:75:0f:d0'] Rebooted Successfully", "ap_reboot_task_details": {"reboot_api_response": {"apList": [{"apName": "LTTS_Test_9120_T2", "failureReason": null, "rebootStatus": "Success"}, {"apName": "LTTS_Test_9166_T3", "failureReason": null, "rebootStatus": "Success"}], "wlcIP": "204.192.6.200"}}}}}

Authors

• A Mohamed Rafeek (@mabdulk2)

• Sonali Deepthi Kesali (@skesali)

• Megha Kandari (@mekandar)

• Natarajan (@natarajan)

• Madhan Sankaranarayanan (@madhansansel)

• Abhishek Maheshwari (@abmahesh)

Collection links

• Issue Tracker
• Repository (Sources)