Sensor

Sensor class

Represents a hardware device that measures the characteristics of a physical property, such as the temperature or voltage of a computer system. The SensorType property distinguishes between types of sensors. Each Sensor instance is a node that contains NumericSensor instances. For example, all of the voltage sensors represented by NumericSensor may be grouped under a Sensor instance for voltages.

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

Syntax

[Dynamic, Provider("IPMIPrv"), UUID("{61da4c13-cdca-44d5-ba39-dc4c73e5e049}"), AMENDMENT]
class Sensor : CIM_Sensor
{
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  string   Name;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[];
  uint64   MaxQuiesceTime;
  uint16   SensorType;
  string   OtherSensorTypeDescription;
  string   PossibleStates[];
  string   CurrentState;
  uint64   PollingInterval;
};

Members

The Sensor class has these types of members:

Methods

The Sensor class has these methods.

MethodDescription
EnableDevice

This method is deprecated. Instead, use the RequestStateChange method.

Requests that the logical device be enabled.

This method is inherited from CIM_LogicalDevice.

OnlineDevice

This method is deprecated. Instead, use the RequestStateChange method.

Requests that the logical device be brought online.

This method is inherited from CIM_LogicalDevice.

QuiesceDevice

This method is deprecated. Instead, use the RequestStateChange method.

Requests that the logical device cleanly cease all current activity.

This method is inherited from CIM_LogicalDevice.

RequestStateChange

Requests that the state of the element be changed to the specified value.

This method is inherited from CIM_EnabledLogicalElement.

Reset

Requests a reset of the LogicalDevice.

This method is inherited from CIM_LogicalDevice.

RestoreProperties

This method is deprecated. Instead, use the ConfigurationData subclass of SettingData.

Requests that the logical device re-establish its configuration, setup and/or state information from a backing store.

This method is inherited from CIM_LogicalDevice.

SaveProperties

This method is deprecated. Instead, use the ConfigurationData subclass of SettingData.

Requests that the logical device capture its current configuration, setup and/or state information in a backing store.

This method is inherited from CIM_LogicalDevice.

SetPowerState

Sets the power state of the Device. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated Power Management Service class.

This method is inherited from CIM_LogicalDevice.

 

Properties

The Sensor class has these properties.

AdditionalAvailability
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

Additional information beyond that specified in the Availability property.

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.

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)

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description of the object.

This property is inherited from CIM_ManagedElement.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

The name of the class 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.

CurrentState
Data type: string
Access type: Read-only
Qualifiers: MaxLen (128)

The current state reported 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

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 unique to the logical device.

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.

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Read/write

An administrator's default or startup configuration for the EnabledState of an element. By default, the element is Enabled (2).

This method 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 (4) and starting (10) are transient states between enabled and disabled.

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 (2) state, 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 (2) state. New requests are queued.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

This property is inherited from CIM_EnabledLogicalElement.

ErrorCleared
Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

Whether the error reported in LastErrorCode is now cleared.

This property is inherited from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

More information about the error in LastErrorCode, and 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.

Unknown (0)

The implementation can not report on HealthState at this time.

OK (5)

The element is fully functional and is operating within normal operational parameters and without error.

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.

Minor failure (15)

All functionality is available but some may be degraded.

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.

Critical failure (25)

The element is non-functional and recovery may not be possible.

Non-recoverable error (30)

The element has completed failed and recovery is not possible. All functionality provided by this element has been lost.

DMTF Reserved

This property is inherited from CIM_ManagedSystemElement.

IdentifyingDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

Explanations and details about 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.

LastErrorCode
Data type: uint32
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

The last error code reported by the logical device.

This property is inherited from CIM_LogicalDevice.

MaxQuiesceTime
Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

Deprecated. The 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. What occurs at the end of the time limit is device-specific. A value of 0 indicates that a Device can remain quiesced indefinitely.

This property is inherited from CIM_LogicalDevice.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

The label by which the object is known. In subclasses the Name property can be overridden to be a Key property.

This property is inherited from CIM_ManagedSystemElement.

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Indicates the current status of the element. Various operational statuses are defined. Many of the enumeration's values are self- explanatory.

OperationalStatus replaces the Status property 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. 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 should also provide the primary status of the element since it is single-valued.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

The element is functioning, but needs attention. Examples of Stressed states are overload and overheated.

Predictive Failure (5)

The element is functioning nominally but predicting a failure in the near future.

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

Implies a clean and orderly stop

In Service (11)

The element is being configured, maintained, cleaned, or otherwise administered.

No Contact (12)

The monitoring system has knowledge of this element, but has never been able to establish communications with it.

Lost Communication (13)

The element is known to exist and has been contacted successfully in the past, but is currently unreachable.

Aborted (14)

Implies an abrupt stop where the element's state and configuration may need to be updated.

Dormant (15)

The element is inactive or quiesced.

Supporting Entity in Error (16)

This element may be OK but 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 (17)

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 succeeded or not. Completed with Degraded would imply the operation finished, but did not complete OK or report an error.

Power Mode (18)

The element has additional power model information contained in the Associated PowerManagementService association.

DMTF Reserved

Vendor Reserved

This property is inherited from CIM_ManagedSystemElement.

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 Other (1). 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")

Additional data, beyond the DeviceID property, that could be used to identify a logical device.

This property is inherited from CIM_LogicalDevice.

OtherSensorTypeDescription
Data type: string
Access type: Read-only
Qualifiers: MaxLen (128), ModelCorrespondence ("CIM_Sensor.SensorType")

When the SensorType property is set to Other, describes the sensor type.

This property is inherited from CIM_Sensor.

PollingInterval
Data type: uint64
Access type: Read-only
Qualifiers: Units ("NanoSeconds")

The interval that the sensor hardware or the instrumentation is polled 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)

An array of strings naming the possible states reported by the sensor.

This property is inherited from CIM_Sensor.

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

The power management capabilities of the Device. This property is deprecated. Instead, use the PowerCapabilites property in an associated power management capabilities class.

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")

Whether the Device can be power managed. This property is deprecated. Instead, the existence of an associated power management capabilities class 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

The number of consecutive hours that this Device has been powered, since its last power cycle.

This property is inherited from CIM_LogicalDevice.

RequestedState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 No Change (5). This property is set as the result of a method invocation, such as StartService or StopService on CIM_Service.

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
SensorType
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_Sensor.OtherSensorTypeDescription")

The Type of the Sensor. If set to Other, then the OtherSensorTypeDescription property identifies the type.

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)

Status
Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

A string indicating the current status of the object. This property is deprecated in favor of OperationalStatus, which includes the same semantics in its enumeration.

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

"Stopped"

This property is inherited from CIM_ManagedSystemElement.

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings describing the various OperationalStatus array values.

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 state of the Logical Device. This property is deprecated. Instead, use the inherited EnabledState property.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (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

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.

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.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\hardware

MOF

IpmiPrv.mof

DLL

IpmiPrv.dll

See also

CIM_Sensor
IPMI Provider

 

 

Show:
© 2016 Microsoft