.. 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.feature_templates_wireless_dot11ax_configurations_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.feature_templates_wireless_dot11ax_configurations module -- Resource module for Feature Templates Wireless Dot11ax Configurations ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.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.feature_templates_wireless_dot11ax_configurations`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.18.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Feature Templates Wireless Dot11ax Configurations. - This API allows users to create a Dot11ax configuration feature template. - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.11.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-designname: .. rst-class:: ansible-option-title **designName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The feature template design name. \`Note \` The following characters are not allowed % & \< \> ' /. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_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.feature_templates_wireless_dot11ax_configurations_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:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes: .. rst-class:: ansible-option-title **featureAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Feature Templates Wireless Dot11ax Configurations's featureAttributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/bsscolor: .. rst-class:: ansible-option-title **bssColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
BSS (Basic Service Set) Color is supported on Cisco IOS-XE based Wireless Controllers running 17.1 and above. .. 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.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/multiplebssid: .. rst-class:: ansible-option-title **multipleBssid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. 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.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/nonsrgobsspdmaxthreshold: .. rst-class:: ansible-option-title **nonSRGObssPdMaxThreshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/obsspd: .. rst-class:: ansible-option-title **obssPd** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. 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.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/radioband: .. rst-class:: ansible-option-title **radioBand** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
6 GHz radioBand is supported only on Cisco IOS-XE based Wireless Controllers running 17.7.1 and above. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/targetwaketimebroadcast: .. rst-class:: ansible-option-title **targetWaketimeBroadcast** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Target Wake Time Broadcast is supported on Cisco IOS-XE based Wireless Controllers running 17.3.1 and above. .. 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.feature_templates_wireless_dot11ax_configurations_module__parameter-featureattributes/targetwakeuptime11ax: .. rst-class:: ansible-option-title **targetWakeUpTime11ax** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Target Wake Up Time 11ax is supported on Cisco IOS-XE based Wireless Controllers running 17.1 and above. .. 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.feature_templates_wireless_dot11ax_configurations_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Dot11ax Configuration Feature Template Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_module__parameter-unlockedattributes: .. rst-class:: ansible-option-title **unlockedAttributes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Attributes unlocked in design can be changed at device provision time. \`Note \` unlockedAttributes can only contain the attributes defined under featureAttributes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.feature_templates_wireless_dot11ax_configurations_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.create\_dot11ax\_configuration\_feature\_template, wireless.Wireless.delete\_dot11ax\_configuration\_feature\_template, wireless.Wireless.update\_dot11ax\_configuration\_feature\_template, - Paths used are post /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations, delete /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/{id}, put /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/{id}, - 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 CreateDot11axConfigurationFeatureTemplate `_ Complete reference of the CreateDot11axConfigurationFeatureTemplate API. `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 Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.feature_templates_wireless_dot11ax_configurations: 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}}" state: present designName: string featureAttributes: bssColor: true multipleBssid: true nonSRGObssPdMaxThreshold: 0 obssPd: true radioBand: string targetWakeUpTime11ax: true targetWaketimeBroadcast: true unlockedAttributes: - string - name: Delete by id cisco.dnac.feature_templates_wireless_dot11ax_configurations: 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}}" state: absent id: string - name: Update by id cisco.dnac.feature_templates_wireless_dot11ax_configurations: 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}}" state: present designName: string featureAttributes: bssColor: true multipleBssid: true nonSRGObssPdMaxThreshold: 0 obssPd: true radioBand: string targetWakeUpTime11ax: true targetWaketimeBroadcast: true id: string unlockedAttributes: - 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.feature_templates_wireless_dot11ax_configurations_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