cisco.dnac.site_health_summaries_summary_analytics_v1_info 模块 – 站点健康摘要汇总分析 V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.dnac.site_health_summaries_summary_analytics_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有站点健康摘要汇总分析 V1。
获取所有站点健康的汇总摘要，或使用查询参数获取站点子集的健康汇总摘要。此 API 提供给定 `endTime` 的最新健康数据。如果数据未准备好用于提供的 endTime，则请求将失败，并且错误消息将指示建议使用的 endTime 以检索完整的数据集。如果提供的 endTime=currentTime，则可能会发生这种情况，因为我们不是实时系统。当未提供 `endTime` 时，API 会返回最新数据。此 API 还提供问题数据。`startTime` 查询参数可用于指定检索活动问题计数的时段的开始点。如果未提供此参数，则默认的 `startTime` 将为 endTime 前 24 小时。聚合响应数据将不会填充唯一标识符数据。唯一标识符数据列表 `id`、`siteHierarchy`、`siteHierarchyId`、`siteType`、`latitude`、`longitude`。有关 API 使用的详细信息，请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-siteHealthSummaries-1.0.3-resolved.yaml。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。支持的属性 id、siteHierarchy、siteHierarchyId、siteType、latitude、longitude、networkDeviceCount、networkDeviceGoodHealthCount、wirelessDeviceCount、wirelessDeviceGoodHealthCount、accessDeviceCount、accessDeviceGoodHealthCount、coreDeviceCount、coreDeviceGoodHealthCount、distributionDeviceCount、distributionDeviceGoodHealthCount、routerDeviceCount、routerDeviceGoodHealthCount、apDeviceCount、apDeviceGoodHealthCount、wlcDeviceCount、wlcDeviceGoodHealthCount、switchDeviceCount、switchDeviceGoodHealthCount、networkDeviceGoodHealthPercentage、accessDeviceGoodHealthPercentage、coreDeviceGoodHealthPercentage、distributionDeviceGoodHealthPercentage、routerDeviceGoodHealthPercentage、apDeviceGoodHealthPercentage、wlcDeviceGoodHealthPercentage、switchDeviceGoodHealthPercentage、wirelessDeviceGoodHealthPercentage、clientCount、clientGoodHealthCount、wiredClientCount、wirelessClientCount、wiredClientGoodHealthCount、wirelessClientGoodHealthCount、clientGoodHealthPercentage、wiredClientGoodHealthPercentage、wirelessClientGoodHealthPercentage、clientDataUsage、p1IssueCount、p2IssueCount、p3IssueCount、p4IssueCount、issueCount。如果属性列表的长度太长，请改用“view”参数。示例 attribute=siteHierarchy（请求单个属性）attribute=siteHierarchy&attribute=clientCount（请求多个属性）。 |
|
用于启用 Cisco DNA Center SDK 调试的标志。 选择
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认： |
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认： |
|
EndTime 查询参数。API 查询与资源相关的数据集的结束时间。它必须以毫秒为单位的 UNIX epochtime 指定。值是包含的。 |
|
附加标头。 |
|
Id 查询参数。实体 UUID 列表。（例如“6bef213c-19ca-4170-8375-b694e251101c”）示例 id=6bef213c-19ca-4170-8375-b694e251101c（请求单个实体 UUID）id=6bef213c-19ca-4170-8375- b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0（具有“&”分隔符的多个实体 UUID）。 |
|
SiteHierarchy 查询参数。站点树的完整层次结构分解，从全局站点名称开始，到特定站点名称结束。根站点命名为“Global”（例如，`Global/区域名称/建筑名称/楼层名称`）。此字段支持通配符星号（`*`）字符搜索。例如：`*/San*, */San, /San*`。示例：`?siteHierarchy=Global/区域名称/建筑名称/楼层名称`（请求单个 siteHierarchy）`?siteHierarchy=Global/区域名称/建筑名称/楼层名称&siteHierarchy=Global/区域名称2/建筑名称2/楼层名称2`（请求多个 siteHierarchy）。 |
|
SiteHierarchyId 查询参数。站点树的完整层次结构分解，以 ID 形式表示，从全局站点 UUID 开始，到特定站点 UUID 结束。（例如，`globalUuid/areaUuid/buildingUuid/floorUuid`）。此字段支持通配符星号（`*`）字符搜索。例如：`*uuid*, *uuid, uuid*`。示例：`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid`（请求单个 siteHierarchyId）`?siteHiera rchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUu id2`（请求多个 siteHierarchyId）。 |
|
SiteType 查询参数。站点的类型。站点可以是区域、建筑或楼层。未提供时的默认值为 `floor,building,area`。示例：`?siteType=area`（请求单个 siteType）`?siteType=area&siteType=building&siteType=floor`（请求多个 siteType）。 |
|
StartTime 查询参数。API 查询与资源相关的数据集的起始时间。必须以 UNIX 纪元时间（毫秒）指定。值是包含的。如果未提供 `startTime`，API 将默认为当前时间。 |
|
Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求体的标志。 选择
|
|
View 查询参数。请求的特定摘要视图。这是一个可选参数，可用于获取与站点关联的一个或多个特定健康数据摘要。### 每个视图提供响应数据 1. **site** id、siteHierarchy、siteHierarchyId、siteType、latitude、longitude 2. **network** id、networkDeviceCount、networkDeviceGoodHealthCount、wirelessDeviceCount、wirelessDeviceGoodHealthCount、accessDeviceCount、accessDeviceGoodHealthCount、coreDeviceCount、coreDeviceGoodHealthCount、distributionDeviceCount、distributionDeviceGoodHealthCount、routerDeviceCount、routerDeviceGoodHealthCount、apDeviceCount、apDeviceGoodHealthCount、wlcDeviceCount、wlcDeviceGoodHealthCount、switchDeviceCount、switchDeviceGoodHealthCount、networkDeviceGoodHealthPercentage、accessDeviceGoodHealthPercentage、coreDeviceGoodHealthPercentage、distributionDeviceGoodHealthPercentage、routerDeviceGoodHealthPercentage、apDeviceGoodHealthPercentage、wlcDeviceGoodHealthPercentage、switchDeviceGoodHealthPercentage、wirelessDeviceGoodHealthPercentage 3. **client** id、clientCount、clientGoodHealthCount、wiredClientCount、wirelessClientCount、wiredClientGoodHealthCount、wirelessClientGoodHealthCount、clientGoodHealthPercentage、wiredClientGoodHealthPercentage、wirelessClientGoodHealthPercentage、clientDataUsage 4. **issue** id、p1IssueCount、p2IssueCount、p3IssueCount、p4IssueCount、issueCount。如果未添加此查询参数，则默认摘要为 **site,client,network,issue**。示例：view=client（请求单个视图）view=client&view=network&view=issue（请求多个视图）。 |
注释
注意
使用的 SDK 方法是 sites.Sites.read_an_aggregated_summary_of_site_health_data_v1。
使用的路径是 get /dna/data/api/v1/siteHealthSummaries/summaryAnalytics。
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 关于站点 ReadAnAggregatedSummaryOfSiteHealthDataV1 的文档
ReadAnAggregatedSummaryOfSiteHealthDataV1 API 的完整参考。
示例
- name: Get all Site Health Summaries Summary Analytics V1
cisco.dnac.site_health_summaries_summary_analytics_v1_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}}"
startTime: 0
endTime: 0
siteHierarchy: string
siteHierarchyId: string
siteType: string
id: string
view: string
attribute: string
register: result
返回值
通用返回值记录在这里，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应。 返回： 始终 示例： |