Set-HCXReplication

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.

Syntax

-ForceSync
-Replication  <HCXReplication[]>
[-Server  <HcxServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
ForceSync
SwitchParameter named Specifies whether you want to sync data from a source to destination with specified RPO.
required
Replication
HCXReplication[] named
  • pipeline
  • Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.

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

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Replication
    HCXReplication[] named
  • pipeline
  • Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.
    required
    Snapshot
    HCXReplicationSnapshot named
  • pipeline
  • Specifies the snapshot of the replicated virtual machine that you have to recover.
    optional
    NetworkMapping
    HCXNetworkMapping[] named
  • pipeline
  • Specifies the list of network mapping that you want to use from a source to destination site.
    optional
    PowerOffVMAfterRecovery
    Boolean named Specifies whether you want to power off the replicated virtual machine after recovering to the source site.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.
    optional
    TargetComputeContainer
    HCXComputeContainer named
  • pipeline
  • Specifies the container on the target site that you use for recovery.
    optional
    TargetDatacenter
    HCXFolderContainer named
  • pipeline
  • Specifies the data center on the target site that you want to use for recovery.
    optional
    Test
    SwitchParameter named Specifies the parameter that you want to use when testing the recovery process.

    -Replication  <HCXReplication[]>
    -Reverse
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Replication
    HCXReplication[] named
  • pipeline
  • Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.
    required
    Reverse
    SwitchParameter named Reverses the replicated virtual machine that has been recovered from the destination to the source site.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.

    -Replication  <HCXReplication[]>
    -TestCleanup
    [-Server  <HcxServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Replication
    HCXReplication[] named
  • pipeline
  • Specifies the replication. If you want to retrieve a replication request, use the Get-HCXReplication cmdlet.
    required
    TestCleanup
    SwitchParameter named Specifies the parameter that you want to use when cleaning up the test recovered virtual machine.
    optional
    Server
    HcxServer[] named
  • wildcards
  • Specifies the HCX Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.

    Output

    VMware.VimAutomation.Hcx.Types.V1.HCXJob

    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.

    Related Commands

    Feedback

    Was this page helpful?