asyncadmin Command-Line Options

Administrators can use the asyncadmin tool to view the status of the current synchronization, as well as the latest snapshot. This includes the number of files in each state and any changes that might be incomplete on the remote endpoint. asyncadmin also offers troubleshooting options for deleting file records from a snapshot by path globbing match or filename. Learn more about asyncadmin definitions, allowable values, and defaults.

General asyncadmin usage:

# asyncadmin -d path [-N name][options]

The -N name option is required if multiple Aspera Sync sessions are running; you must specify the name of the session to which the asyncadmin command should apply.

Note: When records are deleted using the -M or -E options, Aspera Sync recalculates file counters for the entire database. This can take a while, depending on the size of the database.

Session Options

-A: Display the asyncadmin version.
-b path, --local-db-dir=path: Specify the local database directory. The default location is the local Aspera Sync directory.
-C, --clean: Delete problem records (records with statuses of CONF, PCONF, and ERR).
-d path, --local-dir=path: Specify the local Aspera Sync directory.
-E number, --erase=number: Delete the specified file record by number.
-F, --force: Allow changes while database is in use.
-f, --file-info: Report the status of all files.
CAUTION:
The use of this option is not recommended on Windows, as it can cause the database to lock and async to fail. An alternative is to use the -t option.
-h, --help: Display the asyncadmin command-line option help.
-j, --journal: List the changes that might be incomplete remotely.
-l, --list: List the snapshot databases found in the database directory.
-M pattern, --match=pattern: Delete file records that have paths that match the specified pattern (path globbing).
-m, --meta: Report metadata.
-N name, --name=name: Select a source-destination pair from the snapshot database by name.
-O, --compact: Compact the database file.
-p, --pause: Pause when displaying a large amount of file data (for example, -f).
-q, --quiet: Display only the requested information. Use with -f / --file-info to disable abbreviating file names in the output.
-s, --summary: Report the number of files in each state. When -s is used alone, a brief summary from the async database's counters table is reported back (same as the cached counters as in the -t option).
CAUTION:
The use of this option is not recommended on Windows, as it can cause the database to lock and async to fail. An alternative is to use the -t option below.
-s -v: When -s is used with -v, every record in the async database is counted.
Important: This should only be used when async is not running.
-T, --terminate: Shut down async if it is running. This option cannot be used if the storage style set for <async_db_spec> is LMS and outputs an error message.
-t num, --tail=num: Report status of last num files.
Note: Use of this option on Windows as an alternative to the -f and -s options above.
--touch=path: Change the recursive mtime of the node and all its parents to current time if they are older. This option is only applied if async has been run using the --exclude-dirs-older-than option.
-v, --verbose: Increase the verbosity of summary (-s) or file info (-f).
-x, --init: Delete all file system snapshot records.