This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBRExchangeItemRestoreSession
Short Description
Returns active restore sessions started to perform operations with backed-up Microsoft Exchange databases.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRExchangeItemRestoreSession |
Detailed Description
This cmdlet returns an array of active restore sessions started to perform operations with backed-up Microsoft Exchange databases.
|
The cmdlet returns restore sessions initiated in the PowerShell console only. The cmdlet does not return restore sessions running in the Veeam Backup & Replication console. |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
The cmdlet returns the VBRExchangeRestoreSession[] object that contains settings to connect to Veeam Backup & Replication.
Examples
- Getting all Running Restore Sessions
- Getting Specific Restore Session
- Stopping Specific Restore Session
Example 1. Getting all Running Restore Sessions
This command gets all running restore sessions to perform operations with Microsoft Exchange databases. Save the result to the $session variable to be able to use it with other cmdlets.
$session = Get-VBRExchangeItemRestoreSession |
Example 2. Getting Specific Restore Session
This example shows how to get a specific restore session to perform operations with Microsoft Exchange databases.
$session = Get-VBRExchangeItemRestoreSession $session[0] |
You must perform the following steps:
- Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
The Get-VBRExchangeItemRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the forth restore session in the array).
- Specify the necessary ordinal number of the restore session for the $session variable. In our example, it is the fourth restore session in the array.
Example 3. Stopping Specific Restore Session
This example shows how to stop a specific restore session initiated to perform operations with Microsoft Exchange databases.
$session = Get-VBRExchangeItemRestoreSession Stop-VBRExchangeItemRestoreSession -Session $session[0] |
You must perform the following steps:
- Run the Get-VBRExchangeItemRestoreSession cmdlet. Save the result to the $session variable.
The Get-VBRExchangeItemRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the forth restore session in the array).
- Run the Stop-VBRExchangeItemRestoreSession cmdlet. Set the $session variable as the Session parameter value.
Related Commands