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

Add-VBOExcludedBackupItem

In this article

    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

     

    <CommonParameters>

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

    Example

    This example shows how to add a list of excluded items to the Monthly Backup backup job.

    1. 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.
    2. Run the Get-VBoBackupItem cmdlet. Set the $yearlyjob variable as the Job parameter value.
    3. 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.
    4. Run the Add-VBOExcludedBackupItem cmdlet. Specify the following settings:
    • Set the $monthlyjob variable as the Job parameter value.
    • Set the $item variable as the BackupItem parameter.

    $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

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.