Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Remove-VBRBackup

Short Description

Removes selected backups.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet removes selected backups.

You can use the following options:

  • Remove from database. When you remove backup from database, you remove records about the backup from Veeam database. The backup files remain in repository. You can import such backups later with Import-VBRBackup.
  • Remove from disk. With this option, the backup is removed from database and from disk. This removal is complete and non-reversible.

Remove-VBRBackup Important!

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

With this cmdlet, you can remove backups created by the following types of jobs:

  • Backup jobs
  • Backup copy jobs
  • vCD jobs
  • Veeam Agent for Microsoft Windows backup jobs.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Backup

Specifies the array of  backups you want to remove.

True

1

True (ByValue,
ByProperty
Name)

False

FromDisk

If indicated, the backup will be permanently removed from disk. Otherwise, only the information about the backup is deleted from database.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

False

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 a job.

You will need to perform the following steps:

  1. Run Get-VBRBackup to get the job. Save the result to the $backupjob variable.
  2. Run Remove-VBRBackup with the $backupjob variable.

PS C:\PS> $backupjob = Get-VBRBackup -Name "Backup Job 01"

PS C:\PS> Remove-VBRBackup -Backup $backupjob

Example 2

This example shows how to remove jobs ending with "2012".

You will need to perform the following steps:

  1. Run Get-VBRBackup to get the job. Save the result to the $backupjob variable.
  1. Run Remove-VBRBackup with the $backupjob variable. Use the FromDisk parameter to remove the backup from disk.

PS C:\PS> $backupjob = Get-VBRBackup -Name *2012

PS C:\PS> Remove-VBRBackup -Backup $backupjob -FromDisk

Related Commands

Get-VBRBackup

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation