Running async
Aspera 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 an Async Session
Aspera Sync has more than 80 options that can be used when composing an async session, but only a few are required, and Aspera recommends using several others. These instructions describe how to compose a bidirectional async session between a Windows client and a Linux server, and includes the required and recommended options in the correct order. You can use the short form or long form (POSIX) option tags and the complete commands using both tag formats are summarized at the end.
async Command Reference
An async session accepts the following options, some of which are required.
Examples of Async Commands and Output
Examples of common Aspera Sync use cases and a description of async output.
Include and Exclude Filtering Rules
Filtering rules can be specified in the async command line or in the client or server configuration (aspera.conf ) to include or exclude files and directories from Aspera Sync scanning and transfer. Rules in aspera.conf are applied before rules specified in the command line.
Filtering Examples
Filtering 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
Aspera Sync can be used to synchronize files when the source or destination is AWS S3 Cloud Object Storage. Each endpoint (HST Server ) of the async session must be configured to support Aspera 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 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
.
Aspera Sync with Basic Token Authorization
Aspera nodes that require access key authentication, such as IBM Aspera on Cloud transfer service (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.