Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_wireless_devices_packet_loss_by_client_info – Модуль информации для организаций _беспроводных_ устройств _packetloss_ по_клиентам

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.18.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 2.18.0

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

Описание

  • Получение всех организаций _беспроводных_ устройств _packetloss_ по _клиентам_.
  • Получение средней потери пакетов за заданный период времени для всех клиентов в организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

bands

list / elements=string

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

direction

string

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

Default: "https://api.meraki.com/api/v1"

endingBefore

string

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

headers

dictionary

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

macs

list / elements=string

Параметр запроса Macs. Фильтрует результаты по MAC-адресу(-ам) клиента.

meraki_action_batch_retry_wait_time

integer

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

Default: 60

meraki_api_key

string / required

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

meraki_base_url

string

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

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

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

Default: ""

meraki_caller

string

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

Default: ""

meraki_certificate_path

string

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

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (булево), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

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

Default: "meraki_api_"

meraki_log_path

string

log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

Default: ""

meraki_maximum-retries

integer

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

Default: 2

meraki_nginx_429_retry_wait_time

integer

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

Default: 60

meraki_output_log

boolean

meraki_output_log (булево), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (булево), выводить выходные данные журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

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

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (булево), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Выбоpы:

  • 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, чтобы предотвратить изменения?

Выбоpы:

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

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API

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

meraki_suppress_logging

boolean

meraki_suppress_logging (булево), отключить всю регистрацию? Тогда вы сами за себя!

Выбоpы:

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

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (булево), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Выбоpы:

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

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (булево), повторить попытку при возникновении ошибки 429 ограничения скорости?

Выбоpы:

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

networkIds

list / elements=string

Параметр запроса networkIds. Фильтрует результаты по сети.

organizationId

string

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

perPage

integer

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

ssids

list / elements=integer

Параметр запроса ssids. Фильтрует результаты по номеру SSID.

startingAfter

string

Параметр запроса startingAfter. Маркер, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определять.

t0

string

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

t1

string

Параметр запроса t1. Конец временного интервала для данных. t1 может быть максимум через 90 дней после t0.

timespan

float

Параметр запроса 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_client,
  • Используемые пути: get /organizations/{organizationId}/wireless/devices/packetLoss/byClient,
  • Поддерживает check_mode
  • Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений из Cisco meraki SDK
  • Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления соединения

См. также

См. также

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

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

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

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

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

Spec-Zone.ru

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