cisco.catalystcenter.wireless_settings_dot11be_profiles module -- Resource module for Wireless Settings Dot11be Profiles

Note

This module is part of the cisco.catalystcenter collection (version 2.11.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.

New in cisco.catalystcenter 1.0.0

Synopsis

  • Manage operations create, update and delete of the resource Wireless Settings Dot11be Profiles.

  • This API allows the user to create a 802.11be Profile. - > This API allows the user to delete a 802.11be Profile, if the 802.11be Profile is not mapped to any Wireless Network Profile.

  • This API allows the user to update a 802.11be Profile.

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

default

boolean

## Default Profile Flag Specifies whether this 802.11be profile's properties should be set to system default profile on device(`default-dot11be-profile`) or not. ### Configuration Values * `true` - When a profile is marked with `default` as `true` ,configuration is pushed to device's `'default-dot11be-profile'`. * `false` - The profile is treated as a custom 802.11be Profile. ### Version Compatibility Table | IOS-XE Version | Supports Default Profile | Supports Custom Profile | | --------------------------- | ----------------------- | ---------------------- | |>=17.15.2 and <17.18.1 | ✅ Yes | ❌ No | |>= 17.18.1 | ✅ Yes | ✅ Yes | > NOTE > Setting a profile as custom (`default=false`) on devices with IOS-XE versions below 17.18.1 will result in a provisioning failure.

Choices:

description

string

Description of 802.11be Profile. If not passed `profileName` will be used as description.

id

string

802.11be Profile ID.

mloGroup

dictionary

`Multi Link Operation (MLO)` configs is applicable from IOS-XE version 17.18.1.

primary24GhzEnable

boolean

Indicates if primary 2.4GHz MLO link is enabled.

Choices:

primary5GhzEnable

boolean

Indicates if primary 5GHz MLO link is enabled.

Choices:

primary6GhzEnable

boolean

Indicates if primary 6GHz MLO link is enabled.

Choices:

secondary5GhzEnable

boolean

Indicates if secondary 5GHz MLO link is enabled.

Choices:

boolean

MU-MIMO Downlink.

Choices:

boolean

MU-MIMO Uplink.

Choices:

boolean

OFDMA Downlink.

Choices:

ofdmaMultiRu

boolean

OFDMA Multi-RU.

Choices:

boolean

OFDMA Uplink.

Choices:

profileName

string

802.11be 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.create80211be_profile, wireless.Wireless.delete80211be_profile, wireless.Wireless.update80211be_profile,

  • Paths used are post /dna/intent/api/v1/wirelessSettings/dot11beProfiles, delete /dna/intent/api/v1/wirelessSettings/dot11beProfiles/{id}, put /dna/intent/api/v1/wirelessSettings/dot11beProfiles/{id},

  • 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

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

Complete reference of the Create80211beProfile API.

Cisco Catalyst Center documentation for Wireless Delete80211beProfile

Complete reference of the Delete80211beProfile API.

Cisco Catalyst Center documentation for Wireless Update80211beProfile

Complete reference of the Update80211beProfile API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_settings_dot11be_profiles:
    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
    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
- name: Update by id
  cisco.catalystcenter.wireless_settings_dot11be_profiles:
    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
    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
- name: Delete by id
  cisco.catalystcenter.wireless_settings_dot11be_profiles:
    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
    id: string

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)