REST API - ovf

ovf_summary

The ovf_summary structure defines the result of the filter operation. See filter. The fields in the structure describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy operation. See deploy.

Representations:

JSON
XML

{
    "EULAs": [
        "string",
        "string"
    ],
    "additional_params": [
        {
            "@class": "com.vmware.vcenter.ovf.ovf_params",
            "type": "string"
        },
        {
            "@class": "com.vmware.vcenter.ovf.ovf_params",
            "type": "string"
        }
    ],
    "annotation": "string",
    "name": "string",
    "networks": [
        "string",
        "string"
    ],
    "storage_groups": [
        "string",
        "string"
    ]
}

<?xml version="1.0" ?>
<ns0:OvfSummary xmlns:ns0="http://vmware.com/vcenter/ovf/library_item" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <networks-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </networks-array>
  <annotation>string</annotation>
  <storage_groups-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </storage_groups-array>
  <additional_params-array>
    <array-item class="com.vmware.vcenter.ovf.ovf_params">
      <type>string</type>
    </array-item>
    <array-item class="com.vmware.vcenter.ovf.ovf_params">
      <type>string</type>
    </array-item>
  </additional_params-array>
  <name>string</name>
  <EULAs-array>
    <array-item>string</array-item>
    <array-item>string</array-item>
  </EULAs-array>
</ns0:OvfSummary>

Attributes:

Name	Type	Required	Description
name	string	No. If unset, the OVF descriptor did not specify a name.	Default name for the virtual machine or virtual appliance.
annotation	string	No. If unset, the OVF descriptor did not specify an annotation.	Default annotation for the virtual machine or virtual appliance.
EULAs *	List<string>	Yes	Array of End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the `deploy` operation to succeed. See com.vmware.vcenter.ovf.library_item.resource_pool_deployment_spec.accept_all_EULA.
networks	List<string>	No. If unset, the OVF descriptor did not specify any networks.	Array of section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in com.vmware.vcenter.ovf.library_item.resource_pool_deployment_spec.network_mappings.
storage_groups	List<string>	No. If unset, the OVF descriptor did not specify any storage groups.	Array of section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in com.vmware.vcenter.ovf.library_item.resource_pool_deployment_spec.storage_mappings.
additional_params	List<dynamic_structure>	No. If unset, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target.	List of additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in com.vmware.vcenter.ovf.library_item.resource_pool_deployment_spec.additional_parameters for the `deploy` operation. Has the fields of ovf_params.

com.vmware.vcenter.ovf.library_item

ovf_summary