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.
-a, --all
Note: This option is deprecated in Version 2.0. Yellowbrick Data recommends that you use the --objects option instead.
Back up all databases on the Yellowbrick appliance. You must specify this option, the -d option, or the --objects option. The --objects option is recommended.
--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.

-d, --databases
Note: This option is deprecated in Version 2.0. Yellowbrick Data recommends that you use the --objects option instead.
Name one or more databases to back up. You must specify this option or the -a option. Specify a list as shown in the following examples, with or without commas. Spaces after commas are optional:
-d premdb, yellowbrick, newone
--databases premdb yellowbrick newone
Alternatively, you can specify -d or --databases more than once in the same command. For example:
-d premdb -d yellowbrick
--description
Add descriptive text to the backup for reference purposes. The description is returned when you run the ybbackup-list command.
Note: The description must be enclosed in quotes and must be no longer than 255 characters.
--dirs
Storage location for the backup files. See also ybbackup-list Command. You must specify one path to one directory. Multiple directory locations are not supported. Relative paths are allowed. For example:
--dirs /home/brumsby/backups
--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.
--dryrun
Do a dry run of the backup to check that your configuration options are valid; do not actually create any backup files or save any data.
-?, --help
Return help text for all of the ybbackup options.
-h, --host
The database server host. Alternatively, you can set this value with the YBHOST environment variable. Defaults to localhost.
--java-version
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.
--name
Name for this backup chain. The name must be no greater than 64 characters. Directory paths are not allowed. For example:
--name nov_2018
When the backup is run, this name is appended as a directory name to the backup storage location. The backup files are stored in subdirectories under that location. For example if the storage location is /home/brumsby/backups and the backup chain is nov_2018, the backup files will be stored in:
/home/brumsby/backups/nov_2018

A backup chain may contain backups for different iterations of the same database with different database IDs. You can drop and re-create a database with the same name and back it up into the same location and chain.

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.

--nodata
Back up only the metadata for the named databases. Use this option when you want to capture the DDL, but not the data in the tables. An empty database can be restored for testing on another system or under a different database name. (Yellowbrick Customer Support engineers sometimes ask customers to run a "no-data backup" and ship the backup bundle to Yellowbrick.)
-o, --objects
Specify one or more databases that you want to back up. For example:
--objects newpremdb
--objects premdb, yellowbrick
Note: You may want to run separate backups for different databases. It may be easier to keep track of backups that contain isolated databases and have distinctly named backup chains.
-W, --password
Interactively 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.
-p, --port
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.
--secured
Use SSL/TLS to secure all communications. The default is not secured. See also Enabling SSL/TLS Encryption.
-U, --username
Database user running the backup. Alternatively, set this value with the YBUSER environment variable.
--version
Return the software version for the backup tools.