Class CIM_Sensor
extends CIM_LogicalDevice

A Sensor is an entity capable of measuring or reporting the characteristics of some physical property - for example, the temperature or voltage characteristics of a Computer System.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_AllocatedLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_Sensor

Direct Known Subclasses

CIM_BinarySensor
CIM_DiscreteSensor
CIM_MultiStateSensor
CIM_NumericSensor

Class Qualifiers

NameData TypeValue
DescriptionstringA Sensor is an entity capable of measuring or reporting the characteristics of some physical property - for example, the temperature or voltage characteristics of a Computer System.
UMLPackagePathstringCIM::Device::Sensors
Versionstring2.32.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CurrentStatestring
DescriptionstringThe current state indicated by the Sensor. This is always one of the "PossibleStates".
MaxLenuint32128
OtherSensorTypeDescriptionstring
DescriptionstringA string describing the Sensor type - used when the SensorType property is set to "Other".
MaxLenuint32128
ModelCorrespondencestringCIM_Sensor.SensorType
PollingIntervaluint64
DescriptionstringThe polling interval that the Sensor hardware or the instrumentation uses to determine the current state of the Sensor.
PUnitstringsecond * 10^-9
UnitsstringNanoSeconds
SensorContextstring
DescriptionstringSensorContext indicates the purpose and context of the sensor. For example, the property may indicate what entity is being monitored or where the sensor is installed. Contextual and location information should be provided using associations to existing model elements. This property may be used if additional differentiation is necessary beyond that which is possible to convey using associations or values of SensorType. The value shall be formatted using the following algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> shall include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the SensorContext or that is a registered ID assigned to the business entity by a recognized global authority. In addition, to ensure uniqueness, <OrgID> shall not contain a colon (:). <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements.
SensorTypeuint16
DescriptionstringThe 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.
ModelCorrespondencestringCIM_Sensor.OtherSensorTypeDescription
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 32768..65535
ValuesstringUnknown, Other, Temperature, Voltage, Current, Tachometer, Counter, Switch, Lock, Humidity, Smoke Detection, Presence, Air Flow, Power Consumption, Power Production, Pressure, Intrusion, DMTF Reserved, Vendor Reserved
PossibleStatesstring[]
DescriptionstringPossibleStates 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.
MaxLenuint32128

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_LogicalDevice
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice