Stop-VBRvCDReplicaFailover

In this article

    Short Description

    Stops vCD replica failover.

    Applies to

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Stop-VBRvCDReplicaFailover -RestorePoint <COib> [-RunAsync] [-Force] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet stops vCD replica failover.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    RestorePoint

    Specifies a restore point of a production vApp. The cmdlet will stop failover to this vApp.

    Accepts the COib object. To get this object, run the Get-VBRRestorePoint cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    RunAsync

    Defines that the command returns immediately without waiting for the task to complete.

    SwitchParameter

    False

    Named

    False

    Force

    Defines that the cmdlet will perform failover without showing warnings in the PowerShell console.

    SwitchParameter

    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 will display a prompt that asks if you want to continue running the command.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Output Object

    None.

    Examples

    Undoing Failover

    This example shows how to undo failover of the WebServer vCD replica.

    $restorepoint = Get-VBRRestorePoint -Name "WebServer"

    Stop-VBRvCDReplicaFailover -RestorePoint $restorepoint -RunAsync

    Perform the following steps:

    1. Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Save the result to the $restorepoint variable.
    2. Run the Stop-VBRvCDReplicaFailover cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. (The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the forth restore point in the array). Provide the RunAsync parameter.

    Related Commands

    Get-VBRCDPReplica

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.