CIM_System class
CIM_System represents a set of components that function as a single high-level entity.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Core::CoreElements"), Abstract, Version("2.15.0"), AMENDMENT]
class CIM_System : CIM_EnabledLogicalElement
{
string InstanceID;
string Caption;
string Description;
string ElementName;
datetime InstallDate;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
uint16 EnabledState = 5;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState = 12;
string Name;
string CreationClassName;
string NameFormat;
string PrimaryOwnerName;
string PrimaryOwnerContact;
string Roles[];
string OtherIdentifyingInfo[];
string IdentifyingDescriptions[];
};
Members
The CIM_System class has these types of members:
Methods
The CIM_System class has these methods.
| Method | Description |
|---|---|
| RequestStateChange | Requests that the state of the element be changed to the specified value. This method is inherited from the CIM_EnabledLogicalElement class. |
Properties
The CIM_System class has these properties.
-
AvailableRequestedStates
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")
AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.
This property is inherited from CIM_EnabledLogicalElement.
-
-
Enabled (2)
-
Disabled (3)
-
Shut Down (4)
-
Offline (6)
-
Test (7)
-
Defer (8)
-
Quiesce (9)
-
Reboot (10)
-
Reset (11)
-
DMTF Reserved
- 12 65535
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
CommunicationStatus
-
Data type: uint16
-
Access type: Read-only
Indicates the ability of the instrumentation to communicate with the underlying managed element.
A Null return indicates the implementation (provider) does not implement this property.
This property is inherited from CIM_ManagedSystemElement.
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).
Communication OK (2)
Communication is established with the element, but does not convey any quality of service.
Lost Communication (3)
The Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
No Contact (4)
The monitoring system has knowledge of this element, but has never been able to establish communications with it.
DMTF Reserved
Vendor Reserved
CreationClassName
CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
Description
-
Data type: string
-
Access type: Read-only
The Description property provides a textual description of the object.
This property is inherited from CIM_ManagedElement.
DetailedStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")
Compliments PrimaryStatus with additional status detail.
A Null return indicates the implementation (provider) does not implement this property.
This property is inherited from CIM_ManagedSystemElement.
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
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.
EnabledDefault
-
Data type: uint16
-
Access type: Read/write
An enumerated value indicating an administrator\'s default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).
This property is inherited from CIM_EnabledLogicalElement.
Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved
Vendor Reserved
EnabledState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
EnabledState is an integer enumeration that indicates the enabled and 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 and disabled states:
Enabled (2) indicates that the element is or 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 does not support being enabled or disabled.
Enabled but Offline (6) indicates that the element might 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 might be completing commands, but will queue any new requests.
Quiesce (9) indicates that the element is enabled but in a restricted mode.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
This property is inherited from CIM_EnabledLogicalElement.
Unknown (0)
Other (1)
Enabled (2)
Disabled (3)
Shutting Down (4)
Not Applicable (5)
Enabled but Offline (6)
In Test (7)
Deferred (8)
Quiesce (9)
Starting (10)
DMTF Reserved
Vendor Reserved
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.
This property is inherited from CIM_ManagedSystemElement.
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.
DMTF Reserved
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_System.OtherIdentifyingInfo")
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifying Info array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
InstallDate
-
Data type: datetime
-
Access type: Read-only
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
InstanceID
-
Data type: string
-
Access type: Read-only
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.
This property is inherited from CIM_ManagedElement.
Name
The inherited Name serves as the key of a System instance in an enterprise environment.
NameFormat
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The System object and its derivatives are top-level objects of CIM. They provide the scope for numerous components. Having unique System keys is required. A heuristic can be defined in individual System subclasses to attempt to always generate the same System Name Key. The NameFormat property identifies how the System name was generated, using the heuristic of the subclass.
OperatingStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
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.
A Null return indicates the implementation (provider) does not implement this property.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation (ie, the provider) 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)
An element is being configured, maintained, cleaned, or otherwise administered.
Starting (3)
The element is being initialized.
Stopping (4)
An element is being brought to an orderly stop.
Stopped (5)
A clean and orderly stop has occurred.
Aborted (6)
An abrupt stop, where the state and configuration of the element might need to be updated, has occurred.
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 is being brought to an abrupt stop.
In Test (14)
The managed element is performing test functions.
Transitioning (15)
The 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)
The element is in service and operational.
DMTF Reserved
Vendor Reserved
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Indicates the current statuses of the element. Various operational statuses are defined.
OperationalStatus replaces the Status property 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.
This property is inherited from CIM_ManagedSystemElement.
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)
A clean and orderly stop has occurred.
In Service (11)
An element is 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, 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. 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.
DMTF Reserved
Vendor Reserved
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
This property is inherited from CIM_EnabledLogicalElement.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), MaxLen (256), ModelCorrespondence ("CIM_System.IdentifyingDescriptions")
OtherIdentifyingInfo captures additional data, beyond System Name information, that could be used to identify a ComputerSystem. One example would be to hold the Fibre Channel World-Wide Name (WWN) of a node. Note that if only the Fibre Channel name is available and is unique (able to be used as the System key), then this property would be NULL and the WWN would become the System key, its data placed in the Name property.
PrimaryOwnerContact
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (256)
A string that provides information on how the primary system owner can be reached (for example, phone number, e-mail address, and so on).
PrimaryOwnerName
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (64)
The name of the primary system owner. The system owner is the primary user of the system.
PrimaryStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")
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 managed element and its subcomponents.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation is in general capable of returning this property, but is unable to do so at this time.
OK (1)
The managed element is functioning normally.
Degraded (2)
The managed element is functioning below normal.
Error (3)
The managed element is in an Error condition.
DMTF Reserved
Vendor Reserved
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.
If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".
This property is inherited from CIM_EnabledLogicalElement.
Unknown (0)
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Deferred (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved
Vendor Reserved
Roles
-
Data type: string array
-
Access type: Read/write
An array (bag) of strings that specifies the administrator -defined roles this System plays in the managed environment. Examples might be \'Building 8 print server\' or \'Boise user directories\'. A single system may perform multiple roles.
Note that the instrumentation view of the \'roles\' of a System is defined by instantiating a specific subclass of System, or by properties in a subclass, or both. For example, the purpose of a ComputerSystem is defined using the Dedicated and OtherDedicatedDescription properties.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
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:
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.
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
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.
This property is inherited from CIM_ManagedSystemElement.
("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")
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.
This property is inherited from CIM_ManagedSystemElement.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The date or time when the EnabledState of the element 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.
This property is inherited from CIM_EnabledLogicalElement.
TransitioningToState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")
TransitioningToState indicates the target state to which the instance is transitioning.
A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.
A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.
This property is inherited from CIM_EnabledLogicalElement.
Unknown (0)
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved
Remarks
CIM_System represents an entity made up of component parts (defined by the system-component relationship), that operates as a functional whole. Systems are top-level objects in the CIM hierarchy, and do not require a scope or weak relationship in order to exist and have context. You can uniquely name and manage a system at an enterprise level. For example, a computer system is a kind of System that can be uniquely named and independently managed in an enterprise. However, these qualities are not true for a power supply or power supply sub-system within a computer.
Although a system can be viewed as a collection, that is not the correct model. A collection is just a container that holds its members. A system is a higher-level abstraction, built out of its individual components. CIM_System is a subclass of CIM_EnabledLogicalElement, which allows the entire abstraction to be functionally enabled or disabled at a higher level than enabling or disabling its component parts.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\Microsoft\IPAM |
| MOF |
|
| DLL |
|