cisco.meraki.networks_wireless_latency_history_info 模块 – 用于 networks _wireless _latencyhistory 的信息模块

注意

此模块是 cisco.meraki 集合(版本 2.18.3)的一部分。

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

要安装它,请使用:ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

要在 Playbook 中使用它,请指定:cisco.meraki.networks_wireless_latency_history_info

cisco.meraki 2.16.0 中的新增功能

概要

  • 获取所有 networks _wireless _latencyhistory。

  • 返回网络、设备或网络客户端随时间的平均无线延迟。

注意

此模块具有相应的 操作插件

要求

在执行此模块的主机上需要以下要求。

  • meraki >= 2.4.9

  • python >= 3.5

参数

参数

注释

accessCategory

字符串

AccessCategory 查询参数。按访问类别筛选。

apTag

字符串

ApTag 查询参数。按 AP 标签筛选结果。

autoResolution

布尔值

AutoResolution 查询参数。根据给定的时间跨度自动选择数据分辨率;这会覆盖 ‘resolution’ 参数指定的值。默认设置为 false。

选项

  • false

  • true

band

字符串

Band 查询参数。按频段(‘2.4’、‘5’ 或 ‘6’)筛选结果。

clientId

字符串

ClientId 查询参数。按网络客户端筛选结果。

deviceSerial

字符串

DeviceSerial 查询参数。按设备筛选结果。

headers

字典

其他标头。

meraki_action_batch_retry_wait_time

整数

meraki_action_batch_retry_wait_time(整数),操作批处理并发错误重试等待时间

默认值: 60

meraki_api_key

字符串 / 必需

meraki_api_key(字符串),仪表板中生成的 API 密钥;也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY

meraki_base_url

字符串

meraki_base_url(字符串),所有端点资源的前缀

默认值: "https://api.meraki.com/api/v1"

meraki_be_geo_id

字符串

meraki_be_geo_id(字符串),用于 API 使用情况跟踪的可选合作伙伴标识符;也可以设置为环境变量 BE_GEO_ID

默认值: ""

meraki_caller

字符串

meraki_caller(字符串),用于 API 使用情况跟踪的可选标识符;也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER

默认值: ""

meraki_certificate_path

字符串

meraki_certificate_path(字符串),如果位于本地代理之后,则用于 TLS/SSL 证书验证的路径

默认值: ""

meraki_inherit_logging_config

布尔值

meraki_inherit_logging_config(布尔值),继承您自己的记录器实例

选项

  • false ← (默认)

  • true

meraki_log_file_prefix

字符串

meraki_log_file_prefix(字符串),附加日期和时间戳的日志文件名

默认值: "meraki_api_"

meraki_log_path

字符串

log_path(字符串),输出日志的路径;默认情况下,如果未指定,则为脚本的工作目录

默认值: ""

meraki_maximum_retries

整数

meraki_maximum_retries(整数),在遇到 429 或其他服务器端错误时最多重试此多次

默认值: 2

meraki_nginx_429_retry_wait_time

整数

meraki_nginx_429_retry_wait_time(整数),Nginx 429 重试等待时间

默认值: 60

meraki_output_log

布尔值

meraki_output_log(布尔值),创建输出日志文件?

选项

  • false

  • true ← (默认)

meraki_print_console

布尔值

meraki_print_console(布尔值),将日志输出打印到控制台?

选项

  • false

  • true ← (默认)

meraki_requests_proxy

字符串

meraki_requests_proxy(字符串),如果需要,则用于 HTTPS 的代理服务器和端口

默认值: ""

meraki_retry_4xx_error

布尔值

meraki_retry_4xx_error(布尔值),如果遇到其他 4XX 错误(除了 429)是否重试?

选项

  • false ← (默认)

  • true

meraki_retry_4xx_error_wait_time

整数

meraki_retry_4xx_error_wait_time(整数),其他 4XX 错误重试等待时间

默认值: 60

meraki_simulate

布尔值

meraki_simulate(布尔值),模拟 POST/PUT/DELETE 调用以防止更改?

选项

  • false ← (默认)

  • true

meraki_single_request_timeout

整数

meraki_single_request_timeout(整数),每次 API 调用的最大秒数

默认值: 60

meraki_suppress_logging

布尔值

meraki_suppress_logging(布尔值),禁用所有日志记录?然后您就靠自己了!

选项

  • false ← (默认)

  • true

meraki_use_iterator_for_get_pages

布尔值

meraki_use_iterator_for_get_pages(布尔值),list* 方法将返回一个迭代器,其中包含每个对象,而不是包含所有项的完整列表

选项

  • false ← (默认)

  • true

meraki_wait_on_rate_limit

布尔值

meraki_wait_on_rate_limit(布尔值),如果遇到 429 速率限制错误是否重试?

选项

  • false

  • true ← (默认)

networkId

字符串

NetworkId 路径参数。网络 ID。

resolution

整数

Resolution 查询参数。返回数据的时间分辨率(以秒为单位)。有效的分辨率为 300、600、1200、3600、14400、86400。默认值为 86400。

ssid

整数

Ssid 查询参数。按 SSID 号码筛选结果。

t0

字符串

T0 查询参数。数据的时间跨度的开始。最长的回溯期为自今天起 31 天。

t1

字符串

T1 查询参数。数据的时间跨度的结束。T1 最多可在 t0 之后 31 天。

timespan

浮点数

Timespan 查询参数。将获取信息的的时间跨度。如果指定时间跨度,则不要指定参数 t0 和 t1。该值必须以秒为单位,并且必须小于或等于 31 天。默认值为 7 天。

注意事项

注意

  • 使用的 SDK 方法是 wireless.Wireless.get_network_wireless_latency_history,

  • 使用的路径是 get /networks/{networkId}/wireless/latencyHistory,

  • 支持 check_mode

  • 该插件在控制节点上运行,不使用任何 ansible 连接插件,而是使用 Cisco Meraki SDK 的嵌入式连接管理器

  • 以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接

另请参阅

另请参阅

Cisco Meraki 文档,了解无线 getNetworkWirelessLatencyHistory

getNetworkWirelessLatencyHistory API 的完整参考。

示例

- name: Get all networks _wireless _latencyhistory
  cisco.meraki.networks_wireless_latency_history_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    t0: string
    t1: string
    timespan: 0
    resolution: 0
    autoResolution: True
    clientId: string
    deviceSerial: string
    apTag: string
    band: string
    ssid: 0
    accessCategory: string
    networkId: string
  register: result

返回值

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

描述

meraki_response

列表 / 元素=字典

一个字典或列表,包含 Cisco Meraki Python SDK 返回的响应

返回: 总是

示例: "[\n  {\n    \"avgLatencyMs\": 0,\n    \"endTs\": \"string\",\n    \"startTs\": \"string\"\n  }\n]\n"

作者

  • Francisco Munoz (@fmunoz)