Remove-VBRReplica
Short Description
Removes replica objects and replicated VMs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Detailed Description
This cmdlet removes replica objects and 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 by 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 objects and replica VM are 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 the Disable-VBRJob or Remove-VBRJob cmdlet.
This cmdlet removes all VMs in the replication job. To remove individual VMs, run the Remove-VBRRestorePoint cmdlet.
|
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 | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Backup | Specifies the array of replica objects you want to remove. | Accepts the CBackup[] object. To create this object, run the Get-VBRReplica cmdlet. | True | 1 | True (ByValue, |
FromDisk | Defines that the replica object and replicated VM will be permanently removed from disk. Otherwise, you only exclude the replica from processing by Veeam Backup & Replication. | SwitchParameter | False | Named | False |
WhatIf | Defines that the cmdlet writes 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. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
Examples
Example 1. Removing Replicas from Console
Example 2. Removing Replicas from Disk
Related Commands
