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 bool |
| Если 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. Подробнее см. Поддержка и техническое обслуживание модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/mattermost_module.html
