This is an archive version of the document. To get the most up-to-date information, see the current version.

Save-VESPItem

In this article

Short Description

Saves SharePoint items.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

To save a SharePoint document library:

Save-VESPItem [-DocumentLibrary] <VESPDocumentLibrary> [-Path] <string> [-AsZip] [-Force] [<CommonParameters>]

To save a specific SharePoint document:

Save-VESPItem [-Document] <VESPDocument[]> [-Path] <string> [-AsZip] [-Force] [<CommonParameters>]

To save a SharePoint attached item:

Save-VESPItem [-ItemAttachment] <VESPItemAttachment[]> [-Path] <string> [-AsZip] [-Force] [<CommonParameters>]

Detailed Description

This cmdlet saves SharePoint items such as document libraries, documents and attached items.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Document	Specifies SharePoint document that you want to save.	True	0	True (ByValue)	False
DocumentLibrary	Specifies SharePoint document library that you want to save.	True	0	True (ByValue)	False
ItemAttachment	Specifies SharePoint item attachment that you want to save.	True	0	True (ByValue)	False
AsZip	Indicates that the cmdlet will save the specified item as a ZIP-archive.	False	Named	False	False
Path	Specifies a path to the specified item.	True	1	False	False
Force	Indicates that the cmdlet will create a folder in the specified directory.	True	0	True (ByValue)	False

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

Example 1

[For Veeam Backup for Microsoft Office 365] This example shows how to save the Regulations document library a specified path.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPDocumentLibrary cmdlet with the $organization variable and the Name parameter to get the Regulations document library. Save the result to the $documentLibrary variable.
Run the Save-VESPItem cmdlet with the $documentLibrary variable and the Path parameter to save the Regulations document library.

$session = Get-VBOSharePointItemRestoreSession

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

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

Save-VESPItem -DocumentLibrary $documentLibrary -Path "C:\save"

Example 2

[For Veeam Backup for Microsoft Office 365] This example shows how to save the reports.txt document to a specified path.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPDocument cmdlet with the $organization variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document. Save the result to the $document variable.
Run the Save-VESPItem cmdlet with the $document variable and the Path parameter to save the reports.txt document to the specified path.

$session = Get-VBOSharePointItemRestoreSession

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

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

Save-VESPItem -Document $document -Path "C:\save"

Example 3

[For Veeam Backup for Microsoft Office 365] This example shows how to save the attachments to the reports.txt item to the specified path.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPItem cmdlet with the $organization variable and enter the reports.txt value for the Query parameter to get the reports.txt SharePoint item. Save the result to the $item variable.
Run the Get-VESPItemAttachment cmdlet with the $item variable to get SharePoint item attachments. Save the result to the $attachment variable.
Run the Save-VESPItem cmdlet with the $attachment variable and the Path parameter to save attachments to the reports.txt item to the specified path.

$session = Get-VBOSharePointItemRestoreSession

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

$item = Get-VESPItem -Organization $organization -Query "reports.txt"

$attachment = Get-VESPItemAttachment -Item $item

Save-VESPItem -ItemAttachment $attachment -Path "C:\save"

Example 4

[For Veeam Backup & Replication] This example shows how to save the Regulations document library to the specified path.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
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.
Run the Save-VESPItem cmdlet with the $documentLibrary variable and the Path parameter to save the Regulations document library to the specified path.

$session = Get-VBRSharePointItemRestoreSession

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

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

Save-VESPItem -DocumentLibrary $documentLibrary -Path "C:\save"

Example 5

[For Veeam Backup & Replication] This example shows how to save the reports.txt document to the specified path.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
Run the Get-VESPDocument cmdlet with the $database variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document. Save the result to the $document variable.
Run the Save-VESPItem cmdlet with the $document variable and the Path parameter to save the reports.txt document to the specified path.

$session = Get-VBRSharePointItemRestoreSession

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

$document = Get-VESPDocument -Database $database -Query "reports.txt"

Save-VESPItem -Document $document -Path "C:\save"

Example 6

[For Veeam Backup & Replication] This example shows how to save the attachments of the Reports SharePoint item to the specified path.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
Run the Get-VESPItem cmdlet with the $database variable and enter the Reports value for the Query parameter to get the Reports SharePoint item. Save the result to the $item variable.
Run the Get-VESPItemAttachment cmdlet with the $item variable to get the Reports SharePoint item attachments. Save the result to the $attachment variable.
Run the Save-VESPItem cmdlet with the $document variable and the Path parameter to save the Reports SharePoint item attachments to the specified path.

$session = Get-VBRSharePointItemRestoreSession

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

$item = Get-VESPItem -Database $database -Query "Reports"

$attachment = Get-VESPItemAttachment -Item $item

Save-VESPItem -ItemAttachment $attachment -Path "C:\save"

Related Commands