Class CIM_EnabledLogicalElement


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement


Description

This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint.

Subclasses

CIM_AuthenticationService CIM_AuthorizationService CIM_CIMXMLCommunicationMechanism CIM_Cluster CIM_ClusteringService CIM_ComputerSystem CIM_ControllerConfigurationService CIM_FCPort CIM_Log CIM_LogicalDevice CIM_LogicalPort CIM_MessageLog CIM_NetworkPort CIM_ObjectManager CIM_ObjectManagerCommunicationMechanism CIM_PrivilegeManagementService CIM_ProtocolController CIM_ProtocolEndpoint CIM_RemoteServiceAccessPoint CIM_SCSIProtocolController CIM_SCSIProtocolEndpoint CIM_SecurityService CIM_Service CIM_ServiceAccessPoint CIM_StorageConfigurationService CIM_StorageExtent CIM_StorageHardwareIDManagementService CIM_StorageVolume CIM_System CIM_WBEMService IBMTSSVC_BackendController IBMTSSVC_BackendStorageVolume IBMTSSVC_BackendTargetSCSIProtocolEndpoint IBMTSSVC_BackendVolume IBMTSSVC_CIMXMLCommunicationMechanism IBMTSSVC_CandidateNode IBMTSSVC_CascadingAllocationService IBMTSSVC_Cluster IBMTSSVC_ClusteringService IBMTSSVC_ControllerConfigurationService IBMTSSVC_DeviceConfigurationService IBMTSSVC_FCPort IBMTSSVC_IOGroup IBMTSSVC_InitiatorController IBMTSSVC_MasterConsole IBMTSSVC_MessageLog IBMTSSVC_Node IBMTSSVC_ObjectManager IBMTSSVC_PrivilegeManagementService IBMTSSVC_ProtocolController IBMTSSVC_RemoteServiceAccessPoint IBMTSSVC_SCSIProtocolEndpoint IBMTSSVC_StorageConfigurationService IBMTSSVC_StorageHardwareIDManagementService IBMTSSVC_StorageVolume SNIA_AllocationService

Referenced By


Properties

IdTypeRangeDescription
Key
Read Only
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..65535
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not execute commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8) indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode.Starting (10) indicates that the elementis in the process of going to an Enabled state. New requests are queued.
OtherEnabledState string
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..65535
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState ofthe element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are"Reboot"(10) and"Reset"(11). Reboot refers to doing a"Shut Down"and then moving to an"Enabled"state. Reset indicates that the element is first"Disabled"and then"Enabled". The distinction between requesting"Shut Down"and"Disabled"should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
TimeOfLastStateChange datetime
The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.
Read Write
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
Quiesce9
DMTF Reserved..
Vendor Reserved32768..65535
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is"Enabled"(value=2).
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 

Method Summary

NameDescription
RequestStateChangeRequests that the state of the element be changed to the value specified in the RequestedState parameter.
 

Method Detail


RequestStateChange

Description

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.If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.

Parameters

IdTypeRangeDescription
In
RequestedState uint16
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'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.
TimeoutPeriod datetime
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'must be returned.
out
Job CIM_ConcreteJob
Reference to the job (can be null if the task is completed).
Return Codes
none