New-HCXReplication Command | Vmware PowerCLI Reference

New-HCXReplication

This cmdlet creates an HCX replication request. You can use the output of the cmdlet in the Start-HCXReplication cmdlet.

Syntax

New-HCXReplication
-DestinationSite < HCXSite >
-NetworkMapping < HCXNetworkMapping[] >
-RPOIntervalMinutes < Int32 >
-SnapshotIntervalMinutes < Int32 >
-SnapshotNumber < Int32 >
-SourceSite < HCXSite >
-TargetDatastore < HCXDatastore >
-VM < HCXVM >
[-NetworkCompressionEnabled < Boolean > ]
[-QuiesceGuestEnabled < Boolean > ]
[-Server < HcxServer[] > ]
[-TargetComputeContainer < HCXComputeContainer > ]
[-TargetDataCenter < HCXFolderContainer > ]
[-TargetStorageProfile < HCXStorageProfile > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DestinationSite HCXSite named
  • pipeline
Specifies the site to which you want to replicate the virtual machine.
required
NetworkMapping HCXNetworkMapping[] named
  • pipeline
Specifies the list of network mapping from a source to destination site that you want to use.
required
RPOIntervalMinutes Int32 named
Specifies the time interval in minutes for which the data should sync from source to destination.
required
SnapshotIntervalMinutes Int32 named
Specifies the time interval for which you can take the specified number of snapshots.
required
SnapshotNumber Int32 named
Specifies the number of snapshots that you want to take.
required
SourceSite HCXSite named
  • pipeline
Specifies the site at which the virtual machine that you want to replicate resides.
required
TargetDatastore HCXDatastore named
  • pipeline
Specifies the target datastore.
required
VM HCXVM named
  • pipeline
Specifies the virtual machine at the source site that you want to protect.
optional NetworkCompressionEnabled Boolean named
Specifies the network compression enabled option.
optional QuiesceGuestEnabled Boolean named
Specifies the quiesce guest enabled option.
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 target compute container.
optional TargetDataCenter HCXFolderContainer named
  • pipeline
Specifies the data center at the destination site that you want to use.
optional TargetStorageProfile HCXStorageProfile named
  • pipeline
Specifies the storage profile at the destination site that you want to use.
New-HCXReplication
-DestinationSeedVm < HCXVM >
-DestinationSite < HCXSite >
-RPOIntervalMinutes < Int32 >
-SnapshotIntervalMinutes < Int32 >
-SnapshotNumber < Int32 >
-SourceSite < HCXSite >
-VM < HCXVM >
[-NetworkCompressionEnabled < Boolean > ]
[-NetworkMapping < HCXNetworkMapping[] > ]
[-QuiesceGuestEnabled < Boolean > ]
[-Server < HcxServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
DestinationSeedVm HCXVM named
Specifies the virtual machine on the destination site that you want to use as a seed for replicating.
required
DestinationSite HCXSite named
  • pipeline
Specifies the site to which you want to replicate the virtual machine.
required
RPOIntervalMinutes Int32 named
Specifies the time interval in minutes for which the data should sync from source to destination.
required
SnapshotIntervalMinutes Int32 named
Specifies the time interval for which you can take the specified number of snapshots.
required
SnapshotNumber Int32 named
Specifies the number of snapshots that you want to take.
required
SourceSite HCXSite named
  • pipeline
Specifies the site at which the virtual machine that you want to replicate resides.
required
VM HCXVM named
  • pipeline
Specifies the virtual machine at the source site that you want to protect.
optional NetworkCompressionEnabled Boolean named
Specifies the network compression enabled option.
optional NetworkMapping HCXNetworkMapping[] named
Specifies the list of network mapping from a source to destination site that you want to use.
optional QuiesceGuestEnabled Boolean named
Specifies the quiesce guest enabled option.
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.HCXReplication

Examples

Example 1

New-HCXReplication -DestinationSite $myDestination -NetworkMapping $myNetworkMapping -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -TargetComputeContainer $myTargetComputeContainer -TargetDataCenter $myTargetDataCenter -TargetDatastore $myTargetDatastore -VM $myVm

Creates a replication request.

Example 2

New-HCXReplication -DestinationSeedVm $myDestinationSeedVm -DestinationSite myDestination -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -VM $myVm

Creates a replication request with a seed virtual machine option.

Example 3

$myDestination = Get-HCXSite -Destination -Name "myDestinationName"
        $myStorageProfile = Get-HCXStorageProfile -Site $myDestination -Name "myStorageProfileName"
New-HCXReplication -DestinationSite $myDestination -NetworkMapping $myNetworkMapping -RPOIntervalMinutes 30 -SnapshotIntervalMinutes 180 -SnapshotNumber 3 -SourceSite $mySourceSite -TargetComputeContainer $myTargetComputeContainer -TargetDataCenter $myTargetDataCenter -TargetDatastore $myTargetDatastore -VM $myVm -StorageProfile $myStorageProfile

Creates a replication request with a datastore matching storage profile on the destination site.

Related Commands

HCXReplication

This cmdlet retrieves a list of HCX replications.

This cmdlet creates an HCX replication request.

This cmdlet removes an existing HCX replication.

This cmdlet resumes an HCX replication.

This cmdlet modifies an existing HCX replication.

This cmdlet starts an HCX replication.

This cmdlet suspends an existing HCX replication.

This cmdlet validates an HCX replication request.

HCXReplicationSnapshot

This cmdlet retrieves a list of HCX replication snapshots.