Class CIM_EnabledLogicalElement
extends CIM_LogicalElement

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

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement

Direct Known Subclasses

CIM_System
CIM_AdminDomain
CIM_J2eeDomain
CIM_Network
CIM_AutonomousSystem
CIM_RoutingProtocolDomain
CIM_OSPFArea
CIM_ReusablePolicyContainer
CIM_PolicyRepository
CIM_ComputerSystem
CIM_UnitaryComputerSystem
CIM_VirtualComputerSystem
CIM_Cluster
CIM_ApplicationSystem
CIM_J2eeServer
CIM_J2eeApplication
CIM_DatabaseSystem
CIM_StorageLibrary
CIM_Service
CIM_PowerManagementService
CIM_ClusteringService
CIM_BootService
CIM_OOBAlertService
CIM_WakeUpService
CIM_DiagnosticTest
CIM_WBEMService
CIM_ObjectManager
CIM_ProtocolAdapter
CIM_ObjectManagerAdapter
CIM_SecurityService
CIM_AuthenticationService
CIM_VerificationService
CIM_CredentialManagementService
CIM_LocalCredentialManagementService
CIM_PublicKeyManagementService
CIM_SharedSecretService
CIM_KerberosKeyDistributionCenter
CIM_CertificateAuthority
CIM_Notary
CIM_StorageHardwareIDManagementService
CIM_AuthorizationService
CIM_PrivilegeManagementService
CIM_AccountManagementService
CIM_J2eeDeployedObject
CIM_J2eeModule
CIM_J2eeAppClientModule
CIM_J2eeEJBModule
CIM_J2eeWebModule
CIM_J2eeResourceAdapterModule
CIM_J2eeEJB
CIM_J2eeMessageDrivenBean
CIM_J2eeEntityBean
CIM_J2eeSessionBean
CIM_J2eeStatefulSessionBean
CIM_J2eeStatelessSessionBean
CIM_J2eeServlet
CIM_J2eeResourceAdapter
CIM_NetworkService
CIM_ForwardingService
CIM_SwitchService
CIM_TransparentBridgingService
CIM_SpanningTreeService
CIM_SourceRoutingService
CIM_RouteCalculationService
CIM_OSPFService
CIM_BGPService
CIM_SNMPService
CIM_QoSService
CIM_PrecedenceService
CIM_DiffServService
CIM_AFService
CIM_EFService
CIM_Hdr8021PService
CIM_FlowService
CIM_ConditioningService
CIM_ClassifierService
CIM_ClassifierElement
CIM_MeterService
CIM_AverageRateMeterService
CIM_EWMAMeterService
CIM_TokenBucketMeterService
CIM_MarkerService
CIM_PreambleMarkerService
CIM_ToSMarkerService
CIM_DSCPMarkerService
CIM_Priority8021QMarkerService
CIM_DropperService
CIM_REDDropperService
CIM_WeightedREDDropperService
CIM_HeadTailDropper
CIM_QueuingService
CIM_PacketSchedulingService
CIM_NonWorkConservingSchedulingService
CIM_DropThresholdCalculationService
CIM_VLANService
CIM_Specific802dot1QVLANService
CIM_DatabaseService
CIM_ControllerConfigurationService
CIM_ZoneService
CIM_FibreProtocolService
CIM_IBSubnetManager
CIM_StorageConfigurationService
CIM_ConfigurationReportingService
CIM_PrintService
PRS_SISService
CIM_ServiceAccessPoint
CIM_RemoteServiceAccessPoint
CIM_RemotePort
CIM_SNMPTrapTarget
CIM_ServiceAccessURI
CIM_ProtocolEndpoint
CIM_LANEndpoint
CIM_IPProtocolEndpoint
CIM_BGPProtocolEndpoint
CIM_IPXProtocolEndpoint
CIM_TCPProtocolEndpoint
CIM_UDPProtocolEndpoint
CIM_OSPFProtocolEndpointBase
CIM_OSPFProtocolEndpoint
CIM_OSPFVirtualInterface
CIM_SwitchPort
CIM_SecurityAssociationEndpoint
CIM_IPsecSAEndpoint
CIM_IKESAEndpoint
CIM_ClusteringSAP
CIM_BootSAP
CIM_ObjectManagerCommunicationMechanism
CIM_CIMXMLCommunicationMechanism
CIM_CredentialManagementSAP
CIM_SNMPCommunityString
CIM_VLAN
CIM_PrintSAP
CIM_LogicalDevice
CIM_StorageExtent
CIM_DatabaseSegment
CIM_StorageVolume
CIM_VolumeSet
CIM_MediaPartition
CIM_DiskPartition
CIM_TapePartition
CIM_LogicalDisk
CIM_CompositeExtent
CIM_PhysicalExtent
CIM_ProtectedSpaceExtent
CIM_AggregatePExtent
CIM_AggregatePSExtent
CIM_Snapshot
CIM_Memory
CIM_NonVolatileStorage
CIM_VolatileStorage
CIM_CacheMemory
CIM_CoolingDevice
CIM_Refrigeration
CIM_HeatPipe
CIM_Fan
CIM_Battery
CIM_PowerSupply
CIM_UninterruptiblePowerSupply
CIM_Watchdog
CIM_Processor
CIM_Controller
CIM_ESCONController
CIM_IDEController
CIM_InfraredController
CIM_ManagementController
CIM_ParallelController
CIM_PCMCIAController
CIM_SCSIController
CIM_SerialController
CIM_SSAController
CIM_USBController
CIM_VideoController
CIM_PCVideoController
CIM_AGPVideoController
CIM_PCIController
CIM_PCIDevice
CIM_PCIBridge
CIM_PortController
CIM_LogicalPort
CIM_NetworkPort
CIM_EthernetPort
CIM_TokenRingPort
CIM_FCPort
CIM_FibrePort
CIM_USBPort
CIM_LogicalModule
CIM_ProtocolController
CIM_SCSIProtocolController
CIM_NetworkAdapter
CIM_EthernetAdapter
CIM_TokenRingAdapter
CIM_FibreChannelAdapter
CIM_MediaAccessDevice
CIM_DiskDrive
CIM_DisketteDrive
CIM_CDROMDrive
CIM_DVDDrive
CIM_WORMDrive
CIM_MagnetoOpticalDrive
CIM_TapeDrive
CIM_MediaTransferDevice
CIM_PickerElement
CIM_ChangerDevice
CIM_LimitedAccessPort
CIM_InterLibraryPort
CIM_LabelReader
CIM_UserDevice
CIM_PointingDevice
CIM_Keyboard
CIM_Display
CIM_DesktopMonitor
CIM_FlatPanel
CIM_Scanner
CIM_Door
CIM_Modem
CIM_ConnectionBasedModem
CIM_DSLModem
CIM_ADSLModem
CIM_HDSLModem
CIM_SDSLModem
CIM_VDSLModem
CIM_CableModem
CIM_CallBasedModem
CIM_ISDNModem
CIM_POTSModem
CIM_Unimodem
CIM_Printer
CIM_Sensor
CIM_BinarySensor
CIM_MultiStateSensor
CIM_NumericSensor
CIM_TemperatureSensor
CIM_CurrentSensor
CIM_VoltageSensor
CIM_Tachometer
CIM_DiscreteSensor
CIM_AlarmDevice
CIM_USBDevice
CIM_USBHub
CIM_FileSystem
CIM_LocalFileSystem
CIM_UnixLocalFileSystem
CIM_RemoteFileSystem
CIM_NFS
CIM_DatabaseStorageArea
CIM_OperatingSystem
CIM_Process
CIM_UnixProcess
CIM_Thread
CIM_UnixThread
CIM_JobDestination
CIM_PrintQueue
CIM_SystemResource
CIM_IRQ
CIM_MemoryMappedIO
CIM_MemoryResource
CIM_PortResource
CIM_DMA
CIM_J2eeResource
CIM_J2eeJavaMailResource
CIM_J2eeJCAResource
CIM_J2eeJDBCResource
CIM_J2eeJMSResource
CIM_J2eeJNDIResource
CIM_J2eeJTAResource
CIM_J2eeRMI_IIOPResource
CIM_J2eeURLResource
CIM_MessageLog
CIM_J2eeManagedObject
CIM_J2eeJVM
CIM_J2eeJCAConnectionFactory
CIM_J2eeJCAManagedConnectionFactory
CIM_J2eeJDBCDataSource
CIM_J2eeJDBCDriver
CIM_NetworkPipe
CIM_CommonDatabase

Class Qualifiers

NameData TypeValueScopeFlavors
AbstractbooleantrueTOSUBCLASS= falseNone
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint.None TRANSLATABLE= true
Versionstring2.8.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 8..32767, 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/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/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
Namestring
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.None TRANSLATABLE= true
MaxLenuint321024None None
OtherEnabledStatestring
DescriptionstringA string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration. 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). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, 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 may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535None None
ValuesstringEnabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
TimeOfLastStateChangedatetime
DescriptionstringThe date/time when the element's EnabledState 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.None TRANSLATABLE= true
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. "Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None