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

Get-VESPDocumentLibrary

Short Description

Returns SharePoint document libraries.

Applies to: Veeam Backup & Replication, Veeam Backup for Microsoft Office 365

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get a document library from a backed-up SharePoint database.

Get-VESPDocumentLibrary [-Database] <VESPDatabase> [[-Name] <String[]>]  [<CommonParameters>]

  • Get a document library from a Microsoft organization.

Get-VESPDocumentLibrary -Organization <VESPOrganization> [-Name <string[]>]  [<CommonParameters>]

  • Get a document library from a SharePoint site.

Get-VESPDocumentLibrary -Site <VESPSite> [-Name <string[]>] [-Recurse]  [<CommonParameters>]

Detailed Description

This cmdlet returns document libraries. You can search the SharePoint database, site or the whole organization to get a specific document library.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Database

Specifies a backed-up SharePoint database. The cmdlet will return document libraries from the specified database.

Accepts the VESPDatabase[] object. To get this object, run the Get-VESPDatabase cmdlet.

True

0

True (ByValue)

Organization

Specifies an organization. The cmdlet will return the document library from this organization.

Accepts the VESPOrganization[] object. To get this object, run the Get-VESPOrganization cmdlet.

True

0

True (ByValue)

Site

Specifies a name of the SharePoint site. This cmdlet will return a document library from the specified SharePoint site.

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

True

0

True (ByValue)

Name

Specifies a name of the SharePoint document library. This cmdlet will return a document library with the specified name.

String

False

1

False

Recurse

Defines that the cmdlet will return items from all subfolders of the specified parent folder.

SwitchParameter

False

Named

False

<CommonParameters>

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

Examples

Get-VESPDocumentLibraryExample 1. Getting SharePoint Document Library from SharePoint Database [For Veeam Backup & Replication]

Get-VESPDocumentLibraryExample 2. Getting SharePoint Document Library from SharePoint Database [For Veeam Backup & Replication]

Get-VESPDocumentLibraryExample 3. Getting SharePoint Document Library from Microsoft Organization [For Veeam Backup for Microsoft Office 365]

Get-VESPDocumentLibraryExample 4. Getting SharePoint Document Library from SharePoint Site [For Veeam Backup for Microsoft Office 365]

Related Commands