cisco.dnac.site_health – Manage SiteHealth objects of Sites¶
Note
This plugin is part of the cisco.dnac collection (version 2.0.7).
To install it use: ansible-galaxy collection install cisco.dnac
.
To use it in a playbook, specify: cisco.dnac.site_health
.
New in version 1.0.0: of cisco.dnac
Synopsis¶
Returns Overall Health information for all sites.
Note
This module has a corresponding action plugin.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
timestamp
integer
|
Epoch time(in milliseconds) when the Site Hierarchy data is required.
|
See Also¶
See also
- cisco.dnac.plugins.module_utils.definitions.site_health
The official documentation on the cisco.dnac.plugins.module_utils.definitions.site_health module.
- SiteHealth reference
Complete reference of the SiteHealth object model.
- SiteHealth reference
SDK reference.
Examples¶
- name: get_site_health
cisco.dnac.site_health:
state: query # required
timestamp: 1 # integer
register: nm_get_site_health
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Rafael Campos (@racampos)