cisco.dnac.device_details_info – Information module for Device Details

Note

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

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 ansible-galaxy collection list.

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get all Device Details.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.3.3

  • python >= 3.5

Parameters

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.
identifier
string
Identifier query parameter. One of keywords macAddress or uuid or nwDeviceName.
searchBy
string
SearchBy query parameter. MAC Address or Device Name value or UUID of the network device.
timestamp
string
Timestamp query parameter. Epoch time(in milliseconds) when the device 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.

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

See Also

See also

Device Details reference

Complete reference of the Device Details object model.

Examples

- 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

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:
{ "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" }


Authors

  • Rafael Campos (@racampos)