Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
OperationalStatus
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 - Iindicates 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.
PossibleStates
Enumerates the string outputs of the Sensor.
Example 1 - A "Switch" Sensor may output the states "On", or "Off". Another implementation of the Switch may output the states "Open", and "Close".
Example 2 - 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.
RateUnits
Specifies if the units returned by this Sensor are rate units. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). This is true unless this
property (RateUnits) has a value different than "None". For example, if BaseUnits is Volts and the UnitModifier is -6, then the units of the values returned are MicroVolts. But, if the RateUnits property is set to a value other
than "None", then the units are further qualified as rate units. In the above example, if RateUnits is set to "Per Second", then the values returned by the Sensor are in MicroVolts/Second. The units apply to all numeric
properties of the Sensor, unless explicitly overridden by the Units qualifier. Any implementation of CurrentReading should be qualified with either a Counter or a Gauge qualifier, depending on the characteristics of the
sensor being modeled.
Possible values are:
0 = None
1 = Per MicroSecond
2 = Per MilliSecond
3 = Per Second
4 = Per Minute
5 = Per Hour
6 = Per Day
7 = Per Week
8 = Per Month
9 = Per Year
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. 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.
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). Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState.
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".
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
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
The Type of the Sensor, e.g. Voltage or Temperature Sensor. If the type is set to "Other", then the OtherSensorType Description can be used to further identify the type, or if the Sensor has numeric readings, then the
type of the Sensor can be implicitly determined by the Units. A description of the different Sensor types is as follows: A Temperature Sensor measures the environmental temperature. Voltage and Current Sensors measure
electrical voltage and current readings. A Tachometer measures speed/revolutions of a Device. For example, a Fan Device can have an associated Tachometer which measures its speed. A Counter is a general purpose
Sensor that measures some numerical property of a Device. A Counter value can be cleared, but it never decreases. A Switch Sensor has states like Open/Close, On/Off, or Up/Down. A Lock has states of Locked/Unlocked.
Humidity, Smoke Detection and Air Flow Sensors measure the equivalent environmental characteristics. A Presence Sensor detects the presence of a PhysicalElement. A Power Consumption Sensor measures the
instantaneous power consumed by a managed element. A Power Production Sensor measures the instantaneous power produced by a managed element such as a power supply or a voltage regulator. A pressure sensor is
used to report pressure. Intrusion sensor reports an intrusion of an enclosure regardless whether it was authorized or not.
Possible values are:
0 = Unknown
1 = Other
2 = Temperature