Start-VBRExchangeItemRestoreSession
Short Description
Starts restore sessions to explore backed-up Exchange databases and and to perform operations with these databases.
Applies to: Veeam Backup & Replication
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRExchangeItemRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint> [<CommonParameters>] |
Detailed Description
This cmdlet establishes a connection to the Veeam Backup for Microsoft Office 365 and retrieves Exchange databases backed up on this server. Within the restore session, you can get backed-up Exchange objects within these databases using the following cmdlets:
After you get backed-up Exchange objects, you can perform the following operations with these objects:
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 Exchange 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 Common Parameters section of Microsoft Docs.
Return Type
The cmdlet returns the VBRExchangeItemRestoreSession object that contains settings of restore sessions started to explore backed-up Exchange databases and and to perform operations with these databases.
Examples
Starting Restore Session
This example shows how to start a restore session to perform operations with Microsoft Exchange databases.
$restorepoint = Get-VBRApplicationRestorePoint -Exchange Start-VBRExchangeItemRestoreSession -RestorePoint $restorepoint[0] |
Perform the following steps:
- Run the Get-VBRApplicationRestorePoint cmdlet. Provide the Exchange 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-VBRExchangeItemRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.
Related Commands