| Aspera Sync |
234
--name=job1
--private-key-path=c:/users/morgan/.ssh/id_rsa
--local-db-dir="C:\Users\Morgan\Aspera jobs\db"
--target-rate=500m
--local-dir=c:/users/morgan/data
--user=morgan
--host=10.0.0.1
--remote-dir=/data
--remote-logdir=/morgan/async/log
--remote-db-dir=/morgan/async/db
--direction=bidi
--preserve-time
If the session is between Linux computers, it also includes the following session options:
-u
-j
Or using long-format option flags:
--preserve-uid
--preserve-gid
async Command Reference
An
async
session accepts the following options, some of which are required.
Syntax
# async [
instance_options
] -N
pair
-d
ldir
-r [
user@host
:rdir]
[
session_options
] ...
Note:
Transfers started by
async
can be controlled from the HST Server GUI. Canceling an
async
transfer in the
GUI shuts down
async
.
Required Command Options
Naming the async session: -N
pair
-N
pair
is required in
async
commands. The value for
pair
is a name that uniquely identifies the Aspera Sync
session and is visible in IBM Aspera Console.
-N
pair
must follow any instance options and must precede all
session arguments. Names can only use standard alphanumeric characters, plus "_" and "-" characters.
Note:
If your remote host is an Aspera cluster, ensure that your session name is unique by naming
the session with a descriptive string followed by the UUID of the local host, such as "cluster-sync-
ba209999-0c6c-11d2-97cf-00c04f8eea45".
Specifying filepaths and filenames:
ldir
and
rdir
ldir
specifies the local directory to be synchronized and
rdir
specifies the remote directory to be synchronized. File
paths and filenames must follow these rules:
• The drive letter is required in Windows paths, unless the server's
aspera.conf
file has a
docroot
defined for
the user. If no drive letter is included when syncing with a Windows computer and
docroot
is not defined for
the user,
async
displays the error message: "Failed. Peer error: Remote directory is not absolute."
• You can synchronize Windows, Linux, macOS, and other Unix-based endpoints and servers, but must take care
with path separators. The path separator "/" is supported on Windows and other platforms. The path separator "\"
is platform-agnostic
only
for the options
-d/r/L/R/B/b
and
--keep-dir-local/remote
. In Aspera Sync
filtering rules, however, "\" is exclusively a quoting operator and "/" is the only path separator recognized.
• File names may not contain \n, \r, or \. Files with these in their names are skipped.