cisco.dnac.client_detail_info – Information module for Client Detail

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Client Detail.

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
macAddress
string
MacAddress query parameter. MAC Address of the client.
timestamp
string
Timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required.

See Also

See also

Client Detail reference

Complete reference of the Client Detail object model.

Examples

- name: Get all Client Detail
  cisco.dnac.client_detail_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    timestamp: string
    macAddress: string
  register: result

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 or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "detail": { "id": "string", "connectionStatus": "string", "hostType": "string", "userId": {}, "hostName": "string", "hostOs": {}, "hostVersion": {}, "subType": "string", "lastUpdated": 0, "healthScore": [ { "healthType": "string", "reason": "string", "score": 0 } ], "hostMac": "string", "hostIpV4": "string", "hostIpV6": [ "string" ], "authType": "string", "vlanId": "string", "vnid": "string", "ssid": "string", "frequency": "string", "channel": "string", "apGroup": {}, "location": {}, "clientConnection": "string", "connectedDevice": [ {} ], "issueCount": 0, "rssi": "string", "avgRssi": {}, "snr": "string", "avgSnr": {}, "dataRate": "string", "txBytes": "string", "rxBytes": "string", "dnsSuccess": {}, "dnsFailure": {}, "onboarding": { "averageRunDuration": {}, "maxRunDuration": {}, "averageAssocDuration": {}, "maxAssocDuration": {}, "averageAuthDuration": {}, "maxAuthDuration": {}, "averageDhcpDuration": {}, "maxDhcpDuration": {}, "aaaServerIp": "string", "dhcpServerIp": {}, "authDoneTime": {}, "assocDoneTime": {}, "dhcpDoneTime": {}, "assocRootcauseList": [ {} ], "aaaRootcauseList": [ {} ], "dhcpRootcauseList": [ {} ], "otherRootcauseList": [ {} ] }, "clientType": "string", "onboardingTime": {}, "port": {}, "iosCapable": true }, "connectionInfo": { "hostType": "string", "nwDeviceName": "string", "nwDeviceMac": "string", "protocol": "string", "band": "string", "spatialStream": "string", "channel": "string", "channelWidth": "string", "wmm": "string", "uapsd": "string", "timestamp": 0 }, "topology": { "nodes": [ { "role": "string", "name": "string", "id": "string", "description": "string", "deviceType": "string", "platformId": {}, "family": {}, "ip": "string", "softwareVersion": {}, "userId": {}, "nodeType": "string", "radioFrequency": {}, "clients": {}, "count": {}, "healthScore": 0, "level": 0, "fabricGroup": {}, "connectedDevice": {} } ], "links": [ { "source": "string", "linkStatus": "string", "label": [ "string" ], "target": "string", "id": {}, "portUtilization": {} } ] } }


Authors

  • Rafael Campos (@racampos)