Модуль cisco.meraki.organizations_clients_overview_info — информационный модуль для organizations _clients _overview

Примечание

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

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

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

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

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

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

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

Информационный модуль для Organizations Clients Overview Info.
Получает все organizations _clients _overview.
Возвращает сводную информацию об использовании данных клиентами в кб в указанной организации.

Примечание

Этому модулю соответствует плагин действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
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 (строка), префикс для всех ресурсов конечных точек По умолчанию: `"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` ← (по умолчанию)
organizationId строка	Информационный модуль для Organizations Clients Overview Info. Параметр пути organizationId. Идентификатор организации.
t0 строка	Информационный модуль для Organizations Clients Overview Info. Параметр запроса T0. Начало временного интервала, за который получаются данные.
t1 строка	Информационный модуль для Organizations Clients Overview Info. Параметр запроса T1. Конец временного интервала, за который получаются данные. Значение T1 может быть не более чем на 31 день позже t0.
timespan число с плавающей запятой	Информационный модуль для Organizations Clients Overview Info. Параметр запроса Timespan. Временной интервал, за который будет получена информация. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 31 день. Значение по умолчанию — 1 день.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _clients _overview
  cisco.meraki.organizations_clients_overview_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 }}"
    t0: string
    t1: string
    timespan: 0
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"counts": {"total": 0}, "usage": {"average": 0, "overall": {"downstream": 0, "total": 0, "upstream": 0}}}`

Авторы

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_clients_overview_info_module.html