модуль cisco.meraki.networks_wireless_latency_history_info — информационный модуль для истории задержек беспроводной сети

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об истории задержек беспроводной сети.
Получение всех данных об истории задержек беспроводной сети.
Возвращает среднюю задержку беспроводной сети за выбранный период для сети, устройства или клиента сети.

Примечание

Этому модулю соответствует модуль действий.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
accessCategory строка	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса AccessCategory. Фильтрация по категории доступа.
apTag строка	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса ApTag. Фильтрация результатов по тегу точки доступа.
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 (строка), базовый URL для всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
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. Идентификатор сети.
resolution целое число	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса Resolution. Интервал времени в секундах для возвращаемых данных. Допустимые значения: 300, 600, 1200, 3600, 14400, 86400. Значение по умолчанию — 86400.
ssid целое число	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса Ssid. Фильтрация результатов по номеру SSID.
t0 строка	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса T0. Начало временного интервала для данных. Максимальный период, за который можно получить данные, — 31 день до текущей даты.
t1 строка	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса T1. Конец временного интервала для данных. Дата T1 может быть не более чем на 31 день позже t0.
timespan число с плавающей точкой	Информационный модуль для получения сведений об истории задержек беспроводной сети. Параметр запроса 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_ используются Python SDK Cisco meraki для установления соединения

См. также

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

Примеры

- 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_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
    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 список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"avgLatencyMs\": 0\n }\n]\n"`

Авторы

Francisco Munoz (@fmunoz)

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

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