Set-VBRFailoverPlanObject

Short Description

Modifies VMs in failover plans.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRFailoverPlanObject -Object <VBRFailoverPlanObject> [-BootOrder <int>] [-BootDelay <int>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies VMs added to a failover plan.

Run the Set-VBRCloudFailoverPlanObject cmdlet to modify VMs in cloud failover plans.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Object

Specifies the VM you want modify.

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

True

Named

True (ByValue,
ByProperty
Name)

BootOrder

Specifies the new value for the order number by which the VM will boot.

Int32

False

Named

False

BootDelay

Specifies the new value for the delay time for the VM.

The delay time is set in seconds.

Default: 60 sec.

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

Set-VBRFailoverPlanObjectExample 1. Setting New Boot Delay Value [Using Pipeline]

Set-VBRFailoverPlanObjectExample 2. Setting New Boot Delay Value [Using Variable]

Page updated 4/12/2024

Page content applies to build 12.3.1.1139