Developer Documentation

OvfSizeParams

The SizeParams structure contains estimates of the download and deployment sizes. This information is based on the file references and the ovf:DiskSection in the OVF descriptor.

See LibraryItem.deploy and LibraryItem.filter.


Properties

Required Property Name Type Description
optional approximate_download_size integer

A best guess as to the total amount of data that must be transferred to download the OVF package. This may be inaccurate due to disk compression etc.

This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be unset if there is insufficient information to provide a proper estimate.

optional approximate_flat_deployment_size integer

A best guess as to the total amount of space required to deploy the OVF package if using flat disks. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be unset if there is insufficient information to provide a proper estimate.

optional approximate_sparse_deployment_size integer

A best guess as to the total amount of space required to deploy the OVF package using sparse disks. This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. It will be unset if there is insufficient information to provide a proper estimate.

optional type string

Unique identifier describing the type of the OVF parameters. The value is the name of the OVF parameters structure. This field must be provided in the input parameters when deploying an OVF package. This field will always be present in the result when retrieving information about an OVF package.

optional variable_disk_size boolean

Whether the OVF uses variable disk sizes. For empty disks, rather than specifying a fixed virtual disk capacity, the capacity may be given using a reference to a ovf:Property element in a ovf:ProductSection element in OVF package.

This field is not used in the input parameters when deploying an OVF package. This field is optional in the result when retrieving information about an OVF package. If unset or false, the OVF does not use variable disk sizes.

Feedback

Was this page helpful?