OvfCreateDescriptorParams

OvfCreateDescriptorParams
OvfCreateDescriptorParams

Collection of parameters for createDescriptor

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "ovfFiles": [
        {
            "_typeName": "string",
            "deviceId": "string",
            "path": "string",
            "compressionMethod": "string",
            "chunkSize": 0,
            "size": 0,
            "capacity": 0,
            "populatedSize": 0
        }
    ],
    "name": "string",
    "description": "string",
    "includeImageFiles": false,
    "exportOption": [
        "string"
    ],
    "snapshot": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
array of OvfFile
ovfFiles
Optional

Contains information about the files of the entity, if they have already been downloaded.

Needed to construct the References section of the descriptor.

OvfFile is a positive list of files to include in the export. An Empty list will do no filtering.

string
name
Optional

The ovf:id to use for the top-level OVF Entity.

If unset, the entity's product name is used if available. Otherwise, the VI entity name is used.

string
description
Optional

The contents of the Annontation section of the top-level OVF Entity.

If unset, any existing annotation on the entity is left unchanged.

boolean
includeImageFiles
Optional

Controls whether attached image files should be included in the descriptor.

This applies to image files attached to VirtualCdrom and VirtualFloppy.

array of string
exportOption
Optional

An optional argument for modifying the export process.

The option is used to control what extra information that will be included in the OVF descriptor.

To get a list of supported keywords see ovfExportOption. Unknown options will be ignored by the server.

snapshot
Optional

Reference to an instance of the VirtualMachineSnapshot managed object.