.. 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 .. Anchors .. _ansible_collections.cisco.dnac.wireless_rf_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_rf_profile -- Resource module for Wireless Rf Profile +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 4.1.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 :code:`ansible-galaxy collection list`. 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:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and delete of the resource Wireless Rf Profile. .. 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 >= 2.4.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
channelWidth
string
Rf-profile channel width.
defaultRfProfile
boolean
    Choices:
  • no
  • yes
IsDefault rf-profile.
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.3.3"
Informs the SDK which version of Cisco DNA Center to use.
enableBrownField
boolean
    Choices:
  • no
  • yes
True if enable brown field for rf-profile else false.
enableCustom
boolean
    Choices:
  • no
  • yes
True if enable custom rf-profile else false.
enableRadioTypeA
boolean
    Choices:
  • no
  • yes
Tru if Enable Radio Type A else false.
enableRadioTypeB
boolean
    Choices:
  • no
  • yes
True if Enable Radio Type B else false.
name
string
Custom RF profile name.
radioTypeAProperties
dictionary
Wireless Rf Profile's radioTypeAProperties.
dataRates
string
Data Rates.
mandatoryDataRates
string
Mandatory Data Rates.
maxPowerLevel
integer
Max Power Level.
minPowerLevel
integer
Min Power Level.
parentProfile
string
Parent rf-profile name.
powerThresholdV1
integer
Power Threshold V1.
radioChannels
string
Radio Channels.
rxSopThreshold
string
Rx Sop Threshold.
radioTypeBProperties
dictionary
Wireless Rf Profile's radioTypeBProperties.
dataRates
string
Data Rates.
mandatoryDataRates
string
Mandatory Data Rates.
maxPowerLevel
integer
Max Power Level.
minPowerLevel
integer
Min Power Level.
parentProfile
string
Parent rf-profile name.
powerThresholdV1
integer
Power Threshold V1.
radioChannels
string
Radio Channels.
rxSopThreshold
string
Rx Sop Threshold.
rfProfileName
string
RfProfileName path parameter. RF profile name to be deleted(required) *non-custom RF profile cannot be deleted.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - 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 .. Seealso See Also -------- .. seealso:: `Wireless Rf Profile reference `_ Complete reference of the Wireless Rf Profile object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.wireless_rf_profile: 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 channelWidth: string defaultRfProfile: true enableBrownField: true enableCustom: true enableRadioTypeA: true enableRadioTypeB: true name: string radioTypeAProperties: dataRates: string mandatoryDataRates: string maxPowerLevel: 0 minPowerLevel: 0 parentProfile: string powerThresholdV1: 0 radioChannels: string rxSopThreshold: string radioTypeBProperties: dataRates: string mandatoryDataRates: string maxPowerLevel: 0 minPowerLevel: 0 parentProfile: string powerThresholdV1: 0 radioChannels: string rxSopThreshold: string - name: Delete by name cisco.dnac.wireless_rf_profile: 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 rfProfileName: string .. 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 or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "executionId": "string", "executionUrl": "string", "message": "string" }


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