Veeam Backup for Microsoft 365 8
Veeam Explorers PowerShell Reference
ASK LLM
Ask ChatGPT Ask Claude Ask Grok Ask Perplexity
Related documents
Search

Save-VESPItem

Short Description

Saves SharePoint items.

Product: Veeam Backup & Replication, Veeam Backup for Microsoft 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

  • docLibParameterSet

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

  • documentParameterSet

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

  • attachParameterSet

    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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

AsZip

Defines that the cmdlet will save the specified item as a ZIP archive.

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-VESPDocumentReturns SharePoint documents. cmdlet.

VESPDocument[]

True

0

True (ByValue)

DocumentLibrary

Specifies a SharePoint document library that you want to save.

Accepts the VESPDocumentLibrary object. To get this object, run the Get-VESPDocumentLibraryReturns SharePoint document libraries. cmdlet.

VESPDocumentLibrary

True

0

True (ByValue)

Force

Defines that the cmdlet will create a folder in the specified directory.

Default: False

SwitchParameter

False

Named

False

ItemAttachment

Specifies an array of SharePoint item attachments that you want to save.

Accepts the VESPItemAttachment[] object. To get this object, run the Get-VESPItemAttachmentReturns attachments of the specified SharePoint item. cmdlet.

VESPItemAttachment[]

True

0

True (ByValue)

Path

Specifies a path to the specified item.

String

True

1

True (ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Examples

Save-VESPItemExample 1. Saving SharePoint Document Library [For Veeam Backup & Replication]

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:

  1. Get the SharePoint document library:

    1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
    3. Run the Get-VESPDocumentLibraryReturns SharePoint document libraries. cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
  2. Run the Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value.

Save-VESPItemExample 2. Saving SharePoint Document [For Veeam Backup & Replication]

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:

  1. Get the SharePoint document:

    1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
    3. Run the Get-VESPDocumentReturns SharePoint documents. cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $document variable.
  2. Run the Save-VESPItem cmdlet. Set the $document variable as the Document parameter value. Specify the Path parameter value.

Save-VESPItemExample 3. Saving SharePoint Item Attachment [For Veeam Backup & Replication]

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:

  1. Get the SharePoint item:

    1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $database variable.
    3. Run the Get-VESPItemReturns SharePoint items. cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $item variable.
    4. Run the Get-VESPItemAttachmentReturns attachments of the specified SharePoint item. cmdlet. Set the $item variable as the Item parameter value. Save the result to the $attachment variable.
  2. Run the Save-VESPItem cmdlet. Set the $attachment variable as the ItemAttachment parameter value. Specify the Path parameter value.

Save-VESPItemExample 4. Saving SharePoint Document Library [For Veeam Backup for Microsoft 365]

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:

  1. Get the SharePoint document library:

    1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
    3. Run the Get-VESPDocumentLibraryReturns SharePoint document libraries. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
  2. Run the Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value.

Save-VESPItemExample 5. Saving SharePoint Document Library from Specific Backup Job [For Veeam Backup for Microsoft 365]

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:

  1. Get the SharePoint document library:

    1. Run the Start-VBOSharePointItemRestoreSessionStarts restore sessions to explore backed-up SharePoint items and to perform operations with these items. cmdlet. Specify the Job parameter value. Provide the LatestState parameter. Save the result to the $session variable.
    2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. cmdlet. Set the $session variable as the Session parameter value. Save the result to the $organization variable.
    3. Run the Get-VESPSiteReturns SharePoint sites. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.
    4. Run the Get-VESPDocumentLibraryReturns SharePoint document libraries. cmdlet. Set the $site variable as the Site parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
  2. Run the Save-VESPItem cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Path parameter value. Provide the AsZip parameter.

Save-VESPItemExample 6. Saving SharePoint Document [For Veeam Backup for Microsoft 365]

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:

  1. Get the SharePoint document:

    1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
    3. Run the Get-VESPDocumentReturns SharePoint documents. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value. Save the result to the $document variable.
  2. Run the Save-VESPItem cmdlet. Set the $document variable as the Document parameter value. Specify the Path parameter value.

Save-VESPItemExample 7. Saving SharePoint Item Attachment [For Veeam Backup for Microsoft 365]

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:

  1. Get the SharePoint item:

    1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
    3. Run the Get-VESPItemReturns SharePoint items. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value. Save the result to the $item variable.
    4. Run the Get-VESPItemAttachmentReturns attachments of the specified SharePoint item. cmdlet. Set the $item variable as the Item parameter value. Save the result to the $attachment variable.
  2. Run the Save-VESPItem cmdlet. Set the $attachment variable as the ItemAttachment parameter value. Specify the Path parameter value.

Page updated 2026-08-20

Page content applies to build 8.5.0.1014

View all results across Veeam Help Center
Back to document search