1. Types
  2. vcenter
  3. ovf

vcenter ovf: ovf params

The ovf_params structure defines the common fields for all OVF deployment parameters. OVF parameters serve several purposes:
  • Describe information about a given OVF package.
  • Describe default deployment configuration.
  • Describe possible deployment values based on the deployment environment.
  • Provide deployment-specific configuration.
Each OVF parameters structure specifies a particular configurable aspect of OVF deployment. An aspect has both a query-model and a deploy-model. The query-model is used when the OVF package is queried, and the deploy-model is used when deploying an OVF package.

Most OVF parameter structures provide both informational and deployment parameters. However, some are purely informational (for example, download size) and some are purely deployment parameters (for example, the flag to indicate whether registration as a vCenter extension is accepted).

See deploy and filter.

Representations:

{
    "type": "string"
}
<?xml version="1.0" ?>
<ns0:OvfParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <type>string</type>
</ns0:OvfParams>

Attributes:

Name Type Description
Optional
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.