This is an archive version of the document. To get the most up-to-date information, see the current version.Stop-VBRViReplicaFailback
Short Description
Undoes VMware replica failback.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Stop-VBRViReplicaFailback -RestorePoint <COib> [-PowerOn] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet undoes the VMware replica failback started with Start-VBRViReplicaFailback.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
RestorePoint | Specifies the restore point of the replica VM. The cmdlet will undo failback of this VM. | True | 1 | True (ByValue, | False |
PowerOn | Indicates that the cmdlet will power on the replica VM after the failback stops. By default this parameter is set to True. If you want to power on replica VM manually, set this parameter to False. | False | Named | False | False |
RunAsync | Indicates that the command returns immediately without waiting for the task to complete. | 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 on common parameters, see the About CommonParameters section of Microsoft Docs.
Example
This example shows how to stop replica failback.
You will need to perform the following steps:
- Run Get-VBRRestorePoint to get the restore point of the VM. Filter the restore points of the VM with the Sort-Object method by the "creationtime" property to get the most recent one. Save the result to the $WebServer_replica_restorepoint variable.
- Run Stop-VBRViReplicaFailback with the $WebServer_replica_restorepoint variable. Set PowerOn parameter to False if you want to power on replica VM manually.
$WebServer_replica_restorepoint = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 Stop-VBRViReplicaFailback -RestorePoint $WebServer_replica_restorepoint -PowerOn:$False -RunAsync |
Related Commands
