This is an archive version of the document. To get the most up-to-date information, see the current version.

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>]

  • [Veeam Backup & Replication] Get items from a SharePoint database.

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

  • [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 items from all subfolders of the specified parent folder.

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.

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]

Get-VESPItemExample 2. Getting SharePoint Child Items from SharePoint Parent Item [For Veeam Backup & Replication]

Get-VESPItemExample 3. Getting SharePoint Items from SharePoint Database [For Veeam Backup & Replication]

Get-VESPItemExample 4. Getting SharePoint Items from SharePoint Site [For Veeam Backup & Replication]

Get-VESPItemExample 5. Getting SharePoint Items from SharePoint List [For Veeam Backup for Microsoft 365]

Get-VESPItemExample 6. Getting SharePoint Items from SharePoint Parent Item [For Veeam Backup for Microsoft 365]

Get-VESPItemExample 7. Getting SharePoint Items from Microsoft Organization [For Veeam Backup for Microsoft 365]

Get-VESPItemExample 8. Getting SharePoint Items from SharePoint Site [For Veeam Backup for Microsoft 365]

Related Commands