community.general.matrix – Send notifications to matrix
Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.matrix.
Synopsis
- This module sends html formatted notifications to matrix rooms.
Requirements
The below requirements are needed on the host that executes this module.
- matrix-client (Python library)
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| hs_url
string / required
|
URL of the homeserver, where the CS-API is reachable
|
|
| msg_html
string / required
|
HTML form of the message to send to matrix
|
|
| msg_plain
string / required
|
Plain text form of the message to send to matrix, usually markdown
|
|
| password
string
|
The password to log in with
|
|
| room_id
string / required
|
ID of the room to send the notification to
|
|
| token
string
|
Authentication token for the API call. If provided, user_id and password are not required
|
|
| user_id
string
|
The user id of the user
|
Examples
- 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 }}"
Authors
- 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/latest/collections/community/general/matrix_module.html