A newer version of this documentation is available.

View Latest

cbbackupmgr remove

    +

    Removes a backup repository from the backup archive

    SYNOPSIS

    cbbackupmgr remove [--archive <archive_dir>] [--repo <repo_name>]

    DESCRIPTION

    Removes a backup repository from the backup archive. All contents of the specified repository will be deleted from disk.

    OPTIONS

    Below are a list of parameters for the remove command.

    -a,--archive <archive_dir>

    The location of the archive directory.

    -r,--repo <repo_name>

    The name of the backup repository to remove.

    EXAMPLES

    The remove command is used to remove a backup repository from disk. Below is an example of how to run the remove command. The /data/backup directory is used as the archive directory and the backup repository is named "example".

    $ cbbackupmgr list -a /data/backup
    Size      Items          Name
    91.52MB   -              /
    91.52MB   -              + example
    91.52MB   -                  + 2016-02-12T12:45:33.329408761-08:00
    91.52MB   -                      + travel-sample
    322B      0                          bucket-config.json
    91.51MB   31569                      + data
    91.51MB   31569                          shard_0.fdb
    2B        0                          full-text.json
    10.00KB   8                          gsi.json
    1.72KB    1                          views.json
    $ cbbackupmgr remove -a /data/backup -r example
    Backup repository `example` deleted successfully from archive `/tmp/backup`
    $ cbbackupmgr list -a /data/backup
    Size      Items          Name
    0B        -              /

    DISCUSSION

    The remove command is used to safely remove a backup repository from an archive. This command is provided because only the cbbackupmgr utility should ever be used to access or modify a backup archive. Removing a backup repository will remove data permanently from disk. Data is not recoverable once it has been removed.

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_ARCHIVE_PATH

    Specifies the path to the backup archive. If the archive path is supplied as a command line argument then this value is overridden.

    CBBACKUPMGR

    Part of the cbbackupmgr suite