Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Get-VESPSite

Short Description

Returns SharePoint sites.

Syntax

This cmdlet provides 2 parameter sets.

  • For getting sites from a SharePoint organization:

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

  • For getting a SharePoint site from a parent site:

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

Detailed Description

This cmdlet returns SharePoint sites. You can search a SharePoint site or all children of a parent SharePoint site to get the needed item.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name of the SharePoint site. This cmdlet will return SharePoint sites with a specified name.

False

1

False

True

Organization

Specifies an organization. The cmdlet will return items from this organization.

True

0

True (ByValue)

False

ParentSite

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

True

0

True (ByValue)

False

Recurse

Indicates that the cmdlet will return all children items of the specified item.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to get SharePoint site with a name "Team Site" from the SharePoint organization.

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPSite with the $organization variable and Name parameter to get the site with a name "Team Site".

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> Get-VESPSite -Organization $organization -Name "Team Site"

Example 2

This example shows how to get all children sites from a parent site with a name "Team Site".

  1. Run Get-VBOSharePointItemRestoreSession to get the active restore session. Save the result to the $session variable.
  2. Run Get-VESPOrganization with the $session variable to get the organization with a name "ABC". Save the result to the $organization variable.
  3. Run Get-VESPSite with the $organization variable and Name parameter to get the site with a name "Team Site".
  4. Run Get-VESPSite with the $parentSite variable and Name parameter to get the children sites of a site with a name "Team Site".

PS C:\PS> $session = Get-VBOSharePointItemRestoreSession

PS C:\PS> $organization = Get-VESPOrganization -Session $session -Name "ABC"

PS C:\PS> $parentSite = Get-VESPSite -Organization $organization -Name "Team Site"

PS C:\PS> Get-VESPSite -ParentSite $parentSite -Recurse

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference