community.general.mattermost – Отправка уведомлений в Mattermost

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

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

Для использования в книге задач укажите: community.general.mattermost.

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка / обязательно		Ключ API Mattermost webhook. Войдите в свой сайт Mattermost, перейдите в Меню -> Интеграция -> Incoming Webhook -> Добавить Incoming Webhook. Это даст вам полную 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 логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под личным контролем, использующих самозаверяемые сертификаты.

Примеры

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

- name: Send notification message via Mattermost all options
  community.general.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 строка	success	Загрузка Mattermost
webhook_url строка	success	URL, на который отправляется webhook

Авторы

Benjamin Jolivot (@bjolivot)

© 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/community/general/mattermost_module.html