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

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>] [-TeamsGroups <switchparameter>]  [<CommonParameters>]

Detailed Description

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

Parameters

Parameter

Description

Type

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
  • TeamsGroups

String

False

Named

False

True

Users

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

SwitchParameter

False

Named

False

False

Groups

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

SwitchParameter

False

Named

False

False

Sites

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

SwitchParameter

False

Named

False

False

PersonalSites

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

SwitchParameter

False

Named

False

False

TeamsGroups

Defines that the cmdlet will return teams excluded from a backup job.

SwitchParameter

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Get-VBOExcludedBackupItemExample 1. Getting Excluded Objects

Get-VBOExcludedBackupItemExample 2. Getting Excluded Groups

Related Commands

Get-VBOJob