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

Note

This callback plugin is part of the community.general collection (version 5.8.3).

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. You need further requirements to be able to use this callback plugin, see Requirements for details.

To use it in a playbook, specify: community.general.slack.

Callback plugin

This plugin is a notification callback. It sends information for a playbook run to other applications, services, or systems. See Callback plugins for more information on callback plugins.

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

Comments

channel

string

Slack room to post in.

Default: "#ansible"

Configuration:

  • INI entry:

    [callback_slack]
channel = #ansible

  • Environment variable: SLACK_CHANNEL

username

string

Username to post as.

Default: "ansible"

Configuration:

  • INI entry:

    [callback_slack]
username = ansible

  • Environment variable: SLACK_USERNAME

validate_certs

boolean

validate the SSL certificate of the Slack server. (For HTTPS URLs)

Choices:

  • false

  • true ← (default)

Configuration:

webhook_url

string / required

Slack Webhook URL

Configuration:

  • INI entry:

    [callback_slack]
webhook_url = VALUE

  • Environment variable: SLACK_WEBHOOK_URL

Authors

  • Unknown

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.