Set-VBRFailoverPlanObject

In this article

    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. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Object

    Specifies the VM you want modify.

    Accepts VBRFailoverPlanObject type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    True

    BootOrder

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

    False

    Named

    False

    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.

    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

    VBRFailoverPlanObject

    Example 1

    This command sets a new boot delay value for the Microsoft Exchange server that was earlier assigned to the '$MSExchange01' variable.

    • The boot delay is set to 120 sec.
    • The -BootOrder parameter is omitted to leave the original value unchanged.
    • The '$MSExchange01' variable is piped down.

    $MSExchange01 | Set-VBRFailoverPlanObject -BootDelay 120

    Example 2

    This command sets a new boot delay value for the Microsoft Exchange server that was earlier assigned to the  '$MSExchange01' variable.

    • The boot delay is set to 120 sec.
    • The -BootOrder parameter is omitted to leave the original value unchanged.

    $MSExchange01 = Set-VBRFailoverPlanObject -Object $MSExchange01 -BootDelay 120

    I want to report a typo

    There is a misspelling right here:

     

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