cisco.meraki.networks_clients_info 模块 – 用于网络客户端的信息模块
注意
此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：cisco.meraki.networks_clients_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有网络客户端。
通过 ID 获取网络客户端。
列出在时间跨度内使用过此网络的客户端。
返回与给定标识符关联的客户端。客户端可以通过客户端密钥或 MAC 或 IP（取决于网络是否使用按 IP 跟踪）来标识。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ClientId 路径参数。客户端 ID。 |
|
Description 查询参数。根据 description 字段的部分或完整匹配筛选客户端。 |
|
direction (字符串)，用于分页的方向，可以是“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用于指示页面末尾的令牌。通常这是一个时间戳或 ID，但并不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一个、最后一个、前一个或下一个页面的链接应定义它。 |
|
其他标头。 |
|
Ip 查询参数。根据 ip 地址字段的部分或完整匹配筛选客户端。 |
|
Ip6 查询参数。根据 ip6 地址字段的部分或完整匹配筛选客户端。 |
|
Ip6Local 查询参数。根据 ip6Local 地址字段的部分或完整匹配筛选客户端。 |
|
Mac 查询参数。根据 mac 地址字段的部分或完整匹配筛选客户端。 |
|
meraki_action_batch_retry_wait_time (整数)，操作批处理并发错误重试等待时间 默认值： |
|
meraki_api_key (字符串)，在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (字符串)，在所有端点资源之前 默认值： |
|
meraki_be_geo_id (字符串)，用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认值： |
|
meraki_caller (字符串)，用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： |
|
meraki_certificate_path (字符串)，如果位于本地代理之后，用于 TLS/SSL 证书验证的路径 默认值： |
|
meraki_inherit_logging_config (布尔值)，继承您自己的记录器实例 选择
|
|
meraki_log_file_prefix (字符串)，附加了日期和时间戳的日志文件名 默认值： |
|
log_path (字符串)，输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认值： |
|
meraki_maximum_retries (整数)，遇到 429 或其他服务器端错误时，重试次数上限 默认值： |
|
meraki_nginx_429_retry_wait_time (整数)，Nginx 429 重试等待时间 默认值： |
|
meraki_output_log (布尔值)，创建输出日志文件？ 选择
|
|
meraki_print_console (布尔值)，将日志输出打印到控制台？ 选择
|
|
meraki_requests_proxy (字符串), 用于 HTTPS 的代理服务器和端口（如果需要）。 默认值： |
|
meraki_retry_4xx_error (布尔值), 如果遇到其他 4XX 错误（除了 429）是否重试？ 选择
|
|
meraki_retry_4xx_error_wait_time (整数), 其他 4XX 错误重试等待时间。 默认值： |
|
meraki_simulate (布尔值), 模拟 POST/PUT/DELETE 调用以防止更改？ 选择
|
|
meraki_single_request_timeout (整数), 每次 API 调用的最大秒数。 默认值： |
|
meraki_suppress_logging (布尔值), 禁用所有日志记录？那你就自求多福吧！ 选择
|
|
meraki_use_iterator_for_get_pages (布尔值), list* 方法将返回一个迭代器，每次返回一个对象，而不是包含所有项的完整列表。 选择
|
|
meraki_wait_on_rate_limit (布尔值), 如果遇到 429 速率限制错误是否重试？ 选择
|
|
NetworkId 路径参数。网络 ID。 |
|
Os 查询参数。根据操作系统字段的部分或完全匹配来筛选客户端。 |
|
PerPage 查询参数。每页返回的条目数。可接受范围是 3 - 1000。默认值为 10。 |
|
PskGroup 查询参数。根据 iPSK 名称字段的部分或完全匹配来筛选客户端。 |
|
RecentDeviceConnections 查询参数。根据最近的连接类型筛选客户端。可以是“有线”或“无线”。 |
|
StartingAfter 查询参数。服务器用于指示页面开始的令牌。通常这是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
Statuses 查询参数。根据状态筛选客户端。可以是“在线”或“离线”。 |
|
T0 查询参数。数据的起始时间跨度。最大回溯期是自今天起的 31 天。 |
|
Timespan 查询参数。将获取信息的时间跨度。如果指定 timespan，请勿指定参数 t0。该值必须以秒为单位，且小于或等于 31 天。默认值为 1 天。 |
|
total_pages(整数), 与 perPage 一起使用，以获取最多 total_pages*perPage 的总结果；-1 表示所有页。 |
|
Vlan 查询参数。根据 VLAN 字段的完全匹配来筛选客户端。 |
注释
注意
使用的 SDK 方法是 networks.Networks.get_network_client, networks.Networks.get_network_clients,
使用的路径是 get /networks/{networkId}/clients, get /networks/{networkId}/clients/{clientId},
支持
check_mode该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco Meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，关于 networks getNetworkClient
getNetworkClient API 的完整参考。
- Cisco Meraki 文档，关于 networks getNetworkClients
getNetworkClients API 的完整参考。
示例
- name: Get all networks _clients
cisco.meraki.networks_clients_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_caller: "{{meraki_caller}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
t0: string
timespan: 0
perPage: 0
startingAfter: string
endingBefore: string
statuses: []
ip: string
ip6: string
ip6Local: string
mac: string
os: string
pskGroup: string
description: string
vlan: string
recentDeviceConnections: []
networkId: string
total_pages: -1
direction: next
register: result
- name: Get networks _clients by id
cisco.meraki.networks_clients_info:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_caller: "{{meraki_caller}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
networkId: string
clientId: string
register: result
返回值
常见返回值已记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco Meraki Python SDK 返回的响应的字典或列表。 返回： 始终 示例： |