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

4.0 KiB

vim.OvfManager.ParseDescriptorResult

extends

vmodl.DynamicData

since

vSphere API 4.0

Attributes:

eula (str, optional):

The list of all EULAs contained in the OVF

network (vim.OvfManager.NetworkInfo, optional):

The list of networks required by the OVF

ipAllocationScheme (str, optional):

The kind of IP allocation supported by the guest.See VAppIPAssignmentInfo .

ipProtocols (str, optional):

The IP protocols supported by the guest.See VAppIPAssignmentInfo .

property (vim.vApp.PropertyInfo, optional):

Metadata about the properties contained in the OVF

productInfo (vim.vApp.ProductInfo, optional):

The product info contained in the OVF

annotation (str):

The annotation info contained in the OVF

approximateDownloadSize (long, optional):

The OVF Manager's best guess as to the total amount of data that must be transferred to download the entity.This may be inaccurate due to disk compression etc.

approximateFlatDeploymentSize (long, optional):

The OVF Manager's best guess as to the total amount of space required to deploy the entity if using flat disks.

approximateSparseDeploymentSize (long, optional):

The OVF Manager's best guess as to the total amount of space required to deploy the entity using sparse disks.

defaultEntityName (str):

The default name to use for the entity, if a product name is not specified. This is the ID of the OVF top-level entity, or taken from a ProductSection.

virtualApp (bool):

True if the OVF contains a vApp (containing one or more vApps and/or virtual machines), as opposed to a single virtual machine.

deploymentOption (vim.OvfManager.DeploymentOption, optional):

The list of possible deployment options.

defaultDeploymentOption (str):

The key of the default deployment option. Empty only if there are no deployment options.

entityName (vim.KeyValue, optional):

A list of the child entities contained in this package and their location in the vApp hierarchy. Each entry is a (key,value) pair, where the key is the display name, and the value is a unique path identifier for the entity in the vApp. The path is constructed by appending the id of each entity of the path down to the entity, separated by slashes. For example, the path for a child of the root entity with id = "vm1", would simply be "vm1". If the vm is the child of a VirtualSystemCollection called "webTier", then the path would be "webTier/vm".

annotatedOst (vim.OvfConsumer.OstNode, optional):

The annotated OST for the OVF descriptor, generated by OVF consumers. See OvfConsumer for details.

error (vmodl.LocalizedMethodFault, optional):

Errors that happened during processing. Something will be wrong with the result.For example, during export, devices could be missing (in which case this array will contain one or more instances of Unsupported-/UnknownDevice).

warning (vmodl.LocalizedMethodFault, optional):

Non-fatal warnings from the processing. The result will be valid, but the user may choose to reject it based on these warnings.