OvfLibraryItemResourcePoolDeploymentSpec

The LibraryItem.ResourcePoolDeploymentSpec structure defines the deployment parameters that can be specified for the LibraryItem.deploy operation where the deployment target is a resource pool. See LibraryItem.deploy.


Properties

Required Property Name Type Description
required accept_all_EULA boolean

Whether to accept all End User License Agreements. See LibraryItem.OvfSummary.eulas.

optional additional_parameters array of object

Additional OVF parameters that may be needed for the deployment. Additional OVF parameters may be required by the OVF descriptor of the OVF package in the library item. Examples of OVF parameters that can be specified through this field include, but are not limited to: - DeploymentOptionParams - ExtraConfigParams - IpAllocationParams - PropertyParams - ScaleOutParams - VcenterExtensionParams

If unset, the server will choose default settings for all parameters necessary for the LibraryItem.deploy operation. See LibraryItem.deploy. When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in OvfParams. When operations return a value of this structure as a result, the field will contain all the attributes defined in OvfParams.

optional annotation string

Annotation assigned to the deployed target virtual machine or virtual appliance. If unset, the server will use the annotation from the OVF package.

optional default_datastore_id string

Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor. If unset, the server will choose the default datastore. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datastore. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datastore.

optional flags array of string

Flags to be use for deployment. The supported flag values can be obtained using ImportFlag.list. If unset, no flags will be used.

optional locale string

The locale to use for parsing the OVF descriptor. If unset, the server locale will be used.

optional name string

Name assigned to the deployed target virtual machine or virtual appliance. If unset, the server will use the name from the OVF package.

optional network_mappings map of string

Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the map is the section identifier of the ovf:NetworkSection section in the OVF descriptor and the value is the target network to be used for deployment. If unset, the server will choose a network mapping. When clients pass a value of this structure as a parameter, the value in the field map must be an identifier for the resource type: Network. When operations return a value of this structure as a result, the value in the field map will be an identifier for the resource type: Network.

optional storage_mappings map of OvfLibraryItemStorageGroupMapping

Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the map is the section identifier of the ovf:StorageGroupSection section in the OVF descriptor and the value is the target storage specification to be used for deployment. See LibraryItem.StorageGroupMapping. If unset, the server will choose a storage mapping.

optional storage_profile_id string

Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor. If unset, the server will choose the default profile. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: StorageProfile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: StorageProfile.

optional storage_provisioning OvfDiskProvisioningType Enum

Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor. If unset, the server will choose the provisioning type.

JSON Example

{
    "accept_all_EULA": false
}
Feedback

Was this page helpful?