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.rocketchat.
rocketchat module sends notifications to Rocket Chat via the Incoming WebHook integration| Parameter | Choices/Defaults | Comments |
|---|---|---|
| attachments list / elements=dictionary | Define a list of attachments. | |
| channel string | Channel to send the message to. If absent, the message goes to the channel selected for the token specified during the creation of webhook. | |
| color string |
| Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message |
| domain string / required | The domain for your environment without protocol. (i.e. example.com or chat.example.com) | |
| icon_emoji string | Emoji for the message sender. The representation for the available emojis can be got from Rocket Chat. (for example :thumbsup:) (if icon_emoji is set, icon_url will not be used) | |
| icon_url string | Default: "https://www.ansible.com/favicon.ico" | URL for the message sender's icon. |
| link_names integer |
1 | Automatically create links for channels and usernames in msg. |
| msg string | Message to be sent. | |
| protocol string |
| Specify the protocol used to send notification messages before the webhook url. (i.e. http or https) |
| token string / required | Rocket Chat Incoming Webhook integration token. This provides authentication to Rocket Chat's Incoming webhook for posting messages. | |
| username string | Default: "Ansible" | This is the sender of the message. |
| validate_certs boolean |
| If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
- name: Send notification message via Rocket Chat
community.general.rocketchat:
token: thetoken/generatedby/rocketchat
domain: chat.example.com
msg: '{{ inventory_hostname }} completed'
delegate_to: localhost
- name: Send notification message via Rocket Chat all options
community.general.rocketchat:
domain: chat.example.com
token: thetoken/generatedby/rocketchat
msg: '{{ inventory_hostname }} completed'
channel: #ansible
username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png
link_names: 0
delegate_to: localhost
- name: Insert a color bar in front of the message for visibility purposes and use the default webhook icon and name configured in rocketchat
community.general.rocketchat:
token: thetoken/generatedby/rocketchat
domain: chat.example.com
msg: '{{ inventory_hostname }} is alive!'
color: good
username: ''
icon_url: ''
delegate_to: localhost
- name: Use the attachments API
community.general.rocketchat:
token: thetoken/generatedby/rocketchat
domain: chat.example.com
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
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed boolean | success | A flag indicating if any change was made or not. |
© 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/rocketchat_module.html