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 的跟踪。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ClientId 路径参数。客户端 ID。 |
|
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 查询参数。根据操作系统 (OS) 字段的部分或完全匹配过滤客户端。 |
|
PerPage 查询参数。返回的每页条目数。可接受的范围是 3-1000。默认为 10。 |
|
PskGroup 查询参数。根据 iPSK 名称字段的部分或完全匹配过滤客户端。 |
|
RecentDeviceConnections 查询参数。根据最近的连接类型过滤客户端。可以是“Wired”或“Wireless”之一。 |
|
StartingAfter 查询参数。服务器用来指示页面开始的令牌。通常是时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
状态查询参数。根据状态过滤客户端。可以是“在线”或“离线”之一。 |
|
T0 查询参数。数据的起始时间段。最大回溯时间为今天起 31 天。 |
|
时间跨度查询参数。将获取信息的时长。如果指定时间跨度，请勿指定参数 t0。值必须以秒为单位，且小于或等于 31 天。默认值为 1 天。 |
|
total_pages(int)，与 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 网络 getNetworkClient 文档
getNetworkClient API 的完整参考。
- Cisco Meraki 网络 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 返回的响应的字典或列表。 返回值：始终 示例： |