SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_Sensor

Used in features: Hardware Asset , Event Manager & User Notification
Compatible with the following Intel AMT Releases: 3.0, 3.2, 4.0, 5.0, 5.1, 6.0, 6.1, 6.2, 7.0, 8.0, 8.1, 9.0, 9.5, 10.0, 11.0 
CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_EnabledLogicalElement
            extended by CIM_LogicalDevice
               extended by CIM_Sensor


class CIM_Sensor
 extends CIM_LogicalDevice


General Information:
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.

Product 
Specific Usage:
Information is gathered from the ASF tables. 
This 
belongs in Hardware Asset and Event Manager 
groups.

Qualifiers:
-------------
Version=2.32.0
UMLPackagePath=CIM::Device::Sensors









  
  

    Supported Fields 
      Summary

  

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

  

     string 
      
    CreationClassName Key  
CreationClassName indicates the name 
      of the class or the subclass used in the creation of an instance . . 
    .

  

     string 
      
    SystemName Key  
The scoping System's Name.

  

     string 
      
    SystemCreationClassName Key  
The scoping System's 
      CreationClassName.

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     uint16[2] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

     uint16 
      
    HealthState 
      
Indicates the current health of the element . . .

  

     uint16 
      
    EnabledState 
      
EnabledState is an integer enumeration that indicates the 
      enabled and disabled states of an element . . .

  

     uint16 
      
    RequestedState 
      
RequestedState is an integer enumeration that indicates the 
      last requested or desired state for the element, irrespective of the 
      mechanism through which it was requested . . .

  

     uint16 
      
    SensorType 
The Type 
      of the Sensor, e.g . . .

  

     string[3] 
      
    PossibleStates 
      
PossibleStates enumerates the string outputs of the Sensor . . 
      .

  

     string 
      
    CurrentState 
The 
      current state indicated by the Sensor . . 
.




  
  

    Methods Summary

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context




  
  

    Field 
Detail


DeviceID Key 
public string DeviceID



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

Product Specific 
  Usage:
"Sensor N", where N is the index of the ASF_ALERTDATA structure 
  in the ASF_ALRT 
  table

Qualifiers:
-------------
Key
MaxLen=64


  

  





CreationClassName Key 
public string CreationClassName



  
General Information:
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.

Qualifiers:
-------------
Key
MaxLen=11


  

  





SystemName Key 
public string SystemName



  
General Information:
The scoping System's 
  Name.

Qualifiers:
-------------
Key
MaxLen=256
Propagated=CIM_System.Name


  

  





SystemCreationClassName Key 
public string SystemCreationClassName



  
General Information:
The scoping System's 
  CreationClassName.

Qualifiers:
-------------
Key
MaxLen=19
Propagated=CIM_System.CreationClassName


  

  





ElementName 
public string ElementName



  
General Information:
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 
  the Name property of ManagedSystemElement 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 can be present in both the Name and 
  ElementName properties. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





OperationalStatus 
public uint16[2] OperationalStatus



  
General Information:
Indicates the current statuses 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 here in 
  more detail. 
"Stressed" indicates that the element is functioning, but 
  needs attention. Examples of "Stressed" states are overload, overheated, and 
  so on. 
"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 ManagedSystem Element 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 state and configuration of the element might need to be 
  updated. 
"Dormant" indicates that the element is inactive or quiesced. 
  
"Supporting Entity in Error" indicates that this element might 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 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). 
"Power 
  Mode" indicates that the element has additional power model information 
  contained in the Associated PowerManagementService association. 
  
"Relocating" indicates the element is being 
  relocated.
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.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive 
  Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In 
  Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity 
  in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





HealthState 
public uint16 HealthState



  
General Information:
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 completely 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 might not be 
  possible. 
"Major Failure" (20) - The element is failing. It is possible 
  that some or all of the functionality of this component is degraded or not 
  working. 
"Minor Failure" (15) - All functionality is available but some 
  might 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 might not be operating 
  at optimal performance or it might 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 cannot report on HealthState at this time. 
