| Task Request Information | |||
| Description | Field Name | Data Type | Commandline Parameter |
| Task | task | ||
| Type | taskType | enum | taskType |
| Initiated From | initiatedFrom | enum | initiatedFrom |
| Task Flags | taskFlags | ||
| Disabled | disabled | boolean | disabled |
| Common Job Options | |||
| Description | Field Name | Data Type | Commandline Parameter |
| StartUp Options | startUpOpts | ||
| Startup in suspended state | startInSuspendedState | boolean | startInSuspendedState |
| Priority | priority | integer | priority |
| Use Default Priority | useDefaultPriority | boolean | useDefaultPriority |
| Restore Job Options | |||
| Description | Field Name | Data Type | Commandline Parameter |
| Browse Option | browseOption | ||
| Comm Cell Id | commCellId | integer | commCellId |
| Restore deleted items | noImage | boolean | noImage |
| List Media | listMedia | boolean | listMedia |
| Backupset | backupset | ||
| Backupset Name | backupsetName | string | backupset/backupsetName (b) |
| Client Name | clientName | string | backupset/clientName (c) |
| Media Option | mediaOption | ||
| Copy Precedence | mediaOption/copyPrecedence | ||
| Restore from copy precedence | copyPrecedenceApplicable | boolean | copyPrecedenceApplicable |
| Copy Precedence Type | copyPrecedenceType | enum | copyPrecedenceType |
| Synchronous Copy Precedence | synchronousCopyPrecedence | integer | synchronousCopyPrecedence |
| Copy Precedence | copyPrecedence | integer | copyPrecedence/copyPrecedence |
| Time Zone | browseOption/timeZone | ||
| Time Zone Name | TimeZoneName | string | browseOption/timeZone/TimeZoneName |
| Restore Destination | destination | ||
| Destination client | destClient | ||
| Client Name | clientName | string | destClient/clientName (c) |
| Destination Instance | destinationInstance | ||
| Instance Name | instanceName | string | destinationInstance/instanceName (i) |
| App Name | appName | string | destinationInstance/appName (a) |
| Client Name | clientName | string | destinationInstance/clientName (c) |
| DB2 Restore Option | db2Option | ||
| Restore Type | restoreType | enum | restoreType |
| Redirect | redirect | boolean | redirect |
| Leave in Roll-forward Pending State | rollForwardPending | boolean | rollForwardPending |
| Restore Log Files | restoreArchiveLogs | boolean | restoreArchiveLogs |
| Roll-forward (Reapply the Logs) | rollForward | boolean | rollForward |
| Restore Incremental | restoreIncremental | boolean | restoreIncremental |
| Archive Log LSN | archiveLogLSN | boolean | archiveLogLSN |
| Archive Log Time | archiveLogTime | boolean | archiveLogTime |
| Start: | startLSN | boolean | startLSN |
| End: | endLSN | boolean | endLSN |
| Start: | logTimeStart | boolean | logTimeStart |
| End: | logTimeEnd | boolean | logTimeEnd |
| Roll Forward To End | rollForwardToEnd | enum | rollForwardToEnd |
| Alternate Log Path: | useAlternateLogFile | boolean | useAlternateLogFile |
| Restore Data | restoreData | boolean | restoreData |
| Online Restore | restoreOnline | boolean | restoreOnline |
| Target Db | targetDb | string | targetDb |
| Buffers | buffers | integer | buffers |
| Buffer Size | bufferSize | integer | bufferSize |
| Start LSNNum | startLSNNum | integer | startLSNNum |
| End LSNNum | endLSNNum | integer | endLSNNum |
| Recover DB | recoverDb | boolean | recoverDb |
| History File Path | dbHistoryFilepath | boolean | dbHistoryFilepath |
| Specify Storage paths | storagePath | boolean | storagePath |
| Time Zone | db2Option/timeZone | ||
| Time Zone Name | TimeZoneName | string | db2Option/timeZone/TimeZoneName |
| Restore Common Options | commonOptions | ||
| Automatically Detect Regular Expressions | detectRegularExpression | boolean | detectRegularExpression |
| Wild Card | wildCard | boolean | wildCard |
| Power Restore | powerRestore | boolean | powerRestore |
| System State Backup | systemStateBackup | boolean | systemStateBackup |
| One Pass Restore | onePassRestore | boolean | onePassRestore |
| Use hardware revert capability if available | revert | boolean | revert |
| Cluster DBBackedup | clusterDBBackedup | boolean | clusterDBBackedup |
| SubTask Options | |||
| Description | Field Name | Data Type | Commandline Parameter |
| Sub Task Type | subTaskType | enum | subTaskType (st) |
| Operation Type | operationType | enum | operationType (op) |
| Associations | |||
| Description | Field Name | Data Type | Commandline Parameter |
| Backupset Name | backupsetName | string | associations/backupsetName (b) |
| Subclient Name | subclientName | string | subclientName (s) |
| Client Name | clientName | string | associations/clientName (c) |
| App Name | appName | string | associations/appName (a) |
| Instance Name | instanceName | string | associations/instanceName (i) |
| Task Request Information | |
| Task | |
| taskType | Home |
| Type: enum Default Value: IMMEDIATE Possible Values: NONE , IMMEDIATE , SCHEDULE , SAVED_REPORT , SCHEDULE_POLICY , WORKFLOW , PREVIEW , AUTOMATIC_COPY , AGENTLESS_SRM , AGENTLESS_SRM Command Line Paramter: taskType Location: taskInfo/task/taskType | |
| Type | |
| initiatedFrom | Home |
| Type: enum Default Value: GUI Possible Values: NONE , GUI , COMMANDLINE , SYSTEM , SCRIPT , SCHEDULE , SCHEDULE Command Line Paramter: initiatedFrom Location: taskInfo/task/initiatedFrom | |
| Initiated From | |
| Task Flags | |
| disabled | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: disabled Location: taskInfo/task/taskFlags/disabled | |
| Disabled | |
| Common Job Options | |
| StartUp Options | |
| startInSuspendedState | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: startInSuspendedState Location: taskInfo/subTasks/options/commonOpts/startUpOpts/startInSuspendedState | |
| Startup in suspended state | |
| priority | Home |
| Type: integer Command Line Paramter: priority Location: taskInfo/subTasks/options/commonOpts/startUpOpts/priority | |
| Priority | |
| useDefaultPriority | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: useDefaultPriority Location: taskInfo/subTasks/options/commonOpts/startUpOpts/useDefaultPriority | |
| Use Default Priority | |
| Restore Job Options | |
| Browse Option | |
| commCellId | Home |
| Type: integer Command Line Paramter: commCellId Location: taskInfo/subTasks/options/restoreOptions/browseOption/commCellId | |
| Comm Cell Id | |
| noImage | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: noImage Location: taskInfo/subTasks/options/restoreOptions/browseOption/noImage | |
| Restore deleted items | |
| listMedia | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: listMedia Location: taskInfo/subTasks/options/restoreOptions/browseOption/listMedia | |
| List Media | |
| Backupset | |
| backupsetName | Home |
| Type: string Command Line Paramter: backupset/backupsetName Location: taskInfo/subTasks/options/restoreOptions/browseOption/backupset/backupsetName | |
| Backupset Name | |
| clientName | Home |
| Type: string Command Line Paramter: backupset/clientName Location: taskInfo/subTasks/options/restoreOptions/browseOption/backupset/clientName | |
| Client Name | |
| Media Option | |
| Copy Precedence | |
| copyPrecedenceApplicable | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: copyPrecedenceApplicable Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedenceApplicable | |
| Restore from copy precedence | |
| copyPrecedenceType | Home |
| Type: enum Default Value: SYNCHRONOUS Possible Values: SYNCHRONOUS , SELECTIVE , SELECTIVE Command Line Paramter: copyPrecedenceType Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedenceType | |
| Copy Precedence Type | |
| synchronousCopyPrecedence | Home |
| Type: integer Command Line Paramter: synchronousCopyPrecedence Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/synchronousCopyPrecedence | |
| Synchronous Copy Precedence | |
| copyPrecedence | Home |
| Type: integer Command Line Paramter: copyPrecedence/copyPrecedence Location: taskInfo/subTasks/options/restoreOptions/browseOption/mediaOption/copyPrecedence/copyPrecedence | |
| Copy Precedence | |
| Time Zone | |
| TimeZoneName | Home |
| Type: string Command Line Paramter: browseOption/timeZone/TimeZoneName Location: taskInfo/subTasks/options/restoreOptions/browseOption/timeZone/TimeZoneName | |
| Time Zone Name | |
| Restore Destination | |
| Destination client | |
| clientName | Home |
| Type: string Command Line Paramter: destClient/clientName Location: taskInfo/subTasks/options/restoreOptions/destination/destClient/clientName | |
| Client Name | |
| Destination Instance | |
| instanceName | Home |
| Type: string Command Line Paramter: destinationInstance/instanceName Location: taskInfo/subTasks/options/restoreOptions/destination/destinationInstance/instanceName | |
| Instance Name | |
| appName | Home |
| Type: string Command Line Paramter: destinationInstance/appName Location: taskInfo/subTasks/options/restoreOptions/destination/destinationInstance/appName | |
| App Name | |
| clientName | Home |
| Type: string Command Line Paramter: destinationInstance/clientName Location: taskInfo/subTasks/options/restoreOptions/destination/destinationInstance/clientName | |
| Client Name | |
| DB2 Restore Option | |
| restoreType | Home |
| Type: enum Default Value: ENTIREDB Possible Values: ENTIREDB , PARTIALDB , HISTORYFILE , HISTORYFILE Command Line Paramter: restoreType Location: taskInfo/subTasks/options/restoreOptions/db2Option/restoreType | |
| Restore Type | |
| redirect | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: redirect Location: taskInfo/subTasks/options/restoreOptions/db2Option/redirect | |
| Redirect | |
| rollForwardPending | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: rollForwardPending Location: taskInfo/subTasks/options/restoreOptions/db2Option/rollForwardPending | |
| Leave in Roll-forward Pending State | |
| restoreArchiveLogs | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: restoreArchiveLogs Location: taskInfo/subTasks/options/restoreOptions/db2Option/restoreArchiveLogs | |
| Restore Log Files | |
| rollForward | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: rollForward Location: taskInfo/subTasks/options/restoreOptions/db2Option/rollForward | |
| Roll-forward (Reapply the Logs) | |
| restoreIncremental | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: restoreIncremental Location: taskInfo/subTasks/options/restoreOptions/db2Option/restoreIncremental | |
| Restore Incremental | |
| archiveLogLSN | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: archiveLogLSN Location: taskInfo/subTasks/options/restoreOptions/db2Option/archiveLogLSN | |
| Archive Log LSN | |
| archiveLogTime | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: archiveLogTime Location: taskInfo/subTasks/options/restoreOptions/db2Option/archiveLogTime | |
| Archive Log Time | |
| startLSN | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: startLSN Location: taskInfo/subTasks/options/restoreOptions/db2Option/startLSN | |
| Start: | |
| endLSN | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: endLSN Location: taskInfo/subTasks/options/restoreOptions/db2Option/endLSN | |
| End: | |
| logTimeStart | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: logTimeStart Location: taskInfo/subTasks/options/restoreOptions/db2Option/logTimeStart | |
| Start: | |
| logTimeEnd | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: logTimeEnd Location: taskInfo/subTasks/options/restoreOptions/db2Option/logTimeEnd | |
| End: | |
| rollForwardToEnd | Home |
| Type: enum Default Value: TO_END Possible Values: TO_TIME , TO_END , TO_END Command Line Paramter: rollForwardToEnd Location: taskInfo/subTasks/options/restoreOptions/db2Option/rollForwardToEnd | |
| Roll Forward To End | |
| useAlternateLogFile | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: useAlternateLogFile Location: taskInfo/subTasks/options/restoreOptions/db2Option/useAlternateLogFile | |
| Alternate Log Path: | |
| restoreData | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: restoreData Location: taskInfo/subTasks/options/restoreOptions/db2Option/restoreData | |
| Restore Data | |
| restoreOnline | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: restoreOnline Location: taskInfo/subTasks/options/restoreOptions/db2Option/restoreOnline | |
| Online Restore | |
| targetDb | Home |
| Type: string Command Line Paramter: targetDb Location: taskInfo/subTasks/options/restoreOptions/db2Option/targetDb | |
| Target Db | |
| buffers | Home |
| Type: integer Default Value: 2 Command Line Paramter: buffers Location: taskInfo/subTasks/options/restoreOptions/db2Option/buffers | |
| Buffers | |
| bufferSize | Home |
| Type: integer Default Value: 1024 Command Line Paramter: bufferSize Location: taskInfo/subTasks/options/restoreOptions/db2Option/bufferSize | |
| Buffer Size | |
| startLSNNum | Home |
| Type: integer Default Value: 1 Command Line Paramter: startLSNNum Location: taskInfo/subTasks/options/restoreOptions/db2Option/startLSNNum | |
| Start LSNNum | |
| endLSNNum | Home |
| Type: integer Default Value: 1 Command Line Paramter: endLSNNum Location: taskInfo/subTasks/options/restoreOptions/db2Option/endLSNNum | |
| End LSNNum | |
| recoverDb | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: recoverDb Location: taskInfo/subTasks/options/restoreOptions/db2Option/recoverDb | |
| Recover DB | |
| dbHistoryFilepath | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: dbHistoryFilepath Location: taskInfo/subTasks/options/restoreOptions/db2Option/dbHistoryFilepath | |
| History File Path | |
| storagePath | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: storagePath Location: taskInfo/subTasks/options/restoreOptions/db2Option/storagePath | |
| Specify Storage paths | |
| Time Zone | |
| TimeZoneName | Home |
| Type: string Command Line Paramter: db2Option/timeZone/TimeZoneName Location: taskInfo/subTasks/options/restoreOptions/db2Option/timeZone/TimeZoneName | |
| Time Zone Name | |
| Restore Common Options | |
| detectRegularExpression | Home |
| Type: boolean Default Value: true Possible Values: true/false Command Line Paramter: detectRegularExpression Location: taskInfo/subTasks/options/restoreOptions/commonOptions/detectRegularExpression | |
| Automatically Detect Regular Expressions | |
| wildCard | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: wildCard Location: taskInfo/subTasks/options/restoreOptions/commonOptions/wildCard | |
| Wild Card | |
| powerRestore | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: powerRestore Location: taskInfo/subTasks/options/restoreOptions/commonOptions/powerRestore | |
| Power Restore | |
| systemStateBackup | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: systemStateBackup Location: taskInfo/subTasks/options/restoreOptions/commonOptions/systemStateBackup | |
| System State Backup | |
| onePassRestore | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: onePassRestore Location: taskInfo/subTasks/options/restoreOptions/commonOptions/onePassRestore | |
| One Pass Restore | |
| revert | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: revert Location: taskInfo/subTasks/options/restoreOptions/commonOptions/revert | |
| Use hardware revert capability if available | |
| clusterDBBackedup | Home |
| Type: boolean Possible Values: true/false Command Line Paramter: clusterDBBackedup Location: taskInfo/subTasks/options/restoreOptions/commonOptions/clusterDBBackedup | |
| Cluster DBBackedup | |
| SubTask Options | |
| subTaskType | Home |
| Type: enum Possible Values: NONE , ADMIN , BACKUP , RESTORE , WORKFLOW , COMPLIANCE_POLICY , COMPLIANCE_POLICY Command Line Paramter: subTaskType Location: taskInfo/subTasks/subTask/subTaskType | |
| Sub Task Type | |
| operationType | Home |
| Type: enum Default Value: NONE Possible Values: NONE , ALL_BACKUP_JOBS , BACKUP , RECOVERY_POINT_CREATION , CONSISTENTCY_POINT_CREATION , SRM , ARCHIVE , CONTENT_INDEXING , ALL_RESTORE_JOBS , RESTORE , POWER_RESTORE , BROWSE , RESTORE_BY_JOB , ONETOUCH_RECOVERY , ADMIN , WORK_FLOW , COMPLIANCE , SEARCH , SAVE , EMAIL , TAGGING , LEGAL_HOLDS , COMP_RESTORE , MOSS , PRUNE , DRBACKUP , AUX_COPY , REPORT , MEDIA_INVENTORY , SCHED_EXPORT , ARCHIVE_CHECK , MEDIA_PREDICTION , TAPE_ERASE , VT , SELECTIVE_DELETE , DRIVE_VALIDATION , DRIVE_CLEANING , STAMP_MEDIA , BROWSE_DELETE , CATALOGUE_MEDIA , DATA_AGING , DOWNLOAD_UPDATES , INSTALL_UPDATES , SRM_REPORT , OFFLINE_CONTENT_INDEX , MAGLIBMAINTENANCE , SHELF_MANAGEMENT , INFOMGMT , INSTALL_CLIENT , UNINSTALL_CLIENT , SNAP_TO_TAPE , CCM_CAPTURE , CCM_MERGE , EXTERNAL_DATA_PROCESSOR , MEDIA_REFRESHING , PREPARATION , FDC , MAGLIBVOLRECON , DEDUPDBSYNC , TAPEIMPORT , WORKFLOW , QR , FS_BACKUP , IMAGE_BACKUP , SERVERLESS_BACKUP , MOUNT_SNAPSHOT , UNMOUNT_SNAPSHOT , DELETE_SNAPSHOT , MINING_BACKUP , SRM_AGENTLESS , SRM_AGENTLESS Command Line Paramter: operationType Location: taskInfo/subTasks/subTask/operationType | |
| Operation Type | |
| Associations | |
| backupsetName | Home |
| Type: string Command Line Paramter: associations/backupsetName Location: taskInfo/associations/backupsetName | |
| Backupset Name | |
| subclientName | Home |
| Type: string Command Line Paramter: subclientName Location: taskInfo/associations/subclientName | |
| Subclient Name | |
| clientName | Home |
| Type: string Command Line Paramter: associations/clientName Location: taskInfo/associations/clientName | |
| Client Name | |
| appName | Home |
| Type: string Command Line Paramter: associations/appName Location: taskInfo/associations/appName | |
| App Name | |
| instanceName | Home |
| Type: string Command Line Paramter: associations/instanceName Location: taskInfo/associations/instanceName | |
| Instance Name | |