cisco / cisco.dnac / 6.13.3 / module / device_health_info Information module for Device Health | "added in version" 3.1.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.device_health_info (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
Get all Device Health.
Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.
- 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
limit: description: - Limit query parameter. Max number of device entries in the response (default to 50. Max at 1000). type: int health: description: - Health query parameter. The device overall health (One of POOR, FAIR, GOOD). type: str offset: description: - Offset query parameter. The offset of the first device in the returned data. type: int siteId: description: - SiteId query parameter. Assurance site UUID value. type: str endTime: description: - EndTime query parameter. UTC epoch time in miliseconds. type: int headers: description: Additional headers. type: dict dnac_host: description: - The Cisco DNA Center hostname. required: true type: str dnac_port: default: 443 description: - The Cisco DNA Center port. type: int startTime: description: - StartTime query parameter. UTC epoch time in milliseconds. type: int deviceRole: description: - DeviceRole query parameter. The device role (One of CORE, ACCESS, DISTRIBUTION, ROUTER, WLC, AP). type: str dnac_debug: default: false description: - Flag for Cisco DNA Center SDK to enable debugging. type: bool dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool dnac_version: default: 2.3.5.3 description: - Informs the SDK which version of Cisco DNA Center to use. type: str dnac_password: description: - The Cisco DNA Center password to authenticate. type: str dnac_username: aliases: - user default: admin description: - The Cisco DNA Center username to authenticate. type: str validate_response_schema: default: true description: - Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. type: bool
dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always sample: "{\n \"version\": \"string\",\n \"totalCount\": 0,\n \"response\": [\n\ \ {\n \"name\": \"string\",\n \"model\": \"string\",\n \"osVersion\"\ : \"string\",\n \"ipAddress\": \"string\",\n \"overallHealth\": 0,\n\ \ \"issueCount\": 0,\n \"location\": \"string\",\n \"deviceFamily\"\ : \"string\",\n \"deviceType\": \"string\",\n \"macAddress\": \"string\"\ ,\n \"interfaceLinkErrHealth\": 0,\n \"cpuUlitilization\": 0,\n \ \ \"cpuHealth\": 0,\n \"memoryUtilizationHealth\": 0,\n \"memoryUtilization\"\ : 0,\n \"interDeviceLinkAvailHealth\": 0,\n \"reachabilityHealth\":\ \ \"string\",\n \"clientCount\": {\n \"radio0\": 0,\n \"radio1\"\ : 0,\n \"Ghz24\": 0,\n \"Ghz50\": 0\n },\n \"interferenceHealth\"\ : {\n \"radio0\": 0,\n \"radio1\": 0,\n \"Ghz24\": 0,\n \ \ \"Ghz50\": 0\n },\n \"noiseHealth\": {\n \"radio1\":\ \ 0,\n \"Ghz50\": 0\n },\n \"airQualityHealth\": {\n \"\ radio0\": 0,\n \"radio1\": 0,\n \"Ghz24\": 0,\n \"Ghz50\"\ : 0\n },\n \"utilizationHealth\": {\n \"radio0\": 0,\n \ \ \"radio1\": 0,\n \"Ghz24\": 0,\n \"Ghz50\": 0\n }\n }\n\ \ ]\n}\n" type: dict