Start-VBRCDPReplicaFailover

In this article

    Short Description

    Starts to perform a failover to VM replicas.

    Applies to

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

    Syntax

    This cmdlet provides cmdlet sets that allow you to:

    • Start to perform a failover to a specific restore point of VM replicas.

    Start-VBRCDPReplicaFailover -Replica <VBRCDPReplica> [-ToPointInTime <datetime>] [-Reason <string>] [-Commit] [-PowerOn] [-Force] [-RunAsync] [-WhatIf] [-Confirm]  [<CommonParameters>]

    • Start to perform a failover to a specific long-term restore point of VM replicas.

    Start-VBRCDPReplicaFailover -Replica <VBRCDPReplica> -LongTermRestorePoint <VBRCDPLongTermRestorePoint> [-Reason <string>] [-Commit] [-PowerOn] [-Force] [-RunAsync] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet starts to perform a failover to VM replicas.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Replica

    Specifies a VM protected with CDP to which you want to perform a failover.

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

    True

    Named

    True (ByValue, ByPropertyName)

    ToPointInTime

    Specifies a replicated state that are available for a VM protected with CDP.

    DateTime

    False

    Named

    False

    LongTermRestorePoint

    Specifies a long-term restore point of a VM protected with CDP. The cmdlet will perform a failover to this restore point.

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

    False

    Named

    False

    Reason

    Specifies the reason for performing a failover.

    String

    False

    Named

    False

    Commit

    Defines that the cmdlet will perform a permanent failover of a VM protected with CDP.

    • If you provide this parameter, the cmdelt will switch from the original VM to the VM protected with CDP on and will set the CDP replica a role of the original VM.
    • If you do not provide this parameter, the cmdlet will not set the CDP replica a role of the original VM after performing a failover.

    SwitchParameter

    False

    Named

    False

    PowerOn

    Defines that the cmdlet will power on a CDP replica after performing a failover. 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 perform a failover 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 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

    Start-VBRCDPReplicaFailoverExample 1. Performing Failover to CDP Replica Latest Restore Point

    This example show how to perform a failover to the latest restore point. The cmdlet will perform a failover without without showing warnings in the PowerShell console.

    $replica = Get-VBRCDPReplica -Name "Win05_replicant"

    Start-VBRCDPReplicaFailover -Replica $replica -Force

    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 Get-VBRCDPShortTermRestoreInterval cmdlet. Set the $replica variable as the Replica parameter. Provide the Force parameter.

    Start-VBRCDPReplicaFailoverExample 2. Performing Failover to CDP Replica Replicated State

    This example shows how start to perform a failover to a specific replicated state of the Win05_replicant CDP replica.

    $replica = Get-VBRCDPReplica -Name "Win05_replicant"

    Start-VBRCDPReplicaFailover -Replica $replica -ToPointInTime "03.02.2021"

    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 Get-VBRCDPShortTermRestoreInterval cmdlet. Set the $replica variable as the Replica parameter. Provide the ToPointInTime parameter value.

    Start-VBRCDPReplicaFailoverExample 3. Performing Failover to CDP Replica Long-Term Restore Point

    This example shows how to start to perform a failover to a specific long-term restore point of the Win05_replicant CDP replica.

    $replica = Get-VBRCDPReplica -Name "Win05_replicant"

    $restorepoint = Get-VBRCDPLongTermRestorePoint -Replica $replica -ApplicationConsistent

    Start-VBRCDPReplicaFailover -Replica $replica -LongTermRestorePoint $restorepoint -Force

    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 Get-VBRCDPLongTermRestorePoint cmdlet. Provide the ApplicationConsistent and Replica parameters. Save the result to the $restorepoint variable.
    3. Run the Get-VBRCDPShortTermRestoreInterval cmdlet. Specify the following settings:
    • Set the $replica variable as the Replica parameter.
    • Set the $restorepoint variable as the LongTermRestorePoint parameter.
    • Provide the ToPointInTime parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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