cisco.dnac.wireless_settings_rf_profiles module – Resource module for Wireless Settings Rf Profiles

Note

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

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

New in cisco.dnac 6.15.0

Synopsis

• This module represents an alias of the module wireless_settings_rf_profiles_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
defaultRfProfile boolean	True if RF Profile is default, else False. Maximum of only 1 RF Profile can be marked as default at any given time. 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"
enableRadioType6GHz boolean	True if 6 GHz radio band is enabled in the RF Profile, else False. Choices: false true
enableRadioTypeA boolean	True if 5 GHz radio band is enabled in the RF Profile, else False. Choices: false true
enableRadioTypeB boolean	True if 2.4 GHz radio band is enabled in the RF Profile, else False. Choices: false true
id string	Id path parameter. RF Profile ID.
radioType6GHzProperties dictionary	Wireless Settings Rf Profiles’s radioType6GHzProperties.
broadcastProbeResponseInterval integer	Broadcast Probe Response Interval of 6 GHz radio band.
coverageHoleDetectionProperties dictionary	Wireless Settings Rf Profiles’s coverageHoleDetectionProperties.
chdClientLevel integer	Coverage Hole Detection Client Level.
chdDataRssiThreshold integer	Coverage Hole Detection Data Rssi Threshold.
chdExceptionLevel integer	Coverage Hole Detection Exception Level(%).
chdVoiceRssiThreshold integer	Coverage Hole Detection Voice Rssi Threshold.
customRxSopThreshold integer	RX-SOP threshold custom configuration of 6 GHz radio band.
dataRates string	Data rates of 6 GHz radio band passed in comma separated format without any spaces. Permissible values 6, 9, 12, 18, 24, 36, 48, 54.
discoveryFrames6GHz string	Discovery Frames of 6 GHz radio band.
enableStandardPowerService boolean	True if Standard Power Service is enabled, else False. Choices: false true
fraProperties dictionary	Wireless Settings Rf Profiles’s fraProperties.
clientResetCount integer	Client Reset Count of 6 GHz radio band.
clientUtilizationThreshold integer	Client Utilization Threshold of 6 GHz radio band.
mandatoryDataRates string	Mandatory data rates of 6 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values 6, 9, 12, 18, 24, 36, 48, 54.
maxDbsWidth integer	Maximum DBS Width (Permissible Values 20,40,80,160,320).
maxPowerLevel integer	Maximum power level of 6 GHz radio band.
maxRadioClients integer	Client Limit of 6 GHz radio band.
minDbsWidth integer	Minimum DBS Width (Permissible Values 20,40,80,160,320).
minPowerLevel integer	Minimum power level of 6 GHz radio band.
multiBssidProperties dictionary	Wireless Settings Rf Profiles’s multiBssidProperties.
dot11axParameters dictionary	Wireless Settings Rf Profiles’s dot11axParameters.
muMimoDownLink boolean	MU-MIMO Downlink. Choices: false true
muMimoUpLink boolean	MU-MIMO Uplink. Choices: false true
ofdmaDownLink boolean	OFDMA Downlink. Choices: false true
ofdmaUpLink boolean	OFDMA Uplink. Choices: false true
dot11beParameters dictionary	Wireless Settings Rf Profiles’s dot11beParameters.
muMimoDownLink boolean	MU-MIMO Downlink. Choices: false true
muMimoUpLink boolean	MU-MIMO Uplink. Choices: false true
ofdmaDownLink boolean	OFDMA Downlink. Choices: false true
ofdmaMultiRu boolean	OFDMA Multi-RU. Choices: false true
ofdmaUpLink boolean	OFDMA Uplink. Choices: false true
targetWakeTime boolean	Target Wake Time. Choices: false true
twtBroadcastSupport boolean	TWT Broadcast Support. Choices: false true
parentProfile string	Parent profile of 6 GHz radio band.
powerThresholdV1 integer	Power threshold of 6 GHz radio band.
preamblePuncture boolean	Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher. Choices: false true
pscEnforcingEnabled boolean	PSC Enforcing Enable for 6 GHz radio band. Choices: false true
radioChannels string	DCA channels of 6 GHz radio band passed in comma separated format without any spaces. Permissible values 1, 5, 9, 13, 17, 21, 25, 29, 33, 37, 41, 45, 49, 53, 57, 61, 65, 69, 73, 77, 81, 85, 89, 93, 97, 101, 105, 109, 113, 117, 121, 125, 129, 133, 137, 141, 145, 149, 153, 157, 161, 165, 169, 173, 177, 181, 185, 189, 193, 197, 201, 205, 209, 213, 217, 221, 225, 229, 233.
rxSopThreshold string	RX-SOP threshold of 6 GHz radio band.
spatialReuseProperties dictionary	Wireless Settings Rf Profiles’s spatialReuseProperties.
dot11axNonSrgObssPacketDetect boolean	Dot11ax Non SRG OBSS PD. Choices: false true
dot11axNonSrgObssPacketDetectMaxThreshold integer	Dot11ax Non SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetect boolean	Dot11ax SRG OBSS PD. Choices: false true
dot11axSrgObssPacketDetectMaxThreshold integer	Dot11ax SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetectMinThreshold integer	Dot11ax SRG OBSS PD Min Threshold.
radioTypeAProperties dictionary	Wireless Settings Rf Profiles’s radioTypeAProperties.
channelWidth string	Channel Width.
coverageHoleDetectionProperties dictionary	Wireless Settings Rf Profiles’s coverageHoleDetectionProperties.
chdClientLevel integer	Coverage Hole Detection Client Level.
chdDataRssiThreshold integer	Coverage Hole Detection Data Rssi Threshold.
chdExceptionLevel integer	Coverage Hole Detection Exception Level(%).
chdVoiceRssiThreshold integer	Coverage Hole Detection Voice Rssi Threshold.
customRxSopThreshold integer	RX-SOP threshold custom configuration of 5 GHz radio band.
dataRates string	Data rates of 5 GHz radio band passed in comma separated format without any spaces. Permissible values 6, 9, 12, 18, 24, 36, 48, 54.
fraProperties dictionary	Wireless Settings Rf Profiles’s fraProperties.
clientAware boolean	Client Aware of 5 GHz radio band. Choices: false true
clientReset integer	Client Reset(%) of 5 GHz radio band.
clientSelect integer	Client Select(%) of 5 GHz radio band.
mandatoryDataRates string	Mandatory data rates of 5 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values 6, 9, 12, 18, 24, 36, 48, 54.
maxPowerLevel integer	Maximum power level of 5 GHz radio band.
maxRadioClients integer	Client Limit of 5 GHz radio band.
minPowerLevel integer	Minimum power level of 5 GHz radio band.
parentProfile string	Parent profile of 5 GHz radio band.
powerThresholdV1 integer	Power threshold of 5 GHz radio band.
preamblePuncture boolean	Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher. Choices: false true
radioChannels string	DCA channels of 5 GHz radio band passed in comma separated format without any spaces. Permissible values 36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140, 144, 149, 153, 157, 161, 165, 169, 173.
rxSopThreshold string	RX-SOP threshold of 5 GHz radio band.
spatialReuseProperties dictionary	Wireless Settings Rf Profiles’s spatialReuseProperties.
dot11axNonSrgObssPacketDetect boolean	Dot11ax Non SRG OBSS PD. Choices: false true
dot11axNonSrgObssPacketDetectMaxThreshold integer	Dot11ax Non SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetect boolean	Dot11ax SRG OBSS PD. Choices: false true
dot11axSrgObssPacketDetectMaxThreshold integer	Dot11ax SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetectMinThreshold integer	Dot11ax SRG OBSS PD Min Threshold.
zeroWaitDfsEnable boolean	Zero Wait DFS is applicable only for IOS-XE based Wireless Controllers running 17.9.1 and above versions. Choices: false true
radioTypeBProperties dictionary	Wireless Settings Rf Profiles’s radioTypeBProperties.
coverageHoleDetectionProperties dictionary	Wireless Settings Rf Profiles’s coverageHoleDetectionProperties.
chdClientLevel integer	Coverage Hole Detection Client Level.
chdDataRssiThreshold integer	Coverage Hole Detection Data Rssi Threshold.
chdExceptionLevel integer	Coverage Hole Detection Exception Level(%).
chdVoiceRssiThreshold integer	Coverage Hole Detection Voice Rssi Threshold.
customRxSopThreshold integer	RX-SOP threshold custom configuration of 2.4 GHz radio band.
dataRates string	Data rates of 2.4 GHz radio band passed in comma separated format without any spaces. Permissible values 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54.
mandatoryDataRates string	Mandatory data rates of 2.4 GHz radio band passed in comma separated format without any spaces and must be a subset of selected dataRates with maximum of 2 values. Permissible values 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54.
maxPowerLevel integer	Maximum power level of 2.4 GHz radio band.
maxRadioClients integer	Client Limit of 2.4 GHz radio band.
minPowerLevel integer	Minimum power level of 2.4 GHz radio band.
parentProfile string	Parent profile of 2.4 GHz radio band.
powerThresholdV1 integer	Power threshold of 2.4 GHz radio band.
radioChannels string	DCA channels of 2.4 GHz radio band passed in comma separated format without any spaces. Permissible values 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14.
rxSopThreshold string	RX-SOP threshold of 2.4 GHz radio band.
spatialReuseProperties dictionary	Wireless Settings Rf Profiles’s spatialReuseProperties.
dot11axNonSrgObssPacketDetect boolean	Dot11ax Non SRG OBSS PD. Choices: false true
dot11axNonSrgObssPacketDetectMaxThreshold integer	Dot11ax Non SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetect boolean	Dot11ax SRG OBSS PD. Choices: false true
dot11axSrgObssPacketDetectMaxThreshold integer	Dot11ax SRG OBSS PD Max Threshold.
dot11axSrgObssPacketDetectMinThreshold integer	Dot11ax SRG OBSS PD Min Threshold.
rfProfileName string	RF Profile Name.
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.create_rf_profile_v1, wireless.Wireless.delete_rf_profile_v1, wireless.Wireless.update_rf_profile_v1,

