---
title: "Restore-VESQLIRDatabase"
description: "Performs instant recovery of a backed-up Microsoft SQL Server database. Product: Veeam Backup & Replication Product Edition: Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet perfo"
canonical: "https://helpcenter.veeam.com/docs/vbr/explorers_powershell/restore-vesqlirdatabase.html"
breadcrumb: "Veeam Explorers PowerShell Reference > Veeam Explorers PowerShell Reference > Veeam Explorer for Microsoft SQL Server > Restore-VESQLIRDatabase"
dateModified: "2026-08-18"
---

# Restore-VESQLIRDatabase

## Short Description
Performs instant recovery of a backed-up Microsoft SQL Server database.

**Product**: Veeam Backup & Replication

**Product Edition**: Enterprise, Enterprise Plus, Veeam Universal License

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>RestoreUsingCredentialsFromVBR</code></p>

```
Restore-VESQLIRDatabase [-Database] <VESQLDatabase> [-DatabaseName <String>] [-ServerName <String>]
 [-InstanceName <String>] [-Port <Int32>] [-ToPointInTimeUtc <DateTime>] [-TargetFolder <String>]
 [-File <VESQLDatabaseFile[]>] [-TargetPath <String[]>] [-Force] -SwitchOverOptions <VESQLIRSwitchOverOptions> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>RestoreUsingCredentials</code></p>

```
Restore-VESQLIRDatabase [-Database] <VESQLDatabase> [-DatabaseName <String>] [-ServerName <String>]
 [-InstanceName <String>] [-Port <Int32>] -SqlCredentials <PSCredential> [-UseSQLAuthentication]
 [-GuestCredentials <PSCredential>] [-ToPointInTimeUtc <DateTime>] [-TargetFolder <String>]
 [-File <VESQLDatabaseFile[]>] [-TargetPath <String[]>] [-Force] -SwitchOverOptions <VESQLIRSwitchOverOptions> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>RestoreUsingGmsaAccount</code></p>

