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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

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

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

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

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

Требования

Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.

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

Параметры

Параметр	Комментарии
hs_url строка / обязательный	URL домашнего сервера, по которому доступен CS-API.
msg_html строка / обязательный	Сообщение в формате HTML для отправки в Matrix.
msg_plain строка / обязательный	Сообщение в виде обычного текста для отправки в Matrix, обычно в формате Markdown.
password строка	Пароль для входа.
room_id строка / обязательный	Идентификатор комнаты, в которую нужно отправить уведомление.
token строка	Токен аутентификации для вызова API. Если он указан, `user_id` и `password` не требуются.
user_id строка	Идентификатор пользователя.

Атрибуты

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

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/matrix_module.html