cisco.dnac.clients_query_count_v1 模块 – 用于客户端查询计数 V1 的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：cisco.dnac.clients_query_count_v1。

cisco.dnac 6.15.0 中的新增功能

概要 

管理客户端查询计数 V1 资源的创建操作。
通过应用复杂的筛选器检索客户端数量。有关 API 使用的详细信息，请参阅 Open API 规范文档 - 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

参数 

参数	注释
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 整数	结束时间。
filters 列表 / 元素=字典	客户端查询计数的筛选器。
key 字符串	键。
operator 字符串	运算符。
value 整数	值。
headers 字典	其他标头。
startTime 整数	开始时间。
validate_response_schema 布尔值	Cisco DNA Center SDK 用于启用针对 JSON 模式验证请求主体的标志。选择 `false` `true` ←（默认）

注释 

注意

使用的 SDK 方法是 clients.Clients.retrieves_the_number_of_clients_by_applying_complex_filters_v1
使用的路径是 post /dna/data/api/v1/clients/query/count
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 文档，了解客户端 RetrievesTheNumberOfClientsByApplyingComplexFiltersV1: RetrievesTheNumberOfClientsByApplyingComplexFiltersV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.clients_query_count_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}}"
    endTime: 0
    filters:
    - key: string
      operator: string
      value: 0
    headers: '{{my_headers | from_json}}'
    startTime: 0

返回值 

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

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

作者

Rafael Campos (@racampos)