This is an archive version of the document. To get the most up-to-date information, see the current version.New-VBRCloudFailoverPlanObject
Short Description
Creates the VBRCloudFailoverPlanObject object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VBRCloudFailoverPlanObject -RestorePoint <COib> [-BootOrder <int>] [-BootDelay <int>] [-PublicIpRule <VBRFailoverPlanPublicIPRule[]>] [<CommonParameters>] |
Related Commands
Return Type
Detailed Description
This cmdlet creates a new VBRCloudFailoverPlanObject object. This object contains the replica that you want to add to a cloud failover plan. It is used then in the Add-VBRFailoverPlan cmdlet.
You must create the VBRCloudFailoverPlanObject object for each replica that you want to add to the failover plan. For each replica, you can set the boot order and the delay time.
- The boot order indicates the order in which the replicas 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 | Accept |
Restore | Specifies the restore point of the cloud replica that you want to add to the cloud failover plan. | True | Named | True (by Value | 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 | Specifies the rule for mapping public IP and ports to the IP and ports of the replica VM. You can add multiple rules to this object. | 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.
Example
These example shows how to create three VBRCloudFailoverPlanObject objects for the group of servers: a DNS server and two Microsoft Exchange servers. The DNS server boots first followed by the two Microsoft Exchange servers booted with a delay.
The servers objects are obtained with Get-VBRRestorePoint and are sorted by creation time in descending order. The first restore point in the list is selected and piped down.
- The VBRCloudFailoverPlanObject for the DNS server is assigned to the '$DNS' variable. The boot order is omitted and will be automatically set to 0 sec to start the DNS server immediately.
- The VBRCloudFailoverPlanObject 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 VBRCloudFailoverPlanObject 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 = Get-VBRRestorePoint -Name "DNSServer" | Sort-Object $_.creationtime -Descending | Select -First 1 | New-VBRCloudFailoverPlanObject -BootDelay 0 PS C:\PS> $MSExchange01 = Get-VBRRestorePoint -Name "MS_Exchange_Server_01" | Sort-Object $_.creationtime -Descending | Select -First 1 | New-VBRFailoverPlanObject -BootOrder 1 -BootDelay 180 PS C:\PS> $MSExchange02 = Get-VBRRestorePoint -Name "MS_Exchange_Server_02" | Sort-Object $_.creationtime -Descending | Select -First 1 | New-VBRFailoverPlanObject -BootOrder 2 -BootDelay 120 |