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

Get-VBOExcludedBackupitem

Short Description

Returns a list of objects excluded from a backup job.

Syntax

Get-VBOExcludedBackupItem -Job <VBOJob> [-Name <String>] [-Users <SwitchParameter>] [-Groups <SwitchParameter>] [-Sites <SwitchParameter>] [-PersonalSites <SwitchParameter>] [<CommonParameters>]

Detailed Description

This cmdlet returns a list of objects excluded from a backup job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies a backup job. The cmdlet will return objects excluded from this 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. The cmdlet will return all 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

False

Named

False

False

Users

Specifies that the cmdlet will return users excluded from a backup job.

False

Named

False

False

Groups

Specifies that the cmdlet will return groups excluded from a backup job.

False

Named

False

False

Sites

Specifies that the cmdlet will return sites excluded from a backup job.

False

Named

False

False

PersonalSites

Specifies that the cmdlet will return personal sites excluded from a backup job.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to get a list of objects excluded from 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-VBOExcludedBackupItem cmdlet. Set the $job variable as the Job parameter value.

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

Get-VBOExcludedBackupItem -Job $job

Example 2

This example shows how to get a list of groups excluded from the Yearly Backup job.

  1. Run the Get-VBOJob cmdlet. Set Yearly Backup as the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBOExcludedBackupItem cmdlet. Specify the following settings:
  • Set the $job variable as the Job parameter value.
  • Set the Groups parameter.

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

Get-VBOExcludedBackupItem -Job $job -Groups

Related Commands

Get-VBOJob

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference