cisco.catalystcenter.site_health_info module -- Information module for Site Health
Note
This module is part of the cisco.catalystcenter collection (version 2.2.1).
To install it, use: ansible-galaxy collection install cisco.catalystcenter.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.catalystcenter.site_health_info.
New in cisco.catalystcenter 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.
catalystcentersdk >= 3.1.3.0.0
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
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 Catalyst 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 uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for Sites GetSiteHealth
Complete reference of the GetSiteHealth API.
Examples
---
- name: Get all Site Health
cisco.catalystcenter.site_health_info:
catc_host: "{{catc_host}}"
catc_username: "{{catc_username}}"
catc_password: "{{catc_password}}"
catc_verify: "{{catc_verify}}"
catc_api_port: "{{catc_api_port}}"
catc_version: "{{catc_version}}"
catc_debug: "{{catc_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 |
|---|---|