Spec-Zone.ru › Ansible

модуль cisco.meraki.organizations_wireless_devices_packet_loss_by_client_info – информационный модуль для organizations _wireless _devices _packetloss _byclient

Примечание

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

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

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

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

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

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

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

  • Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.
  • Получение всех organizations _wireless _devices _packetloss _byclient.
  • Получение среднего уровня потери пакетов за указанный период для всех клиентов организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

bands

list / elements=string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса Bands. Фильтрация результатов по диапазону частот. Допустимые значения: 2.4, 5 и 6.

direction

string

direction (string), направление постраничной навигации: «next» (по умолчанию) или страница «prev»

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

endingBefore

string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.

headers

dictionary

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

macs

list / elements=string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса Macs. Фильтрация результатов по MAC-адресам клиентов.

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 ← (по умолчанию)

networkIds

list / elements=string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса NetworkIds. Фильтрация результатов по сети.

organizationId

string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр пути OrganizationId. Идентификатор организации.

perPage

integer

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.

ssids

list / elements=integer

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса Ssids. Фильтрация результатов по номеру SSID.

startingAfter

string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.

t0

string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса T0. Начало периода для данных. Максимальный период получения данных за прошлое составляет 90 дней от текущей даты.

t1

string

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса T1. Конец периода для данных. Значение T1 может отстоять от t0 не более чем на 90 дней.

timespan

float

Информационный модуль для Organizations Wireless Devices Packetloss Byclient Info.

Параметр запроса Timespan. Период, за который будут получены данные. Если задан timespan, не указывайте параметры t0 и t1. Значение задаётся в секундах и должно быть не меньше 5 минут и не больше 90 дней. Значение по умолчанию — 7 дней.

total_pages

string / обязательный

total_pages(int), используйте вместе с perPage, чтобы получить не более total_pages*perPage результатов; -1 — все страницы

Примечания

Примечание

  • Используемый метод SDK: wireless.Wireless.get_organization_wireless_devices_packet_loss_by_client,
  • Используемый путь: get /organizations/{organizationId}/wireless/devices/packetLoss/byClient,
  • Поддерживает check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а использует встроенный менеджер подключений из Cisco meraki SDK
  • Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки подключения

См. также

См. также

Документация Cisco Meraki по wireless getOrganizationWirelessDevicesPacketLossByClient

Полное описание API getOrganizationWirelessDevicesPacketLossByClient.

Примеры

- name: Get all organizations _wireless _devices _packetloss _byclient
  cisco.meraki.organizations_wireless_devices_packet_loss_by_client_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 }}"
    networkIds: []
    ssids: []
    bands: []
    macs: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    t0: string
    t1: string
    timespan: 0
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n  {\n    \"downstream\": {\n      \"total\": 0,\n      \"lost\": 0,\n      \"lossPercentage\": 0\n    },\n    \"upstream\": {\n      \"total\": 0,\n      \"lost\": 0,\n      \"lossPercentage\": 0\n    },\n    \"client\": {\n      \"id\": \"string\",\n      \"mac\": \"string\"\n    },\n    \"network\": {\n      \"id\": \"string\",\n      \"name\": \"string\"\n    }\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/organizations_wireless_devices_packet_loss_by_client_info_module.html

Spec-Zone.ru

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