mattermost – Отправка уведомлений в 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 boolean |
| Если 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 строка | успех | Payload Mattermost |
| webhook_url строка | успех | URL, на который отправляется вебхук |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.9/modules/mattermost_module.html
