Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_wireless_usage_history_info – Информационный модуль для сетей _wireless _usagehistory

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

apTag

string

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

autoResolution

boolean

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

Варианты:

  • false
  • true

band

string

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

clientId

string

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

deviceSerial

string

Параметр запроса DeviceSerial. Фильтрует результаты по устройству. Требуется band.

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 (строка), прокси-сервер и порт, если необходимо, для 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 может быть максимум на 31 день после t0.

timespan

float

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

См. также

См. также

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

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

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

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

Пример: "[\n  {\n    \"endTs\": \"string\",\n    \"receivedKbps\": 0,\n    \"sentKbps\": 0,\n    \"startTs\": \"string\",\n    \"totalKbps\": 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_usage_history_info_module.html

Spec-Zone.ru

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