Start-VESQLRestoreSession

Short Description

Starts a restore session to explore backed-up Microsoft SQL Server databases and to perform operations with these databases.

Product: Veeam Backup & Replication

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Start-VESQLRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint> [<CommonParameters>]

Detailed Description

This cmdlet starts a new restore session, establishes a connection to the backup server and retrieves backed-up Microsoft SQL Server databases. Within the restore session, you can get backed-up databases using the following cmdlets:

After you get backed-up Microsoft SQL Server databases, you can perform the following operations with these databases:

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
RestorePoint	Specifies a restore point used to start a new restore session. You will be able to use the session to perform operations with Microsoft SQL Server databases that this restore point contains. Accepts the `IVBRApplicationRestorePoint` object. To get this object, run the `Get-VBRApplicationRestorePoint` cmdlet.	`IVBRApplicationRestorePoint`	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 VESQLRestoreSession object that contains settings of the restore session started to explore backed-up Microsoft SQL Server databases and to perform operations with these databases.

Examples

Starting Restore Session

This example shows how to start a restore session to perform operations with a Microsoft SQL Server database.

$restorepoint = Get-VBRApplicationRestorePoint -SQL

$session = Start-VESQLRestoreSession -RestorePoint $restorepoint[0]

Perform the following steps:

Run the Get-VBRApplicationRestorePoint cmdlet. Provide the SQL parameter. Save the result to the $restorepoint variable.

The cmdlet will return an array of restore points. Note the ordinal number of the necessary restore point. In this example, it is the first restore point in the array.
Run the Start-VESQLRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value and select the necessary restore point. Save the result to the $session variable to be able to use it with other cmdlets.

Get-VBRApplicationRestorePoint