SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

## Class CIM_LogicalElement

Used in features: CIM Schema inheritance classes

    CIM_ManagedElement
       CIM_ManagedSystemElement
          CIM_LogicalElement

Known Subclasses:
  CIM_Job CIM_ConcreteJob CIM_EnabledLogicalElement CIM_Service OOB_Service AMT_Service CIM_System CIM_ComputerSystem ME_System

    Abstract class CIM_LogicalElement

extends CIM_ManagedSystemElement

General Information:
CIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices.
Qualifiers:
-------------
Abstract
Version=2.6.0
UMLPackagePath=CIM::Core::CoreElements

Supported Fields Summary
`uint16` | `HealthState` Indicates the current health of the element . . .
`string` | `Status` A string indicating the current status of the object . . .
`string[]` | `StatusDescriptions` Strings describing the various OperationalStatus array values . . .
`uint16[]` | `OperationalStatus` Indicates the current statuses of the element . . .
`string` | `Name` The Name property defines the label by which the object is known . . .
`datetime` | `InstallDate` A datetime value that indicates when the object was installed . . .
`string` | `InstanceID` InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace . . .
`string` | `Caption` The Caption property is a short textual description (one- line string) of the object.
`string` | `Description` The Description property provides a textual description of the object.
`string` | `ElementName` A user-friendly name for the object . . .

Methods Summary

Field Detail

### HealthState

    public uint16 HealthState

  General Information:
  Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined:
  "Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
  "Critical Failure" (25) - The element is non-functional and recovery might not be possible.
  "Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
  "Minor Failure" (15) - All functionality is available but some might be degraded.
  "Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors.
  "OK" (5) - The element is fully functional and is operating within normal operational parameters and without error.
  "Unknown" (0) - The implementation cannot report on HealthState at this time.
  DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
  Qualifiers:
  -------------
  ValueMap={0, 5, 10, 15, 20, 25, 30, ..}
  Values={Unknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF Reserved}

### Status

    public string Status

  General Information:
  A 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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped.
  2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
  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.
  Qualifiers:
  -------------
  Deprecated={CIM_ManagedSystemElement.OperationalStatus}
  ValueMap={OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped}
  MaxLen=10

### StatusDescriptions

    public string[] StatusDescriptions

  General Information:
  Strings 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.
  Qualifiers:
  -------------
  ArrayType=Indexed
  ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
  MaxLen=256

### OperationalStatus

    public uint16[] OperationalStatus

  General Information:
  Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail.
  "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
  "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 state and configuration of the element might need to be updated.
  "Dormant" indicates that the element is inactive or quiesced.
  "Supporting Entity in Error" indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).
  "Power Mode" indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element.
  Qualifiers:
  -------------
  ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..}
  Values={Unknown, 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 Reserved}
  ArrayType=Indexed
  ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}

### Name

    public string Name

  General Information:
  The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.
  Qualifiers:
  -------------
  MaxLen=1024

### InstallDate

    public datetime InstallDate

  General Information:
  A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
  Qualifiers:
  -------------
  MappingStrings={MIF.DMTF|ComponentID|001.5}

### InstanceID

    public string InstanceID

  General Information:
  InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
  To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
  <OrgID>:<LocalID>
  Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.
  <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
  If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
  Qualifiers:
  -------------
  MaxLen=256

### Caption

    public string Caption

  General Information:
  The Caption property is a short textual description (one- line string) of the object.
  Qualifiers:
  -------------
  MaxLen=64

### Description

    public string Description

  General Information:
  The Description property provides a textual description of the object.
  Qualifiers:
  -------------
  MaxLen=256

### ElementName

    public string ElementName

  General Information:
  A 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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties.
  Qualifiers:
  -------------
  MaxLen=256

Method Detail

SUMMARY: NESTED | FIELD | METHOD
DETAIL: FIELD | METHOD