Модуль cisco.meraki.organizations_summary_top_devices_by_usage_info — информационный модуль для organizations _summary _top _devices _byusage

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о самых используемых устройствах организации.
Получает все данные organizations _summary _top _devices _byusage.
Возвращает показатели для 10 самых используемых устройств организации, отсортированных по объёму переданных данных за указанный период. Единица измерения по умолчанию — мегабайты.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceTag string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса deviceTag. Фильтрует результаты по точному совпадению с тегом устройства.
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 (целое число), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `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` ← (по умолчанию)
networkTag string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса NetworkTag. Фильтрует результаты по точному совпадению с тегом сети.
organizationId string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр пути OrganizationId. Идентификатор организации.
quantity integer	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса Quantity. Задаёт количество возвращаемых результатов. По умолчанию — 10. Максимальное значение — 50.
ssidName string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса SsidName. Фильтрует результаты по имени SSID.
t0 string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса T0. Начало периода, за который запрашиваются данные.
t1 string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса T1. Конец периода, за который запрашиваются данные. Значение T1 может отстоять от t0 не более чем на 186 дней.
timespan float	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса Timespan. Период, за который будут получены данные. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и составлять не менее 8 часов и не более 186 дней. По умолчанию — 1 день.
usageUplink string	Информационный модуль для получения сведений о самых используемых устройствах организации. Параметр запроса UsageUplink. Фильтрует результаты по используемому восходящему каналу.

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.get_organization_summary_top_devices_by_usage,
Используемые пути: get /organizations/{organizationId}/summary/top/devices/byUsage,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco Meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco Meraki для установки подключения

См. также

Документация Cisco Meraki для organizations getOrganizationSummaryTopDevicesByUsage: Полное описание API getOrganizationSummaryTopDevicesByUsage.

Примеры

- name: Get all organizations _summary _top _devices _byusage
  cisco.meraki.organizations_summary_top_devices_by_usage_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 }}"
    networkTag: string
    deviceTag: string
    quantity: 0
    ssidName: string
    usageUplink: string
    t0: string
    t1: string
    timespan: 0
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"name\": \"string\",\n \"model\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"productType\": \"string\",\n \"network\": {\n \"name\": \"string\",\n \"id\": \"string\"\n },\n \"usage\": {\n \"total\": 0,\n \"percentage\": 0\n },\n \"clients\": {\n \"counts\": {\n \"total\": 0\n }\n }\n }\n]\n"`

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"name\": \"string\",\n \"model\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"productType\": \"string\",\n \"network\": {\n \"name\": \"string\",\n \"id\": \"string\"\n },\n \"usage\": {\n \"total\": 0,\n \"percentage\": 0\n },\n \"clients\": {\n \"counts\": {\n \"total\": 0\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_summary_top_devices_by_usage_info_module.html