cisco.dnac.wireless_settings_rf_profiles_v1 module – Resource module for Wireless Settings Rf Profiles V1
Note
This module is part of the cisco.dnac collection (version 6.26.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_settings_rf_profiles_v1
.
New in cisco.dnac 6.15.0
Synopsis
Manage operations create, update and delete of the resource Wireless Settings Rf Profiles V1.
This API allows the user to create a custom RF Profile.
This API allows the user to delete a custom RF Profile.
This API allows the user to update a custom RF Profile.
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 |
---|---|
True if RF Profile is default, else False. Maximum of only 1 RF Profile can be marked as default at any given time. Choices:
|
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
True if 6 GHz radio band is enabled in the RF Profile, else False. Choices:
|
|
True if 5 GHz radio band is enabled in the RF Profile, else False. Choices:
|
|
True if 2.4 GHz radio band is enabled in the RF Profile, else False. Choices:
|
|
Id path parameter. RF Profile ID. |
|
Wireless Settings Rf Profiles’s radioType6GHzProperties. |
|
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. |
|
True if Standard Power Service is enabled, else False. Choices:
|
|
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. |
|
Maximum DBS Width (Permissible Values 20,40,80,160,320). |
|
Maximum power level of 6 GHz radio band. |
|
Minimum DBS Width (Permissible Values 20,40,80,160,320). |
|
Minimum power level of 6 GHz radio band. |
|
Wireless Settings Rf Profiles’s multiBssidProperties. |
|
Wireless Settings Rf Profiles’s dot11axParameters. |
|
MU-MIMO Downlink. Choices:
|
|
MU-MIMO Uplink. Choices:
|
|
OFDMA Downlink. Choices:
|
|
OFDMA Uplink. Choices:
|
|
Wireless Settings Rf Profiles’s dot11beParameters. |
|
MU-MIMO Downlink. Choices:
|
|
MU-MIMO Uplink. Choices:
|
|
OFDMA Downlink. Choices:
|
|
OFDMA Multi-RU. Choices:
|
|
OFDMA Uplink. Choices:
|
|
Target Wake Time. Choices:
|
|
TWT Broadcast Support. Choices:
|
|
Parent profile of 6 GHz radio band. |
|
Power threshold of 6 GHz radio band. |
|
Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher. Choices:
|
|
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. |
|
RX-SOP threshold of 6 GHz radio band. |
|
Wireless Settings Rf Profiles’s radioTypeAProperties. |
|
Channel Width. |
|
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. |
|
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. |
|
Maximum power level of 5 GHz radio band. |
|
Minimum power level of 5 GHz radio band. |
|
Parent profile of 5 GHz radio band. |
|
Power threshold of 5 GHz radio band. |
|
Enable or Disable Preamble Puncturing. This Wifi 7 configuration is applicable to wireless IOS devices supporting 17.15 and higher. Choices:
|
|
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. |
|
RX-SOP threshold of 5 GHz radio band. |
|
Wireless Settings Rf Profiles’s radioTypeBProperties. |
|
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. |
|
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. |
|
Maximum power level of 2.4 GHz radio band. |
|
Minimum power level of 2.4 GHz radio band. |
|
Parent profile of 2.4 GHz radio band. |
|
Power threshold of 2.4 GHz radio band. |
|
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. |
|
RX-SOP threshold of 2.4 GHz radio band. |
|
RF Profile Name. |
|
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_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},
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_v1:
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:
dataRates: string
enableStandardPowerService: true
mandatoryDataRates: string
maxDbsWidth: 0
maxPowerLevel: 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
radioChannels: string
rxSopThreshold: string
radioTypeAProperties:
channelWidth: string
dataRates: string
mandatoryDataRates: string
maxPowerLevel: 0
minPowerLevel: 0
parentProfile: string
powerThresholdV1: 0
preamblePuncture: true
radioChannels: string
rxSopThreshold: string
radioTypeBProperties:
dataRates: string
mandatoryDataRates: string
maxPowerLevel: 0
minPowerLevel: 0
parentProfile: string
powerThresholdV1: 0
radioChannels: string
rxSopThreshold: string
rfProfileName: string
- name: Delete by id
cisco.dnac.wireless_settings_rf_profiles_v1:
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_v1:
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:
dataRates: string
enableStandardPowerService: true
mandatoryDataRates: string
maxDbsWidth: 0
maxPowerLevel: 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
radioChannels: string
rxSopThreshold: string
radioTypeAProperties:
channelWidth: string
dataRates: string
mandatoryDataRates: string
maxPowerLevel: 0
minPowerLevel: 0
parentProfile: string
powerThresholdV1: 0
preamblePuncture: true
radioChannels: string
rxSopThreshold: string
radioTypeBProperties:
dataRates: string
mandatoryDataRates: string
maxPowerLevel: 0
minPowerLevel: 0
parentProfile: string
powerThresholdV1: 0
radioChannels: string
rxSopThreshold: string
rfProfileName: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |