Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 3.0
PowerShell Reference

Get-VBOBackupItem

Short Description

Returns a list of objects included in a backup job.

Syntax

Get-VBOBackupItem -Job <VBOJob> [-Name <String>] [-Organization <SwitchParameter>] [-Users <SwitchParameter>] [-Groups <SwitchParameter>] [-Sites <SwitchParameter>] [<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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

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

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

True

Named

False

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

False

Named

False

False

Organization

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

False

Named

False

False

Users

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

False

Named

False

False

Groups

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

False

Named

False

False

Sites

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

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example

This example shows how to get all objects that included in the Monthly Backup job.

  1. Run the Get-VBOJob cmdlet. Set Monthly Backup as the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBoBackupItem cmdlet. Set the $job variable as the Job parameter value.

$job = Get-VBOJob -Name "Monthly Backup"

Get-VBoBackupItem -Job $job

Related Commands

Get-VBOJob

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference