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

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Для использования в книге задач укажите: community.general.rocketchat.

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

Описание

Модуль 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 По умолчанию: 1	Автоматически создает ссылки на каналы и имена пользователей в msg.
msg строка		Сообщение, которое нужно отправить.
protocol строка	Варианты: http https ←	Укажите используемый протокол для отправки сообщений уведомлений перед URL webhook. (например, http или https).
token строка / обязательно		Токен интеграции Rocket Chat Incoming Webhook. Он обеспечивает аутентификацию в Rocket Chat Incoming webhook для публикации сообщений.
username строка	По умолчанию: "Ansible"	Это отправитель сообщения.
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах под вашим контролем, использующих самозаверяющие сертификаты.

Примеры

- name: Send notification message via Rocket Chat
  community.general.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
  community.general.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
  community.general.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
  community.general.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 булево	успех	Флаг, указывающий, были ли внесены какие-либо изменения.

Авторы

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.10/collections/community/general/rocketchat_module.html