Get-VESPSite

In this article

    Short Description

    Returns SharePoint sites.

    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 SharePoint sites from a backed-up Sharepoint database.

    Get-VESPSite [-Database] <VESPDatabase> [[-Name] <String[]>] [-Recurse <SwitchParameter>] [<CommonParameters>]

    • [Veeam Backup for Microsoft Office 365] Get SharePoint sites from a SharePoint organization.

    Get-VESPSite -Organization <VESPOrganization> [-Name <string[]>] [-Recurse]  [<CommonParameters>]

    • Get a SharePoint site from a parent site.

    Get-VESPSite -ParentSite <VESPSite> [-Name <string[]>] [-Recurse]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns SharePoint sites. You can get either parent items or child items of a SharePoint site.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Database

    Specifies a backed-up SharePoint database. The cmdlet will get SharePoint sites from the specified database.

    Note: This parameter is available for backups of SharePoint created by Veeam Backup & Replication only.

    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 items from this organization.

    Note: This parameter is available for backups of SharePoint created by Veeam Backup for Microsoft Office 365 only.

    Accepts the VESPOrganization[] object. To get this object, run the Get-VESPOrganization cmdlet.

    True

    0

    True (ByValue)

    ParentSite

    Specifies a name of a SharePoint parent site. This cmdlet will return one sub-level child of the specified site.

    Accepts the VESPItem object. To get this object, run the Get-VESPItem cmdlet.

    True

    0

    True (ByValue)

    Name

    Specifies an array of names for a SharePoint site. This cmdlet will return SharePoint sites with the specified names.

    String

    False

    1

    False

    Recurse

    Defines that the cmdlet will return all child items of the specified parent item.

    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-VESPSiteExample 1. Getting SharePoint Items from SharePoint Database [For Veeam Backup & Replication]

    This example shows how to get all SharePoint sites from the WSS_Content.mdf SharePoint database.

    $session = Get-VBRSharePointItemRestoreSession

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

    Get-VESPSite -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-VESPSite cmdlet. Set the $database variable as the Database parameter value.

    Get-VESPSiteExample 2. Getting SharePoint Site from SharePoint Parent Site [For Veeam Backup & Replication]

    This example shows how to get all child sites from the Teams parent site.

    $session = Get-VBRSharePointItemRestoreSession

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

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

    Get-VESPSite -ParentSite $parentSite -Recurse

    Perform the following steps:

    1. Get a parent 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 $parentSite variable.
    1. Run the Get-VESPSite cmdlet. Set the $parentSite variable as the ParentSite parameter value. Provide the Recurse parameter value.

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

    This example shows how to get the Team Site SharePoint site from the ABC SharePoint organization.

    $session = Get-VBOSharePointItemRestoreSession

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

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

    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-VESPSiteExample 3. Getting SharePoint Child Site from SharePoint Parent Site [For Veeam Backup for Microsoft Office 365]

    This example shows how to get all child sites from the Team Site parent site.

    $session = Get-VBOSharePointItemRestoreSession

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

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

    Get-VESPSite -ParentSite $parentSite -Recurse

    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.
    1. Run the Get-VESPSite cmdlet. Set the $parentSite variable as the ParentSite parameter value. Provide the Recurse parameter value.

    Related Commands