ybbackup Options

This section contains detailed descriptions of the ybbackup command-line options. See also ybbackup Examples and ybrestore Options.

Note the following points about the format of these options and their values:
  • Options are listed in alphabetical order for quick reference.
  • Option names are shown in lowercase; they are case-sensitive.
  • Specific valid option values (such as true and false) are shown in lowercase. Variables for option values, such as STRING, are shown in uppercase. Option values are not case-sensitive.
  • The requirements for quoting option strings vary by client platform. Values are shown without quotes, but quotes are sometimes required. For example, if you specify the # character in a Linux shell, it must be enclosed by single or double quotes.
Note: Storage locations for backup files are not prefaced with an option name. See Storage Locations for Backups.

To see all of these options in the online help, run the ybbackup --help and ybbackup --help-advanced commands.

--cacert STRING
Customize trust with secured communication; use this option in combination with the --secured option. Enter the file name of a custom PEM-encoded certificate or the file name and password for a Java KeyStore (JKS).
For PEM format, the file must be named with a .pem, .cert, .cer, .crt, or .key extension. For example:
--cacert cacert.pem
For JKS format, files are always password-protected. Use the following format:
--cacert yellowbrick.jks:changeit

where the : character separates the file name from the password of the keystore.

See also Enabling SSL/TLS Encryption.

-c STRING, --chain STRING
Specify the name of the backup chain. You can use any meaningful name that defines the contents of a particular backup set. If you do not specify this option, the chain is named default.

Multiple chains and databases may be backed up to the same storage location. Backups that belong to different chains and databases are stored in distinct sets of files.

-C, --cumu
Use this option to take a cumulative backup.
-d, --dbname
Name the database to back up. You must specify one database only.
--desc STRING
Include a description of the backup. The maximum length is 256 characters.
--disable-trust, -k
Disable SSL/TLS trust when using secured communications. Trust is enabled by default. See also Enabling SSL/TLS Encryption.
Important: This option is not supported for use on production systems and is only recommended for testing purposes. It may be useful to disable trust during testing, then enable it when a formal signed certificate is installed on the appliance.
--exclude SCHEMA
Specify the names of schemas that you want to exclude from a full backup. Database objects that belong to the specified schemas will not be backed up. This option may only be used for full backups. You can use a comma-separated list or a wildcard character to specify multiple schemas. Do not include any blanks (space characters) in the list; they will be treated as part of the schema name. For example:
--exclude public,dev,new
--exclude dev*
--exclude yb*
-f, --full
Use this option to take a full backup.
-?, --help, --help-advanced
Return help text for all of the ybbackup options.
-h, --host
Specify the database server host. Alternatively, you can set this value with the YBHOST environment variable. Defaults to localhost.
-I, --inc
Use this option to take an incremental backup.
--initial-connection-timeout NUMBER_MIN_0
Specify the number of seconds to wait for initial connections to the database. Specify 0 to wait indefinitely. Default: 120.
Return the Java version that is running on the client system. The client tools require the 64-bit version of Java 8 (also known as Java 1.8). Java 9 and 10 are not supported.
--log-level OFF | ERROR | WARN | INFO | DEBUG | TRACE
Specify the logging level for the default console output. The default level is INFO. (Use the --logfile-log-level option to specify the logging level for a named log file.)
--logfile STRING
Specify the name and location of a log file for the backup operation. If the specified file already exists, it will be truncated. If this option is not specified, no log file is written. When you specify this --logfile option, also specify a --logfile-log-level value other than OFF.
--logfile-log-level OFF | ERROR | WARN | INFO | DEBUG | TRACE
Specify the logging level for a given log file (as defined with the --logfile option). If the level is not specified, it defaults to the --log-level value. You must specify a --logfile-log-level value other than OFF when you specify the --logfile option.
Specify a unique name for this backup snapshot. The name must be no greater than 64 characters. Directory paths are not allowed. For example:
--name sept6_2019_premdb_weekly_cumu
The backup name must contain only the following valid ASCII characters:
  • A-Z
  • a-z
  • 0-9
  • _

Mixed-case names are allowed, and the backup storage file system must support Linux-style mixed-case file names.

The --name value in the ybbackup command corresponds to the snapshot_name in the output for ybbackupctl commands.

-p, --port
Specify the database server port. Alternatively, set this value with the YBPORT environment variable. Default: 5432
-q, --quiet
Do not write any output to the screen. This option is suitable for cron invocations. If this option is specified, you must also specify --logfile.
--rollback-to-snapshot | --no-rollback-to-snapshot
Allow the database to be rolled back to the snapshot created by this backup, which must be a full or cumulative backup. This option does not apply to incremental backups. The default is no rollback. See Rolling Back to a Full or Cumulative Backup.

When you specify this option, database storage is not reclaimed until a new backup is taken that also specifies --rollback-to-snapshot.

Use SSL/TLS to secure all communications. The default is not secured. See also Enabling SSL/TLS Encryption.
-U, --username
Specify the database user running the backup. Alternatively, set this value with the YBUSER environment variable.
Return the software version for the backup tools.
-W, --password
Request an interactive prompt for the database user's password. Do not enter a password on the command line if you use this option. For non-interactive password entry, set the YBPASSWORD environment variable.