The following table lists the supported DB2 MultiNode backup and restore parameters.
Parameter |
Description of Parameter Values |
---|---|
appName |
The name of the application. Windows: DB2 UNIX: DB2 on Unix |
backupsetName |
The name of the client computer, as displayed in the CommCell Console where the instance is located. |
clientName |
The name of the DB2 MultiNode instance. |
instanceName |
The backup set name. |
backupLevel |
The type of backup to restore. Valid values are:
|
jobDescription |
The job description. |
postRecoveryCommand |
The command that is run after the restore job. |
preRecoveryCommand |
The command that is run before the restore job |
runPostWhenFail |
Run the post restore command regardless of the success of the restore job. Valid values are:
|
priority |
The priority of the job. The highest priority is zero and the lowest priority is 999. Range: 0-999 |
startInSuspendedState |
The option to start the job in a suspended state. The suspended job cannot run until it is manually resumed. Valid values are:
|
backupsetName |
The name of the backup set. |
clientName |
The name of the client computer. |
commCellId |
The CommCell ID of the CommServe. The valid value is 2. |
listMedia |
The list media operation must display media associated with the most recent data protection operation (from now back to the last full backup). Valid values are:
|
copyPrecedence |
The backup copy precedence. |
copyPrecedenceApplicable |
Use a backup copy for the restore. Valid values are:
|
drive |
The name of the drive in the pool that performs the restore. |
drivePool |
The name of the drive pool that performs the restore. Use this option to restore by using a specific drive. |
library |
The name of the library that performs the restore. Use this option to restore by using a specific library. |
mediaAgent |
The name of the MediaAgent that performs the restore. |
proxyForSnapClients/clientName |
The proxy client that is used for IntelliSnap. |
noImage |
Restore the deleted files. Valid values are:
|
timeRange |
The time range to use for the listMedia option. |
timeZone |
The time zone to use for the listMedia option. |
useExactIndex |
This is available in UNIX configurations. You can associate the media with the most recent index in the CommCell Console. Valid values are:
|
clusterDBBackedup |
This parameter indicates that the backup is for a clustered environment. Valid values are:
|
detectRegularExpression |
The option to use regular expressions in defining source paths. Valid values are:
|
isFromBrowseBackup |
The option to restore from a browsed backup. Valid values are:
|
onePassRestore |
The option to restore from OnePass. Valid values are:
|
recoverAllProtectedMails |
The option to recover all protected emails. Valid values are:
|
restoreDeviceFilesAsRegularFiles |
The option to restore the device files as regular files. Valid values are:
|
restoreSpaceRestrictions |
Valid values are:
|
restoreToDisk |
The option to restore the file to a disk (perform an application free restore). Valid values are:
|
revert |
The option to perform a revert. Valid values are:
|
restoreType |
The data to restore. Valid values are:
|
redirect |
The option to redirect the restore. Valid values are:
|
rollForwardPending |
The option to leave the database in a roll-forward pending state after the restore. Valid values are:
|
restoreArchiveLogs |
The option to restore the archive logs. Valid values are:
|
rollForward |
The option to reapply the log files that are required to complete the restore for partitions that have this capability. Valid values are:
|
restoreIncremental |
Valid values are:
|
archiveLogLSN |
The option to reapply the logs to the log serial number (LSN). Valid values are:
|
archiveLogTime |
The option to reapply the logs to the time. Valid values are:
|
startLSN |
Valid values are:
|
endLSN |
Valid values are:
|
rollForwardToEnd |
The option to use to reapply the logs. Valid values are:
|
useAlternateLogFile |
Valid values are:
|
restoreData |
Restore the database. Valid values are:
|
restoreOnline |
Perform the restore when the database is online. Valid values are:
|
targetDB |
The destination database name. You must use this parameter when you perform an in-place restore and you specify this parameter on the command line. You can use the source backup set name for this value. |
targetPath |
The path for destination database on the destination client. |
buffers |
The number of buffers to use for the restore. |
bufferSize |
The size of the buffer. |
timeStamps |
The time stamp entry for each node when the rollForwardToEnd element is set to TO_TIME. The format is: YYYYMMDDHHMMSS, 1, 1, 0, 0 NODE X where X is the node partition number. You must have an entry for each node. |
startLSNNum |
This is the first Log Serial number when you restore the log files by using the Log Serial Number. |
endLSNNum |
This is the last Log Serial number when you restore the log files by using the Log Serial Number. |
alternateLogFile |
Restore and reapply the log files to this directory. |
rollForwardDir |
The path to the overflow directory that contains the logs |
historyFilePath |
The path to the history file. |
recoverDB |
The option to recover the database. Valid values are:
|
timeZone/timeZoneName |
The point-in-time restore time zone name, for example (GMT-05:00) Eastern Time (US & Canada). |
storagePath |
The option to specify the storage paths for an automatic database. Valid values are:
|
storagePaths |
The storage path for an automatic database. |
parallelism |
The number of simultaneous queries to use for the restore. |
useSnapRestore |
Perform a IntelliSnap restore. Valid values are:
|
useLatestImage |
Restore from the latest backup image. Valid values are:
|
tableViewRestore |
Perform a table restore. Valid values are:
|
useLogTarget |
Restore the logs from the backup image (use LogTarget). Valid values are:
|
cloneRecovery |
Clone the database. Valid values are:
|
restoreToDisk |
Restore the backup to a disk. Valid values are:
|
syncRestore |
Valid values are:
|
destClient/clientName |
The name of the destination client. |
destInstance/appName |
The name of the destination client application. Windows: DB2 UNIX: DB2 on Unix |
destClient/instanceName |
The name of the DB2 destination instance. |
destClient/databaseName |
The name of the DB2 destination database. |
operationType |
The type of task. Valid values are:
|
subTaskType |
The sub task. Valid values are:
|
alertName |
The name of the alert that is used for the restore job. |
initiatedFrom |
Where the restore is initialed from (for example CommCell Console, or command line). A valid value is COMMANDLINE. |
policyType |
The storage policy type. A valid value is DATA_PROTECTION. |
taskType |
The time the task runs (for example, immediate) A valid value is IMMEDIATE. |