Backup Object Manager command options

Edit online

Use the following options together with Backup Object Manager commands.

  • -a database alias or -a original database alias,target database alias. Denotes the name of the database for which an operation is requested. For a redirected restore to a different database or of database cloning, the database aliases of both the original and the target databases must be specified and separated by a comma. When a redirected restore is requested that specifies a single database alias, the database is restored to the original database.
  • -b buffer size Denotes the size of DB2® backup or restore buffers, in 4-KB allocation units (pages). The minimum is eight units. The buffer size is limited by the memory available.
  • -B number of buffers Denotes the number of DB2 buffers to be used for backup or restore. The minimum number is 2. The number of buffers is limited by the available memory.
  • -C If specified for a redirected restore, this option indicates that the Backup Object Manager is to run only a test of the setup but not start copying data.
  • -d destination directory Denotes the destination path for restoring a file to the file system.
  • -D target database directory For a redirected restore, this option denotes the fully qualified name of the target database directory. This command option is ignored when the database alias of the target database is the same as the database alias of the original database.
  • -e execution profile Denotes the complete path of the IBM Storage Protect™ for Enterprise Resource Planning for DB2 profile to be used with the Backup Object Manager. This option overrides the profile name that is set in the XINT_PROFILE environment variable.
  • -f file name Denotes the name of a file in the file system. Unless the file denotes a TDI image, the following wildcard characters are accepted: ??? denotes any single character. * denotes any number of any characters.
  • -i DB2 instance Used in query commands to limit the database or table space data to be displayed to a specific DB2 instance. With all other commands, this command option is used to override the DB2 instance name that is defined in the DB_INSTANCE environment variable.
  • -k log chain | log chain range where log chain range = chain1 - chain2. Denotes the log chain number or numbers of DB2 log file or files. DB2 log chains can be specified either in the format Cnnnnnnn, where nnnnnnn is a string of seven decimal digits or in the format mmmmmmm, where mmmmmmm is a string of up to seven decimal digits that denote the log chain number.
  • -l log number | log number range where log number range = log number 1 - log number 2 Denotes the log serial numbers of DB2 log files. DB2 log numbers can be specified either in the format Snnnnnnn.log (DB2 log file name), where nnnnnnn is a string of seven decimal digits, or in the format mmmmmmm, where mmmmmmm is a string of up to seven decimal digits that denote the log serial number.
  • -L If specified for a database backup, the DB2 log files are saved to IBM Storage Protect with the database backup.
  • -m output mode where output mode = short | normal | detailed denotes the detail of information that is requested with a query command. The default is short for information that is related to DB2 log files, normal for all other kinds of information.

    If you must override the default values generally, you might set environment variables FULL_OUTPUT (for information about database backups), TABLESPACE_OUTPUT (for information about table space backups) and LOG_OUTPUT (for information about DB2 log file backups) to the values wanted.

  • -N If specified, this command option causes all containers of a table space to be allocated with the same size during a redirected restore.
  • -n node number Denotes the DB2 node number. For the password command in a DB2 partitioned environment: If for only one DB2 node/partition the password must be set/changed, specify the command option -n node number. If the node/partition number is not specified, the new password is saved to all available node/partitioned based Data Protection for SAP configuration files. For all other commands: If the node number is not specified, node NODE0000 is assumed.
  • -o If specified for a backup, DB2 is requested to optimize the format of the backup images for target storage devices that support data deduplication.
  • -O If specified when you request a backup or table space restore operation, an online backup or an online table space restore is run.
  • -p password The password of the user ID specified in option -u.
  • -P parallelism Denotes the degree of parallelism within DB2, which is the number of buffer manipulator processes reading from or writing to table spaces at the same time. The minimum parallelism is 1. The maximum is 1024.
  • -R backup type where backup type = full | incremental | delta . Denotes the type of backup requested. If no backup type is specified, a full backup is done.
  • -S sessionsDenotes the number of I/O sessions that are to be started by DB2. The value of this command option must be less than or equal to the value of the keyword MAX_SESSIONS in the Data Protection for SAP profile.
  • -s scaling factor Denotes the positive floating point factor to be used for resizing all containers of a table space during redirected restore. The default is 1, indicating that the new table space is exactly the size of the original.
  • -t timestamp | time range where time range = timestamp1-timestamp2 Denotes the time when a backup object was created. For database and table space backups, this time stamp matches the time stamp that is listed in the DB2 Recovery History File. It consists of 14 decimal digits and has the format: yyyymmddhhmmss where yyyy is the year; mm is the month of the year, 01 - 12; dd is the day of the month, 01 - 31; hh is the hour of the day, 00 - 23; mm is the minute of the hour, 00 - 59; ss is the second of the minute, 00 - 59. For restore commands, an exact time stamp must be given. For query and delete commands, a time range can be specified, or the time stamp can contain wildcard characters. The following wildcard characters are accepted:
    • ? denotes any single digit
    • * denotes any number of any digits.
    If a time stamp is not specified for a query, the result contains all eligible backup object available on the IBM Storage Protect server. If a time stamp is not specified for a restore, the newest object is retrieved from IBM Storage Protect.
  • -T tablespace list where tablespace list = tablespace[,tablespace list] For a backup request, denotes the names of the table space or spaces to be backed up. Table space names are separated by commas. If there is no table space list that is specified, a full database backup is done.
  • -u userid Denotes the DB2 user ID used for backing up or restoring a DB2 database, table space, or recovery history file if it is different from the current login user ID.
  • -v If set, all log messages are displayed on STDOUT.
  • -x If specified, this option suppresses all confirmation requests. Otherwise, confirmation requests are sought for restore commands that would overwrite existing data, and for delete requests.

    With the -c password option, -x causes the password to be changed on all database partitions.