cisco.dnac.clients_query_v1 模块 – 客户查询 V1 资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 需求 了解详情。
要在 playbook 中使用它，请指定： cisco.dnac.clients_query_v1。
cisco.dnac 6.15.0 中的新增功能
概要
管理资源 Clients Query 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。
注意
此模块具有相应的 action 插件。
需求
在执行此模块的主机上需要以下需求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
客户端查询的 aggregateAttributes。 |
|
函数。 |
|
名称。 |
|
属性。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
结束时间。 |
|
客户端查询的过滤器。 |
|
键。 |
|
操作符。 |
|
值。 |
|
附加标头。 |
|
客户端查询的页码。 |
|
限制。 |
|
偏移量。 |
|
客户端查询的 sortBy。 |
|
名称。 |
|
顺序。 |
|
开始时间。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
|
视图。 |
备注
注意
使用的 SDK 方法是 clients.Clients.retrieves_the_list_of_clients_by_applying_complex_filters_while_also_supporting_aggregate_attributes_v1，
使用的路径是 post /dna/data/api/v1/clients/query，
不支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 关于 Clients RetrievesTheListOfClientsByApplyingComplexFiltersWhileAlsoSupportingAggregateAttributesV1 的文档
RetrievesTheListOfClientsByApplyingComplexFiltersWhileAlsoSupportingAggregateAttributesV1 API 的完整参考。
示例
- name: Create
cisco.dnac.clients_query_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}}"
aggregateAttributes:
- function: string
name: string
attributes:
- string
endTime: 0
filters:
- key: string
operator: string
value: 0
headers: '{{my_headers | from_json}}'
page:
limit: 0
offset: 0
sortBy:
- name: string
order: string
startTime: 0
views:
- string
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回：始终返回 示例： |