Share via


RequestStateChange method of the CIM_System class

Requests the specified state change.

This method is inherited from CIM_EnabledLogicalElement.

Syntax

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

Parameters

RequestedState [in]

The new state to request.

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 [out, ref]

A concrete job that tracks the state transition initiated by this operation.

TimeoutPeriod [in]

The timeout period required by the client when waiting for a state transition. A "0" or null value indicates that the client does not have a timeout requirement for this state transition.

Return value

A return code that indicates whether the operation completed successfully.

The possible return codes are:

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

Remarks

Invoking the RequestStateChange method multiple times before each operation is complete, can result in earlier requests being overwritten or lost.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012 R2
Namespace
Root\Microsoft\IPAM
MOF
IPAMServerPSProvider.mof
DLL
IPAMServerPSProvider.dll

See also

CIM_System