Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.organizations_wireless_devices_channel_utilization_by_device_info.

Новое в cisco.meraki 2.18.0

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

Обзор

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

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

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

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

endingBefore

string

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

headers

dictionary

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

interval

integer

Параметр запроса Interval. Временной интервал в секундах для возвращаемых данных. Допустимые интервалы: 300, 600, 3600, 7200, 14400, 21600. Значение по умолчанию — 3600.

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

строка

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

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

meraki_retry_4xx_error

логический

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

Варианты:

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

meraki_retry_4xx_error_wait_time

целое число

meraki_retry_4xx_error_wait_time (целое число), время ожидания повторной попытки при других ошибках 4XX

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

meraki_simulate

логический

meraki_simulate (логический), имитировать вызовы POST/PUT/DELETE для предотвращения изменений?

Варианты:

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

meraki_single_request_timeout

целое число

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

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

meraki_suppress_logging

логический

meraki_suppress_logging (логический), отключить всю запись в журнал? Тогда сами разбирайтесь!

Варианты:

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

meraki_use_iterator_for_get_pages

логический

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

Варианты:

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

meraki_wait_on_rate_limit

логический

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

Варианты:

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

networkIds

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

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

organizationId

строка

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

perPage

целое число

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

serials

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

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

startingAfter

строка

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

t0

строка

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

t1

строка

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

timespan

вещественное число

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

total_pages

строка / обязательно

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

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki по беспроводным устройствам getOrganizationWirelessDevicesChannelUtilizationByDevice

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

Примеры

- name: Get all organizations _wireless _devices _channelutilization _bydevice
  cisco.meraki.organizations_wireless_devices_channel_utilization_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    networkIds: []
    serials: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    t0: string
    t1: string
    timespan: 0
    interval: 0
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Значения возврата

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

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n  {\n    \"byBand\": [\n      {\n        \"band\": \"string\",\n        \"nonWifi\": {\n          \"percentage\": 0\n        },\n        \"total\": {\n          \"percentage\": 0\n        },\n        \"wifi\": {\n          \"percentage\": 0\n        }\n      }\n    ],\n    \"mac\": \"string\",\n    \"network\": {\n      \"id\": \"string\"\n    },\n    \"serial\": \"string\"\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_channel_utilization_by_device_info_module.html

Spec-Zone.ru

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