Stop-VBRCDPReplicaFailback

In this article

    Short Description

    Undoes a CDP replica failback.

    Applies to

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

    Syntax

    Stop-VBRCDPReplicaFailback -Replica <VBRCDPReplica> [-PowerOn] [-Force] [-RunAsync] [-WhatIf] [-Confirm][<CommonParameters>]

    Detailed Description

    This cmdlet undoes a CDP replica failback.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Replica

    Specifies a CDP replica for which you want to undo a failback.

    Accepts the VBRCDPReplica object. To create this object, run the Get-VBRCDPReplica cmdlet.

    True

    Named

    False

    PowerOn

    Defines that the cmdlet will power on a CDP replica after failback stops. If you do not provide this parameter, the cmdelt will not power on the replica.

    Default: True.

    SwitchParameter

    False

    Named

    False

    Force

    Defines that the cmdlet will undo a failback for a CDP replica without showing warnings in the PowerShell console.

    SwitchParameter

    False

    Named

    False

    RunAsync

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

    SwitchParameter

    False

    Named

    False

    WhatIf

    Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

    SwitchParameter

    False

    Named

    False

    Confirm

    Defines that the command returns the output object to the Windows PowerShell console.

    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 Failback

    This example shows how to undo a failback of the Win05_replicant CDP replica.

    $replica = Get-VBRCDPReplica -Name "Win05_replicant"

    Stop-VBRCDPReplicaFailback -Replica $replica -RunAsync

    Perform the following steps:

    1. Run the Get-VBRCDPReplica cmdlet. Specify the Name parameter value. Save the result to the $replica variable.
    2. Run the Stop-VBRCDPReplicaFailback cmdlet. Set the $replica variable as the Replica parameter. 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.