.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.dnac.client_detail_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.client_detail_info -- Information module for Client Detail +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.2.2). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.client_detail_info`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Client Detail. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk >= 2.3.1 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
dnac_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Cisco DNA Center SDK to enable debugging.
dnac_host
string / required
The Cisco DNA Center hostname.
dnac_password
string
The Cisco DNA Center password to authenticate.
dnac_port
string
Default:
443
The Cisco DNA Center port.
dnac_username
string
Default:
"admin"
The Cisco DNA Center username to authenticate.

aliases: user
dnac_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
dnac_version
string
Default:
"2.2.2.3"
Informs the SDK which version of Cisco DNA Center to use.
headers
dictionary
Additional headers.
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.
validate_response_schema
boolean
    Choices:
  • no
  • yes ←
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

.. Attributes .. Notes Notes ----- .. note:: - Supports ``check_mode`` - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Client Detail reference `_ Complete reference of the Client Detail object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: custom: value timestamp: string macAddress: string register: result .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
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": {} } ] } }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors