XLAB Steampunk logo Try Spotter
 / home / racampos / racampos.dnac / 0.0.1 / module / wireless_rf_profile

racampos.dnac.wireless_rf_profile (0.0.1) — module

Manage WirelessRfProfile objects of Wireless

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection | Add to requirements.yml | Description | Requirements | Usage examples | Inputs | Outputs

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Retrieve all RF profiles.

Create or Update RF profile.

Delete RF profile(s).


Requirements

Usage examples

Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: retrieve_rf_profiles
  cisco.dnac.wireless_rf_profile:
    state: query  # required
    rf_profile_name: SomeValue  # string
  register: query_result
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- 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

create_or_update_rf_profile:
  contains: null
  description: Create or Update RF profile.
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionUrl:
    description: Execution Url, property of the response body.
    returned: success
    sample: <executionurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
delete_rf_profiles:
  contains: null
  description: Delete RF profile(s).
  executionId:
    description: Execution Id, property of the response body.
    returned: success
    sample: <executionid>
    type: str
  executionUrl:
    description: Execution Url, property of the response body.
    returned: success
    sample: <executionurl>
    type: str
  message:
    description: Message, property of the response body.
    returned: success
    sample: <message>
    type: str
  returned: success
  type: dict
retrieve_rf_profiles:
  contains: null
  description: Retrieve all RF profiles.
  response:
    contains:
      aRadioChannels:
        description: It is the wireless rf profile's aRadioChannels.
        returned: always
        sample: <aradiochannels>
        type: str
      bRadioChannels:
        description: It is the wireless rf profile's bRadioChannels.
        returned: always
        sample: <bradiochannels>
        type: str
      channelWidth:
        description: It is the wireless rf profile's channelWidth.
        returned: always
        sample: <channelwidth>
        type: str
      dataRatesA:
        description: It is the wireless rf profile's dataRatesA.
        returned: always
        sample: <dataratesa>
        type: str
      dataRatesB:
        description: It is the wireless rf profile's dataRatesB.
        returned: always
        sample: <dataratesb>
        type: str
      defaultRfProfile:
        description: It is the wireless rf profile's defaultRfProfile.
        returned: always
        sample: false
        type: bool
      enableARadioType:
        description: It is the wireless rf profile's enableARadioType.
        returned: always
        sample: false
        type: bool
      enableBRadioType:
        description: It is the wireless rf profile's enableBRadioType.
        returned: always
        sample: false
        type: bool
      enableBrownField:
        description: It is the wireless rf profile's enableBrownField.
        returned: always
        sample: false
        type: bool
      enableCustom:
        description: It is the wireless rf profile's enableCustom.
        returned: always
        sample: false
        type: bool
      mandatoryDataRatesA:
        description: It is the wireless rf profile's mandatoryDataRatesA.
        returned: always
        sample: <mandatorydataratesa>
        type: str
      mandatoryDataRatesB:
        description: It is the wireless rf profile's mandatoryDataRatesB.
        returned: always
        sample: <mandatorydataratesb>
        type: str
      maxPowerLevelA:
        description: It is the wireless rf profile's maxPowerLevelA.
        returned: always
        sample: <maxpowerlevela>
        type: str
      maxPowerLevelB:
        description: It is the wireless rf profile's maxPowerLevelB.
        returned: always
        sample: <maxpowerlevelb>
        type: str
      minPowerLevelA:
        description: It is the wireless rf profile's minPowerLevelA.
        returned: always
        sample: <minpowerlevela>
        type: str
      minPowerLevelB:
        description: It is the wireless rf profile's minPowerLevelB.
        returned: always
        sample: <minpowerlevelb>
        type: str
      name:
        description: It is the wireless rf profile's name.
        returned: always
        sample: <name>
        type: str
      parentProfileA:
        description: It is the wireless rf profile's parentProfileA.
        returned: always
        sample: <parentprofilea>
        type: str
      parentProfileB:
        description: It is the wireless rf profile's parentProfileB.
        returned: always
        sample: <parentprofileb>
        type: str
      powerThresholdV1A:
        description: It is the wireless rf profile's powerThresholdV1A.
        returned: always
        sample: 0
        type: int
      powerThresholdV1B:
        description: It is the wireless rf profile's powerThresholdV1B.
        returned: always
        sample: 0
        type: int
      rxSopThresholdA:
        description: It is the wireless rf profile's rxSopThresholdA.
        returned: always
        sample: <rxsopthresholda>
        type: str
      rxSopThresholdB:
        description: It is the wireless rf profile's rxSopThresholdB.
        returned: always
        sample: <rxsopthresholdb>
        type: str
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict

See also

Got feedback? steampunk@xlab.si | © 2024. All rights reserved.
Cookie policy-Privacy policy-Terms of use-Security policy