asyncadmin Command-Line Options

Administrators can use the asyncadmin command 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 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 definitions, allowable values, and defaults are described below.

General asyncadmin usage:

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

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

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

Session Options

Option (short and long form) Description
-h
--help
Show asyncadmin command-line option help.
-A
Display the asyncadmin version.
-d path
--local-dir=path
Choose the location of the local sync directory.
-b path
--local-db-dir=path
Choose the location of the local database directory. The default location is the local sync directory.
-N name
--name=name
Choose a source-destination pair from the snapshot database by name.
-l 
--list
List snapshot databases found in the database directory.
-m
--meta
Report meta details.
-s
--summary
Report the 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 the cached counters as in the -t option).
-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.
-f
--file-info
Report the status of all files.
-j
--journal
List changes that may be incomplete remotely.
-x
--init
Delete all file system snapshot records.
-C
--clean
Delete problem records (records with statuses of CONF, PCONF, and 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
-F

--force
Allow changes while database is already in use.
-p
--pause
Pause when printing a large amount of data (for example, -f).
-t num
--tail=num
Report status of last num files.
-v
--verbose
Increase the verbosity of summary (-s) or file info (-f).
-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.
-O
--compact
Compact the database file.
--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.