Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Rsync Tasks

  2 minute read.

Last Modified 2022-05-10 16:18 EDT



PathBrowse to the path to be copied. FreeBSD file path limits apply. Other operating systems can have different limits which might affect how they can be used as sources or destinations.
UserSelect the user to run the rsync task. The user selected must have permissions to write to the specified directory on the remote host.
DirectionDirect the flow of data to the remote host. During a push, the dataset transfers to the remote module. During a pull, the dataset stores files from the remote system.
DescriptionEnter a description of the rsync task.


ScheduleSelect a schedule preset or choose Custom to open the advanced scheduler.
RecursiveSet to include all subdirectories of the specified directory. When unset, only the specified directory is included.


Remote HostEnter the IP address or hostname of the remote system that will store the copy. Use the format username@remote_host if the username differs on the remote host.
Rsync ModeChoose to either use a custom-defined remote module of the rsync server or to use an SSH configuration for the rsync task.

More Options

TimesSet to preserve modification times of files.
CompressSet to reduce the size of data to transmit. Recommended for slow connections.
ArchiveWhen set, rsync is run recursively, preserving symlinks, permissions, modification times, group, and special files. When run as root, owner, device files, and special files are also preserved. Equivalent to passing the flags -rlptgoD to rsync.
DeleteDelete files in the destination directory that do not exist in the source directory.
QuietSet to suppress informational messages from the remote server.
Preserve PermissionsSet to preserve original file permissions. This is useful when the user is set to root.
Preserve Extended AttributesExtended attributes are preserved, but must be supported by both systems.
Delay UpdatesSet to save the temporary file from each updated file to a holding directory until the end of the transfer when all transferred files are renamed into place.
Auxiliary ParametersAdditional rsync(1) options to include. Separate entries by pressing Enter. Note: The “” character must be escaped with a backslash (\.txt) or used inside single quotes ('*.txt').
EnabledEnable this rsync task. Unset to disable this rsync task without deleting it.