Skip to main content

Oracle DB Restore​

To restore an Oracle database

Request Body
  • taskInfo object
  • associations object[]
  • clientName string required

    Source Client Name

  • instanceName string required

    Source Instance Name

  • appName string

    Oracle

  • subTasks object[]
  • subTask object
  • subTaskType string required

    RESTORE

  • operationType string required

    RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • mediaOption object

    To use a specific Media option

  • mediaAgent object

    Select specific MediaAgent for restore job. Provide MediaAgentId or MediaAgentName

  • mediaAgentId integer

    Media Agent ID

  • mediaAgentName string

    Media Agent Name

  • destination object
  • destClient object required

    Destination Client

  • clientName string required

    Destination Client Name

  • destinationInstance object required
  • instanceName string required

    Destination Instance Name

  • appName string

    Default value: Oracle

    Oracle

  • clientName string required

    Destination client Name

  • destPath string[]

    The destination path for restore to disk operation

  • oracleOpt object
  • restoreSPFile boolean required

    Set this True to restore SPFILE

  • restoreControlFile boolean required

    Set this True to restore Control File

  • ctrlBackupPiece string

    Enter controlfile backuppiece to be used for restore. Leave it empty to auto pick relavent piece.

  • restoreData boolean required

    Set this to true to restore entire database i.e all tablespaces/datafiles.

  • restoreFrom string required

    Possible values: [0 - Latest Backup, 1 - Point in Time]

    Select point in time for restore database. Fill restoreTime value.

  • restoreTime object

    if restoreFrom=1, provide a timestamp for restore database.

  • time integer

    epoch timestamp value for PIT restore. It will be converted to Oracle RMAN syntax for restore database.

  • recover boolean required

    Set this to true to recover database by applying archive logs for given poin-in-time.

  • recoverFrom string required

    Possible values: [0 - Current Time, 1 - Point in Time, 2 - SCN, 3 - Most Recent Backup]

    Select recovery critieria. Use '0 - Current Time' only for in-place restores. For '3 - Most Recent Backup', no need to provide recoverSCN or recoverTime values.

  • recoverSCN integer required

    If using "2 - SCN" for recoverFrom, provide SCN value here.

  • recoverTime object required

    If using "1 - Point in Time" for recoverFrom field, provide timestamp

  • time integer required

    epoch timestamp value. It will be converted to Oracle RMAN syntax for recover database.

  • noCatalog boolean required

    Set to false to skip RMAN catalog usage during restore or if source never had recovery catalog.. Otherwise, RMAN restore will use source catalog configured in Commvault.

  • restoreStream integer

    Default value: 1

    Number of RMAN channels or streams to allocate for restore

  • switchDatabaseMode boolean required

    Set to true to change destination database mode automatically for restore

  • openDatabase boolean

    Default value: true

    Set to true to open the database post restore, applicable for pdbs too

  • resetLogs integer

    Default value: 1

    Set 1 to run "open resetlogs" after restore during open. When controlfile is restored along with database OR a PIT recovery is done, open resetlogs is required.

  • restoreWallet boolean

    Set to true to restore Oracle wallet for cross machine restores Applies to encrypted Oracle databases

  • sourceWalletIdentifier object

    If restoreWallet is set to true, supply source wallet password.

  • savedCredential object

    provide CredentialVault entity ID created for source database wallet password

  • credentialId integer

    Credential ID of type 'Database Encryption Key'

  • destinationWalletIdentifier object

    if restoreWallet is true, provide destination database wallet password

  • savedCredential object

    provide CredentialVault entity ID created for destination database wallet password

  • credentialId integer

    Credential ID of type 'Database Encryption Key'

  • redirectAllItemsSelected boolean

    Set to true if you want to redirect all datafiles to a single path. Enter the destination path in renamePathForAllTablespaces field.

  • renamePathForAllTablespaces string

    Path to Redirect all datafiles / Redirect all PDBs for PDB Clone. Example: +DATA, /u01/oracle/oradata/PRD/datafiles

  • redirectItemsPresent boolean

    Set to true if datafile level redirect is required. Provide values in redirectItems, redirectItemsValue.

  • redirectItems string[]

    List of files are to be redirected

  • redirectItemsValue string[]

    List of redirect file paths

  • logFileGroup boolean

    Set to true to redirect redo logs

  • duplicateToLogFile boolean

    Set to true to create redo logs

  • duplicateToLogFilesList string

    List of redo log volumes to be created

  • duplicateToLogFilesListValue string[]

    List of redo log files to be created

  • redirectTempFilesSelected boolean

    Set to true to redirect temp datafiles

  • redirectTempFilesValue string

    Path to which redirect temp file must be redirected

  • crossmachineRestoreOptions object

    Opions Restore to same SID cross machine

  • doNidForCrossMachineRestore boolean

    Default value: true

    set to true to change DBID via nid command post restore

  • setDBId boolean

    Default value: true

    Set to true to search controlfile autobackup with source DBID for cross machine restores.

  • archiveLog boolean

    Set to true to restore archivelogs instead of recover. 'recover' and 'restoreLog' are mutually exclusive. Enter log range by SCN/Seq#/Time in archiveLogBy and logTarget values.

  • logTarget string

    Target path to restore archivelogs on destination client.

  • archiveLogBy string

    Possible values: [BYLSN, BYTIME]

    Select archive log restore criteria. For BYTIME option, it requires useStartLog,logTime/fromTime for start range AND/OR set useEndLog,logTime/toTime to use end range. For BYLSN option, it requires useStartLSNNum,startLSNNum AND/OR useEndLSNNum,endLSNNum values to use LSn ranges.

  • useStartLog boolean

    set to true to supply logTime/fromTime for archive log range

  • useEndLog boolean

    set to true to supply logTime/toTime for archive log range

  • logTime object

    If archiveLogBy is set to BYTIME, enter fromTime and toTime of archive log range to be restored.

  • fromTime integer

    Enter epoch timestamp for archivelog range fromTime

  • toTime integer

    Enter epoch timestamp for archivelog range toTime

  • useStartLSNNum boolean

    set to true to supply startLSNNum

  • startLSNNum integer

    provide start log sequence number for range

  • useEndLSNNum boolean

    set to true to supply endLSNNum

  • endLSNNum integer

    provide end log sequence number for range

  • duplicate boolean

    Set to true for RMAN duplicate operation

  • duplicateTo boolean

    Set to true for duplicateTo

  • duplicateNoFileNamecheck boolean

    Set to true for cross machine restores

  • duplicateStandby boolean

    Set to true to create standby database

  • duplicateToName string

    RMAN duplicate operation destination instance name

  • duplicateStandbySID string

    Default value: dup

  • duplicateStandbyDoRecover boolean

    Default value: false

  • partialRestore boolean

    Set to true for database partial restores (PDB,Tablespace, Datafile)

  • stagingPath string

    Enter staging path for Partial database restore job/ Table level restore job/ PDB Clone

  • cleanupAuxiliary boolean

    Set to true to cleanup auxiliary

  • sourcePaths string[]

    Source Paths for oracle table restore / PDB Clone

  • auxiliaryInstance boolean

    Set to true for user created auxiliary for table level restores

  • tableViewRestore boolean

    Set to true for table level restore

  • databaseName string

    Name of user-created auxiliary instance to clone subset of database for exporting tables

  • importToWhere string

    Possible values: [IMPORT_TO_SOURCE, IMPORT_TO_ANOTHER, DO_NOT_IMPORT]

    Select relevant option to import tables to source database/a different database/create dumps only

  • importDatabase string

    Enter destination database name if IMPORT_TO_ANOTHER is selected

  • dropTable boolean

    Set to true to drop table if it exists at the destination during table restores

  • oracleTableRstOptions object

    Oracle table level restore options

  • includeTriggers boolean

    Default value: true

  • includeConstraints boolean

    Default value: true

  • includeIndexes boolean

    Default value: true

  • includeGrants boolean

    Default value: true

  • includeStoredProcedures boolean

    Default value: true

  • importDbClient object

    This section is relevant only for table restores

  • clientId string

    ClientId of destination client to import tables

  • clientName string

    Client name of destination client to import tables

  • displayName string

    Display name of destination client to import tables

  • oracleObjectRenameInfoList object[]

    PDB Clone Options

  • filename string

    Set to the staging path for pdb clone

  • commonOptions object
  • indexFreeRestore boolean

    Set to true for restore to disk

  • restoreToDisk boolean

    Set to true for Restore to disk

  • fileOption object
  • sourceItem string[]

    Files to be restored. Set it to the database SID for full database restore.

  • commonOpts object
  • notifyUserOnJobCompletion boolean

    Default value: true

Responses

OK

Schema
  • taskId integer
  • jobIds string[]
Loading...