Get-VBOBackupItem

Short Description

Returns a list of objects included in a backup job.

Syntax

Get-VBOBackupItem [-Organization] -Job <VBOJob> [-Name <String>] [-Users] [-Groups] [-TeamsGroups] [-Sites] [-PersonalSites] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of objects included in a backup job. The job will back up these objects.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Organization

Defines that the cmdlet will return an organization included in a backup job.

Default: False

SwitchParameter

False

Named

False

Job

Specifies a backup job. The cmdlet will return objects included in this backup job.

Accepts the VBOJob object.

To get this object, run the Get-VBOJob cmdlet.

True

Named

False

Name

Specifies a name of an object that is added to a backup job. The cmdlet will return objects with this name.

Note: If you want to get a specific type of an object, you must also set either of the following parameters:

  • Organization
  • Users
  • Groups
  • Sites
  • PersonalSites
  • TeamsGroups

String

False

Named

False

Users

Defines that the cmdlet will return users included in a backup job.

Default: False

SwitchParameter

False

Named

False

Groups

Defines that the cmdlet will return groups included in a backup job.

Default: False

SwitchParameter

False

Named

False

TeamsGroups

Defines that the cmdlet will return teams included in a backup job.

Default: False

SwitchParameter

False

Named

False

Sites

Defines that the cmdlet will return sites included in a backup job.

Default: False

SwitchParameter

False

Named

False

PersonalSites

Defines that the cmdlet will return personal sites included in a backup job.

Default: False

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 VBOBackupItem[] object that contains an array of objects included in a backup job.

Examples

Example 1. Getting All Objects from Backup Job

Example 2. Getting Groups from Backup Job

Example 3. Getting Details on Specific Group from Backup Job

Example 4. Getting Name of Specific Group from Backup Job

Related Commands

Get-VBOJob

Page updated 4/23/2024

Page content applies to build 8.1.2.180