Export-VESPItem

Short Description

Exports SharePoint items.

Applies to

Veeam Backup & Replication

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Export to the SharePoint document library.

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

  • Export to the SharePoint list.

Export-VESPItem [-List <VESPList>] -Path <String> [-Force] [<CommonParameters>]

Detailed Description

This cmdlet exports SharePoint lists and document libraries.

Export-VESPItem Note:

Consider the following:

  • This cmdlet is available for backups created with Veeam Backup & Replication.
  • Before performing export operations, you must first start a restore session. For more information, see Start-VBRSharePointItemRestoreSession.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

DocumentLibrary

Specifies a SharePoint document library. This cmdlet will export the specified SharePoint document library.

Accepts the DocumentLibrary object. To get this object, run the Get-VESPDocumentLibrary cmdlet.

True

0

True (ByValue)

Path

Specifies a path to the export destination directory.

String

True

Named

True (ByValue)

Force

Defines that the cmdlet will create a folder in the specified directory and will overwrite the existing item with the same name.

Default: False

SwitchParameter

False

Named

False

List

Specifies a SharePoint list. This cmdlet will export the specified SharePoint list.

Accepts the VESPList object. To get this object, run the Get-VESPList 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.

Examples

Export-VESPItemExample 1. Exporting SharePoint Document Library [For Veeam Backup & Replication]

This example shows how to export the SharePoint document library to the C:\ExportedDocLibrary folder.

$session = Get-VBRSharePointItemRestoreSession

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

$doclib = Get-VESPDocumentLibrary -Database $database -Name "Document_Library"

Export-VESPItem -DocumentLibrary $doclib -Path "C:\ExportedDocLibrary" -Force

Perform the following steps:

  1. Get the SharePoint document library:
  1. Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
  2. 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.
  3. Run the Get-VESPDocumentLibrary cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $doclib variable.
  1. Run the Export-VESPItem cmdlet. Set the $doclib variable as the DocumentLibrary parameter value. Specify the Path parameter value. Provide the Force parameter.

Export-VESPItemExample 2. Exporting SharePoint List [For Veeam Backup & Replication]

This example shows how to export the Calendar SharePoint list to the C:\ExportedLists folder.

$restorepoint = Get-VBRApplicationRestorePoint -SharePoint -Name "SharePoint server"

$session = Start-VBRSharePointItemRestoreSession -RestorePoint $restorePoint

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

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

$list = Get-VESPList -Site $site -Name "Calendar"

Export-VESPItem -List $list -Path C:\ExportedLists -Force

Perform the following steps:

  1. Get the SharePoint list:
  1. Run the Get-VBRApplicationRestorePoint cmdlet. Specify the SharePoint parameter value. Specify the Name parameter value. Save the result to the $restorepoint variable.
  2. Run the Start-VBRSharePointItemRestoreSession cmdlet. Set the $restorePoint variable as the RestorePoint parameter value. Save the result to the $session variable.
  3. 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.
  4. 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.
  5. Run the Get-VESPList cmdlet. Set the $site variable as the Site parameter value. Specify the Name parameter value. Save the result to the $list variable.
  1. Run the Export-VESPItem cmdlet. Set the $list variable as the List parameter value. Specify the Path parameter value. Provide the Force parameter.

Related Commands

Page updated 6/21/2024

Page content applies to build 12.3.0.310