Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
EnabledState
4 = Shutting Down - Indicates that the element is in the process of going to a Disabled state.
5 = Not Applicable - Indicates the element does not support being enabled or disabled.
6 = Enabled but Offline - Indicates that the element may be completing commands, and will drop any new requests.
7 = In Test - Indicates that the element is in a test state.
8 = Deferred - Indicates that the element may be completing commands, but will queue any new requests.
9 = Quiesce - Indicates that the element is enabled but in a restricted mode.
10 = Starting - Indicates that the element is in the process of going to an Enabled state. New requests are queued.
11..32767 = DMTF Reserved
32768..65535 = Vendor Reserved
For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled.
HealthState
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents.
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
Possible values are:
0 = Unknown - The implementation cannot report on HealthState at this time.
5 = OK - The element is fully functional and is operating within normal operational parameters and without error.
10 = Degraded/Warning - 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 may not be operating at optimal
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
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
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
18 = Power Mode
.. = 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.
PossibleStates
PossibleStates enumerates the string outputs of the Sensor. For example, a "Switch" Sensor may output the states "On", or "Off". Another implementation of the Switch may output the states "Open", and "Close". Another
example is a NumericSensor supporting thresholds. This Sensor can report the states like "Normal", "Upper Fatal", "Lower Non-Critical", etc. A NumericSensor that does not publish readings and thresholds, but stores this
data internally, can still report its states.
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
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
11 = Reset
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). 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"
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