Spec-Zone.ru › Ansible 2.4

mattermost - Отправка уведомлений в Mattermost

Новая версия 2.3.

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

Описание

  • Отправляет уведомления на http://your.mattermost.url через интеграцию Incoming WebHook.

Параметры

параметр обязательный по умолчанию значения комментарии
api_key
да
Ключ API вебхука Mattermost. Войдите в свой сайт Mattermost, перейдите в Меню -> Интеграции -> Входящий вебхук -> Добавить входящий вебхук. Это даст вам полный URL. api_key - это последняя часть. http://mattermost.example.com/hooks/API_KEY
channel
нет
Канал для отправки сообщения. При отсутствии сообщение отправляется в канал, выбранный для api_key.
icon_url
нет https://www.ansible.com/favicon.ico
URL для значка отправителя сообщения.
text
да
Текст для отправки. Обратите внимание, что модуль не обрабатывает экранирование символов.
url
да
URL Mattermost (например, http://mattermost.yourcompany.com).
username
нет Ansible
Отправитель сообщения (необходимо включить параметр «Имя пользователя» для отправки сообщения в Mattermost, см. документацию Mattermost.)
validate_certs
нет True
  • да
  • нет
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяемые сертификаты.

Примеры

- name: Send notification message via Mattermost
  mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'

- name: Send notification message via Mattermost all options
  mattermost:
    url: http://mattermost.example.com
    api_key: my_api_key
    text: '{{ inventory_hostname }} completed'
    channel: notifications
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png

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

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

имя описание возвращается тип пример
payload
Загрузка Mattermost
успех строка
webhook_url
URL, на который отправляется вебхук
успех строка

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API