共用方式為

NumericSensor class

  • 發行項

Represents an analog type of sensor. The SensorType property differentiates between numeric sensors.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of its inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

[Dynamic, Provider("IPMIPrv"), UUID("{7be7579b-4370-4a75-857c-9e789d1aff8a}"), AMENDMENT]
class NumericSensor : CIM_NumericSensor
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  uint16   SensorType;
  string   OtherSensorTypeDescription;
  string   PossibleStates[];
  string   CurrentState;
  uint64   PollingInterval;
  uint16   BaseUnits;
  sint32   UnitModifier;
  uint16   RateUnits;
  sint32   CurrentReading;
  sint32   NominalReading;
  sint32   NormalMax;
  sint32   NormalMin;
  uint32   Resolution;
  sint32   Tolerance;
  sint32   Accuracy;
  boolean  IsLinear;
  uint32   Hysteresis;
  sint32   LowerThresholdNonCritical;
  uint16   EnabledThresholds[];
  uint16   SettableThresholds[];
  uint16   EnabledState = 5;
  datetime TimeOfLastStateChange;
  boolean  ErrorCleared;
  sint32   LowerThresholdCritical;
  sint32   LowerThresholdFatal;
  sint32   MaxReadable;
  sint32   MinReadable;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  string   SupportedThresholds[];
  sint32   UpperThresholdCritical;
  sint32   UpperThresholdNonCritical;
  sint32   UpperThresholdFatal;
};

Members

The NumericSensor class has these types of members:

Methods

The NumericSensor class has these methods.

Method Description
[EnableDevice](numericsensor-enabledevice.md)
[!Note]
This method is deprecated. Instead we recommend that you use the [RequestStateChange](numericsensor-requeststatechange.md) method.

Enable or disables the numeric sensor.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[GetNonLinearFactors](numericsensor-getnonlinearfactors.md)
[!Note]
This method is deprecated and should not be used.

Retrieves data collected by the numeric sensor.
This method is inherited from CIM_NumericSensor.
[OnlineDevice](numericsensor-onlinedevice.md)
[!Note]
This method is deprecated. Instead we recommend that you use the [RequestStateChange](numericsensor-requeststatechange.md) method.

Brings the numeric sensor online so it can accept requests, or offline so it can no longer accept requests.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[QuiesceDevice](numericsensor-quiescedevice.md)
[!Note]
This method is deprecated. Instead we recommend that you use the [RequestStateChange](numericsensor-requeststatechange.md) method.

Temporarily suspends activity on the numeric sensor, or re-enables the activity.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[RequestStateChange](numericsensor-requeststatechange.md) Initiates a requests to change the state of the numeric sensor.
This method is inherited from [CIM_EnabledLogicalElement](cim-enabledlogicalelement.md).
[Reset](numericsensor-reset.md) Resets the numeric sensor.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[RestoreDefaultThresholds](numericsensor-restoredefaultthresholds.md) Resets the values of numeric sensor thresholds to the hardware default values.
This method is inherited from CIM_NumericSensor.
[RestoreProperties](numericsensor-restoreproperties.md)
[!Note]
This method is deprecated. Instead we recommend that you use the ApplyConfiguration property of the CIM_ConfigurationData class.

Restores a previous configuration and state of the numeric sensor.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[SaveProperties](numericsensor-saveproperties.md)
[!Note]
This method is deprecated. Instead we recommend that you use the ConfigurationInformation property of the CIM_ConfigurationData class.

Saves the configuration and state of the numeric sensor.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).
[SetPowerState](numericsensor-setpowerstate.md)
[!Note]
This method is deprecated. Instead we recommend that you use the SetPowerState property of the CIM_PowerManagementService class.

Sets the power state of the numeric sensor.
This method is inherited from [CIM_LogicalDevice](cim-logicaldevice.md).

Properties

The NumericSensor class has these properties.

Accuracy

Data type: sint32

Access type: Read-only

Qualifiers: Units ("Hundredths of Percent"), MappingStrings ("MIF.DMTF|Temperature Probe|002.19", "MIF.DMTF|Electrical Current Probe|001.19", "MIF.DMTF|Voltage Probe|001.19")

