cisco.meraki.networks_wireless_clients_latency_stats_info модуль — Модуль информации для сетей _wireless _clients _latencystats

Примечание

Этот модуль является частью коллекции cisco.meraki (версия 2.18.2).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.meraki. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: cisco.meraki.networks_wireless_clients_latency_stats_info.

Добавлена в cisco.meraki 2.16.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Краткое описание

Получить все сети _wireless _clients _latencystats.
Сводная информация о задержке для заданного клиента в этой сети. Клиенты идентифицируются по их MAC-адресу.

Примечание

У этого модуля есть соответствующий плагин действия.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag string	Параметр запроса ApTag. Фильтрует результаты по тегу AP.
band string	Параметр запроса Band. Фильтрует результаты по полосе пропускания (либо ‘2.4’, ‘5’ или ‘6’). Обратите внимание, что данные до февраля 2020 года не будут содержать информацию о полосе пропускания.
clientId string	Параметр пути ClientId. Идентификатор клиента.
fields string	Параметр запроса Fields. Частичный выбор. Если присутствует, этот вызов вернет только выбранные поля “rawDistribution”, “avg”. По умолчанию будут возвращены все поля. Выбранные поля должны быть введены в виде строки, разделенной запятыми.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может быть также установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может быть также установлен как переменная окружения BE_GEO_ID По умолчанию: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может быть также установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS По умолчанию: `""`

meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора попытки при ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя в ответе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку при возникновении ошибки ограничения скорости 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
ssid integer	Параметр запроса Ssid. Фильтрует результаты по SSID.
t0 string	Параметр запроса T0. Начало временного интервала для данных. Максимальный период обратного просмотра составляет 180 дней с сегодняшнего дня.
t1 string	Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 7 дней позже t0.
timespan float	Параметр запроса Timespan. Временной интервал, для которого будет извлекаться информация. При указании timespan не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 7 дням.
vlan integer	Параметр запроса Vlan. Фильтрует результаты по VLAN.

Примечания

Примечание

Используемые методы SDK: wireless.Wireless.get_network_wireless_client_latency_stats,
Используемые пути: get /networks/{networkId}/wireless/clients/{clientId}/latencyStats,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco Meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco Meraki Python SDK для установления соединения

См. также

Документация Cisco Meraki для wireless getNetworkWirelessClientLatencyStats: Полная справка по API getNetworkWirelessClientLatencyStats.

Примеры

- name: Get all networks _wireless _clients _latencystats
  cisco.meraki.networks_wireless_clients_latency_stats_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
    band: string
    ssid: 0
    vlan: 0
    apTag: string
    fields: string
    networkId: string
    clientId: string
  register: result

Возвращаемые значения

Общие возвращаемые значения задокументированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `{"latencyStats": {"backgroundTraffic": {"avg": 0, "rawDistribution": {"0": 0, "1": 0, "1024": 0, "128": 0, "16": 0, "2": 0, "2048": 0, "256": 0, "32": 0, "4": 0, "512": 0, "64": 0, "8": 0}}, "bestEffortTraffic": "string", "videoTraffic": "string", "voiceTraffic": "string"}, "mac": "string"}`

Ключ

Описание

meraki_response

dictionary

Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK

Возвращается: всегда

Пример: {"latencyStats": {"backgroundTraffic": {"avg": 0, "rawDistribution": {"0": 0, "1": 0, "1024": 0, "128": 0, "16": 0, "2": 0, "2048": 0, "256": 0, "32": 0, "4": 0, "512": 0, "64": 0, "8": 0}}, "bestEffortTraffic": "string", "videoTraffic": "string", "voiceTraffic": "string"}, "mac": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_wireless_clients_latency_stats_info_module.html