---
title: "Restore-VEORIRDatabase"
description: "Performs instant recovery of a backed-up Oracle database. Product: Veeam Backup & Replication Product Edition: Enterprise, Enterprise Plus, Veeam Universal License This cmdlet performs instant recovery of a backed-up Oracle database."
canonical: "https://helpcenter.veeam.com/docs/vbr/explorers_powershell/restore-veorirdatabase.html"
breadcrumb: "Veeam Explorers PowerShell Reference > Veeam Explorers PowerShell Reference > Veeam Explorer for Oracle > Restore-VEORIRDatabase"
dateModified: "2026-08-20"
---

# 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](https://helpcenter.veeam.com/docs/vbr/userguide/veor_ir.html?ver=13) section of the Veeam Explorers User Guide.

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Database</span></p>
        </td>
        <td>
          <p>Specifies an Oracle database that the cmdlet will restore.</p><p>Accepts the <a href="veordatabase.md"><code>VEORDatabase</code></a> object. To get this object, run the <a href="get-veordatabase.md"><code>Get-VEORDatabase</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="veordatabase.md"><code>VEORDatabase</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>0</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">File</span></p>
        </td>
        <td>
          <p>Specifies an array of Oracle database files.</p><p>Accepts the <a href="veordatabasefile.md"><code>VEORDatabaseFile</code></a><code>[]</code> object. To get this object, run the <a href="get-veordatabasefile.md"><code>Get-VEORDatabaseFile</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="veordatabasefile.md"><code>VEORDatabaseFile[]</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will overwrite the existing Oracle database with the database from the backup.</p><p><strong>Note</strong>: The cmdlet will show no prompt before executing the command.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">GlobalDatabaseName</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies the global database name. The cmdlet will restore an Oracle database with the specified name.</p><p><strong>Note</strong>: Do not provide this parameter if you want to restore to the original location.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">LinuxCredentials</span></p>
        </td>
        <td>
          <p>For restore to a Linux machine.</p><p>Specifies Linux credentials that the cmdlet will use to connect to a Linux machine.</p><p>Accepts the <a href="veorlinuxcredential.md"><code>VEORLinuxCredential</code></a> object. To get this object, run the<a href="new-veorlinuxcredential.md"><code> New-VEORLinuxCredential</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="veorlinuxcredential.md"><code>VEORLinuxCredential</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">OracleHome</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies the target Oracle home path. The cmdlet will restore an Oracle database to the location specified in the Oracle home path.</p><p><strong>Note</strong>: Do not provide this parameter if you want to restore to the original location.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">OracleHomePassword</span></p>
        </td>
        <td>
          <p>For restoring Oracle Database 12c or later on Windows server.</p><p>Specifies Oracle home credentials that the cmdlet will use for starting Oracle Services on the guest OS.</p><p><strong>Note</strong>: This parameter is required in case you use the following types of Oracle home User:</p><ul><li>Existing Windows user.</li><li>New Windows user.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">OracleSid</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies a new SID for an Oracle database. The cmdlet will restore the database with the specified SID.</p><p><strong>Note</strong>: Do not provide this parameter if you want to restore to the original location.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Server</span></p>
        </td>
        <td>
          <p>For restore to another server.</p><p>Specifies DNS name or IP address of the target server to which the database will be restored.</p><p><strong>Note</strong>: Do not provide this parameter if you want to restore to the original server.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SshPort</span></p>
        </td>
        <td>
          <p>For restore to a Linux machine.</p><p>Specifies the SSH port number that the cmdlet will use to connect to the Linux machine.</p><p>Default: <em>22</em></p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SwitchOverOptions</span></p>
        </td>
        <td>
          <p>Specifies a switchover option: <code>Auto</code>, <code>Manual</code> or <code>Scheduled</code>.</p><p>Accepts the <a href="veorirschedule.md"><code>VEORIRSchedule</code></a> object. To get this object, run the <a href="new-veorirswitchoveroptions.md"><code>New-VEORIRSwitchOverOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="veorirschedule.md"><code>VEORIRSchedule</code></a></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">TargetPath</span></p>
        </td>
        <td>
          <p>Specifies the target path array. The cmdlet will restore the Oracle database files to the locations specified in the array.</p><p><strong>Note</strong>: You must assign a specific file path for each Oracle database file.</p>
        </td>
        <td style="width:10%;">
          <p><code>String[]</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ToPointInTimeUTC</span></p>
        </td>
        <td>
          <p>Specifies a point in time in the UTC format within the restore interval of an Oracle database.</p><p>The cmdlet will restore the database to the state of the specified point in time.</p>
        </td>
        <td style="width:10%;">
          <p><code>DateTime</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">WindowsCredentials</span></p>
        </td>
        <td>
          <p>For restore to a Windows machine.</p><p>Specifies Windows credentials that the cmdlet will use to connect to a Windows machine.</p><p>Accepts the <code>PSCredential</code> object. To get this object, run the [`Get-Credential`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential) cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>PSCredential</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the [About Common Parameters](http://go.microsoft.com/fwlink/p/?LinkID=113216) section of Microsoft Learn.

## Output Object
The cmdlet returns the [`VEORIRDatabase`](veorirdatabase.md) object that contains the Oracle database published within the instant recovery session.

## Examples

::: example
### 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:

1. Run the [`Get-Date`](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/get-date) cmdlet and specify the date and time when the switchover must be performed. Save the result to the `$time` variable.
2. Convert the scheduled time to the UTC format using the `ToUniversalTime()` method. Save the result to the `$TimeUtc` variable.
3. Run the [`New-VEORIRSwitchOverOptions`](new-veorirswitchoveroptions.md) cmdlet. Provide the `Scheduled` parameter and specify the `SwitchingTimeUtc` parameter value. Save the result to the `$ScheduledSwitch` variable.
4. Run the [`Get-VEORRestoreSession`](get-veorrestoresession.md) 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).

