community.general.mail – Sends failure events via email

Note

This plugin is part of the community.general collection (version 3.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.

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

Synopsis

  • This callback will report failures via email

Requirements

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

  • whitelisting in configuration

Parameters

Parameter

Comments

bcc

string

BCC’d recipient

Configuration:

  • INI entry:

    [callback_mail]
bcc = None

cc

string

CC’d recipient

Configuration:

  • INI entry:

    [callback_mail]
cc = None

mta

string

Mail Transfer Agent, server that accepts SMTP

Default: “localhost”

Configuration:

  • INI entry:

    [callback_mail]
smtphost = localhost

  • Environment variable: SMTPHOST

mtaport

string

Mail Transfer Agent Port, port at which server SMTP

Default: 25

Configuration:

  • INI entry:

    [callback_mail]
smtpport = 25

sender

string

Mail sender

Configuration:

  • INI entry:

    [callback_mail]
sender = None

to

string

Mail recipient

Default: “root”

Configuration:

  • INI entry:

    [callback_mail]
to = root

Notes

Note

  • TODO: expand configuration options now that plugins can leverage Ansible’s configuration

Authors

  • Dag Wieers (@dagwieers)