Ovf_LibraryItem_ResourcePoolDeploymentSpec

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.

JSON Example

{
    "name": "string",
    "annotation": "string",
    "accept_all_EULA": false,
    "network_mappings": {
        "network_mappings": "string"
    },
    "storage_mappings": {
        "storage_mappings": {
            "type": "string",
            "datastore_id": "string",
            "storage_profile_id": "string",
            "provisioning": "string"
        }
    },
    "storage_provisioning": "string",
    "storage_profile_id": "string",
    "locale": "string",
    "flags": [
        "string"
    ],
    "additional_parameters": [
        {}
    ],
    "default_datastore_id": "string"
}

string

name

Optional

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

string

annotation

Optional

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

boolean

accept_all_EULA

Required

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

object

network_mappings

Optional

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.

object

storage_mappings

Optional

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.

Ovf_DiskProvisioningType

storage_provisioning

Optional

The DiskProvisioningType enumerated type defines the virtual disk provisioning types that can be set for a disk on the target platform.
thin : A thin provisioned virtual disk has space allocated and zeroed on demand as the space is used.
thick : A thick provisioned virtual disk has all space allocated at creation time and the space is zeroed on demand as the space is used.
eagerZeroedThick : An eager zeroed thick provisioned virtual disk has all space allocated and wiped clean of any previous contents on the physical media at creation time. Disks specified as eager zeroed thick may take longer time to create than disks specified with the other disk provisioning types.

string

storage_profile_id

Optional

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.

string

locale

Optional

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

array of string

flags

Optional

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

array of object

additional_parameters

Optional

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.

string

default_datastore_id

Optional

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.