VirtualBox Main API
|
Represents one virtual system (machine) in an appliance. More...
Public Member Functions | |
void | getDescription (out VirtualSystemDescriptionType[] types, out wstring[] refs, out wstring[] OVFValues, out wstring[] VBoxValues, out wstring[] extraConfigValues) |
Returns information about the virtual system as arrays of instruction items. | |
void | getDescriptionByType (in VirtualSystemDescriptionType type, out VirtualSystemDescriptionType[] types, out wstring[] refs, out wstring[] OVFValues, out wstring[] VBoxValues, out wstring[] extraConfigValues) |
This is the same as getDescription except that you can specify which types should be returned. | |
void | removeDescriptionByType (in VirtualSystemDescriptionType type) |
Delete all records which are equal to the passed type from the list. | |
void | getValuesByType (in VirtualSystemDescriptionType type, in VirtualSystemDescriptionValueType which, [retval] out wstring[] values) |
This is the same as getDescriptionByType except that you can specify which value types should be returned. | |
void | setFinalValues (in boolean[] enabled, in wstring[] VBoxValues, in wstring[] extraConfigValues) |
This method allows the appliance's user to change the configuration for the virtual system descriptions. | |
void | addDescription (in VirtualSystemDescriptionType type, in wstring VBoxValue, in wstring extraConfigValue) |
This method adds an additional description entry to the stack of already available descriptions for this virtual system. | |
Public Attributes | |
readonly attribute unsigned long | count |
Return the number of virtual system description entries. | |
Represents one virtual system (machine) in an appliance.
This interface is used in the IAppliance::virtualSystemDescriptions array. After IAppliance::interpret has been called, that array contains information about how the virtual systems described in the OVF should best be imported into VirtualBox virtual machines. See IAppliance for the steps required to import an OVF into VirtualBox.
{01510F40-C196-4D26-B8DB-4C8C389F1F82}
void IVirtualSystemDescription::getDescription | ( | out VirtualSystemDescriptionType[] | types, |
out wstring[] | refs, | ||
out wstring[] | OVFValues, | ||
out wstring[] | VBoxValues, | ||
out wstring[] | extraConfigValues | ||
) |
Returns information about the virtual system as arrays of instruction items.
In each array, the items with the same indices correspond and jointly represent an import instruction for VirtualBox.
The list below identifies the value sets that are possible depending on the VirtualSystemDescriptionType enum value in the array item in aTypes[]. In each case, the array item with the same index in OVFValues[] will contain the original value as contained in the OVF file (just for informational purposes), and the corresponding item in aVBoxValues[] will contain a suggested value to be used for VirtualBox. Depending on the description type, the aExtraConfigValues[] array item may also be used.
"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
The array item in OVFValues[] will contain the file specification from the OVF file (without a path since the image file should be in the same location as the OVF file itself), whereas the item in aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the hard disk image. This means that on import the image will be copied and converted from the "ovf" location to the "vbox" location; on export, this will be handled the other way round.
The matching item in the aExtraConfigValues[] array must contain a string of the following format: "controller=<index>;channel=<c>" In this string, <index> must be an integer specifying the hard disk controller to connect the image to. That number must be the index of an array item with one of the hard disk controller types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE). In addition, <c> must specify the channel to use on that controller. For IDE controllers, this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
types | |
refs | |
OVFValues | |
VBoxValues | |
extraConfigValues |
void IVirtualSystemDescription::getDescriptionByType | ( | in VirtualSystemDescriptionType | type, |
out VirtualSystemDescriptionType[] | types, | ||
out wstring[] | refs, | ||
out wstring[] | OVFValues, | ||
out wstring[] | VBoxValues, | ||
out wstring[] | extraConfigValues | ||
) |
This is the same as getDescription except that you can specify which types should be returned.
type | |
types | |
refs | |
OVFValues | |
VBoxValues | |
extraConfigValues |
void IVirtualSystemDescription::removeDescriptionByType | ( | in VirtualSystemDescriptionType | type | ) |
Delete all records which are equal to the passed type from the list.
type |
void IVirtualSystemDescription::getValuesByType | ( | in VirtualSystemDescriptionType | type, |
in VirtualSystemDescriptionValueType | which, | ||
[retval] out wstring[] | values | ||
) |
This is the same as getDescriptionByType except that you can specify which value types should be returned.
See VirtualSystemDescriptionValueType for possible values.
type | |
which | |
values |
void IVirtualSystemDescription::setFinalValues | ( | in boolean[] | enabled, |
in wstring[] | VBoxValues, | ||
in wstring[] | extraConfigValues | ||
) |
This method allows the appliance's user to change the configuration for the virtual system descriptions.
For each array item returned from getDescription, you must pass in one boolean value and one configuration value.
Each item in the boolean array determines whether the particular configuration item should be enabled. You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA, HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController and SoundCard.
For the "vbox" and "extra configuration" values, if you pass in the same arrays as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription, the configuration remains unchanged. Please see the documentation for getDescription for valid configuration values for the individual array item types. If the corresponding item in the aEnabled array is false
, the configuration value is ignored.
enabled | |
VBoxValues | |
extraConfigValues |
void IVirtualSystemDescription::addDescription | ( | in VirtualSystemDescriptionType | type, |
in wstring | VBoxValue, | ||
in wstring | extraConfigValue | ||
) |
This method adds an additional description entry to the stack of already available descriptions for this virtual system.
This is handy for writing values which aren't directly supported by VirtualBox. One example would be the License type of VirtualSystemDescriptionType.
type | |
VBoxValue | |
extraConfigValue |
readonly attribute unsigned long IVirtualSystemDescription::count |
Return the number of virtual system description entries.