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

Get-VESPDocument

In this article

Short Description

Returns SharePoint documents.

Applies to

Product Edition: Community, Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

To get documents from a specified SharePoint site:

Get-VESPDocument [-Site] <VESPSite> [-Query <string>] [<CommonParameters>]

To get documents from a specified SharePoint document library:

Get-VESPDocument [-DocumentLibrary] <VESPDocumentLibrary> [-Query <string>] [-Recurse] [<CommonParameters>]

To get children of a specified SharePoint document item:

Get-VESPDocument [-ParentDocument] <VESPDocument> [-Query <String>] [-Recurse [<SwitchParameter>] [<CommonParameters>]

To get documents from a specified SharePoint organization:

Get-VESPDocument [-Organization] <VESPOrganization[]> [-Query <string>] [<CommonParameters>]

To get documents from a specified SharePoint database:

Get-VESPDocument [-Database] <VESPDatabase[]> [-Query <string>] [<CommonParameters>]

Detailed Description

This cmdlet returns SharePoint documents.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Site	Specifies a SharePoint site. This cmdlet will return SharePoint documents from a specified SharePoint site. Accepts the VESPSite object. To get this object, run the Get-VESPSite cmdlet.	True	0	True (ByValue)	False
DocumentLibrary	Specifies a document library. This cmdlet will return SharePoint documents from the specified document library. Accepts the VESPDocumentLibrary object. To get this object, run the Get-VESPDocumentLibrary cmdlet.	True	0	True (ByValue)	False
ParentDocument	Specifies a parent document in a mailbox. The cmdlet will return child documents of this parent document. Accepts the VESPDocument object. To get this object, run the Get-VESPDocument cmdlet.	True	0	True (ByValue)	False
Organization	Specifies an organization. The cmdlet will return a document library from this organization. Accepts the VESPOrganization[] object. To get this object, run the Get-VESPOrganization cmdlet.	True	0	True (ByValue)	False
Database	Specifies a name of the SharePoint database. This cmdlet will return SharePoint documents from the specified database. NOTE: This parameter is available for SahrePoint databases backed up by means of Veeam Backup & Replication. Accepts the VESPDatabase[] object. To get this object, run the Get-VESPDatabase cmdlet.	True	0	True (ByValue)	False
Query	Allows using keywords for item search. The cmdlet will return items that match the search query from the specified database, site, list or item.	False	Named	False	False
Recurse	Indicates that the cmdlet will return the specified parent document and all of its children.	False	Named	False	False

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

Example 1

[For Veeam Backup for Microsoft Office 365] This example shows how to get the reports.txt document from the Teams site.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPSite cmdlet with the $organization variable and the Name parameter to get the specific site from the organization. Save the result to the $site variable.
Run the Get-VESPDocument cmdlet with the $site variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document.

$session = Get-VBOSharePointItemRestoreSession

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

$site = Get-VESPSite -Organization $organization -Name "Team Site"

Get-VESPDocument -Site $site -Query "reports.txt"

Example 2

[For Veeam Backup for Microsoft Office 365] This example shows how to get the reports.txt document from the content.mdf database.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPDocument cmdlet with the $organization variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document.

$session = Get-VBOSharePointItemRestoreSession

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

Get-VESPDocument -Organization $organization -Query "report.txt"

Example 3

[For Veeam Backup for Microsoft Office 365] This example shows how to get the report.txt document from the Regulations document library.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPDocumentLibrary cmdlet with the $organization variable and the Name parameter to get the report.txt SharePoint document library. Save the result to the $documentLibrary variable.
Run the Get-VESPDocument cmdlet with the $documentLibrary variable and the report.txt value for the Query parameter to get the report.txt SharePoint document.

$session = Get-VBOSharePointItemRestoreSession

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

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

Get-VESPDocument -DocumentLibrary $documentLibrary -Query "report.txt"

Example 4

[For Veeam Backup for Microsoft Office 365] This example shows how to get children documents for the reports.txt document.

Run the Get-VBOSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPOrganization cmdlet with the $session variable to get the ABC organization. Save the result to the $organization variable.
Run the Get-VESPDocument cmdlet with the $organization variable and the Query parameter to get the reports.txt SharePoint document. Save the result to the $parentDocument variable.
Run the Get-VESPDocument cmdlet with the $parentDocument variable and the Recurse parameter to get the children of the reports.txt SharePoint document.

$session = Get-VBOSharePointItemRestoreSession

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

$documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Documents"

$parentDocument = Get-VESPDocument -DocumentLibrary $documentLibrary -Query "reports.txt"

Get-VESPDocument -ParentDocument $parentDocument -Recurse

Example 5

[For Veeam Backup & Replication] This example shows how to get all SharePoint documents from the WSS_Content.mdf SharePoint database.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get a Microsoft SharePoint restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable and the Name parameter to get the WSS_Content.mdf SharePoint database. Save the result to the $database variable.
Run the Get-VESPDocument cmdlet with the $database variable to get all SharePoint documents from the WSS_Content.mdf SharePoint database.

$session = Get-VBRSharePointItemRestoreSession

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

Get-VESPDocument -Database $database

Example 6

[For Veeam Backup & Replication] This example shows how to get the reports.txt document from the Teams site.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
Run the Get-VESPSite cmdlet with the $database variable and the Name parameter to get the Teams site from the SharePoint database. Save the result to the $site variable.
Run the Get-VESPDocument cmdlet with the $site variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document.

$session = Get-VBRSharePointItemRestoreSession

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

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

Get-VESPDocument -Site $site -Query "reports.txt"

Example 7

[For Veeam Backup & Replication] This example shows how to get a document with a name reports.txt from the Regulations SharePoint document library.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable to get the WSS_Content.mdf database. Save the result to the $database variable.
Run the Get-VESPDocumentLibrary cmdlet with the $database variable and the Name parameter to get the Regulations SharePoint document library. Save the result to the $documentLibrary variable.
Run the Get-VESPDocument cmdlet with the $documentLibrary variable and the reports.txt value for the Query parameter to get the reports.txt SharePoint document.

$session = Get-VBRSharePointItemRestoreSession

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

$documentLibrary = Get-VESPDocumentLibrary -Database $database -Name "Regulations"

Get-VESPDocument -DocumentLibrary $documentLibrary -Query "reports.txt"

Example 8

[For Veeam Backup & Replication] This example shows how to get children documents for the reports.txt SharePoint document.

Run the Get-VBRSharePointItemRestoreSession cmdlet to get an active restore session. Save the result to the $session variable.
Run the Get-VESPDatabase cmdlet with the $session variable and the Name parameter to get the WSS_Content.mdf database. Save the result to the $database variable.
Run the Get-VESPDocumentLibrary cmdlet with the $database variable and the Query parameter to get the Regulations SharePoint document library. Save the result to the $documentLibrary variable.
Run the Get-VESPDocument cmdlet with the $documentLibrary variable and the Query parameter to get the reports.txt SharePoint document. Save the result to the $parentDocument variable.
Run the Get-VESPDocument cmdlet with the $parentDocument variable and the Recurse parameter to get the children of the reports.txt SharePoint document.

$session = Get-VBRSharePointItemRestoreSession

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

$documentLibrary = Get-VESPDocumentLibrary -Database $database -Name "Regulations"

$parentDocument = Get-VESPDocument -DocumentLibrary $documentLibrary -Query "reports.txt"

Get-VESPDocument -ParentDocument $parentDocument -Recurse

Related Commands