Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

New-VBRFailoverPlanObject

Short Description

Creates the VBRFailoverPlanObject object.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

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

-OR-

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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Restore
Point

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

True

Named

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

False

Vm

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

True

Named

True (by Value
FromPipeline,
ValueFromPipeline
ByPropertyName)

True

BootOrder

Specifies the order number by which the VM will boot.

False

Named

False

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.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRFailoverPlanObject

Example 1

These commands create three VBRFailoverPlanObject objects for the group of mail servers: a DNS server and two Microsoft Exchange servers. The DNS server starts first followed by the two Microsoft Exchange servers started with a delay.

The servers objects are obtained with Find-VBRViEntity and piped down.

  • The VBRFailoverPlanObject for the DNS server is assigned to the '$DNS' variable. The boot order is omitted and will be automatically set to 0. The boot delay is set to 0 sec to start the DNS server immediately.
  • The VBRFailoverPlanObject for the first Microsoft Exchange server is assigned to the '$MSExchange01' variable. The boot order is set to 1, and the boot delay is set to 180 sec.
  • The VBRFailoverPlanObject for the second Microsoft Exchange server is assigned to the '$MSExchange02' variable. The boot order is set to 2, and the boot delay is set to 120 sec.

PS C:\PS> $DNS = Find-VBRViEntity -Name "DNSServer" | New-VBRFailoverPlanObject -BootDelay 0

PS C:\PS> $MSExchange01 = Find-VBRViEntity -Name "MS_Exchange_Server_01" | New-VBRFailoverPlanObject -BootOrder 1  -BootDelay 180

PS C:\PS> $MSExchange02 = Find-VBRViEntity -Name "MS_Exchange_Server_02" | New-VBRFailoverPlanObject -BootOrder 2  -BootDelay 120

Example 2

This command creates the VBRFailoverPlanObject for the server named 'MS_Exchange_Server_01'.

  • The server object is obtained with Find-VBRViEntity and assigned to the '$vm1' variable.
  • The VBRFailoverPlanObject is created and assigned to the '$MSExchange01' variable. The '$vm1' variable is used to add the Microsoft Exchange server, the boot order is set to 1 and the boot delay is set to 180 sec.

PS C:\PS> $vm1 = Find-VBRViEntity -Name "MS_Exchange_Server_01"

PS C:\PS> $MSExchange01 = New-VBRFailoverPlanObject -Vm $vm1 -BootOrder 1  -BootDelay 180

Related Commands

Find-VBRViEntity

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation