Skip to main content

Restore a DB2 Database​

Select

SaaS
Customer Managed

This operation is used to Restore a DB2 Backupset

Request Body
  • taskInfo object required
  • associations object[] required
  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer required

    ID of the backupset

  • _type_ string required
  • instanceId integer required

    ID of the instance

  • backupsetGUID string
  • clientId integer required

    ID of the client

  • appName string

    DB2

  • backupsetName string
  • applicationId integer required

    Possible values: [37, 62]

    application ID for DB2 Unix is 62 and application ID for DB2 windows is 37

  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string

    It will be in the format of InstanceName/BackupsetName

  • commCellId integer
  • task object required
  • taskType integer required

    1 for backup / restore

  • initiatedFrom integer
  • subTasks object[] required
  • subTask object required
  • subTaskType integer required

    3 for restore

  • operationType integer required

    1001 for inplace / out of place restore , 1005 for restore to disk

  • options object
  • restoreOptions object required
  • browseOption object
  • commCellId integer
  • timeRange object

    pass this if you to browse based on specific timestamps

  • fromTime integer

    start timestamp

  • toTime integer

    end timestamp

  • mediaOption object
  • mediaAgent object

    Pass this object to restore data from specific media agent

  • mediaAgentId integer

    Pass ID of media agent from which data should be restored

  • destination object

    destination client details

  • destClient object
  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer

    destination backupset ID (necessary only for Inplace restore)

  • _type_ integer
  • instanceId integer

    Destination instance ID

  • backupsetGUID string
  • clientId integer

    Destination Client ID

  • appName string

    DB2

  • backupsetName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string
  • commCellId integer
  • destinationInstance object

    Details of destination instance

  • clientName string
  • instanceName string
  • displayName string
  • backupsetId integer

    ID of the destination backupset (pass only if the backupset is already present in command center)

  • _type_ integer
  • instanceId integer

    Destination Instance ID

  • instanceGUID string
  • backupsetGUID string
  • clientId integer

    Destination client ID

  • appName string

    DB2

  • backupsetName string
  • applicationId integer
  • entityInfo object
  • companyId integer
  • companyName string
  • multiCommcellId integer
  • isDefaultBackupSet boolean
  • entityName string
  • commCellId integer
  • selected boolean

    True for out of place restore , False for inplace restore

  • destPath string[]

    Use this to pass destination path where backup image should be restored in case of restore to disk

  • oracleOpt object
  • fileOption object
  • sourceItem string[]

    Pass the tablespaces to restore , pass the job id's in case of Restore to disk

  • impersonation object

    pass this object if you want to impersonate user

  • impersonateUserName string

    username of user you want to impersonate

  • impersonatePassword string

    password of the user

  • impersonation boolean

    True if you are trying to impersonate else False

  • commonOptions object
  • restoreToDisk boolean

    True if you are doing restore to disk

  • indexFreeRestore boolean

    True in case of restore to disk

  • jobIds integer[]

    Pass jobid's in case of restore to disk

  • db2Option object required
  • rollForward boolean

    True if you want to rollforward DB

  • rollForwardPending boolean

    True if you want to leave DB in rollforward pending mode

  • rollForwardTime object

    pass this object if you to rollforward to a specific point in time

  • time integer

    Timestamp until which DB should be rollforwarded

  • rollForwardToEnd integer

    Possible values: [1, 0]

    1 if you are rollforwarding DB to end of logs else 0

  • useAlternateLogFile boolean

    True if you want to pass alternate log file path

  • alternateLogFile string

    Pass the alternate log file path using this parameter

  • rollForwardDir string

    pass the overflow log directory using this parameter

  • restoreArchiveLogs boolean

    True if you want to do log restore

  • logTimeStart boolean

    True if mentioned starting timestamp of log restore

  • logTimeEnd boolean

    True if mentioned ending timestamp for log restore

  • archiveLogTime boolean

    True if you want to restore logs based on timestamp

  • logTimeRange object

    pass this object to pass log restore timestamps

  • fromTime integer

    Starting timestamp

  • toTime integer

    Ending timestamp

  • useLogTarget boolean

    True if you want to use log target option

  • useLatestImage boolean

    True if you want to use latest backup image

  • redirect boolean

    True if you want to redirect tablespaces or storage groups

  • restoreData boolean

    True if you to want to restore data

  • recoverDb boolean

    True if you to want to recover DB (only applicable for inplace)

  • useSnapRestore boolean

    True if you want to do snap restore

  • restoreIncremental boolean
  • restoreType integer

    0 for full db restore , 1 for subset restore

  • restoreOnline boolean

    True for subset restore , False for full db restore

  • targetDb string

    Target DB name for restore

  • targetPath string

    pass DB path where it should be created if target DB is not present inside client

  • storagePath boolean
  • redirectAllTableSpacesSelected boolean
  • redirectAllItemsSelected boolean
  • redirectItemsPresent boolean

    True if you to redirect

  • redirectInfo string[]

    pass the tablespaces and the path where you want them to redirect

  • redirectStorageGroups boolean

    True if you want to redirect storage groups

  • storageGroupInfo object

    pass this object with storage groups to redirect

  • storageGroup object[]

    pass storage group objects

  • groupName string

    storage group name

  • stoPaths string[]

    path to redirect storage group

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    True if you want to get notified post job completion

  • prePostOpts object

    pass this object if you want to execute any pre or post commands

  • preRecoveryCommand string

    path to pre recovery command file

  • postRecoveryCommand string

    path to post recovery command file

  • runPostWhenFail boolean

    True if you want to run post recovery command even if job fails

  • impersonation object

    pass this object if you want to impersonate user to run pre and post recovery commands

  • level integer
  • user object

    pass user details in this object for pre post command user impersonation

  • userName string

    Username

  • password string

    Base64 encoded Password

  • confirmPassword string

    Confirm password

Responses

OK

Schema
  • taskId integer
  • jobIds string[]
POST /createtask

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "taskInfo": {

    "associations": [

      {

        "clientName": "string",

        "instanceName": "string",

        "displayName": "string",

        "backupsetId": 0,

        "_type_": "string",

        "instanceId": 0,

        "backupsetGUID": "string",

        "clientId": 0,

        "appName": "string",

        "backupsetName": "string",

        "applicationId": 37,

        "entityInfo": {

          "companyId": 0,

          "companyName": "string",

          "multiCommcellId": 0

        },

        "isDefaultBackupSet": true,

        "entityName": "string",

        "commCellId": 0

      }

    ],

    "task": {

      "taskType": 0,

      "initiatedFrom": 0

    },

    "subTasks": [

      {

        "subTask": {

          "subTaskType": 0,

          "operationType": 0

        },

        "options": {

          "restoreOptions": {

            "browseOption": {

              "commCellId": 0,

              "timeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "mediaOption": {

                "mediaAgent": {

                  "mediaAgentId": 0

                }

              }

            },

            "destination": {

              "destClient": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "_type_": 0,

                "instanceId": 0,

                "backupsetGUID": "string",

                "clientId": 0,

                "appName": "string",

                "backupsetName": "string",

                "applicationId": 0,

                "entityInfo": {

                  "companyId": 0,

                  "companyName": "string",

                  "multiCommcellId": 0

                },

                "isDefaultBackupSet": true,

                "entityName": "string",

                "commCellId": 0

              },

              "destinationInstance": {

                "clientName": "string",

                "instanceName": "string",

                "displayName": "string",

                "backupsetId": 0,

                "_type_": 0,

                "instanceId": 0,

                "instanceGUID": "string",

                "backupsetGUID": "string",

                "clientId": 0,

                "appName": "string",

                "backupsetName": "string",

                "applicationId": 0,

                "entityInfo": {

                  "companyId": 0,

                  "companyName": "string",

                  "multiCommcellId": 0

                },

                "isDefaultBackupSet": true,

                "entityName": "string",

                "commCellId": 0,

                "selected": true

              },

              "destPath": [

                "string"

              ]

            },

            "oracleOpt": {},

            "fileOption": {

              "sourceItem": [

                "string"

              ]

            },

            "impersonation": {

              "impersonateUserName": "string",

              "impersonatePassword": "string",

              "impersonation": true

            },

            "commonOptions": {

              "restoreToDisk": true,

              "indexFreeRestore": true

            },

            "jobIds": [

              0

            ],

            "db2Option": {

              "rollForward": true,

              "rollForwardPending": true,

              "rollForwardTime": {

                "time": 0

              },

              "rollForwardToEnd": 1,

              "useAlternateLogFile": true,

              "alternateLogFile": "string",

              "rollForwardDir": "string",

              "restoreArchiveLogs": true,

              "logTimeStart": true,

              "logTimeEnd": true,

              "archiveLogTime": true,

              "logTimeRange": {

                "fromTime": 0,

                "toTime": 0

              },

              "useLogTarget": true,

              "useLatestImage": true,

              "redirect": true,

              "restoreData": true,

              "recoverDb": true,

              "useSnapRestore": true,

              "restoreIncremental": true,

              "restoreType": 0,

              "restoreOnline": true,

              "targetDb": "string",

              "targetPath": "string",

              "storagePath": true,

              "redirectAllTableSpacesSelected": true,

              "redirectAllItemsSelected": true,

              "redirectItemsPresent": true,

              "redirectInfo": [

                "string"

              ],

              "redirectStorageGroups": true,

              "storageGroupInfo": {

                "storageGroup": [

                  {

                    "groupName": "string",

                    "stoPaths": [

                      "string"

                    ]

                  }

                ]

              }

            }

          },

          "commonOpts": {

            "notifyUserOnJobCompletion": true,

            "prePostOpts": {

              "preRecoveryCommand": "string",

              "postRecoveryCommand": "string",

              "runPostWhenFail": true,

              "impersonation": {

                "level": 0,

                "user": {

                  "userName": "string",

                  "password": "string",

                  "confirmPassword": "string"

                }

              }

            }

          }

        }

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/createtask' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "taskInfo": {
    "associations": [
      {
        "clientName": "string",
        "instanceName": "string",
        "displayName": "string",
        "backupsetId": 0,
        "_type_": "string",
        "instanceId": 0,
        "backupsetGUID": "string",
        "clientId": 0,
        "appName": "string",
        "backupsetName": "string",
        "applicationId": 37,
        "entityInfo": {
          "companyId": 0,
          "companyName": "string",
          "multiCommcellId": 0
        },
        "isDefaultBackupSet": true,
        "entityName": "string",
        "commCellId": 0
      }
    ],
    "task": {
      "taskType": 0,
      "initiatedFrom": 0
    },
    "subTasks": [
      {
        "subTask": {
          "subTaskType": 0,
          "operationType": 0
        },
        "options": {
          "restoreOptions": {
            "browseOption": {
              "commCellId": 0,
              "timeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "mediaOption": {
                "mediaAgent": {
                  "mediaAgentId": 0
                }
              }
            },
            "destination": {
              "destClient": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "_type_": 0,
                "instanceId": 0,
                "backupsetGUID": "string",
                "clientId": 0,
                "appName": "string",
                "backupsetName": "string",
                "applicationId": 0,
                "entityInfo": {
                  "companyId": 0,
                  "companyName": "string",
                  "multiCommcellId": 0
                },
                "isDefaultBackupSet": true,
                "entityName": "string",
                "commCellId": 0
              },
              "destinationInstance": {
                "clientName": "string",
                "instanceName": "string",
                "displayName": "string",
                "backupsetId": 0,
                "_type_": 0,
                "instanceId": 0,
                "instanceGUID": "string",
                "backupsetGUID": "string",
                "clientId": 0,
                "appName": "string",
                "backupsetName": "string",
                "applicationId": 0,
                "entityInfo": {
                  "companyId": 0,
                  "companyName": "string",
                  "multiCommcellId": 0
                },
                "isDefaultBackupSet": true,
                "entityName": "string",
                "commCellId": 0,
                "selected": true
              },
              "destPath": [
                "string"
              ]
            },
            "oracleOpt": {},
            "fileOption": {
              "sourceItem": [
                "string"
              ]
            },
            "impersonation": {
              "impersonateUserName": "string",
              "impersonatePassword": "string",
              "impersonation": true
            },
            "commonOptions": {
              "restoreToDisk": true,
              "indexFreeRestore": true
            },
            "jobIds": [
              0
            ],
            "db2Option": {
              "rollForward": true,
              "rollForwardPending": true,
              "rollForwardTime": {
                "time": 0
              },
              "rollForwardToEnd": 1,
              "useAlternateLogFile": true,
              "alternateLogFile": "string",
              "rollForwardDir": "string",
              "restoreArchiveLogs": true,
              "logTimeStart": true,
              "logTimeEnd": true,
              "archiveLogTime": true,
              "logTimeRange": {
                "fromTime": 0,
                "toTime": 0
              },
              "useLogTarget": true,
              "useLatestImage": true,
              "redirect": true,
              "restoreData": true,
              "recoverDb": true,
              "useSnapRestore": true,
              "restoreIncremental": true,
              "restoreType": 0,
              "restoreOnline": true,
              "targetDb": "string",
              "targetPath": "string",
              "storagePath": true,
              "redirectAllTableSpacesSelected": true,
              "redirectAllItemsSelected": true,
              "redirectItemsPresent": true,
              "redirectInfo": [
                "string"
              ],
              "redirectStorageGroups": true,
              "storageGroupInfo": {
                "storageGroup": [
                  {
                    "groupName": "string",
                    "stoPaths": [
                      "string"
                    ]
                  }
                ]
              }
            }
          },
          "commonOpts": {
            "notifyUserOnJobCompletion": true,
            "prePostOpts": {
              "preRecoveryCommand": "string",
              "postRecoveryCommand": "string",
              "runPostWhenFail": true,
              "impersonation": {
                "level": 0,
                "user": {
                  "userName": "string",
                  "password": "string",
                  "confirmPassword": "string"
                }
              }
            }
          }
        }
      }
    ]
  }
}'