Defined Type: rsync::push

Defined in:
manifests/push.pp

Overview

This is simply a call to rsync::retrieve with $pull set to false. It’s present for clarity and hopefully won’t break any dependency chains if you use it.

See the documentation for “rsync::retrieve“ for details.

Parameters:

  • source_path (String)
  • target_path (String)
  • rsync_server (Simplib::Host)
  • proto (String) (defaults to: 'rsync')
  • rsync_path (Stdlib::Absolutepath) (defaults to: '/usr/bin/rsync')
  • preserve_perms (Boolean) (defaults to: true)
  • preserve_acl (Boolean) (defaults to: true)
  • preserve_xattrs (Boolean) (defaults to: true)
  • preserve_owner (Boolean) (defaults to: true)
  • preserve_group (Boolean) (defaults to: true)
  • preserve_devices (Boolean) (defaults to: false)
  • exclude (Array[String]) (defaults to: ['.svn/','.git/'])
  • rsync_timeout (Integer[0]) (defaults to: 2)
  • logoutput (Variant[Boolean,String]) (defaults to: 'on_failure')
  • delete (Boolean) (defaults to: false)
  • bwlimit (Optional[Integer[0]]) (defaults to: undef)
  • copy_links (Boolean) (defaults to: false)
  • size_only (Boolean) (defaults to: false)
  • no_implied_dirs (Boolean) (defaults to: true)
  • user (Optional[String]) (defaults to: undef)
  • pass (Optional[String]) (defaults to: undef)
  • rsubscribe (Optional[Catalogentry]) (defaults to: undef)
  • rnotify (Optional[Catalogentry]) (defaults to: undef)

Author:

  • Trevor Vaughan <tvaughan@onyxpoint.com>



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'manifests/push.pp', line 33

define rsync::push (
  String                  $source_path,
  String                  $target_path,
  Simplib::Host           $rsync_server,
  String                  $proto            = 'rsync',
  Stdlib::Absolutepath    $rsync_path       = '/usr/bin/rsync',
  Boolean                 $preserve_perms   = true,
  Boolean                 $preserve_acl     = true,
  Boolean                 $preserve_xattrs  = true,
  Boolean                 $preserve_owner   = true,
  Boolean                 $preserve_group   = true,
  Boolean                 $preserve_devices = false,
  Array[String]           $exclude          = ['.svn/','.git/'],
  Integer[0]              $rsync_timeout    = 2,
  Variant[Boolean,String] $logoutput        = 'on_failure',
  Boolean                 $delete           = false,
  Optional[Integer[0]]    $bwlimit          = undef,
  Boolean                 $copy_links       = false,
  Boolean                 $size_only        = false,
  Boolean                 $no_implied_dirs  = true,
  Optional[String]        $user             = undef,
  Optional[String]        $pass             = undef,
  Optional[Catalogentry]  $rsubscribe       = undef,
  Optional[Catalogentry]  $rnotify          = undef
) {
  rsync::retrieve { "push_${name}":
    source_path      => $source_path,
    target_path      => $target_path,
    rsync_server     => $rsync_server,
    proto            => $proto,
    rsync_path       => $rsync_path,
    preserve_perms   => $preserve_perms,
    preserve_acl     => $preserve_acl,
    preserve_xattrs  => $preserve_xattrs,
    preserve_owner   => $preserve_owner,
    preserve_group   => $preserve_group,
    preserve_devices => $preserve_devices,
    exclude          => $exclude,
    rsync_timeout    => $rsync_timeout,
    logoutput        => $logoutput,
    delete           => $delete,
    rnotify          => $rnotify,
    bwlimit          => $bwlimit,
    copy_links       => $copy_links,
    size_only        => $size_only,
    no_implied_dirs  => $no_implied_dirs,
    rsubscribe       => $rsubscribe,
    user             => $user,
    pass             => $pass,
    pull             => false
  }
}