Remove-VBRBackup

Short Description

Removes selected backups.

Note

If the four-eyes authorization is enabled, you cannot run this cmdlet. For more information, see the Four-Eyes Authorization section in the User Guide for VMware vSphere.

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

FromDb (Default)

Remove-VBRBackup [-Backup] <CBackup[]> [-WhatIf] [-Confirm] [<CommonParameters>]
FromDisk

Remove-VBRBackup [-Backup] <CBackup[]> [-FromDisk] [-RunAsync] [-IncludeGFS] [-FromDBIfSPUnavailable]

[-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes selected backups created by all types of jobs: backup jobs, backup copy jobs, Cloud Director jobs and Veeam Agent for Microsoft Windows backup jobs. When you remove backups, you can use the following options:

Remove from the database. When you remove a backup from the database, you remove records about the backup from the Veeam configuration database. The backup files remain in the repository. You can import these backups later with the Import-VBRBackup cmdlet.

Note

Cloud Connect backups cannot be removed with this option. To remove a Cloud Connect backup from the configuration, contact Veeam Support.
Remove from the disk. With this option, the backup is removed from the database and from the disk. This removal is complete and non-reversible.

Important

You must use this option if you want to remove backups from archive extents and capacity extents.

This cmdlet removes all restore points associated with backups of all VMs processed by the job. You should remove backups carefully considering the subsequent backup jobs that may fail to produce a valid backup. To remove backups of individual VMs, run the Remove-VBRRestorePoint cmdlet.

To remove a replicated VM, run the Remove-VBRReplica cmdlet.

To remove a backup job, run the Remove-VBRJob cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies the array of backups you want to remove. Accepts the `CBackup[]` object. To get this object, run the `Get-VBRBackup` cmdlet. [For backups from archive extents and capacity extents] Accepts the `VBRSOBRObjectStorageBackup` object. To get this object, run the `Get-VBRSOBRObjectStorageBackup` cmdlet.	`CBackup[]`	True	0	True (ByPropertyName, ByValue)
FromDBIfSPUnavailable	Defines that the cmdlet will remove backups from a database if a cloud provider is not available.	`SwitchParameter`	False	Named	False
FromDisk	Defines that the cmdlet will delete backups from disk. If you do not provide this parameter, the cmdlet will delete only the information about the backups. Note: You must provide this parameter to remove backups from archive extents and capacity extents.	`SwitchParameter`	False	Named	False
IncludeGFS	Defines that the cmdlet will remove backups with GFS flags (weekly, monthly and yearly).	`SwitchParameter`	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Confirm	Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue. Note: Microsoft PowerShell enables the `Confirm` parameter for this cmdlet by default. To disable this option, set the parameter value to `$false`. That is, `Confirm:$false`.	`SwitchParameter`	False	Named	False
WhatIf	Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Remove-VBRBackup Example 1. Removing Specific Backups from Database [Using Pipeline]

This example shows how to remove the backups named Backup Job 01 and Backup Job 02 from the database.

Get-VBRBackup -Name "Backup Job 01", "Backup Job 02" | Remove-VBRBackup

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Remove-VBRBackup cmdlet.

Remove-VBRBackup Example 2. Removing Backups from Disk with Specified Names [Using Pipeline]

This example shows how to remove backups ending with 2012 characters from the disk.

Get-VBRBackup -Name *2012 | Remove-VBRBackup -FromDisk

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Remove-VBRBackup cmdlet. Provide the FromDisk parameter.

Remove-VBRBackup Example 3. Removing Backup from Disk [Using Variable]

This example shows how to delete backups from the disk.

$backup = Get-VBRBackup -Name "Backups"

Remove-VBRBackup -Backup $backup -FromDisk

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Remove-VBRBackup cmdlet. Set the $backup variable as the Backup parameter value. Provide the FromDisk parameter.

Remove-VBRBackup Example 4. Removing Backups from Capacity Extents

This example shows how to delete backups from capacity extents of a scale-out backup repository.

$backup = Get-VBRSOBRObjectStorageBackup -CapacityTier

Remove-VBRBackup -Backup $backup -FromDisk

Perform the following steps:

Run the Get-VBRSOBRObjectStorageBackup cmdlet. Provide the CapacityTier parameter value. Save the result to the $backup variable.
Run the Remove-VBRBackup cmdlet. Set the $backup variable as the Backup parameter value. Provide the FromDisk parameter.

Remove-VBRBackup Example 5. Removing Backups from Archive Extents

This example shows how to delete backups from archive extents of a scale-out backup repository.

$backup = Get-VBRSOBRObjectStorageBackup -ArchiveTier

Remove-VBRBackup -Backup $backup -FromDisk

Perform the following steps:

Run the Get-VBRSOBRObjectStorageBackup cmdlet. Provide the ArchiveTier parameter value. Save the result to the $backup variable.
Run the Remove-VBRBackup cmdlet. Set the $backup variable as the Backup parameter value. Provide the FromDisk parameter.