cisco.catalystcenter.feature_templates_wireless_dot11ax_configurations_id module -- Resource module for Feature Templates Wireless Dot11ax Configurations Id

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

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

To use it in a playbook, specify: cisco.catalystcenter.feature_templates_wireless_dot11ax_configurations_id.

New in cisco.catalystcenter 6.18.0

Synopsis

  • Manage operations update and delete of the resource Feature Templates Wireless Dot11ax Configurations Id.

  • This API allows users to delete a specific Dot11ax configuration feature template by ID.

  • This API allows users to update the details of a specific Dot11ax configuration feature template by ID.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

designName

string

The feature template design name. `Note ` The following characters are not allowed % & < > ' /.

featureAttributes

dictionary

Feature Templates Wireless Dot11ax Configurations Id's featureAttributes.

bssColor

boolean

BSS (Basic Service Set) Color is supported on Cisco IOS-XE based Wireless Controllers running 17.1 and above.

Choices:

multipleBssid

boolean

Multiple Basic service set identifiers (BSSID) is supported only on Cisco IOS-XE based Wireless Controllers running 17.7.1 and above. `Note ` Multiple Bssid is only supported for radioBand 6GHZ.

Choices:

nonSRGObssPdMaxThreshold

integer

Non SRG Obss Pd Max Threshold is supported only on Cisco IOS-XE based Wireless Controllers running 17.4 and above. `Note ` Non SRG Obss Pd Max Threshold is only supported for radioBand 2_4GHZ and 5GHZ.

obssPd

boolean

Overlapping BSS Packet Detect (obssPd) is supported only on Cisco IOS-XE based Wireless Controllers running 17.4 and above. `Note ` Obss Pd is only supported for radioBand 2_4GHZ and 5GHZ.

Choices:

radioBand

string

6 GHz radioBand is supported only on Cisco IOS-XE based Wireless Controllers running 17.7.1 and above.

targetWaketimeBroadcast

boolean

Target Wake Time Broadcast is supported on Cisco IOS-XE based Wireless Controllers running 17.3.1 and above.

Choices:

targetWakeUpTime11ax

boolean

Target Wake Up Time 11ax is supported on Cisco IOS-XE based Wireless Controllers running 17.1 and above.

Choices:

id

string

Id path parameter. Dot11ax Configuration Feature Template Id.

unlockedAttributes

list / elements=string

Attributes unlocked in design can be changed at device provision time. `Note ` unlockedAttributes can only contain the attributes defined under featureAttributes.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are wireless.Wireless.delete_dot11ax_configuration_feature_template, wireless.Wireless.update_dot11ax_configuration_feature_template,

  • Paths used are delete /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/{id}, put /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/{id},

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Wireless DeleteDot11axConfigurationFeatureTemplate

Complete reference of the DeleteDot11axConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless UpdateDot11axConfigurationFeatureTemplate

Complete reference of the UpdateDot11axConfigurationFeatureTemplate API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.feature_templates_wireless_dot11ax_configurations_id:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    id: string
- name: Update by id
  cisco.catalystcenter.feature_templates_wireless_dot11ax_configurations_id:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    designName: string
    featureAttributes:
      bssColor: true
      multipleBssid: true
      nonSRGObssPdMaxThreshold: 0
      obssPd: true
      radioBand: string
      targetWakeUpTime11ax: true
      targetWaketimeBroadcast: true
    id: string
    unlockedAttributes:
      - 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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)