New-VBRCloudFailoverPlanObject
Short Description
Defines VM replicas that you want to add to a failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRCloudFailoverPlanObject -RestorePoint <COib> [-BootOrder <int32>] [-BootDelay <int32>] [-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
- Cloud Director cloud replicas
Run the Add-VBRFailoverPlan cmdlet to create a failover plan.
|
You must create the VBRCloudFailoverPlanObject object for each replica that you want to add to the failover plan. |
Parameters
Parameter | Description | Type | Required | Position | Accept |
|---|---|---|---|---|---|
RestorePoint | Specifies the restore point of the cloud replica that you want to add to the cloud failover plan. | Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet. | True | Named | True (ByValue, |
BootOrder | Specifies the order number by which the replica will boot. | Int32 | False | Named | 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. | Int32 | False | Named | False |
PublicIpRule | Specifies the array of rules for mapping public IP and ports to the IP and ports of the replica VM. | Accepts the VBRFailoverPlanPublicIPRule[] object. To create this object, run the New-VBRFailoverPlanPublicIPRule cmdlet. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Adding VM Replicas to Cloud Failover Plan
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.
$DNS = Get-VBRRestorePoint -Name "DNSServer" | Sort-Object $_.creationtime -Descending | Select -First 1 $MSExchange01 = Get-VBRRestorePoint -Name "MS_Exchange_Server_01" | Sort-Object $_.creationtime -Descending | Select -First 1 $MSExchange02 = Get-VBRRestorePoint -Name "MS_Exchange_Server_02" | Sort-Object $_.creationtime -Descending | Select -First 1 New-VBRCloudFailoverPlanObject -RestorePoint $DNS -BootDelay 0 New-VBRCloudFailoverPlanObject -RestorePoint $MSExchange01 -BootOrder 1 -BootDelay 180 New-VBRCloudFailoverPlanObject -RestorePoint $MSExchange02 -BootOrder 2 -BootDelay 120 |
Perform the following steps:
- Run the Get-VBRRestorePoint cmdlet. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $DNS variable.
- Run the Get-VBRRestorePoint cmdlet. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $MSExchange01 variable.
- Run the Get-VBRRestorePoint cmdlet. Use the Sort-Object and the Select commands to select the first restore point. Save the result to the $MSExchange02 variable.
- Run the New-VBRCloudFailoverPlanObject cmdlet. Set the $DNS variable as the RestorePoint parameter value. Set 0 as the BootDelay parameter value.
- Run the New-VBRCloudFailoverPlanObject cmdlet. Set the $MSExchange01 variable as the RestorePoint parameter value. Set 1 as the BootOrder parameter value and 180 as the BootDelay parameter value.
- Run the New-VBRCloudFailoverPlanObject cmdlet. Set the $MSExchange02 variable as the RestorePoint parameter value. Set 2 as the BootOrder parameter value and 120 as the BootDelay parameter value.
Related Commands