• Paths used are post /dna/intent/api/v1/wirelessSettings/rfProfiles, delete /dna/intent/api/v1/wirelessSettings/rfProfiles/{id}, put /dna/intent/api/v1/wirelessSettings/rfProfiles/{id},

• It should be noted that this module is an alias of wireless_settings_rf_profiles_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 CreateRFProfileV1

Complete reference of the CreateRFProfileV1 API.

Cisco DNA Center documentation for Wireless DeleteRFProfileV1

Complete reference of the DeleteRFProfileV1 API.

Cisco DNA Center documentation for Wireless UpdateRFProfileV1

Complete reference of the UpdateRFProfileV1 API.

Examples

- name: Create
  cisco.dnac.wireless_settings_rf_profiles:
    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
    defaultRfProfile: true
    enableRadioType6GHz: true
    enableRadioTypeA: true
    enableRadioTypeB: true
    radioType6GHzProperties:
      broadcastProbeResponseInterval: 0
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      discoveryFrames6GHz: string
      enableStandardPowerService: true
      fraProperties:
        clientResetCount: 0
        clientUtilizationThreshold: 0
      mandatoryDataRates: string
      maxDbsWidth: 0
      maxPowerLevel: 0
      maxRadioClients: 0
      minDbsWidth: 0
      minPowerLevel: 0
      multiBssidProperties:
        dot11axParameters:
          muMimoDownLink: true
          muMimoUpLink: true
          ofdmaDownLink: true
          ofdmaUpLink: true
        dot11beParameters:
          muMimoDownLink: true
          muMimoUpLink: true
          ofdmaDownLink: true
          ofdmaMultiRu: true
          ofdmaUpLink: true
        targetWakeTime: true
        twtBroadcastSupport: true
      parentProfile: string
      powerThresholdV1: 0
      preamblePuncture: true
      pscEnforcingEnabled: true
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
    radioTypeAProperties:
      channelWidth: string
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      fraProperties:
        clientAware: true
        clientReset: 0
        clientSelect: 0
      mandatoryDataRates: string
      maxPowerLevel: 0
      maxRadioClients: 0
      minPowerLevel: 0
      parentProfile: string
      powerThresholdV1: 0
      preamblePuncture: true
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
      zeroWaitDfsEnable: true
    radioTypeBProperties:
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      mandatoryDataRates: string
      maxPowerLevel: 0
      maxRadioClients: 0
      minPowerLevel: 0
      parentProfile: string
      powerThresholdV1: 0
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
    rfProfileName: string
