/ home / cisco / cisco.dnac / 2.0.7 / module / wireless_rf_profile

cisco.dnac.wireless_rf_profile (2.0.7) — module

Manage WirelessRfProfile objects of Wireless

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Retrieve all RF profiles.

Create or Update RF profile.

Delete RF profile(s).

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: retrieve_rf_profiles
  cisco.dnac.wireless_rf_profile:
    state: query  # required
    rf_profile_name: SomeValue  # string
  register: nm_retrieve_rf_profiles

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- name: delete_rf_profiles
  cisco.dnac.wireless_rf_profile:
    state: delete  # required
    rf_profile_name: SomeValue  # string, required

Inputs

    
name:
    description:
    - Name, property of the request body.
    - Required for state create.
    type: str

channelWidth:
    description:
    - Channel Width, property of the request body.
    - Required for state create.
    type: str

enableCustom:
    description:
    - EnableCustom, property of the request body.
    - Required for state create.
    type: bool

rf_profile_name:
    description:
    - Rf-profile-name query parameter.
    - Rf-profile-name path parameter.
    - Required for state delete.
    type: str

defaultRfProfile:
    description:
    - DefaultRfProfile, property of the request body.
    - Required for state create.
    type: bool

enableBrownField:
    description:
    - EnableBrownField, property of the request body.
    - Required for state create.
    type: bool

enableRadioTypeA:
    description:
    - EnableRadioTypeA, property of the request body.
    - Required for state create.
    type: bool

enableRadioTypeB:
    description:
    - EnableRadioTypeB, property of the request body.
    - Required for state create.
    type: bool

radioTypeAProperties:
    description:
    - Radio Type AProperties, property of the request body.
    suboptions:
      dataRates:
        description:
        - It is the wireless rf profile's dataRates.
        type: str
      mandatoryDataRates:
        description:
        - It is the wireless rf profile's mandatoryDataRates.
        type: str
      maxPowerLevel:
        description:
        - It is the wireless rf profile's maxPowerLevel.
        type: int
      minPowerLevel:
        description:
        - It is the wireless rf profile's minPowerLevel.
        type: int
      parentProfile:
        description:
        - It is the wireless rf profile's parentProfile.
        type: str
      powerThresholdV1:
        description:
        - It is the wireless rf profile's powerThresholdV1.
        type: int
      radioChannels:
        description:
        - It is the wireless rf profile's radioChannels.
        type: str
      rxSopThreshold:
        description:
        - It is the wireless rf profile's rxSopThreshold.
        type: str
    type: dict

radioTypeBProperties:
    description:
    - Radio Type BProperties, property of the request body.
    suboptions:
      dataRates:
        description:
        - It is the wireless rf profile's dataRates.
        type: str
      mandatoryDataRates:
        description:
        - It is the wireless rf profile's mandatoryDataRates.
        type: str
      maxPowerLevel:
        description:
        - It is the wireless rf profile's maxPowerLevel.
        type: int
      minPowerLevel:
        description:
        - It is the wireless rf profile's minPowerLevel.
        type: int
      parentProfile:
        description:
        - It is the wireless rf profile's parentProfile.
        type: str
      powerThresholdV1:
        description:
        - It is the wireless rf profile's powerThresholdV1.
        type: int
      radioChannels:
        description:
        - It is the wireless rf profile's radioChannels.
        type: str
      rxSopThreshold:
        description:
        - It is the wireless rf profile's rxSopThreshold.
        type: str
    type: dict

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: wireless.create_or_update_rf_profile
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also