Restore-VEORIRDatabase

Short Description

Performs instant recovery of a backed-up Oracle database.

Product: Veeam Backup & Replication

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Restore-VEORIRDatabase [-Database] <VEORDatabase> [-Server <String>] [-OracleHome <String>]

[-GlobalDatabaseName <String>] [-OracleSid <String>] [-WindowsCredentials <PSCredential>]

[-OracleHomePassword <SecureString>] [-LinuxCredentials <VEORLinuxCredential>] [-SshPort <Int32>]

[-ToPointInTimeUTC <DateTime>] [-File <VEORDatabaseFile[]>] [-TargetPath <String[]>]

-SwitchOverOptions <VEORIRSchedule> [-Force] [<CommonParameters>]

Detailed Description

This cmdlet performs instant recovery of a backed-up Oracle database. You can recover the database to the original location or to another location. For details, see the Instant Recovery section of the Veeam Explorers User Guide.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Database	Specifies an Oracle database that the cmdlet will restore. Accepts the `VEORDatabase` object. To get this object, run the `Get-VEORDatabase` cmdlet.	`VEORDatabase`	True	0	True (ByValue)
File	Specifies an array of Oracle database files. Accepts the `VEORDatabaseFile[]` object. To get this object, run the `Get-VEORDatabaseFile` cmdlet.	`VEORDatabaseFile[]`	False	Named	False
Force	Defines that the cmdlet will overwrite the existing Oracle database with the database from the backup. Note: The cmdlet will show no prompt before executing the command.	`SwitchParameter`	False	Named	False
GlobalDatabaseName	For restore to another location. Specifies the global database name. The cmdlet will restore an Oracle database with the specified name. Note: Do not provide this parameter if you want to restore to the original location.	`String`	False	Named	False
LinuxCredentials	For restore to a Linux machine. Specifies Linux credentials that the cmdlet will use to connect to a Linux machine. Accepts the `VEORLinuxCredential` object. To get this object, run the `New-VEORLinuxCredential` cmdlet.	`VEORLinuxCredential`	False	Named	False
OracleHome	For restore to another location. Specifies the target Oracle home path. The cmdlet will restore an Oracle database to the location specified in the Oracle home path. Note: Do not provide this parameter if you want to restore to the original location.	`String`	False	Named	False
OracleHomePassword	For restoring Oracle Database 12c or later on Windows server. Specifies Oracle home credentials that the cmdlet will use for starting Oracle Services on the guest OS. Note: This parameter is required in case you use the following types of Oracle home User: Existing Windows user. New Windows user.	`SecureString`	False	Named	False
OracleSid	For restore to another location. Specifies a new SID for an Oracle database. The cmdlet will restore the database with the specified SID. Note: Do not provide this parameter if you want to restore to the original location.	`String`	False	Named	False
Server	For restore to another server. Specifies DNS name or IP address of the target server to which the database will be restored. Note: Do not provide this parameter if you want to restore to the original server.	`String`	False	Named	False
SshPort	For restore to a Linux machine. Specifies the SSH port number that the cmdlet will use to connect to the Linux machine. Default: 22	`Int32`	False	Named	False
SwitchOverOptions	Specifies a switchover option: `Auto`, `Manual` or `Scheduled`. Accepts the `VEORIRSchedule` object. To get this object, run the `New-VEORIRSwitchOverOptions` cmdlet.	`VEORIRSchedule`	True	Named	True (ByValue)
TargetPath	Specifies the target path array. The cmdlet will restore the Oracle database files to the locations specified in the array. Note: You must assign a specific file path for each Oracle database file.	`String[]`	False	Named	False
ToPointInTimeUTC	Specifies a point in time in the UTC format within the restore interval of an Oracle database. The cmdlet will restore the database to the state of the specified point in time.	`DateTime`	False	Named	False
WindowsCredentials	For restore to a Windows machine. Specifies Windows credentials that the cmdlet will use to connect to a Windows machine. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Output Object

The cmdlet returns the VEORIRDatabase object that contains the Oracle database published within the instant recovery session.

Examples

Restore-VEORIRDatabase Example 1. Performing Instant Recovery of Oracle Database to Original Location with Scheduled Switchover

This example shows how to perform instant recovery of the orcl database to the original location using the scheduled switchover option. The cmdlet will perform the switchover at 13:00:00 on 2026-11-24.

