Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
performance or it may be reporting recoverable errors.
15 = Minor failure - All functionality is available but some may be degraded.
20 = Major failure - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working.
25 = Critical failure - The element is non-functional and recovery may not be possible.
30 = Non-recoverable error - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
.. = DMTF Reserved
IdentifyingDescriptions
An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note that each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the
same index.
Name 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.
OperationalStatus
Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory.
Possible values are:
0 = Unknown
1 = Other
2 = OK
3 = Degraded -
4 = Stressed - Indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.
5 = Predictive Failure - Indicates that an element is functioning nominally but predicting a failure in the near future.
6 = Error
7 = Non-Recoverable Error
8 = Starting
9 = Stopping
10 = Stopped - Implies a clean and orderly stop
11 = In Service - Describes an element being configured, maintained, cleaned, or otherwise administered.
12 = No Contact - Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
13 = Lost Communication - Indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.
14 = Aborted - Implies an abrupt stop where the state and configuration of the element may need to be updated.
15 = Dormant - Indicates that the element is inactive or quiesced.
16 = Supporting Entity in Error - Indicates that this element may 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.
17 = 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).
18 = Power Mode - Indicates that the element has additional power model information contained in the Associated PowerManagementService association.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
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.
OtherIdentifyingInfo
OtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system's user-friendly name for the
Device.
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.
Possible values are:
0 = Unknown - Indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
1 = OK - Indicates the ManagedElement is functioning normally.
2 = Degraded - Indicates the ManagedElement is functioning below normal.
3 = Error - Indicates the ManagedElement is in an Error condition.
.. = DMTF Reserved
0x8000.. = Vendor Reserved
RemainingCapacityMaxError The maximum error (as a percentage) in the mWatt-hour data reported by RemainingCapacity property.
RequestedState
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.
Possible values are:
0 = Unknown - Indicates the last requested state for the element is unknown.
2 = Enabled
3 = Disabled
4 = Shut Down
5 = No Change
6 = Offline - Indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
7 = Test
8 = Deferred
9 = Quiesce
10 = Reboot - Refers to doing a "Shut Down" and then moving to an "Enabled" state.
11 = Reset - Indicates that the element is first "Disabled" and then "Enabled".
12 = Not Applicable
.. = DMTF Reserved
32768..65535 = Vendor Reserved
Note: 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.
Note: The value "No Change" (5) has been deprecated instead 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).
There are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11).
Shut Down requests an orderly transition to the Disabled state, and may 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 is NULL or has the value 12 "Not Applicable".
SmartBatteryVersion The Smart Battery Data Specification version number that is supported by this Battery. If the Battery does not support this function, the value should be left blank.
A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated instead of OperationalStatus, which includes the same semantics in its
enumeration. This change is made for three 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 may 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