Forge Home

mail_aliases

Manages email aliases on Linux based systems via hiera data

20,772 downloads

7,523 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.3.0 (latest)
  • 0.2.4
  • 0.2.3
  • 0.2.0
  • 0.1.1
released Mar 2nd 2017
This version is compatible with:
  • Puppet Enterprise 2015.2.x
  • Puppet 4.2
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'stjeanp-mail_aliases', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install stjeanp-mail_aliases --version 0.3.0

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.

Download
Tags: aliases

Documentation

stjeanp/mail_aliases — version 0.3.0 Mar 2nd 2017

#mail_aliases Build Status

####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 mail_aliases
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

##Overview

This module uses data stored in hiera to manage mail aliases on Linux systems. Currently it works on any OS that sets $::osfamily to RedHat, Debian, or Suse.

##Module Description

The mail_aliases module manages mail aliases on the target systems using data stored in hiera. It is capable of both creating and removing aliases, with the default being to create them.

##Setup

###What mail_aliases affects

  • The aliases file on the target systems.

###Setup Requirements REQUIRED

  • Deep merging is no longer required. Puppet's native merging works perfectly.

##Usage

In at least one level of your hiera data, create aliases you wish to manage.

 mail_aliases:
   root:
     recipient: 'someone@somewhere.else.com'
   user:
     recipient: 'their@real.address'
   olduser:
     recipient: 'not@work.anymore'
     ensure: absent

The default behavior is to create an alias, so if you need to remove one, make sure to include the 'ensure: absent' line.

include mail_aliases

##Reference

####Class: mail_aliases

##Limitations

This module has been tested on :

  • Red Hat Enterprise Linux (RHEL) 6.5
  • CentOs 6.5
  • Debian 7.7.0
  • OpenSUSE 13.1
  • Ubuntu Server 14.04

It should work on :

  • Red Hat Enterprise Linux (RHEL) 5,6,7
  • CentOs 5,6,7
  • Oracle Linux 5,6,7
  • Scientific Linux 5,6,7
  • Debian 6,7
  • OpenSuSE 13
  • Ubuntu 14

##Development

Updates and tweaks are welcome.