cisco.catalystcenter.excluded_wireless_clients_info module -- Information module for Excluded Wireless Clients

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

New in cisco.catalystcenter 2.11.0

Synopsis

• Get all Excluded Wireless Clients.

• Get Excluded Wireless Clients by id. - > This API allows user to retrieve details of a specific excluded wireless client by ID. This API allows user to retrieve details of a specific excluded wireless client by ID. - > This API allows user to retrieve information about all excluded wireless clients. This API allows user to retrieve information about all excluded wireless clients. Results can be filtered and paginated.

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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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. ID of the excluded wireless client to be retrieved.
limit integer	Limit query parameter. The number of records to show for this page.
macAddress string	MacAddress query parameter. Filter results by MAC address.
networkDeviceId string	NetworkDeviceId query parameter. Filter results by 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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are wireless.Wireless.get_all_excluded_clients, wireless.Wireless.get_excluded_client_by_id,

• Paths used are get /dna/intent/api/v1/excludedWirelessClients, get /dna/intent/api/v1/excludedWirelessClients/{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 GetAllExcludedClients

Complete reference of the GetAllExcludedClients API.

Cisco Catalyst Center documentation for Wireless GetExcludedClientByID

Complete reference of the GetExcludedClientByID API.

Examples

---
- name: Get all Excluded Wireless Clients
  cisco.catalystcenter.excluded_wireless_clients_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}}"
    macAddress: string
    networkDeviceId: string
    offset: 1
    limit: 500
  register: result
- name: Get Excluded Wireless Clients by id
  cisco.catalystcenter.excluded_wireless_clients_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": {"description": "string", "id": "string", "impactedWlcs": ["string"], "macAddress": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)