.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.accesspoint_workflow_manager module -- Automates bulk AP configuration changes. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.19.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.accesspoint_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.17.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.8 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of details of AP being managed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio: .. rst-class:: ansible-option-title **2.4ghz_radio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration options for the 2.4GHz radio interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Administrative status for the 2.4GHz radio interface. For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/antenna_cable_name: .. rst-class:: ansible-option-title **antenna_cable_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna cable used for the 2.4GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/antenna_gain: .. rst-class:: ansible-option-title **antenna_gain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the antenna gain value in decibels (dB) for the 2.4GHz radio interface, valid values range from 0 to 40. For example, 10. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/antenna_name: .. rst-class:: ansible-option-title **antenna_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna used for the 2.4GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/cable_loss: .. rst-class:: ansible-option-title **cable_loss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/channel_assignment_mode: .. rst-class:: ansible-option-title **channel_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of channel assignment for the 2.4GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/channel_number: .. rst-class:: ansible-option-title **channel_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom channel number configured for the 2.4GHz radio interface. For example, 6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/power_assignment_mode: .. rst-class:: ansible-option-title **power_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of power assignment for the 2.4GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/power_level: .. rst-class:: ansible-option-title **power_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom power level configured for the 2.4GHz radio interface. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/2.4ghz_radio/radio_role_assignment: .. rst-class:: ansible-option-title **radio_role_assignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role assignment mode for the 2.4GHz radio interface. Accepts "Auto", "Client-serving", or "Monitor". For example, Auto. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio: .. rst-class:: ansible-option-title **5ghz_radio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration options for the 5GHz radio interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Administrative status for the 5GHz radio interface. For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/antenna_cable_name: .. rst-class:: ansible-option-title **antenna_cable_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna cable used for the 5GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/antenna_gain: .. rst-class:: ansible-option-title **antenna_gain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Antenna gain value in decibels (dB) for the 5GHz radio interface, valid values range from 0 to 40. For example, 5. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/antenna_name: .. rst-class:: ansible-option-title **antenna_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna used for the 5GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/cable_loss: .. rst-class:: ansible-option-title **cable_loss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/channel_assignment_mode: .. rst-class:: ansible-option-title **channel_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of channel assignment for the 5GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/channel_number: .. rst-class:: ansible-option-title **channel_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom channel number configured for the 5GHz radio interface. For example, 36. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/power_assignment_mode: .. rst-class:: ansible-option-title **power_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of power assignment for the 5GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/power_level: .. rst-class:: ansible-option-title **power_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom power level configured for the 5GHz radio interface. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/5ghz_radio/radio_role_assignment: .. rst-class:: ansible-option-title **radio_role_assignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role assignment mode for the 5GHz radio interface. Accepts "Auto", "Client-serving", or "Monitor". For example, "Auto". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio: .. rst-class:: ansible-option-title **6ghz_radio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration options for the 6GHz radio interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Administrative status for the 6GHz radio interface. For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/antenna_cable_name: .. rst-class:: ansible-option-title **antenna_cable_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna cable used for the 6GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/antenna_gain: .. rst-class:: ansible-option-title **antenna_gain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Antenna gain value in decibels (dB) for the 6GHz radio interface, valid values range from 0 to 40. For example, 30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/antenna_name: .. rst-class:: ansible-option-title **antenna_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna used for the 6GHz radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/cable_loss: .. rst-class:: ansible-option-title **cable_loss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/channel_assignment_mode: .. rst-class:: ansible-option-title **channel_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of channel assignment for the 6GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/channel_number: .. rst-class:: ansible-option-title **channel_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom channel number configured for the 6GHz radio interface. For example, 6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/power_assignment_mode: .. rst-class:: ansible-option-title **power_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of power assignment for the 6GHz radio interface. Accepts "Global" or "Custom". For example, "Custom". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/power_level: .. rst-class:: ansible-option-title **power_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom power level configured for the 6GHz radio interface. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/6ghz_radio/radio_role_assignment: .. rst-class:: ansible-option-title **radio_role_assignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Role assignment mode for the 6GHz radio interface. Accepts "Auto", "Client-serving", or "Monitor". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Status of the AP configuration. Accepts "Enabled" or "Disabled". For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/ap_config_selected_fields: .. rst-class:: ansible-option-title **ap_config_selected_fields** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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") .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/ap_mode: .. rst-class:: ansible-option-title **ap_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Defines the mode of operation for the Access Point (AP). Possible values include "Local", "Monitor", "Sniffer", or "Bridge". For example, "Local". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/ap_name: .. rst-class:: ansible-option-title **ap_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Current AP name that needs to be changed along with the new AP name. For example, "Test2". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/ap_selected_fields: .. rst-class:: ansible-option-title **ap_selected_fields** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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") .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/clean_air_si_2.4ghz: .. rst-class:: ansible-option-title **clean_air_si_2.4ghz** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/clean_air_si_5ghz: .. rst-class:: ansible-option-title **clean_air_si_5ghz** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Clean Air Spectrum Intelligence (SI) feature status for the 5GHz band. Indicates whether. For example, "Enabled". Clean Air Spectrum Intelligence is enabled or disabled. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/clean_air_si_6ghz: .. rst-class:: ansible-option-title **clean_air_si_6ghz** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Clean Air Spectrum Intelligence (SI) feature status for the 6GHz band. Indicates whether. For example, "Enabled". Clean Air Spectrum Intelligence is enabled or disabled. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/failover_priority: .. rst-class:: ansible-option-title **failover_priority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Priority order for failover in AP configuration. Accepts "Low", "Medium", "High", or "Critical". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/hostname: .. rst-class:: ansible-option-title **hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
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 .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/is_assigned_site_as_location: .. rst-class:: ansible-option-title **is_assigned_site_as_location** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/led_brightness_level: .. rst-class:: ansible-option-title **led_brightness_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Brightness level of the AP's LED. Accepts values from 1 to 8. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/led_status: .. rst-class:: ansible-option-title **led_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
State of the AP's LED. Accepts "Enabled" or "Disabled". For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/location: .. rst-class:: ansible-option-title **location** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Location name of the AP. Provide this data if a change is required. For example, "Bangalore". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/mac_address: .. rst-class:: ansible-option-title **mac_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
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 .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/management_ip_address: .. rst-class:: ansible-option-title **management_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
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 .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/primary_controller_name: .. rst-class:: ansible-option-title **primary_controller_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or identifier of the primary wireless LAN controller (WLC) managing the Access Point (AP). For example, "SJ-EWLC-1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/primary_ip_address: .. rst-class:: ansible-option-title **primary_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
IP address of the primary wireless LAN controller (WLC) managing the Access Point (AP). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/primary_ip_address/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of the primary wireless LAN controller. For example, "10.0.0.3". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/rf_profile: .. rst-class:: ansible-option-title **rf_profile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/secondary_controller_name: .. rst-class:: ansible-option-title **secondary_controller_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/secondary_ip_address: .. rst-class:: ansible-option-title **secondary_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
IP address of the secondary wireless LAN controller (WLC) managing the Access Point (AP). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/secondary_ip_address/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of the primary wireless LAN controller. For example, "10.0.0.3". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/site: .. rst-class:: ansible-option-title **site** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Current site details where the Access Point is located. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/site/floor: .. rst-class:: ansible-option-title **floor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Floor details of the current site. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/site/floor/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the floor. For example, "FLOOR1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/site/floor/parent_name: .. rst-class:: ansible-option-title **parent_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent name of the floor in the site hierarchy. For example, "Global/USA/New York/BLDNYC". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tertiary_controller_name: .. rst-class:: ansible-option-title **tertiary_controller_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tertiary_ip_address: .. rst-class:: ansible-option-title **tertiary_ip_address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
IP address of the tertiary wireless LAN controller (WLC) managing the Access Point (AP). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tertiary_ip_address/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP address of the primary wireless LAN controller. For example, "10.0.0.2". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio: .. rst-class:: ansible-option-title **tri_radio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration options for the TRI radio interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Administrative status for the TRI radio interface. For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/antenna_cable_name: .. rst-class:: ansible-option-title **antenna_cable_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna cable used for the TRI radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/antenna_gain: .. rst-class:: ansible-option-title **antenna_gain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Antenna gain value in decibels (dB) for the TRI radio interface, valid values range from 0 to 40. For example, 16. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/antenna_name: .. rst-class:: ansible-option-title **antenna_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna used for the TRI radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/cable_loss: .. rst-class:: ansible-option-title **cable_loss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/channel_assignment_mode: .. rst-class:: ansible-option-title **channel_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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) .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/channel_number: .. rst-class:: ansible-option-title **channel_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom channel number configured for the TRI radio interface. For example, 6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/channel_width: .. rst-class:: ansible-option-title **channel_width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/dual_radio_mode: .. rst-class:: ansible-option-title **dual_radio_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of operation configured for the TRI radio interface. Specifies how the access point (AP) manages its dual radio functionality. eg . Auto .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/power_assignment_mode: .. rst-class:: ansible-option-title **power_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of power assignment for the TRI radio interface. Accepts "Global" or "Custom". In Custom, it accepts values 1 to 8. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/power_level: .. rst-class:: ansible-option-title **power_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom power level configured for the TRI radio interface. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/tri_radio/radio_role_assignment: .. rst-class:: ansible-option-title **radio_role_assignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio: .. rst-class:: ansible-option-title **xor_radio** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration options for the XOR radio interface. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/admin_status: .. rst-class:: ansible-option-title **admin_status** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Administrative status for the XOR radio interface. For example, "Enabled". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/antenna_cable_name: .. rst-class:: ansible-option-title **antenna_cable_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna cable used for the XOR radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/antenna_gain: .. rst-class:: ansible-option-title **antenna_gain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Antenna gain value in decibels (dB) for the XOR radio interface, valid values range from 0 to 40. For example, 14. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/antenna_name: .. rst-class:: ansible-option-title **antenna_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name or type of antenna used for the XOR radio interface. For example, "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/cable_loss: .. rst-class:: ansible-option-title **cable_loss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/channel_assignment_mode: .. rst-class:: ansible-option-title **channel_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/channel_number: .. rst-class:: ansible-option-title **channel_number** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom channel number configured for the XOR radio interface. For example, 6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/channel_width: .. rst-class:: ansible-option-title **channel_width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/power_assignment_mode: .. rst-class:: ansible-option-title **power_assignment_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of power assignment for the XOR radio interface. Accepts "Global" or "Custom." In "Custom" mode, valid values range from 1 to 8. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/power_level: .. rst-class:: ansible-option-title **power_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Custom power level configured for the XOR radio interface. For example, 3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/radio_band: .. rst-class:: ansible-option-title **radio_band** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config/xor_radio/radio_role_assignment: .. rst-class:: ansible-option-title **radio_role_assignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set to True to verify the Cisco Catalyst Center configuration after applying the playbook config. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The number of times to retry resynchronization. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The hostname of the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password for authentication at the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The interval, in seconds, for polling Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-next_task_after_interval: .. rst-class:: ansible-option-title **next_task_after_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time in second between Provision and AP updated execution .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`5` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The desired state of the device replacement workflow. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja - 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: - ap_type: "Unified AP" 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__return-response_1: .. rst-class:: ansible-option-title **response_1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A list of dictionaries containing details about the AP updates and verification results, as returned by the Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": [{"changed": true, "response": {"ap\_config\_update\_status": "The update for AP Config Cisco\_Test\_9120\_T1 has been successfully verified."}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.accesspoint_workflow_manager_module__return-response_2: .. rst-class:: ansible-option-title **response_2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary with activation details as returned by the Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"{\\n \\"response\\": {\\n {\\n \\"bapiKey\\": \\"d897-19b8-47aa-a9c4\\",\\n \\"bapiName\\": \\"AP Provision\\",\\n \\"bapiExecutionId\\": \\"97d5edd5-d5db-40d8-9ab6-f15dc4a5cc30\\",\\n \\"startTime\\": \\"Wed Jul 03 18:37:24 UTC 2024\\",\\n \\"startTimeEpoch\\": 1720031844919,\\n \\"endTimeEpoch\\": 0,\\n \\"timeDuration\\": 0,\\n \\"status\\": \\"IN\_PROGRESS\\",\\n \\"runtimeInstanceId\\": \\"DNACP\_Runtime\_3f8f258c-9f7a-4511-b361-592ee9e0c4d2\\"\\n }\\n }\\n}\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - A Mohamed Rafeek (@mabdulk2) - Sonali Deepthi Kesali (@skesali) - Megha Kandari (@mekandar) - Natarajan (@natarajan) - Madhan Sankaranarayanan (@madhansansel) - Abhishek Maheshwari (@abmahesh) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors