Forge Home


Creates an SMTP report for failed and changed runs


8,445 latest version

5.0 quality score

Version information

  • 0.0.10 (latest)
  • 0.0.9
  • 0.0.8
  • 0.0.7
released Jul 31st 2015
This version is compatible with:
  • Puppet Enterprise >= 3.7.0
  • Puppet >= 3.7.0
  • , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'stjeanp-smtpreports', '0.0.10'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add stjeanp-smtpreports
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install stjeanp-smtpreports --version 0.0.10

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



stjeanp/smtpreports — version 0.0.10 Jul 31st 2015

#SMTP Reports Puppet module

####Table of Contents

  1. Overview
  2. Module description - What the module does and why it is useful
  3. Setup - The basics of getting started with the Logstash Reporter
  1. Usage - Configuration options and additional functionality
  2. Limitations - OS compatibility, etc.
  3. Development - Guide for contributing to the module
  4. Support - When you need help with this module
  5. Credits


This module manages the SMTP reporter which sends puppet reports to the configured email addresses.

##Module description

The smtpreports module sets up and configures the reporter


###The module manages the following

  • reporter configuration file.


  • json
  • yaml
  • Master puppet.conf needs to use the SMTP reporter.
report = true
reports = smtp
pluginsync = true
  • Agent puppet.conf needs to send the reports to master.
report = true
pluginsync = true


###Main class

####Basic usage

class { 'smtpreports':
  smtp_server => ''



Required. Specifies the hostname or IP address of the SMTP server to use. Default: undef.


Specifies the TCP port to use to connect to the SMTP server. Default: 25.


Specifies the hostname to use in the HELO command. Default: 'localhost'.


Required. The email address that should be used as the sender. Default: undef.


Required. A comma delimited list of email addresses that will receive the notifications. Default: undef.


Whether or not to use SMTP authentication. Valid options: true, false. Default: false.


Required when smtp_use_auth is true. The authentication type to use. Valid options: plain, login, cram_md5. Default: undef.


Required when smtp_use_auth is true. The account/user to authenticate as. Default: undef.


Required when smtp_use_auth is true. The secret used to authenticate. Default: undef.


This module has been built on and tested against Puppet 3.8 and higher.

The module has been tested on:

  • CentOS 7

Other distro's that have been reported to work:

  • RHEL 7

Testing on other platforms has been light and cannot be guaranteed.