Модуль cisco.meraki.organizations_summary_top_devices_models_by_usage_info — информационный модуль для organizations _summary _top _devices _models _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_models_by_usage_info.

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

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

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

Информационный модуль для получения сведений об организациях и наиболее используемых моделях устройств.
Получает все organizations _summary _top _devices _models _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 (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` ← (по умолчанию)
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_models_by_usage,
Используемые пути: get /organizations/{organizationId}/summary/top/devices/models/byUsage,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого применяет встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

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

Примеры

- name: Get all organizations _summary _top _devices _models _byusage
  cisco.meraki.organizations_summary_top_devices_models_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 \"model\": \"string\",\n \"count\": 0,\n \"usage\": {\n \"total\": 0,\n \"average\": 0\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_models_by_usage_info_module.html