Forge Home


Manage ccollect


7,067 latest version

4.6 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

  • 1.2.1 (latest)
  • 1.2.0
  • 1.1.0
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
released Jan 8th 2017
This version is compatible with:
  • Debian, Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'saz-ccollect', '1.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add saz-ccollect
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install saz-ccollect --version 1.2.1

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.



saz/ccollect — version 1.2.1 Jan 8th 2017


Manage ccollect via Puppet

How to use

Destination node

    class { 'ccollect':
        backup_dir = '/backup/ccollect/',

    # Realize all collected nodes
    Ccollect::Backup <<| |>> {
        ensure => present,

Source node(s)

    @@ccollect::backup {
        source_host       => $fqdn,
        ssh_user          => root,
        source            => '/',
        exclude           => 'puppet:///files/another/exclude/file',
        rsync_options     => '',
        delete_incomplete => 'y',
        pre_exec          => 'puppet:///files/path/to/pre/exec/script',
        post_exec         => 'puppet:///files/path/to/post/exec/script',
  • source_host: Host to connect to, most of the time this should be set to $fqdn. Required

  • ssh_user: User to connect as to remote host Default: root

  • source: Start position of rsync Default: /

  • exclude: Exclude list to use Default: 'puppet:///modules/ccollect/exclude'

  • rsync_options: Additional rsync options Default: ''

  • delete_incomplete: Delete incomplete backups Default: y

  • pre_exec: Script to execute before backing up host Default: ''

  • post_exec: Script to execute after backing up host Default: ''