Using BART Subcommands

This section briefly describes the BART subcommands.

Invoking BART

BART subcommands are invoked at the Linux command line. You can invoke the bart program (located in the <BART_HOME>/bin directory) with the desired options to manage your BART installation.

The following examples demonstrate ways of invoking BART. In these examples, the BART user account is named bartuser.

$ su bartuser
$ export

To run BART from any current working directory:

$ su bartuser
$ export

To use a BART configuration file other than <BART_HOME>/etc/bart.cfg, include the -c option and the path and name of the configuration file:

$ su bartuser
$ export
$ bart -c /home/bartuser/bart.cfg SHOW-SERVERS

Syntax for invoking BART

bart [ <general_option> ]... [ <subcommand> ] [<subcommand_option>]...


You can use either abbreviated ( for example -h) or long (for example --help) option forms on the command line.

General Options

You can specify the following general options with bart.

  • -h or (--help)
    • Displays general syntax and information about BART usage.
    • All subcommands support a help option (-h, --help). If the help option is specified, information is displayed regarding that particular subcommand. The subcommand, itself, is not executed.

The following code sample shows the result of invoking the --help option for the BACKUP subcommand:

-bash-4.2$ bart BACKUP --help
bart: backup and recovery tool


-h, --help Show this help message and exit
-s, --server Name of the server or 'all' (full backups only) to specify all servers
-F, --format=p|t Backup output format (tar (default) or plain)
-z, --gzip Enables gzip compression of tar files
-c, --compress-level Specifies the compression level (1 through 9, 9 being
     best compression)
--backup-name Specify a friendly name for the current backup
--parent Specify parent backup for incremental backup
--check Verify checksum of required mbm files
  • -v (or --version)

    Displays information about BART version.

  • -d (or --debug)

    Displays information about debugging output while executing BART subcommands.

  • -c (or --config-path) <config_file_path>

Specifies config_file_path as the full directory path to a BART configuration file. Use this option if you do not want to use the default BART configuration file BART_HOME/etc/bart.cfg.

The following section describes the BART subcommands. The option help is omitted from the syntax diagrams in the following sections for the purpose of providing clarity for the subcommand options.