cisco.dnac.site_health_summaries_v1_info 模块 – 站点健康概要 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 了解更多详情。
要在剧本中使用它，请指定：cisco.dnac.site_health_summaries_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有站点健康概要 V1。
按 ID 获取站点健康概要 V1。
通过在 URL 路径中提供唯一的站点 ID 来获取特定站点的健康概要。此 API 提供来自给定 `endTime` 的最新健康数据。如果未准备好提供 endTime 的数据，则请求将失败，并且错误消息将指示用于检索完整数据集的推荐 endTime。如果提供的 endTime=currentTime，则可能会发生此行为，因为我们不是实时系统。当未提供 `endTime` 时，API 将返回最新数据。此 API 还提供问题数据。`startTime` 查询参数可用于指定时间范围的起始点以检索活动问题计数。当未提供此参数时，默认 `startTime` 将为 endTime 之前的 24 小时。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-siteHealthSummaries-1.0.3-resolved.yaml。
获取站点健康概要的分页列表。使用可用的查询参数来识别您想要其健康概要的站点的子集。此 API 提供来自给定 `endTime` 的最新健康数据。如果未准备好提供 endTime 的数据，则请求将失败，并且错误消息将指示用于检索完整数据集的推荐 endTime。如果提供的 endTime=currentTime，则可能会发生此行为，因为我们不是实时系统。当未提供 `endTime` 时，API 将返回最新数据。此 API 还提供问题数据。`startTime` 查询参数可用于指定时间范围的起始点以检索活动问题计数。当未提供此参数时，默认 `startTime` 将为 endTime 之前的 24 小时。此 API 中 `sortBy` 参数的有效值仅限于 `site` 视图中提供的属性。默认 sortBy 为 'siteHierarchy'，顺序为 'asc' 升序。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-siteHealthSummaries-1.0.3-resolved.yaml。
注意
此模块具有相应的 action 插件。
需求
执行此模块的主机需要以下需求。
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 查询与资源相关的 dataset 的结束时间。必须以毫秒为单位以 UNIX 纪元时间指定。值包含在内。 |
|
附加标头。 |
|
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）。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序，升序或降序。 |
|
SiteHierarchy 查询参数。站点树的完整分层结构，从全局站点名称开始，到特定站点名称结束。根站点命名为“Global”（例如：`Global/AreaName/BuildingName/FloorName`）。此字段支持通配符星号（`*`）字符搜索。例如：`*/San*`, `*/San`, `/San*` 示例 `?siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy）`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2`（请求多个 siteHierarchies）。 |
|
siteHierarchyId 查询参数。站点树的完整分层结构，以 ID 形式表示，从全局站点 UUID 开始，到特定站点 UUID 结束。（例如：`globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号（`*`）字符搜索。例如：`*uuid*`, `*uuid`, `uuid*` 示例 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid`（请求单个 siteHierarchyId）`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2`（请求多个 siteHierarchyIds）。 |
|
SiteType 查询参数。站点的类型。站点可以是区域、建筑物或楼层。未提供时，默认为 `floor,building,area` 示例 `?siteType=area`（请求单个 siteType）`?siteType=area&siteType=building&siteType=floor`（请求多个 siteTypes）。 |
|
SortBy 查询参数。响应中用于排序的字段。 |
|
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_list_of_site_health_summaries_v1, sites.Sites.read_site_health_summary_data_by_site_id_v1,
使用的路径为 get /dna/data/api/v1/siteHealthSummaries, get /dna/data/api/v1/siteHealthSummaries/{id},
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另见
另见
- Cisco DNA Center 站点 ReadListOfSiteHealthSummariesV1 文档
ReadListOfSiteHealthSummariesV1 API 的完整参考。
- Cisco DNA Center 站点 ReadSiteHealthSummaryDataBySiteIdV1 文档
ReadSiteHealthSummaryDataBySiteIdV1 API 的完整参考。
示例
- name: Get all Site Health Summaries V1
cisco.dnac.site_health_summaries_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
limit: 0
offset: 0
sortBy: string
order: string
siteHierarchy: string
siteHierarchyId: string
siteType: string
id: string
view: string
attribute: string
register: result
- name: Get Site Health Summaries V1 by id
cisco.dnac.site_health_summaries_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
view: string
attribute: string
id: string
register: result
返回值
公共返回值已记录在 此处，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回：始终 示例： |