cisco.catalystcenter.wireless_controllers_intended_ssids_dot11_be_profiles_info module -- Information module for Wireless Controllers Intended Ssids Dot11 Be 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_controllers_intended_ssids_dot11_be_profiles_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Wireless Controllers Intended Ssids Dot11 Be Profiles.

  • Get Wireless Controllers Intended Ssids Dot11 Be Profiles by id. - > This API operation returns the configurations for a specific instance of a Dot11BeProfile feature on a wireless controller, and this API is applicable for per-device based configuration. - > This API operation returns the intended configurations for the Dot11BeProfile feature on a wireless controller, and this API is applicable for per-device based configuration.

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. Instance UUID of the Dot11BeProfile.

limit

integer

Limit query parameter. The number of records to show for this page.

networkDeviceId

string

NetworkDeviceId path parameter. Network device ID of the wireless controller to provision. The API /dna/intent/api/v1/network-device can be used to get the network device ID.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

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.get_configurations_for_a_specific_instance_of_a_dot11_be_profile_feature_on_a_wireless_controller, wireless.Wireless.get_configurations_for_dot11_be_profile_feature_on_a_wireless_controller_connectivity,

  • Paths used are get /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/ssids/dot11BeProfiles, get /dna/campus/api/v1/wirelessControllers/{networkDeviceId}/intended/ssids/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 GetConfigurationsForASpecificInstanceOfADot11BeProfileFeatureOnAWirelessController

Complete reference of the GetConfigurationsForASpecificInstanceOfADot11BeProfileFeatureOnAWirelessController API.

Cisco Catalyst Center documentation for Wireless GetConfigurationsForDot11BeProfileFeatureOnAWirelessControllerConnectivity

Complete reference of the GetConfigurationsForDot11BeProfileFeatureOnAWirelessControllerConnectivity API.

Examples

---
- name: Get all Wireless Controllers Intended Ssids Dot11 Be Profiles
  cisco.catalystcenter.wireless_controllers_intended_ssids_dot11_be_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}}"
    offset: 1
    limit: 100
    networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
  register: result
- name: Get Wireless Controllers Intended Ssids Dot11 Be Profiles by id
  cisco.catalystcenter.wireless_controllers_intended_ssids_dot11_be_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}}"
    networkDeviceId: dd584a8a-a7ae-4323-97f4-ab950cab52a6
    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": {}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)