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

New-VBRCloudFailoverPlanObject

Short Description

Creates VM replicas failover plan.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

New-VBRCloudFailoverPlanObject -RestorePoint <COib> [-BootOrder <int>] [-BootDelay <int>] [-PublicIpRule <VBRFailoverPlanPublicIPRule[]>]  [<CommonParameters>]

Detailed Description

This cmdlet creates a new VBRCloudFailoverPlanObject object. This object contains VM replicas that you want to add to a cloud failover plan. You can add the following types of replicas for a failover plan:

  • Simple cloud replicas
  • vCD cloud replicas

Run Add-VBRFailoverPlan to create a failover plan.

New-VBRCloudFailoverPlanObject Note:

You must create the VBRCloudFailoverPlanObject object for each replica that you want to add to the failover plan.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Restore
Point

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

True

Named

True (ByValue,
ByProperty
Name)

False

BootOrder

Specifies the order number by which the replica will boot.

False

Named

False

False

BootDelay

Specifies the delay time for the replica 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 replicas, these replicas will start simultaneously.

False

Named

False

False

Public
IpRule

Specifies the array of rules for mapping public IP and ports to the IP and ports of the replica VM.

Accepts the VBRFailoverPlanPublicIPRule type.

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

VBRCloudFailoverPlanObject

Example

This example shows how to create VBRCloudFailoverPlanObject objects for three servers: a DNS server and two Microsoft Exchange servers. The servers will boot with the following order:

  • The DNS server boots first.
  • The first Microsoft Exchange server boots with the 180 seconds delay.
  • The second Microsoft Exchange server boots with the 120 seconds delay.

You will need to perform the following steps:

  1. Run Get-VBRRestorePoint to get the necessary restore point for the DNS server. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $DNS variable.
  2. Run Get-VBRRestorePoint to get the necessary restore point for the first Microsoft Exchange server. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $MSExchange01 variable.
  3. Run Get-VBRRestorePoint to get the necessary restore point for the second Microsoft Exchange server. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $MSExchange02 variable.
  4. Run New-VBRCloudFailoverPlanObject with the $DNS variable.
  5. Run New-VBRCloudFailoverPlanObject with the $MSExchange01 variable.
  6. Run New-VBRCloudFailoverPlanObject with the $MSExchange02 variable.

PS C:\PS> $DNS = Get-VBRRestorePoint -Name "DNSServer" | Sort-Object $_.creationtime -Descending | Select -First 1

PS C:\PS> $MSExchange01 = Get-VBRRestorePoint -Name "MS_Exchange_Server_01" | Sort-Object $_.creationtime -Descending | Select -First 1

PS C:\PS> $MSExchange02 = Get-VBRRestorePoint -Name "MS_Exchange_Server_02" | Sort-Object $_.creationtime -Descending | Select -First 1

PS C:\PS> New-VBRCloudFailoverPlanObject -RestorePoint $DNS -BootDelay 0

PS C:\PS> New-VBRFailoverPlanObject -RestorePoint $MSExchange01 -BootOrder 1  -BootDelay 180

PS C:\PS> New-VBRFailoverPlanObject -RestorePoint $MSExchange02 -BootOrder 2  -BootDelay 120

Related Commands

Get-VBRRestorePoint

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 Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation