cisco.dnac.device_health_info module – Information module for Device Health
Note
This module is part of the cisco.dnac collection (version 6.22.0).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.device_health_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Device Health.
Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
DeviceRole query parameter. CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, or AP (case insensitive). |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
EndTime query parameter. UTC epoch time in milliseconds. |
|
Additional headers. |
|
Health query parameter. DNAC health catagory POOR, FAIR, or GOOD (case insensitive). |
|
Limit query parameter. Max number of device entries in the response (default to 50. Max at 500). |
|
Offset query parameter. The offset of the first device in the returned data (Mutiple of ‘limit’ + 1). |
|
SiteId query parameter. DNAC site UUID. |
|
StartTime query parameter. UTC epoch time in milliseconds. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are devices.Devices.devices,
Paths used are get /dna/intent/api/v1/device-health,
Supports
check_modeThe 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
- Cisco DNA Center documentation for Devices Devices
Complete reference of the Devices API.
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: "{{my_headers | from_json}}"
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 |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |