| InstanceID |
string |
CIM_ManagedElement |
|
Key
|
TRUE |
|
Override
|
InstanceID |
|
Description
|
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 <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 the above "preferred" algorithm is not used, the defining entity must ensure 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. |
|
| Caption |
string |
CIM_ManagedElement |
|
Description
|
The Caption property is a short textual description (one- line string) of the object. |
|
MaxLen
|
64 |
|
| Description |
string |
CIM_ManagedElement |
|
Description
|
The Description property provides a textual description of the object. |
|
| ElementName |
string |
CIM_ManagedElement |
|
Description
|
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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class. |
|
| InstallDate |
datetime |
CIM_ManagedSystemElement |
|
Description
|
A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. |
|
MappingStrings
|
MIF.DMTF|ComponentID|001.5 |
|
| Name |
string |
CIM_ManagedSystemElement |
|
Description
|
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. |
|
MaxLen
|
1024 |
|
| OperationalStatus |
uint16[] |
CIM_ManagedSystemElement |
|
Description
|
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. |
|
ValueMap
|
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000.. |
|
Values
|
"Unknown" [0]
"Other" [1]
"OK" [2]
"Degraded" [3]
"Stressed" [4]
"Predictive Failure" [5]
"Error" [6]
"Non-Recoverable Error" [7]
"Starting" [8]
"Stopping" [9]
"Stopped" [10]
"In Service" [11]
"No Contact" [12]
"Lost Communication" [13]
"Aborted" [14]
"Dormant" [15]
"Supporting Entity in Error" [16]
"Completed" [17]
"Power Mode" [18]
"DMTF Reserved" [..]
"Vendor Reserved" [0x8000..] |
|
ArrayType
|
Indexed |
|
ModelCorrespondence
|
CIM_ManagedSystemElement.StatusDescriptions |
|
| StatusDescriptions |
string[] |
CIM_ManagedSystemElement |
|
Description
|
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. |
|
ArrayType
|
Indexed |
|
ModelCorrespondence
|
CIM_ManagedSystemElement.OperationalStatus |
|
| Status |
string |
CIM_ManagedSystemElement |
|
Deprecated
|
CIM_ManagedSystemElement.OperationalStatus |
|
Description
|
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. |
|
ValueMap
|
OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped |
|
MaxLen
|
10 |
|
| HealthState |
uint16 |
CIM_ManagedSystemElement |
|
Description
|
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. |
|
ValueMap
|
0, 5, 10, 15, 20, 25, 30, .. |
|
Values
|
"Unknown" [0]
"OK" [5]
"Degraded/Warning" [10]
"Minor failure" [15]
"Major failure" [20]
"Critical failure" [25]
"Non-recoverable error" [30]
"DMTF Reserved" [..] |
|
| CommunicationStatus |
uint16 |
CIM_ManagedSystemElement |
|
Description
|
CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"Not Available" indicates that 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 " indicates communication is established with the element, but does not convey any quality of service.
"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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable. |
|
ValueMap
|
0, 1, 2, 3, 4, .., 0x8000.. |
|
Values
|
"Unknown" [0]
"Not Available" [1]
"Communication OK" [2]
"Lost Communication" [3]
"No Contact" [4]
"DMTF Reserved" [..]
"Vendor Reserved" [0x8000..] |
|
| DetailedStatus |
uint16 |
CIM_ManagedSystemElement |
|
Description
|
DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
"Not Available" indicates that 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" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".
"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 normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention.
"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. |
|
ValueMap
|
0, 1, 2, 3, 4, 5, .., 0x8000.. |
|
Values
|
"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..] |
|
ModelCorrespondence
|
CIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthState |
|
| OperatingStatus |
uint16 |
CIM_ManagedSystemElement |
|
Description
|
OperatingStatus 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.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"None" indicates that 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" 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.
"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.
"Completed" indicates that 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" element is being moved between host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting Down" describes an element being brought to an abrupt stop.
"In Test" element is performing test functions.
"Transitioning" 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" describes an element that is in service and operational. |
|
ValueMap
|
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000.. |
|
Values
|
"Unknown" [0]
"Not Available" [1]
"Servicing" [2]
"Starting" [3]
"Stopping" [4]
"Stopped" [5]
"Aborted" [6]
"Dormant" [7]
"Completed" [8]
"Migrating" [9]
"Emigrating" [10]
"Immigrating" [11]
"Snapshotting" [12]
"Shutting Down" [13]
"In Test" [14]
"Transitioning" [15]
"In Service" [16]
"DMTF Reserved" [..]
"Vendor Reserved" [0x8000..] |
|
ModelCorrespondence
|
CIM_EnabledLogicalElement.EnabledState |
|
| PrimaryStatus |
uint16 |
CIM_ManagedSystemElement |
|
Description
|
PrimaryStatus 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 ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded" indicates the ManagedElement is functioning below normal.
"Error" indicates the ManagedElement is in an Error condition. |
|
ValueMap
|
0, 1, 2, 3, .., 0x8000.. |
|
Values
|
"Unknown" [0]
"OK" [1]
"Degraded" [2]
"Error" [3]
"DMTF Reserved" [..]
"Vendor Reserved" [0x8000..] |
|
ModelCorrespondence
|
CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState |
|
| PoolID |
string |
CIM_ResourcePool |
|
Description
|
An opaque identifier for the pool. This property is used to provide correlation across save and restore of configuration data to underlying persistent storage. |
|
ModelCorrespondence
|
CIM_ResourceAllocationSettingData.PoolId |
|
| Primordial |
boolean |
CIM_ResourcePool |
|
Description
|
If true, "Primordial" indicates that this ResourcePool is a base from which resources are drawn and returned in the activity of resource management. Being primordial means that this ResourcePool shall not be created or deleted by consumers of this model. However, other actions, modeled or not, may affect the characteristics or size of primordial ResourcePools. If false, "Primordial" indicates that the ResourcePool, a concrete Resource Pool, is subject to resource allocation services functions. This distinction is important because higher-level ResourcePools may be assembled using the Component or ElementAllocatedFromPool associations. Although the higher-level abstractions can be created and deleted, the most basic, (i.e. primordial), hardware-based ResourcePools cannot. They are physically realized as part of the System, or are actually managed by some other System and imported as if they were physically realized. |
|
| Capacity |
uint64 |
CIM_ResourcePool |
|
Description
|
This property represents the maximum amount (in units of AllocationUnits) of reservations that the ResourcePool can support. |
|
| Reserved |
uint64 |
CIM_ResourcePool |
|
Description
|
This property represents the current reservations (in units of AllocationUnits) spread across all active allocations from this pool. In a hierarchical configuration, this represents the sum of all descendant ResourcePool current reservations. |
|
| ResourceType |
uint16 |
CIM_ResourcePool |
|
Description
|
The type of resource this ResourcePool may allocate. |
|
ValueMap
|
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, .., 0x8000..0xFFFF |
|
Values
|
"Other" [1]
"Computer System" [2]
"Processor" [3]
"Memory" [4]
"IDE Controller" [5]
"Parallel SCSI HBA" [6]
"FC HBA" [7]
"iSCSI HBA" [8]
"IB HCA" [9]
"Ethernet Adapter" [10]
"Other Network Adapter" [11]
"I/O Slot" [12]
"I/O Device" [13]
"Floppy Drive" [14]
"CD Drive" [15]
"DVD drive" [16]
"Disk Drive" [17]
"Tape Drive" [18]
"Storage Extent" [19]
"Other storage device" [20]
"Serial port" [21]
"Parallel port" [22]
"USB Controller" [23]
"Graphics controller" [24]
"IEEE 1394 Controller" [25]
"Partitionable Unit" [26]
"Base Partitionable Unit" [27]
"Power" [28]
"Cooling Capacity" [29]
"Ethernet Switch Port" [30]
"Logical Disk" [31]
"Storage Volume" [32]
"Ethernet Connection" [33]
"DMTF reserved" [..]
"Vendor Reserved" [0x8000..0xFFFF] |
|
ModelCorrespondence
|
CIM_ResourcePool.OtherResourceType, CIM_ResourcePool.ResourceSubType |
|
| OtherResourceType |
string |
CIM_ResourcePool |
|
Description
|
A string that describes the resource type when a well defined value is not available and ResourceType is set to 0 for Other. |
|
ModelCorrespondence
|
CIM_ResourcePool.ResourceType |
|
| ResourceSubType |
string |
CIM_ResourcePool |
|
Description
|
A string describing an implementation specific sub-type for this pool. For example, this may be used to distinguish different models of the same resource type. |
|
ModelCorrespondence
|
CIM_ResourcePool.ResourceType |
|
| AllocationUnits |
string |
CIM_ResourcePool |
|
Description
|
This property specifies the units of allocation used by the Reservation and Limit properties. For example, when ResourceType=Processor, AllocationUnits may be set to hertz*10^6 or percent. When ResourceType=Memory, AllocationUnits may be set to bytes*10^3. The value of this property shall be a legal value of the Programmatic Units qualifier as defined in Appendix C.1 of DSP0004 V2.4 or later. |
|
IsPUnit
|
TRUE |
|
| ConsumedResourceUnits |
string |
CIM_ResourcePool |
|
Description
|
This property specifies the units for the MaxConsumable and the Consumed properties. |
|
ModelCorrespondence
|
CIM_ResourcePool.MaxConsumableResource, CIM_ResourcePool.CurrentlyConsumedResource |
|
IsPUnit
|
TRUE |
|
| CurrentlyConsumedResource |
uint64 |
CIM_ResourcePool |
|
Description
|
This property specifies the amount of resource that the resource pool currently presents to consumers.
This property is different from the Reserved property in that it describes the consumers view of the resource while the Reserved property describes the producers view of the resource. |
|
ModelCorrespondence
|
CIM_ResourcePool.ConsumedResourceUnits |
|
| MaxConsumableResource |
uint64 |
CIM_ResourcePool |
|
Description
|
This property specifies the maximum of amount of consumable resource that the resource pool can present to consumers.
This property is different from the Capacity property in that it describes the consumers view of the resource while the Capacity property describes the producers view of the resource. |
|
ModelCorrespondence
|
CIM_ResourcePool.ConsumedResourceUnits |
|