This is an archive version of the document. To get the most up-to-date information, see the current version.Remove-VBRReplica
Short Description
Removes replicated VMs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRReplica [-Backup] <CBackup[]> [-FromDisk] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet removes replicated VMs.
You can use the following options:
- Remove from console. When you remove replica from the Veeam console, you will not delete the VM but only stop managing it with Veeam Backup & Replication. When replica is created, Veeam Backup & Replication maintains it in sync with the original VM by running the replication job. When you delete a replica from your managing console, it is no longer synchronized. The replica VM stays on target host.
- Remove from disk. With this option, the replica is removed from database and from target host. This removal is complete and non-reversible.
To stop synchronizing a replica without deleting it from the console, you need to disable or delete the corresponding replication job. Run Disable-VBRJob or Remove-VBRJob.
This cmdlet removes all VMs in the replication job. To remove individual VMs, run Remove-VBRRestorePoint.
|
When you remove a replica from Veeam Backup & Replication console, you can not bring it back by means of PowerShell. Use replica seeding option in UI to restore a removed replica. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Backup | Specifies the replica you want to remove. You can assign multiple replicas to this object. | True | 1 | True (ByValue, | False |
FromDisk | If indicated, the replicated VM will be permanently removed from disk. Otherwise, you only exclude the replica from processing with Veeam Backup & Replication. | 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 replicas named "DC_replica01" and "DC_replica02" from Veeam Backup & Replication. The replicated VMs are obtained with Get-VBRReplica and piped down.
Example 2
This command removes the replicas named "DC_replica01" and "DC_replica02" from disk. The replicated VMs are obtained with Get-VBRReplica and piped down.
Example 3
This command removes the replicated VM represented by the $replica variable from disk. The replicated VM is obtained with Get-VBRReplica and assigned to the variable beforehand.
