cisco.catalystcenter.wireless_rf_profile module -- Resource module for Wireless Rf Profile

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operations create and delete of the resource Wireless Rf Profile.

  • Create or Update RF profile.

  • Delete RF profile.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

channelWidth

string

Channel Width.

defaultRfProfile

boolean

Is Default Rf Profile.

Choices:

enableBrownField

boolean

Enable Brown Field.

Choices:

enableCustom

boolean

Enable Custom.

Choices:

enableRadioTypeA

boolean

Enable Radio Type A.

Choices:

enableRadioTypeB

boolean

Enable Radio Type B.

Choices:

enableRadioTypeC

boolean

Enable Radio Type C (6GHz).

Choices:

name

string

RF Profile Name.

radioTypeAProperties

dictionary

Wireless Rf Profile's radioTypeAProperties.

dataRates

string

Data Rates (Default "6,9,12,18,24,36,48,54").

mandatoryDataRates

string

Mandatory Data Rates (Default "6,12,24").

maxPowerLevel

float

Max Power Level (Default 30).

minPowerLevel

float

Rx Sop Threshold (Default -10).

parentProfile

string

Parent Profile (Default CUSTOM).

powerThresholdV1

float

Power Threshold V1 ( (Default -70).

radioChannels

string

Radio Channels (Default "36,40,44,48,52,56,60,64,149,153,157,161").

rxSopThreshold

string

Rx Sop Threshold (Default "AUTO").

radioTypeBProperties

dictionary

Wireless Rf Profile's radioTypeBProperties.

dataRates

string

Data Rates (Default "9,11,12,18,24,36,48,54").

mandatoryDataRates

string

Mandatory Data Rates (Default "12").

maxPowerLevel

float

Max Power Level (Default 30).

minPowerLevel

float

Min Power Level (Default -10).

parentProfile

string

Parent Profile (Default CUSTOM).

powerThresholdV1

float

Power Threshold V1 (Default -70).

radioChannels

string

Radio Channels (Default "9,11,12,18,24,36,48,54").

rxSopThreshold

string

Rx Sop Threshold (Default "AUTO").

radioTypeCProperties

dictionary

Wireless Rf Profile's radioTypeCProperties.

dataRates

string

Data Rates (Default "6,9,12,18,24,36,48,54").

mandatoryDataRates

string

Mandatory Data Rates (Default "6,12,24").

maxPowerLevel

float

Max Power Level (Default 30).

minPowerLevel

float

Min Power Level (Default -10).

parentProfile

string

Parent Profile (Default CUSTOM).

powerThresholdV1

float

Power Threshold V1 (Default -70).

radioChannels

string

Radio Channels (Default "5,21,37,53,69,85,101,117,133,149,165,181,197,213,229").

rxSopThreshold

string

Rx Sop Threshold (Default "AUTO").

rfProfileName

string

RfProfileName path parameter. RF profile name to be deleted(required) *non-custom RF profile cannot be deleted.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Wireless CreateOrUpdateRFProfile

Complete reference of the CreateOrUpdateRFProfile API.

Cisco DNA Center documentation for Wireless DeleteRFProfiles

Complete reference of the DeleteRFProfiles API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_rf_profile:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    channelWidth: string
    defaultRfProfile: true
    enableBrownField: true
    enableCustom: true
    enableRadioTypeA: true
    enableRadioTypeB: true
    enableRadioTypeC: 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
    radioTypeCProperties:
      dataRates: string
      mandatoryDataRates: string
      maxPowerLevel: 0
      minPowerLevel: 0
      parentProfile: string
      powerThresholdV1: 0
      radioChannels: string
      rxSopThreshold: string
- name: Delete by name
  cisco.catalystcenter.wireless_rf_profile:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    rfProfileName: string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

  • Rafael Campos (@racampos)