Msvm_GuestService::RequestStateChange method

Requests that the state of the guest service be changed to the specified value.

Syntax

uint32 RequestStateChange(
  [in]  uint16              RequestedState,
  [out] CIM_ConcreteJob 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 or 4096. 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]

An optional reference to a CIM_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]

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.

Return code/value Description
Completed with No Error
0
Success.
Not supported
1
Method Parameters Checked - Transition Started
4096
The transition is asynchronous.
Use of Timeout Parameter Not Supported
4098
Access Denied
32769
Access denied.
Invalid state for this operation
32775
The value specified in the RequestedState parameter is not supported.

Requirements

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

See also

Msvm_GuestService