Developer Documentation

OvfProperty

The Property structure contains the information about a property in an OVF package. A property is uniquely identified by its [classid.]id[.instanceid] fully-qualified name (see Property.class-id, Property.id, and Property.instance-id). If multiple properties in an OVF package have the same fully-qualified name, then the property is excluded and cannot be set. We do warn about this during import.

See LibraryItem.deploy and LibraryItem.filter.


Properties

Required Property Name Type Description
optional category string

If this is set to a non-empty string, this property starts a new category. 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, the property is in the same category as the previous item, otherwise, it starts a new category.

optional class_id string

The classId of this OVF property. 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 description string

A description of this OVF property. 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.

optional id string

The identifier of this OVF property. 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.

optional instance_id string

The instanceId of this OVF property. 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 label string

The display name of this OVF property. 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 type string

The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values. 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 ui_optional boolean

Whether a category is UI optional. This is only used if this property starts a new category (see Property.category). The value is stored in an optional attribute vmw:uioptional to the ovf:Category element. The default value is false. If this value is true, the properties within this category are optional. The UI renders this as a group with a check box, and the group is grayed out until the check box is selected. When the check box is selected, the input values are read and used in deployment. If properties within the same category specify conflicting values the default is used. Only implemented in vSphere Web Client 5.1 and later as of Nov 2012.

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.

optional value string

The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read. 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?