Data Object - HostNumericSensorInfo(vim.host.NumericSensorInfo)

Property of: HostSystemHealthInfo
Extends: DynamicData
See also: ElementDescription, HostFru
Since: VI API 2.5

Data Object Description

Base class for numeric sensor information.

Properties

Name	Type	Description
baseUnits	xsd:string	The base units in which the sensor reading is specified. If rateUnits is set the units of the current reading is further qualified by the rateUnits. Otherwise the value returned is 'unspecified'. See rateUnits
currentReading	xsd:long	The current reading of the element indicated by the sensor. The actual sensor reading is obtained by multiplying the current reading by the scale factor.
fru*	HostFru	The FRU this sensor monitors if any. *Since* vSphere API Release 8.0.0.1
healthState*	ElementDescription	The health state of the of the element indicated by the sensor. This property is populated only for sensors that support threshold settings and for discrete sensors using control file. See HostNumericSensorHealthState
id*	xsd:string	A unique sensor identifier. A four part value consisting of: BMC device.Entity ID.Instance.SensorNumber Can be used to match a NumericSensorInfo object to esxcli hardware ipmi sdr list *Since* vSphere API Release 6.5
name	xsd:string	The name of the physical element associated with the sensor It consists of a string of the form: "description --- state/identifer".
rateUnits*	xsd:string	The rate units in which the sensor reading is specified. For example if the baseUnits is Volts and the rateUnits is per second the value returned by the sensor are in Volts/second. If no rate applies the value returned is 'none'.
sensorNumber*	xsd:long	The IPMI Sensor/probe that is reporting this event. Use this value to locate System Event Log (SEL) entries for this Sensor. It is also reported in 'id' in string format. This property is intended to be used with vim.host.SystemEventInfo.sensorNumber *Since* vSphere API Release 8.0.0.1
sensorType	xsd:string	The type of the sensor. If the sensor type is set to Other the sensor name can be used to further identify the type of sensor. The sensor units can also be used to further implicitly determine the type of the sensor. See HostNumericSensorType
timeStamp*	xsd:string	Reports the ISO 8601 Timestamp when this sensor was last updated by management controller if the this sensor is capable of tracking when it was last updated. *Since* vSphere API Release 6.5
unitModifier	xsd:int	The unit multiplier for the values returned by the sensor. All values returned by the sensor are current reading * 10 raised to the power of the UnitModifier. If no unitModifier applies the value returned is 0.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="HostNumericSensorInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="name" type="xsd:string"/>
                     <element name="healthState" type="vim25:ElementDescription" minOccurs="0"/>
                     <element name="currentReading" type="xsd:long"/>
                     <element name="unitModifier" type="xsd:int"/>
                     <element name="baseUnits" type="xsd:string"/>
                     <element name="rateUnits" type="xsd:string" minOccurs="0"/>
                     <element name="sensorType" type="xsd:string"/>
                     <element name="id" type="xsd:string" minOccurs="0"/>
                     <element name="sensorNumber" type="xsd:long" minOccurs="0"/>
                     <element name="timeStamp" type="xsd:string" minOccurs="0"/>
                     <element name="fru" type="vim25:HostFru" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - HostNumericSensorInfo(vim.host.NumericSensorInfo)

Data Object Description