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

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в книге задач, укажите: community.general.rocketchat.

Обзор
Параметры
Атрибуты
Примеры
Возвращаемые значения

Обзор

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме проверки и возвращать прогноз статуса изменений без модификации целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения вернет подробности о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примеры

- 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 boolean	Флаг, указывающий, были ли внесены какие-либо изменения. Возвращаемое значение: success Пример: `false`

Авторы

Рамон де ла Фуэнте (@ramondelafuente)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/rocketchat_module.html