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

Add-VBOExcludedBackupItem

Short Description

Creates a list of objects excluded from a backup job.

Syntax

Add-VBOExcludedBackupItem -Job <VBOJob> -BackupItem <VBOBackupItem[]> [<CommonParameters>]

Detailed Description

This cmdlet creates a list of objects that will be excluded from a backup job.

Run the Get-VBOExcludedBackupitem cmdlet to get a list of excluded items.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Job	Specifies a backup job. The cmdlet will exclude objects from this backup job. Accepts the VBOJob object. To get this object, run the Get-VBOJob cmdlet.	True	Named	False
BackupItem	Specifies an array of objects that you want to exclude from a backup job. Accepts the VBOBackupItem[] object. To get this object, run the Get-VBOBackupItem cmdlet.	True	Named	False

Parameter

Description

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Job

Specifies a backup job. The cmdlet will exclude objects from this backup job.

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

True

Named

False

BackupItem

Specifies an array of objects that you want to exclude from a backup job.

Accepts the VBOBackupItem[] object. To get this object, run the Get-VBOBackupItem cmdlet.

True

Named

False

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

Examples

Example 1

This example shows how to exclude objects of a SharePoint organization site from the Yearly Backup backup job.

Run the Get-VBOJob cmdlet to specify a job to which you want to add a list of excluded items. Set Yearly Backup as the Name parameter value. Save the result to the $yearlyjob variable.
Run the Get-VBOOrganization cmdlet with the Name parameter to get the organization with the name "ABC". Save the result to the $organization variable.
Save URL address of a SharePoint organization site that you want to exclude to the $site variable.
Run the Get-VBOOrganizationSite cmdlet with the $organization variable and the $site value for the URL parameter. Save the result to the $excludedsite variable.
Run the New-VBOBackupItem cmdlet with the $excludedsite variable to create item that represents a SharePoint organization site with a given URL. Save the result to the $excludeditems variable.
Run the Add-VBOExcludedBackupItem cmdlet. Set the $yearlyjob variable as the Job parameter value. Set the $excludeditems variable as the BackupItem parameter value.

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

$organization = Get-VBOOrganization -Name "ABC"

$site = "https://exampleorganization.sharepoint.com/sites/excludedsite"

$excludedsite = Get-VBOOrganizationSite -Organization $organization -URL $site

$excludeditems = New-VBOBackupItem -Site $excludedsite

Add-VBOExcludedBackupItem -Job $yearlyjob -BackupItem $excludeditems

Example 2

This example shows how to get backup items from the Yearly Backup backup job and to add them as excluded items to the Monthly Backup backup job.

Run the Get-VBOJob cmdlet to specify a job from which you want to get items. Set Yearly Backup as the Name parameter value. Save the result to the $yearlyjob variable.
Run the Get-VBOBackupItem cmdlet. Set the $yearlyjob variable as the Job parameter value. Save the result to the $item variable.
Run the Get-VBOJob cmdlet to specify a job to which you want to add a list of excluded items. Set Monthly Backup as the Name parameter value. Save the result to the $monthlyjob variable.
Run the Add-VBOExcludedBackupItem cmdlet. Set the $monthlyjob variable as the Job parameter value. Set the $item variable as the BackupItem parameter value.

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

$item = Get-VBOBackupItem -Job $yearlyjob

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

Add-VBOExcludedBackupItem -Job $monthlyjob -BackupItem $item

Related Commands