Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_webhooks_logs_info — Модуль информации об организациях _webhooks _logs

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.organizations_webhooks_logs_info.

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

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

Описание

  • Получить все журналы организаций _webhooks _logs.
  • Возвращает журнал POST-запросов webhook.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

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

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

endingBefore

string

Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке 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 (целое число), время ожидания повтора попытки при ошибке 429 от Nginx

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

meraki_retry_4xx_error (логическое значение), повторить попытку при возникновении других ошибок 4XX (кроме 429)?

Choices:

  • false ← (default)
  • 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 ← (по умолчанию)

organizationId

string

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

perPage

integer

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

startingAfter

string

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

t0

string

Параметр запроса T0. Начало временного интервала для данных. Максимальный период поиска — 90 дней с текущей даты.

t1

string

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

timespan

float

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

total_pages

string / обязательно

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

url

string

Параметр запроса Url. URL, к которому был отправлен веб-хук.

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki по organizations getOrganizationWebhooksLogs

Полное описание API getOrganizationWebhooksLogs.

Примеры

- name: Get all organizations _webhooks _logs
  cisco.meraki.organizations_webhooks_logs_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
    url: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Значения возврата

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

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n  {\n    \"alertType\": \"string\",\n    \"loggedAt\": \"string\",\n    \"networkId\": \"string\",\n    \"organizationId\": \"string\",\n    \"responseCode\": 0,\n    \"responseDuration\": 0,\n    \"sentAt\": \"string\",\n    \"url\": \"string\"\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_webhooks_logs_info_module.html

Spec-Zone.ru

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