.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-entry .. role:: ansible-option-default .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. 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.2.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. - 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 >= 2.4.4 - python >= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-channelWidth: .. rst-class:: ansible-option-title **channelWidth** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rf-profile channel width. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-defaultRfProfile: .. rst-class:: ansible-option-title **defaultRfProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IsDefault rf-profile. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-enableBrownField: .. rst-class:: ansible-option-title **enableBrownField** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if enable brown field for rf-profile else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-enableCustom: .. rst-class:: ansible-option-title **enableCustom** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if enable custom rf-profile else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-enableRadioTypeA: .. rst-class:: ansible-option-title **enableRadioTypeA** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Tru if Enable Radio Type A else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-enableRadioTypeB: .. rst-class:: ansible-option-title **enableRadioTypeB** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if Enable Radio Type B else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Custom RF profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties: .. rst-class:: ansible-option-title **radioTypeAProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Rf Profile's radioTypeAProperties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/dataRates: .. rst-class:: ansible-option-title **dataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Data Rates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/mandatoryDataRates: .. rst-class:: ansible-option-title **mandatoryDataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mandatory Data Rates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/maxPowerLevel: .. rst-class:: ansible-option-title **maxPowerLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Max Power Level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/minPowerLevel: .. rst-class:: ansible-option-title **minPowerLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Min Power Level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/parentProfile: .. rst-class:: ansible-option-title **parentProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent rf-profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/powerThresholdV1: .. rst-class:: ansible-option-title **powerThresholdV1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Power Threshold V1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/radioChannels: .. rst-class:: ansible-option-title **radioChannels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Radio Channels. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeAProperties/rxSopThreshold: .. rst-class:: ansible-option-title **rxSopThreshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rx Sop Threshold. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties: .. rst-class:: ansible-option-title **radioTypeBProperties** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Rf Profile's radioTypeBProperties. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/dataRates: .. rst-class:: ansible-option-title **dataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Data Rates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/mandatoryDataRates: .. rst-class:: ansible-option-title **mandatoryDataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mandatory Data Rates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/maxPowerLevel: .. rst-class:: ansible-option-title **maxPowerLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Max Power Level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/minPowerLevel: .. rst-class:: ansible-option-title **minPowerLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Min Power Level. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/parentProfile: .. rst-class:: ansible-option-title **parentProfile** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent rf-profile name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/powerThresholdV1: .. rst-class:: ansible-option-title **powerThresholdV1** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Power Threshold V1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/radioChannels: .. rst-class:: ansible-option-title **radioChannels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Radio Channels. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-radioTypeBProperties/rxSopThreshold: .. rst-class:: ansible-option-title **rxSopThreshold** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rx Sop Threshold. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-rfProfileName: .. rst-class:: ansible-option-title **rfProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RfProfileName path parameter. RF profile name to be deleted(required) *non-custom RF profile cannot be deleted. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.create_or_update_rf_profile, wireless.Wireless.delete_rf_profiles - Paths used are post /dna/intent/api/v1/wireless/rf-profile, delete /dna/intent/api/v1/wireless/rf-profile/{rfProfileName} - Does not support \ :literal:`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 .. 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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_rf_profile_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` "{\\n \\"executionId\\": \\"string\\",\\n \\"executionUrl\\": \\"string\\",\\n \\"message\\": \\"string\\"\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors