CIM_ManagedSystemElement class

CIM_ManagedSystemElement is the base class for the system element hierarchy. Any component of a system can potentially be represented by this class or its subclasses.

Examples of system components include:

  • Software components such as application servers, databases, and applications.
  • Operating system components such as files, processes; and threads device components such as disk drives, controllers, processors, and printers.
  • Physical components such as chips and cards.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Abstract, Version("2.11.0"), AMENDMENT]
class CIM_ManagedSystemElement : CIM_ManagedElement
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
};

Members

The CIM_ManagedSystemElement class has these types of members:

Properties

The CIM_ManagedSystemElement class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

A textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

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.

This property is inherited from CIM_ManagedElement.

HealthState

Data type: uint16

Access type: Read-only

Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.

Unknown (0)

The implementation cannot report on HealthState at this time.

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

Degraded/Warning (10)

The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Minor failure (15)

All functionality is available, but some functionality might be degraded.

Major failure (20)

The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.

Critical failure (25)

The element is nonfunctional, and recovery might not be possible.

Non-recoverable error (30)

The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.

DMTF Reserved

Reserved.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024)

The label by which the object is known. When subclassed, the Name property can be overridden to be a key property.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.

Note

The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.

The possible values are.

Unknown (0)

Indicates that the implementation cannot report on the OperationalStatus property at this time.

Other (1)

Indicates an undefined state.

OK (2)

Indicates full functionality without errors.

Degraded (3)

Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.

Stressed (4)

Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.

Predictive Failure (5)

Indicates that an element functions nominally, but predicts a failure in the near future.

Error (6)

Indicates that an error has occurred.

Non-Recoverable Error (7)

Indicates that a nonrecoverable error has occurred.

Starting (8)

Indicates that the job is starting.

Stopping (9)

Indicates that the job is stopping.

Stopped (10)

Indicates that the element has been intentionally stopped.

In Service (11)

Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.

No Contact (12)

Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.

Lost Communication (13)

Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.

Aborted (14)

Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.

Dormant (15)

Indicates that the job is inactive.

Supporting Entity in Error (16)

Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

Completed (17)

Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.

Power Mode (18)

Indicates that the element has additional power model information that is contained in the associated power management service.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

Status

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

Indicates the primary status of the object.

Note

This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008
End of client support
None supported
End of server support
Windows Server 2012 R2
Namespace
Root\virtualization
MOF
WindowsVirtualization.mof

See also

CIM_ManagedElement