This is an archive version of the document. To get the most up-to-date information, see the current version.

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

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRCloudFailoverPlanObject

Example 1

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

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

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

Set-VBRCloudFailoverPlanObject -Object $MSExchange01 -BootOrder 2

Example 2

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

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

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

Set-VBRCloudFailoverPlanObject -Object $MSExchange02 -BootDelay 240

Related Commands

Get-VBRFailoverPlan