Start-VBRFailoverPlan

In this article

    Short Description

    Starts failover by failover plan.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force]  [<CommonParameters>]

    -OR-

    Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-FromDate <datetime>] [-Wait] [-Force] [<CommonParameters>]

    -OR-

    Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force] [-Test]  [<CommonParameters>]

    Detailed Description

    This cmdlet starts failover by failover plan. With this cmdlet, you can start a number of failover processes.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    FailoverPlan

    Specifies the array of failover plans you want to start.

    Accepts VBRFailoverPlan or VBRCloudFailoverPlan types.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    FromDate

    Use this parameter to fail over to a particular restore point.

    Specifies the date and time to which you want to fail over. Veeam Backup & Replication will find a restore point closest to this moment.

    If omitted, Veeam Backup & Replication will fail over to the latest restore point.

    False

    Named

    False

    False

    Wait

    Use this parameter to manage starting multiple failover processes.

    If indicated, the next failover process will wait for the previous to end.

    False

    Named

    False

    False

    Force

    Used for cloud failovers to start full failover after the user's site is already partially failed over to cloud replicas.

    If set, the cmdlet turns off the user appliance without notifying the user. Otherwise, the cmdlet will display a warning.

    False

    Named

    False

    False

    Test

    If set, the failover runs in test mode.

    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.

    Return Type

    VBRBackupSession[]

    Example 1

    This command starts failover process by failover plan named "MS Exchange Group Failover". The VMs in the failover group are failed over to the latest restore point.

    • The failover plan is obtained with Get-VBRFailoverPlan and piped down.
    • The FromDate parameter is omitted to select the latest restore point automatically.

    Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | Start-VBRFailoverPlan

    Example 2

    This command starts failover process represented by the '$MSExchangeGroup' variable. The VMs in the failover group are failed over to the latest restore point.

    • The failover plan is obtained with Get-VBRFailoverPlan and assigned to the '$MSExchangeGroup' variable beforehand.
    • The FromDate parameter is omitted to select the latest restore point automatically.

    Start-VBRFailoverPlan -FailoverPlan $MSExchangeGroup

    Example 3

    This command starts failover processes by failover plans named "MS Exchange Group Failover" and "SQLServers Group Failover". The VMs are failed over to a week ago state. The VM groups are failed over one by one.

    • The date is obtained with the Date command and assigned to the '$date' variable beforehand.
    • The failover plans are obtained with Get-VBRFailoverPlan and piped down.
    • The Wait parameter is used to start the failover processes one after the other.

    $date = date

    Get-VBRFailoverPlan -Name "MS Exchange Group Failover", "SQLServers Group Failover" | Start-VBRFailoverPlan -FromDate $date.AddDays(-7) -Wait

    Related Commands