Remove-VBOBackupItem - Veeam Backup for Microsoft Office 365 PowerShell Reference
Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Remove-VBOBackupItem

Short Description

Removes a backup item from the specified backup job.

Syntax

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

Detailed Description

This cmdlet removes a backup item from the Veeam Backup for Microsoft Office 365 backup job.

Remove-VBOBackupItem Note:

If you use this cmdlet the specified backup item will be entirely removed regardless of its processing options included.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

BackupItem

Specifies a backup item. The backup job will stop backing up this backup item.

False

Named

false

False

Job

Specifies the backup job that will back up this backup item.

True

Named

False

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 1

This example shows how to remove an organization user "UserAlpha" backup item from the "TestJob" backup job.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get an organization. Save the result to the $org variable.
  2. Run Get-VBOOrganizationUser to get an organization user. Save the result to the $user variable.
  3. Run New-VBOBackupItem to select the item in the backup job. Save the result to the $backupItemUser variable.
  4. Run Get-VBOJob to select the backup job for modification. Save the result to the $job variable.
  5. Run Remove-VBOBackupItem with the $job and $backupItemUser variables to remove the selected user from the specified backup job.

PS C:\PS> $org = Get-VBOOrganization -Name "ABC Company"

PS C:\PS> $user = Get-VBOOrganizationUser -Organization $org -Name "UserAlpha"

PS C:\PS> $backupItemUser = New-VBOBackupItem -User $user -Mailbox:$True -ArchiveMailbox:$False -OneDrive:$False

PS C:\PS> $job = Get-VBOJob -Name "TestJob"

PS C:\PS> Remove-VBOBackupItem -Job $job -BackupItem $backupItemUser

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference