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

Описание
Параметры
Примеры
Возвращаемые значения
Статус

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
attachments -		Определяет список вложений.
channel -		Канал для отправки сообщения. Если отсутствует, сообщение отправляется в канал, выбранный для токена, указанного при создании вебхука.
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 ←	Укажите протокол, используемый для отправки сообщений уведомлений перед URL вебхука. (например, http или https)
token - / обязательно		Токен интеграции Rocket Chat Incoming Webhook. Он обеспечивает аутентификацию для отправки сообщений через вебхук Rocket Chat.
username -	Значение по умолчанию: "Ansible"	Отправитель сообщения.
validate_certs boolean	Варианты: 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	Флаг, указывающий, были ли внесены изменения.

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.9/modules/rocketchat_module.html