.. Document meta
:orphan:
.. Anchors
.. _ansible_collections.cisco.dnac.device_details_info_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.device_details_info -- Information module for Device Details
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 3.1.1).
To install it use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.device_details_info`.
.. version_added
.. versionadded:: 1.0.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Get all Device Details.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-headers"></div>
<b>headers</b>
<a class="ansibleOptionLink" href="#parameter-headers" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>
</td>
<td>
<div>Additional headers.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-identifier"></div>
<b>identifier</b>
<a class="ansibleOptionLink" href="#parameter-identifier" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Identifier query parameter. One of keywords macAddress or uuid or nwDeviceName.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-searchBy"></div>
<b>searchBy</b>
<a class="ansibleOptionLink" href="#parameter-searchBy" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>SearchBy query parameter. MAC Address or Device Name value or UUID of the network device.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-timestamp"></div>
<b>timestamp</b>
<a class="ansibleOptionLink" href="#parameter-timestamp" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Timestamp query parameter. Epoch time(in milliseconds) when the device data is required.</div>
</td>
</tr>
</table>
<br/>
.. Notes
.. Seealso
See Also
--------
.. seealso::
`Device Details reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Device Details object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Get all Device Details
cisco.dnac.device_details_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
searchBy: string
identifier: string
register: result
.. Facts
.. Return values
Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"HALastResetReason": "string",
"managementIpAddr": "string",
"HAPrimaryPowerStatus": "string",
"redundancyMode": "string",
"communicationState": "string",
"nwDeviceName": "string",
"redundancyUnit": "string",
"platformId": "string",
"redundancyPeerState": "string",
"nwDeviceId": "string",
"redundancyState": "string",
"nwDeviceRole": "string",
"nwDeviceFamily": "string",
"macAddress": "string",
"collectionStatus": "string",
"deviceSeries": "string",
"osType": "string",
"clientCount": "string",
"HASecondaryPowerStatus": "string",
"softwareVersion": "string",
"nwDeviceType": "string",
"overallHealth": 0,
"memoryScore": 0,
"cpuScore": 0,
"noiseScore": 0,
"utilizationScore": 0,
"airQualityScore": 0,
"interferenceScore": 0,
"wqeScore": 0,
"freeMbufScore": 0,
"packetPoolScore": 0,
"freeTimerScore": 0,
"memory": "string",
"cpu": "string",
"noise": "string",
"utilization": "string",
"airQuality": "string",
"interference": "string",
"wqe": "string",
"freeMbuf": "string",
"packetPool": "string",
"freeTimer": "string",
"location": "string",
"timestamp": "string"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors