cisco.dnac.site_health_info – Information module for Site Health

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Site 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
headers dictionary		Additional headers.
timestamp string		Timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required.

See Also

See also

Site Health reference

Complete reference of the Site Health object model.

Examples

- name: Get all Site Health
  cisco.dnac.site_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
    timestamp: 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 list / elements=dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: [ { "siteName": "string", "siteId": "string", "parentSiteId": "string", "parentSiteName": "string", "siteType": "string", "latitude": 0, "longitude": 0, "healthyNetworkDevicePercentage": {}, "healthyClientsPercentage": {}, "clientHealthWired": {}, "clientHealthWireless": {}, "numberOfClients": {}, "numberOfNetworkDevice": {}, "networkHealthAverage": {}, "networkHealthAccess": {}, "networkHealthCore": {}, "networkHealthDistribution": {}, "networkHealthRouter": {}, "networkHealthWireless": {}, "networkHealthOthers": {}, "numberOfWiredClients": {}, "numberOfWirelessClients": {}, "totalNumberOfConnectedWiredClients": {}, "totalNumberOfActiveWirelessClients": {}, "wiredGoodClients": {}, "wirelessGoodClients": {}, "overallGoodDevices": {}, "accessGoodCount": {}, "accessTotalCount": {}, "coreGoodCount": {}, "coreTotalCount": {}, "distributionGoodCount": {}, "distributionTotalCount": {}, "routerGoodCount": {}, "routerTotalCount": {}, "wirelessDeviceGoodCount": {}, "wirelessDeviceTotalCount": {}, "applicationHealth": {}, "applicationGoodCount": {}, "applicationTotalCount": {}, "applicationBytesTotalCount": {}, "dnacInfo": {}, "applicationHealthStats": { "appTotalCount": 0, "businessRelevantAppCount": { "poor": 0, "fair": 0, "good": 0 }, "businessIrrelevantAppCount": { "poor": 0, "fair": 0, "good": 0 }, "defaultHealthAppCount": { "poor": 0, "fair": 0, "good": 0 } } } ]

Authors

• Rafael Campos (@racampos)