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

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _wireless _usagehistory
  cisco.meraki.networks_wireless_usage_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 \"totalKbps\": 0,\n \"sentKbps\": 0,\n \"receivedKbps\": 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_usage_history_info_module.html