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

Save-VESPItem

Short Description

Saves SharePoint items.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides the following parameter sets.

  • 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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

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

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

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> $documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Regulations"

PS C:\PS> 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.

  1. Run Get-VBOSharePointItemRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the ABC organization. Save the result to the $organization variable.
  3. Run Get-VESPDocument 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.
  4. Run Save-VESPItem with the $document variable and the Path parameter to save the reports.txt document to the specified path.

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> $document = Get-VESPDocument -Organization $organization -Query "reports.txt"

PS C:\PS> 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.

  1. Run Get-VBOSharePointItemRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the ABC organization. Save the result to the $organization variable.
  3. Run Get-VESPItem 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.
  4. Run Get-VESPItemAttachment with the $item variable to get SharePoint item attachments. Save the result to the $attachment variable.
  5. Run Save-VESPItem with the $attachment variable and the Path parameter to save attachments to the reports.txt item to the specified path.

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> $item = Get-VESPItem -Organization $organization -Query "reports.txt"

PS C:\PS> $attachment = Get-VESPItemAttachment -Item $item

PS C:\PS> 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.

  1. Run Get-VBRSharePointItemRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VESPDatabase with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  3. Run Get-VESPDocumentLibrary with the $database variable and the Name parameter to get the Regulations document library. Save the result to the $documentLibrary variable.
  4. Run Save-VESPItem with the $documentLibrary variable and the Path parameter to save the Regulations document library to the specified path.

PS C:\PS> $session = Get-VBRSharePointItemRestoreSession

PS C:\PS> $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

PS C:\PS> $documentLibrary = Get-VESPDocumentLibrary -Database $database -Name "Regulations"

PS C:\PS> 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.

  1. Run Get-VBRSharePointItemRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VESPDatabase with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  3. Run Get-VESPDocument 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.
  4. Run Save-VESPItem with the $document variable and the Path parameter to save the reports.txt document to the specified path.

PS C:\PS> $session = Get-VBRSharePointItemRestoreSession

PS C:\PS> $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

PS C:\PS> $document = Get-VESPDocument -Database $database -Query "reports.txt"

PS C:\PS> 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.

  1. Run Get-VBRSharePointItemRestoreSession to get an active restore session. Save the result to the $session variable.
  2. Run Get-VESPDatabase with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
  3. Run Get-VESPItem 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.
  4. Run Get-VESPItemAttachment with the $item variable to get the Reports SharePoint item attachments. Save the result to the $attachment variable.
  5. Run Save-VESPItem with the $document variable and the Path parameter to save the Reports SharePoint item attachments to the specified path.

PS C:\PS> $session = Get-VBRSharePointItemRestoreSession

PS C:\PS> $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf"

PS C:\PS> $item = Get-VESPItem -Database $database -Query "Reports"

PS C:\PS> $attachment = Get-VESPItemAttachment -Item $item

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

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