Get-VESPSite
Returns SharePoint sites.
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:
- [For Veeam Backup & Replication] Get SharePoint sites from a backed-up SharePoint database.
Get-VESPSite [-Database] <VESPDatabase> [[-Name] <String[]>] [-Recurse] [<CommonParameters>] |
- [For Veeam Backup for Microsoft 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>] |
This cmdlet returns SharePoint sites. You can get either parent items or child items of a SharePoint site.
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) |
Name | Specifies an array of SharePoint site names. This cmdlet will return SharePoint sites with the specified names. This parameter accepts wildcard characters. | String[] | False | 1 | False |
Recurse | Defines that the cmdlet will return all child items of the specified parent item. Default: False | SwitchParameter | False | Named | False |
Organization | Specifies a SharePoint 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 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. The cmdlet will return only one sub-level child sites for this site. | Accepts the VESPSite object. To get this object, run the Get-VESPSite cmdlet. | True | 0 | True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
The cmdlet returns the VESPSite[] array that contains SharePoint sites.
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: - 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.
|
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: - Get a parent SharePoint site:
- 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 $parentSite variable.
- Run the Get-VESPSite cmdlet. Set the $parentSite variable as the ParentSite parameter value. Provide the Recurse parameter.
|
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: - 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. Use the * wildcard character to substitute the timestamp. 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.
|
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: - Get a parent SharePoint site:
- 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. Use the * wildcard character to substitute the timestamp. 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 $parentSite variable.
- Run the Get-VESPSite cmdlet. Set the $parentSite variable as the ParentSite parameter value. Provide the Recurse parameter.
|
Related Commands
Example 1. Getting SharePoint Sites from SharePoint Database [For Veeam Backup & Replication]