Модуль cisco.meraki.networks_wireless_signal_quality_history_info — информационный модуль для networks _wireless _signalqualityhistory

Примечание

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

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

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

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

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

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

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

Информационный модуль для Networks Wireless Signalqualityhistory Info.
Получает все networks _wireless _signalqualityhistory.
Возвращает историю качества сигнала SNR/RSSI для устройства или сетевого клиента.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса ApTag. Фильтрует результаты по тегу точки доступа; необходимо одновременно указать clientId или deviceSerial.
autoResolution логическое значение	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса AutoResolution. Автоматически выбирает разрешение данных на основе заданного временного интервала; переопределяет значение, указанное параметром «resolution». По умолчанию задано значение false. Варианты: `false` `true`
band строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса Band. Фильтрует результаты по диапазону (допустимые значения: «2.4», «5» или «6»).
clientId строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса ClientId. Фильтрует результаты по сетевому клиенту.
deviceSerial строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса 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 строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр пути NetworkId. Идентификатор сети.
resolution целое число	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса Resolution. Временное разрешение возвращаемых данных в секундах. Допустимые значения: 300, 600, 1200, 3600, 14400, 86400. Значение по умолчанию — 86400.
ssid целое число	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса Ssid. Фильтрует результаты по номеру SSID.
t0 строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса T0. Начало временного интервала, за который возвращаются данные. Максимальный период ретроспективного просмотра — 31 день от текущей даты.
t1 строка	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса T1. Конец временного интервала, за который возвращаются данные. Значение T1 может отстоять от t0 не более чем на 31 день.
timespan число с плавающей запятой	Информационный модуль для Networks Wireless Signalqualityhistory Info. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 31 день. Значение по умолчанию — 7 дней.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _wireless _signalqualityhistory
  cisco.meraki.networks_wireless_signal_quality_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
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"snr\": 0,\n \"rssi\": 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_signal_quality_history_info_module.html