Модуль cisco.meraki.organizations_api_requests_overview_info – Модуль информации об обзоре запросов API организаций

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.meraki.organizations_api_requests_overview_info.

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

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

Обзор

Получить все организации _apirequests _overview.
Возвратить агрегированный обзор данных запросов API.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки Default: `60`
meraki_api_key string / required	meraki_api_key (string), ключ API, сгенерированный на панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить выходные данные журнала на консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении другой ошибки 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при другой ошибке 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `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 строка	Параметр пути OrganizationId. Идентификатор организации.
t0 строка	Параметр запроса T0. Начало временного интервала для данных. Максимальный период просмотров составляет 31 день с сегодняшнего дня.
t1 строка	Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 31 день после t0.
timespan вещественное число	Параметр запроса Timespan. Временной интервал, для которого будет извлечена информация. Если указывается timespan, не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 31 дню. По умолчанию — 31 день.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по организации getOrganizationApiRequestsOverview: Полное руководство по API getOrganizationApiRequestsOverview.

Примеры

- name: Get all organizations _apirequests _overview
  cisco.meraki.organizations_api_requests_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_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 словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: {"200": 0, "201": 0, "202": 0, "203": 0, "204": 0, "205": 0, "206": 0, "207": 0, "208": 0, "226": 0, "300": 0, "301": 0, "302": 0, "303": 0, "304": 0, "305": 0, "306": 0, "307": 0, "308": 0, "400": 0, "401": 0, "402": 0, "403": 0, "404": 0, "405": 0, "406": 0, "407": 0, "408": 0, "409": 0, "410": 0, "411": 0, "412": 0, "413": 0, "414": 0, "415": 0, "416": 0, "417": 0, "421": 0, "422": 0, "423": 0, "424": 0, "425": 0, "426": 0, "428": 0, "429": 0, "431": 0, "451": 0, "500": 0, "501": 0, "502": 0, "503": 0, "504": 0, "505": 0, "506": 0, "507": 0, "508": 0, "509": 0, "510": 0, "511": 0}

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"200": 0, "201": 0, "202": 0, "203": 0, "204": 0, "205": 0, "206": 0, "207": 0, "208": 0, "226": 0, "300": 0, "301": 0, "302": 0, "303": 0, "304": 0, "305": 0, "306": 0, "307": 0, "308": 0, "400": 0, "401": 0, "402": 0, "403": 0, "404": 0, "405": 0, "406": 0, "407": 0, "408": 0, "409": 0, "410": 0, "411": 0, "412": 0, "413": 0, "414": 0, "415": 0, "416": 0, "417": 0, "421": 0, "422": 0, "423": 0, "424": 0, "425": 0, "426": 0, "428": 0, "429": 0, "431": 0, "451": 0, "500": 0, "501": 0, "502": 0, "503": 0, "504": 0, "505": 0, "506": 0, "507": 0, "508": 0, "509": 0, "510": 0, "511": 0}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/organizations_api_requests_overview_info_module.html