community.general.mattermost – Send Mattermost notifications¶
Note
This plugin is part of the community.general collection (version 2.5.1).
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¶
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
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
payload
string
|
success |
Mattermost payload
|
webhook_url
string
|
success |
URL the webhook is sent to
|
Authors¶
Benjamin Jolivot (@bjolivot)