1. Types
  2. vcenter
  3. ovf
  4. library item

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.

Representations:

{
    "accept_all_EULA": true,
    "additional_parameters": [
        {
            "@class": "com.vmware.vcenter.ovf.ovf_params",
            "type": "string"
        },
        {
            "@class": "com.vmware.vcenter.ovf.ovf_params",
            "type": "string"
        }
    ],
    "annotation": "string",
    "default_datastore_id": "obj-103",
    "flags": [
        "string",
        "string"
    ],
    "locale": "string",
    "name": "string",
    "network_mappings": [
        {
            "key": "string",
            "value": "obj-103"
        }
    ],
    "storage_mappings": [
        {
            "key": "string",
            "value": {
                "datastore_id": "obj-103",
                "provisioning": "thin",
                "storage_profile_id": "obj-103",
                "type": "DATASTORE"
            }
        }
    ],
    "storage_profile_id": "obj-103",
    "storage_provisioning": "thin"
}
<?xml version="1.0" ?>
<ns0:ResourcePoolDeploymentSpec xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <annotation>string</annotation>
  <network_mappings-array>
    <array-item>
      <value>obj-103</value>
      <key>string</key>
    </array-item>
  </network_mappings-array>
  <flags-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </flags-array>
  <storage_provisioning>thin</storage_provisioning>
  <storage_mappings-array>
    <array-item>
      <value>
        <datastore_id>obj-103</datastore_id>
        <storage_profile_id>obj-103</storage_profile_id>
        <type>DATASTORE</type>
        <provisioning>thin</provisioning>
      </value>
      <key>string</key>
    </array-item>
  </storage_mappings-array>
  <locale>string</locale>
  <name>string</name>
  <default_datastore_id>obj-103</default_datastore_id>
  <additional_parameters-array>
    <array-item class="com.vmware.vcenter.ovf.ovf_params">
      <type>string</type>
    </array-item>
    <array-item class="com.vmware.vcenter.ovf.ovf_params">
      <type>string</type>
    </array-item>
  </additional_parameters-array>
  <storage_profile_id>obj-103</storage_profile_id>
  <accept_all_EULA>true</accept_all_EULA>
</ns0:ResourcePoolDeploymentSpec>

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.
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 list 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 list 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_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.