Veeam Backup for Microsoft 365 8
Veeam Explorers PowerShell Reference
ASK LLM
Ask ChatGPT Ask Claude Ask Grok Ask Perplexity
Related documents
Search

Get-VESPItem

Short Description

Returns SharePoint items.

Product: Veeam Backup & Replication, Veeam Backup for Microsoft 365

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

Syntax

This cmdlet provides the following parameter sets:

  • listParameterSet

    Get-VESPItem [-List] <VESPList> [-Query <String>] [-Recurse] [<CommonParameters>]

  • itemParameterSet

    Get-VESPItem [-ParentItem] <VESPItem> [-Query <String>] [-Recurse] [<CommonParameters>]

  • databaseParameterSet

    Get-VESPItem [-Database] <VESPDatabase[]> [-Query <String>] [<CommonParameters>]

  • organizationParameterSet

    Get-VESPItem [-Organization] <VESPOrganization[]> [-Query <String>] [<CommonParameters>]

  • siteParameterSet

    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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Database

Specifies an array of SharePoint databases. The cmdlet will get items from these databases.

Note: This parameter is available for SharePoint databases backed up by Veeam Backup & Replication.

Accepts the VESPDatabase[] object. To get this object, run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. cmdlet.

VESPDatabase[]

True

0

True (ByValue)

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-VESPListReturns SharePoint lists. cmdlet.

VESPList

True

0

True (ByValue)

Organization

Specifies an array of SharePoint organizations. The cmdlet will return SharePoint items from these organizations.

Accepts the VESPOrganization[] object. To get this object, run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. cmdlet.

VESPOrganization[]

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.

VESPItem

True

0

True (ByValue)

Query

Specifies a query string for item search. The cmdlet will return items that match the search query from the specified database, organization, site, list or item.

For more information, see the Appendix A. Item Search Parameters section of the Veeam Backup for Microsoft 365 User Guide.

String

False

Named

False

Recurse

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

Default: False

SwitchParameter

False

Named

False

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-VESPSiteReturns SharePoint sites. cmdlet.

VESPSite

True

0

True (ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the VESPItem object that contains SharePoint items.

Examples

Get-VESPItemExample 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:

  1. Get SharePoint list:

    1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. 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-VESPListReturns SharePoint lists. cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $list variable.
  2. Run the Get-VESPItem cmdlet. Set the $list variable as the List parameter value. Specify the Query parameter value.

Get-VESPItemExample 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:

  1. Get SharePoint item:

    1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
    2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. 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-VESPItem cmdlet. Set the $database variable as the Database parameter value. Specify the Query parameter value. Save the result to the $parentItem variable.
  2. Run the Get-VESPItem cmdlet. Set the $parentItem variable as the ParentItem parameter value. Provide the Recurse parameter.

Get-VESPItemExample 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:

  1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. 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-VESPItem cmdlet. Set the $database variable as the Database parameter value.

Get-VESPItemExample 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:

  1. Run the Get-VBRSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up Microsoft SharePoint databases. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPDatabaseReturns backed-up Microsoft SharePoint databases. 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-VESPSiteReturns SharePoint sites. cmdlet. Set the $database variable as the Database parameter value. Specify the Name parameter value. Save the result to the $site variable.
  4. Run the Get-VESPItem cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.

Get-VESPItemExample 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:

  1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
  3. Run the Get-VESPListReturns SharePoint lists. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $list variable.
  4. Run the Get-VESPItem cmdlet. Set the $list variable as the List parameter value. Specify the Query parameter value.

Get-VESPItemExample 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:

  1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
  3. 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.
  4. Run the Get-VESPItem cmdlet. Set the $parentItem variable as the ParentItem parameter value. Provide the Recurse parameter.

Get-VESPItemExample 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:

  1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
  3. Run the Get-VESPItem cmdlet. Set the $organization variable as the Organization parameter value. Specify the Query parameter value.

Get-VESPItemExample 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:

  1. Run the Get-VBOSharePointItemRestoreSessionReturns active restore sessions started to perform operations with backed-up SharePoint items. cmdlet. Save the result to the $session variable.
  2. Run the Get-VESPOrganizationReturns SharePoint organizations added to Veeam Backup for Microsoft 365. 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.
  3. Run the Get-VESPSiteReturns SharePoint sites. cmdlet. Set the $organization variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $site variable.
  4. Run the Get-VESPItem cmdlet. Set the $site variable as the Site parameter value. Specify the Query parameter value.

Page updated 2026-08-20

Page content applies to build 8.5.0.1014

View all results across Veeam Help Center
Back to document search