Developer Documentation

LibraryItemOvfSummary

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


Properties

Required Property Name Type Description
required EULAs array of string

End User License Agreements specified in the OVF descriptor. All end user license agreements must be accepted in order for the LibraryItem.deploy operation to succeed. See LibraryItem.ResourcePoolDeploymentSpec.accept-all-eula.

optional additional_params array of object

Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in LibraryItem.ResourcePoolDeploymentSpec.additional-parameters for the LibraryItem.deploy operation. If unset, the OVF descriptor does not require addtional parameters or does not have additional parameters suitable for the deployment target. When clients pass a value of this structure as a parameter, the field must contain all the attributes defined in OvfParams. When operations return a value of this structure as a result, the field will contain all the attributes defined in OvfParams.

optional annotation string

Default annotation for the virtual machine or virtual appliance. If unset, the OVF descriptor did not specify an annotation.

optional name string

Default name for the virtual machine or virtual appliance. If unset, the OVF descriptor did not specify a name.

optional networks array of string

Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.network-mappings. If unset, the OVF descriptor did not specify any networks.

optional storage_groups array of string

Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in LibraryItem.ResourcePoolDeploymentSpec.storage-mappings. If unset, the OVF descriptor did not specify any storage groups.

Feedback

Was this page helpful?