This is an archive version of the document. To get the most up-to-date information, see the current version.Start-VESQLRestoreSession
Short Description
Starts restore sessions to explore backed-up Microsoft SQL databases and to perform operations with these databases.
Applies to Veeam Backup & Replication
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Start-VESQLRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint> [<CommonParameters>] |
Detailed Description
This cmdlet starts a new restore session, establishes a connection to the Veeam Backup & Replication server and retrieves Microsoft SQL databases backed up on this server. Within the restore session, you can get backed-up databases using the following cmdlets:
After you get backed-up Microsoft SQL databases, you can perform the following operations with these databases:
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
RestorePoint | Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with Microsoft SQL databases that this restore point contains. | Accepts the IVBRApplicationRestorePoint object. To get this object, run the Get-VBRApplicationRestorePoint cmdlet. | True | 0 | True (ByValue) | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VESQLRestoreSession object that contains settings to connect to Veeam Backup & Replication.
Examples
Starting Restore Session
This example shows how to start a restore session to perform operations with a Microsoft SQL database.
$restorepoint = Get-VBRApplicationRestorePoint -SQL Start-VESQLRestoreSession -RestorePoint $restorepoint[0] |
You must perform the following steps:
- Run the Get-VBRApplicationRestorePoint cmdlet with the SQL parameter. Save the result to the $restorepoint variable.
The Get-VBRApplicationRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the first restore point in the array).
- Run the Start-VESQLRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.
Related Commands