Data Object Description

Properties

Name	Type	Description
annotatedOst*	OvfConsumerOstNode	The annotated OST for the OVF descriptor, generated by OVF consumers. See OvfConsumer for details. *Since* vSphere API 5.0
annotation	xsd:string	The annotation info contained in the OVF
approximateDownloadSize*	xsd:long	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*	xsd:long	The OVF Manager's best guess as to the total amount of space required to deploy the entity if using flat disks.
approximateSparseDeploymentSize*	xsd:long	The OVF Manager's best guess as to the total amount of space required to deploy the entity using sparse disks.
defaultDeploymentOption	xsd:string	The key of the default deployment option. Empty only if there are no deployment options.
defaultEntityName	xsd:string	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.
deploymentOption*	OvfDeploymentOption[]	The list of possible deployment options.
entityName*	KeyValue[]	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". *Since* vSphere API 4.1
error*	LocalizedMethodFault[]	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).
eula*	xsd:string[]	The list of all EULAs contained in the OVF
ipAllocationScheme*	xsd:string[]	The kind of IP allocation supported by the guest. See VAppIPAssignmentInfo.
ipProtocols*	xsd:string[]	The IP protocols supported by the guest. See VAppIPAssignmentInfo.
network*	OvfNetworkInfo[]	The list of networks required by the OVF
productInfo*	VAppProductInfo	The product info contained in the OVF
property*	VAppPropertyInfo[]	Metadata about the properties contained in the OVF
virtualApp	xsd:boolean	True if the OVF contains a vApp (containing one or more vApps and/or virtual machines), as opposed to a single virtual machine.
warning*	LocalizedMethodFault[]	Non-fatal warnings from the processing. The result will be valid, but the user may choose to reject it based on these warnings.
Properties inherited from DynamicData
None

Name

Type

Description

annotatedOst*

OvfConsumerOstNode

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

Since vSphere API 5.0

annotation

xsd:string

The annotation info contained in the OVF

approximateDownloadSize*

xsd:long

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*

xsd:long

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

approximateSparseDeploymentSize*

xsd:long

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

defaultDeploymentOption

xsd:string

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

defaultEntityName

xsd:string

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.

deploymentOption*

OvfDeploymentOption[]

The list of possible deployment options.

entityName*

KeyValue[]

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".

Since vSphere API 4.1

error*

LocalizedMethodFault[]

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).

eula*

xsd:string[]

The list of all EULAs contained in the OVF

ipAllocationScheme*

xsd:string[]

The kind of IP allocation supported by the guest.

See VAppIPAssignmentInfo.

ipProtocols*

xsd:string[]

The IP protocols supported by the guest.

See VAppIPAssignmentInfo.

network*

OvfNetworkInfo[]

The list of networks required by the OVF

productInfo*

VAppProductInfo

The product info contained in the OVF

property*

VAppPropertyInfo[]

Metadata about the properties contained in the OVF

virtualApp

xsd:boolean

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

warning*

LocalizedMethodFault[]

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

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="OvfParseDescriptorResult">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="eula" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="network" type="vim25:OvfNetworkInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="ipAllocationScheme" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="ipProtocols" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="property" type="vim25:VAppPropertyInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="productInfo" type="vim25:VAppProductInfo" minOccurs="0"/>
                     <element name="annotation" type="xsd:string"/>
                     <element name="approximateDownloadSize" type="xsd:long" minOccurs="0"/>
                     <element name="approximateFlatDeploymentSize" type="xsd:long" minOccurs="0"/>
                     <element name="approximateSparseDeploymentSize" type="xsd:long" minOccurs="0"/>
                     <element name="defaultEntityName" type="xsd:string"/>
                     <element name="virtualApp" type="xsd:boolean"/>
                     <element name="deploymentOption" type="vim25:OvfDeploymentOption" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="defaultDeploymentOption" type="xsd:string"/>
                     <element name="entityName" type="vim25:KeyValue" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="annotatedOst" type="vim25:OvfConsumerOstNode" minOccurs="0"/>
                     <element name="error" type="vim25:LocalizedMethodFault" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="warning" type="vim25:LocalizedMethodFault" minOccurs="0" maxOccurs="unbounded"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - OvfParseDescriptorResult(vim.OvfManager.ParseDescriptorResult)

Data Object Description