Indicates the accuracy of the Sensor for the measured property. Its value is recorded as plus/minus hundredths of a percent. Accuracy, along with Resolution, is used to calculate the actual value of the measured physical property. Accuracy may vary depending on whether the Device is linear over its dynamic range.

This property is inherited from CIM_NumericSensor.

AdditionalAvailability

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device's primary Availability may be "Off line" (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, "In Test").

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

Availability

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

The primary availability and status of the Device. (Additional status information can be specified using the AdditionalAvailability array property.) For example, the Availability property indicates that the Device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the Power Save states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the Device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the Device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the Device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the Device is in a warning state, though also in a power save mode.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

Power Save - Low Power Mode (14)

Power Save - Standby (15)

Power Cycle (16)

Power Save - Warning (17)

Paused (18)

Not Ready (19)

Not Configured (20)

Quiesced (21)

BaseUnits

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_NumericSensor.UnitModifier", "CIM_NumericSensor.RateUnits")

The base unit of the values returned by this Sensor. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). For example, if BaseUnits is Volts and the UnitModifier is -6, then the units of the values returned are MicroVolts. However, 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.

This property is inherited from CIM_NumericSensor.

Unknown (0)

Other (1)

Degrees C (2)

Degrees F (3)

Degrees K (4)

Volts (5)

Amps (6)

Watts (7)

Joules (8)

Coulombs (9)

VA (10)

Nits (11)

Lumens (12)

Lux (13)

Candelas (14)

kPa (15)

PSI (16)

Newtons (17)

CFM (18)

RPM (19)

Hertz (20)

Seconds (21)

Minutes (22)

Hours (23)

Days (24)

Weeks (25)

Mils (26)

Inches (27)

Feet (28)

Cubic Inches (29)

Cubic Feet (30)

Meters (31)

Cubic Centimeters (32)

Cubic Meters (33)

Liters (34)

Fluid Ounces (35)

Radians (36)

Steradians (37)

Revolutions (38)

Cycles (39)

Gravities (40)

Ounces (41)

Pounds (42)

Foot-Pounds (43)

Ounce-Inches (44)

Gauss (45)

Gilberts (46)

Henries (47)

Farads (48)

Ohms (49)

Siemens (50)

Moles (51)

Becquerels (52)

PPM (parts/million) (53)

Decibels (54)

DbA (55)

DbC (56)

Grays (57)

Sieverts (58)

Color Temperature Degrees K (59)

Bits (60)

Bytes (61)

Words (data) (62)

DoubleWords (63)

QuadWords (64)

Percentage (65)

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.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

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.

This property is inherited from CIM_LogicalDevice.

CurrentReading

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.5", "MIF.DMTF|Electrical Current Probe|001.5", "MIF.DMTF|Voltage Probe|001.5")

The current value indicated by the Sensor.

This property is inherited from CIM_NumericSensor.

CurrentState

Data type: string

Access type: Read-only

Qualifiers: MaxLen (128)

The current state indicated by the Sensor. This is always one of the "PossibleStates".

This property is inherited from CIM_Sensor.

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.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (64)

An address or other identifying information to uniquely name the LogicalDevice.

This property is inherited from CIM_LogicalDevice.

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.

Note that ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties.

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)

DMTF Reserved

8 32767

Vendor Reserved

32768 65535

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

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.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Other (1)

Enabled (2)

The element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled (3)

The element will not execute commands and will drop any new requests.

Shutting Down (4)

The element is in the process of going to a Disabled state.

Not Applicable (5)

The element does not support being enabled or disabled.

Enabled but Offline (6)

The element might be completing commands, and will drop any new requests.

In Test (7)

The element is in a test state.

Deferred (8)

The element might be completing commands, but will queue any new requests.

Quiesce (9)

The element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state (2), but it processes only a restricted set of commands. All other requests are queued.

Starting (10)

The element is in the process of going to an Enabled state (2). New requests are queued.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

EnabledThresholds

Data type: uint16 array

Access type: Read-only

An array representing the thresholds that are currently enabled for this Sensor.

This property is inherited from CIM_NumericSensor.

LowerThresholdNonCritical (0)

UpperThresholdNonCritical (1)

LowerThresholdCritical (2)

UpperThresholdCritical (3)

LowerThresholdFatal (4)

UpperThresholdFatal (5)

ErrorCleared

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

Note

This property is deprecated. Instead we recommend that you use the OperationalStatus property from the CIM_ManagedSystemElement class.

Indicates whether an error reported by the LastErrorCode property is cleared. This property is inherited from CIM_LogicalDevice.

This property is inherited from CIM_NumericSensor .

ErrorDescription

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken.

This property is inherited from CIM_LogicalDevice.

HealthState

Data type: uint16

Access type: Read-only

Qualifiers: Experimental

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 completed 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 MAY NOT be possible.

"Major Failure" (20) - The element is failing. It is possible the some or all of the functionality of this component is degraded or not working.

"Minor Failure" (15) - All functionality is available but some MAY 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 may not be operating at optimal performance or it may 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 can not report on HealthState at this time.

DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.

This property is inherited from CIM_ManagedSystemElement.

Unknown (0)

OK (5)

Degraded/Warning (10)

Minor failure (15)

Major failure (20)

Critical failure (25)

Non-recoverable error (30)

DMTF Reserved

31 65535

Hysteresis

Data type: uint32

Access type: Read-only

Indicates the margin built around the thresholds. This margin prevents unnecessary state changes when the Sensor reading may fluctuate very close to its thresholds. This could be due to the Sensor's tolerance/accuracy/resolution or due to environmental factors. Once a threshold is crossed, the state of the Sensor should change. However, the state should not fluctuate between the old and new states unless the Sensor's change in the reading exceeds the Hysteresis value. The units for this measurement are determined by BaseUnit*UnitModifier/RateUnit.

This property is inherited from CIM_NumericSensor.

IdentifyingDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.

This property is inherited from CIM_LogicalDevice.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

IsLinear

Data type: boolean

Access type: Read-only

Indicates that the Sensor is linear over its dynamic range.

This property is inherited from CIM_NumericSensor.

LastErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

LastErrorCode captures the last error code reported by the LogicalDevice.

This property is inherited from CIM_LogicalDevice.

LowerThresholdCritical

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.13", "MIF.DMTF|Electrical Current Probe|001.13", "MIF.DMTF|Voltage Probe|001.13")

A value that specifies a range that determines whether the sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If CurrentReading is between LowerThresholdCritical and LowerThresholdFatal, then the current state is noncritical. This property is inherited from CIM_NumericSensor.

Example: 500

This property is inherited from CIM_NumericSensor .

LowerThresholdFatal

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.15", "MIF.DMTF|Electrical Current Probe|001.15", "MIF.DMTF|Voltage Probe|001.15")

A value that specifies a range that determines whether the sensor is operating under Normal, NonCritical, Critical, or Fatal conditions. If CurrentReading is below LowerThresholdFatal, then the current state is fatal. This property is inherited from CIM_NumericSensor.

Example: -1279

This property is inherited from CIM_NumericSensor .

LowerThresholdNonCritical

Data type: sint32

Access type: Read/write

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.11", "MIF.DMTF|Electrical Current Probe|001.11", "MIF.DMTF|Voltage Probe|001.11")

The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If CurrentReading is between LowerThresholdNonCritical and UpperThresholdNonCritical, then the Sensor is reporting a normal value. If CurrentReading is between LowerThresholdNonCritical and LowerThresholdCritical, then the CurrentState is NonCritical.

This property is inherited from CIM_NumericSensor.

MaxQuiesceTime

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later.

Maximum time in milliseconds, that a Device can run in a "Quiesced" state. A Device's state is defined in its Availability and AdditionalAvailability properties, where "Quiesced" is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely.

This property is inherited from CIM_LogicalDevice.

MaxReadable

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.9", "MIF.DMTF|Electrical Current Probe|001.9", "MIF.DMTF|Voltage Probe|001.9")

The largest value of the measure property that can be read by the numeric sensor. This property is inherited from CIM_NumericSensor.

Example: 1270

This property is inherited from CIM_NumericSensor .

MinReadable

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.10", "MIF.DMTF|Electrical Current Probe|001.10", "MIF.DMTF|Voltage Probe|001.10")

The smallest value of the measured property that can be read by the numeric sensor. This property is inherited from CIM_NumericSensor.

Example: -1279

This property is inherited from CIM_NumericSensor .

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (1024)

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.

This property is inherited from CIM_ManagedSystemElement.

NominalReading

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.6", "MIF.DMTF|Electrical Current Probe|001.6", "MIF.DMTF|Voltage Probe|001.6")

NominalReading indicates the 'normal' or expected value for the NumericSensor.

This property is inherited from CIM_NumericSensor.

NormalMax

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.7", "MIF.DMTF|Electrical Current Probe|001.7", "MIF.DMTF|Voltage Probe|001.7")

NormalMax provides guidance for the user as to the normal maximum range for the NumericSensor.

This property is inherited from CIM_NumericSensor.

NormalMin

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.8", "MIF.DMTF|Electrical Current Probe|001.8", "MIF.DMTF|Voltage Probe|001.8")

NormalMin provides guidance for the user as to the normal minimum range for the NumericSensor.

This property is inherited from CIM_NumericSensor.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Indicates the current status(es) 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 in more detail.

"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.

"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 ManagedSystemElement 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 element's state and configuration may need to be updated.

"Dormant" indicates that the element is inactive or quiesced.

"Supporting Entity in Error" describes 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.

"Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.

"Power Mode" indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since 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)

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

19 32767

Vendor Reserved

32768 65535

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: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

Information that identifies the numeric sensor, other than a DeviceID. This property is inherited from CIM_LogicalDevice.

This property is inherited from CIM_NumericSensor .

OtherSensorTypeDescription

Data type: string

Access type: Read-only

Qualifiers: MaxLen (128), ModelCorrespondence ("CIM_Sensor.SensorType")

A string describing the Sensor type - used when the SensorType property is set to "Other".

This property is inherited from CIM_Sensor.

PollingInterval

Data type: uint64

Access type: Read-only

Qualifiers: Units ("NanoSeconds")

The polling interval that the Sensor hardware or the instrumentation uses to determine the current state of the Sensor.

This property is inherited from CIM_Sensor.

PossibleStates

Data type: string array

Access type: Read-only

Qualifiers: MaxLen (128)

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.

This property is inherited from CIM_Sensor.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

An enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

Not Supported (1)

Disabled (2)

Enabled (3)

Power Saving Modes Entered Automatically (4)

Power State Settable (5)

Power Cycling Supported (6)

Timed Power On Supported (7)

PowerManagementSupported

Data type: boolean

Access type: Read-only

Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

Boolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationship) indicates that power management is supported.

This property is inherited from CIM_LogicalDevice.

PowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

Note

This property is deprecated. Instead we recommend that you use the PowerOnHours property from theCIM_PoweredStatisticalData class.

The number of consecutive hours that the numeric sensor has been powered, since its last power cycle. This property is inherited from CIM_LogicalDevice.

This property is inherited from CIM_NumericSensor .

RateUnits

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_NumericSensor.UnitModifier", "CIM_NumericSensor.BaseUnits")

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 (0). For example, if BaseUnits is Volts (5) 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 (0), then the units are further qualified as rate units. In the above example, if RateUnits is set to Per Second (3), 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.

This property is inherited from CIM_NumericSensor.

None (0)

Per MicroSecond (1)

Per MilliSecond (2)

Per Second (3)

Per Minute (4)

Per Hour (5)

Per Day (6)

Per Week (7)

Per Month (8)

Per Year (9)

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. 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. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. 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 StartService 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. A particular instance of CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

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

13 32767

Vendor Reserved

32768 65535

Resolution

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.17", "MIF.DMTF|Electrical Current Probe|001.17", "MIF.DMTF|Voltage Probe|001.17")

Resolution indicates the ability of the Sensor to resolve differences in the measured property. The units for this measurement are determined by BaseUnit*UnitModifier/RateUnit.

This property is inherited from CIM_NumericSensor.

SensorType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Sensor.OtherSensorTypeDescription")

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.

This property is inherited from CIM_Sensor.

Unknown (0)

Other (1)

Temperature (2)

Voltage (3)

Current (4)

Tachometer (5)

Counter (6)

Switch (7)

Lock (8)

Humidity (9)

Smoke Detection (10)

Presence (11)

Air Flow (12)

SettableThresholds

Data type: uint16 array

Access type: Read-only

An array representing the writable thresholds supported by Sensor.

This property is inherited from CIM_NumericSensor.

LowerThresholdNonCritical (0)

UpperThresholdNonCritical (1)

LowerThresholdCritical (2)

UpperThresholdCritical (3)

LowerThresholdFatal (4)

UpperThresholdFatal (5)

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: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via 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. And, 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.

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.

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

The StatusInfo property indicates whether the Logical Device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the LogicalDevice, the value, 5 ("Not Applicable"), should be used. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement.

If a Device is ("Enabled")(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ("Disabled") StatusInfo value=4), a Device can only be "enabled" or powered off. In a personal computer environment, ("Disabled") means that the Device's driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other "enabling" activity has occurred.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SupportedThresholds

Data type: string array

Access type: Read-only

An array that contains the thresholds supported by the numeric sensor. For more information, see SettableThresholds and EnabledThresholds. This property is inherited from CIM_NumericSensor.

This property is inherited from CIM_NumericSensor .

This property can contain the following values.

LowerThresholdNonCritical ("0")

UpperThresholdNonCritical ("1")

LowerThresholdCritical ("2")

UpperThresholdCritical ("3")

LowerThresholdFatal ("4")

UpperThresholdFatal ("5")

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping System's CreationClassName.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The scoping System's Name.

This property is inherited from CIM_LogicalDevice.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The date or time when the enabled state 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.

Tolerance

Data type: sint32

Access type: Read-only

Qualifiers: Deprecated ("CIM_NumericSensor.Resolution", "CIM_NumericSensor.Accuracy")

This property is being deprecated in lieu of using the Resolution and Accuracy properties.

Indicates the tolerance of the Sensor for the measured property. Tolerance, along with Resolution and Accuracy, is used to calculate the actual value of the measured physical property. Tolerance may vary depending on whether the Device is linear over its dynamic range.

This property is inherited from CIM_NumericSensor.

TotalPowerOnHours

Data type: uint64

Access type: Read-only

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

The total number of hours that this Device has been powered.

This property is inherited from CIM_LogicalDevice.

UnitModifier

Data type: sint32

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_NumericSensor.BaseUnits", "CIM_NumericSensor.RateUnits")

The unit multiplier for the values returned by this Sensor. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). For example, if BaseUnits is Volts (5) and the UnitModifier is -6, then the units of the values returned are MicroVolts. However, 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 (3), 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.

This property is inherited from CIM_NumericSensor.

UpperThresholdCritical

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.14", "MIF.DMTF|Electrical Current Probe|001.14", "MIF.DMTF|Voltage Probe|001.14")

A value that specifies a range that determines whether the sensor is operating under Normal, NonCritical, Critical, or Fatal conditions. If CurrentReading is between UpperThresholdCritical and UpperThresholdFatal, then the current state is critical. This property is inherited from CIM_NumericSensor.

Example: 550

This property is inherited from CIM_NumericSensor .

UpperThresholdFatal

Data type: sint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.16", "MIF.DMTF|Electrical Current Probe|001.16", "MIF.DMTF|Voltage Probe|001.16")

A value that specifies a range that determines whether the sensor is operating under Normal, NonCritical, Critical, or Fatal conditions. If CurrentReading is above UpperThresholdFatal, then the current state is fatal. This property is inherited from CIM_NumericSensor.

Example: 1270

This property is inherited from CIM_NumericSensor .

UpperThresholdNonCritical

Data type: sint32

Access type: Read/write

Qualifiers: MappingStrings ("MIF.DMTF|Temperature Probe|002.12", "MIF.DMTF|Electrical Current Probe|001.12", "MIF.DMTF|Voltage Probe|001.12")

A value that specifies a range that determines whether the sensor is operating under Normal, NonCritical, Critical, or Fatal conditions. If CurrentReading is between UpperThresholdNonCritical and UpperThresholdCritical, then the current state is noncritical. This property is inherited from CIM_NumericSensor.

Example: 500

This property is inherited from CIM_NumericSensor .

Remarks

All values returned by the numeric sensor are represented in the units obtained by the BaseUnits property, multiplied by 10, raised to the power of the UnitModifier property. For example, if BaseUnits is volts and UnitModifier is -6, then the units of the values returned are microvolts. However, 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.

Requirements
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\Hardware
MOF
IpmiPrv.mof
DLL
IpmiPrv.dll

See also

CIM_NumericSensor

IPMI Provider