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>] |
Related Commands
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.
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 all types of jobs: backup jobs, backup copy jobs, vCD jobs and Endpoint backup jobs.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Backup | Specifies the backup you want to remove. You can assign multiple backups to this object. | True | 1 | True (ByValue, | 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 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.
PS C:\PS> Get-VBRBackup -Name "Backup Job 01", "Backup Job 02" | Remove-VBRBackup |
Example 2
This command removes the backups with names ending with "2012" from disk. The backups are obtained with Get-VBRBackup and piped down.
PS C:\PS> Get-VBRBackup -Name *2012 | Remove-VBRBackup -FromDisk |
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.
PS C:\PS> Remove-VBRBackup $backup -FromDisk |