cisco.dnac.client_detail – Manage ClientDetail objects of Clients

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.client_detail.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns detailed Client information retrieved by Mac Address for any given point of time.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
mac_address
string / required
MAC Address of the client.
timestamp
integer
Epoch time(in milliseconds) when the Client health data is required.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.client_detail

The official documentation on the cisco.dnac.plugins.module_utils.definitions.client_detail module.

ClientDetail reference

Complete reference of the ClientDetail object model.

ClientDetail reference

SDK reference.

Examples

- name: get_client_detail
  cisco.dnac.client_detail:
    state: query  # required
    mac_address: SomeValue  # string, required
    timestamp: 1  #  integer
  register: nm_get_client_detail

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
clients.get_client_detail


Authors

  • Rafael Campos (@racampos)