Spec-Zone.ru › Ansible 2.6

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 ←
  • good
  • warning
  • danger
Разрешает использовать цвета по умолчанию. Использование значения '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
    Варианты:
  • 1 ←
  • 0
Автоматически создавать ссылки на каналы и имена пользователей в msg.
msg
Сообщение для отправки. Обратите внимание, что модуль не обрабатывает экранирование символов. Символы угловых скобок и амперсандов в формате обычного текста следует преобразовать в HTML-сущности (например, & в &) перед отправкой. Дополнительную информацию см. в документации Slack (https://api.slack.com/docs/message-formatting).
parse
    Варианты:
  • full
  • none
Настройки парсера сообщений в Slack
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, которые получаются в приложениях и интеграциях. Входящие вебхуки можно добавить в этой области. В некоторых случаях это может быть заблокировано администратором Slack, и вам необходимо запросить доступ. Именно там можно добавить входящие вебхуки. Ключ находится в конце URL, предоставленного вам в этой секции.
username Значение по умолчанию:
"Ansible"
Это отправитель сообщения.
validate_certs
bool
    Варианты:
  • 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'
    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, что означает, что сотрудники, отвечающие за этот модуль, гарантируют, что не будут вноситься несовместимые изменения интерфейса.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.

Автор

  • 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.6/modules/slack_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API