RequestStateChange method of the Msvm_VirtualSystemMigrationService class

Requests a state change.

Syntax

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

Parameters

RequestedState [in]

The new state. The info is placed in the RequestedState property of the instance if the return code of the RequestStateChange method is 0 (Job complete without error) or 4096 (Job started). For more info, see the description of the EnabledState and RequestedState properties for the element. This must be one of the following values.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved (..)

Vendor Reserved (32768..65535)

Job [out]

May contain a reference to the CIM_ConcreteJob created to track the state transition initiated by the method invocation.

TimeoutPeriod [in]

A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the timeout period. A value of 0 or Null indicates that the client has no time requirements for the transition. If this property does not contain 0 or Null and the implementation does not support this parameter, a return code of 4098 (Use Of Timeout Parameter Not Supported) must be returned.

Return value

This method returns one of the following values:

Completed with No Error (0)

Not supported (1)

Requirements

Requirement	Value
Minimum supported client	Windows 8.1
Minimum supported server	Windows Server 2012 R2
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

Msvm_VirtualSystemMigrationService