cisco.catalystcenter.site_health_summaries_summary_analytics module -- Resource module for Site Health Summaries Summary Analytics
Note
This module is part of the cisco.catalystcenter collection (version 2.3.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_summaries_summary_analytics.
New in cisco.catalystcenter 6.15.0
Synopsis
Manage operation create of the resource Site Health Summaries Summary Analytics.
Query an aggregated summary of all site health.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.6.0.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Attributes. |
|
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 port. Default: :ansible-option-default:`443` |
|
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:`"3.1.6.0"` |
|
End Time. |
|
Additional headers. |
|
Id query parameter. The list of entity Uuids. Example "6bef213c-19ca-4170-8375-b694e251101c". Multiple entity uuids can be provided with '&' separator. |
|
SiteHierarchy query parameter. The full hierarchical breakdown of the site tree. Starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`). This field supports wildcard asterisk (`*`) character search support. |
|
SiteHierarchyId query parameter. The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globa... (multiple siteHierarchyIds requested). |
|
SiteType query parameter. The type of the site. A site can be an area, building, or floor. Default when not provided will be `floor,building,area` Examples `?siteType=area` (single siteType requested) `?siteType=area&siteType=building&siteType=floor` (multiple siteTypes requested). |
|
Start Time. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
Views. |
Notes
Note
SDK Method used are sites.Sites.query_an_aggregated_summary_of_site_health_data,
Paths used are post /dna/data/api/v1/siteHealthSummaries/summaryAnalytics,
Does not support
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 QueryAnAggregatedSummaryOfSiteHealthData
Complete reference of the QueryAnAggregatedSummaryOfSiteHealthData API.
Examples
---
- name: Create
cisco.catalystcenter.site_health_summaries_summary_analytics:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_port: "{{catalystcenter_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
state: present
attributes:
- string
endTime: 0
headers: '{{my_headers | from_json}}'
id: string
siteHierarchy: string
siteHierarchyId: string
siteType: string
startTime: 0
views:
- string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|