Start-VBRViReplicaFailback

Short Description

Fails back VMware VMs to production host.

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

ToOriginal (Default)

Start-VBRViReplicaFailback -RestorePoint <COib> [-Complete] [-StoragePolicyAction <VBRStoragePolicyAction>]

[-PowerOn] [-ReIp] [-SkipTagsRestore] [-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>]

[-Reason <String>] [-QuickRollback] [-Force] [-SwitchingSchedule <VBRFailbackSwitchingSchedule>]

[-SwitchToProduction] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

DifferentLocation

Start-VBRViReplicaFailback -RestorePoint <COib> [-Complete] -Server <Object>

[-ResourcePool <CViResourcePoolItem>] [-Datastore <VBRViDatastoreBase>] [-Folder <CViFolderItem>]

[-StoragePolicy <VBRViStoragePolicy>] [-Network <VBRViNetworkInfo[]>] [-PowerOn] [-ReIp] [-SkipTagsRestore]

[-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>] [-Reason <String>] [-QuickRollback] [-Force]

[-SwitchingSchedule <VBRFailbackSwitchingSchedule>] [-SwitchToProduction] [-RunAsync] [-VmName <String>]

[-WhatIf] [-Confirm] [<CommonParameters>]

FromBackup

Start-VBRViReplicaFailback -RestorePoint <COib> [-Complete] -Vm <CViVmItem> [-PowerOn] [-ReIp]

[-SkipTagsRestore] [-DRSiteProxy <CViProxy[]>] [-ProdSiteProxy <CViProxy[]>] [-Reason <String>]

[-QuickRollback] [-Force] [-SwitchingSchedule <VBRFailbackSwitchingSchedule>] [-SwitchToProduction]

