REST API - deployment_option

vcenter ovf: 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.

Representation:

JSON

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

Attributes:

Name	Type	Description
Optional
deployment_options	deployment_option[]	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. Optional. This field is not used 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.
deployment_options[].key	string	The key of the deployment option, corresponding to the ovf:id attribute in the OVF descriptor. Optional. This field is not used 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.
deployment_options[].label	string	A localizable label for the deployment option. Optional. This field is not used 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.
deployment_options[].description	string	A localizable description for the deployment option. Optional. This field is not used 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.
deployment_options[].default_choice	boolean	A boolean flag indicates whether this deployment option is the default choice. Optional. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. If unset or false, it is not the default.
selected_key	string	The selected deployment option. Identifies the vcenter.ovf.deployment_option in the list in the `deployment_options` field with a matching value in the vcenter.ovf.deployment_option.key field. Optional. 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 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.
type	string	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. Optional. 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.