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 [[-Job] <IVBOJob>] [[-Organization] <IVBOOrganization>][-RestorePoint] <IVBORestorePoint> [-Server <String>] [-Credential <PSCredential>] [-Port <Int32>][-ShowDeleted] [-ShowAllVersions] [-Reason <String>] [<CommonParameters>]

  • Explore and perform operations with SharePoint items from the latest restore point.

Start-VBOSharePointItemRestoreSession [[-Job] <IVBOJob>] [[-Organization] <IVBOOrganization>][-Server <String>] [-Credential <PSCredential>] [-Port <Int32>] [-ShowDeleted] [-ShowAllVersions][-LatestState] [-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, note 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 <Int32>] [-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 <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 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

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)

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.

SwitchParameter

True

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-VBOOrganization cmdlet.

False

Named

True (ByValue)

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

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.

Note: With this parameter provided, 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. 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

Reason

Specifies a reason to perform restore operation.

String

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Start-VBOSharePointItemRestoreSessionExample 1. Starting Restore Session for Backup Job

This example shows how to start a new restore session to retrieve items backed up by a job running on the srv.tech.local server from the latest restore point. To connect to the Veeam Backup for Microsoft 365 server, the default port number (9194) will be used.

$credentials = Get-Credential

$job = Get-VBOJob -Name "SharePoint"

Start-VBOSharePointItemRestoreSession -LatestState -Job $job -Server "srv.tech.local" -Credential $credentials

Perform the following steps:

  1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $credentials variable.
  2. Run the Get-VBOJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  3. Run the Start-VBOSharePointItemRestoreSession cmdlet. Specify the following settings:
  • Provide the LatestState parameter.
  • Set the $job variable as the Job parameter value.
  • Specify the Server parameter value.
  • Set the $credentials variable as the Credential parameter value.

Start-VBOSharePointItemRestoreSessionExample 2. Starting Restore Session from Specific Restore Point

This example shows how to start a restore session to retrieve items from a specific restore point created on the srv.tech.local server. To connect to the Veeam Backup for Microsoft 365 server, the default port number (9194) will be used.

$credentials = Get-Credential

$restorepoint = Get-VBORestorePoint

Start-VBOSharePointItemRestoreSession -RestorePoint $restorepoint[0] -Server "srv.tech.local" -Credentials $credentials

Perform the following steps:

  1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $credentials variable.
  2. Run the Get-VBORestorePoint cmdlet. Save the result to the $restorepoint variable.

The cmdlet will return an array of all restore points created on the srv.tech.local server. Note the ordinal number of the necessary restore point. In our example, it is the first restore point in the array.

  1. Run the Start-VBOSharePointItemRestoreSession cmdlet. Specify the following settings:
  • Set the $restorepoint[0] variable as the RestorePoint parameter value.
  • Specify the Server parameter value.
  • Set the $credentials variable as the Credential parameter value.

Start-VBOSharePointItemRestoreSessionExample 3. Starting Restore Session for Backed-Up Microsoft Organization

This example shows how to start a restore session to retrieve the TechCompany organization items backed up on the srv.tech.local server from the latest restore point. To connect to the Veeam Backup for Microsoft 365, the default port number (9194) will be used.

$credentials = Get-Credential

$organization = Get-VBOOrganization -Name "TechCompany"

Start-VBOSharePointItemRestoreSession -LatestState -Organization $organization -Server "srv.tech.local" -Credentials $credentials

Perform the following steps:

  1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $credentials variable.
  2. Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $organization variable.
  3. Run the Start-VBOSharePointItemRestoreSession cmdlet. Specify the following settings:
  • Provide the LatestState parameter.
  • Set the $organization variable as the Organization parameter value.
  • Specify the Server parameter value.
  • Set the $credentials variable as the Credential parameter value.

Related Commands