Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

RequestStateChange method of the MSISCSITARGET_iSCSISession class

Requests that the state of the element be changed to the specified value. Invoking this method multiple times could overwrite or lose earlier requests.

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]

Specifies the state to which the job should be changed.

The RequestedState property of the instance is updated with this value if this method returns Completed with No Error, Timeout, or 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]

On return, contains a reference to the job, but can be null if the task is completed.

TimeoutPeriod [in]

Specifies the maximum amount of time that the client expects the transition to the new state to take. The time-out must be specified by using the datetime interval format.

A value of zero or NULL indicates that the client has no time requirements for the transition. If this property does not contain zero or NULL and the implementation does not support this parameter, a return code of Use Of Timeout Parameter Not Supported must be returned.

Return value

Completed with No Error (0)
Not Supported (1)
Unknown/Unspecified Error (2)
Cannot complete within Timeout Period (3)
Failed (4)
Invalid Parameter (5)
In Use (6)
DMTF Reserved (7–4095)
Method Parameters Checked - Transition 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\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

See also

MSISCSITARGET_iSCSISession
CIM_EnabledLogicalElement

 

 

Show:
© 2014 Microsoft