ansible / ansible.builtin / v2.7.18 / module / slack Send Slack notifications | "added in version" 1.6 of ansible.builtin" Authors: Ramon de la Fuente (@ramondelafuente) stableinterface | supported by communityansible.builtin.slack (v2.7.18) — module
pip
Install with pip install ansible==2.7.18
The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration
- name: Send notification message via Slack slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} completed' delegate_to: localhost
- name: Send notification message via Slack all options slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} completed' channel: '#ansible' username: 'Ansible on {{ inventory_hostname }}' icon_url: http://www.example.com/some-image-file.png link_names: 0 parse: 'none' 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 Slack slack: token: thetoken/generatedby/slack msg: '{{ inventory_hostname }} is alive!' color: good username: '' icon_url: ''
- name: Use the attachments API slack: token: thetoken/generatedby/slack 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
- name: Send a message with a link using Slack markup slack: token: thetoken/generatedby/slack msg: We sent this message using <https://www.ansible.com|Ansible>!
- name: Send a message with angle brackets and ampersands slack: token: thetoken/generatedby/slack msg: This message has &lt;brackets&gt; &amp; ampersands in plain text.
msg: description: - Message to send. Note that the module does not handle escaping characters. Plain-text angle brackets and ampersands should be converted to HTML entities (e.g. & to &amp;) before sending. See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more. color: choices: - normal - good - warning - danger default: normal description: - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message version_added: '2.0' version_added_collection: ansible.builtin parse: choices: - full - none description: - Setting for the message parser at Slack token: description: - Slack integration token. This authenticates you to the slack service. Prior to 1.8, a token looked like C(3Ffe373sfhRE6y42Fg3rvf4GlK). In 1.8 and above, ansible adapts to the new slack API where tokens look like C(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack does that the old format will stop working. ** Please keep in mind the tokens are not the API tokens but are the webhook tokens. In slack these are found in the webhook URL which are obtained under the apps and integrations. The incoming webhooks can be added in that area. In some cases this may be locked by your Slack admin and you must request access. It is there that the incoming webhooks can be added. The key is on the end of the URL given to you in that section. required: true domain: description: - Slack (sub)domain for your environment without protocol. (i.e. C(example.slack.com)) In 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information. channel: description: - Channel to send the message to. If absent, the message goes to the channel selected for the I(token). icon_url: description: - Url for the message sender's icon (default C(https://www.ansible.com/favicon.ico)) username: default: Ansible description: - This is the sender of the message. icon_emoji: description: - Emoji for the message sender. See Slack documentation for options. (if I(icon_emoji) is set, I(icon_url) will not be used) link_names: choices: - 1 - 0 default: 1 description: - Automatically create links for channels and usernames in I(msg). attachments: description: - Define a list of attachments. This list mirrors the Slack JSON API. - For more information, see also in the (U(https://api.slack.com/docs/attachments)). validate_certs: default: 'yes' description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool