Search

Class VcOvfCreateImportSpecParams

Extends VcOvfManagerCommonParams
Parameters for deploying an OVF.

Attributes

Name Type Description
deploymentOption String 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.
diskProvisioning String 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: <ul> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> <li><a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcOvfCreateImportSpecParamsDiskProvisioningType</a> </ul><br>See <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfCreateImportSpecParamsDiskProvisioningType.html#monolithicSparse">VcVirtualDiskMode</a><br>
entityName String 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.
hostSystem VcHostSystem The host to validate the OVF descriptor against, if it cannot be deduced from the resource pool. <p> The privilege System.Read is required on the host.
importOption String[] An optional argument for modifing the OVF parsing. When the server parses an OVF descriptor a set of options can be used to modify the parsing. The argument is a list of keywords. <p> To get a list of supported keywords see <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcOvfManager.html#ovfImportOption">VcOvfManager</a>. Unknown options will be ignored by the server.
instantiationOst VcOvfConsumerOstNode The instantiation OST to configure OVF consumers. This is created by the client from the annotated OST. See <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/null.html">null</a> for details.
ipAllocationPolicy String The IP allocation policy chosen by the caller. <p> See <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcVAppIPAssignmentInfo.html">VcVAppIPAssignmentInfo</a>.
ipProtocol String The IP protocol chosen by the caller. <p> See <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcVAppIPAssignmentInfo.html">VcVAppIPAssignmentInfo</a>.
locale String 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. <p> 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. <p> 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). <br/><i>As of vSphere API 5.1.</i>

Methods

Name Returns
VcOvfCreateImportSpecParams() constructor

Returned by

None

Referenced in

Method Returns
VcOvfManager.createImportSpec(String ovfDescriptor, VcResourcePool resourcePool, VcDatastore datastore, VcOvfCreateImportSpecParams cisp) VcOvfCreateImportSpecResult