PowerCLI Reference



This cmdlet modifies an existing HCX replication.


Set-HCXReplication [-Confirm] -ForceSync -Replication <HCXReplication[]> [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Set-HCXReplication [-Confirm] [-NetworkMapping <HCXNetworkMapping[]>] [-PowerOffVMAfterRecovery <Boolean>] -Replication <HCXReplication[]> [-Server <HcxServer[]>] -Snapshot <HCXReplicationSnapshot> [-TargetComputeContainer <HCXComputeContainer>] [-TargetDatacenter <HCXFolderContainer>] [-Test] [-WhatIf] [<CommonParameters>]

Set-HCXReplication [-Confirm] -Replication <HCXReplication[]> -Reverse [-Server <HcxServer[]>] [-WhatIf] [<CommonParameters>]

Set-HCXReplication [-Confirm] -Replication <HCXReplication[]> [-Server <HcxServer[]>] -TestCleanup [-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.


NameTypeDescriptionRequired?Pipeline InputDefault Value
ConfirmSwitchParameterIf 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.falseFalse
ForceSyncSwitchParameterSpecifies whether you want to sync data from a source to destination with specified RPO.trueFalse
NetworkMappingHCXNetworkMapping[]Specifies the list of network mapping that you want to use from a source to destination site.falseTrue (ByValue)
PowerOffVMAfterRecoveryBooleanSpecifies whether you want to power off the replicated virtual machine after recovering to the source site.falseFalse
ReplicationHCXReplication[]Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.trueTrue (ByValue)
ReverseSwitchParameterReverses the replicated virtual machine that has been recovered from the destination to the source site.trueFalse
ServerHcxServer[]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.falseFalse
SnapshotHCXReplicationSnapshotSpecifies the snapshot of the replicated virtual machine that you have to recover.trueTrue (ByValue)
TargetComputeContainerHCXComputeContainerSpecifies the container on the target site that you use for recovery.falseTrue (ByValue)
TargetDatacenterHCXFolderContainerSpecifies the data center on the target site that you want to use for recovery.falseTrue (ByValue)
TestSwitchParameterSpecifies the parameter that you want to use when testing the recovery process.falseFalse
TestCleanupSwitchParameterSpecifies the parameter that you want to use when cleaning up the test recovered virtual machine.trueFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type




-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.