Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Restore-VESPItem

Short Description

Restores SharePoint item.

Applies to

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • To restore a specific SharePoint site:

Restore-VESPItem [-Site] <VESPSite> [-RestoreSubsites [<SwitchParameter>]] [[-SiteURL] <String>] [-SiteAlias <String>] [-Credential <PSCredential>] [-RestorePermissions [<SwitchParameter>]] [-SkipPermissionNotificationSending [<SwitchParameter>]] [-RestoreChangedItems [<SwitchParameter>]] [-RestoreDeletedItems [<SwitchParameter>]] [-RestoreListViews [<SwitchParameter>]]  [<CommonParameters>]

  • To restore a SharePoint list:

Restore-VESPItem [-List] <VESPList> [-TargetList <String>] [[-SiteURL] <String>] [-SiteAlias <String>] [-Credential <PSCredential>] [-RestorePermissions [<SwitchParameter>]] [-SkipPermissionNotificationSending [<SwitchParameter>]] [-RestoreChangedItems [<SwitchParameter>]] [-RestoreDeletedItems [<SwitchParameter>]] [-RestoreListViews [<SwitchParameter>]]  [<CommonParameters>]

  • To restore a SharePoint document library:

Restore-VESPItem [-DocumentLibrary] <VESPDocumentLibrary> [-TargetList <String>] [[-SiteURL] <String>] [-SiteAlias <String>] [-Credential <PSCredential>] [-RestorePermissions [<SwitchParameter>]] [-SkipPermissionNotificationSending [<SwitchParameter>]] [-RestoreChangedItems [<SwitchParameter>]] [-RestoreDeletedItems [<SwitchParameter>]] [-RestoreListViews [<SwitchParameter>]] [<CommonParameters>]

  • To restore a specific SharePoint item:

Restore-VESPItem [-Item] <VESPItem[]> [-TargetList <String>] [[-SiteURL] <String>] [-SiteAlias <String>] [-Credential <PSCredential>] [-RestorePermissions [<SwitchParameter>]] [-SkipPermissionNotificationSending [<SwitchParameter>]] [-RestoreChangedItems [<SwitchParameter>]] [-RestoreDeletedItems [<SwitchParameter>]] [<CommonParameters>]

  • To restore a SharePoint document:

Restore-VESPItem [-Document] <VESPDocument[]> [-TargetList <String>] [[-SiteURL] <String>] [-SiteAlias <String>] [-Credential <PSCredential>] [-RestorePermissions [<SwitchParameter>]] [-SkipPermissionNotificationSending [<SwitchParameter>]] [-RestoreChangedItems [<SwitchParameter>]] [-RestoreDeletedItems [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet restores SharePoint items.

Restore-VESPItem Note:

Mind the following:

  • To perform restore operations, you must first start a restore session. For more information on how to start a restore session, see Start-VBOExchangeItemRestoreSession.
  • This cmdlet requires the PSCredential object. Use the Get-Credential cmdlet to create the PSCredentials object. For detailed instructions on how to run Get-Credential, see this Microsoft article.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Site

Specifies a name of the SharePoint site. This cmdlet will restore SharePoint item from the specified SharePoint site.

True

0

True (ByValue)

False

RestoreSubsites

Indicates that the cmdlet will restore child sites.

False

Named

False

False

SiteURL

Specifies the SharePoint site URL. This cmdlet will restore SharePoint item to a SharePoint site with the specified URL.

True

1

False

False

SiteAlias

Specifies the SharePoint alias site URL. This cmdlet will restore SharePoint item a with the specified alias site URL.

False

Named

False

False

Credential

Specifies account credentials that you want to use for connecting to the SharePoint server.

If omitted, the cmdlet will use a currently logged in user Windows account credentials for connecting to the SharePoint server.

False

Named

False

False

RestorePermissions

Indicates that the cmdlet will restore permissions.

False

Named

False

False

Skip
Permission
NotificationSending

Indicates that the cmdlet will not send permission notification.

False

Named

False

False

RestoreChangedItems

Indicates that the cmdlet will restore changed items.

False

Named

False

False

RestoreDeletedItems

Indicates that the cmdlet will restore deleted items.

False

Named

False

False

RestoreListViews

Indicates that the cmdlet will restore the SharePoint list views.

False

Named

False

False

List

Specifies a name of the SharePoint list. This cmdlet will restore the SharePoint item from the specified list.

True

0

True (ByValue)

False

TargetList

Specifies a name of the SharePoint list. The cmdlet will restore items to this list.

False

Named

False

False

DocumentLibrary

Specifies a name of the SharePoint document library. This cmdlet will restore a SharePoint item from a specified document library.

True

0

True (ByValue)

Fase

Item

Specifies a name of the SharePoint item. This cmdlet will restore a specified SharePoint item.

True

Named

True (ByValue)

False

Document

Specifies a name of the SharePoint document. This cmdlet will restore a SharePoint item with a specified SharePoint document.

True

0

True (ByValue)

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

[For Veeam Backup for Microsoft Office 365] This example shows how to restore the Teams SharePoint site.

  1. Run the Get-Credential cmdlet to create a credential object. Type the credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  4. Run the Get-VESPSite cmdlet with the $organization variable and the Name parameter to get the Teams site from the ABC SharePoint organization. Save the result to the $site variable.
  5. Run the Restore-VESPItem cmdlet with the $site and $credentials variables. Use RestoreSubsites, RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$site = Get-VESPSite -Organization $organization -Name "Teams"

Restore-VESPItem -Site $site -RestoreSubsites -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Example 2

[For Veeam Backup for Microsoft Office 365] This example shows how to restore the Color names SharePoint list to the ABC organization production list.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  4. Run the Get-VESPList cmdlet with the $organization variable and the Name parameter to get the Color name site from the ABC SharePoint organization. Save the result to the $site variable.
  5. Run the Restore-VESPItem cmdlet with the $list and $credentials variables. Use the RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parameters in order to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$list = Get-VESPList -Organization $organization -Name "Color names"

Restore-VESPItem -List $list -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Example 3

[For Veeam Backup for Microsoft Office 365] This example shows how to restore the Test Document Library SharePoint document library.

  1. Run the Get-Credential cmdlet  to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
  4. Run the Get-VESPDocumentLibrary cmdlet with the $organization variable and the Name parameter to get the Documents document library from the SharePoint organization. Save the result to the $documentLibrary variable.
  5. Run the Restore-VESPItem cmdlet with the $documentLibrary and $credentials variables. Use the RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parameters to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Documents"

Restore-VESPItem -DocumentLibrary $documentLibrary -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Example 4

[For Veeam Backup for Microsoft Office 365] This example shows how to restore a SharePoint item from the ABC organization.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPOrganization cmdlet with the Name parameter to get the ABC organization. Save the result to the $organization variable.
  4. Run the Get-VESPItem cmdlet with the $organization variable and a value for the Query parameter. Save the result to the $item variable.
  5. Run the Restore-VESPItem cmdlet with the $item and $credentials variables. Use the RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parameters to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$item = Get-VESPItem -Organization $organization -Query

Restore-VESPItem -Item $item -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems

Example 5

[For Veeam Backup for Microsoft Office 365] This example shows how to restore a SharePoint item.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPOrganization cmdlet with the Name parameter to get the ABC organization. Save the result to the $organization variable.
  4. Run the Get-VESPDocument cmdlet with the $organization variable and the reports.txt value for the Query parameter. Save the result to the $document variable.
  5. Run the Restore-VESPItem cmdlet with the $document and $credentials variables. Use the RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parametres to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$document = Get-VESPDocument -Organization $organization -Query "reports.txt"

Restore-VESPItem -Document $document -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems

Example 6

[For Veeam Backup & Replication] This example shows how to restore the Teams SharePoint site.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPDatabase cmdlet with the $session variable and the Name parameter to get the WSS_Content.mdf SharePoint database. Save the result to the $database variable.
  4. Run the Get-VESPSite cmdlet with the $database variable and the Name parameter to get the Teams site. Save the result to the $site variable.
  5. Run the Restore-VESPItem cmdlet with the $site and $credentials variables and a value for the SiteURL parameter. Use RestoreSubsites, RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parametres to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$site = Get-VESPSite -Database $database -Name "Teams"

Restore-VESPItem -Site $site -RestoreSubsites -SiteURL "http://servername/sitename" -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Example 7

[For Veeam Backup & Replication] This example shows how to restore the Color names SharePoint list to the production list.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  4. Run the  Get-VESPList cmdlet with the $database variable and the Name parameter to get the Color names site from the SharePoint database. Save the result to the $site variable.
  5. Run the Restore-VESPItem cmdlet with the $list and $credentials variables and a value for the SiteURL parameter. Use RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$list = Get-VESPList -Database $database -Name "Color names"

Restore-VESPItem -List $list -SiteURL "http://servername/sitename" -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Example 8

[For Veeam Backup & Replication] This example shows how to restore the RegulationsSharePoint document library.

  1. Run the Get-Credential cmdlet to create a credential object. Type credentials that you want to use for connecting to the SharePoint server. Save the result to the $credentials variable.
  2. Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
  3. Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  4. Run the Get-VESPDocumentLibrary cmdlet with the $database variable and the Name parameter to get the Regulations document library. Save the result to the $documentLibrary variable.
  5. Run the Restore-VESPItem cmdlet with the $documentLibrary and $credentials variables and a value for the SiteURL parameter. Use the RestorePermissions, RestoreChangedItems, RestoreDeletedItems and RestoreListViews parameters to restore the corresponding objects.

$credentials = Get-Credential

$session = Get-VBRSharePointItemRestoreSession

$database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

$documentLibrary = Get-VESPDocumentLibrary -Database $database -Name "Regulations"

Restore-VESPItem -DocumentLibrary $documentLibrary -SiteURL "http://servername/sitename" -Credential $credentials -RestorePermissions -RestoreChangedItems     -RestoreDeletedItems -RestoreListViews

Related Commands

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation