Short Description
Starts restore sessions for exploring backed up items and performing restore operations.
Syntax
This cmdlet provides 3 parameter sets.
- For exploring or restoring mailbox backups from the latest restore point:
Start-VBOExchangeItemRestoreSession -LatestState [-Job <VBOJob>] [-Organization <VBOOrganization>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
- For exploring or restoring mailbox backups from the specified restore point:
Start-VBOExchangeItemRestoreSession -RestorePoint <VBORestorePoint> [-Job <VBOJob>] [-Organization <VBOOrganization>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
- For exploring or restoring mailbox backups from the latest restore point remotely:
Start-VBOExchangeItemRestoreSession -Server <string> -Credential <pscredential> [-Port <int>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
Detailed Description
This cmdlet establishes a connection to the Veeam Backup for Microsoft Office 365 server and retrieves organization's mailbox data from the backups. You can specify a restore point to view organization's mailbox data at the state of this restore point.
During a restore session you can explore backed up mailbox items using the following cmdlets:
To perform restore operations, use the following cmdlets:
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Latest | Indicates that the cmdlet will retrieve data from the mailbox database at the state of the latest restore point. | True | Named | False | False |
Job | Specifies the backup job. The cmdlet will start a restore session for backups created by the specified job. | False | Named | True (ByValue) | False |
Organization | Specifies Exchange organization. The cmdlet will start a restore session for backups associated with the specified organization. | False | Named | True (ByValue) | False |
Show | Indicates that the cmdlet will add the backups of mailbox items that were deleted by user to the restore session. | False | Named | False | False |
Show | Indicates that the cmdlet will add all versions of backed up mailbox items to the restore session. | False | Named | False | False |
Restore | Specifies the restore point. The cmdlet will retrieve data from the mailbox database at the state of the specified restore point. | True | Named | True (ByValue) | False |
Server | Specifies the Veeam Backup for Microsoft Office 365 server to which you want to connect. | True | Named | False | False |
Credential | Specifies credentials you want to use for authenticating with the Veeam Backup for Microsoft Office 365 server. | True | Named | False | False |
Port | Specifies the port for connecting with Veeam Backup for Microsoft Office 365 server. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This example shows how to start a restore session with the following parameters:
- The cmdlet will use the mailbox database at the state of the latest restore point.
- The restore session will be started only for backups associated with the "ABC" organization.
You will need to perform the following steps:
- Run Get-VBOOrganization to get the Exchange organization whose backups you want to explore or restore during the restore session. Save the result to the $organization variable.
- Run Start-VBOExchangeItemRestoreSession with the $organization variable. Use LatestState parameter to bring the mailbox database to the state of the latest restore point.
PS C:\PS> $organization = Get-VBOOrganization -Name "ABC" PS C:\PS> Start-VBOExchangeItemRestoreSession -LatestState -Organization $organization |
Example 2
This example shows how to start a restore session with the following parameters:
- The cmdlet will use the mailbox database at the state of the selected restore point.
- The restore session will be started only for backups that were created by the "Sales Reports" backup job.
You will need to perform the following steps:
- Run Get-VBORestorePoint and select the needed restore point by its creation time. Save the result to the $restorepoint variable.
- Run Get-VBOJob to get the backup job associated with the backups you want to explore or restore during the restore session.
- Run Start-VBOExchangeItemRestoreSession with the $restorepoint and $job variables.
PS C:\PS> $restorepoint = Get-VBORestorePoint | Select-Object -Property BackupTime | select -First 2 PS C:\PS> $job = Get-VBOJob -Name "Sales Reports" PS C:\PS> Start-VBOExchangeItemRestoreSession -RestorePoint $restorepoint -Job $job |
Example 3
This example shows how to start a remote restore session for the mailbox database at the state of the latest restore point.
You will need to perform the following steps:
- Run Get-Credential to create a credential object. Type Windows credentials for connecting to the Veeam Backup for Microsoft Office 365 server. Save the result to the $creds variable
- Run Start-VBOExchangeItemRestoreSession with the $creds variable.
PS C:\PS> $creds = Get-Credential PS C:\PS> Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $creds |
Example 4
This example shows how to perform a restore scenario:
- Start a remote restore session for the mailbox database at the state of the latest restore point,
- Perform an item restore from the organization's mailbox,
- Stop a restore session.
You will need to perform the following steps:
- Start a remote restore session for the mailbox database at the state of the latest restore point:
- Run Get-Credential to create a credential object with Windows credentials for connecting to the Veeam Backup for Microsoft Office 365 server. Save the result to the $vbosrvcreds variable
- Run Start-VBOExchangeItemRestoreSession with the $vbosrvcreds variable.
- Perform an item restore:
- Get the mailbox that contains the item you want to restore and save it to the $mailbox variable:
- Run Get-VBOExchangeItemRestoreSession to get the active restore session. Save the result to the $session variable.
- Run Get-VEXDatabase with the $session variable to get the mailbox database. Save the result to the $database variable.
- Run Get-VEXMailbox with the $database variable and Name parameter to get the specific mailbox from the mailbox database. Save the result to the $mailbox variable.
- Run Get-Credential to create a credential object with account credentials for connecting to the Microsoft Exchange server. Save the result to the $exsrvcreds variable.
- Run Restore-VEXitem with the $mailbox and $exsrvcreds variables to restore the mailbox to the Microsoft Exchange server.
- Stop a remote restore session:
- Run Stop-VBOExchangeItemRestoreSession. Use the $session variable you obtained in Step 1.
PS C:\PS> $vbosrvcreds = Get-Credential PS C:\PS> Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $vbosrvcreds PS C:\PS> $session = Get-VBOExchangeItemRestoreSession PS C:\PS> $database = Get-VEXDatabase -Session $session PS C:\PS> $mailbox = Get-VEXMailbox -Database $database -Name "sales" PS C:\PS> $exsrvcreds = Get-Credential PS C:\PS> Restore-VEXItem -Mailbox $mailbox -Server outlook.office365.com -Credential $exsrvcreds -RestoreChangedItem PS C:\PS> Stop-VBOExchangeItemRestoreSession -Session $session |
Related Commands
Get-VBOExchangeItemRestoreSession
Stop-VBOExchangeItemRestoreSession