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

Примечание

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

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

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

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

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

Описание

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

Требования

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

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

Параметры

Параметр	Комментарии
hs_url строка / обязательно	URL сервера Matrix, где доступен 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/matrix_module.html