Data Object Description

An instance of this class is used to tell OvfManager about the choices the caller made about a file. This information is needed when the OVF descriptor is generated with createDescriptor.

Properties

Name	Type	Description
capacity*	xsd:long	The capacity of the disk backed by this file. This should only be set if the device backed by this file is a disk. This value will be written in the "capacity" attribute of the corresponding "Disk" element in the OVF descriptor. Note that the "capacity" attribute is normally set to the capacity of the corresponding VirtualDisk. Setting this variable overrides the capacity from the VirtualDisk. *Since* vSphere API 4.1
chunkSize*	xsd:long	The chunksize chosen by the caller. When using chunking, the caller must adhere to the method described in the OVF specification.
compressionMethod*	xsd:string	The compression method the caller chose to employ for this file.
deviceId	xsd:string	The ID of the device backed by this file. This ID uniquely identifies the device within the entity hierarchy. The caller will have received this along with the URL needed to download the file (this is handled by another service interface).
path	xsd:string	The path chosen by the caller for this file. This path becomes the value of the "href" attribute of the corresponding "File" element in the OVF descriptor. This path must be relative to the path chosen for the OVF descriptor. This implies that the caller must decide in advance on the path to which it will write the OVF descriptor, once it is returned. The folder separator must be "/" (forward slash). The path must not begin with a slash - ie. it must not be an absolute path.
populatedSize*	xsd:long	The populated size of the disk backed by this file. This should only be set if the device backed by this file is a disk. This value will be written in the "populatedSize" attribute of the corresponding "Disk" element in the OVF descriptor. *Since* vSphere API 4.1
size	xsd:long	The file size, as observed by the caller during download.
Properties inherited from DynamicData
None

Name

Type

Description

capacity*

xsd:long

The capacity of the disk backed by this file. This should only be set if the device backed by this file is a disk. This value will be written in the "capacity" attribute of the corresponding "Disk" element in the OVF descriptor.

Note that the "capacity" attribute is normally set to the capacity of the corresponding VirtualDisk. Setting this variable overrides the capacity from the VirtualDisk.

Since vSphere API 4.1

chunkSize*

xsd:long

The chunksize chosen by the caller.

When using chunking, the caller must adhere to the method described in the OVF specification.

compressionMethod*

xsd:string

The compression method the caller chose to employ for this file.

deviceId

xsd:string

The ID of the device backed by this file. This ID uniquely identifies the device within the entity hierarchy.

The caller will have received this along with the URL needed to download the file (this is handled by another service interface).

path

xsd:string

The path chosen by the caller for this file. This path becomes the value of the "href" attribute of the corresponding "File" element in the OVF descriptor.

This path must be relative to the path chosen for the OVF descriptor. This implies that the caller must decide in advance on the path to which it will write the OVF descriptor, once it is returned.

The folder separator must be "/" (forward slash).

The path must not begin with a slash - ie. it must not be an absolute path.

populatedSize*

xsd:long

The populated size of the disk backed by this file. This should only be set if the device backed by this file is a disk. This value will be written in the "populatedSize" attribute of the corresponding "Disk" element in the OVF descriptor.

Since vSphere API 4.1

size

xsd:long

The file size, as observed by the caller during download.

Properties inherited from DynamicData

None

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="OvfFile">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="deviceId" type="xsd:string"/>
                     <element name="path" type="xsd:string"/>
                     <element name="compressionMethod" type="xsd:string" minOccurs="0"/>
                     <element name="chunkSize" type="xsd:long" minOccurs="0"/>
                     <element name="size" type="xsd:long"/>
                     <element name="capacity" type="xsd:long" minOccurs="0"/>
                     <element name="populatedSize" type="xsd:long" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Feedback

1 2 3 4 5
0 Ratings

Data Object - OvfFile(vim.OvfManager.OvfFile)

Data Object Description

Feedback