Remove-VBRRestorePoint
Short Description
Removes individual VMs from backup or replicas.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Remove-VBRRestorePoint [-Oib] <COib[]> [-Name <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet removes backup of a selected VM(s) or replica.
The backup is removed from disk. If you remove a replica, the replicated VM is removed from infrastructure.
If you need to remove replicated VM, run the Remove-VBRReplica cmdlet.
|
This cmdlet removes all restore points of the selected VMs or replicas. You should run removal procedures carefully considering the subsequent backup jobs that may fail to produce valid backup. |
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
Oib | Specifies the array of VM restore points. The cmdlet will use these restore point to locate the VMs and remove the backups of these VMs. | Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet. | True | 0 | True (ByProperty |
Name | This parameter is legacy and not supported. | String[] | False | Named | False |
WhatIf | Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. | SwitchParameter | False | Named | False |
Confirm | Defines that the cmdlet displays a prompt that asks if the user is sure that they want to continue. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Examples
Removing Backup of Specific VM
This example shows how to remove backup of Webserver03 VM.
$backup = Get-VBRBackup -Name "Webservers Backup Job" $vm = Get-VBRRestorePoint -Backup $backup -Name "Webserver03" Remove-VBRRestorePoint -Oib $vm |
Perform the following steps:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Specify the Name parameter value. Save the result to the $vm variable.
- Run the Remove-VBRRestorePoint cmdlet. Set the $vm variable as the Oib parameter value.
Related Commands