Start-VEODRestoreSession
Short Description
Starts restore sessions to explore backed-up OneDrive items and to perform operations with these items.
Applies to
Veeam Backup for Microsoft 365
Product Edition: Community, Rental License, Subscription License
Syntax
This cmdlet provides parameter sets that allow you to:
- Explore and perform operations with OneDrive items from backups created by a specific job.
Start-VEODRestoreSession [-Job] <IVBOJob> [-Server <String>] [-Credential <PSCredential>] [-Port <Int32>] [-ShowDeleted] [-ShowAllVersions] [-Reason <String>] [<CommonParameters>] |
- Explore and perform operations with OneDrive items from a specific restore point.
Start-VEODRestoreSession [[-Job] <IVBOJob>] [[-Organization] <IVBOOrganization>] [-RestorePoint] <IVBORestorePoint> [-Server <String>] [-Credential <PSCredential>] [-Port <Int32>] [-ShowDeleted] [-ShowAllVersions] [-Reason <String>] [<CommonParameters>] |
- Explore and perform operations with OneDrive items from the latest restore point.
Start-VEODRestoreSession [[-Job] <IVBOJob>] [[-Organization] <IVBOOrganization>] [-Server <String>] [-Credential <PSCredential>] [-Port <Int32>] [-ShowDeleted] [-ShowAllVersions] [-LatestState] [-Reason <String>] [<CommonParameters>] |
- Explore and perform operations with OneDrive items from backups created for a specific organization.
Start-VEODRestoreSession [-Organization] <IVBOOrganization> [-Server <String>] [-Credential <PSCredential>] [-Port <Int32>] [-ShowDeleted] [-ShowAllVersions] [-Reason <String>] [<CommonParameters>] |
Detailed Description
This cmdlet starts a new restore session, establishes a connection to the Veeam Backup for Microsoft 365 server and retrieves data on OneDrive items backed up on this server. Within the restore session, you can get backed-up items using the following cmdlets:
After you get backed-up items, you can perform the following operations with these items:
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
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. | True | 0 | True (ByValue) |
Server | Specifies DNS name or IP address of the Veeam Backup for Microsoft 365 server that backed up items you want to restore. | String | False | Named | False |
Credential | Specifies credentials that will be used for authenticating to the Veeam Backup for Microsoft 365 server. | Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet. | False | Named | False |
Port | Specifies a port number that will be used to connect to the Veeam Backup for Microsoft 365 server. Default: 9194 | Int32 | False | Named | False |
ShowDeleted | Defines 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. Default: False Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase. | SwitchParameter | False | Named | False |
ShowAllVersions | Defines 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. Default: False Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase. | SwitchParameter | False | Named | False |
Reason | Specifies a reason to perform restore operation. | String | False | Named | 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-VBOO rganization cmdlet. | False | 0 | True (ByValue) |
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 | 0 | True (ByValue) |
LatestState | Defines that the cmdlet will retrieve items from the latest restore point. If you provide this parameter, you will be able to perform operations with items in the most recent restore state. Default: False | SwitchParameter | True | Named | 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 VBOOneDriveItemRestoreSession object that contains the restore session started to perform operations with backed-up OneDrive items.
Examples
Example 1. Starting Restore Session from Specific Restore Point
Example 2. Starting Restore Session from Latest State
Related Commands
