cisco.dnac.clients_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.clients_count_v1_info。

cisco.dnac 6.15.0 中的新增功能

概要

• 获取所有客户计数 V1。

• 通过应用基本过滤来检索客户数量。有关 API 用法的详细信息，请参阅 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst-center- api-specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml。

注意

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

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
band 字符串	Band 查询参数。客户或接入点运行的 WiFi 频率频段。频段值以千兆赫 - GHz 表示 示例 `band=5GHZ`（请求单个频段） `band=2.4GHZ&band=6GHZ`（请求多个频段）。
connectedNetworkDeviceName 字符串	ConnectedNetworkDeviceName 查询参数。客户连接到的邻居网络设备的名称。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*ap-25*` 或 `ap-25*` 或 `*ap-25` 示例 `connectedNetworkDeviceName=ap-25`（请求单个 connectedNetworkDeviceName） `connectedNetworkDeviceName=ap-25&ap-34`（请求多个 connectedNetworkDeviceName）。
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 查询与资源相关的 DataSet 的结束时间。必须以毫秒为单位指定 UNIX 纪元时间。值为包含。
headers 字典	附加标题。
ipv4Address 字符串	Ipv4Address 查询参数。网络实体（网络设备或客户端）的 IPv4 地址。此字段支持基于通配符（`*`）字符的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1` 示例 `ipv4Address=1.1.1.1`（请求单个 ipv4Address） `ipv4Address=1.1.1.1&ipv4Address=2.2.2.2`（请求多个 ipv4Address）。
ipv6Address 字符串	Ipv6Address 查询参数。网络实体（网络设备或客户端）的 IPv6 地址。此字段支持基于通配符（`*`）字符的搜索。例如 `*2001 db8*` 或 `2001 db8*` 或 `*2001 db8` 示例 `ipv6Address=2001 db8 0 0 0 0 2 1`（请求单个 ipv6Address） `ipv6Address=2001 db8 0 0 0 0 2 1&ipv6Address=2001 db8 85a3 8d3 1319 8a2e 370 7348`（请求多个 ipv6Address）。
macAddress 字符串	MacAddress 查询参数。网络设备或客户端的 macAddress。此字段支持基于通配符（`*`）字符的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB` 示例 `macAddress=AB AB AB CD CD CD`（请求单个 macAddress） `macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE`（请求多个 macAddress）。
osType 字符串	OsType 查询参数。客户端设备操作系统类型。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*iOS*` 或 `iOS*` 或 `*iOS` 示例 `osType=iOS`（请求单个 osType） `osType=iOS&osType=Android`（请求多个 osType）。
osVersion 字符串	OsVersion 查询参数。客户端设备操作系统版本。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*14.3*` 或 `14.3*` 或 `*14.3` 示例 `osVersion=14.3`（请求单个 osVersion） `osVersion=14.3&osVersion=10.1`（请求多个 osVersion）。
siteHierarchy 字符串	SiteHierarchy 查询参数。从全局站点名称开始到特定站点名称结束的站点树的完整分层细分。根站点名为“Global”（例如，“Global/AreaName/BuildingName/FloorName”）。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*BuildingName*` 或 `BuildingName*` 或 `*BuildingName` 示例 `siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy） `siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaNa me/BuildingName1/FloorName2`（请求多个 siteHierarchy）。
siteHierarchyId 字符串	SiteHierarchyId 查询参数。从全局站点 UUID 开始到特定站点 UUID 结束的站点树的完整分层细分。（例如，“globalUuid/areaUuid/buildingUuid/floorUuid”）。此字段支持基于通配符（`*`）字符的搜索。例如 `*buildingUuid*` 或 `buildingUuid*` 或 `*buildingUuid` 示例 `siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid`（请求单个 siteHierarchyId） `siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1&siteHierarchyId=glo balUuid/areaUuid/buildingUuid1/floorUuid2`（请求多个 siteHierarchyId）。
siteId 字符串	SiteId 查询参数。站点 UUID，不包含顶级层次结构。（例如：“floorUuid”）示例 `siteId=floorUuid`（请求单个 siteId） `siteId=floorUuid1&siteId=floorUuid2`（请求多个 siteId）。
ssid 字符串	Ssid 查询参数。SSID 是客户端连接到的无线网络名称。它也称为 WLAN ID - 无线局域网标识符。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*Alpha*` 或 `Alpha*` 或 `*Alpha` 示例 `ssid=Alpha`（请求单个 ssid） `ssid=Alpha&ssid=Guest`（请求多个 ssid）。
startTime 浮点数	StartTime 查询参数。API 从其查询与资源相关的数集的起始时间。必须以毫秒为单位指定为 UNIX 纪元时间。值包含在内。如果未提供 `startTime`，API 将默认为当前时间。
type 字符串	Type 查询参数。客户端设备类型，指示客户端是通过有线还是无线介质连接到网络。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项 false true ← (默认)
wlcName 字符串	WlcName 查询参数。报告无线客户端的无线控制器名称。此字段支持基于通配符（`*`）字符的搜索。如果值包含（`*`）字符，请使用 /query API 进行正则表达式搜索。例如 `*wlc-25*` 或 `wlc-25*` 或 `*wlc-25` 示例 `wlcName=wlc-25`（请求单个 wlcName） `wlcName=wlc-25&wlc-34`（请求多个 wlcName）。

注释

注意

• 使用的 SDK 方法是 clients.Clients.retrieves_the_total_count_of_clients_by_applying_basic_filtering_v1，

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

• 支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 文档，关于 Clients RetrievesTheTotalCountOfClientsByApplyingBasicFilteringV1

RetrievesTheTotalCountOfClientsByApplyingBasicFilteringV1 API 的完整参考。

示例

- name: Get all Clients Count V1
  cisco.dnac.clients_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}}"
    startTime: 0
    endTime: 0
    type: string
    osType: string
    osVersion: string
    siteHierarchy: string
    siteHierarchyId: string
    siteId: string
    ipv4Address: string
    ipv6Address: string
    macAddress: string
    wlcName: string
    connectedNetworkDeviceName: string
    ssid: string
    band: string
  register: result

返回值

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回值：始终 示例： {"response": {"count": 0}, "version": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题追踪器
• 代码库（源代码）