Scripting Object - VcOvfCreateImportSpecParams

Parameter to

Scripting Object Description

Parameters for deploying an OVF.


Name Type Description

The key of the chosen deployment option. If empty, the default option is chosen. The list of possible deployment options is returned in the result of parseDescriptor.

An optional disk provisioning. If set, all the disks in the deployed OVF will have get the same specified disk type (e.g., thin provisioned). The valide values for disk provisioning are:
See VcVirtualDiskMode
dynamicProperty*VcDynamicProperty []

Set of dynamic properties. This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future.


The name to set on the entity (more precisely, on the top-level vApp or VM of the entity) as it appears in VI. If empty, the product name is obtained from the ProductSection of the descriptor. If that name is not specified, the ovf:id of the top-level entity is used.

The host to validate the OVF descriptor against, if it cannot be deduced from the resource pool.

The privilege System.Read is required on the host.


The IP allocation policy chosen by the caller.

See VcVAppIPAssignmentInfo.


The IP protocol chosen by the caller.

See VcVAppIPAssignmentInfo.


The locale-identifier to choose from the descriptor. If empty, the default locale on the server is used.
msgBundle*VcKeyValue []

An optional set of localization strings to be used. The server will use these message strings to localize information in the result and in error and warning messages.

This argument allows a client to pass messages from external string bundles. The client is responsible for selecting the right string bundle (based on locale) and parsing the external string bundle. The passed in key/value pairs are looked up before any messages included in the OVF descriptor itself.

networkMapping*VcOvfNetworkMapping []

The mapping of network identifiers from the descriptor to networks in the VI infrastructure.

The privilege Network.Assign is required on all networks in the list.

propertyMapping*VcKeyValue []

The assignment of values to the properties found in the descriptor. If no value is specified for an option, the default value from the descriptor is used.
resourceMapping*VcOvfResourceMap []

The resource configuration for the created vApp. This can be used to distribute a vApp across multiple resource pools (and create linked children).
*May not be present


Methods defined in this Scripting Object