cisco.dnac.site_health_summaries_summary_analytics_v1 模块 – 用于站点健康摘要汇总分析 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。
cisco.dnac 6.15.0 中的新增功能
概要
管理资源站点健康摘要汇总分析 V1 的创建操作。
查询所有站点健康状况的汇总摘要。此 API 提供给定 `endTime` 的最新健康数据。如果为提供的 endTime 准备的数据未就绪，则请求将失败，并且错误消息将指示要使用以检索完整数据集的建议 endTime。如果提供的 endTime=currentTime，则可能会发生这种情况，因为我们不是实时系统。当未提供 `endTime` 时，API 返回最新数据。此 API 还提供问题数据。可以使用 `startTime` 查询参数来指定检索活动问题计数的起始时间范围。当未提供此参数时，默认的 `startTime` 将是 endTime 前的 24 小时。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机上需要满足以下要求。
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 版本。 默认值： |
|
结束时间。 |
|
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-79… (多个实体 uuid，使用 “&” 分隔符)。 |
|
SiteHierarchy 查询参数。从全局站点名称开始到特定站点名称结束的站点树的完整分层细分。根站点名为“Global”（例如 `Global/AreaName/BuildingName/FloorName`）。此字段支持通配符星号 (`*`) 字符搜索支持。例如 `*/San*, */San, /San*`。示例 `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (请求单个 siteHierarchy) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/…` (请求多个 siteHierarchies)。 |
|
SiteHierarchyId 查询参数。站点树的完整层次结构细分，采用 id 形式，从全局站点 UUID 开始到特定站点 UUID 结束。（例如 `globalUuid/areaUuid/buildingUuid/floorUuid`）此字段支持通配符星号 (`*`) 字符搜索支持。例如 `*uuid*, *uuid, uuid*`。示例 `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid` (请求单个 siteHierarchyId) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globa…` (请求多个 siteHierarchyIds)。 |
|
SiteType 查询参数。站点的类型。站点可以是区域、建筑物或楼层。未提供时的默认值为 `floor,building,area`。示例 `?siteType=area` (请求单个 siteType) `?siteType=area&siteType=building&siteType=floor` (请求多个 siteTypes)。 |
|
开始时间。 |
|
用于启用 Cisco DNA Center SDK 根据 JSON 模式验证请求体的标志。 选择
|
|
视图。 |
说明
注意
使用的 SDK 方法是 sites.Sites.query_an_aggregated_summary_of_site_health_data_v1，
使用的路径是 post /dna/data/api/v1/siteHealthSummaries/summaryAnalytics，
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关站点 QueryAnAggregatedSummaryOfSiteHealthDataV1 的 Cisco DNA Center 文档
QueryAnAggregatedSummaryOfSiteHealthDataV1 API 的完整参考。
示例
- name: Create
cisco.dnac.site_health_summaries_summary_analytics_v1:
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}}"
state: present
attributes:
- string
endTime: 0
id: string
siteHierarchy: string
siteHierarchyId: string
siteType: string
startTime: 0
views:
- string
返回值
通用返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回值：始终返回 示例： |