RequestStateChange method of the CIM_ProtocolController class

Requests the specified change to the state of the element.

Syntax

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

Parameters

RequestedState [in]

The requested state for the element.

The possible values are:

2

Enabled

3

Disabled

4

Shut Down

6

Offline

7

Test

8

Defer

9

Quiesce

10

Reboot

11

Reset

12 32767

DMTF Reserved

32768..65535

Vendor Reserved

Job [in, out]

A reference to the job created to track the state transition initiated by the method invocation.

TimeoutPeriod [in]

The client specified timeout interval for the length of the state transition. A 0 or a null value 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, this method returns 4098 (Use Of Timeout Parameter Not Supported).

Return value

The is method returns one of the following values:

0

Completed with No Error

1

Not Supported

2

Unknown or Unspecified Error

3

Cannot complete within Timeout Period

4

Failed

5

Invalid Parameter

6

In Use

7 4095

DMTF Reserved

4096

Method Parameters Checked - Job Started

4097

Invalid State Transition

4098

Use of Timeout Parameter Not Supported

4099

Busy

4100 32767

Method Reserved

32768 65535

Vendor Specific

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

See also

CIM_ProtocolController