Spec-Zone.ru › Ansible

модуль cisco.meraki.organizations_wireless_devices_packet_loss_by_device_info — информационный модуль для organizations _wireless _devices _packetloss _bydevice

Примечание

Этот модуль входит в коллекцию 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_device_info.

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

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

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

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

Примечание

Этому модулю соответствует модуль действий.

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

bands

list / elements=string

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

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

direction

string

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

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

endingBefore

string

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

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

headers

dictionary

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

meraki_action_batch_retry_wait_time

integer

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

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

meraki_api_key

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

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

meraki_base_url

string

meraki_base_url (строка) — базовый URL для всех ресурсов конечных точек

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

meraki_be_geo_id

string

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

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

meraki_certificate_path

string

meraki_certificate_path (строка) — путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер

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

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение) — наследовать экземпляр вашего регистратора

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка) — имя файла журнала с добавленными датой и временной меткой

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

meraki_log_path

string

log_path (строка) — путь для записи журнала; если не указан, используется рабочий каталог скрипта

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

meraki_maximum_retries

integer

meraki_maximum_retries (целое число) — максимальное количество повторных попыток при ошибках 429 и других ошибках на стороне сервера

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

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число) — время ожидания перед повторной попыткой при ошибке 429 от Nginx

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

meraki_output_log

boolean

meraki_output_log (логическое значение) — создавать файл журнала вывода?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (логическое значение) — выводить журнал в консоль?

Варианты:

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

networkIds

list / elements=string

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

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

organizationId

string

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

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

perPage

integer

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

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

serials

list / elements=string

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

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

ssids

list / elements=integer

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

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

startingAfter

string

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

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

t0

string

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

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

t1

string

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

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

timespan

float

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

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

total_pages

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

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

Примечания

Примечание

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

См. также

См. также

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

Полный справочник по API getOrganizationWirelessDevicesPacketLossByDevice.

Примеры

- name: Get all organizations _wireless _devices _packetloss _bydevice
  cisco.meraki.organizations_wireless_devices_packet_loss_by_device_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: []
    serials: []
    ssids: []
    bands: []
    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    \"network\": {\n      \"id\": \"string\",\n      \"name\": \"string\"\n    },\n    \"device\": {\n      \"name\": \"string\",\n      \"serial\": \"string\",\n      \"mac\": \"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_device_info_module.html

Spec-Zone.ru

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