Get-VESPItem
Short Description
Returns SharePoint items.
Applies to
Veeam Backup & Replication, Veeam Backup for Microsoft 365
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get items from a SharePoint list.
Get-VESPItem [-List] <VESPList> [-Query <string>] [-Recurse] [<CommonParameters>] |
- Get items from a parent item.
Get-VESPItem [-ParentItem] <VESPItem> [-Query <string>] [-Recurse] [<CommonParameters>] |
- [For Veeam Backup & Replication] Get items from a SharePoint database.
Get-VESPItem [-Database] <VESPDatabase[]> [-Query <String>] [<CommonParameters>] |
- [For Veeam Backup for Microsoft 365] Get items from a SharePoint organization.
Get-VESPItem [-Organization] <VESPOrganization[]> [-Query <string>] [<CommonParameters>] |
- Get items from a SharePoint site.
Get-VESPItem [-Site] <VESPSite> [-Query <string>] [<CommonParameters>] |
Detailed Description
This cmdlet returns SharePoint items. You can get either parent and\or child items from the following backed-up sources:
- Microsoft organization
- SharePoint site
- SharePoint list
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|
List | Specifies a SharePoint list. This cmdlet will return SharePoint items from this list. | Accepts the VESPList object. To get this object, run the Get-VESPList cmdlet. | True | 0 | True (ByValue) |
ParentItem | Specifies a parent item. The cmdlet will return only one sub-level child items for this item. | Accepts the VESPItem object. To get this object, run the Get-VESPItem cmdlet. | True | 0 | True (ByValue) |
Database | Specifies an array of databases. The cmdlet will get items from the specified databases. Note: This parameter is available for SharePoint databases backed up by means of Veeam Backup & Replication. | Accepts the VESPDatabase[] object. To get this object, run the Get-VESPDatabase cmdlet. | True | 0 | True (ByValue) |
Organization | Specifies an organization. The cmdlet will return SharePoint items 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 items from the specified SharePoint site. | Accepts the VESPSite object. To get this object, run the Get-VESPSite cmdlet. | True | 0 | True (ByValue) |
Query | Allows to use keywords for item search. The cmdlet will return items that match the search query from the specified database, site, list or item. | String | False | Named | 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 CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VESPItem object that contains SharePoint items.
Examples
Example 1. Getting SharePoint Items from SharePoint List [For Veeam Backup & Replication]
This example shows how to get a SharePoint item from the Color names SharePoint list. $session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" $list = Get-VESPList -Database $database -Name "Color names" Get-VESPItem -List $list -Query "new" |
Perform the following steps: - Get SharePoint list:
- 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-VESPList cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $list variable.
- Run the Get-VESPItem cmdlet. Set the $list variable as the List parameter value. Specify the Query parameter value.
|
Example 2. Getting SharePoint Child Items from SharePoint Parent Item [For Veeam Backup & Replication]
This example shows how to get the child items for the Reports SharePoint parent item. $session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" $parentItem = Get-VESPItem -Database $database -Query "Reports" Get-VESPItem -ParentItem $parentItem -Recurse |
Perform the following steps: - Get SharePoint item:
- 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-VESPItem cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $parentItem variable.
- Run the Get-VESPItem cmdlet. Set the $parentItem variable as the ParentItem parameter value. Provide the Recurse parameter.
|
Example 3. Getting SharePoint Items from SharePoint Database [For Veeam Backup & Replication]
This example shows how to get all SharePoint items from the WSS_Content.mdf database. $session = Get-VBRSharePointItemRestoreSession $database = Get-VESPDatabase -Session $session -Name "WSS_Content.mdf" Get-VESPItem -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-VESPItem cmdlet. Set the $database variable as the Database parameter value.
|
Example 4. Getting SharePoint Items from SharePoint Site [For Veeam Backup & Replication]
This example shows how to get an item 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-VESPItem -Site $site -Query "new" |
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. Specify the Name parameter value. Save the result to the $site variable.
- Run the Get-VESPItem cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.
|
Example 5. Getting SharePoint Items from SharePoint List [For Veeam Backup for Microsoft 365]
This example shows how to get a SharePoint item from the ABC One SharePoint list. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC*" $list = Get-VESPList -Organization $organization -Name "ABC One" Get-VESPItem -List $list -Query "new" |
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-VESPList cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $list variable.
- Run the Get-VESPItem cmdlet. Set the $list variable as the List parameter value. Specify the Query parameter value.
|
Example 6. Getting SharePoint Child Items from SharePoint Parent Item [For Veeam Backup for Microsoft 365]
This example shows how to get child items for the Reports item. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC*" $parentItem = Get-VESPItem -Organization $organization -Query "Reports" Get-VESPItem -ParentItem $parentItem -Recurse |
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-VESPItem cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value. Save the result to the $parentItem variable.
- Run the Get-VESPItem cmdlet. Set the $parentItem variable as the ParentItem parameter value. Provide the Recurse parameter.
|
Example 7. Getting SharePoint Items from Microsoft Organization [For Veeam Backup for Microsoft 365]
This example shows how to get a SharePoint item from the ABC organization. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC*" Get-VESPItem -Organization $organization -Query "new" |
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-VESPItem cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value.
|
Example 8. Getting SharePoint Items from SharePoint Site [For Veeam Backup for Microsoft 365]
This example shows how to get a SharePoint item from the Teams SharePoint site. $session = Get-VBOSharePointItemRestoreSession $organization = Get-VESPOrganization -Session $session -Name "ABC*" $site = Get-VESPSite -Organization $organization -Name "Teams" Get-VESPItem -Site $site -Query "new" |
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. Save the result to the $site variable.
- Run the Get-VESPItem cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.
|
Related Commands
Example 1. Getting SharePoint Items from SharePoint List [For Veeam Backup & Replication]