Data Object - OvfCreateDescriptorParams(vim.OvfManager.CreateDescriptorParams)

Parameter to
CreateDescriptor
Extends
DynamicData
See also
OvfFile, VirtualMachineSnapshot
Since
vSphere API 4.0

Data Object Description

Collection of parameters for createDescriptor

Properties

Name Type Description
description*xsd:string

The contents of the Annontation section of the top-level OVF Entity. If unset, any existing annotation on the entity is left unchanged.
exportOption*xsd:string[]

An optional argument for modifying the export process. The option is used to control what extra information that will be included in the OVF descriptor.

To get a list of supported keywords see ovfExportOption. Unknown options will be ignored by the server.

Since vSphere API 5.1
includeImageFiles*xsd:boolean

Controls whether attached image files should be included in the descriptor. This applies to image files attached to VirtualCdrom and VirtualFloppy.

Since vSphere API 4.1
name*xsd:string

The ovf:id to use for the top-level OVF Entity. If unset, the entity's product name is used if available. Otherwise, the VI entity name is used.
ovfFiles*OvfFile[]

Contains information about the files of the entity, if they have already been downloaded. Needed to construct the References section of the descriptor.

OvfFile is a positive list of files to include in the export. An Empty list will do no filtering.

snapshot*ManagedObjectReference
to a VirtualMachineSnapshot

Snapshot reference from which the OVF descriptor should be based.

If this parameter is set, the OVF descriptor is based off the snapshot point. This means that the OVF descriptor will have the same configuration as the virtual machine at the time the snapshot was taken.

The snapshot must be belong to the specified ManagedEntity in the createDescriptor call.

Since vSphere API 5.5
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition