Forge Home

mail_aliases

Manage sendmail/postfix mail aliases using hiera

21,691 downloads

141 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.4.0 (latest)
  • 0.3.0
  • 0.2.4
  • 0.2.3
  • 0.2.0
  • 0.1.1
released Nov 10th 2023
This version is compatible with:
  • Puppet Enterprise 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2021.7.x
  • Puppet >= 7.24 < 9.0.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'stjeanp-mail_aliases', '0.4.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.4.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.4.0 Nov 10th 2023

mail_aliases

Table of Contents

  1. Description
  2. Setup - The basics of getting started with mail_aliases
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the 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

Setup Requirements

This will only work if sendmail or postfix is installed on the target system. Please ensure that one of those packages is installed, otherwise you're going to get failures.

Please ensure that the puppetlabs/mailalias_core module is installed in your Puppetfile.

Beginning with mail_aliases

Configure your hiera data however you would like, following the example below. Then update your Puppetfile to install stjeanp/mail_aliases and puppetlabs/mailalias_core modules.

Usage

 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

Limitations

Due to testing VM availability, it only supports systems whose OS Family fact is RedHat, Debian, or SUSE.

Development

Issues, merge requests, and feedback are always welcome.