Start-VESQLPluginRestoreSession

Short Description

Starts a restore session to explore and restore databases backed up with Veeam Plug-in for Microsoft SQL Server.

Product: Veeam Backup & Replication

Product Edition: Enterprise Plus, Veeam Universal License

Syntax

Start-VESQLPluginRestoreSession [-Backup] <IVESQLPluginBackup> [<CommonParameters>]

Detailed Description

This cmdlet starts a restore session to explore and restore databases backed up with Veeam Plug-in for Microsoft SQL Server.

After you create the restore session, run the Get-VESQLPluginDatabase cmdlet to get databases backed up with Veeam Plug-in for Microsoft SQL Server.

Note the difference between a restore session and a restore job. A restore session is a preliminary step where Veeam Explorer for Microsoft SQL Server has retrieved the backup from the backup repository, pending restore operations. A restore job is the process of restoring data from the backup to the target Microsoft SQL Server machine.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies a backup used to start a new restore session. You will be able to use the session to explore and restore Microsoft SQL Server databases that this backup contains. Accepts the `IVESQLPluginBackup` object. To get this object, run the `Get-VESQLPluginBackup` cmdlet.	`IVESQLPluginBackup`	True	0	True (ByValue)

<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 VESQLPluginRestoreSession object that contains settings of the restore session for databases backed up with Veeam Plug-in for Microsoft SQL Server.

Examples

Starting Restore Session

This example shows how to start a restore session to explore and restore databases backed up with Veeam Plug-in for Microsoft SQL Server.

$backup = Get-VESQLPluginBackup -Name "SQL Backup"

$session = Start-VESQLPluginRestoreSession -Backup $backup

Perform the following steps:

Run the Get-VESQLPluginBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Start-VESQLPluginRestoreSession cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $session variable to be able to use it with other cmdlets.

Get-VESQLPluginBackup