Files
deb-python-pyvmomi/docs/vim/cluster/HostPowerAction.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

29 lines
1.3 KiB
ReStructuredText

.. _int: https://docs.python.org/2/library/stdtypes.html
.. _VI API 2.5: ../../vim/version.rst#vimversionversion2
.. _vim.cluster.Action: ../../vim/cluster/Action.rst
.. _vim.cluster.HostPowerAction.OperationType: ../../vim/cluster/HostPowerAction/OperationType.rst
vim.cluster.HostPowerAction
===========================
Describes a single host power action.
:extends: vim.cluster.Action_
:since: `VI API 2.5`_
Attributes:
operationType (`vim.cluster.HostPowerAction.OperationType`_):
Specify whether the action is power on or power off
powerConsumptionWatt (`int`_, optional):
Estimated power consumption of the host. In case of power-on, this is the projected increase in the cluster's power consumption. In case of power off, this is the projected decrease in the cluster's power consumption
cpuCapacityMHz (`int`_, optional):
CPU capacity of the host in units of MHz. In case of power-on action, this is the projected increase in the cluster's CPU capacity. In case of power off, this is the projected decrease in the cluster's CPU capacity.
memCapacityMB (`int`_, optional):
Memory capacity of the host in units of MM. In case of power-on action, this is the projected increase in the cluster's memory capacity. In case of power off, this is the projected decrease in the cluster's memory capacity.