RequestStateChange method of the MSFT_IPAM_Address class

  • Article

Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the this method multiple times could result in earlier requests being overwritten or lost.

This method is inherited from the CIM_EnabledLogicalElement class.

Syntax

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

Parameters

RequestedState [in]

The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 Completed with No Error, or 4096 (0x1000) Job Started.

The possible values are.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved

12 32767

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 TimeoutPeriod. A value of 0 or a null parameter 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 the value, the method returns Use Of Timeout Parameter Not Supported.

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

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

MSFT_IPAM_Address