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 365

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

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

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

Examples

Example 1. Getting SharePoint Document Library from SharePoint Database [For Veeam Backup & Replication]

This example shows how to get all SharePoint document libraries from the WSS_Content.mdf SharePoint database.

$session = Get-VBRSharePointItemRestoreSession

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

Get-VESPDocumentLibrary -Database $database

Perform the following steps:

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.

Example 2. Getting SharePoint Document Library from SharePoint Database [For Veeam Backup & Replication]

This example shows how to get the Regulations document library from the Teams SharePoint site.

$session = Get-VBRSharePointItemRestoreSession

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

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

Get-VESPDocumentLibrary -Site $site -Name "Regulations"

Perform the following steps:

Get a SharePoint site:

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-VESPSite cmdlet. Set the $database variable as the Database 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.

Example 3. Getting SharePoint Document Library from Microsoft Organization [For Veeam Backup for Microsoft 365]

This example shows how to get the Regulations document library from the ABC Microsoft organization.

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

Get-VESPDocumentLibrary -Organization $organization -Name "Regulations"

Perform the following steps:

Run the Get-VBOSharePointItemRestoreSession 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 $organization variable as the Organization parameter value. Specify the Name parameter value.

Example 4. Getting SharePoint Document Library from SharePoint Site [For Veeam Backup for Microsoft 365]

This example shows how to get the Regulations document library from the Teams SharePoint site.

$session = Get-VBOSharePointItemRestoreSession

$organization = Get-VESPOrganization -Session $session -Name "ABC"

$site = Get-VESPSite -Organization $organization -Name "Teams"

Get-VESPDocumentLibrary -Site $site -Name "Regulations"

Perform the following steps:

Get a SharePoint site:

Run the Get-VBOSharePointItemRestoreSession 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-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.

Related Commands