REST API - property

property_params

The property_params structure contains a array of OVF properties that can be configured when the OVF package is deployed.

This is based on the ovf:ProductSection.

See deploy and filter.

Representations:

JSON
XML

{
    "properties": [
        {
            "category": "string",
            "class_id": "string",
            "description": "string",
            "id": "string",
            "instance_id": "string",
            "label": "string",
            "type": "string",
            "ui_optional": true,
            "value": "string"
        },
        {
            "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:PropertyParams xmlns:ns0="http://vmware.com/vcenter/ovf" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <properties-array>
    <array-item>
      <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>
    </array-item>
    <array-item>
      <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>
    </array-item>
  </properties-array>
</ns0:PropertyParams>

Attributes:

Name	Type	Required	Description
properties	List<property>	Read	Array of OVF properties.
type	string	Create, Read	Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure.

com.vmware.vcenter.ovf

property_params