community.general.slack – Sends play events to a Slack channel

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.slack.

Synopsis

  • This is an ansible callback plugin that sends status updates to a Slack channel during playbook execution.
  • Before 2.4 only environment variables were available for configuring this plugin

Requirements

The below requirements are needed on the local controller node that executes this callback.

  • whitelist in configuration
  • prettytable (python library)

Parameters

Parameter Choices/Defaults Configuration Comments
channel
string
Default:
"#ansible"
ini entries:

[callback_slack]
channel = #ansible

env:SLACK_CHANNEL
Slack room to post in.
username
string
Default:
"ansible"
ini entries:

[callback_slack]
username = ansible

env:SLACK_USERNAME
Username to post as.
validate_certs
boolean
    Choices:
  • no
  • yes ←
ini entries:

[callback_slack]
validate_certs = yes

env:SLACK_VALIDATE_CERTS
validate the SSL certificate of the Slack server. (For HTTPS URLs)
webhook_url
string / required
ini entries:

[callback_slack]
webhook_url = None

env:SLACK_WEBHOOK_URL
Slack Webhook URL

Authors

  • Unknown (!UNKNOWN)

© 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/slack_callback.html