Модуль cisco.meraki.meraki_webhook — управление вебхуками, настроенными в облаке Meraki

Примечание

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

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

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

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

УСТАРЕЛО
Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

УСТАРЕЛО

Удалено в:: версии 3.0.0
Причина:: Выпущены обновлённые модули с расширенной функциональностью
Альтернатива:: cisco.meraki.networks_webhooks_http_servers

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

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

Параметры

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

Примечания

Примечание

Некоторые параметры, вероятно, используются только разработчиками Meraki.
Дополнительную информацию об API Meraki можно найти по адресу https://dashboard.meraki.com/api_docs.
Некоторые параметры, вероятно, используются только разработчиками Meraki.
Начиная с Ansible 2.9 модули Meraki выводят ключи в формате snake case. Чтобы использовать camel case, задайте для переменной среды ANSIBLE_MERAKI_FORMAT значение camelcase.
В Ansible 2.13 поддержка вывода в формате camel case в модулях Meraki будет прекращена. Обновите плейбуки.
Режим проверки загружает текущую конфигурацию с панели управления, а затем сравнивает с ней изменения. Режим проверки сообщит об изменениях, если конфигурации различаются, но не отправит изменения в 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
    payload_template_name: Slack (included)
  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 complex	Список администраторов. Возвращается: при успешном выполнении
id string	Уникальный идентификатор вебхука. Возвращается: при успешном выполнении Пример: `"aHR0cHM6Ly93ZWJob22LnvpdGUvOGViNWI3NmYtYjE2Ny00Y2I4LTlmYzQtND32Mj3F5NzIaMjQ0"`
name string	Понятное имя вебхука. Возвращается: при успешном выполнении Пример: `"Test_Hook"`
networkId string	Идентификатор сети, содержащей объект вебхука. Возвращается: при успешном выполнении Пример: `"N_12345"`
payloadTemplate string	Шаблон полезной нагрузки, используемый при отправке данных на HTTP-сервер. Возвращается: при успешном выполнении Пример: `"{'name': 'Meraki (included)', 'payloadTemplateId': 'wpt_00001'}"`
shared_secret string	Пароль вебхука. Возвращается: при успешном выполнении Пример: `"VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"`
status string	Статус проверки вебхука. Возвращается: при успешном выполнении, если выполняется проверка вебхука Пример: `"enqueued"`
url string	URL конечной точки вебхука. Возвращается: при успешном выполнении Пример: `"https://webhook.url/abc123"`

Статус

Этот модуль будет удалён в версии 3.0.0. [устарел]
Подробнее см. раздел УСТАРЕЛО.

Авторы

Kevin Breit (@kbreit)

Ссылки на коллекцию

© 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/meraki_webhook_module.html