sync($source, $dest, $opts)

This function executes the rsync command on the local machine (where rex is being run) to sync $source and $dest with a remote. The "rsync" command is invoked with the "--recursive --links --verbose --stats" options set.

If you want to use sudo, you need to disable requiretty option for this user. You can do this with the following snippet in your sudoers configuration.

 Defaults:username !requiretty

UPLOAD - Will upload all from the local directory html to the remote directory /var/www/html.

 task "sync", "server01", sub {
   sync "html/*", "/var/www/html", {
    exclude => "*.sw*",
    parameters => '--backup --delete',
   };
 };
 task "sync", "server01", sub {
   sync "html/*", "/var/www/html", {
    exclude => ["*.sw*", "*.tmp"],
    parameters => '--backup --delete',
   };
 };
    

DOWNLOAD - Will download all from the remote directory /var/www/html to the local directory html.

 task "sync", "server01", sub {
   sync "/var/www/html/*", "html/", {
    download => 1,
    parameters => '--backup',
   };
 };