rocketchat - Отправка уведомлений в Rocket Chat

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

Обзор
Параметры
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Модуль rocketchat отправляет уведомления в Rocket Chat через интеграцию Incoming WebHook.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attachments		Определяет список вложений.
channel		Канал для отправки сообщения. Если параметр отсутствует, сообщение будет отправлено в канал, выбранный для token, указанного при создании webhook.
color	Варианты: normal ← good warning danger	Разрешает использовать стандартные цвета текста. Используйте значение 'normal' по умолчанию, чтобы не отправлять специальную цветную панель в начале сообщения.
domain обязательно		Домен вашей среды без протокола. (например, `example.com` или `chat.example.com`)
icon_emoji		Эмоджи отправителя сообщения. Представления доступных эмодзи можно получить из Rocket Chat. (например: :thumbsup:) (если задан icon_emoji, icon_url не будет использоваться)
icon_url	По умолчанию: "https://www.ansible.com/favicon.ico"	URL иконки отправителя сообщения.
link_names	Варианты: 1 ← 0	Автоматически создает ссылки на каналы и имена пользователей в msg.
msg		Сообщение, которое нужно отправить.
protocol	Варианты: http https ←	Указывает используемый протокол для отправки уведомлений webhook до адреса URL. (например, http или https).
token обязательно		Токен интеграции Rocket Chat Incoming Webhook. Обеспечивает аутентификацию в Incoming webhook Rocket Chat для отправки сообщений.
username	По умолчанию: "Ansible"	Это отправитель сообщения.
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, использующих самоподписанные сертификаты.

Примеры

- name: Send notification message via Rocket Chat
  rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    msg: '{{ inventory_hostname }} completed'
  delegate_to: localhost

- name: Send notification message via Rocket Chat all options
  rocketchat:
    domain: chat.example.com
    token: thetoken/generatedby/rocketchat
    msg: '{{ inventory_hostname }} completed'
    channel: #ansible
    username: 'Ansible on {{ inventory_hostname }}'
    icon_url: http://www.example.com/some-image-file.png
    link_names: 0
  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 rocketchat
  rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    msg: '{{ inventory_hostname }} is alive!'
    color: good
    username: ''
    icon_url: ''
  delegate_to: localhost

- name: Use the attachments API
  rocketchat:
    token: thetoken/generatedby/rocketchat
    domain: chat.example.com
    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
  delegate_to: localhost

Возвращаемые значения

Общие значения, возвращаемые модулем, описаны здесь. Ниже приведены поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
changed boolean	success	Флаг, указывающий, были ли внесены какие-либо изменения.

Статус

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

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

Этот модуль помечен как 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/rocketchat_module.html