[-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet fails back VMware VMs to the production host. This cmdlet finalizes the replica failover started with the Start-VBRViReplicaFailover cmdlet.

Run the Stop-VBRReplicaFailover cmdlet to undo failover.

Run the Stop-VBRViReplicaFailback cmdlet to undo failback.

Note

The cmdlet will not run if the geographic location of the VMs you want to fail back and the target production host location do not match. If you still want to run the cmdlet, use the Force parameter.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Complete	Defines that the failback will be committed.	`SwitchParameter`	False	Named	False
Datastore	For performing failback to a new location or to any location but with different settings. Specifies the datastore where you want to register the recovered VM. If not specified, the cmdlet will use the datastore that is set as default for the target host. Accepts the `VBRViDatastoreBase` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`VBRViDatastoreBase`	False	Named	False
DRSiteProxy	Specifies the proxy configured on the disaster recovery site. Accepts the `CViProxy[]` object. To get this object, run the `Get-VBRViProxy` cmdlet.	`CViProxy[]`	False	Named	False
Folder	For performing failback to a new location or to any location but with different settings. Specifies the folder where you want to register the recovered VM. If not specified, the cmdlet will use the folder that is set as default for the target host. Accepts the `CViFolderItem` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`CViFolderItem`	False	Named	False
Force	Defines that the cmdlet will perform failback even if the geographic location of the VMs you want to fail back and the target production host location do not match.	`SwitchParameter`	False	Named	False
Network	For performing failback to a new location or to any location but with different settings. Specifies the array of production site networks. The cmdlet will map the replica to these networks. Accepts the `VBRViNetworkInfo[]` object. To get this object, run the `Get-VBRViServerNetworkInfo` cmdlet.	`VBRViNetworkInfo[]`	False	Named	False
PowerOn	Defines that the production VM will be powered on after the failback. Otherwise, you will need to power the VM on manually.	`SwitchParameter`	False	Named	False
ProdSiteProxy	Specifies the proxy configured on the production site. Accepts the `CViProxy[]` object. To get this object, run the `Get-VBRViProxy` cmdlet.	`CViProxy[]`	False	Named	False
QuickRollback	Defines that the cmdlet will perform incremental failback. Note: Incremental failback uses VM changed block tracking data. If the cmdlet fails to retrieve the changed block tracking data for some reason, it will perform full VM failback.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for performing failback.	`String`	False	Named	False
ReIp	Defines that the production VM will use the re-IP rules set in the replication job. Do not enable the re-IP if the re-IP rules are not configured in the replication job.	`SwitchParameter`	False	Named	False
ResourcePool	For performing failback to a new location or to any location but with different settings. Specifies the resource pool where you want to register the recovered VM. If not specified, the cmdlet will use the resource pool that is set as default for the target host. Accepts the `CViResourcePoolItem` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`CViResourcePoolItem`	False	Named	False
RestorePoint	Specifies the replica restore point. The cmdlet uses this restore point to identify the replica you want to fail back. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	True	Named	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete. Note: This parameter cannot be used if you set the failback switch schedule by running the `New-VBRFailbackSwitchingSchedule` cmdlet to the `Auto` or `Scheduled` types.	`SwitchParameter`	False	Named	False
Server	For performing failback to a new location or to any location but with different settings. Specifies the ESXi host where you want to register the recovered VM. Accepts the `Object` object. To get this object, run the `Get-VBRServer` cmdlet.	`Object`	True	Named	False
SkipTagsRestore	Defines that the VM will be restored without its VMware tag. Otherwise, the restored VM will keep its original tag.	`SwitchParameter`	False	Named	False
StoragePolicy	For performing failback to a new location or to any location but with different settings. Specifies the storage policy with which you want to register the recovered VM. If not specified, the cmdlet will use the storage policy that is set as default for the target host. Accepts the `VBRViStoragePolicy` object. To get this object, run the `Find-VBRViStoragePolicy` cmdlet.	`VBRViStoragePolicy`	False	Named	False
StoragePolicyAction	Specifies the strategy for selecting storage policy profile in case the storage profile of the backed up VM differs from the profile of the original VM. `Current`: the restored VM will be subscribed to the same profile as in backup (if such profile still exists) or to the profile to which the original VM is subscribed (if profile as in backup was removed). `Default`: the restored VM will be subscribed to the profile that is set as default for the target datastore. `Stored`: the restored VM will be subscribed to the profile as in backup (if such profile still exists).	`VBRStoragePolicyAction`	False	Named	False
SwitchingSchedule	Specifies a switching schedule for a VM replica. The cmdlet will switch the replica to the production VM according to this schedule. Accepts the `VBRFailbackSwitchingSchedule` object. To create this object, run the `New-VBRFailbackSwitchingSchedule` cmdlet.	`VBRFailbackSwitchingSchedule`	False	Named	False
SwitchToProduction	Defines that the cmdlet will switch a VM replica from the Ready to switch state to the Failback state.	`SwitchParameter`	False	Named	False
Vm	For performing failback to a new location. Specifies the VM restored from backup. The cmdlet will map the replica to this VM. Accepts the `CViVmItem` object. To get this object, run the cmdlet.	`CViVmItem`	True	Named	False
VmName	For performing failback to a new location or to any location but with different settings. Specifies the name of the VM. The cmdlet will recover a VM with this name and will perform failback of the replica to this VM. If not specified, the cmdlet will use the name of the original VM.	`String`	False	Named	False
Confirm	Defines that the cmdlet displays a prompt that asks if the user is sure that they want to continue.	`SwitchParameter`	False	Named	False
WhatIf	Defines that the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Start-VBRViReplicaFailback Example 1. Performing Failback to Original VM

This example shows how to fail back to the original VM. The VM will fail back with the following parameters:

The storage policy is set to Current.
The cmdlet will power the VM on after failback.
The cmdlet will perform failback using changed block tracking data.

$restorepoint = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1

Start-VBRViReplicaFailback -RestorePoint $restorepoint -StoragePolicyAction Current -PowerOn -QuickRollback

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter restore points with Sort-Object method by the creationtime property to get the most recent one. Save the result to the $restorepoint variable.
Run the Start-VBRViReplicaFailback cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
- Set the Current value as the StoragePolicyAction parameter value.
- Provide the PowerOn and QuickRollback parameters.

Start-VBRViReplicaFailback Example 2. Performing Failback to VM Restored in New Location

This example shows how to fail back to the VM restored in a new location.

$restorepoint = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1

$vm = Find-VBRViEntity -Name "Fileserver03"

Start-VBRViReplicaFailback -RestorePoint $restorepoint -VM $vm

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter restore points with Sort-Object method by the creationtime property to get the most recent one. Save the result to the $restorepoint variable.
Run the Find-VBRViEntity cmdlet. Specify the Name parameter value. Save the result to the $vm variable.
Run the Start-VBRViReplicaFailback cmdlet. Set the $restorepoint as the RestorePoint parameter value. Set the $vm variable as the VM parameter value.

Start-VBRViReplicaFailback Example 3. Performing Failback to New Location

This example shows how to fail back to a new location.

$restorepoint = Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1

$srv = Get-VBRServer -Name "tech.qa.local"

Start-VBRViReplicaFailback -RestorePoint $restorepoint -Server $srv -PowerOn

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Specify the Name parameter value. Filter restore points with Sort-Object method by the creationtime property to get the most recent one. Save the result to the $restorepoint variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $srv variable.
Run the Start-VBRViReplicaFailback cmdlet. Set the $restorepoint as the RestorePoint parameter value. Set the $srv variable as the Server parameter value. Provide the PowerOn parameter if you want the cmdlet to power on the VM after the failback.