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

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса apTag. Фильтрует результаты по тегу точки доступа и возвращает показатели использования каналов точками доступа для устройств с указанным тегом; необходимо также указать clientId или deviceSerial.
autoResolution boolean	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса autoResolution. Автоматически выбирает разрешение данных на основе заданного интервала времени; переопределяет значение, указанное параметром ‘resolution’. По умолчанию — false. Варианты: `false` `true`
band string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса band. Фильтрует результаты по диапазону (’2.4’, ’5’ или ’6’).
clientId string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса clientId. Фильтрует результаты по сетевому клиенту и возвращает показатели использования каналов точками доступа для каждого устройства и диапазона, связанные с историей подключений указанного клиента.
deviceSerial string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса deviceSerial. Фильтрует результаты по устройству и возвращает показатели использования каналов точки доступа для указанного устройства; необходимо также указать band или clientId.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повторным выполнением пакетного действия при ошибке параллельного выполнения По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также можно задать в переменной окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL для всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной окружения BE_GEO_ID По умолчанию: `""`
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. Идентификатор сети.
resolution integer	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса resolution. Разрешение времени в секундах для возвращаемых данных. Допустимые значения: 600, 1200, 3600, 14400, 86400. Значение по умолчанию — 86400.
t0 string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса t0. Начало временного интервала для данных. Максимальный период ретроспективного просмотра — 31 день от текущей даты.
t1 string	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса t1. Конец временного интервала для данных. Значение t1 может отстоять от t0 не более чем на 31 день.
timespan float	Информационный модуль для получения сведений об истории использования каналов беспроводной сети. Параметр запроса timespan. Временной интервал, за который извлекаются сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 31 день. Значение по умолчанию — 7 дней.

Примечания

Примечание

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

См. также

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

Примеры

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

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

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

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