slack – Отправка уведомлений в Slack
Новое в версии 1.6.
Обзор
- Модуль
slackотправляет уведомления на http://slack.com через интеграцию Incoming WebHook
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| attachments - | Определяет список вложений. Этот список соответствует JSON API Slack. Для получения дополнительной информации см. также (https://api.slack.com/docs/attachments). | |
| channel - | Канал для отправки сообщения. Если отсутствует, сообщение отправляется в канал, выбранный для параметра token. | |
| color - добавлено в 2.0 |
| Разрешает использовать цвета по умолчанию — используйте значение по умолчанию 'normal', чтобы не отправлять пользовательскую полосу цвета в начале сообщения |
| domain - | Домен Slack (поддомен) для вашей среды без протокола. (например, example.slack.com) В 1.8 и более поздних версиях данное поле устарело и может быть проигнорировано. Обратитесь к документации по параметру token для получения информации. | |
| icon_emoji - | Эмодзи отправителя сообщения. См. документацию Slack для вариантов. (если icon_emoji задан, то icon_url не будет использоваться) | |
| icon_url - | URL иконки отправителя сообщения (значение по умолчанию https://www.ansible.com/favicon.ico) | |
| link_names - |
| Автоматически создавать ссылки на каналы и имена пользователей в msg. |
| msg - | Сообщение для отправки. Обратите внимание, что модуль не обрабатывает экранирование символов. Символы угловых скобок и амперсандов в формате простого текста должны быть преобразованы в HTML-сущности (например, & в &) перед отправкой. Дополнительную информацию см. в документации Slack (https://api.slack.com/docs/message-formatting). | |
| parse - |
| Настройки парсера сообщений в Slack |
| token - / обязательно | Токен интеграции Slack. Он аутентифицирует вас на сервисе Slack. До версии 1.8, токен выглядел как 3Ffe373sfhRE6y42Fg3rvf4GlK. В версии 1.8 и выше Ansible адаптируется к новому API Slack, где токены выглядят как G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK. Если токен в новом формате, то Slack проигнорирует любое значение domain. Если токен в старом формате, то domain обязателен. Ansible не контролирует, когда Slack избавится от старого API. Когда Slack сделает это, старый формат перестанет работать. ** Пожалуйста, имейте в виду, что токены — это не API-токены, а токены webhook. В Slack они находятся в URL webhook, которые получаются в разделе приложения и интеграции. Входящие webhook можно добавить в этой области. В некоторых случаях это может быть заблокировано администратором Slack, и вам необходимо запросить доступ. Именно там можно добавить входящие webhook. Ключ находится в конце URL, предоставленного вам в этом разделе. | |
| username - | По умолчанию: "Ansible" | Это отправитель сообщения. |
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самоподписанными сертификатами. |
Примеры
- name: Send notification message via Slack
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} completed'
delegate_to: localhost
- name: Send notification message via Slack all options
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} completed'
channel: '#ansible'
username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png
link_names: 0
parse: 'none'
delegate_to: localhost
- name: insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in Slack
slack:
token: thetoken/generatedby/slack
msg: '{{ inventory_hostname }} is alive!'
color: good
username: ''
icon_url: ''
- name: Use the attachments API
slack:
token: thetoken/generatedby/slack
attachments:
- text: Display my system load on host A and B
color: '#ff00dd'
title: System load
fields:
- title: System A
value: "load average: 0,74, 0,66, 0,63"
short: True
- title: System B
value: 'load average: 5,16, 4,64, 2,43'
short: True
- name: Send a message with a link using Slack markup
slack:
token: thetoken/generatedby/slack
msg: We sent this message using <https://www.ansible.com|Ansible>!
- name: Send a message with angle brackets and ampersands
slack:
token: thetoken/generatedby/slack
msg: This message has <brackets> & ampersands in plain text.
Статус
- Данному модулю гарантированы отсутствие обратной несовместимости в будущих изменениях. [stableinterface]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Ramon de la Fuente (@ramondelafuente)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/slack_module.html