cisco.catalystcenter.tracked_clients module -- Resource 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.

New in cisco.catalystcenter 2.11.0

Synopsis

• Manage operations create, update and delete of the resource Tracked Clients. - > Creates one MAC-based tracked-client configuration through the customer-facing intent API. All create fields are mandatory. Use an empty string for `description` when no description is needed, `trackingStartTime 0` to start tracking at the current server time, and `trackingEndTime 0` for never-expiring tracking.

• Deletes the tracked-client configuration for the given client identifier. - > Partially updates a MAC-based tracked-client configuration for the given client identifier. Omitted fields keep their existing values. At least one of `description`, `trackingStartTime`, `trackingEndTime`, or `notificationModes` must be supplied. Use `trackingStartTime 0` to restart tracking at the current server time and `trackingEndTime 0` for never-expiring tracking.

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"`
clientMacAddress string	MAC address stored as the tracked-client configuration identifier. The stored identifier may be either the client's canonical MAC address or a randomized MAC address.
description string	User-provided description for the tracked client. Omit to keep the current value.
headers dictionary	Additional headers.
id string	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.
notificationModes list / elements=string	Enabled notification modes for the tracked client. Omit to keep the current value.
trackingEndTime integer	End time of the active tracking interval in UNIX epoch time milliseconds. Use `0` for never-expiring tracking. Omit to keep the current value.
trackingStartTime integer	Start time of the active tracking interval in UNIX epoch time milliseconds. Use `0` to restart tracking at the current server time. Omit to keep the current value.
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 clients.Clients.create_a_tracked_client_configuration, clients.Clients.delete_a_tracked_client_configuration, clients.Clients.partially_update_a_tracked_client_configuration,

• Paths used are post /dna/intent/api/v1/trackedClients, delete /dna/intent/api/v1/trackedClients/{id}, put /dna/intent/api/v1/trackedClients/{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 Clients CreateATrackedClientConfiguration

Complete reference of the CreateATrackedClientConfiguration API.

Cisco Catalyst Center documentation for Clients DeleteATrackedClientConfiguration

Complete reference of the DeleteATrackedClientConfiguration API.

Cisco Catalyst Center documentation for Clients PartiallyUpdateATrackedClientConfiguration

Complete reference of the PartiallyUpdateATrackedClientConfiguration API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.tracked_clients:
    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
    headers: '{{my_headers | from_json}}'
    id: string
- name: Update by id
  cisco.catalystcenter.tracked_clients:
    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
    description: string
    headers: '{{my_headers | from_json}}'
    id: string
    notificationModes:
      - string
    trackingEndTime: 0
    trackingStartTime: 0
- name: Create
  cisco.catalystcenter.tracked_clients:
    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
    clientMacAddress: string
    description: string
    headers: '{{my_headers | from_json}}'
    notificationModes:
      - string
    trackingEndTime: 0
    trackingStartTime: 0

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": {"clientMacAddress": "string", "duid": "string", "id": "string", "message": "string", "status": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)