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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attachments -		Определяет список вложений. Этот список соответствует JSON API Slack. Для получения дополнительной информации, см. также (https://api.slack.com/docs/attachments).
channel -		Канал для отправки сообщения. Если параметр отсутствует, сообщение отправляется в канал, выбранный для параметра token.
color - добавлен в 2.0	По умолчанию: "normal"	Разрешает использовать цвета по умолчанию - используйте значение 'normal', чтобы не отправлять пользовательскую цветную полосу в начале сообщения. Допустимые значения для цвета включают 'normal', 'good', 'warning', 'danger', любой допустимый 3-х или 6-х значный шестнадцатеричный цвет. Указание значения в шестнадцатеричном формате поддерживается с версии 2.8.
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 -	Варианты: 1 ← 0	Автоматически создаёт ссылки для каналов и имён пользователей в msg.
msg -		Сообщение для отправки. Обратите внимание, что модуль не обрабатывает экранирование символов. Простые угловые скобки и амперсанды должны быть преобразованы в HTML-сущности (например, & в &) перед отправкой. Для получения дополнительной информации см. документацию Slack (https://api.slack.com/docs/message-formatting).
parse -	Варианты: full none	Параметр для парсера сообщений в Slack.
thread_id - добавлен в 2.8		Необязательно. Отметка времени сообщения для привязки к нему текущего сообщения в формате float. https://api.slack.com/docs/message-threading
token - / обязательно		Токен интеграции Slack. Он аутентифицирует вас на службе Slack. До версии 1.8 токен выглядел как `3Ffe373sfhRE6y42Fg3rvf4GlK`. В версиях 1.8 и выше Ansible адаптируется к новому API Slack, где токены выглядят как `G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK`. Если токен имеет новый формат, Slack проигнорирует любое значение параметра domain. Если токен имеет старый формат, параметр domain требуется. Ansible не контролирует, когда Slack откажется от старого API. Когда это произойдёт, старый формат перестанет работать. ** Имейте в виду, что токены - это не API-токены, а токены webhook. В Slack они находятся в URL webhook, который можно получить в разделе приложения и интеграций. Входящие webhook могут быть добавлены в этом разделе. В некоторых случаях это может быть заблокировано вашим администратором Slack, и вам нужно запросить доступ. Именно там можно добавить входящие webhook. Ключ находится в конце URL, предоставленного вам в этом разделе.
username -	По умолчанию: "Ansible"	Это отправитель сообщения.
validate_certs boolean	Варианты: no yes ←	Если `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'
    thread_id: 1539917263.000100
    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: insert a color bar in front of the message with valid hex color value
  slack:
    token: thetoken/generatedby/slack
    msg: 'This message uses color in hex value'
    color: '#00aacc'
    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. [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.8/modules/slack_module.html