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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.rocketchat.

Краткое описание
Параметры
Атрибуты
Примеры

Краткое описание

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

Параметры

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

Атрибуты

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

Примеры

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

- name: Send notification message through 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

Авторы

Ramon de la Fuente (@ramondelafuente)

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

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