Forge Home


Puppet module for rsync


18,031 latest version

2.3 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

  • 2.0.13 (latest)
  • 2.0.12
  • 2.0.11
  • 2.0.10
  • 2.0.9
  • 2.0.8
released Jun 30th 2015
This module has been deprecated by its author since Oct 28th 2019.

The reason given was: No longer maintained

The author has suggested puppetlabs-rsync as its replacement.

Start using this module


example42/rsync — version 2.0.13 Jun 30th 2015

Puppet module: rsync


This module is no more actively maintained and will hardly be updated.

Please find an alternative module from other authors or consider Tiny Puppet as replacement.

If you want to maintain this module, contact Alessandro Franceschi

This is a Puppet module for rsync based on the second generation layout ("NextGen") of Example42 Puppet Modules.

Made by Alessandro Franceschi / Lab42

Official site:

Official git repository:

Released under the terms of Apache 2 License.

This module requires functions provided by the Example42 Puppi module (you need it even if you don't use and install Puppi)

For detailed info about the logic and usage patterns of Example42 modules check the DOCS directory on Example42 main modules set.

USAGE - Basic management

  • Install rsync with default settings

      class { 'rsync': }
  • Install a specific version of rsync package

      class { 'rsync':
        version => '1.0.1',
  • Disable rsync service.

      class { 'rsync':
        disable => true
  • Remove rsync package

      class { 'rsync':
        absent => true
  • Enable auditing without without making changes on existing rsync configuration files

      class { 'rsync':
        audit_only => true

USAGE - Overrides and Customizations

  • Use custom sources for main config file

      class { 'rsync':
        source => [ "puppet:///modules/lab42/rsync/rsync.conf-${hostname}" , "puppet:///modules/lab42/rsync/rsync.conf" ], 
  • Use custom source directory for the whole configuration dir

      class { 'rsync':
        source_dir       => 'puppet:///modules/lab42/rsync/conf/',
        source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  • Use custom template for main config file. Note that template and source arguments are alternative.

      class { 'rsync':
        template => 'example42/rsync/rsync.conf.erb',
  • Automatically include a custom subclass

      class { 'rsync':
        my_class => 'rsync::example42',

USAGE - Example42 extensions management

  • Activate puppi (recommended, but disabled by default)

      class { 'rsync':
        puppi    => true,
  • Activate puppi and use a custom puppi_helper template (to be provided separately with a puppi::helper define ) to customize the output of puppi commands

      class { 'rsync':
        puppi        => true,
        puppi_helper => 'myhelper', 
  • Activate automatic monitoring (recommended, but disabled by default). This option requires the usage of Example42 monitor and relevant monitor tools modules

      class { 'rsync':
        monitor      => true,
        monitor_tool => [ 'nagios' , 'monit' , 'munin' ],
  • Activate automatic firewalling. This option requires the usage of Example42 firewall and relevant firewall tools modules

      class { 'rsync':       
        firewall      => true,
        firewall_tool => 'iptables',
        firewall_src  => '',
        firewall_dst  => $ipaddress_eth0,

Build Status