cisco.dnac.client_proximity_v1_info 模块 – 客户接近 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，有关详细信息，请参阅 需求。
要在 playbook 中使用它，请指定：cisco.dnac.client_proximity_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有客户接近 V1。
此意图 API 将为特定无线用户提供客户端接近信息。接近度定义为与指定无线用户同时出现在同一楼层。在进行此 API 调用 NETWORK-CLIENTS-3-506 - 客户端接近度报告之前，接近度工作流需要通过事件通知工作流订阅以下事件。
注意
此模块具有相应的 操作插件。
需求
在执行此模块的主机上需要以下需求。
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。 默认： |
|
附加标头。 |
|
number_days 查询参数。跟踪接近度的天数，直到当前日期。默认为最多 14 天。 |
|
time_resolution 查询参数。测量接近度的间隔时间（以分钟为单位）。默认为 15 分钟，最小 5 分钟。 |
|
username 查询参数。需要接近信息无线客户端用户名。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构的请求正文验证。 选项
|
注释
注意
使用的 SDK 方法是 clients.Clients.client_proximity_v1，
使用的路径是 get /dna/intent/api/v1/client-proximity，
支持
check_mode插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参见
另请参见
- Cisco DNA Center 关于 Clients ClientProximityV1 的文档
ClientProximityV1 API 的完整参考。
示例
- name: Get all Client Proximity V1
cisco.dnac.client_proximity_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}}"
username: string
number_days: 0
time_resolution: 0
register: result
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 始终 示例： |