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

Примечание

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

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

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

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

Обзор

Отправляет уведомления на 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 логическое	Варианты: 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	Payload Mattermost
webhook_url строка	success	URL, на который отправляется вебхук

Авторы

Benjamin Jolivot (@bjolivot)

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