Vcenter Ovf LibraryItem OvfSummary

Vcenter Ovf LibraryItem OvfSummary
Vcenter Ovf LibraryItem OvfSummary

The Vcenter Ovf LibraryItem OvfSummary schema defines the result of the filter operation. See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=filter. The properties in the schema describe parameterizable information in the OVF descriptor, with respect to a deployment target, for the deploy operation. See POST /vcenter/ovf/library-item/{ovfLibraryItemId}?action=deploy.

JSON Example
{
    "name": "string",
    "annotation": "string",
    "eulas": [
        "string"
    ],
    "networks": [
        "string"
    ],
    "storage_groups": [
        "string"
    ],
    "additional_params": [
        {
            "type": "string"
        }
    ]
}
string
name
Optional

Default name for the virtual machine or virtual appliance.

If missing or null, the OVF descriptor did not specify a name.

string
annotation
Optional

Default annotation for the virtual machine or virtual appliance.

If missing or null, the OVF descriptor did not specify an annotation.

array of string
eulas
Required

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 Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.accept_all_EULA.

array of string
networks
Optional

Section identifiers for sections of type ovf:NetworkSection in the OVF descriptor. These identifiers can be used as keys in Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.network_mappings.

If missing or null, the OVF descriptor did not specify any networks.

array of string
storage_groups
Optional

Section identifiers for sections of type vmw:StorageGroupSection in the OVF descriptor. These identifiers can be used as keys in Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.storage_mappings.

If missing or null, the OVF descriptor did not specify any storage groups.

array of Vcenter Ovf OvfParams
additional_params
Optional

Additional OVF parameters which can be specified for the deployment target. These OVF parameters can be inspected, optionally modified, and used as values in Vcenter Ovf LibraryItem ResourcePoolDeploymentSpec.additional_parameters for the deploy operation.

If missing or null, 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 schema as a parameter, the property must contain all the properties defined in Vcenter Ovf OvfParams. When operations return a value of this schema as a response, the property will contain all the properties defined in Vcenter Ovf OvfParams.

Returned By