openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
master
deb-python-pyvmomi/docs/vim/vm/DefaultPowerOpInfo.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
Raw Permalink Blame History

vim.vm.DefaultPowerOpInfo

The DefaultPowerOpInfo data object type holds the configured defaults for the power operations on a virtual machine. The properties indicated whether to do a "soft" or guest initiated operation, or a "hard" operation.

extends

vmodl.DynamicData

Attributes:

powerOffType (str, optional):

Describes the default power off type for this virtual machine. The possible values are specified by the PowerOpType.
  • hard - Perform power off by using the PowerOff method.
  • soft - Perform power off by using the ShutdownGuest method.
  • preset - The preset value is specified in the defaultPowerOffType section.
  • This setting is advisory and clients can choose to ignore it.

suspendType (str, optional):

Describes the default suspend type for this virtual machine. The possible values are specified by the PowerOpType.
  • hard - Perform suspend by using the Suspend method.
  • soft - Perform suspend by using the StandbyGuest method.
  • preset - The preset value is specified in the defaultSuspendType section.
  • This setting is advisory and clients can choose to ignore it.

resetType (str, optional):

Describes the default reset type for this virtual machine. The possible values are specified by the PowerOpType.
  • hard - Perform reset by using the Reset method.
  • soft - Perform reset by using the RebootGuest method.
  • preset - The preset value is specified in the defaultResetType section.
  • This setting is advisory and clients can choose to ignore it.

defaultPowerOffType (str, optional):

Default operation for power off: soft or hard

defaultSuspendType (str, optional):

Default operation for suspend: soft or hard

defaultResetType (str, optional):

Default operation for reset: soft or hard

standbyAction (str, optional):

Behavior of virtual machine when it receives the S1 ACPI call.