StartReplication method of the Msvm_ReplicationService class

Starts the replication of a virtual machine. When a client calls this method for a replica virtual machine, it starts the replication with extended replica.

Syntax

uint32 StartReplication(
  [in]  CIM_ComputerSystem REF ComputerSystem,
  [in]  uint16                 InitialReplicationType,
  [in]  string                 InitialReplicationExportLocation,
  [in]  datetime               StartTime,
  [out] CIM_ConcreteJob    REF Job
);

Parameters

ComputerSystem [in]

A reference to a CIM_ComputerSystem instance that represents the virtual machine for which the replication should be started.

InitialReplicationType [in]

The type of transfer to be used for performing the initial replication.

Network Transfer (1)

Network transfer.

Export (2)

Export.

Seeded Network Transfer (3)

Seeded network transfer.

InitialReplicationExportLocation [in]

If InitialReplicationType is 2 (Export), this parameter contains the fully qualified path of the directory to which the initial replication is to be exported. This parameter is not used for other values of InitialReplicationType, and can be Null. This directory can be reused for exporting multiple virtual machine replication. This method places each virtual machine replication in a separate subdirectory under this path.

StartTime [in]

The scheduled start time for the initial replication over the network connection to recovery server. This parameter is ignored when InitialReplicationType is 2 (Export). If this parameter is Null, the initial replication starts immediately.

Job [out]

If the operation is performed asynchronously, this method will return 4096, and this parameter will contain a reference to an object derived from CIM_ConcreteJob.

Return value

This method returns one of the following values.

Completed with No Error (0)

Method Parameters Checked - Job Started (4096)

Failed (32768)

Access Denied (32769)

Not Supported (32770)

Status is unknown (32771)

Timeout (32772)

Invalid parameter (32773)

System is in use (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

File not found (32779)

Requirements

Minimum supported client
Windows 8 [desktop apps only]
Minimum supported server
Windows Server 2012 [desktop apps only]
Namespace
Root\Virtualization\V2
MOF
WindowsVirtualization.V2.mof
DLL
Vmms.exe

See also

Msvm_ReplicationService