cisco.dnac.site_health_summaries_count_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_count_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有站点健康汇总计数 V1。
获取站点计数。使用可用的查询参数获取站点子集的计数。此 API 提供来自给定 `endTime` 的最新数据。如果提供endTime 的数据尚未准备好，请求将失败，并且错误消息将指示建议使用的 endTime 以检索完整的数据集。如果提供的 endTime=currentTime，可能会发生这种情况，因为我们不是实时系统。当未提供 `endTime` 时，API 返回最新数据。有关 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
参数
参数 |
注释 |
|---|---|
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）。 |
|
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）`?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）。 |
|
Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。 选择
|
备注
注意
使用的 SDK 方法为 sites.Sites.read_site_count_v1,。
使用的路径为 get /dna/data/api/v1/siteHealthSummaries/count,
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
参见
另请参阅
- Cisco DNA Center 文档，了解站点 ReadSiteCountV1
ReadSiteCountV1 API 的完整参考。
示例
- name: Get all Site Health Summaries Count V1
cisco.dnac.site_health_summaries_count_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}}"
endTime: 0
siteHierarchy: string
siteHierarchyId: string
siteType: string
id: string
register: result
返回值
常见的返回值已在这里文档中说明，以下是此模块独有的字段
键 |
描述 |
|---|---|
由 Cisco DNAC Python SDK 返回的字典或列表形式的响应 返回: 总是 示例: |