Files
deb-python-pyvmomi/docs/vim/host/NumericSensorInfo.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

2.1 KiB

vim.host.NumericSensorInfo

Base class for numeric sensor information.

extends

vmodl.DynamicData

since

VI API 2.5

Attributes:

name (str):

The name of the physical element associated with the sensor

healthState (vim.ElementDescription, optional):

The health state of the of the element indicated by the sensor. This property is populated only for sensors that support threshold settings.See HostNumericSensorHealthState

currentReading (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.

unitModifier (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.

baseUnits (str):

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

rateUnits (str, 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.

sensorType (str):

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