Defined Type: rsync::put

Defined in:
manifests/put.pp

Summary

put files via rsync ussing exec

Overview

Examples:

rsync::put { '${rsyncDestHost}:/repo/foo':
  user    => 'user',
  source  => "/repo/foo/",
}

Parameters:

  • source (String) —

    source to copy from

  • path (Optional[String]) (defaults to: undef) —

    path to copy to

  • user (Optional[String]) (defaults to: undef) —

    username on remote system

  • keyfile (String) (defaults to: "/home/${user}/.ssh/id_rsa") —

    path to ssh key used to connect to remote host

  • timeout (String) (defaults to: '900') —

    timeout in seconds

  • options (String) (defaults to: '-a') —

    commandline options to pass to rsync (-a)



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'manifests/put.pp', line 13

define rsync::put (
  String           $source,
  Optional[String] $path    = undef,
  Optional[String] $user    = undef,
  String           $keyfile = "/home/${user}/.ssh/id_rsa",
  String           $timeout = '900',
  String           $options = '-a'
) {
  if $user {
    $myuseropt = "-e 'ssh -i ${keyfile} -l ${user}'"
    $myuser = "${user}@"
  } else {
    $myuseropt = undef
    $myuser = undef
  }

  if $path {
    $mypath = $path
  } else {
    $mypath = $name
  }

  $rsync_options = join(
  delete_undef_values([$options, $myuseropt, $source, "${myuser}${mypath}"]), ' ')

  exec { "rsync ${name}":
    command => "rsync -q ${rsync_options}",
    path    => ['/bin', '/usr/bin'],
    # perform a dry-run to determine if anything needs to be updated
    # this ensures that we only actually create a Puppet event if something needs to
    # be updated
    # TODO - it may make senes to do an actual run here (instead of a dry run)
    #        and relace the command with an echo statement or something to ensure
    #        that we only actually run rsync once
    onlyif  => "test `rsync --dry-run --itemize-changes ${rsync_options} | wc -l` -gt 0",
    timeout => $timeout,
  }
}