New-VBRFailoverPlanObject

Short Description

Creates the VBRFailoverPlanObject object.

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 VBRFailoverPlanObject object for a specific restore point of a replica.

New-VBRFailoverPlanObject -RestorePoint <COib> [-BootOrder <int>] [-BootDelay <int>]  [<CommonParameters>]

  • Create a VBRFailoverPlanObject object for a specific VM.

New-VBRFailoverPlanObject -Vm <IItem> [-BootOrder <int>] [-BootDelay <int>]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRFailoverPlanObject object. This object contains the VM that you want to add to a failover plan. It is used then in the Add-VBRFailoverPlan cmdlet.

You must create the VBRFailoverPlanObject object for each VM that you want to add to the failover plan. For each VM, you can set the boot order and the delay time.

  • The boot order indicates the order in which the VMs will start by the failover plan. Make sure you set the dependent VMs to start after the VMs they depend on.
  • The delay time is an interval between each VM start. Use delay intervals to make sure that some VMs are already running at the moment the dependent VMs start.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies the restore point of the replica that you want to add to the cloud failover plan.

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

True

Named

True (ByValue,
ByProperty
Name)

Vm

Specifies the VM you want to add to the failover plan.

Accepts the IItem object. To get this object, run the Find-VBRViEntity cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

BootOrder

Specifies the order number by which the VM will boot.

Int32

False

Named

False

BootDelay

Specifies the delay time for the VM to boot.

The delay time is set in seconds.

If omitted, the delay time will be set to 60 sec by default.

If you set boot delay to '0' to a number of VMs, these VMs will start simultaneously.

Int32

False

Named

False

<CommonParameters>

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

Output Object

VBRFailoverPlanObject

Examples

New-VBRFailoverPlanObjectExample 1. Create VBRFailoverPlanObject Object for Group of Servers

New-VBRFailoverPlanObjectExample 2. Create VBRFailoverPlanObject Object for Server

Related Commands

Find-VBRViEntity

Page updated 2/12/2024

Page content applies to build 12.3.1.1139