.. 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.wireless_accespoint_configuration_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_accespoint_configuration module -- Resource module for Wireless Accespoint Configuration ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.10.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.wireless_accespoint_configuration`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.7.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Wireless Accespoint Configuration. - User can configure multiple access points with required options using this intent API. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-adminstatus: .. rst-class:: ansible-option-title **adminStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configure the access point's admin status. Set this parameter's value to "true" to enable it and "false" to disable it. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-apheight: .. rst-class:: ansible-option-title **apHeight** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the height of the access point by setting a value between 3 and height of the floor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-aplist: .. rst-class:: ansible-option-title **apList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Accespoint Configuration's apList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-aplist/apname: .. rst-class:: ansible-option-title **apName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The current host name of the access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-aplist/apnamenew: .. rst-class:: ansible-option-title **apNameNew** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The modified hostname of the access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-aplist/macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The ethernet MAC address of the access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-apmode: .. rst-class:: ansible-option-title **apMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the access point's mode for local/flexconnect mode, set "0"; for monitor mode, set "1"; for sniffer mode, set "4"; and for bridge/flex+bridge mode, set "5". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configureadminstatus: .. rst-class:: ansible-option-title **configureAdminStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's admin status, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configureapheight: .. rst-class:: ansible-option-title **configureApHeight** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's height, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configureapmode: .. rst-class:: ansible-option-title **configureApMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's mode, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configurefailoverpriority: .. rst-class:: ansible-option-title **configureFailoverPriority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's failover priority, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configurehacontroller: .. rst-class:: ansible-option-title **configureHAController** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's HA controller, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configureledbrightnesslevel: .. rst-class:: ansible-option-title **configureLedBrightnessLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's LED brightness level, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configureledstatus: .. rst-class:: ansible-option-title **configureLedStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's LED status, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-configurelocation: .. rst-class:: ansible-option-title **configureLocation** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the access point's location, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_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
Flag for Cisco DNA Center SDK to enable debugging. .. 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.wireless_accespoint_configuration_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 Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_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 Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_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 Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_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.wireless_accespoint_configuration_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
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.5.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-failoverpriority: .. rst-class:: ansible-option-title **failoverPriority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the acess point's failover priority for low, set "1"; for medium, set "2"; for high, set "3"; and for critical, set "4". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-ledbrightnesslevel: .. rst-class:: ansible-option-title **ledBrightnessLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the access point's LED brightness level by setting a value between 1 and 8. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-ledstatus: .. rst-class:: ansible-option-title **ledStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configure the access point's LED status. Set "true" to enable its status and "false" to disable it. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-location: .. rst-class:: ansible-option-title **location** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the access point's location. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-primarycontrollername: .. rst-class:: ansible-option-title **primaryControllerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the hostname for an access point's primary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-primaryipaddress: .. rst-class:: ansible-option-title **primaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Accespoint Configuration's primaryIpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-primaryipaddress/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the IP address for an access point's primary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations: .. rst-class:: ansible-option-title **radioConfigurations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Accespoint Configuration's radioConfigurations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/adminstatus: .. rst-class:: ansible-option-title **adminStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Configure the admin status on the specified radio for an access point. Set this parameter's value to "true" to enable it and "false" to disable it. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennacablename: .. rst-class:: ansible-option-title **antennaCableName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the antenna cable name on the specified radio for an access point. If cable loss needs to be configured, set this parameter's value to "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennadegree: .. rst-class:: ansible-option-title **antennaDegree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the antenna degree on the specified radio for an access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennaelevangledegree: .. rst-class:: ansible-option-title **antennaElevAngleDegree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the antenna elevation angle on the specified radio for an access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennaelevanglesign: .. rst-class:: ansible-option-title **antennaElevAngleSign** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the antenna elevation angle direction on the specified radio for an access point for up, set "1"; for down, set "-1". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennagain: .. rst-class:: ansible-option-title **antennaGain** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the antenna gain on the specified radio for an access point by setting a decimal value (in dBi). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/antennapatternname: .. rst-class:: ansible-option-title **antennaPatternName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the antenna pattern name on the specified radio for an access point. If antenna gain needs to be configured, set this parameter's value to "other". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/cableloss: .. rst-class:: ansible-option-title **cableLoss** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the cable loss on the specified radio for an access point by setting a decimal value (in dBi). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/channelassignmentmode: .. rst-class:: ansible-option-title **channelAssignmentMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the channel assignment mode on the specified radio for an access point for global mode, set "1"; and for custom mode, set "2". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/channelnumber: .. rst-class:: ansible-option-title **channelNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the channel number on the specified radio for an access point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/channelwidth: .. rst-class:: ansible-option-title **channelWidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the channel width on the specified radio for an access point for 20 MHz, set "3"; for 40 MHz, set "4"; for 80 MHz, set "5"; and for 160 MHz, set "6". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/cleanairsi: .. rst-class:: ansible-option-title **cleanAirSI** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure CleanAir or Spectrum Intelligence on the specified radio for an access point. Set this parameter's value to "0" to disable the feature or "1" to enable it. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureadminstatus: .. rst-class:: ansible-option-title **configureAdminStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the admin status on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureantennacable: .. rst-class:: ansible-option-title **configureAntennaCable** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the antenna cable name on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureantennadegree: .. rst-class:: ansible-option-title **configureAntennaDegree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the antenna degree on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureantennapatternname: .. rst-class:: ansible-option-title **configureAntennaPatternName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the antenna pattern name on the specified radio for an access point, set the value for this parameter to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configurechannel: .. rst-class:: ansible-option-title **configureChannel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the channel on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configurechannelwidth: .. rst-class:: ansible-option-title **configureChannelWidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the channel width on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configurecleanairsi: .. rst-class:: ansible-option-title **configureCleanAirSI** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To enable or disable either CleanAir or Spectrum Intelligence on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureelevangledegree: .. rst-class:: ansible-option-title **configureElevAngleDegree** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the elevation angle degree on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configurepower: .. rst-class:: ansible-option-title **configurePower** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the power assignment mode on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/configureradioroleassignment: .. rst-class:: ansible-option-title **configureRadioRoleAssignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
To change the radio role on the specified radio for an access point, set this parameter's value to "true". .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/powerassignmentmode: .. rst-class:: ansible-option-title **powerAssignmentMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the power assignment mode on the specified radio for an access point for global mode, set "1"; and for custom mode, set "2". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/powerlevel: .. rst-class:: ansible-option-title **powerlevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure the power level on the specified radio for an access point by setting a value between 1 and 8. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/radioband: .. rst-class:: ansible-option-title **radioBand** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the band on the specified radio for an access point for 2.4 GHz, set "RADIO24"; for 5 GHz, set "RADIO5". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/radioroleassignment: .. rst-class:: ansible-option-title **radioRoleAssignment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure one of the following roles on the specified radio for an access point "auto", "serving", or "monitor". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-radioconfigurations/radiotype: .. rst-class:: ansible-option-title **radioType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configure an access point's radio band for 2.4 GHz, set "1"; for 5 GHz, set "2"; for XOR, set "3"; and for 6 GHz, set "6". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-secondarycontrollername: .. rst-class:: ansible-option-title **secondaryControllerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the hostname for an access point's secondary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-secondaryipaddress: .. rst-class:: ansible-option-title **secondaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Accespoint Configuration's secondaryIpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-secondaryipaddress/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the IP address for an access point's secondary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-tertiarycontrollername: .. rst-class:: ansible-option-title **tertiaryControllerName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the hostname for an access point's tertiary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-tertiaryipaddress: .. rst-class:: ansible-option-title **tertiaryIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Accespoint Configuration's tertiaryIpAddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_module__parameter-tertiaryipaddress/address: .. rst-class:: ansible-option-title **address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configure the IP address for an access point's tertiary controller. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_accespoint_configuration_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 DNA 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:: - SDK Method used are wireless.Wireless.configure\_access\_points, - Paths used are post /dna/intent/api/v1/wireless/accesspoint-configuration, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Wireless ConfigureAccessPoints `_ Complete reference of the ConfigureAccessPoints API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.wireless_accespoint_configuration: 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}}" adminStatus: true apHeight: 0 apList: - apName: string apNameNew: string macAddress: string apMode: 0 configureAdminStatus: true configureApHeight: true configureApMode: true configureFailoverPriority: true configureHAController: true configureLedBrightnessLevel: true configureLedStatus: true configureLocation: true failoverPriority: 0 ledBrightnessLevel: 0 ledStatus: true location: string primaryControllerName: string primaryIpAddress: address: string radioConfigurations: - adminStatus: true antennaCableName: string antennaDegree: 0 antennaElevAngleDegree: 0 antennaElevAngleSign: 0 antennaGain: 0 antennaPatternName: string cableLoss: 0 channelAssignmentMode: 0 channelNumber: 0 channelWidth: 0 cleanAirSI: 0 configureAdminStatus: true configureAntennaCable: true configureAntennaDegree: true configureAntennaPatternName: true configureChannel: true configureChannelWidth: true configureCleanAirSI: true configureElevAngleDegree: true configurePower: true configureRadioRoleAssignment: true powerAssignmentMode: 0 powerlevel: 0 radioBand: string radioRoleAssignment: string radioType: 0 secondaryControllerName: string secondaryIpAddress: address: string tertiaryControllerName: string tertiaryIpAddress: address: string .. 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.wireless_accespoint_configuration_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC 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": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors