meraki_webhook – Управление веб-хуками, настроенными в облаке Meraki

Новое в версии 2.9.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

Настройка и получение информации о веб-хуках в облаке Meraki.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная среды `MERAKI_KEY` не задана.
host строка	По умолчанию: "api.meraki.com"	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	По умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
name строка		Имя веб-хука.
net_id строка		ID сети, к которой применяется конфигурация.
net_name строка		Имя сети, к которой применяется конфигурация. псевдонимы: сеть
org_id строка		ID организации.
org_name строка		Название организации. псевдонимы: организация
output_format строка	Варианты: snakecase ← camelcase	Указывает модулю, должны ли ключи ответа быть в формате snake case (например, `net_id`) или camel case (например, `netId`).
output_level строка	Варианты: debug normal ←	Устанавливает объем отладочной информации во время выполнения модуля.
rate_limit_retry_time целое число	По умолчанию: 165	Количество секунд для повторной попытки, если срабатывает лимит запросов.
shared_secret строка		Секретный пароль для доступа к веб-хуку.
state строка	Варианты: absent present query ←	Указывает, должен ли объект быть запрошен, создан/изменён или удалён.
test строка	Варианты: test status	Указывает, нужно ли проводить тест или запрос статуса.
test_id строка		ID запроса для тестирования веб-хука.
timeout целое число	По умолчанию: 30	Время ожидания HTTP-запросов.
url строка		URL для доступа при вызове веб-хука.
use_https логическое значение	Варианты: no yes ←	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki.
use_proxy логическое значение	Варианты: no yes	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
validate_certs логическое значение	Варианты: no yes ←	Проверка сертификатов HTTP.
webhook_id строка		Уникальный ID веб-хука.

Примечания

Примечание

Некоторые параметры, вероятно, используются только разработчиками Meraki.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9, модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте переменную среды ANSIBLE_MERAKI_FORMAT в значение camelcase.
Модули Meraki Ansible перестанут поддерживать вывод в формате camel case в Ansible 2.13. Пожалуйста, обновите свои playbook'ы.

Примеры

- name: Create webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
    url: https://webhook.url/
    shared_secret: shhhdonttellanyone
  delegate_to: localhost

- name: Query one webhook
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Query all webhooks
  meraki_webhook:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Delete webhook
  meraki_webhook:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    name: Test_Hook
  delegate_to: localhost

- name: Test webhook
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: test
    url: https://webhook.url/abc123
  delegate_to: localhost

- name: Get webhook status
  meraki_webhook:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    test: status
    test_id: abc123531234
  delegate_to: localhost

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

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

Ключ		Возвращается	Описание
data сложный тип		успех	Список администраторов.
	id строка	успех	Уникальный ID веб-хука. Пример: aHR0cHM6Ly93ZWJob22LnvpdGUvOGViNWI3NmYtYjE2Ny00Y2I4LTlmYzQtND32Mj3F5NzIaMjQ0
	name строка	успех	Описание веб-хука. Пример: Test_Hook
	networkId строка	успех	ID сети, содержащей веб-хук. Пример: N_12345
	shared_secret строка	успех	Пароль веб-хука. Пример: VALUE_SPECIFIED_IN_NO_LOG_PARAMETER
	status строка	успех, при тестировании веб-хука	Статус тестирования веб-хука. Пример: enqueued
	url строка	успех	URL конечной точки веб-хука. Пример: https://webhook.url/abc123

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Kevin Breit (@kbreit)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/meraki_webhook_module.html