cisco.dnac.device_health_info – Information module for Device Health

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Device Health.

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
deviceRole string		DeviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP).
endTime integer		EndTime query parameter. UTC epoch time in miliseconds.
headers dictionary		Additional headers.
health string		Health query parameter. The device overall health (One of POOR, FAIR, GOOD).
limit integer		Limit query parameter. Max number of device entries in the response (default to 50. Max at 1000).
offset integer		Offset query parameter. The offset of the first device in the returned data.
siteId string		SiteId query parameter. Assurance site UUID value.
startTime integer		StartTime query parameter. UTC epoch time in milliseconds.

See Also

See also

Device Health reference

Complete reference of the Device Health object model.

Examples

- name: Get all Device Health
  cisco.dnac.device_health_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
    deviceRole: string
    siteId: string
    health: string
    startTime: 0
    endTime: 0
    limit: 0
    offset: 0
  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: { "version": "string", "totalCount": 0, "response": [ { "name": "string", "model": "string", "osVersion": "string", "ipAddress": "string", "overallHealth": 0, "issueCount": 0, "location": "string", "deviceFamily": "string", "deviceType": "string", "macAddress": "string", "interfaceLinkErrHealth": 0, "cpuUlitilization": 0, "cpuHealth": 0, "memoryUtilizationHealth": 0, "memoryUtilization": 0, "interDeviceLinkAvailHealth": 0, "reachabilityHealth": "string", "clientCount": { "radio0": 0, "radio1": 0, "Ghz24": 0, "Ghz50": 0 }, "interferenceHealth": { "radio0": 0, "radio1": 0, "Ghz24": 0, "Ghz50": 0 }, "noiseHealth": { "radio1": 0, "Ghz50": 0 }, "airQualityHealth": { "radio0": 0, "radio1": 0, "Ghz24": 0, "Ghz50": 0 }, "utilizationHealth": { "radio0": 0, "radio1": 0, "Ghz24": 0, "Ghz50": 0 } } ] }

Authors

• Rafael Campos (@racampos)