Syntax
Set-HCXReplication [-Confirm] -ForceSync -Replication <HCXReplication[]> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]Related Commands
Detailed Description
This cmdlet modifies an existing HCX replication. You can use the cmdlet to perform the FoceSync, Recover, TestRecover, Reverse, and TestCleanup operations on the HCXReplication objects.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Confirm | SwitchParameter | If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation. | false | False | |
| ForceSync | SwitchParameter | Specifies whether you want to sync data from a source to destination with specified RPO. | true | False | |
| NetworkMapping | HCXNetworkMapping[] | Specifies the list of network mapping that you want to use from a source to destination site. | false | True (ByValue) | |
| PowerOffVMAfterRecovery | Boolean | Specifies whether you want to power off the replicated virtual machine after recovering to the source site. | false | False | |
| Replication | HCXReplication[] | Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet. | true | True (ByValue) | |
| Reverse | SwitchParameter | Reverses the replicated virtual machine that has been recovered from the destination to the source site. | true | False | |
| Server | HcxServer[] | Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet. | false | False | |
| Snapshot | HCXReplicationSnapshot | Specifies the snapshot of the replicated virtual machine that you have to recover. | true | True (ByValue) | |
| TargetComputeContainer | HCXComputeContainer | Specifies the container on the target site that you use for recovery. | false | True (ByValue) | |
| TargetDatacenter | HCXFolderContainer | Specifies the data center on the target site that you want to use for recovery. | false | True (ByValue) | |
| Test | SwitchParameter | Specifies the parameter that you want to use when testing the recovery process. | false | False | |
| TestCleanup | SwitchParameter | Specifies the parameter that you want to use when cleaning up the test recovered virtual machine. | true | False | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | False |
Return Type
VMware.VimAutomation.Hcx.Types.V1.HCXJobNotes
Examples
-------------------------- Example 1 --------------------------
PS C:\> Set-HCXReplication -ForceSync -Replication $myReplication
Forces a sync process for the existing replication.
-------------------------- Example 2 --------------------------
PS C:\> Set-HCXReplication -Replication $myReplication -Snapshot $mySnapshot
Recovers the replicated virtual machine at the destination site.
-------------------------- Example 3 --------------------------
PS C:\> Set-HCXReplication -Replication $myReplication -Snapshot $mySnapshot -Test
Tests the recovery process of the replication.
-------------------------- Example 4 --------------------------
PS C:\> Set-HCXReplication -Reverse -Replication $myReplication
Specifies how to reverse the replication.
-------------------------- Example 5 --------------------------
PS C:\> Set-HCXReplication -Replication $myReplication -TestCleanup
Removes the test recovered virtual machine.