cisco.catalystcenter.wireless_settings_dot11be_profiles_info module -- Information module for Wireless Settings Dot11be Profiles

Note

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

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_settings_dot11be_profiles_info.

New in cisco.catalystcenter 1.0.0

Synopsis

  • Get all Wireless Settings Dot11be Profiles.

  • Get Wireless Settings Dot11be Profiles by id.

  • This API allows the user to get 802.11be Profile by ID.

  • This API allows the user to get all 802.11be Profiles configured under Wireless Settings.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

headers

dictionary

Additional headers.

id

string

Id path parameter. 802.11be Profile ID.

boolean

IsMuMimoDownLink query parameter. MU-MIMO Downlink.

Choices:

boolean

IsMuMimoUpLink query parameter. MU-MIMO Uplink.

Choices:

boolean

IsOfDmaDownLink query parameter. OFDMA Downlink.

Choices:

isOfDmaMultiRu

boolean

IsOfDmaMultiRu query parameter. OFDMA Multi-RU.

Choices:

boolean

IsOfDmaUpLink query parameter. OFDMA Downlink.

Choices:

limit

integer

Limit query parameter.

offset

integer

Offset query parameter.

profileName

string

ProfileName query parameter. Profile Name.

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.get80211be_profiles_by_id, wireless.Wireless.get_all80211be_profiles,

  • Paths used are get /dna/intent/api/v1/wirelessSettings/dot11beProfiles, get /dna/intent/api/v1/wirelessSettings/dot11beProfiles/{id},

  • Supports 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Wireless Get80211beProfilesByID

Complete reference of the Get80211beProfilesByID API.

Cisco Catalyst Center documentation for Wireless GetAll80211beProfiles

Complete reference of the GetAll80211beProfiles API.

Examples

---
- name: Get all Wireless Settings Dot11be Profiles
  cisco.catalystcenter.wireless_settings_dot11be_profiles_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    limit: 500
    offset: 1
    profileName: string
    isOfDmaDownLink: true
    isOfDmaUpLink: true
    isMuMimoUpLink: true
    isMuMimoDownLink: true
    isOfDmaMultiRu: true
  register: result
- name: Get Wireless Settings Dot11be Profiles by id
  cisco.catalystcenter.wireless_settings_dot11be_profiles_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"default": true, "description": "string", "id": "string", "mloGroup": {"primary24GhzEnable": true, "primary5GhzEnable": true, "primary6GhzEnable": true, "secondary5GhzEnable": true}, "muMimoDownLink": true, "muMimoUpLink": true, "ofdmaDownLink": true, "ofdmaMultiRu": true, "ofdmaUpLink": true, "profileName": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)