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

Rsync Tasks Screens

  4 minute read.

Last Modified 2022-09-20 13:05 EDT

The Rsync Task widget on the Data Protection screen lists rsync tasks configured on the TrueNAS system.


The Rsync Tasks widget displays No Rsync Tasks configured before you add a task.


Add opens the Add Rsync Task screen.

Each rsync task is a link to open the Edit Rsync Task screen.

The widget displays the status of a task as PENDING, RUNNING, SUCCESS or FAILED.

Use the play_arrow Run Now icon to manually run the task.

Use the delete icon to open a delete confirmation dialog.

Add and Edit Rsync Task Screens

The Add Rsync Task and Edit Rsync Task display the same settings.

Source and Remote Settings

Source and Remote settings specify the direction of the remote sync, the TrueNAS system and the remote rsync server paths to or from the data location, the method to uses to sync the TrueNAS and remote servers and the user with permissions to do the remote sync operation.


PathRequired. Enter or use the arrow_right to the left of folder/mnt to browse to the path to copy. Linux file path limits apply. Other operating systems can have different limits which might affect how you can use them as sources or destinations.
UserRequired. Select the user to run the rsync task. Select a user that has permissions to write to the specified directory on the remote host.
DirectionRequired. Select the direction of the flow of data to the remote host. Options are Push or Pull. 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.
Remote HostRequired. Enter the IP address or host name of the remote system that stores the copy. Use the format username@remote_host if the user name differs on the remote host.
Rsync ModeSelect the mode from the dropdown list. Select Module to use a custom-defined remote module of the rsync server or if the remote server is a TrueNAS, and then define the rsync module or select SSH to use an SSH configuration for the rsync task. The remote system must have SSH enabled. The host system needs an established SSH connection to the remote for the rsync task. SSH displays more settings.
Remote Module NameRequired. If Rsync Mode is Module specify the name of the module on the remote rsync server. Define at least one module in rsyncd.conf(5) or the rsync server or in the Rsync Modules of another TrueNAS system. Type the Remote Module Name exactly as it appears on the remote system.
Remote SSH PortRequired when Rsync Mode is SSH. Enter the SSH port number of the remote system. By default, 22 is reserved in TrueNAS.
Remote PathEnter or use the arrow_right to the left of folder/mnt to browse to the existing path on the remote host to sync with, or use Validate Remote Path to automatically create and define the path if it does not exist. Maximum path length is 255 characters.
Validate Remote PathDisplays if Rsync Mode is Module. Select to automatically create the defined Remote Path if it does not exist.

Schedule and More Options Settings

Schedule defines when the remote sync task occurs and More Options specify other settings related to when and how the rsync occurs.


ScheduleSelect a schedule preset or select Custom to open the advanced scheduler.
RecursiveSelect to include all subdirectories of the specified directory. When cleared, only the specified directory is included.
TimesSelect to preserve modification times of files.
CompressSelect to reduce the size of data to transmit. Recommended for slow connections.
ArchiveSelect to preserve symlinks, permissions, modification times, group and special files. When selected, rsync runs recursively. When run as root, owner, device files, and special files are also preserved. Equal to passing the flags -rlptgoD to rsync.
DeleteSelect to delete 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 AttributesSelect to preserve extended attributes, but this must be supported by both systems.
Delay UpdatesSelect to save 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 ParametersEnter additional rsync(1) options to include. Separate entries by pressing Enter. Note: You must escape the emergency character with a backslash (\) or used inside single quotes ('*.txt').
EnabledSelect to enable this rsync task. Clear to disable this rsync task without deleting it.

Related Content