cisco.dnac.feature_templates_wireless_clean_air_configurations module -- Resource module for Feature Templates Wireless Clean Air Configurations

Note

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

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

New in cisco.dnac 6.18.0

Synopsis

  • Manage operations create, update and delete of the resource Feature Templates Wireless Clean Air Configurations.

  • This API allows users to create a CleanAir configuration feature template.

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

  • This API allows users to update the details of a specific CleanAir 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.

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

designName

string

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

featureAttributes

dictionary

Feature Templates Wireless Clean Air Configurations's featureAttributes.

cleanAir

boolean

Clean Air.

Choices:

cleanAirDeviceReporting

boolean

CleanAir Device Reporting.

Choices:

description

string

CleanAir Description.

interferersFeatures

dictionary

Feature Templates Wireless Clean Air Configurations's interferersFeatures.

bleBeacon

boolean

BLE Beacon is only applicable for Radio Band 2_4GHZ.

Choices:

bluetoothPagingInquiry

boolean

Bluetooth Paging Inquiry is only applicable for Radio Band 2_4GHZ.

Choices:

bluetoothScoAcl

boolean

Bluetooth SCO ACL is only applicable for Radio Band 2_4GHZ.

Choices:

continuousTransmitter

boolean

Continuous Transmitter is applicable for Radio Bands 2_4GHZ, 5GHZ, 6GHZ.

Choices:

genericDect

boolean

Generic DECT is only applicable for Radio Bands 2_4GHZ, 5GHZ.

Choices:

genericTdd

boolean

Generic TDD is only applicable for Radio Band 2_4GHZ, 5GHZ.

Choices:

jammer

boolean

Jammer is only applicable for Radio Band 2_4GHZ, 5GHZ.

Choices:

microwaveOven

boolean

Microwave Oven is only applicable for Radio Band 2_4GHZ.

Choices:

motorolaCanopy

boolean

Motorola Canopy is only applicable for Radio Band 2_4GHZ, 5GHZ.

Choices:

siFhss

boolean

SI FHSS is only applicable for Radio Band 2_4GHZ, 5GHZ.

Choices:

spectrum80211Fh

boolean

Spectrum 802.11 FH is only applicable for Radio Band 2_4GHZ.

Choices:

spectrum80211NonStandardChannel

boolean

Spectrum 802.11 Non STD Channel is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

spectrum802154

boolean

Spectrum 802.15.4 is only applicable for Radio Band 2_4GHZ.

Choices:

spectrumInverted

boolean

Spectrum Inverted is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

superAg

boolean

Super AG is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

videoCamera

boolean

Video Camera is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

wimaxFixed

boolean

WiMAX Fixed is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

wimaxMobile

boolean

WiMAX Mobile is only applicable for Radio Band 2_4GHZ and 5GHZ.

Choices:

xbox

boolean

Xbox is only applicable for Radio Band 2_4GHZ.

Choices:

persistentDevicePropagation

boolean

Persistent Device Propagation.

Choices:

radioBand

string

Radio Band.

id

string

Id path parameter. Clean Air 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 first level attributes defined under featureAttributes.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are wireless.Wireless.create_clean_air_configuration_feature_template, wireless.Wireless.delete_clean_air_configuration_feature_template, wireless.Wireless.update_clean_air_configuration_feature_template,

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

  • 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 CreateCleanAirConfigurationFeatureTemplate

Complete reference of the CreateCleanAirConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless DeleteCleanAirConfigurationFeatureTemplate

Complete reference of the DeleteCleanAirConfigurationFeatureTemplate API.

Cisco DNA Center documentation for Wireless UpdateCleanAirConfigurationFeatureTemplate

Complete reference of the UpdateCleanAirConfigurationFeatureTemplate API.

Examples

---
- name: Create
  cisco.dnac.feature_templates_wireless_clean_air_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:
      cleanAir: true
      cleanAirDeviceReporting: true
      description: string
      interferersFeatures:
        bleBeacon: true
        bluetoothPagingInquiry: true
        bluetoothScoAcl: true
        continuousTransmitter: true
        genericDect: true
        genericTdd: true
        jammer: true
        microwaveOven: true
        motorolaCanopy: true
        siFhss: true
        spectrum80211Fh: true
        spectrum80211NonStandardChannel: true
        spectrum802154: true
        spectrumInverted: true
        superAg: true
        videoCamera: true
        wimaxFixed: true
        wimaxMobile: true
        xbox: true
      persistentDevicePropagation: true
      radioBand: string
    unlockedAttributes:
      - string
- name: Delete by id
  cisco.dnac.feature_templates_wireless_clean_air_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_clean_air_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:
      cleanAir: true
      cleanAirDeviceReporting: true
      description: string
      interferersFeatures:
        bleBeacon: true
        bluetoothPagingInquiry: true
        bluetoothScoAcl: true
        continuousTransmitter: true
        genericDect: true
        genericTdd: true
        jammer: true
        microwaveOven: true
        motorolaCanopy: true
        siFhss: true
        spectrum80211Fh: true
        spectrum80211NonStandardChannel: true
        spectrum802154: true
        spectrumInverted: true
        superAg: true
        videoCamera: true
        wimaxFixed: true
        wimaxMobile: true
        xbox: true
      persistentDevicePropagation: true
      radioBand: string
    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 DNAC Python SDK

Returned: always

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

Authors

  • Rafael Campos (@racampos)