Syncs files or directories using the rsync command. Syncing can be done on the same server or from/to a remote server.
Table C.11: Attributes
Name | Type | Description | Default | Required |
---|---|---|---|---|
rsyncPath | String | Path to rsync command | /usr/bin/rsync | Yes |
sourceDir | String | Source directory (with user&host for remote sources) | n/a | Yes |
destinationDir | String | Destination directory (with user&host for remote destinations) | n/a | Yes |
excludeFile | String | Excluded patterns file | n/a | No |
backupDir | String | Creates a backup so users can rollback to an existing restore point | n/a | No |
options | String | Any options that rsync supports, removes the default options | -rpKz | No |
verbose | Boolean | This option increases the amount of information you are given during the transfer | True | No |
dryRun | Boolean | This option makes rsync perform a trial run that doesn't make any changes | False | No |
itemizeChanges | Boolean | This option requests a simple itemized list of the changes that are being made to each file, including attribute changes | False | No |
checksum | Boolean | This option will cause rsync to skip files based on checksum, not mod-time & size | False | No |
delete | Boolean | This option deletes files that don't exist on sender after transfer including force and ignore-errors | False | No |
identityFile | String | Identity file for ssh authentication of a remote transfer | n/a | No |