This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VESPList
Short Description
Returns SharePoint lists.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides parameter sets that allow you to:
- To get lists from the Microsoft Sharepoint database.
Get-VESPList [-Database] <VESPDatabase> [[-Name] <String[]>] [<CommonParameters>] |
- To get lists from the Microsoft SharePoint organization:
Get-VESPList [-Organization] <VESPOrganization> [[-Name] <string[]>] [<CommonParameters>] |
- To get lists from the Microsoft SharePoint site:
Get-VESPList [-Site] <VESPSite> [[-Name] <string[]>] [-Recurse] [<CommonParameters>] |
Detailed Description
This cmdlet returns SharePoint lists.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Database | Specifies a database. The cmdlet will return SharePoint lists from this database. Accepts the VESPDatabase[] object. To get this object, run the Get-VESPDatabase cmdlet. | True | 0 | True (ByValue) | False |
Organization | Specifies an organization. The cmdlet will return SharePoint lists from this organization. Accepts the VESPOrganization[] object. To get this object, run the Get-VESPOrganization cmdlet. | True | 0 | True (ByValue) | False |
Site | Specifies a name of the SharePoint site. This cmdlet will return SharePoint lists from the specified SharePoint site. Accepts the VESPSite object. To get this object, run the Get-VESPSite cmdlet. | True | 0 | True (ByValue) | False |
Name | Specifies an array of names for a SharePoint list. This cmdlet will return SharePoint lists with the specified name. | False | 1 | False | True |
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 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 Color names SharePoint list from the ABC SharePoint organization.
- 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-VESPList cmdlet with the $organization variable and the Name parameter to get the Color names list.
$session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC" Get-VESPList -Organization $organization -Name "Color names" |
Example 2
[For Veeam Backup for Microsoft Office 365] This example shows how to get the Color SharePoint list from the Team Site SharePoint.
- Run the Get-VBOSharePointItemRestoreSession cmdlet to get the 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 Team Site SharePoint site.
- Run the Get-VESPList cmdlet with the $site variable and the Name parameter to get the Color list.
$session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC" $site = Get-VESPSite -Organization $organization -Name "Teams" Get-VESPList -Site $site -Name "Color names" |
Example 3
[For Veeam Backup & Replication] This example shows how to get all SharePoint lists from the WSS_Content.mdf database.
- 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-VESPList cmdlet with the $database variable to get all SharePoint lists from the SharePoint database.
$session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" Get-VESPList -Database $database |
Example 4
[For Veeam Backup & Replication] This example shows how to get the Color names SharePoint list from the ABC DB01 SharePoint database.
- 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 SharePoint database. Save the result to the $database variable.
- Run the Get-VESPList cmdlet with the $database variable and the Name parameter to get the Color names list.
$session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" Get-VESPList -Database $database -Name "Color names" |
Related Commands