Export (0) Print
Expand All
Expand Minimize

CIM_ManagedSystemElement class

The CIM_ManagedSystemElement class is the base class for the system element hierarchy. Any distinguishable system component is a candidate for inclusion in this class. Examples include software components, such as files; devices, such as disk drives and controllers; and physical components, such as chips and cards.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_ManagedSystemElement : CIM_ManagedElement
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   InstanceId;
  datetime REF InstallDate;
  string   Name;
  uint16   OperationalStatus;
  string   StatusDescriptions;
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
};

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 inherits from CIM_ManagedElement.

CommunicationStatus
Data type: uint16
Access type: Read-only

ValueMeaning
Not Available
0

the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information
1

the element is functioning normally as indicated by PrimaryStatus = OK.

Stressed
2

the element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
3

an element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error
4

this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

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.

DMTF Reserved
..
Vendor Reserved
0x800

 

Description
Data type: string
Access type: Read-only

A textual description of the object. This property inherits from CIM_ManagedElement.

DetailedStatus
Data type: uint16
Access type: Read-only

Compliments PrimaryStatus with additional status detail. Detailed status is used to expand upon the PrimaryStatus of the element.

ValueMeaning
Not Available
0

he implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

No Additional Information
1

the element is functioning normally as indicated by PrimaryStatus = OK.

Stressed
2

"Stressed" indicates that the element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
3

indicates that an element is functioning normally but a failure is predicted in the near future.

Non-Recoverable Error
4

indicates that this element is in an error condition that requires human intervention.

Supporting Entity in Error
5

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.

DMTF Reserved
...
Vendor Reserved
0x800

 

ElementName
Data type: string
Access type: Read-only

A user-friendly name for the object. This property enables each instance to define a display name in addition to its key properties, identity data, and description information. Be aware that the Name property of CIM_ManagedSystemElement is also defined as a display name. However, it is often subclassed to be a Key. 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 CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. This property inherits 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 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.

ValueMeaning
Unknown
0

The implementation cannot report on HealthState at this time.

OK
5

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

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.

Minor Failure
15

All functionality is available but some 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 not working.

Critical Failure
25

The element is non-functional and recovery might not be possible.

Non-recoverable Error
30

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

Reserved
...

The remaining values are reserved for DTMF use.

 

InstallDate
Data type: datetime
Access type: Read-only

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

InstanceId
Data type: string
Access type: Read-only

Within the scope of the instantiating Namespace, InstanceId opaquely and uniquely identifies an instance of this class. 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 SchemaName_ClassName 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 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. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM. This property inherits from CIM_ManagedElement.

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

OperatingStatus
Data type: uint16
Access type: Read-only

Provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.

ValueMeaning
Unknown
0

the implementation is in general capable of returning this property, but is unable to do so at this time.

Not Available
1

the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).

Servicing
2

describes an element being configured, maintained, cleaned, or otherwise administered. Starting describes an element being initialized. "Stopping" describes an element being brought to an orderly stop.

Starting
3

The element is starting.

Stopping
4

The element is stopping.

Stopped
5

A a clean and orderly stop has occurred.

Aborted
6

An abrupt stop has occurred; the state and configuration of the element might need to be updated.

Dormant
7

The element is inactive or quiesced.

Completed
8

The element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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).

Migrating
9

The element is being moved between host elements.

Emigrating
10

The element is being moved away from host element.

Immigrating
11

The element is being moved to new host element.

Snapshotting
12
Shutting Down
13

The element being brought to an abrupt stop.

In Test
14

The element is performing test functions.

Transitioning
15

The element is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.

In Service
16

The element is in service and operational."

DTMF Reserved
..
Vendor Reserved
0x800

 

OperationalStatus
Data type: uint16
Access type: Read-only

The current statuses of the element.

ValueMeaning
Unknown
0

An unknown error has occured.

Other
1

An error other than one on this list has occured.

OK
2

The elemetn is OK.

Degraded
3

The element has been degraded.

Stressed
4

The element is functioning, but needs attention. Examples of Stressed states are overload, overheated, and so on.

Predictive Failure
5

An element is functioning nominally but predicting a failure in the near future.

Error
6

An error has occurred.

Non-Recoverable Error
7

A non-recoverable error has occurred.

Starting
8

The element is in the process of starting.

Stopping
9

The element is in the process of stopping.

Stopped
10

A clean and orderly stop has occurred.

In Service
11

An element being configured, maintained, cleaned, or otherwise administered.

No Contact
12

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication
13

The Managed System Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted
14

An abrupt stop has occurred; the state and configuration of the element might need to be updated.

Dormant
15

The element is inactive or quiesced.

Supporting Entity in Error
16

The current 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
17

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
18

The element has additional power model information contained in the Associated PowerManagementService association.

Relocating
19

indicates the element is being relocated. OperationalStatus replaces the Status property on CIM_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.

DMTF Reserved
..

Reserved for the DTMF.

Vendor Reserved
0x8000

Reserved for the vendors.

 

PrimaryStatus
Data type: uint16
Access type: Read-only

provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the CIM_ManagedSystemElement and its subcomponents.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (...)
Vendor Reserved (0x8000)
Status
Data type: string
Access type: Read-only

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

Values include the following:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusDescriptions
Data type: string
Access type: Read-only

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."

Remarks

WMI does not implement this class. For WMI classes derived from this class, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft