Save-VESPItem
Saves SharePoint items.
Veeam Backup for Microsoft 365, Veeam Backup & Replication
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
This cmdlet provides parameter sets that allow you to:
- Save a SharePoint document library.
Save-VESPItem [-DocumentLibrary] <VESPDocumentLibrary> [-Path] <String> [-AsZip] [-Force] [<CommonParameters>] |
- Save a specific SharePoint document.
Save-VESPItem [-Document] <VESPDocument[]> [-Path] <String> [-AsZip] [-Force] [<CommonParameters>] |
- Save a SharePoint attached item.
Save-VESPItem [-ItemAttachment] <VESPItemAttachment[]> [-Path] <String> [-AsZip] [-Force] [<CommonParameters>] |
This cmdlet saves SharePoint items such as document libraries, documents and attached items.
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|
DocumentLibrary | Specifies a SharePoint document library that you want to save. | Accepts the VESPDocumentLibrary object. To get this object, run the Get-VESPDocumentLibrary cmdlet. | True | 0 | True (ByValue) |
Path | Specifies a path to the specified item. | String | True | 1 | True (ByValue) |
AsZip | Defines that the cmdlet will save the specified item as a ZIP archive. Default: False | SwitchParameter | False | Named | False |
Force | Defines that the cmdlet will create a folder in the specified directory. Default: False | SwitchParameter | False | Named | False |
Document | Specifies an array of SharePoint documents that you want to save. | Accepts the VESPDocument[] object. To get this object, run the Get-VESPDocument cmdlet. | True | 0 | True (ByValue) |
ItemAttachment | Specifies an array of SharePoint item attachments that you want to save. | Accepts the VESPItemAttachment[]object. To get this object, run the Get-VESPItemAttachment cmdlet. | True | 0 | True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
None.
This example shows how to save the Regulations document library to the C:\save 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" |
Perform the following steps: - 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 Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value.
|
This example shows how to save the reports.txt document to the C:\save 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" |
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-VESPDocument cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $document variable.
- Run the Save-VESPItem cmdlet. Set the $document variable as the Document parameter value. Specify the Path parameter value.
|
This example shows how to save attachments for the Documents item to the C:\save 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" |
Perform the following steps: - Get the SharePoint item:
- 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-VESPItem cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $item variable.
- Run the Get-VESPItemAttachment cmdlet. Set the $item variable as the Item parameter value. Save the result to the $attachment variable.
- Run the Save-VESPItem cmdlet. Set the $attachment variable as the ItemAttachment parameter value. Specify the Path parameter value.
|
This example shows how to save the Regulations document library to the C:\save path. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC*" $documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Regulations" Save-VESPItem -DocumentLibrary $documentLibrary -Path "C:\save" |
Perform the following steps: - 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. Use the * wildcard character to substitute the timestamp. 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 Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value.
|
This example shows how to save the Regulations document library created by a specific backup job to the ZIP archive file. $session = Start-VBOSharePointItemRestoreSession -Job $Job -LatestState $organization = Get-VESPOrganization -Session $session $site = Get-VESPSite -Organization $organization -Name "Site" $documentLibrary = Get-VESPDocumentLibrary -Site $site -Name "Regulations" Save-VESPItem -DocumentLibrary $documentLibrary -Path "C:\Save\archive.zip" -AsZip |
Perform the following steps: - Get the SharePoint document library:
- Run the Start-VBOSharePointItemRestoreSession cmdlet. Specify the Job parameter value. Provide the LatestState parameter. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session 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 Get-VESPDocumentLibrary cmdlet. Set the $site variable as the Site parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
- Run the Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value. Provide the AsZip parameter.
|
This example shows how to save the reports.txt document to the C:\save 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" |
Perform the following steps: - 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. Use the * wildcard character to substitute the timestamp. 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 Save-VESPItem cmdlet. Set the $document variable as the Document parameter value. Specify the Path parameter value.
|
This example shows how to save attachments to the reports.txt item to the C:\save 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" |
Perform the following steps: - 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. Use the * wildcard character to substitute the timestamp. Save the result to the $organization variable.
- Run the Get-VESPItem cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value. Save the result to the $item variable.
- Run the Get-VESPItemAttachment cmdlet. Set the $item variable as the Item parameter value. Save the result to the $attachment variable.
- Run the Save-VESPItem cmdlet. Set the $attachment variable as the ItemAttachment parameter value. Specify the Path parameter value.
|
Related Commands
Example 1. Saving SharePoint Document Library [For Veeam Backup & Replication]