Skip to main content

Oracle Restore Options​

Select

SaaS
Customer Managed

This operation is used to perform Oracle Restores

Request Body
  • taskInfo object
  • task object
  • taskType required

    Possible values: [IMMEDIATE, SCHEDULE, SCHEDULE_POLICY, SAVED_REPORT]

  • associations object[]
  • clientName string required

    Source Client Name

  • displayName string

    Client display Name

  • instanceName string required

    Source Instance Name

  • appName string

    Oracle

  • subTasks object[]
  • subTask object
  • subTaskType string

    RESTORE

  • operationType string

    RESTORE

  • options object
  • restoreOptions object
  • browseOption object
  • commCellId integer

    Default value: 2

  • mediaOption object
  • mediaAgent object

    Select specific mediaagent for restore job

  • mediaAgentId integer

    Media Agent ID

  • timeRange object

    Browse time range

  • toTime integer
  • destination object
  • destClient object required

    Client details for restore

  • clientName string required

    Client Name of destination client

  • displayName string

    Display Name of destination client

  • destinationInstance object required
  • instanceName string

    Destination Instance Name

  • appName string

    Default value: Oracle

  • clientName string

    Destination client Name

  • displayName string

    Destination display name.

  • destPath string[]

    The destination path for restore to disk

  • oracleOpt object
  • restoreControlFile boolean

    Enable this option if you want the control file to be restored

  • restoreSPFile boolean

    Enable this option to restore SP file.

  • restoreData boolean

    Enable this option to restore datafiles

  • restoreFrom

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

    Select database state to be restored from given options Default - Point in Time

  • recover boolean

    Enable this option to run recovery

  • recoverFrom

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

    Select database state to be recovered to from given options

  • recoverSCN integer

    The SCN to recover the database to.

  • ctrlBackupPiece string

    Name of the control backup piece

  • specifyControlFileTime boolean

    Enable this option for Point-in-time restores

  • ControlFileTime object

    Relevant for point-in-time restores

  • time integer

    Specify the point in time to restore controlfile from

  • recoverTime object

    Relevant for PIT restores

  • time integer

    Specify the point in time to recover the database to

  • restoreTime object

    Relevant for point in time restores

  • time integer

    Point in Time to restore files

  • noCatalog boolean

    Set to false if recovery catalog is configured

  • restoreStream integer

    Default value: 2

    Number of restore streams

  • resetLogs integer

    Default value: 1

    Set to 1 to resetlogs

  • duplicateToLogFilesList string

    List of redo log volumes to be created

  • duplicateToLogFile boolean

    Set to true to create redo logs

  • redirectItemsPresent boolean

    Set to true if some datafiles being restored need to be redirected

  • duplicateToLogFilesListValue string[]

    List of redo log files to be created

  • redirectItems string[]

    List of files are to be redirected

  • logFileGroup boolean

    Set to true to redirect redo logs

  • redirectItemsValue string[]

    List of redirect file paths

  • redirectAllItemsSelected boolean

    Set to true if you want to redirect all datafiles to a single path

  • renamePathForAllTablespaces string

    Path to Redirect all datafiles / Redirect all PDBs for PDB Clone

  • switchDatabaseMode boolean

    Set to true to switch initital mode of destination database to appropriate mode for restore

  • redirectTempFilesSelected boolean

    Set to true to redirect temp datafiles

  • redirectTempFilesValue string

    Path to which redirect temp file must be redirected

  • restoreWallet boolean

    Set to true to restore Oracle wallet for cross machine restores

  • crossmachineRestoreOptions object

    Relevant for cross machine restores

  • doNidForCrossMachineRestore boolean

    Default value: true

  • setDBId boolean

    Default value: true

    Set to true for Crossmachine Restores

  • duplicateNoFileNamecheck boolean

    Set to true for cross machine restores

  • archiveLog boolean

    Set to true to restore archivelogs

  • logTarget string

    Directory where the archivelogs are to be restored

  • archivelLogBy

    Possible values: [DEFAULT, BYLSN, BYTIME]

    Select parameter to restore archivelogs

  • logTime object

    Set logTime if archiveLogBy is set to BYTIME

  • fromTime integer

    Start Time for picking archivelogs

  • toTime integer

    From time for archive logs

  • useStartLog boolean

    Enable useStartLog if you want to filter archivelogs by a start time

  • useEndLog boolean

    Enable useEndLog if you want to filter archivelogs by a end time

  • useStartLSNNum boolean

    Enable to filter archivelogs by start SCN

  • startLSNNum integer

    Enter start SCN to select archive logs

  • useEndLSNNum boolean

    Enable to filter archivelogs by End SCN

  • endLSNNum integer

    Enter End SCN to select archive logs

  • duplicate boolean

    Set to true for RMAN duplicate

  • duplicateStandby boolean

    Set to true to create standby database

  • duplicateTo boolean

    Set to true for duplicateTo

  • duplicateToName string

    Name of destination instance to duplicate to.

  • duplicateStandbySID string

    Default value: dup

  • duplicateStandbyDoRecover boolean

    Default value: false

  • partialRestore boolean

    Set to true for database partial restores

  • 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

  • databaseName string

    Name of user-created auxiliary instance

  • importToWhere

    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

  • tableViewRestore boolean

    Set to true for table level restore

  • 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

  • openDatabase boolean

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

  • 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...