Synchronization Server Documentation Index
Command-Line Tool Reference Home

remove-backup

↓Description
↓Examples
↓Arguments

Description

Safely remove a backup and optionally all of its dependent backups from the specified Synchronization Server backend.

This tool deletes the specified backup archive and updates the backup descriptor accordingly. If there are other (incremental) backups that depend on this backup, they will need to be removed before the base backup can be removed, unless you choose the --force option.

If you choose the --force option, the specified backup and all other backups depending on it are removed. You can use the --showDependencies option to see what incremental backups depend on a given base backup.

Examples

Remove the backup with ID 'monday' stored in the 'backups/userRoot' folder: 
remove-backup --backupDirectory backups/userRoot --backupID monday


Remove the backup with ID 'monday' stored in the 'backups/userRoot' folder, as well as all of its dependencies: 
remove-backup --backupDirectory backups/userRoot --backupID monday --force


List all of the incremental backups in 'backups/userRoot' folder which use the backup 'monday' as a base: 
remove-backup --backupDirectory backups/userRoot --backupID monday \
     --showDependencies

Arguments

-V
--version

Description Display Synchronization Server version information

-H
--help

Description Display general usage information

--help-debug

Description Display help for using debug options
Advanced Yes

-d {backupDir}
--backupDirectory {backupDir}

Description Directory containing backup archives and backup descriptor for a given backend
Required Yes
Multi-Valued No

-I {backupID}
--backupID {backupID}

Description Identifier of the backup archive to remove
Required Yes
Multi-Valued No

-f
--force

Description Force the removal of this backup and all its dependent incremental backups

-s
--showDependencies

Description Show the incremental backups that depend on this backup