asyncadmin Command-Line Options

async command-line options for System Administrators

This topic covers async options for administrators (using the asyncadmin command-line tool), including definitions, allowable values and defaults. Text shown in bold below indicates a parameter that is required when using the corresponding asyncadmin option. asyncadmin reports 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 may be incomplete on the remote endpoint. asyncadmin also includes troubleshooting options for deleting file records from a snapshot by path globbing match or filename.

asyncadmin Usage:

asyncadmin -d PATH [-N NAME][options]

Table Legend
BOLD TEXT = Required parameter

Short-form Option Long-form Option Description
-h --help asyncadmin command-line option help.
-A   Display asyncadmin version.
-d PATH --directory=PATH Choose location of monitored tree.
-N NAME --name=NAME Choose source-destination pair by name.
-l PATH --list=PATH List async pairs found at dirname.
-m --meta Report meta details.
-s --summary The use of this option is not recommended on Windows, as it may cause the database to lock and async to fail. Alternatively, please use the -t option below. Report number of files in each state. When -s is used alone, a quick summary from the async database's counters table is reported back (same as cached counters as in the -t option).
-s -v   When -s is used with -v, every record in the async database is counted. Note that this should only be used when async is not running.
-f --file-info The use of this option is not recommended on Windows, as it may cause the database to lock and async to fail. Alternatively, please use the -t option below. Report status of all files.
  --file-prefix=PREFIX List only files starting with the specified prefix.
  --bad-files Similar to the -f option, but only reports files in error or conflict states.
-p --pause Pause when printing a large amount of data (for example, -f).
-t NUM --tail=NUM The use of this option is RECOMMENDED on Windows as an alternative to the -f and -s options above. Report status of last NUM files.
-j --journal List changes that may be incomplete remotely.
-x --init Delete all file system snapshot records.
-C --clean Delete problem records (CONF, PCONF, ERR).
-M PATTERN --match=PATTERN Delete file records by path globbing.
-E NUMBER --erase=NUMBER Delete file record by number.
-q --quiet Emit only the information requested and do not abbreviate file names in -f / --file-info listing
-v --verbose Increases the amount of information (verbosity) you are given during the transfer. Akin to using -s -f.
-F --force Allow changes while database is already in use.
-T --terminate Shut down async if it is running.