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

Примечание

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

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

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

Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам.
Получение всех organizations _wireless _devices _channelutilization _bydevice.
Получение средней загрузки канала для всех диапазонов сети с разбивкой по точкам доступа.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string): направление постраничной навигации — страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса endingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке 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 (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	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса NetworkIds. Фильтрация результатов по сети.
organizationId string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса PerPage. Число записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
serials list / elements=string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса Serials. Фильтрация результатов по устройству.
startingAfter string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
t0 string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса T0. Начало временного интервала для данных. Максимальный период получения данных за прошедшее время — 90 дней от текущей даты.
t1 string	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может отстоять от t0 не более чем на 90 дней.
timespan float	Информационный модуль для получения сведений о канале беспроводных устройств организации по устройствам. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 90 дней. Значение по умолчанию — 7 дней.
total_pages string / обязательный	total_pages(int): используйте вместе с 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_, используются Python SDK Cisco meraki для установки соединения

См. также

Документация Cisco Meraki по wireless 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_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: []
    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 list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"network\": {\n \"id\": \"string\"\n },\n \"byBand\": [\n {\n \"band\": \"string\",\n \"wifi\": {\n \"percentage\": 0\n },\n \"nonWifi\": {\n \"percentage\": 0\n },\n \"total\": {\n \"percentage\": 0\n }\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

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