Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_api_requests_info – Модуль информации об организациях _apirequests

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Описание

  • Получить все запросы организации _apirequests.
  • Список API-запросов, сделанных организацией.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

adminId

string

Параметр запроса AdminId. Фильтруйте результаты по ID администратора, который сделал запросы API.

direction

string

direction (строка), направление для постраничной навигации, либо «next» (по умолчанию), либо «prev» страница

Default: "https://api.meraki.com/api/v1"

endingBefore

string

Параметр запроса EndingBefore. Маркер, используемый сервером для обозначения конца страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

headers

dictionary

Дополнительные заголовки.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке параллелизма пакетных действий

Default: 60

meraki_api_key

string / required

meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), предшествует всем ресурсам конечной точки

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), наследует ваш собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и метки времени

Default: "meraki_api_"

meraki_log_path

string

log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторите попытку до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить сообщения журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

Повторить попытку при возникновении ошибки 4XX (кроме 429)?

Варианты:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

Время ожидания повтора попытки при ошибке 4XX

По умолчанию: 60

meraki_simulate

boolean

Имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Варианты:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

Максимальное количество секунд для каждого вызова API

По умолчанию: 60

meraki_suppress_logging

boolean

Отключить ведение журнала? Тогда вы сами за себя отвечаете!

Варианты:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

Методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Варианты:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

Повторить попытку при возникновении ошибки ограничения скорости 429?

Варианты:

  • false
  • true ← (default)

method

string

Параметр запроса Method. Фильтрует результаты по методу запросов API (должен быть «GET», «PUT», «POST» или «DELETE»).

operationIds

list / elements=string

Параметр запроса OperationIds. Фильтрует результаты по одному или нескольким идентификаторам операций для запроса API.

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

path

string

Параметр запроса Path. Фильтрует результаты по пути запросов API.

perPage

integer

Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон — 3–1000. По умолчанию — 50.

responseCode

integer

Параметр запроса ResponseCode. Фильтрует результаты по коду ответа запросов API.

sourceIp

string

Параметр запроса SourceIp. Фильтрует результаты по IP-адресу исходного запроса API.

startingAfter

string

Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен задаваться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

t0

string

Параметр запроса T0. Начало временного интервала для данных. Максимальный период обратного просмотра составляет 31 день от сегодняшнего дня.

t1

string

Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 31 день позже t0.

timespan

float

Параметр запроса Timespan. Временной интервал, для которого будет извлекаться информация. При указании timespan не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 31 дню. По умолчанию — 31 день.

total_pages

string / required

total_pages(int), использовать с perPage для получения всех результатов до total_pages*perPage; -1 для всех страниц

userAgent

string

Параметр запроса UserAgent. Фильтрует результаты по строке user agent запроса API.

version

integer

Параметр запроса версии. Фильтрует результаты по версии API запроса.

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki для организаций 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_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

список / элементы=словарь

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

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

Пример: "[\n  {\n    \"adminId\": \"string\",\n    \"host\": \"string\",\n    \"method\": \"string\",\n    \"operationId\": \"string\",\n    \"path\": \"string\",\n    \"queryString\": \"string\",\n    \"responseCode\": 0,\n    \"sourceIp\": \"string\",\n    \"ts\": \"string\",\n    \"userAgent\": \"string\",\n    \"version\": 0\n  }\n]\n"

Авторы

  • 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_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API