DMTF has 
  reserved the unused portion of the continuum for additional HealthStates in 
  the future.

Qualifiers:
-------------
ValueMap={0, 5, 10, 
  15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning, 
  Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF 
  Reserved, Vendor Specific}


  

  





EnabledState 
public uint16 EnabledState



  
General Information:
EnabledState is an integer enumeration that 
  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. The following text briefly summarizes the various enabled and 
  disabled states: 
Enabled (2) indicates that the element is or could be 
  executing commands, will process any queued commands, and queues new requests. 
  
Disabled (3) indicates that the element will not execute commands and will 
  drop any new requests. 
Shutting Down (4) indicates that the element is in 
  the process of going to a Disabled state. 
Not Applicable (5) indicates the 
  element does not support being enabled or disabled. 
Enabled but Offline 
  (6) indicates that the element might be completing commands, and will drop any 
  new requests. 
Test (7) indicates that the element is in a test state. 
  
Deferred (8) indicates that the element might be completing commands, but 
  will queue any new requests. 
Quiesce (9) indicates that the element is 
  enabled but in a restricted mode.
Starting (10) indicates that the element 
  is in the process of going to an Enabled state. New requests are 
  queued.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 
  5, 6, 7, 8, 9, 10, 11..32767, 32768..65535}
Values={Unknown, Other, 
  Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In 
  Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.OtherEnabledState}


  

  





RequestedState 
public uint16 RequestedState



  
General Information:
RequestedState is 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. 
"Unknown" (0) indicates the 
  last requested state for the element is unknown.
Note that the value "No 
  Change" (5) has been deprecated in lieu 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. 
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 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 shall be NULL or have the value 12 "Not 
  Applicable".

Qualifiers:
-------------
ValueMap={0, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535}
Values={Unknown, Enabled, 
  Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, 
  Reset, Not Applicable, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_EnabledLogicalElement.EnabledState}


  

  





SensorType 
public uint16 SensorType



  
General Information:
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.

Product Specific Usage:
Mapped value in 
  EventSensorType field of ASF_ALERTDATA structure for sensor in ACPI "ASF!" 
  table: 
i. Tempature: ASF_ALERTDATA.EventSensorType = 01h - SensorType = 
  02h 
ii. Voltage: ASF_ALERTDATA.EventSensorType = 02h - SensorType = 03h 
  
iii. Current: ASF_ALERTDATA.EventSensorType = 03h - SensorType = 04h 
  


Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 4, 5, 
  6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 32768..65535}
Values={Unknown, 
  Other, Temperature, Voltage, Current, Tachometer, Counter, Switch, Lock, 
  Humidity, Smoke Detection, Presence, Air Flow, Power Consumption, Power 
  Production, Pressure, Intrusion, DMTF Reserved, Vendor 
  Reserved}
ModelCorrespondence={CIM_Sensor.OtherSensorTypeDescription}


  

  





PossibleStates 
public string[3] PossibleStates



  
General Information:
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.

Product Specific Usage:
f. PossibleStates 
i. When 
  SensorType = 2 (Temperature), PossibleStates = {"Bad", "Good", "Unknown" } 
  
ii. When SensorType = 3 (Voltage) , PossibleStates = { "Bad", "Good", 
  "Unknown" } 
iii. When SensorType = 4 (Current) , PossibleStates = { "Bad", 
  "Good", "Unknown"} 
  


Qualifiers:
-------------
MaxLen=128


  

  





CurrentState 
public string CurrentState



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

Qualifiers:
-------------
MaxLen=128


  

  






  
  

    Method 
Detail


Get
public  Get([OUT]CIM_Sensor Instance)



  
Permission Information:
Permitted realms: 
  ADMIN_SECURITY_HARDWARE_ASSET_REALM, 
  ADMIN_SECURITY_EVENT_MANAGER_REALM

General Information:
Gets 
  the representation of the instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.