модуль cisco.meraki.organizations_summary_top_applications_by_usage_info — информационный модуль для организаций: сводка самых используемых приложений

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
device string	Информационный модуль для получения сводки самых используемых приложений организации. Параметр запроса Device. Сопоставляет результат с точным тегом устройства.
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 для всех конечных точек API По умолчанию: `"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` ← (по умолчанию)
networkId string	Информационный модуль для получения сводки самых используемых приложений организации. Параметр запроса NetworkId. Сопоставляет результат с точным идентификатором сети.
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. Значение должно быть задано в секундах и составлять не менее 25 минут и не более 186 дней. По умолчанию — 1 день.
usageUplink string	Информационный модуль для получения сводки самых используемых приложений организации. Параметр запроса UsageUplink. Фильтрует результаты по используемому каналу восходящей линии связи.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _summary _top _applications _by _usage
  cisco.meraki.organizations_summary_top_applications_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
    device: string
    networkId: string
    quantity: 0
    ssidName: string
    usageUplink: string
    t0: string
    t1: string
    timespan: 0
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"application\": \"string\",\n \"total\": 0,\n \"downstream\": 0,\n \"upstream\": 0,\n \"percentage\": 0\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_applications_by_usage_info_module.html