$time = Get-Date -Date "2026-11-24 13:00:00"

$TimeUtc = $time.ToUniversalTime()

$ScheduledSwitch = New-VEORIRSwitchOverOptions -Scheduled -SwitchingTimeUtc $TimeUtc

$session = Get-VEORRestoreSession

$database = Get-VEORDatabase -Session $session[0] -Name "orcl"

Restore-VEORIRDatabase -Database $database -SwitchOverOptions $ScheduledSwitch

Perform the following steps:

Run the Get-Date cmdlet and specify the date and time when the switchover must be performed. Save the result to the $time variable.
Convert the scheduled time to the UTC format using the ToUniversalTime() method. Save the result to the $TimeUtc variable.
Run the New-VEORIRSwitchOverOptions cmdlet. Provide the Scheduled parameter and specify the SwitchingTimeUtc parameter value. Save the result to the $ScheduledSwitch variable.
Run the Get-VEORRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the first restore session in the array).
Run the Get-VEORDatabase cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Specify the Name parameter value. Save the result to the $database variable.
Run the Restore-VEORIRDatabase cmdlet. Set the $database variable as the Database parameter value. Set the $ScheduledSwitch variable as the SwitchOverOptions parameter value.

Restore-VEORIRDatabase Example 2. Performing Instant Recovery of Oracle Database to Specific Server with Manual Switchover

This example shows how to perform instant recovery of the orcl database to its latest state with the following settings:

The cmdlet will restore the database to the linorcl01 target server.
The cmdlet will restore an Oracle database with the orcl_published.tech.local global database name.
The cmdlet will restore the database with the orclpub SID.
The cmdlet will restore an Oracle database to the /home/oracle/app/oracle/product/19.3.0/db_home_2 Oracle home path.
To perform the switchover operation manually, you must run the Switch-VEORIRDatabase cmdlet.

$restore = Get-VBRApplicationRestorePoint -Id fa4de91d-a493-41a8-88f7-1e29b0ab838d

$session = Start-VEORRestoreSession -RestorePoint $restore

$db = Get-VEORDatabase -Session $session -Name "orcl"

$ManualSwitch = New-VEORIRSwitchOverOptions -Manual

$securepassword = Read-Host -Prompt "Enter password" -AsSecureString

$linuxCredentials = New-VEORLinuxCredential -Account "oracle" -Password $securepassword -ElevateAccountToRoot

$IRDatabase = Restore-VEORIRDatabase -Database $db -SwitchOverOptions $ManualSwitch -Server "linorcl01" -OracleSid "orclpub" -GlobalDatabaseName "orcl_published.tech.local" -LinuxCredentials $linuxCredentials -OracleHome "/home/oracle/app/oracle/product/19.3.0/db_home_2" -Force

Switch-VEORIRDatabase -Database $IRDatabase

Perform the following steps:

Run the Get-VBRApplicationRestorePoint cmdlet. Specify the Id parameter value. Save the result to the $restore variable.
Run the Start-VEORRestoreSession cmdlet. Set the $restore variable as the RestorePoint parameter value. Save the result to the $session variable.
Run the Get-VEORDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter. Save the result to the $db variable.
Run the New-VEORIRSwitchOverOptions cmdlet. Provide the Manual parameter. Save the result in the $ManualSwitch variable.
Run the Read-Host cmdlet. Specify the Prompt parameter value. Provide the AsSecureString parameter. Save the result to the $securepassword variable.
Run the New-VEORLinuxCredential cmdlet. Specify the Account parameter value. Set the $securepassword variable as the Password parameter value. Provide the ElevateAccountToRoot parameter. Save the result to the $linuxCredentials variable.
Run the Restore-VEORIRDatabase cmdlet. Specify the following settings:
- Set the $db variable as the Database parameter value.
- Set the $ManualSwitch variable as the SwitchOverOptions parameter value.
- Specify the Server parameter value.
- Specify the OracleSid parameter value.
- Specify the GlobalDatabaseName parameter value.
- Set the $linuxCredentials variable as the LinuxCredentials parameter value.
- Specify the OracleHome parameter value.
- Provide the Force parameter.
Save the result to the $IRDatabase variable.
Run the Switch-VEORIRDatabase cmdlet. Set the $IRDatabase variable as the Database parameter value.