cisco.catalystcenter.tracked_clients_info module -- Information module for Tracked Clients
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.tracked_clients_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Tracked Clients.
Get Tracked Clients by id.
Returns one tracked-client configuration for the given client identifier.
Returns tracked-client configurations for the customer-facing intent API.
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 |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
ClientMacAddress query parameter. Up to 10 stored tracked-client identifiers to match. Each value is matched against the MAC address stored on the tracked-client configuration. The stored identifier may be either the client's canonical MAC address or a randomized MAC address. To filter by correlated randomized MAC aliases, use `randomizedMacAddresses`. Invalid MAC address values are rejected. |
|
Description query parameter. Exact-match description value for tracked-client configurations. This parameter uses `eq` semantics only. For partial matching or other request-body filter combinations, use `POST /intent/api/v1/trackedClients/query`. |
|
Duid query parameter. Up to 10 DUID values to match. A DUID is the device identifier used to correlate related randomized MACs for the same client. |
|
Additional headers. |
|
Id path parameter. Tracked-client identifier. This is the MAC address stored on the tracked-client configuration. The stored identifier may be either the client's canonical MAC address or a randomized MAC address. Correlated randomized MACs listed in `randomizedMacAddresses` are not interchangeable resource identifiers for this path. |
|
IsPresentOnNetwork query parameter. Match tracked-client configurations by whether the client is present on the network within the last 28 days. Choices: |
|
Limit query parameter. Maximum number of records to return. |
|
NotificationModes query parameter. One or more notification modes to match. Supported values are `CONNECT_FIRST`, `CONNECT_EVERY`, and `DISCONNECT_EVERY`. |
|
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. |
|
RandomizedMacAddresses query parameter. Up to 10 randomized MAC addresses to match against the tracked client. These addresses are matched through the client-correlation data associated with the DUID when available. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are clients.Clients.read_a_tracked_client_configuration_by_client_identifier, clients.Clients.read_tracked_client_configurations,
Paths used are get /dna/intent/api/v1/trackedClients, get /dna/intent/api/v1/trackedClients/{id},
Supports
check_modeThe 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 Clients ReadATrackedClientConfigurationByClientIdentifier
Complete reference of the ReadATrackedClientConfigurationByClientIdentifier API.
- Cisco Catalyst Center documentation for Clients ReadTrackedClientConfigurations
Complete reference of the ReadTrackedClientConfigurations API.
Examples
---
- name: Get all Tracked Clients
cisco.catalystcenter.tracked_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}}"
offset: 1
limit: 100
clientMacAddress: []
duid: []
description: string
notificationModes: []
isPresentOnNetwork: true
randomizedMacAddresses: []
register: result
- name: Get Tracked Clients by id
cisco.catalystcenter.tracked_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 |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always |