cisco.dnac.wireless_rf_profile – Resource module for Wireless Rf Profile

Note

This plugin is part of the cisco.dnac collection (version 3.2.2).

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.

To use it in a playbook, specify: cisco.dnac.wireless_rf_profile.

New in version 3.1.0: of cisco.dnac

Synopsis

  • Manage operations create and delete of the resource Wireless 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.3.1

  • python >= 3.5

Parameters

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.2.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.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

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

See Also

See also

Wireless Rf Profile reference

Complete reference of the Wireless Rf Profile object model.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

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" }


Authors

  • Rafael Campos (@racampos)