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

Set-VBRCloudFailoverPlanObject

Short Description

Modifies VMs in cloud failover plans.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

Set-VBRCloudFailoverPlanObject -Object <VBRCloudFailoverPlanObject> [-BootOrder <int>] [-BootDelay <int>] [-PublicIpRule <VBRFailoverPlanPublicIPRule[]>]  [<CommonParameters>]

Detailed Description

This cmdlet modifies VMs added to a cloud failover plan. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Run Set-VBRFailoverPlanObject to modify VMs in non-cloud failover plans.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Object

Specifies the cloud failover plan VM.

Accepts VBRCloudFailoverPlanObject type.

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 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 1

This example shows how to change the boot order of a replica VM.

  1. Run Get-VBRRestorepoint to get the latest restore point of the replica VM you want to edit. Save it to $MSExchange01 variable.
  2. Run Set-VBRCloudFailoverPlanObject to modify the boot order of the replica VM. Use the saved variable.

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

PS C:\PS> Set-VBRCloudFailoverPlanObject -Object $MSExchange01 -BootOrder 2

Example 2

This example shows how to change the boot delay of a replica VM.

  1. Run Get-VBRRestorePoint to get the latest restore point of the replica VM you want to edit. Save it to $MSExchange02 variable.
  2. Run Set-VBRCloudFailoverPlanObject to modify the boot delay of the replica VM. Use the saved variable.

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

PS C:\PS> Set-VBRCloudFailoverPlanObject -Object $MSExchange02 -BootDelay 240

Related Commands

Get-VBRFailoverPlan

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