.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.wireless_rf_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_rf_profile -- Manage WirelessRfProfile objects of Wireless ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.wireless_rf_profile`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Retrieve all RF profiles. - Create or Update RF profile. - Delete RF profile(s). .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
channelWidth
string
Channel Width, property of the request body.
Required for state create.
defaultRfProfile
boolean
    Choices:
  • no
  • yes
DefaultRfProfile, property of the request body.
Required for state create.
enableBrownField
boolean
    Choices:
  • no
  • yes
EnableBrownField, property of the request body.
Required for state create.
enableCustom
boolean
    Choices:
  • no
  • yes
EnableCustom, property of the request body.
Required for state create.
enableRadioTypeA
boolean
    Choices:
  • no
  • yes
EnableRadioTypeA, property of the request body.
Required for state create.
enableRadioTypeB
boolean
    Choices:
  • no
  • yes
EnableRadioTypeB, property of the request body.
Required for state create.
name
string
Name, property of the request body.
Required for state create.
radioTypeAProperties
dictionary
Radio Type AProperties, property of the request body.
dataRates
string
It is the wireless rf profile's dataRates.
mandatoryDataRates
string
It is the wireless rf profile's mandatoryDataRates.
maxPowerLevel
integer
It is the wireless rf profile's maxPowerLevel.
minPowerLevel
integer
It is the wireless rf profile's minPowerLevel.
parentProfile
string
It is the wireless rf profile's parentProfile.
powerThresholdV1
integer
It is the wireless rf profile's powerThresholdV1.
radioChannels
string
It is the wireless rf profile's radioChannels.
rxSopThreshold
string
It is the wireless rf profile's rxSopThreshold.
radioTypeBProperties
dictionary
Radio Type BProperties, property of the request body.
dataRates
string
It is the wireless rf profile's dataRates.
mandatoryDataRates
string
It is the wireless rf profile's mandatoryDataRates.
maxPowerLevel
integer
It is the wireless rf profile's maxPowerLevel.
minPowerLevel
integer
It is the wireless rf profile's minPowerLevel.
parentProfile
string
It is the wireless rf profile's parentProfile.
powerThresholdV1
integer
It is the wireless rf profile's powerThresholdV1.
radioChannels
string
It is the wireless rf profile's radioChannels.
rxSopThreshold
string
It is the wireless rf profile's rxSopThreshold.
rf_profile_name
string
Rf-profile-name query parameter.
Rf-profile-name path parameter.
Required for state delete.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.wireless_rf_profile ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.wireless_rf_profile** module. `WirelessRfProfile reference `_ Complete reference of the WirelessRfProfile object model. `WirelessRfProfile reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: retrieve_rf_profiles cisco.dnac.wireless_rf_profile: state: query # required rf_profile_name: SomeValue # string register: nm_retrieve_rf_profiles - name: create_or_update_rf_profile cisco.dnac.wireless_rf_profile: state: create # required channelWidth: SomeValue # string, required defaultRfProfile: True # boolean, required enableBrownField: True # boolean, required enableCustom: True # boolean, required enableRadioTypeA: True # boolean, required enableRadioTypeB: True # boolean, required name: SomeValue # string, required radioTypeAProperties: parentProfile: SomeValue # string radioChannels: SomeValue # string dataRates: SomeValue # string mandatoryDataRates: SomeValue # string powerThresholdV1: 1 # number rxSopThreshold: SomeValue # string minPowerLevel: 1 # number maxPowerLevel: 1 # number radioTypeBProperties: parentProfile: SomeValue # string radioChannels: SomeValue # string dataRates: SomeValue # string mandatoryDataRates: SomeValue # string powerThresholdV1: 1 # number rxSopThreshold: SomeValue # string minPowerLevel: 1 # number maxPowerLevel: 1 # number - name: delete_rf_profiles cisco.dnac.wireless_rf_profile: state: delete # required rf_profile_name: SomeValue # string, required .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
wireless.create_or_update_rf_profile


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors