Restore-VESPItem - Veeam Explorers PowerShell Reference

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Site	Specifies a name of the SharePoint site. This cmdlet will restore SharePoint items from the specified SharePoint site.	Accepts the VESPSite object. To get this object, run the Get-VESPSite cmdlet.	True	0	True (ByValue)
List	Specifies a name of the SharePoint list. This cmdlet will restore SharePoint items from the specified list.	Accepts the VESPList object. To get this object, run the Get-VESPList cmdlet.	True	0	True (ByValue)
DocumentLibrary	Specifies a name of the SharePoint document library. This cmdlet will restore SharePoints item from a specified document library.	Accepts the VESPDocumentLibrary object. To get this object, run the Get-VESPDocumentLibrary cmdlet.	True	0	True (ByValue)
Item	Specifies an array of names for SharePoint items. This cmdlet will restore SharePoint items with the specified names.	Accepts the VESPItem[] object. To get this object, run the Get-VESPItem cmdlet.	True	Named	True (ByValue)
Document	Specifies an array of names for SharePoint documents. This cmdlet will restore SharePoint items from documents with the specified names.	Accepts the VESPDocument[] object. To get this object, run the Get-VESPDocument cmdlet.	True	0	True (ByValue)
ApplicationId	To restore data using Multi-factor authentication. Specifies an ID of an Azure AD application. The cmdlet will use this application ID to set up a secure connection to a Microsoft organization. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.	Guid	True	Named	False
ApplicationCertificatePath	To restore data using Multi-factor authentication. Specifies a path to the folder where the certificate is located. The cmdlet will import the certificate that is located in this path to set up an encrypted connection to a Microsoft organization. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.	String	True	Named	False
ApplicationCertificatePassword	To restore data using Multi-factor authentication. Specifies the certificate password. The cmdlet will use this password to confirm the certificate that you want to import to an Azure AD application. This parameter is obligatory. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.	String	True	Named	False
ImpersonationAccountName	To restore data using Multi-factor authentication. Specifies a user name of the account that will be used as a SharePoint site owner account to restore a SharePoint site. Use this parameter together with the ApplicationCertificatePassword parameter. Note: This parameter is available for restore from backups created by Veeam Backup for Microsoft Office 365 version 4c and later.	String	True	Named	False
SiteURL	Specifies the SharePoint site URL. This cmdlet will restore SharePoint item to a SharePoint site with the specified URL. If you do not provide this parameter, the cmdlet will restore a SharePoint site to the original site. Note: This parameter does not work for restore from backups created by Veeam Backup for Microsoft Office 365.	String	True	1	False
RestoreSubsites	Indicates that the cmdlet will restore child sites.	SwitchParameter	False	Named	False
SiteAlias	Specifies the SharePoint alias site URL. This cmdlet will restore SharePoint item with the specified alias site URL. Note: This parameter does not work for restore from backups created by Veeam Backup & Replication.	String	False	Named	False
TargetList	Specifies a name of the SharePoint list. The cmdlet will restore items to this list. Note: If you do not provide this parameter, the cmdlet will restore the SharePoint list to the original location.	String	False	Named	False
Credential	Specifies account credentials that you want to use to connect to the SharePoint server. If omitted, the cmdlet will use a currently logged in user Windows account credentials for connecting to the SharePoint server.	PSCredential	False	Named	False
RestorePermissions	Defines that the cmdlet will restore permissions.	SwitchParameter	False	Named	False
SkipPermissionNotificationSending	Defines that the cmdlet will not send permission notification.	SwitchParameter	False	Named	False
RestoreChangedItems	Defines that the cmdlet will restore changed items.	SwitchParameter	False	Named	False
RestoreDeletedItems	Defines that the cmdlet will restore deleted items.	SwitchParameter	False	Named	False
RestoreListViews	Defines that the cmdlet will restore the SharePoint list views.	SwitchParameter	False	Named	False

This example shows how to restore the Teams SharePoint site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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 -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Perform the following steps:

Get the SharePoint site:

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.
Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Get-VESPSite cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Teams SharePoint site to the http://servername/sitename site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

