Модуль cisco.meraki.meraki_webhook_payload_template — управление шаблонами полезной нагрузки вебхуков для сети в облаке Meraki

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install cisco.meraki.

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

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

УСТАРЕЛО

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

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

Позволяет запрашивать, удалять, создавать и обновлять шаблоны полезной нагрузки вебхуков.

Параметры

Параметр	Комментарии
auth_key string / обязательный	Ключ аутентификации, предоставленный панелью управления. Обязателен, если переменная среды `MERAKI_KEY` не задана.
body string	Шаблон Liquid, используемый для тела сообщения вебхука.
headers list / элементы=dictionary	Список шаблонов Liquid, используемых для заголовков вебхука. По умолчанию: `[]`
name string	Имя шаблона заголовка.
template string	Шаблон Liquid для заголовков
host string	Имя хоста панели управления Meraki. Можно использовать для доступа к региональным средам Meraki, например в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time integer	Количество секунд до повторной попытки, если сервер возвращает внутреннюю ошибку сервера. По умолчанию: `60`
name string	Имя шаблона.
net_id string	Идентификатор сети, содержащей точки доступа.
net_name 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"` ← (по умолчанию)
rate_limit_retry_time integer	Количество секунд до повторной попытки, если сработало ограничение частоты запросов. По умолчанию: `165`
state string	Указывает, следует ли запрашивать, создавать, изменять или удалять шаблон полезной нагрузки. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
timeout integer	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https boolean	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах. Варианты: `false` ← (по умолчанию) `true`
validate_certs boolean	Проверять ли сертификаты HTTP. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительные сведения об 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: Query all configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost
- name: Query specific configuration templates
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    name: Twitter
  delegate_to: localhost
- name: Create payload template
  meraki_webhook_payload_template:
    auth_key: abc12345
    org_name: YourOrg
    state: query
    name: TestTemplate
    body: Testbody
    headers:
      - name: testheader
        template: testheadertemplate
  delegate_to: localhost
- name: Delete a configuration template
  meraki_config_template:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    name: TestTemplate
  delegate_to: localhost

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

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

Ключ	Описание
data complex	Информация о запрошенном объекте. Возвращается: success
body string	Шаблон Liquid, используемый для тела сообщения вебхука. Возвращается: success Пример: `"{'client_payload': {'text': '{{ alertData }}'}, 'event_type': '{{ alertTypeId }}'}"`
headers list / элементы=string	Список шаблонов Liquid, используемых для заголовков вебхука. Возвращается: success
name string	Имя шаблона Возвращается: success Пример: `"testTemplate"`
template string	Шаблон Liquid для заголовка Возвращается: success Пример: `"Bearer {{ sharedSecret }}"`
name string	Имя шаблона Возвращается: success Пример: `"testTemplate"`

Статус

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

Авторы

Joshua Coronado (@joshuajcoronado)

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

© 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_payload_template_module.html