REST API - deployment_option

deployment_option_params

The deployment_option_params structure describes the possible deployment options as well as the choice provided by the user.

This information based on the ovf:DeploymentOptionSection.

See deploy and filter.

Representations:

JSON
XML

{
    "deployment_options": [
        {
            "default_choice": true,
            "description": "string",
            "key": "string",
            "label": "string"
        },
        {
            "default_choice": true,
            "description": "string",
            "key": "string",
            "label": "string"
        }
    ],
    "selected_key": "string"
}

<?xml version="1.0" ?>
<ns0:DeploymentOptionParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <deployment_options-array>
    <array-item>
      <default_choice>true</default_choice>
      <description>string</description>
      <label>string</label>
      <key>string</key>
    </array-item>
    <array-item>
      <default_choice>true</default_choice>
      <description>string</description>
      <label>string</label>
      <key>string</key>
    </array-item>
  </deployment_options-array>
  <selected_key>string</selected_key>
</ns0:DeploymentOptionParams>

Attributes:

Name	Type	Required	Description
deployment_options	List<deployment_option>	Read	Array of deployment options. This field corresponds to the ovf:Configuration elements of the ovf:DeploymentOptionSection in the specification. It is a discrete set of intended resource allocation configurations from which one can be selected.
selected_key	string	No. This field is optional in the input parameters when deploying an OVF package. If unset the server will use the default deployment configuration, usually it's the first one in com.vmware.vcenter.ovf.deployment_option_params.deployment_options array. This field is optional in the result when retrieving information about an OVF package. The value will be set only if it is specified with the optional ovf:default attribute.	The selected deployment option. Identifies the com.vmware.vcenter.ovf.deployment_option in the list in the `deployment_options` field with a matching value in the com.vmware.vcenter.ovf.deployment_option.key field.
type	string	Create, Read	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.

com.vmware.vcenter.ovf

deployment_option_params