Get-VESPList

In this article

    Short Description

    Returns SharePoint lists.

    Applies to: Veeam Backup & Replication, Veeam Backup for Microsoft Office 365

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • [Veeam Backup & Replication] Get lists from a backed-up Sharepoint database.

    Get-VESPList [-Database] <VESPDatabase> [[-Name] <String[]>]  [<CommonParameters>]

    • [Veeam Backup for Microsoft Office 365] Get lists from the Microsoft organization.

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

    • Get lists from the SharePoint site.

    Get-VESPList [-Site] <VESPSite> [[-Name] <string[]>] [-Recurse]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns SharePoint lists.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    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)

    Organization

    Specifies a Microsoft 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)

    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)

    Name

    Specifies an array of names for a SharePoint list. This cmdlet will return SharePoint lists 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

    <CommonParameters>

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

    Examples

    Get-VESPListExample 1. Getting SharePoint List from Backed-Up SharePoint Database [For Veeam Backup & Replication]

    This example shows how to get all SharePoint lists from the WSS_Content.mdf backed-up SharePoint database.

    $session = Get-VBRSharePointItemRestoreSession

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

    Get-VESPList -Database $database

    Perform the following steps:

    1. Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
    2. 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.
    3. Run the Get-VESPList cmdlet. Set the $database variable as the Database parameter value.

    Get-VESPListExample 2. Getting SharePoint List from SharePoint Site [For Veeam Backup & Replication]

    This example shows how to get the Color names SharePoint list 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-VESPList -Site $site -Name "Color names"

    Perform the following steps:

    1. Get a SharePoint site:
    1. Run the Get-VBRSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
    2. 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.
    3. 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.
    1. Run the Get-VESPList cmdlet. Set the $site variable as the Site parameter value. Specify the Name parameter value.

    Get-VESPListExample 3. Getting SharePoint Site from Microsoft Organization [For Veeam Backup for Microsoft Office 365]

    This example shows how to get the Color names SharePoint list from the ABC SharePoint organization

    $session = Get-VBOSharePointItemRestoreSession

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

    Get-VESPList -Organization $organization -Name "Color names"

    Perform the following steps:

    1. Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
    2. 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.
    3. Run the Get-VESPSite cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value.

    Get-VESPListExample 3. Getting SharePoint List from SharePoint Site [For Veeam Backup for Microsoft Office 365]

    This example shows how to get the Color SharePoint list from the Team Site SharePoint site.

    $session = Get-VBOSharePointItemRestoreSession

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

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

    Get-VESPList -Site $site -Name "Color names"

    Perform the following steps:

    1. Get a parent SharePoint site:
    1. Run the Get-VBOSharePointItemRestoreSession cmdlet. Save the result to the $session variable.
    2. 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.
    3. 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.
    1. Run the Get-VESPSite cmdlet. Set the $site variable as the Site parameter value. Specify the Name parameter value..

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.