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

Примечание

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

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

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

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

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

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

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

Информационный модуль Organizations Apirequests Info.
Получение всех organizations _apirequests.
Список API-запросов, выполненных организацией.

Примечание

Для этого модуля имеется соответствующий модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
adminId string	Информационный модуль Organizations Apirequests Info. Параметр запроса AdminId. Фильтрация результатов по идентификатору администратора, выполнившего API-запросы.
direction string	direction (string), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль Organizations Apirequests Info. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
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), время ожидания перед повторной попыткой после ошибки 429 от Nginx По умолчанию: `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` ← (по умолчанию)
method string	Информационный модуль Organizations Apirequests Info. Параметр запроса Method. Фильтрация результатов по методу API-запроса (должен быть «GET», «PUT», «POST» или «DELETE»).
operationIds list / элементы=string	Информационный модуль Organizations Apirequests Info. Параметр запроса OperationIds. Фильтрация результатов по одному или нескольким идентификаторам операции для API-запроса.
organizationId string	Информационный модуль Organizations Apirequests Info. Параметр пути OrganizationId. Идентификатор организации.
path string	Информационный модуль Organizations Apirequests Info. Параметр запроса Path. Фильтрация результатов по пути API-запросов.
perPage integer	Информационный модуль Organizations Apirequests Info. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 50.
responseCode integer	Информационный модуль Organizations Apirequests Info. Параметр запроса ResponseCode. Фильтрация результатов по коду ответа API-запросов.
sourceIp string	Информационный модуль Organizations Apirequests Info. Параметр запроса SourceIp. Фильтрация результатов по IP-адресу, с которого был отправлен API-запрос.
startingAfter string	Информационный модуль Organizations Apirequests Info. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
t0 string	Информационный модуль Organizations Apirequests Info. Параметр запроса T0. Начало временного интервала для данных. Максимальный период ретроспективного просмотра — 31 день от текущей даты.
t1 string	Информационный модуль Organizations Apirequests Info. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может отстоять от t0 не более чем на 31 день.
timespan float	Информационный модуль Organizations Apirequests Info. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если задан параметр timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 31 день. Значение по умолчанию — 31 день.
total_pages string / обязательный	total_pages(int), используется вместе с perPage для получения общего количества результатов до total_pages*perPage; -1 — все страницы
userAgent string	Информационный модуль Organizations Apirequests Info. Параметр запроса UserAgent. Фильтрация результатов по строке user agent API-запроса.
version integer	Информационный модуль Organizations Apirequests Info. Параметр запроса Version. Фильтрация результатов по версии API, использованной в API-запросе.

Примечания

Примечание

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

См. также

Документация Cisco Meraki для organizations getOrganizationApiRequests: Полный справочник по API getOrganizationApiRequests.

Примеры

- name: Get all organizations _apirequests
  cisco.meraki.organizations_api_requests_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
    perPage: 0
    startingAfter: string
    endingBefore: string
    adminId: string
    path: string
    method: string
    responseCode: 0
    sourceIp: string
    userAgent: string
    version: 0
    operationIds: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"adminId\": \"string\",\n \"method\": \"string\",\n \"host\": \"string\",\n \"path\": \"string\",\n \"queryString\": \"string\",\n \"userAgent\": \"string\",\n \"ts\": \"string\",\n \"responseCode\": 0,\n \"sourceIp\": \"string\",\n \"version\": 0,\n \"operationId\": \"string\",\n \"client\": {\n \"id\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n {\n \"adminId\": \"string\",\n \"method\": \"string\",\n \"host\": \"string\",\n \"path\": \"string\",\n \"queryString\": \"string\",\n \"userAgent\": \"string\",\n \"ts\": \"string\",\n \"responseCode\": 0,\n \"sourceIp\": \"string\",\n \"version\": 0,\n \"operationId\": \"string\",\n \"client\": {\n \"id\": \"string\",\n \"type\": \"string\"\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_api_requests_info_module.html