Add-VBOBackupItem
Short Description
Adds a list of objects to a backup job.
Syntax
Add-VBOBackupItem -Job <VBOJob> -BackupItem <VBOBackupItem[]> [<CommonParameters>] |
Detailed Description
Adds a list of objects to a backup job. The job will process these objects.
Note |
Before you add an object to a backup job, consider the following restrictions:
|
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.
| 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
Example 1
This example shows how to add an organization user "UserAlpha" backup item to the "TestJob" backup job.
- Run the Get-VBOOrganization cmdlet to get an organization. Save the result to the $org variable.
- 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.
- Run the New-VBOBackupItem cmdlet to select the item for the backup job. Save the result to the $backupItemUser variable.
- Run the Get-VBOJob cmdlet to select the backup job for modification. Save the result to the $job variable.
- Run the Add-VBOBackupItem cmdlet with the $job and $backupItemUser variables to add the selected user to the specified 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 |
Related Commands