```
Restore-VESQLIRDatabase [-Database] <VESQLDatabase> [-DatabaseName <String>] [-ServerName <String>]
 [-InstanceName <String>] [-Port <Int32>] -GMSAAccount <String> [-ToPointInTimeUtc <DateTime>]
 [-TargetFolder <String>] [-File <VESQLDatabaseFile[]>] [-TargetPath <String[]>] [-Force]
 -SwitchOverOptions <VESQLIRSwitchOverOptions> [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet performs instant recovery of a backed-up Microsoft SQL Server database. You can restore a database to the original location or to another location. For details, see the [Instant Recovery](https://helpcenter.veeam.com/docs/vbr/userguide/vesql_instant_recovery.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 a Microsoft SQL Server database. The cmdlet will restore this database.</p><p>Accepts the <a href="vesqldatabase.md"><code>VESQLDatabase</code></a> object. To get this object, run the <a href="get-vesqldatabase.md"><code>Get-VESQLDatabase</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vesqldatabase.md"><code>VESQLDatabase</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">DatabaseName</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies a name for the restored Microsoft SQL Server database on the target location. The database will be restored with the specified name.</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">File</span></p>
        </td>
        <td>
          <p>Specifies an array of file names for Microsoft SQL Server databases.</p><p>Accepts the <a href="vesqldatabasefile.md"><code>VESQLDatabaseFile</code></a><code>[]</code> object. To get this object, run the <a href="get-vesqldatabasefile.md"><code>Get-VESQLDatabaseFile</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vesqldatabasefile.md"><code>VESQLDatabaseFile[]</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 an existing Microsoft SQL Server database with a Microsoft SQL Server 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">GMSAAccount</span></p>
        </td>
        <td>
          <p>Specifies the name of the Group Managed Service Account (gMSA). The cmdlet will use this account to authenticate to Microsoft SQL Server on the target machine.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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">GuestCredentials</span></p>
        </td>
        <td>
          <p>Specifies credentials for authenticating to the target machine. If these credentials do not work, the cmdlet will use the credentials specified in the backup job.</p><p>Consider the following:</p><ul><li>If you omit this parameter, the cmdlet will use the credentials specified in the <code>SqlCredentials</code> parameter to connect to both Microsoft SQL Server and to the guest OS on the target server.</li><li>If you do not specify SQL credentials, the cmdlet will use the current account credentials.</li></ul><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?view=powershell-7.6) 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>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">InstanceName</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies the name of the target Microsoft SQL Server instance. The cmdlet will restore the Microsoft SQL Server database to the specified target instance.</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">Port</span></p>
        </td>
        <td>
          <p>Specifies a port number that will be used to connect to the target Microsoft SQL Server.</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">ServerName</span></p>
        </td>
        <td>
          <p>For restore to another location.</p><p>Specifies DNS name or IP address of the target SQL Server machine. The cmdlet will restore the database to the specified Microsoft SQL Server machine.</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">SqlCredentials</span></p>
        </td>
        <td>
          <p>Specifies Microsoft SQL Server credentials for authenticating to Microsoft SQL Server on the target machine.</p><p><strong>Note</strong>: If you do not specify Microsoft SQL Server credentials, the cmdlet will use the current account credentials. If these credentials do not work, the cmdlet will use the credentials specified in the backup job.</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?view=powershell-7.6) cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>PSCredential</code></p>
        </td>
        <td style="width:10%;">
          <p>True</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: automatic, manual or scheduled.</p><p>Accepts the <a href="vesqlirswitchoveroptions.md"><code>VESQLIRSwitchOverOptions</code></a> object. To get this object, run the <a href="new-vesqlirswitchoveroptions.md"><code>New-VESQLIRSwitchOverOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vesqlirswitchoveroptions.md"><code>VESQLIRSwitchOverOptions</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">TargetFolder</span></p>
        </td>
        <td>
          <p>For restoring Microsoft SQL Server database files to specific location.</p><p>Specifies the destination folder. The cmdlet will restore all database files to that folder.</p><p><strong>Note</strong>: This parameter is not available if you use the <code>TargetPath</code> parameter.</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">TargetPath</span></p>
        </td>
        <td>
          <p>Specifies a target path array. The cmdlet will restore Microsoft SQL Server database files to the locations specified in the array.</p><p>Consider the following:</p><ul><li>For every Microsoft SQL Server database file, you must assign a specific file path.</li><li>This parameter is not available if you use the <code>TargetFolder</code> parameter.</li></ul>
        </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 a Microsoft SQL Server 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">UseSQLAuthentication</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will use SQL authentication to connect to Microsoft SQL Server on the target machine.</p><p><strong>Note</strong>: If you omit this parameter, the cmdlet will use credentials specified in the <code>SqlCredentials</code> parameter to connect to both Microsoft SQL Server and to the guest OS.</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>
    </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 Docs.

## Output Object
The cmdlet returns the [`VESQLIRDatabase`](vesqlirdatabase.md) object that contains information about the Microsoft SQL Server database published within the instant recovery session.

## Examples

::: example
### Example 1. Performing Instant Recovery of Microsoft SQL Server Database to Original Location with Scheduled Switchover

This example shows how to perform instant recovery of the `SQLDatabase` 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-VESQLIRSwitchOverOptions -Scheduled -SwitchingTimeUtc $TimeUtc
$session = Get-VESQLRestoreSession
$database = Get-VESQLDatabase -Session $session[0] -Name "SQLDatabase"
Restore-VESQLIRDatabase -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?view=powershell-7.6) cmdlet. Specify the `Date` parameter value to set the 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-VESQLIRSwitchOverOptions`](new-vesqlirswitchoveroptions.md) cmdlet. Provide the `Scheduled` parameter. Set the `$TimeUTC` variable as the `SwitchingTimeUtc` parameter value. Save the result to the `$ScheduledSwitch` variable.
4. Run the [`Get-VESQLRestoreSession`](get-vesqlrestoresession.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-VESQLDatabase`](get-vesqldatabase.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-VESQLIRDatabase` 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 Microsoft SQL Server Databases to Specific Folder and Switching over Manually

This example shows how to restore the `SQLDatabase01` database files to the latest state with the following settings:

- The cmdlet will restore the database to the `localhost` target server.
- The cmdlet will restore the database to the `SQLExpress` instance.
- The cmdlet will restore the database with the `TableDatabase` name.
- The cmdlet will restore the database to the `C:\` folder.
- To perform the switchover operation manually, you must run the [`Switch-VESQLIRDatabase`](switch-vesqlirdatabase.md) cmdlet.

```
$restore = Get-VBRApplicationRestorePoint -Id E4786E49-D943-4E27-80C2-C99A059CBB27
$session = Start-VESQLRestoreSession -RestorePoint $restore
$database = Get-VESQLDatabase -Session $session -Name "SQLDatabase01"
$ManualSwitch = New-VESQLIRSwitchOverOptions -Manual
$IRDatabase = Restore-VESQLIRDatabase -Database $database -SwitchOverOptions $ManualSwitch -ServerName "localhost" -InstanceName "SQLExpress" -DatabaseName "TableDatabase" -TargetFolder "C:\"
Switch-VESQLIRDatabase -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 restore point to the `$restore` variable.
2. Run the [`Start-VESQLRestoreSession`](start-vesqlrestoresession.md) cmdlet. Specify the `RestorePoint` parameter value. Save the restore point to the `$session` variable.
3. Run the [`Get-VESQLDatabase`](get-vesqldatabase.md) cmdlet. Set the `$session` variable as the Session parameter value. Specify the Name parameter value. Save the result to the `$database` variable.
4. Run the [`New-VESQLIRSwitchOverOptions`](new-vesqlirswitchoveroptions.md) cmdlet. Provide the `Manual` parameter. Save the result in the `$ManualSwitch` variable.
5. Run the `Restore-VESQLIRDatabase` cmdlet with the `$database` variable. Specify the following options:

   - Set the `$database` variable as the `Database` parameter value.
   - Set the `$ManualSwitch` variable as the `SwitchOverOptions` parameter value.
   - Specify the `ServerName` parameter value.
   - Specify the `InstanceName` parameter value.
   - Specify the `DatabaseName` parameter value.
   - Specify the `TargetFolder` parameter value.

   Save the result to the `$IRDatabase` variable.

6. Run the [`Switch-VESQLIRDatabase`](switch-vesqlirdatabase.md) cmdlet. Set the `$IRDatabase` variable as the `Database` parameter value.

:::

## Related Commands

- [`Get-VESQLRestoreSession`](get-vesqlrestoresession.md)
- [`Start-VESQLRestoreSession`](start-vesqlrestoresession.md)
- [`Get-VESQLDatabase`](get-vesqldatabase.md)
- [`Get-VESQLDatabaseFile`](get-vesqldatabasefile.md)
- [`New-VESQLIRSwitchOverOptions`](new-vesqlirswitchoveroptions.md)
- [`Switch-VESQLIRDatabase`](switch-vesqlirdatabase.md)
- [`Get-VBRApplicationRestorePoint`](https://helpcenter.veeam.com/docs/vbr/powershell/get-vbrapplicationrestorepoint.html?ver=13)
- [``Get-Date``](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/get-date?view=powershell-7.6)