Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBROracleDatabaseRestore

Short Description

Starts Oracle database restore.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides 2 parameter sets.

  • For restoring to original location:

Start-VBROracleDatabaseRestore -Database <VBROracleDatabase> [-GuestCredentials <CInternalCredentials>] [-OracleExplicitPassword <string>] [-OracleCredentials <CInternalCredentials>] [-ToPointInTime <datetime>] [-Force] [-Wait]  [<CommonParameters>]

  • For restoring to another location:

Start-VBROracleDatabaseRestore -Database <VBROracleDatabase> [-ServerName <string>] [-HomePath <string>] [-DatabaseGlobalName <string>] [-DatabaseSid <string>] [-GuestCredentials <CInternalCredentials>] [-OracleExplicitPassword <string>] [-OracleCredentials <CInternalCredentials>] [-ToPointInTime <datetime>] [-Force] [-Wait]  [<CommonParameters>]

Detailed Description

This cmdlet starts restore of a selected Oracle database.

Start-VBROracleDatabaseRestore Note:

The OracleExplicitPassword parameter is no longer required. The OracleCredentials parameter must be used instead.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Database

Specifies the database you want to restore.

Accepts VBROracleDatabase type.

True

Named

True (ByValue,
ByProperty
Name)

False

DatabaseGlobalName

Used for restoring to another location. Specifies the new global name for the database you restore.

False

Named

False

False

DatabaseSid

Used for restoring to another location. Specifies the new SID for the database you restore.

False

Named

False

False

HomePath

Used for restoring to another location. Specifies the name of the Oracle Home on target for the database you restore.

False

Named

False

False

ServerName

Used for restoring to another location. Specifies the target server. The database will be restored to that server.

False

Named

False

False

OracleCredentials

Used for restoring Oracle Database 12c or later on Windows server.

Specifies the Oracle Home User account credentials. The cmdlet will use these credentials for starting Oracle Services on the VM guest OS.

If not set, the cmdlet will start the service using the Windows Built-in Account or Virtual Account credentials.

False

Named

False

False

GuestCredentials

Specifies the user credentials to authenticate with the guest OS of the target server.

If not set, the cmdlet will first try to use credentials specified in the backup job settings, then credentials of a current account.

False

Named

False

False

OracleExplicitPassword

This parameter is deprecated. Use OracleCredentials instead.

False

Named

False

False

ToPointInTime

Used to restore the database to a specific point in time.

Specifies the point in time to restore to. Redo logs replay will bring the database to the state as of at that moment.

False

Named

False

False

Force

If set, the command will overwrite the existing database with the database from the backup.

Note: the cmdlet will show no prompt.

False

Named

False

False

Wait

Indicates that the command waits for the process to complete before accepting more input.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRSession

Example

This example shows how to restore the Oracle 12c database to a selected point in time to the original location.

  1. Get the database you want to restore: run Get-VBRApplicationRestorePoint to get the restore points of the "oracle_prod" VM created with application-aware processing. Save the result to the $restorepoint variable.

PS C:\PS> $restorepoint = Get-VBRApplicationRestorePoint -Oracle -Name "oracle_prod"

Select the needed restore point (with index [2] in this example) and run Get-VBROracleDatabase for it to get the database named "Products". Save the result to the $products_db variable.

PS C:\PS> $locations = Get-VBROracleDatabase -ApplicationRestorePoint $restorepoint[2] -Name "Products"

  1. Get the credentials to connect to the server guest OS (Windows in this example) and to the Oracle database. For that:
  • Run Get-VBRCredentials to get the credentials to authenticate with the target Windows server. Save the result to the $guestcreds variable.
  • Run Get-VBRCredentials to get the Oracle Home User account credentials. Save the result to the $oraclehomecreds variable.

PS C:\PS> $guestcreds = Get-VBRCredentials -Name "tech\administrator"

PS C:\PS> $oraclehomecreds = Get-VBRCredentials -Name "oracleuser1"

  1. Run Get-VBROracleDatabaseRestoreInterval to check the available restore interval. You can then select a point in time (within that interval) to restore the database to.

PS C:\PS> Get-VBROracleDatabaseRestoreInterval -Database $locations

  1. Run Start-VBROracleDatabaseRestore with the saved variables.

PS C:\PS> Start-VBROracleDatabaseRestore -Database $locations -GuestCredentials $guestcreds -OracleCredentials $oraclehomecreds -ToPointInTime "10/28/2015 12:33:39 PM"

Related Commands

Get-VBROracleDatabase

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation