cbbackupmgr list

SYNOPSIS

DESCRIPTION

Lists the contents of the backup archive. The size in bytes and number of items
is listed for each backup file. For each directory the cumulative size of all
data contained in that directory is listed. The flags for this command are used
to see various sections of the backup archive.

OPTIONS

Below are the required and optional parameters for the list command.

Required

-a,--archive <archive_dir>

The location of the backup archive to list.

Optional

-r,--repo <repo_name>

If specified, the list command will only list the contents of this backup
repository.

--backup <backup>

If specified, the list command will only list the contents of this backup.
The --repo flag must also be specified if this flag is used.

--bucket <bucket>

If specified, the list command will only list the contents of this bucket.
The --repo and --backup flags must also be specified if this flag is used.

EXAMPLES

The list command will display the contents of the backup archive. Below we take
an example of a backup archive that has two backup repositories, example1 and
example2. The example1 backup repository will contain one backup and the
example2 repository will contain two backups. Below are a few examples of how
the list command can be used.

The example below shows how to list the entire backup archive. The output for
this operation can be large if there are a lot of backups in the backup archive.

From the output we can see the entire contents of the backup archive and even
more importantly we can see the sizes of the backups and the amount of items
backed up. The data folder contains the data files and lists the size of those
files and the number of documents that were backed up. The data is kept in shard
files and in this example there is only one shard file, but depending on the way
the backup is taken there may be more of these. In the full-text.json,
views.json, and gsi.json files the item counts refer to the number of index
definitions backed up.

Since the output for listing the entire backup archive can be long, the list
command provides ways to look only at specific portions of the backup archive.
For example, if we only want to see the example1 backup repository we can do the
following:

The results can further be filtered in order to look at a specific bucket in a
specific backup. To see the travel-sample bucket in the backup taken at
2016-03-03T11_50_01.863827072-08_00 from the example2 backup repository you
would run the list command as follows:

DISCUSSION

The list command is mainly used to explore your data and understand what your
backup structure looks like. This alleviates the need for users to traverse the
folder structure manually to infer information about their data.

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.