cisco / cisco.dnac / 6.13.3 / module / site_health_info Information module for Site Health | "added in version" 3.1.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.site_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 Site Health.
Returns Overall Health information for all sites.
- 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: "{{my_headers | from_json}}" timestamp: string siteType: string offset: 0 limit: 0 register: result
limit: description: - Limit query parameter. The max number of sites in the returned data set. Default is 25, and max at 50. type: int offset: description: - Offset query parameter. The offset value, starting from 1, of the first returned site entry. Default is 1. type: int headers: description: Additional headers. type: dict siteType: description: - SiteType query parameter. Type of the site to return. AREA or BUILDING. Default to AREA. type: str dnac_host: description: - The Cisco DNA Center hostname. required: true type: str dnac_port: default: 443 description: - The Cisco DNA Center port. type: int timestamp: description: - Timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required. 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 elements: dict returned: always sample: "[\n {\n \"siteName\": \"string\",\n \"siteId\": \"string\",\n \ \ \"parentSiteId\": \"string\",\n \"parentSiteName\": \"string\",\n \"\ siteType\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"healthyNetworkDevicePercentage\"\ : {},\n \"healthyClientsPercentage\": {},\n \"clientHealthWired\": {},\n\ \ \"clientHealthWireless\": {},\n \"numberOfClients\": {},\n \"numberOfNetworkDevice\"\ : {},\n \"networkHealthAverage\": {},\n \"networkHealthAccess\": {},\n \ \ \"networkHealthCore\": {},\n \"networkHealthDistribution\": {},\n \"\ networkHealthRouter\": {},\n \"networkHealthWireless\": {},\n \"networkHealthOthers\"\ : {},\n \"numberOfWiredClients\": {},\n \"numberOfWirelessClients\": {},\n\ \ \"totalNumberOfConnectedWiredClients\": {},\n \"totalNumberOfActiveWirelessClients\"\ : {},\n \"wiredGoodClients\": {},\n \"wirelessGoodClients\": {},\n \"\ overallGoodDevices\": {},\n \"accessGoodCount\": {},\n \"accessTotalCount\"\ : {},\n \"coreGoodCount\": {},\n \"coreTotalCount\": {},\n \"distributionGoodCount\"\ : {},\n \"distributionTotalCount\": {},\n \"routerGoodCount\": {},\n \ \ \"routerTotalCount\": {},\n \"wirelessDeviceGoodCount\": {},\n \"wirelessDeviceTotalCount\"\ : {},\n \"applicationHealth\": {},\n \"applicationGoodCount\": {},\n \ \ \"applicationTotalCount\": {},\n \"applicationBytesTotalCount\": {},\n \ \ \"dnacInfo\": {},\n \"applicationHealthStats\": {\n \"appTotalCount\"\ : 0,\n \"businessRelevantAppCount\": {\n \"poor\": 0,\n \"\ fair\": 0,\n \"good\": 0\n },\n \"businessIrrelevantAppCount\"\ : {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n },\n\ \ \"defaultHealthAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n\ \ \"good\": 0\n }\n }\n }\n]\n" type: list