community.general.mail – Sends failure events via email

From Get docs
Ansible/docs/2.10/collections/community/general/mail callback


community.general.mail – Sends failure events via email

Note

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

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 Choices/Defaults Configuration Comments

bcc

string

ini entries: [callback_mail]bcc = None


BCC'd recipient

cc

string

ini entries: [callback_mail]cc = None


CC'd recipient

mta

string

Default:

"localhost"

ini entries: [callback_mail]smtphost = localhost


env:SMTPHOST

Mail Transfer Agent, server that accepts SMTP

mtaport

string

Default:

25

ini entries: [callback_mail]smtpport = 25


Mail Transfer Agent Port, port at which server SMTP

sender

string

ini entries: [callback_mail]sender = None


Mail sender

to

string

Default:

"root"

ini entries: [callback_mail]to = root


Mail recipient



Notes

Note

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


Authors

  • Dag Wieers (@dagwieers)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/mail_callback.html