OvfFileItem

OvfFileItem
OvfFileItem

An FileItem represents a file that must be uploaded by the caller when the inventory objects has been created in VI.

These objects are created by ResourcePool.importVApp.

Files can either be new files, in which case the "create" flag will be true, or updates to existing files in VI. The latter is used to support the OVF parentRef mechanism for Disks.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "deviceId": "string",
    "path": "string",
    "compressionMethod": "string",
    "chunkSize": 0,
    "size": 0,
    "cimType": 0,
    "create": false
}
string
deviceId
Required

Uniquely identifies the device (disk, CD-ROM etc.) within the entity hierarchy.

When ResourcePool.importVApp is called to create the VirtualMachines and VirtualApps, it returns a map, device ID -> URL, of where to upload the backing files.

string
path
Required

The path of the item to upload, relative to the path of the OVF descriptor.

string
compressionMethod
Optional

The compression method as specified by the OVF specification (for example "gzip" or "bzip2").

integer As int64 As int64
chunkSize
Optional

The chunksize as specified by the OVF specification.

If this attribute is set, the "path" attribute is a prefix to each chunk of the complete file. For example, if chunksize is 2000000000 bytes, the actual files might be: myfile.000000000 (2000000000 bytes) myfile.000000001 (2000000000 bytes) myfile.000000002 (1500000000 bytes)

integer As int64 As int64
size
Optional

The complete size of the file, if it is specified in the OVF descriptor.

integer As int32 As int32
cimType
Required

The CIM type of the device for which this file provides backing.

For example, the value 17 means "Disk drive".

boolean
create
Required

True if the item is not expected to exist in the infrastructure and should therefore be created by the caller (for example using HTTP PUT).