REST API - property

property

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 com.vmware.vcenter.ovf.property.class_id, com.vmware.vcenter.ovf.property.id, and com.vmware.vcenter.ovf.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 deploy and filter.

Representations:

JSON
XML

{
    "category": "string",
    "class_id": "string",
    "description": "string",
    "id": "string",
    "instance_id": "string",
    "label": "string",
    "type": "string",
    "ui_optional": true,
    "value": "string"
}

<?xml version="1.0" ?>
<ns0:Property xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <id>string</id>
  <ui_optional>true</ui_optional>
  <category>string</category>
  <class_id>string</class_id>
  <description>string</description>
  <value>string</value>
  <label>string</label>
  <type>string</type>
  <instance_id>string</instance_id>
</ns0:Property>

Attributes:

Name	Type	Required	Description
class_id	string	Read	The classId of this OVF property.
id	string	Create, Read	The identifier of this OVF property.
instance_id	string	Read	The instanceId of this OVF property.
category	string	Read	If this is set to a non-empty string, this property starts a new category.
ui_optional	boolean	Read	Whether a category is UI optional. This is only used if this property starts a new category (see com.vmware.vcenter.ovf.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.
label	string	Read	The display name of this OVF property.
description	string	Read	A description of this OVF property.
type	string	Read	The type of this OVF property. Refer to the configuration of a virtual appliance/virtual machine for the valid values.
value	string	Create, Read	The OVF property value. This contains the default value from ovf:defaultValue if ovf:value is not present when read.