Get-VESPDocumentLibrary - Veeam Backup for Microsoft Office 365 PowerShell Reference
Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Get-VESPDocumentLibrary

Short Description

Returns SharePoint document libraries.

Syntax

This cmdlet provides 2 parameter sets.

  • For getting document library from a SharePoint organization:

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

  • For getting 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 the needed document library.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

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

False

1

False

True

Organization

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

True

0

True (ByValue)

False

Site

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

True

0

True (ByValue)

False

Recurse

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

False

Named

False

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

This example shows how to get a document library with a name "Test Document Library" from a SharePoint organization.

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable  to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPDocumentLibrary with the $organization variable and Name parameter to get a document library with a name "Test Document Library"

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

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

PS C:\PS> Get-VESPDocumentLibrary -Organization $organization -Name "Test Document Library"

Example 2

This example shows how to get a document library with a name "Test Document Library" from a SharePoint site with a name "Team Site".

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPSite with the $organization variable and and Name parameter to get a SharePoint site with a name "Team Site".
  4. Run Get-VESPDocumentLibrary with the $site variable and Name parameter to get a document library with a name "Test Document Library"

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

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

PS C:\PS> $site = Get-VESPSite -Organization $organization -Name "Team Site"

PS C:\PS> Get-VESPDocumentLibrary -Site $site -Name "Test Document Library"

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference