Add-VBRFailoverPlan

Short Description

Creates failover plans or cloud failover plans.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

  • Create a failover plan.

Add-VBRFailoverPlan -Name <string> -FailoverPlanObject <VBRFailoverPlanObject[]> [-Description <string>] [-PrefailoverCommand <string>] [-PostfailoverCommand <string>] [-EnablePublicIpRule]  [<CommonParameters>]

  • Create a cloud failover plan.

Add-VBRFailoverPlan -Name <string> -CloudFailoverPlanObject <VBRCloudFailoverPlanObject[]> [-Description <string>] [-PrefailoverCommand <string>] [-PostfailoverCommand <string>] [-EnablePublicIpRule]  [<CommonParameters>]

Detailed Description

This cmdlet creates the following types of failover plans:

  • Failover plan
  • Cloud failover plan

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies the name that you want to assign to the failover plan.

String

True

Named

False

FailoverPlanObject

Specifies the array of VMs you want to add to the failover plan.

Accepts the VBRFailoverPlanObject[] object. To get this object, run the New-VBRFailoverPlanObject cmdlet.

True

Named

False

Description

Specifies the description of the failover plan.

String

False

Named

False

PrefailoverCommand

Specifies the path to the script you want to automatically run before failing over to replicas.

Veeam Backup & Replication provides a 10-minute timeout for the script.

In case the script does not run successfully or timeout ends, the failover is not performed.

String

False

Named

False

PostfailoverCommand

Specifies the path to the script you want to automatically run after failing over to replicas is complete.

Veeam Backup & Replication provides a 10- minute timeout for the script.

In case the script does not run successfully or timeout ends, the failover proceeds disregarding script failure.

String

False

Named

False

CloudFailoverPlanObject

Specifies the array of VMs replicated to cloud. These VMs will be added to the cloud failover plan.

Accepts the VBRCloudFailoverPlanObject[] object. To get this object, run the New-VBRCloudFailoverPlanObject cmdlet.

True

Named

False

EnablePublicIpRule

Enables the failover plan to use the public IP rules configured in the VBRFailoverPlanObject or VBRCloudFailoverPlanObject objects.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

Examples

Add-VBRFailoverPlanExample 1. Creating Failover Plan for Group of VMs

Add-VBRFailoverPlanExample 2. Creating Cloud Failover Plan

Related Commands

Page updated 6/27/2024

Page content applies to build 12.3.1.1139