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

Примечание

Этот плагин является частью коллекции community.general (версия 2.0.1).

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

Для использования в плейбуке укажите: community.general.matrix.

Обзор
Требования
Параметры
Примеры

Обзор

Этот модуль отправляет уведомления в формате HTML в комнаты Matrix.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

matrix-client (библиотека Python)

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
hs_url строка / обязательно		URL сервера Homeserver, где доступен CS-API
msg_html строка / обязательно		HTML-формат сообщения, которое необходимо отправить в Matrix
msg_plain строка / обязательно		Формат сообщения в обычном тексте (обычно Markdown), которое необходимо отправить в Matrix
password строка		Пароль для входа
room_id строка / обязательно		ID комнаты, в которую необходимо отправить уведомление
token строка		Токен аутентификации для вызова API. При указании, user_id и password не требуются
user_id строка		Идентификатор пользователя

Примеры

- name: Send matrix notification with token
  community.general.matrix:
    msg_plain: "**hello world**"
    msg_html: "<b>hello world</b>"
    room_id: "!12345678:server.tld"
    hs_url: "https://matrix.org"
    token: "{{ matrix_auth_token }}"

- name: Send matrix notification with user_id and password
  community.general.matrix:
    msg_plain: "**hello world**"
    msg_html: "<b>hello world</b>"
    room_id: "!12345678:server.tld"
    hs_url: "https://matrix.org"
    user_id: "ansible_notification_bot"
    password: "{{ matrix_auth_password }}"

Авторы

Jan Christian Grünhage (@jcgruenhage)

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