This is an archive version of the document. To get the most up-to-date information, see the current version.Remove-VBRRestorePoint
Short Description
Removes individual VMs from backup or replicas.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
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 Remove-VBRReplica.
|
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 | Required | Position | Accept | Accept |
COib | 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. | True | 1 | True (ByValue, | False |
Name | This parameter is legacy and not supported. | False | Named | False | True |
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
This command removes backup of VM named "Webserver03".
- Run Get-VBRBackup to get the backup containing this VM. Save it to the $backup variable.
- Run Get-VBRRestorePoint to get the Webserver03. Save it to the $vm variable.
- Run Remove-VBRRestorePoint with the $vm variable.
$backup = Get-VBRBackup -Name "Webservers Backup Job" $vm = Get-VBRRestorePoint -Backup $backup -Name "Webserver03" Remove-VBRRestorePoint -Oib $vm |
Related Commands
