Модуль cisco.meraki.devices_wireless_latency_stats_info – Модуль информации для устройств _wireless _latencystats

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.meraki.devices_wireless_latency_stats_info.

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

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

Описание

Получить все устройства _wireless _latencystats.
Агрегированная информация о задержке для указанного точки доступа в этой сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag string	Параметр запроса ApTag. Фильтрует результаты по тегу AP.
band string	Параметр запроса Band. Фильтрует результаты по диапазону (либо ‘2.4’, ‘5’ или ‘6’). Обратите внимание, что данные до февраля 2020 года не будут содержать информацию о диапазоне.
fields string	Параметр запроса Fields. Частичный выбор. Если присутствует, этот вызов вернет только выбранные поля «rawDistribution», «avg». По умолчанию будут возвращены все поля. Выбранные поля должны быть введены в виде строки, разделенной запятыми.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; также может быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем ресурсам конечных точек Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная окружения BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала, к которому добавляется дата и метка времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить журналы в консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `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` ← (по умолчанию)
serial строка	Параметр пути serial.
ssid целое число	Параметр запроса ssid. Фильтрует результаты по SSID.
t0 строка	Параметр запроса T0. Начало временного интервала для данных. Максимальный период поиска — 180 дней от текущей даты.
t1 строка	Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 7 дней после t0.
timespan число с плавающей точкой	Параметр запроса timespan. Временной интервал, для которого будут получены данные. Если задан timespan, параметры t0 и t1 не должны задаваться. Значение должно быть в секундах и не превышать 7 дней.
vlan целое число	Параметр запроса vlan. Фильтрует результаты по VLAN.

Примечания

Примечание

Используемые методы SDK — wireless.Wireless.get_device_wireless_latency_stats,
Используемые пути — get /devices/{serial}/wireless/latencyStats,
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления подключения

См. также

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

Примеры

- name: Get all devices _wireless _latencystats
  cisco.meraki.devices_wireless_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
    serial: string
  register: result

Значения возврата

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением возврата 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"}, "serial": "string"}`

Ключ

Описание

meraki_response

словарь

Словарь или список со значением возврата 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"}, "serial": "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/devices_wireless_latency_stats_info_module.html