Add-VBOBackupItem

In this article

    Short Description

    Adds a list of objects to a backup job.

    Syntax

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

    Detailed Description

    This cmdlet adds a list of objects to a backup job. The job will process these objects.

    Add-VBOBackupItem Note

    Before you add an object to a backup job, consider the following restrictions:

    • Only one job can back up an entire organization.
    • Several jobs cannot back up the same object.
    • If you add an object that has already been added to the backup job again, a new object will replace the old object.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Job

    Specifies a backup job. The cmdlet will add an array of objects to this job.

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

    True

    Named

    False

    False

    BackupItem

    Specifies an array of objects. The cmdlet will add them to a list of included objects.

    Accepts the VBOBackupItem[] object.

    True

    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

    Example 1. Adding User Backup Item to Backup Job

    This example shows how to add an organization user UserAlpha backup item to the TestJob backup job.

    $org = Get-VBOOrganization -Name "ABC Company"

    $user = Get-VBOOrganizationUser -Organization $org -Name "UserAlpha"

    $backupItemUser = New-VBOBackupItem -User $user -Mailbox:$True -ArchiveMailbox:$False -OneDrive:$False

    $job = Get-VBOJob -Name "TestJob"

    Add-VBOBackupItem -Job $job -BackupItem $backupItemUser

    Perform the following steps:

    1. Run the Get-VBOOrganization cmdlet to get an organization. Save the result to the $org variable.
    2. Run the Get-VBOOrganizationUser cmdlet to get an organization user. In this case we will use it as a backup item. Save the result to the $user variable.
    3. Run the New-VBOBackupItem cmdlet to select the item for the backup job. Save the result to the $backupItemUser variable.
    4. Run the Get-VBOJob cmdlet to select the backup job for modification. Save the result to the $job variable.
    5. Run the Add-VBOBackupItem cmdlet with the $job and $backupItemUser variables to add the selected user to the specified backup job.

    Related Commands