Share via

StartReplication method of the Msvm_CollectionReplicationService class

Starts the replication service for a collection of virtual machines.


uint32 StartReplication(
  [in]  CIM_CollectionOfMSEs REF Collection,
  [in]  uint16                   InitialReplicationType,
  [in]  string                   InitialReplicationExportLocation,
  [in]  datetime                 StartTime,
  [out] CIM_ConcreteJob      REF Job


Collection [in]

A reference to the CIM_CollectionOfMSEs instance that represents the collection of virtual machines.

InitialReplicationType [in]

The type of transfer to use for the initial replication.

Network Transfer (1)

Export (2)

Seeded Network Transfer (3)

InitialReplicationExportLocation [in]

If the InitialReplicationType property is set to "2" (export), this contains the fully-qualified path of the directory to which the initial replication is exported. This method places each virtual machine replication in a separate subdirectory under.

StartTime [in]

The scheduled start time for the initial replication. This parameter is ignored when the InitialReplicationType property is set to "2" (export). When StartTime is not specified, initial replication starts immediately.

Job [out]

An optional job to use for this operation if it is performed asynchronously.

Return value

The possible return values are:

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)


Minimum supported client
None supported
Minimum supported server
Windows Server 2016

See also