cisco / cisco.dnac / 6.13.3 / module / client_detail_info Information module for Client Detail | "added in version" 3.1.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.client_detail_info (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
Get all Client Detail.
Returns detailed Client information retrieved by Mac Address for any given point of time.
- 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}}" headers: "{{my_headers | from_json}}" timestamp: string macAddress: string register: result
headers: description: Additional headers. type: dict dnac_host: description: - The Cisco DNA Center hostname. required: true type: str dnac_port: default: 443 description: - The Cisco DNA Center port. type: int timestamp: description: - Timestamp query parameter. Epoch time(in milliseconds) when the Client health data is required. type: str dnac_debug: default: false description: - Flag for Cisco DNA Center SDK to enable debugging. type: bool macAddress: description: - MacAddress query parameter. MAC Address of the client. type: str dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool dnac_version: default: 2.3.5.3 description: - Informs the SDK which version of Cisco DNA Center to use. type: str dnac_password: description: - The Cisco DNA Center password to authenticate. type: str dnac_username: aliases: - user default: admin description: - The Cisco DNA Center username to authenticate. type: str validate_response_schema: default: true description: - Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. type: bool
dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always sample: "{\n \"detail\": {\n \"id\": \"string\",\n \"connectionStatus\":\ \ \"string\",\n \"hostType\": \"string\",\n \"userId\": {},\n \"hostName\"\ : \"string\",\n \"hostOs\": {},\n \"hostVersion\": {},\n \"subType\"\ : \"string\",\n \"lastUpdated\": 0,\n \"healthScore\": [\n {\n \ \ \"healthType\": \"string\",\n \"reason\": \"string\",\n \"\ score\": 0\n }\n ],\n \"hostMac\": \"string\",\n \"hostIpV4\": \"\ string\",\n \"hostIpV6\": [\n \"string\"\n ],\n \"authType\": \"\ string\",\n \"vlanId\": 0,\n \"vnid\": 0,\n \"ssid\": \"string\",\n \ \ \"frequency\": \"string\",\n \"channel\": \"string\",\n \"apGroup\"\ : {},\n \"location\": {},\n \"clientConnection\": \"string\",\n \"connectedDevice\"\ : [\n {}\n ],\n \"issueCount\": 0,\n \"rssi\": \"string\",\n \ \ \"avgRssi\": {},\n \"snr\": \"string\",\n \"avgSnr\": {},\n \"dataRate\"\ : \"string\",\n \"txBytes\": \"string\",\n \"rxBytes\": \"string\",\n \ \ \"dnsSuccess\": {},\n \"dnsFailure\": {},\n \"onboarding\": {\n \ \ \"averageRunDuration\": {},\n \"maxRunDuration\": {},\n \"averageAssocDuration\"\ : {},\n \"maxAssocDuration\": {},\n \"averageAuthDuration\": {},\n \ \ \"maxAuthDuration\": {},\n \"averageDhcpDuration\": {},\n \"maxDhcpDuration\"\ : {},\n \"aaaServerIp\": \"string\",\n \"dhcpServerIp\": {},\n \ \ \"authDoneTime\": {},\n \"assocDoneTime\": {},\n \"dhcpDoneTime\"\ : {},\n \"assocRootcauseList\": [\n {}\n ],\n \"aaaRootcauseList\"\ : [\n {}\n ],\n \"dhcpRootcauseList\": [\n {}\n ],\n\ \ \"otherRootcauseList\": [\n {}\n ]\n },\n \"clientType\"\ : \"string\",\n \"onboardingTime\": {},\n \"port\": {},\n \"iosCapable\"\ : true\n },\n \"connectionInfo\": {\n \"hostType\": \"string\",\n \"nwDeviceName\"\ : \"string\",\n \"nwDeviceMac\": \"string\",\n \"protocol\": \"string\"\ ,\n \"band\": \"string\",\n \"spatialStream\": \"string\",\n \"channel\"\ : \"string\",\n \"channelWidth\": \"string\",\n \"wmm\": \"string\",\n \ \ \"uapsd\": \"string\",\n \"timestamp\": 0\n },\n \"topology\": {\n \ \ \"nodes\": [\n {\n \"role\": \"string\",\n \"name\": \"\ string\",\n \"id\": \"string\",\n \"description\": \"string\",\n\ \ \"deviceType\": \"string\",\n \"platformId\": {},\n \"\ family\": {},\n \"ip\": \"string\",\n \"softwareVersion\": {},\n\ \ \"userId\": {},\n \"nodeType\": \"string\",\n \"radioFrequency\"\ : {},\n \"clients\": {},\n \"count\": {},\n \"healthScore\"\ : 0,\n \"level\": 0,\n \"fabricGroup\": {},\n \"connectedDevice\"\ : {}\n }\n ],\n \"links\": [\n {\n \"source\": \"string\"\ ,\n \"linkStatus\": \"string\",\n \"label\": [\n \"string\"\ \n ],\n \"target\": \"string\",\n \"id\": {},\n \"\ portUtilization\": {}\n }\n ]\n }\n}\n" type: dict