Get the SharePoint site:

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.
Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Get-VESPSite cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Color names SharePoint list to the http://servername/sitename site with the following settings:

The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

Get the SharePoint list:

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.
Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.

Run the Get-VESPList cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $list variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $list variable as the List parameter value.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the RegulationsSharePoint document library to the http://servername/sitename site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.

$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

Perform the following steps:

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.
Get the SharePoint document library:

Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Get-VESPDocumentLibrary cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $documentLibrary variable as the DocumentLibrary parameter value.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.

This example shows how to restore the reports.txt document from the Teams site to the http://servername/sitename site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$session = Get-VBRSharePointItemRestoreSession

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

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

$document = Get-VESPDocument -Site $site -Query "reports.txt"

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

Perform the following steps:

Get the SharePoint document.

Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
Run the Get-VESPSite cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $site variable.
Run the Get-VESPDocument cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $documentLibrary variable as the DocumentLibrary parameter value.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.

This example shows how to restore the Teams SharePoint site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

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.
Get the SharePoint site.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPSite cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.

Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Teams SharePoint site with the following settings:

The cmdlet will apply the 6049d4a6-b814-4b67-aa4c-14580af94dce Azure AD application ID to connect to a Microsoft Organization.
The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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 -ApplicationId "6049d4a6-b814-4b67-aa4c-14580af94dce" -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Perform the following steps:

Get the SharePoint site.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPSite cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Set the $credentials variable as the Credential parameter value.
Specify the ApplicationId parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.

Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Teams SharePoint site with the following settings:

The cmdlet will apply the 6049d4a6-b814-4b67-aa4c-14580af94dce Azure AD application ID to connect to a Microsoft Organization.

The cmdlet will use the certificate located at the C:\Certificate\ path.

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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 -ApplicationId "6049d4a6-b814-4b67-aa4c-14580af94dce" -ApplicationCertificatePath "C:\Certificate\" -ApplicationCertificatePassword $securepassword -ImpersonationAccountName global2@tech-365.tech -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Perform the following steps:

Get the SharePoint site.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPSite cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Read-Host cmdlet to specify the password. Specify the text that will show up in the password prompt window in the Prompt parameter. Provide the AsSecureString parameter to convert the password to the secure string.
Enter the password.
Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Set the $credentials variable as the Credential parameter value.
Specify the ApplicationId parameter value.
Specify the ApplicationCertificatePath parameter value.
Specify the ApplicationCertificatePassword parameter value.
Specify the ImpersonationAccountName parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Teams SharePoint site to the AliasTeamSite alias site with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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 -SiteAlias "Alias" -Credential $credentials -RestorePermissions -RestoreChangedItems -RestoreDeletedItems -RestoreListViews

Perform the following steps:

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.
Get the SharePoint site.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPSite cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $site variable as the Site parameter value.
Provide the RestoreSubsites parameter.
Specify the SiteURL parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Color names SharePoint list to the ABC organization production list with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

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.
Get the SharePoint list.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPList cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $list variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $list variable as the List parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore the Test Document Library SharePoint document library with the following settings:

The cmdlet will restore site permissions.
The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

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.
Get the SharePoint document library.

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPDocumentLibrary cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $documentLibrary variable as the DocumentLibrary parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore a SharePoint item added to the ABC organization with the following settings:

The cmdlet will restore site permissions.

The cmdlet will restore changed items.
The cmdlet will restore deleted items.
The cmdlet will restore the SharePoint list views.

$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

Perform the following steps:

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.
Get the SharePoint item:

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPItem cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $item variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $item variable as the Item parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.
Provide the RestoreListViews parameter.

This example shows how to restore a SharePoint document with the following settings:

The cmdlet will restore site permissions.

The cmdlet will restore changed items.
The cmdlet will restore deleted items.

$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

Perform the following steps:

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.
Get the SharePoint document:

Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
Run the Get-VESPDocument cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value. Save the result to the $document variable.

Run the Restore-VESPItem cmdlet. Specify the following settings:

Set the $document variable as the Document parameter value.
Set the $credentials variable as the Credential parameter value.
Provide the RestorePermissions parameter.
Provide the RestoreChangedItems parameter.
Provide the RestoreDeletedItems parameter.