cisco.dnac.site_health_summaries_info 模块 – 站点健康摘要信息的信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.site_health_summaries_info。
cisco.dnac 6.15.0 中的新功能
概要
此模块表示模块 site_health_summaries_v1_info 的别名
注意
此模块有一个对应的 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 查询与资源相关的数据集的结束时间。必须以 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/区域名称/建筑名称/楼层名称`）。此字段支持使用星号 (`*`) 通配符进行搜索。例如：`*/San*, */San, /San*`。示例：`?siteHierarchy=Global/区域名称/建筑名称/楼层名称`（请求单个 siteHierarchy） `?siteHierarchy=Global/区域名称/建筑名称/楼层名称&siteHierarchy=Global /区域名称2/建筑名称2/楼层名称2`（请求多个 siteHierarchies）。 |
|
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`（请求多个 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}，
应该注意的是，此模块是 site_health_summaries_v1_info 的别名
支持
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 Info
cisco.dnac.site_health_summaries_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 Info by id
cisco.dnac.site_health_summaries_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 返回的响应 返回： 始终 示例： |