Developer Documentation

OvfDeploymentOptionParams

The DeploymentOptionParams structure describes the possible deployment options as well as the choice provided by the user. This information based on the ovf:DeploymentOptionSection.

See LibraryItem.deploy and LibraryItem.filter.


Properties

Required Property Name Type Description
optional deployment_options array of OvfDeploymentOption

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

optional selected_key string

The selected deployment option. Identifies the DeploymentOption in the list in the DeploymentOptionParams.deployment-options field with a matching value in the DeploymentOption.key field. 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 DeploymentOptionParams.deployment-options list. 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.

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

Feedback

Was this page helpful?