5. Run the [`Get-VEORDatabase`](get-veordatabase.md) 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.
6. Run the `Restore-VEORIRDatabase` cmdlet. Set the `$database` variable as the `Database` parameter value. Set the `$ScheduledSwitch` variable as the `SwitchOverOptions` parameter value.

:::

::: example
### 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`](switch-veorirdatabase.md) 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:

1. Run the [`Get-VBRApplicationRestorePoint`](https://helpcenter.veeam.com/docs/vbr/powershell/get-vbrapplicationrestorepoint.html?ver=13) cmdlet. Specify the `Id` parameter value. Save the result to the `$restore` variable.
2. Run the [`Start-VEORRestoreSession`](start-veorrestoresession.md) cmdlet. Set the `$restore` variable as the `RestorePoint` parameter value. Save the result to the `$session` variable.
3. Run the [`Get-VEORDatabase`](get-veordatabase.md) cmdlet. Set the `$session` variable as the `Session` `parameter` value. Specify the `Name` parameter. Save the result to the `$db` variable.
4. Run the [`New-VEORIRSwitchOverOptions`](new-veorirswitchoveroptions.md) cmdlet. Provide the `Manual` parameter. Save the result in the `$ManualSwitch` variable.
5. Run the [`Read-Host`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host) cmdlet. Specify the `Prompt` parameter value. Provide the `AsSecureString` parameter. Save the result to the `$securepassword` variable.
6. Run the [`New-VEORLinuxCredential`](new-veorlinuxcredential.md) 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.
7. 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.

8. Run the `Switch-VEORIRDatabase` cmdlet. Set the `$IRDatabase` variable as the `Database` parameter value.

:::

## Related Commands

- [`New-VEORIRSwitchOverOptions`](new-veorirswitchoveroptions.md)
- [`Get-VEORDatabase`](get-veordatabase.md)
- [``Get-Credential``](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.security/get-credential)
- [`New-VEORLinuxCredential`](new-veorlinuxcredential.md)
- [``Read-Host``](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host)
- [`Switch-VEORIRDatabase`](switch-veorirdatabase.md)