cisco.dnac.site_health_summaries_count_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_count_info。

cisco.dnac 6.15.0 中的新功能

概要

  • 此模块表示模块 site_health_summaries_count_v1_info 的别名

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

dnac_debug

布尔值

用于启用调试的 Cisco DNA Center SDK 标志。

选项

  • false ← (默认)

  • true

dnac_host

字符串 / 必需

Cisco DNA Center 主机名。

dnac_password

字符串

用于身份验证的 Cisco DNA Center 密码。

dnac_port

整数

Cisco DNA Center 端口。

默认： 443

dnac_username

别名：user

字符串

用于身份验证的 Cisco DNA Center 用户名。

默认： "admin"

dnac_verify

布尔值

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

字符串

通知 SDK 使用哪个版本的 Cisco DNA Center。

默认： "2.3.7.6"

endTime

浮点数

EndTime 查询参数。API 查询与资源相关的数据集的结束时间。它必须以毫秒为单位的 UNIX 时间戳指定。值是包含的。

headers

字典

附加标头。

id

字符串

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

字符串

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`（请求多个 siteHierarchy）。

siteHierarchyId

字符串

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

字符串

SiteType 查询参数。站点的类型。站点可以是区域、建筑物或楼层。未提供时的默认值为 `floor,building,area` 示例 `?siteType=area`（请求单个 siteType）`?siteType=area&siteType=building&siteType=floor`（请求多个 siteType）。

validate_response_schema

布尔值

用于启用根据 JSON 模式验证请求主体的 Cisco DNA Center SDK 标志。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 sites.Sites.read_site_count_v1

  • 使用的路径是 get /dna/data/api/v1/siteHealthSummaries/count

  • 应注意，此模块是 site_health_summaries_count_v1_info 的别名

  • 支持 check_mode

  • 该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档，了解站点 ReadSiteCountV1

ReadSiteCountV1 API 的完整参考。

示例

- name: Get all Site Health Summaries Count Info
  cisco.dnac.site_health_summaries_count_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

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

已返回： 始终

示例： {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)