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

1.8 KiB

vim.VirtualApp.Summary

This data object type encapsulates a typical set of resource pool information that is useful for list views and summary pages.

extends

vim.ResourcePool.Summary

since

vSphere API 4.0

Attributes:

product (vim.vApp.ProductInfo, optional):

Product information. References to properties in the URLs are expanded.

vAppState (vim.VirtualApp.VAppState, optional):

Whether the vApp is running

suspended (bool, optional):

Whether a vApp is suspended, in the process of being suspended, or in the process of being resumed. A stopped vApp is marked as suspended under the following conditions:
  • All child virtual machines are either suspended or powered-off.
  • There is at least one suspended virtual machine for which the stop action is not "suspend".If the vAppState property is "stopped", the value is set to true if the vApp is suspended (according the the above definition).If the vAppState property is "stopping" or "starting" and the suspend flag is set to true, then the vApp is either in the process of being suspended or resumed from a suspended state, respectively.If the vAppState property is "started", then the suspend flag is set to false.

installBootRequired (bool, optional):

Whether one or more VMs in this vApp require a reboot to finish installation.

instanceUuid (str, optional):

vCenter-specific UUID of the vApp