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:

RestoreUsingCredentialsFromVBR

Restore-VESQLIRDatabase [-Database] <VESQLDatabase> [-DatabaseName <String>] [-ServerName <String>]

[-InstanceName <String>] [-Port <Int32>] [-ToPointInTimeUtc <DateTime>] [-TargetFolder <String>]

[-File <VESQLDatabaseFile[]>] [-TargetPath <String[]>] [-Force] -SwitchOverOptions <VESQLIRSwitchOverOptions> [<CommonParameters>]

RestoreUsingCredentials

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>]

RestoreUsingGmsaAccount

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>]

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 section of the Veeam Explorers User Guide.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Database	Specifies a Microsoft SQL Server database. The cmdlet will restore this database. Accepts the `VESQLDatabase` object. To get this object, run the `Get-VESQLDatabase` cmdlet.	`VESQLDatabase`	True	0	True (ByValue)
DatabaseName	For restore to another location. Specifies a name for the restored Microsoft SQL Server database on the target location. The database will be restored with the specified name.	`String`	False	Named	False
File	Specifies an array of file names for Microsoft SQL Server databases. Accepts the `VESQLDatabaseFile[]` object. To get this object, run the `Get-VESQLDatabaseFile` cmdlet.	`VESQLDatabaseFile[]`	False	Named	False
Force	Defines that the cmdlet will overwrite an existing Microsoft SQL Server database with a Microsoft SQL Server database from the backup. Note: The cmdlet will show no prompt before executing the command.	`SwitchParameter`	False	Named	False
GMSAAccount	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.	`String`	True	Named	False
GuestCredentials	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. Consider the following: If you omit this parameter, the cmdlet will use the credentials specified in the `SqlCredentials` parameter to connect to both Microsoft SQL Server and to the guest OS on the target server. If you do not specify SQL credentials, the cmdlet will use the current account credentials. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	False	Named	False
InstanceName	For restore to another location. Specifies the name of the target Microsoft SQL Server instance. The cmdlet will restore the Microsoft SQL Server database to the specified target instance.	`String`	False	Named	False
Port	Specifies a port number that will be used to connect to the target Microsoft SQL Server.	`Int32`	False	Named	False
ServerName	For restore to another location. 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.	`String`	False	Named	False
SqlCredentials	Specifies Microsoft SQL Server credentials for authenticating to Microsoft SQL Server on the target machine. Note: 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. Accepts the `PSCredential` object. To get this object, run the `Get-Credential` cmdlet.	`PSCredential`	True	Named	False
SwitchOverOptions	Specifies a switchover option: automatic, manual or scheduled. Accepts the `VESQLIRSwitchOverOptions` object. To get this object, run the `New-VESQLIRSwitchOverOptions` cmdlet.	`VESQLIRSwitchOverOptions`	True	Named	True (ByValue)
TargetFolder	For restoring Microsoft SQL Server database files to specific location. Specifies the destination folder. The cmdlet will restore all database files to that folder. Note: This parameter is not available if you use the `TargetPath` parameter.	`String`	False	Named	False
TargetPath	Specifies a target path array. The cmdlet will restore Microsoft SQL Server database files to the locations specified in the array. Consider the following: For every Microsoft SQL Server database file, you must assign a specific file path. This parameter is not available if you use the `TargetFolder` parameter.	`String[]`	False	Named	False
ToPointInTimeUtc	Specifies a point in time in the UTC format within the restore interval of a Microsoft SQL Server database. The cmdlet will restore the database to the state of the specified point in time.	`DateTime`	False	Named	False
UseSQLAuthentication	Defines that the cmdlet will use SQL authentication to connect to Microsoft SQL Server on the target machine. Note: If you omit this parameter, the cmdlet will use credentials specified in the `SqlCredentials` parameter to connect to both Microsoft SQL Server and to the guest OS.	`SwitchParameter`	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 VESQLIRDatabase object that contains information about the Microsoft SQL Server database published within the instant recovery session.

Examples

Restore-VESQLIRDatabase 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:

Run the Get-Date cmdlet. Specify the Date parameter value to set the 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-VESQLIRSwitchOverOptions cmdlet. Provide the Scheduled parameter. Set the $TimeUTC variable as the SwitchingTimeUtc parameter value. Save the result to the $ScheduledSwitch variable.
Run the Get-VESQLRestoreSession 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-VESQLDatabase 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-VESQLIRDatabase cmdlet. Set the $database variable as the Database parameter value. Set the $ScheduledSwitch variable as the SwitchOverOptions parameter value.

Restore-VESQLIRDatabase 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 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:

Run the Get-VBRApplicationRestorePoint cmdlet. Specify the ID parameter value. Save the restore point to the $restore variable.
Run the Start-VESQLRestoreSession cmdlet. Specify the RestorePoint parameter value. Save the restore point to the $session variable.
Run the Get-VESQLDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the New-VESQLIRSwitchOverOptions cmdlet. Provide the Manual parameter. Save the result in the $ManualSwitch variable.
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.
Run the Switch-VESQLIRDatabase cmdlet. Set the $IRDatabase variable as the Database parameter value.