cisco.dnac.site_health_info module – Information module for Site Health
Note
This module is part of the cisco.dnac collection (version 6.24.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.site_health_info.
New in cisco.dnac 3.1.0
Synopsis
Get all Site Health.
Returns Overall Health information for all sites.
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 |
|---|---|
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: |
|
Additional headers. |
|
Limit query parameter. Max number of data entries in the returned data set 1,50. Default is 25. |
|
Offset query parameter. Offset of the first returned data set entry (Multiple of ‘limit’ + 1). |
|
SiteType query parameter. Site type AREA or BUILDING (case insensitive). |
|
Timestamp query parameter. Epoch time(in milliseconds) when the Site Hierarchy data is required. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sites.Sites.get_site_health,
Paths used are get /dna/intent/api/v1/site-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 Sites GetSiteHealth
Complete reference of the GetSiteHealth API.
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: "{{my_headers | from_json}}"
siteType: string
offset: 0
limit: 0
timestamp: 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: |