Running async
Sync uses the async command line tool to
synchronize content from the source to the destination. async has many options
for customizing the behavior of the synchronization, and this section describes how to compose an
async session, the command line arguments, and examples for specific use
cases.
Composing a Sync session
Sync has more than 80 options that can be used when composing an async session, but only a few are required, and for security by using several others.
Async command reference
An async session accepts the following options, some of which are required.
Examples of async commands and output
Examples of common Sync use cases and a description of async output.
Filtering patterns and examples
Filtering patterns and examples that demonstrate the effects of adding more filter rules to the command and show how to format a filter rule file.
Bidirectional example
Bidirectional synchronization syntax is similar to push or pull async sessions, as show in the following example.
Synchronizing with AWS S3 Storage
Sync can be used to synchronize files when the source or destination is AWS S3 Cloud Object Storage. Each endpoint (HSTS) of the async session must be configured to support Sync and the async must include certain file system-related options.
Writing custom metadata for objects in object storage
Files that are uploaded to metadata-compatible storage (S3, Google Cloud, and Azure ) can have custom metadata that is written with them by using the --tags
or --tags64
option. The argument is a JSON payload that specifies the metadata and that is base64 encoded if it is used as an argument for --tags64
.
Sync with basic token authorization
Aspera nodes that require access key authentication, such as IBM Aspera on Cloud (AoCts ), can be used as synchronization endpoints by configuring the async database on the node and authenticating the async session with a basic token. A basic token requires a docroot on the server and allows access to all files in the docroot.