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

Примечание

Этот плагин входит в коллекцию cisco.meraki (версия 2.1.3).

Для его установки используйте: ansible-galaxy collection install cisco.meraki.

Для использования в книге задач укажите: cisco.meraki.meraki_webhook.

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
auth_key строка / обязательно		Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
host строка	Значение по умолчанию: "api.meraki.com"	Имя хоста для панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, таким как Китай.
internal_error_retry_time целое число	Значение по умолчанию: 60	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней серверной ошибки.
name строка		Имя веб-хука.
net_id строка		ID сети, к которой применяется конфигурация.
net_name строка		Имя сети, к которой применяется конфигурация. псевдонимы: network
org_id строка		ID организации.
org_name строка		Имя организации. псевдонимы: organization
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	Указывает, следует ли выполнить тестирование или запросить статус.
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. Обновите свои книги задач.
Режим проверки загружает текущую конфигурацию с панели управления, затем сравнивает изменения с этой загрузкой. Режим проверки сообщит о различиях в конфигурациях, но не отправит изменения в API для проверки изменений.

Примеры

- 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

Авторы

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.10/collections/cisco/meraki/meraki_webhook_module.html