This is an archive version of the document. To get the most up-to-date information, see the
current version.
Get-VESPDocument
Returns SharePoint documents.
Veeam Backup & Replication, Veeam Backup for Microsoft 365
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
This cmdlet provides parameter sets that allow you to:
- Get documents from a specified SharePoint site.
Get-VESPDocument [-Site] <VESPSite> [-Query <string>] [<CommonParameters>] |
- Get documents from a specified SharePoint document library.
Get-VESPDocument [-DocumentLibrary] <VESPDocumentLibrary> [-Query <string>] [-Recurse] [<CommonParameters>] |
- Get child documents of a specified SharePoint document.
Get-VESPDocument [-ParentDocument] <VESPDocument> [-Query <String>] [-Recurse [<SwitchParameter>] [<CommonParameters>] |
- Get documents from a specified SharePoint organization.
Get-VESPDocument [-Organization] <VESPOrganization[]> [-Query <string>] [<CommonParameters>] |
- Get documents from a specified SharePoint database.
Get-VESPDocument [-Database] <VESPDatabase[]> [-Query <string>] [<CommonParameters>] |
This cmdlet returns SharePoint documents.
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
|---|
Site | Specifies a SharePoint site. This cmdlet will return SharePoint documents from this 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. 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 SharePoint 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. | String | False | Named | False | False |
Recurse | Defines that the cmdlet will return the specified parent document and all of its child documents. | SwitchParameter | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Docs.
The cmdlet returns the VESPDocument object that contains an array of SharePoint documents.
This example shows how to get the reports.txt document from the Teams site. $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" |
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-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-VESPDocument cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.
|
This example shows how to get a document with a name reports.txt from the Regulations SharePoint document library. $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" |
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. Save the result to the $documentLibrary variable.
- Run the Get-VESPDocument cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Query parameter value.
|
This example shows how to get child documents for 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 |
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. Save the result to the $documentLibrary variable.
- Run the Get-VESPDocument cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Query parameter value. Save the result to the $parentDocument variable.
- Run the Get-VESPDocument cmdlet. Set the $parentDocument variable as the ParentDocument parameter value. Specify the Recurse parameter.
|
This example shows how to get all SharePoint documents from the ABC SharePoint organization. $session = Get-VBRSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC" Get-VESPDocument -Organization $organization |
Perform the following steps: - Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
- Run the Get-VESPDocument cmdlet. Set the $organization variable as the Organization parameter value.
|
This example shows how to get all SharePoint documents from the WSS_Content.mdf SharePoint database. $session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" Get-VESPDocument -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-VESPDocument cmdlet. Set the $database variable as the Database parameter value.
|
This example shows how to get the reports.txt document from the Teams site. $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" |
Perform the following steps: - Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization 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-VESPDocument cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.
|
This example shows how to get the report.txt document from the Regulations document library. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC" $documentLibrary = Get-VESPDocumentLibrary -Organization $organization -Name "Regulations" Get-VESPDocument -DocumentLibrary $documentLibrary -Query "report.txt" |
Perform the following steps: - Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
- Run the Get-VESPDocumentLibrary cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
- Run the Get-VESPDocument cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Query parameter value.
|
This example shows how to get child documents for the reports.txt 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 |
Perform the following steps: - Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet, Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
- Run the Get-VESPDocumentLibrary cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $documentLibrary variable.
- Run the Get-VESPDocument cmdlet. Set the $documentLibrary variable as the DocumentLibrary parameter value. Specify the Query parameter value. Save the result to the $parentDocument variable.
- Run the Get-VESPDocument cmdlet. Set the $parentDocument variable as the ParentDocument parameter value. Specify the Recurse parameter.
|
This example shows how to get the reports.txt document from the ABC SharePoint organization. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC" Get-VESPDocument -Organization $organization -Query "report.txt" |
Perform the following steps: - Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
- Run the Get-VESPOrganization cmdlet. Set the $session variable as the Session parameter value. Specify the Name parameter value. Save the result to the $organization variable.
- Run the Get-VESPDocument cmdlet. Set the $organization variable as the Organization parameter value.
|
This example shows how to get all SharePoint documents from the WSS_Content.mdf SharePoint database. $session = Get-VBOSharePointItemRestoreSession Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" Get-VESPDocument -Database $database |
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-VESPDocument cmdlet. Set the $database variable as the Database parameter value.
|
Related Commands
Example 1. Getting SharePoint Document from Site [For Veeam Backup & Replication]