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

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

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

Описание

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

Параметры

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

Статус

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

Для получения помощи в разработке модулей, если это вас интересует, ознакомьтесь с Информация о сообществе и участие в разработке, Тестирование 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/rocketchat_module.html