This is an archive version of the document. To get the most up-to-date information, see the current version.Start-VBOExchangeItemRestoreSession
Short Description
Starts restore sessions to explore backed-up Microsoft Exchange objects and to perform operations with them.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides parameter sets that allow you to.
- Explore or restore Microsoft Exchange objects from the latest restore point:
Start-VBOExchangeItemRestoreSession -LatestState [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
- Explore or restore Microsoft Exchange objects from the specified restore point:
Start-VBOExchangeItemRestoreSession -RestorePoint <IVBORestorePoint> [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
- Explore or restore Microsoft Exchange objects from the latest restore point remotely:
Start-VBOExchangeItemRestoreSession -Server <string> -Credential <pscredential> [-Port <int>] [-SkipCertificateCheck] [-ShowDeleted] [-ShowAllVersions] [<CommonParameters>] |
Detailed Description
This cmdlet establishes a connection to the Veeam Backup for Microsoft Office 365 server and retrieves Exchange objects backed up on this server. Within the restore session, you can get backed-up Exchange objects 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 |
LatestState | Indicates that the cmdlet will retrieve data from a mailbox database at the state of the latest restore point. | SwitchParameter | True | Named | False | False |
RestorePoint | Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with items that this restore point contains. | Accepts the IVBORestorePoint object. To get this object, run the Get-VBORestorePoint cmdlet. | True | Named | True (ByValue) | False |
Server | Specifies a DNS name or an IP address of Veeam Backup for Microsoft Office 365 server that backed up items you want to restore. | String | True | Named | False | False |
Credential | Specifies credentials that will be used to authenticate against the Veeam Backup for Microsoft Office 365 server. | PSCredential | True | Named | False | False |
Job | Specifies a backup job to start a new restore session. You will be able to use the session to perform operations with items backed up by this job. | Accepts the IVBOJob object. To get this object, run the Get-VBOJob cmdlet. | False | Named | True (ByValue) | False |
Organization | Specifies an organization to start a new restore session. You will be able to use the session to perform operations with items backed up for this organization. | Accepts the IVBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet. | False | Named | True (ByValue) | False |
ShowDeleted | Specifies that deleted items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items. NOTE: With this parameter provided, the amount of data returned by cmdlets within the current session may significantly increase. | SwitchParameter | False | Named | False | False |
ShowAllVersions | Specifies that all versions of SharePoint items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items. NOTE: With this parameter provided, the amount of data returned by cmdlets within the current session may significantly increase. | SwitchParameter | False | Named | False | False |
Port | Specifies a port number that will be used to connect to the Veeam Backup for Microsoft Office 365 server. | Int32 | False | Named | False | False |
SkipCertificateCheck | Indicates that the cmdlet will not perform the SSL certificate check. | SwitchParameter | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Examples
- Starting Restore Session From Latest Restore Point
- Starting Restore Session From Specific Restore Point
- Starting Restore Session From Latest Restore Point Remotely
- Performing Restore Scenario
Example 1. Starting Restore Session From Latest Restore Point
This example shows how to start a restore session to perform operations with Microsoft Exchange objects. The restore session will start with the following settings:
- The cmdlet will retrieve data from a mailbox database from the state of the latest restore point.
- The cmdlet will start a restore session only for backups associated with the ABC organization.
$organization = Get-VBOOrganization -Name "ABC" Start-VBOExchangeItemRestoreSession -LatestState -Organization $organization |
You must perform the following steps:
- Run the Get-VBOOrganization cmdlet. Save the result to the $organization variable.
- Run the Start-VBOExchangeItemRestoreSession cmdlet. Set the $organization variable as the Organization parameter value.
Example 2. Starting Restore Session From Specific Restore Point
This example shows how to start a restore session to perform operations with Microsoft Exchange objects. The restore session will start with the following settings:
- The cmdlet will retrieve a mailbox database at the state of the selected restore point.
- The cmdlet will start a restore session only for backups that were created by the Sales Reports backup job.
$restorepoint = Get-VBORestorePoint | Select-Object -Property BackupTime | select -First 2 $job = Get-VBOJob -Name "Sales Reports" Start-VBOExchangeItemRestoreSession -RestorePoint $restorepoint -Job $job |
You must perform the following steps:
- Run the Get-VBORestorePoint cmdlet. Specify the restore point by its creation time. Save the result to the $restorepoint variable.
- Run the Get-VBOJob cmdlet. Specify the Name parameter value.
- Run the Start-VBOExchangeItemRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Set the $job as the Job parameter value.
Example 3. Starting Restore Session From Latest Restore Point Remotely
This example shows how to start a remote restore session to perform operations with Microsoft Exchange objects. The cmdlet will retrieve a mailbox database at the state of the selected restore point.
$credentials = Get-Credential Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $credentials |
- Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable.
- Run the Start-VBOExchangeItemRestoreSession cmdlet with the $creds variable.
Example 4. Performing Restore Scenario
This example shows how to perform a restore scenario. The restore scenario includes the following steps:
- Start a remote restore session for a mailbox database at the state of the latest restore point
- Perform an item restore from an organization mailbox
- Stop a restore session
$vbosrvcreds = Get-Credential Start-VBOExchangeItemRestoreSession -Server vbo365server.support.local -Credential $vbosrvcreds $session = Get-VBOExchangeItemRestoreSession $database = Get-VEXDatabase -Session $session $mailbox = Get-VEXMailbox -Database $database -Name "sales" $exsrvcreds = Get-Credential Restore-VEXItem -Mailbox $mailbox -Server outlook.office365.com -Credential $exsrvcreds -RestoreChangedItem Stop-VBOExchangeItemRestoreSession -Session $session |
You must perform the following steps:
- Start the remote restore session for the mailbox database at the state of the latest restore point:
- Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $vbosrvcreds variable
- Run the Start-VBOExchangeItemRestoreSession cmdlet. Set the $vbosrvcreds variable as the Credential parameter value. Specify the Server parameter value
- Perform an item restore:
- Get a mailbox that contains an item that you want to restore and save it to the $mailbox variable:
- Run the Get-VBOExchangeItemRestoreSession cmdlet to get the restore session. Save the result to the $session variable.
- Run the Get-VEXDatabase cmdlet with the $session variable to get the mailbox database. Save the result to the $database variable.
- Run the Get-VEXMailbox cmdlet with the $database variable and the Name parameter to get the specific mailbox from the mailbox database. Save the result to the $mailbox variable.
- Run the Get-Credential cmdlet to create a credential object with account credentials to connect to the Microsoft Exchange server. Save the result to the $exsrvcreds variable.
- Run the Restore-VEXitem cmdlet with the $mailbox and $exsrvcreds variables to restore the mailbox to the Microsoft Exchange server.
- Stop the restore session:
- Run the Stop-VBOExchangeItemRestoreSession cmdlet. Use the $session variable that you obtained in the Step 1.
Related Commands