модуль cisco.meraki.organizations_summary_top_clients_manufacturers_by_usage_info — информационный модуль для organizations _summary _top _clients _manufacturers _byusage

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации.
Получение всех данных organizations _summary _top _clients _manufacturers _byusage.
Возвращает метрики использования данных наиболее активными клиентами организации в МБ за указанный период времени, сгруппированные по производителю.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceTag строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса DeviceTag. Сопоставляет результат с точным тегом устройства.
headers словарь	Дополнительные заголовки.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллелизма пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также его можно задать в переменной окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также его можно задать в переменной окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать экземпляр вашего регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и временная метка По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для выходного журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать файл выходного журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
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` ← (по умолчанию)
networkTag строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса NetworkTag. Сопоставляет результат с точным тегом сети.
organizationId строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр пути OrganizationId. Идентификатор организации.
quantity целое число	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса Quantity. Задает количество результатов. По умолчанию — 10. Максимальное значение — 50.
ssidName строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса SsidName. Фильтрует результаты по имени SSID.
t0 строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса T0. Начало периода, за который собираются данные.
t1 строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса T1. Конец периода, за который собираются данные. Значение T1 может отстоять от t0 не более чем на 186 дней.
timespan число с плавающей запятой	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса Timespan. Период, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение задается в секундах и не должно превышать 186 дней. По умолчанию — 1 день.
usageUplink строка	Информационный модуль для получения сведений о производителях устройств среди наиболее активных клиентов организации. Параметр запроса UsageUplink. Фильтрует результаты по использованию восходящего канала связи.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _summary _top _clients _manufacturers _byusage
  cisco.meraki.organizations_summary_top_clients_manufacturers_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 список / элементы=словарь	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"name\": \"string\",\n \"clients\": {\n \"counts\": {\n \"total\": 0\n }\n },\n \"usage\": {\n \"total\": 0,\n \"upstream\": 0,\n \"downstream\": 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_clients_manufacturers_by_usage_info_module.html