CIM_ManagedSystemElement class (Hyper-V management)

Article
01/07/2021

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.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Core::CoreElements"), AMENDMENT]
class CIM_ManagedSystemElement : CIM_ManagedElement
{
  datetime 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

Properties

The CIM_ManagedSystemElement class has these properties.

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.

Unknown (0)

Not Available (1)

Communication OK (2)

Lost Communication (3)

No Contact (4)

DMTF Reserved (..)

Vendor Reserved (0x8000..)

DetailedStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

Not Available (0)

No Additional Information (1)

Stressed (2)

Predictive Failure (3)

Non-Recoverable Error (4)

Supporting Entity in Error (5)

DMTF Reserved (..)

Vendor Reserved (0x8000..)

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)

OK (5)

Degraded/Warning (10)

Minor failure (15)

Major failure (20)

Critical failure (25)

Non-recoverable error (30)

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

OperatingStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.

"Unknown" indicates

"None" indicates that

"Servicing"

"Starting"

"Stopping"

"Stopped" and "Aborted" are similar, although the former , while the latter i

"Dormant" indicates that

"Completed" indicates that t

"Migrating"

"Immigrating"

"Emigrating"

"Shutting Down"

"In Test"

"Transitioning"

"In Service"

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 (3)

Describes an element being initialized.

Stopping (4)

Describes an element being brought to an orderly stop.

Stopped (5)

A clean and orderly stop has occurred.

Aborted (6)

An abrupt stop has occurred, where 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)

Describes an element being brought to an abrupt stop.

In Test (14)

The element is performing test functions.

Transitioning (15)

Describes an element that 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)

Describes an element that is in service and operational.

DMTF Reserved (..)

Vendor Reserved (0x8000..)

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.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

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)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

An 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 ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

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

Dormant (15)

The element is inactive or quiesced.

Supporting Entity in Error (16)

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 (17)

The element has completed its operation.

Power Mode (18)

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

DMTF Reserved (..)

Vendor Reserved (0x8000..)

PrimaryStatus

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Indicates a high-level status value.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved (..)

Vendor Reserved (0x8000..)

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.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

("Stressed")

("NonRecover")

("No Contact")

("Lost Comm")

("Stopped")

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

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

Share via

CIM_ManagedSystemElement class (Hyper-V management)

Syntax

Members

Properties

Requirements

See also

Feedback

Additional resources