Rsync-specific guidelines and requirements

You should review these guidelines prior to configuring or using either secure or non-secure Rsync.

Use the same Rsync version as NetStorage

For best results, we recommend that the Rsync client installed the system that will perform the transfers (the “client”) be as close in version as possible to the Rsync server used by NetStorage. This ensures compatibility with supported rsync command options. Older versions can be problematic, and newer ones may offer functionality that is not supported. NetStorage currently supports this version:

  • ObjectStore: Version 3.1.2
    Note: Your client should be no lower than version 3.0.6

Rsync client installation

It is assumed that you have properly installed and configured an Rsync client on your local system, and understand its use. No specific instructions on its installation or use are covered here. Currently, Rsync is maintained by “samba.org” and complete details on its use (and download access) can be found on their website: https://rsync.samba.org/

Rsync file total limitations

We do not specifically limit the number of Rsync operations that are targeting an ObjectStore storage group. However, the storage group itself is subject to various limitations. This includes, but is not limited to, the following:
  • The size of a single storage group cannot exceed 1000 TB.
  • The total number objects (files and directories) in a single storage group can't exceed 200 million.

Recommended directory targeting for Rsync

The nature of Rsync is to scan directories and only update content it finds to be new or updated. This is the benefit of Rsync—you can be lenient on tracking your file content, because there is reduced fear of complete overwrite. We recommend that you be specific in targeting subdirectory trees you know to contain new or changed content. Rsync under-performs if you target a large directory structure, because it continually scans until it finds this content.

The more directories and files Rsync has to scan, the longer an operation will take.

Know your source environment!

Be mindful of your local source environment and protect your directory tree configuration. This helps to avoid sudden large target changes as a result of accidental source changes. For example, there could be an accidental configuration change on your end that selects a new, empty source directory. Rsync could inadvertently use it to synchronize content in NetStorage. Since the new source is empty, Rsync will faithfully attempt to delete everything in the storage group to make it conform with this empty directory.

Rsync and smaller quantity transfers

Due to the nature of Rsync and its typical configuration, we recommended you use Rsync to transfer larger quantities of files. Since Rsync must scan the entirety of a directory tree to determine what to transfer, it may not be suited for the immediate transfer of files. For example, if you are looking to quickly transfer five or six files, you would be better off uploading them via the CMShell system (if SSH security is desired), or an FTP connection.

Using Rsync on the Sun Microsystems Solaris operating system

The Solaris operating system truncates any Rsync password greater than eight (8) characters (i.e., its getpass() function call in Rsync only takes the first eight characters). If your password is longer than this, you can work around the problem by using the --password-file option, or by setting the environment variable, “RSYNC_PASSWORD”.