Edit

RequestReplicationStateChange method of the Msvm_ComputerSystem class

  • Article

Requests that the replication state of the virtual machine be changed to the specified value and acts on the primary replication relationship of the virtual machine. While the state change is in progress, the ReplicationState property is changed to the value of the RequestedState parameter. This method is only supported for instances of the Msvm_ComputerSystem class that represent a virtual machine.

Note

Starting with Windows 8.1, we recommend not to use RequestReplicationStateChange anymore to request changing of replication state. Instead, use RequestReplicationStateChangeEx.

Syntax

uint32 RequestReplicationStateChange(
  [in]  uint16              RequestedState,
  [out] CIM_ConcreteJob REF Job,
  [in]  datetime            TimeoutPeriod
);

Parameters

RequestedState [in]

The new replication state. The must be one of the following values.

Ready to start initial replication (1)

Ready to start initial replication.

Waiting to complete initial replication (2)

Waiting to complete initial replication.

Replicating (3)

Replicating.

Synced replication complete (4)

Synced replication complete.

Suspend (7)

Suspend replication.

Cancel Resynchronize (9)

Cancel resynchronization.

Job [out]

An optional reference to a Msvm_ConcreteJob object that is returned if the operation is executed asynchronously. If present, the returned reference can be used to monitor progress and obtain the result of the method.

TimeoutPeriod [in]

This parameter is not used.

Return value

This method returns one of the following values.

Return code/value Description
Completed with No Error
0
 Success
Method Parameters Checked - Job Started
4096
 The transition is asynchronous.
Failed
32768
Access Denied
32769
Not Supported
32770
Status is unknown
32771
Timeout
32772
Invalid parameter
32773
 The value specified in one of the parameters is not supported.
System is in use
32774
Invalid state for this operation
32775
 The value specified in the RequestedState parameter is not supported in the current replication mode or state.
Incorrect data type
32776
System is not available
32777
Out of memory
32778
File not found
32779

Requirements

Requirement Value
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_ComputerSystem