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

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса apTag. Фильтрация результатов по тегу точки доступа.
autoResolution boolean	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса autoResolution. Автоматический выбор разрешения данных на основе заданного временного интервала; переопределяет значение, указанное параметром «resolution». По умолчанию — false. Варианты: `false` `true`
band string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса band. Фильтрация результатов по диапазону ( «2.4», «5» или «6»).
clientId string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса clientId. Фильтрация результатов по клиенту сети.
deviceSerial string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса deviceSerial. Фильтрация результатов по устройству.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также можно задать как переменную среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый URL, предшествующий ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать как переменную среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе через локальный прокси По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение), использовать ваш экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь для сохранения журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), прокси-сервер и порт для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать запросы POST/PUT/DELETE, не внося изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда вы сами за себя! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр пути networkId. Идентификатор сети.
resolution integer	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса resolution. Временное разрешение возвращаемых данных в секундах. Допустимые значения: 300, 600, 1200, 3600, 14400, 86400. Значение по умолчанию — 86400.
ssid integer	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса ssid. Фильтрация результатов по номеру SSID.
t0 string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса t0. Начало временного интервала для данных. Максимальный период в прошлом — 31 день от текущей даты.
t1 string	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса t1. Конец временного интервала для данных. Значение t1 может отстоять от t0 не более чем на 31 день.
timespan float	Информационный модуль для получения сведений о скоростях передачи данных в беспроводных сетях. Параметр запроса timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 31 день. По умолчанию — 7 дней.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _wireless _dataratehistory
  cisco.meraki.networks_wireless_data_rate_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 list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"averageKbps\": 0,\n \"downloadKbps\": 0,\n \"uploadKbps\": 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_data_rate_history_info_module.html