This is an archive version of the document. To get the most up-to-date information, see the current version.Start-VBOSharePointItemRestoreSession
Short Description
Starts restore sessions to explore backed-up SharePoint items and to perform operations with these items.
Applies to:
Veeam Backup for Microsoft 365
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Explore and perform operations with SharePoint items from a specific restore point.
Start-VBOSharePointItemRestoreSession [-RestorePoint] <IVBORestorePoint> [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions] [-Reason <string>] [<CommonParameters>] |
- Explore and perform operations with SharePoint items from the latest restore point.
Start-VBOSharePointItemRestoreSession -LatestState [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions] [-Reason <string>] [<CommonParameters>] |
Updated Cmdlet Sets
In Veeam Backup for Microsoft 365 3.0, the following cmdlet sets have been updated. If you had already used these cmdlet sets in previous versions, mind the syntax. The ShowDeleted and ShowAllVersions parameters have been added.
- Explore and perform operations with SharePoint items from backups created by a specific job.
Start-VBOSharePointItemRestoreSession [-Job] <IVBOJob> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions] [-Reason <string>] [<CommonParameters>] |
- Explore operations with SharePoint items from backups created for a specific organization.
Start-VBOSharePointItemRestoreSession [-Organization] <IVBOOrganization> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-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 SharePoint 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 | Accept Wildcard Characters |
|---|---|---|---|---|---|---|
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) | 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 | 0 | True (ByValue) | False |
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. | SwitchParameter | True | Named | False | 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 |
Server | Specifies a DNS name or an IP address of the Veeam Backup for Microsoft 365 server that backed up items you want to restore. | String | False | Named | False | False |
Credential | Specifies credentials that will be used to authenticate against the Veeam Backup for Microsoft 365 server. | Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet. | False | Named | False | 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 | 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. 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 | 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. Otherwise, only the latest version of SharePoint items will be available. Note: With this parameter provided, the amount of data returned by cmdlets within the current session may significantly increase. | SwitchParameter | False | Named | False | False |
Reason | Specifies a reason to perform restore operation. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft 365 version 6.0 or later. | String | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.
Examples
Example 1. Starting Restore Session From Backup Job
Example 2. Starting Restore Session From Specific Restore Point
Example 3. Starting Restore Session From Backed-Up Microsoft Organization
Related Commands
