TrueNAS CORETrueNAS CORE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Rsync Tasks

Remote sync is a utility that copies data across a network. Rsync first copies the initial data. Later copies contain only the data that is different between the source and destination files. This reduces network traffic. Use Rsync to create backups, and to synchronize data across systems.

Create a New Rsync Task

Go to Tasks > Rsync Tasks. The Rsync Tasks menu displays.


Click ADD.



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 select Custom to open the advanced scheduler.
RecursiveSelect to include all sub-directories of the specified directory. When cleared, only the specified directory is included.


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

More Options

TimesSelect to preserve modification times of files.
CompressSelect to reduce the size of data to transmit. Recommended for slow connections.
ArchiveWhen selected, rsync runs recursively. Preserves symlinks, permissions, modification times, group, and special files. When run as root, owner, device files, and special files are also preserved. Equal to passing the flags -rlptgoD to rsync.
DeleteDelete files in the destination directory that do not exist in the source directory.
QuietSelect to suppress informational messages from the remote server.
Preserve PermissionsSelect to preserve original file permissions. Useful when the user is set to root.
Preserve Extended AttributesExtended attributes are preserved, but must be supported by both systems.
Delay UpdatesSaves a temporary file from each updated file to a holding directory until the end of the transfer. All transferred files renamed once the transfer is complete.
Auxiliary ParametersAdditional rsync(1) options to include. Separate entries by pressing Enter. Note: The emergency character must be escaped with a backslash \ or used inside single quotes (’*.txt’).
EnabledSelect to enable this rsync task. Clear to disable this rsync task without deleting it.