HostNumericSensorInfo

HostNumericSensorInfo
HostNumericSensorInfo

Base class for numeric sensor information.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "name": "string",
    "healthState": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string"
    },
    "currentReading": 0,
    "unitModifier": 0,
    "baseUnits": "string",
    "rateUnits": "string",
    "sensorType": "string",
    "id": "string",
    "sensorNumber": 0,
    "timeStamp": "string",
    "fru": {
        "_typeName": "string",
        "type": "string",
        "partName": "string",
        "partNumber": "string",
        "manufacturer": "string",
        "serialNumber": "string",
        "mfgTimeStamp": "string"
    }
}
string
name
Required

The name of the physical element associated with the sensor It consists of a string of the form: "description --- state/identifer".

healthState
Optional

Static strings used for describing an object model string or enumeration.

integer As int64 As int64
currentReading
Required

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.

integer As int32 As int32
unitModifier
Required

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.

string
baseUnits
Required

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 also rateUnits.

string
rateUnits
Optional

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'.

string
sensorType
Required

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 also HostNumericSensorTypeEnum.

string
id
Optional

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

integer As int64 As int64
sensorNumber
Optional

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

string
timeStamp
Optional

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.

fru
Optional

Data object representing the hardware vendor identity for a given hardware component in the host.

Since: vSphere API Release 8.0.0.1