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

Примечание

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

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

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

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

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

УСТЕРЕНО

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

Обзор

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

Параметры

Параметр	Комментарии
auth_key строка / обязательно	Ключ аутентификации, предоставленный панелью управления. Требуется, если переменная окружения `MERAKI_KEY` не задана.
body строка	Шаблон Liquid, используемый для тела сообщения веб-хука.
headers список / элементы=словарь	Список шаблонов Liquid, используемых для заголовков веб-хука. По умолчанию: `[]`
name строка	Имя шаблона заголовка.
template строка	Шаблон Liquid для заголовков
host строка	Имя хоста панели управления Meraki. Может использоваться для доступа к региональным средам Meraki, например, в Китае. По умолчанию: `"api.meraki.com"`
internal_error_retry_time целое число	Количество секунд для повторной попытки, если сервер возвращает ошибку внутренней системы. По умолчанию: `60`
name строка	Имя шаблона.
net_id строка	ID сети, содержащей точки доступа.
net_name строка	Имя сети, содержащей точки доступа.
org_id строка	ID организации.
org_name псевдонимы: organization строка	Название организации.
output_format строка	Указывает модулю, должны ли ключи ответа быть в нижнем регистре со знаками подчёркивания (например, `net_id`) или с заглавными буквами (например, `netId`). Варианты: `"snakecase"` ← (по умолчанию) `"camelcase"`
output_level строка	Установите количество отладочных сообщений во время выполнения модуля. Варианты: `"debug"` `"normal"` ← (по умолчанию)
rate_limit_retry_time целое число	Количество секунд для повторной попытки, если срабатывает ограничение скорости. По умолчанию: `165`
state строка	Определяет, нужно ли запросить, создать, изменить или удалить шаблон загрузки полезной нагрузки. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
timeout целое число	Время ожидания для HTTP-запросов. По умолчанию: `30`
use_https логическое	Если `no`, будет использоваться HTTP. В противном случае будет использоваться HTTPS. Полезно только для внутренних разработчиков Meraki. Варианты: `false` `true` ← (по умолчанию)
use_proxy логическое	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Варианты: `false` ← (по умолчанию) `true`
validate_certs логическое	Требовать валидацию HTTP-сертификатов. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Дополнительную информацию о Meraki API можно найти по адресу 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 сложный	Информация о запрошенном объекте. Возвращается: успешно
body строка	Шаблон Liquid, используемый для тела сообщения веб-хука. Возвращается: успешно Пример: `"{'client_payload': {'text': '{{alertData}}'}, 'event_type': '{{alertTypeId}}'}"`
headers список / элементы=строка	Список шаблонов Liquid, используемых с заголовками веб-хука. Возвращается: успешно
name строка	Название шаблона Возвращается: успешно Пример: `"testTemplate"`
template строка	Шаблон Liquid для заголовка Возвращается: успешно Пример: `"Bearer {{sharedSecret}}"`
name строка	Название шаблона Возвращается: успешно Пример: `"testTemplate"`

Статус

Этот модуль будет удален в версии 3.0.0. [устаревший]
Дополнительная информация см. в разделе УСТАРЕВШИЙ.

Авторы

Joshua Coronado (@joshuajcoronado)

Ссылки на сборку

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