Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_wireless_channel_utilization_history_info – Информационный модуль для networks_wireless_channelutilizationhistory

Примечание

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

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

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

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

Новый в cisco.meraki 2.16.0

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

Описание

  • Получить все networks_wireless_channelutilizationhistory.
  • Возвращает использование канала AP со временем для устройства или клиента сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

apTag

string

Параметр запроса ApTag. Фильтрует результаты по тегу AP, чтобы возвращать показатели использования канала AP для устройств, помеченных данным тегом; необходимо совместно указать либо clientId, либо deviceSerial.

autoResolution

boolean

Параметр запроса AutoResolution. Автоматически выбирает разрешение данных на основе заданного временного интервала; это переопределяет значение, указанное параметром «resolution». Настройка по умолчанию — false.

Варианты:

  • false
  • true

band

string

Параметр запроса Band. Фильтрует результаты по полосе пропускания (либо ‘2.4’, ‘5’ или ‘6’).

clientId

string

Параметр запроса ClientId. Фильтрует результаты по клиенту сети, чтобы возвращать показатели использования канала AP на уровне каждого устройства и каждой полосы пропускания, объединенные внутренним соединением с историей подключений запрошенного клиента.

deviceSerial

string

Параметр запроса DeviceSerial. Фильтрует результаты по устройству, чтобы возвращать показатели использования канала AP для запрошенного устройства; необходимо совместно указать либо band, либо clientId.

headers

dictionary

Дополнительные заголовки.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий

По умолчанию: 60

meraki_api_key

string / required

meraki_api_key (string), API ключ, сгенерированный на панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), предшествует всем конечным точкам ресурсов

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID

По умолчанию: ""

meraki_caller

string

meraki_caller (string), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""

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 может быть максимум через 31 день после t0.

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_, используются Cisco meraki Python SDK для установления соединения

См. также

См. также

Документация 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_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

список / элементы=словарь

Словарь или список с ответом, возвращённым Cisco Meraki Python SDK

Возвращается: всегда

Пример: "[\n  {\n    \"endTs\": \"string\",\n    \"startTs\": \"string\",\n    \"utilization80211\": 0,\n    \"utilizationNon80211\": 0,\n    \"utilizationTotal\": 0\n  }\n]\n"

Авторы

  • Франсиско Муньос (@fmunoz)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API