This is an archive version of the document. To get the most up-to-date information, see the current version.Remove-VBRBackup
Short Description
Removes selected backups.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Remove selected backups from databse.
- Remove selected backups from disk.
Remove-VBRBackup [-Backup] <CBackup[]> -FromDisk [-RunAsync] [-IncludeGFS] [-FromDBIfSPUnavailable] [-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.
To remove replicated VM, run Remove-VBRReplica.
To remove a backup job, run Remove-VBRJob.
|
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 VMs, run Remove-VBRRestorePoint. |
With this cmdlet, you can remove backups created by all types of jobs: backup jobs, backup copy jobs, vCD jobs and Veeam Agent for Microsoft Windows backup jobs.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Backup | Specifies the array of backups you want to remove. | True | 1 | True (ByValue, | False |
IncludeGFS | Defines that the cmdlet will remove backups with GFS flags (weekly, monthly and yearly). | False | Named | False | False |
FromDBIfSPUnavailable | Defines that the cmdlet will remove backups from a database if a cloud provider not available. | False | Named | False | 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 |
RunAsync | Defines that the command returns immediately without waiting for the task to complete. | SwitchParameter | False | Named | 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 on common parameters, see the About CommonParameters section of Microsoft Docs.
Example 1
This command removes the backups named "Backup Job 01" and "Backup Job 02" from database only. The backups are obtained with Get-VBRBackup and piped down.
Example 2
This command removes the backups with names ending with "2012" from disk. The backups are obtained with Get-VBRBackup and piped down.
Example 3
This command removes the backup represented by the $backup variable from disk. The backup is obtained with Get-VBRBackup and assigned to the variable beforehand.
Related Commands
