Configuring Required VBR Parameters

To invoke the vbr utility to create a configuration file, enter this command:

> /opt/vertica/bin/vbr --setupconfig

The utility prompts you to answer the following questions. Each is followed by its default value, if any exists. Type Enter to accept a default value.

The second table column lists the name of the parameter associated with the question, as it appears in the configuration file.

Setupconfig Prompt Parameter Name
Snapshot name: (backup_snapshot)
snapshotName
Number of restore points? (1):
restorePointLimit
Specify objects (no default):
objects
Object restore mode (coexist, createOrReplace or create)(createOrReplace):
objectRestoreMode
Vertica user name (current user):
dbUser
Save password to avoid runtime prompt (n) [y/n]
dbPromptForPassword
Database user password to save in vbr password 
config file (no default):
          
dbPassword
Backup host name (no default):
Backup host
Backup directory (no default):
Backup directory
Config file name (backup_snapshot.ini):
N/A
Password file name (no default):
PasswordFile
Change advanced settings? (n) [y/n]:
N/A

To change any advanced parameters, respond to the last question, Change advanced settings? by entering y.

After you successfully complete all of the required questions, vbr generates a configuration file with the information you supplied. Create separate configuration files for a full backup and each object-level backup. Use distinct backup names in each configuration file.

When the setup completes processing, enter a configuration file name. Use this file name when you run the --task backup or other commands. The utility uses the configuration file contents for both backup and restore tasks, and also for the --copycluster task.

If you do not successfully complete all of the required questions, vbr lists error messages and hints but does not create a configuration file. You can then run the --setupconfig command again to specify any missing or incorrect information.

Sample Session Configuring Required Parameters

The following sample test session shows the required configuration file parameters needed to create a configuration file. The utility detects the Vertica node names in the cluster, so you do not have to supply them (v_example_node0001, v_example_node0002, and v_exampledb_node0003):

> /opt/vertica/bin/vbr --setupconfig
Snapshot name (snapshotName): ExampleBackup
Backup Vertica configurations? (n) [y/n] y
Number of restore points? (1): 5
Specify objects (no default): dim, dim2
Object restore mode (coexist, createOrReplace or create) (createOrReplace): coexist
Vertica user name (current_user): dbadmin
Save password to avoid runtime prompt? (n)[y/n]: y
Database user password to save in vbr password config file (no default): mypw234
Node v_example_node0001
Backup host name (no default): backup01
Backup directory (no default): /home/dbadmin/backups
Node v_exampledb_node0002
Backup host name: backup02
Backup directory: /home/dbadmin/backups
Node v_exampledb_node0003
Backup host name: backup03
Backup directory: /home/dbadmin/backups
Config file name: exampleBackup.ini
Password file name:StoredPasswords
Change advanced settings? (n)[y/n]: n
Saved vbr configuration to ExampleBackup.ini.

See Also

Related Tasks