slack - Отправка уведомлений в Slack

Новая версия с 1.6.

Обзор
Параметры
Примеры
- Статус

Обзор

Модуль slack отправляет уведомления на http://slack.com через интеграцию Incoming WebHook.

Параметры

параметр	обязательный	по умолчанию	значения	комментарии
attachments	нет	None		Определяет список вложений. Этот список соответствует JSON API Slack. Дополнительная информация: https://api.slack.com/docs/attachments
channel	нет	None		Канал для отправки сообщения. При отсутствии сообщения отправляется в канал, выбранный для параметра token.
color (добавлен в 2.0)	нет	normal	normal good warning danger	Разрешает использование стандартных цветов текста. Используйте значение 'normal', чтобы не отправлять пользовательскую цветную полосу в начале сообщения.
domain	нет	None		Домен Slack (поддомен) для вашей среды без протокола. (например, `example.slack.com`) В версиях 1.8 и выше этот параметр устарел и может быть проигнорирован. Для получения информации обратитесь к документации по параметру token.
icon_emoji	нет	None		Эмоджи отправителя сообщения. См. документацию Slack для вариантов. (если задан icon_emoji, то icon_url не будет использоваться).
icon_url	нет			URL иконки отправителя сообщения (по умолчанию `https://www.ansible.com/favicon.ico`)
link_names	нет	1	1 0	Автоматически создает ссылки для каналов и имён пользователей в msg.
msg	нет	None		Сообщение для отправки. Обратите внимание, что модуль не обрабатывает экранирование символов. Символы угловых скобок и амперсандов в формате обычного текста должны быть преобразованы в HTML-сущности (например, & в &) перед отправкой. Дополнительная информация: https://api.slack.com/docs/message-formatting
parse	нет	None	full none	Настройка парсера сообщений в Slack.
token	да			Токен интеграции Slack. Авторизует вас на сервисе Slack. До версии 1.8, токен выглядел так: `3Ffe373sfhRE6y42Fg3rvf4GlK`. В версиях 1.8 и выше Ansible адаптирован к новому API Slack, где токены выглядят так: `G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK`. Если токены в новом формате, то Slack проигнорирует любое значение параметра domain. Если токен в старом формате, то domain необходим. Ansible не контролирует, когда Slack откажется от старого API. Когда Slack это сделает, старый формат перестанет работать. ** Имейте в виду, что токены — это не токены API, а токены веб-хуков. В Slack они находятся в URL веб-хука, которые можно получить в разделе приложения и интеграции. Входящие веб-хуки можно добавить в этой области. В некоторых случаях это может быть заблокировано администратором Slack, и вам нужно запросить доступ. Именно там можно добавить входящие веб-хуки. Ключ находится в конце URL, предоставленного вам в этом разделе.
username	нет	Ansible		Отправитель сообщения.
validate_certs	нет	да	да нет	Если `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 &lt;brackets&gt; &amp; ampersands in plain text.

Статус

Этот модуль помечен как stableinterface, что означает, что разработчики данного модуля гарантируют, что не будут внесены несовместимые изменения в интерфейс.

Для получения помощи в разработке модулей, если вы этого захотите, прочитайте Информацию о сообществе и сотрудничестве, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/slack_module.html