community.general.mattermost module – Send Mattermost notifications
Note
This module is part of the community.general collection (version 9.4.0).
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.mattermost
.
Synopsis
Sends notifications to http://your.mattermost.url via the Incoming WebHook integration.
Parameters
Parameter |
Comments |
---|---|
Mattermost webhook api key. Log into your mattermost site, go to Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook. This will give you full URL. |
|
Define a list of attachments. For more information, see https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/. Required when |
|
Channel to send the message to. If absent, the message goes to the channel selected for the |
|
URL for the message sender’s icon. Default: |
|
Text to send. Note that the module does not handle escaping characters. Required when |
|
Mattermost url (i.e. http://mattermost.yourcompany.com). |
|
This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc. Default: |
|
If Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Send notification message via Mattermost
community.general.mattermost:
url: http://mattermost.example.com
api_key: my_api_key
text: '{{ inventory_hostname }} completed'
- name: Send notification message via Mattermost all options
community.general.mattermost:
url: http://mattermost.example.com
api_key: my_api_key
text: '{{ inventory_hostname }} completed'
channel: notifications
username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png
- name: Send attachments message via Mattermost
community.general.mattermost:
url: http://mattermost.example.com
api_key: my_api_key
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Mattermost payload Returned: success |
|
URL the webhook is sent to Returned: success |