RequestStateChange method of the CIM_ProtocolEndpoint class
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 RequestStateChange method multiple times could result in earlier requests being overwritten or lost. A return code of 0 shall indicate the state change was successfully initiated. A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter. A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
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\\'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
-
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 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 this parameter, a return code of \\'Use Of Timeout Parameter Not Supported\\' shall be returned.
Return value
-
Completed with No Error (0)
-
Not Supported (1)
-
Unknown or Unspecified Error (2)
-
Cannot complete within Timeout Period (3)
-
Failed (4)
-
Invalid Parameter (5)
-
In Use (6)
-
DMTF Reserved (7 4095)
-
Method Parameters Checked - Job Started (4096)
-
Invalid State Transition (4097)
-
Use of Timeout Parameter Not Supported (4098)
-
Busy (4099)
-
Method Reserved (4100 32767)
-
Vendor Specific (32768 65535)
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\IPAM |
| MOF |
|
| DLL |
|