- name: Delete by id
  cisco.dnac.wireless_settings_rf_profiles:
    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.wireless_settings_rf_profiles:
    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
    defaultRfProfile: true
    enableRadioType6GHz: true
    enableRadioTypeA: true
    enableRadioTypeB: true
    id: string
    radioType6GHzProperties:
      broadcastProbeResponseInterval: 0
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      discoveryFrames6GHz: string
      enableStandardPowerService: true
      fraProperties:
        clientResetCount: 0
        clientUtilizationThreshold: 0
      mandatoryDataRates: string
      maxDbsWidth: 0
      maxPowerLevel: 0
      maxRadioClients: 0
      minDbsWidth: 0
      minPowerLevel: 0
      multiBssidProperties:
        dot11axParameters:
          muMimoDownLink: true
          muMimoUpLink: true
          ofdmaDownLink: true
          ofdmaUpLink: true
        dot11beParameters:
          muMimoDownLink: true
          muMimoUpLink: true
          ofdmaDownLink: true
          ofdmaMultiRu: true
          ofdmaUpLink: true
        targetWakeTime: true
        twtBroadcastSupport: true
      parentProfile: string
      powerThresholdV1: 0
      preamblePuncture: true
      pscEnforcingEnabled: true
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
    radioTypeAProperties:
      channelWidth: string
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      fraProperties:
        clientAware: true
        clientReset: 0
        clientSelect: 0
      mandatoryDataRates: string
      maxPowerLevel: 0
      maxRadioClients: 0
      minPowerLevel: 0
      parentProfile: string
      powerThresholdV1: 0
      preamblePuncture: true
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
      zeroWaitDfsEnable: true
    radioTypeBProperties:
      coverageHoleDetectionProperties:
        chdClientLevel: 0
        chdDataRssiThreshold: 0
        chdExceptionLevel: 0
        chdVoiceRssiThreshold: 0
      customRxSopThreshold: 0
      dataRates: string
      mandatoryDataRates: string
      maxPowerLevel: 0
      maxRadioClients: 0
      minPowerLevel: 0
      parentProfile: string
      powerThresholdV1: 0
      radioChannels: string
      rxSopThreshold: string
      spatialReuseProperties:
        dot11axNonSrgObssPacketDetect: true
        dot11axNonSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetect: true
        dot11axSrgObssPacketDetectMaxThreshold: 0
        dot11axSrgObssPacketDetectMinThreshold: 0
    rfProfileName: 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)

Collection links

• Issue Tracker
• Repository (Sources)