vcenter ovf library item: resource pool deployment spec

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

Representation:

{
    "annotation""string",
    "storage_provisioning""thin",
    "default_datastore_id""obj-103",
    "accept_all_EULA"true,
    "network_mappings"{
        "<string>""obj-103"
    },
    "storage_mappings"{
        "<string>"{
            "storage_profile_id""obj-103",
            "datastore_id""obj-103",
            "provisioning""thin",
            "type""DATASTORE"
        }
    },
    "storage_profile_id""obj-103",
    "name""string",
    "flags"[
        "string",
        "string"
    ],
    "additional_parameters"[
        {
            "type""string"
        },
        {
            "type""string"
        }
    ],
    "locale""string"
}
{
    "annotation""string",
    "storage_provisioning""thin",
    "default_datastore_id""obj-103",
    "accept_all_EULA"true,
    "network_mappings"[
        {
            "value""obj-103",
            "key""string"
        }
    ],
    "storage_mappings"[
        {
            "value"{
                "storage_profile_id""obj-103",
                "datastore_id""obj-103",
                "provisioning""thin",
                "type""DATASTORE"
            },
            "key""string"
        }
    ],
    "storage_profile_id""obj-103",
    "name""string",
    "flags"[
        "string",
        "string"
    ],
    "additional_parameters"[
        {
            "@class""com.vmware.vcenter.ovf.ovf_params",
            "type""string"
        },
        {
            "@class""com.vmware.vcenter.ovf.ovf_params",
            "type""string"
        }
    ],
    "locale""string"
}

Attributes:

Name Type Description
Required
-.accept_all_EULA boolean Whether to accept all End User License Agreements. See vcenter.ovf.library_item.ovf_summary.EULAs.

-.network_mappings.* string
-.storage_mappings.* storage_group_mapping
-.storage_mappings.*.type string Type of storage deployment target to use for the vmw:StorageGroupSection section. The specified value must be DATASTORE or STORAGE_PROFILE.

Defines the supported types of storage targets for sections of type vmw:StorageGroupSection in the OVF descriptor. Value is one of:
DATASTORE: Storage deployment target is a datastore.
STORAGE_PROFILE: Storage deployment target is a storage profile.

-.additional_parameters.type string Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.

This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

Optional
-.name string Name assigned to the deployed target virtual machine or virtual appliance.

Optional. If unset, the server will use the name from the OVF package.

-.annotation string Annotation assigned to the deployed target virtual machine or virtual appliance.

Optional. If unset, the server will use the annotation from the OVF package.

-.network_mappings object Specification of the target network to use for sections of type ovf:NetworkSection in the OVF descriptor. The key in the key/value pairs 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.

Optional. 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 key/value pairs 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 key/value pairs will be an identifier for the resource type: Network.

-.storage_mappings object Specification of the target storage to use for sections of type vmw:StorageGroupSection in the OVF descriptor. The key in the key/value pairs 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 vcenter.ovf.library_item.storage_group_mapping.

Optional. If unset, the server will choose a storage mapping.

-.storage_mappings.*.datastore_id string Target datastore to be used for the storage group.

Optional. It is only relevant when type has value DATASTORE. This field is optional and it is only relevant when the value of type is 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.

-.storage_mappings.*.storage_profile_id string Target storage profile to be used for the storage group.

Optional. It is only relevant when type has value STORAGE_PROFILE. This field is optional and it is only relevant when the value of type is STORAGE_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.

-.storage_mappings.*.provisioning string Target provisioning type to use for the storage group.

Optional. If unset, vcenter.ovf.library_item.resource_pool_deployment_spec.storage_provisioning will be used.

-.storage_provisioning string Default storage provisioning type to use for all sections of type vmw:StorageSection in the OVF descriptor.

Optional. If unset, the server will choose the provisioning type.

-.storage_profile_id string Default storage profile to use for all sections of type vmw:StorageSection in the OVF descriptor.

Optional. 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.

-.locale string The locale to use for parsing the OVF descriptor.

Optional. If unset, the server locale will be used.

-.flags string[] Flags to be use for deployment. The supported flag values can be obtained using list.

Optional. If unset, no flags will be used.

-.additional_parameters 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:

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

-.default_datastore_id string Default datastore to use for all sections of type vmw:StorageSection in the OVF descriptor.

Optional. 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.