cisco.dnac.wireless_accespoint_configuration module – Resource module for Wireless Accespoint Configuration

Note

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

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

To install it, use: ansible-galaxy collection install cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.wireless_accespoint_configuration.

New in cisco.dnac 3.1.0

Synopsis

  • This module represents an alias of the module wireless_accespoint_configuration_v1

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

adminStatus

boolean

Configure the access point’s admin status. Set this parameter’s value to “true” to enable it and “false” to disable it.

Choices:

  • false

  • true

apList

list / elements=dictionary

Wireless Accespoint Configuration’s apList.

apName

string

The current host name of the access point.

apNameNew

string

The modified hostname of the access point.

macAddress

string

The ethernet MAC address of the access point.

apMode

integer

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”.

configureAdminStatus

boolean

To change the access point’s admin status, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureApMode

boolean

To change the access point’s mode, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureFailoverPriority

boolean

To change the access point’s failover priority, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureHAController

boolean

To change the access point’s HA controller, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureLedBrightnessLevel

boolean

To change the access point’s LED brightness level, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureLedStatus

boolean

To change the access point’s LED status, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureLocation

boolean

To change the access point’s location, set this parameter’s value to “true”.

Choices:

  • false

  • true

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

failoverPriority

integer

Configure the acess point’s failover priority for low, set “1”; for medium, set “2”; for high, set “3”; and for critical, set “4”.

isAssignedSiteAsLocation

boolean

If AP is assigned to a site, then to assign AP location as the site name, set this parameter’s value to “true”.

Choices:

  • false

  • true

ledBrightnessLevel

integer

Configure the access point’s LED brightness level by setting a value between 1 and 8.

ledStatus

boolean

Configure the access point’s LED status. Set “true” to enable its status and “false” to disable it.

Choices:

  • false

  • true

location

string

Configure the access point’s location.

primaryControllerName

string

Configure the hostname for an access point’s primary controller.

primaryIpAddress

dictionary

Wireless Accespoint Configuration’s primaryIpAddress.

address

string

Configure the IP address for an access point’s primary controller.

radioConfigurations

list / elements=dictionary

Wireless Accespoint Configuration’s radioConfigurations.

adminStatus

boolean

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.

Choices:

  • false

  • true

antennaCableName

string

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”.

antennaGain

integer

Configure the antenna gain on the specified radio for an access point by setting a decimal value (in dBi). To configure “antennaGain”, set “antennaPatternName” value to “other”.

antennaPatternName

string

Specify the antenna name on the specified radio for an access point. The antenna name is used to calculate the gain on the radio slot.

cableLoss

float

Configure the cable loss on the specified radio for an access point by setting a decimal value (in dBi).

channelAssignmentMode

integer

Configure the channel assignment mode on the specified radio for an access point for global mode, set “1”; and for custom mode, set “2”.

channelNumber

integer

Configure the channel number on the specified radio for an access point.

channelWidth

integer

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”; for 160 MHz, set “6”, and for 320 MHz, set “7”.

cleanAirSI

integer

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.

configureAdminStatus

boolean

To change the admin status on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureAntennaCable

boolean

To change the antenna cable name on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureAntennaPatternName

boolean

To change the antenna gain on the specified radio for an access point, set the value for this parameter to “true”.

Choices:

  • false

  • true

configureChannel

boolean

To change the channel on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureChannelWidth

boolean

To change the channel width on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureCleanAirSI

boolean

To enable or disable either CleanAir or Spectrum Intelligence on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configurePower

boolean

To change the power assignment mode on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

configureRadioRoleAssignment

boolean

To change the radio role on the specified radio for an access point, set this parameter’s value to “true”.

Choices:

  • false

  • true

powerAssignmentMode

integer

Configure the power assignment mode on the specified radio for an access point for global mode, set “1”; and for custom mode, set “2”.

powerlevel

integer

Configure the power level on the specified radio for an access point by setting a value between 1 and 8.

radioBand

string

Configure the band on the specified radio for an access point for 2.4 GHz, set “RADIO24”; for 5 GHz, set “RADIO5”. Any other string is invalid, including empty string.

radioRoleAssignment

string

Configure only one of the following roles on the specified radio for an access point as “AUTO”, “SERVING”, or “MONITOR”. Any other string is invalid, including empty string.

radioType

integer

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”.

secondaryControllerName

string

Configure the hostname for an access point’s secondary controller.

secondaryIpAddress

dictionary

Wireless Accespoint Configuration’s secondaryIpAddress.

address

string

Configure the IP address for an access point’s secondary controller.

tertiaryControllerName

string

Configure the hostname for an access point’s tertiary controller.

tertiaryIpAddress

dictionary

Wireless Accespoint Configuration’s tertiaryIpAddress.

address

string

Configure the IP address for an access point’s tertiary controller.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are wireless.Wireless.configure_access_points_v1,

  • Paths used are post /dna/intent/api/v1/wireless/accesspoint-configuration,

  • It should be noted that this module is an alias of wireless_accespoint_configuration_v1

  • Does not support 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

See Also

See also

Cisco DNA Center documentation for Wireless ConfigureAccessPointsV1

Complete reference of the ConfigureAccessPointsV1 API.

Examples

- 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
    apList:
    - apName: string
      apNameNew: string
      macAddress: string
    apMode: 0
    configureAdminStatus: true
    configureApMode: true
    configureFailoverPriority: true
    configureHAController: true
    configureLedBrightnessLevel: true
    configureLedStatus: true
    configureLocation: true
    failoverPriority: 0
    isAssignedSiteAsLocation: true
    ledBrightnessLevel: 0
    ledStatus: true
    location: string
    primaryControllerName: string
    primaryIpAddress:
      address: string
    radioConfigurations:
    - adminStatus: true
      antennaCableName: string
      antennaGain: 0
      antennaPatternName: string
      cableLoss: 0
      channelAssignmentMode: 0
      channelNumber: 0
      channelWidth: 0
      cleanAirSI: 0
      configureAdminStatus: true
      configureAntennaCable: true
      configureAntennaPatternName: true
      configureChannel: true
      configureChannelWidth: true
      configureCleanAirSI: 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

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)