VirtualBox Main API
|
Properties of a specific virtualization platform. More...
Public Member Functions | |
void | getMaxNetworkAdapters (in ChipsetType chipset, [retval] out unsigned long maxNetworkAdapters) |
Maximum total number of network adapters associated with every IMachine instance. | |
void | getMaxNetworkAdaptersOfType (in ChipsetType chipset, in NetworkAttachmentType type, [retval] out unsigned long maxNetworkAdapters) |
Maximum number of network adapters of a given attachment type, associated with every IMachine instance. | |
void | getMaxDevicesPerPortForStorageBus (in StorageBus bus, [retval] out unsigned long maxDevicesPerPort) |
Returns the maximum number of devices which can be attached to a port for the given storage bus. | |
void | getMinPortCountForStorageBus (in StorageBus bus, [retval] out unsigned long minPortCount) |
Returns the minimum number of ports the given storage bus supports. | |
void | getMaxPortCountForStorageBus (in StorageBus bus, [retval] out unsigned long maxPortCount) |
Returns the maximum number of ports the given storage bus supports. | |
void | getMaxInstancesOfStorageBus (in ChipsetType chipset, in StorageBus bus, [retval] out unsigned long maxInstances) |
Returns the maximum number of storage bus instances which can be configured for each VM. | |
void | getDeviceTypesForStorageBus (in StorageBus bus, [retval] out DeviceType[] deviceTypes) |
Returns list of all the supported device types (DeviceType) for the given type of storage bus. | |
void | getStorageBusForControllerType (in StorageControllerType storageControllerType, [retval] out StorageBus storageBus) |
Returns the StorageBus enum value for a given storage controller type. | |
void | getStorageControllerTypesForBus (in StorageBus storageBus, [retval] out StorageControllerType[] storageControllerType) |
Returns the possible StorageControllerType enum values for a given storage bus. | |
void | getStorageControllerHotplugCapable (in StorageControllerType controllerType, [retval] out boolean hotplugCapable) |
Returns whether the given storage controller supports hot-plugging devices. | |
void | getMaxInstancesOfUSBControllerType (in ChipsetType chipset, in USBControllerType type, [retval] out unsigned long maxInstances) |
Returns the maximum number of USB controller instances which can be configured for each VM. | |
Public Attributes | |
readonly attribute boolean | rawModeSupported |
Indicates whether VirtualBox was built with raw-mode support. | |
attribute boolean | exclusiveHwVirt |
Exclusive use of hardware virtualization by VirtualBox. | |
readonly attribute unsigned long | serialPortCount |
Maximum number of serial ports associated with every IMachine instance. | |
readonly attribute unsigned long | parallelPortCount |
Maximum number of parallel ports associated with every IMachine instance. | |
readonly attribute unsigned long | maxBootPosition |
Maximum device position in the boot order. | |
readonly attribute ParavirtProvider[] | supportedParavirtProviders |
Returns an array of officially supported values for enum ParavirtProvider, in the sense of what is e.g. | |
readonly attribute FirmwareType[] | supportedFirmwareTypes |
Returns an array of officially supported values for enum FirmwareType, in the sense of what is e.g. | |
readonly attribute IGuestOSType[] | supportedGuestOSTypes |
Returns an array of officially supported values for enum IGuestOSType, in the sense of what is e.g. | |
readonly attribute GraphicsControllerType[] | supportedGraphicsControllerTypes |
Returns an array of officially supported values for enum GraphicsControllerType, in the sense of what is e.g. | |
readonly attribute NetworkAdapterPromiscModePolicy[] | supportedNetAdpPromiscModePols |
Returns an array of officially supported values for enum NetworkAdapterPromiscModePolicy, in the sense of what is e.g. | |
readonly attribute NetworkAdapterType[] | supportedNetworkAdapterTypes |
Returns an array of officially supported values for enum NetworkAdapterType, in the sense of what is e.g. | |
readonly attribute UartType[] | supportedUartTypes |
Returns an array of officially supported values for enum UartType, in the sense of what is e.g. | |
readonly attribute USBControllerType[] | supportedUSBControllerTypes |
Returns an array of officially supported values for enum USBControllerType, in the sense of what is e.g. | |
readonly attribute AudioControllerType[] | supportedAudioControllerTypes |
Returns an array of officially supported values for enum AudioControllerType, in the sense of what is e.g. | |
readonly attribute DeviceType[] | supportedBootDevices |
Returns an array of officially supported boot devices for enum DeviceType, in the sense of what is e.g. | |
readonly attribute StorageBus[] | supportedStorageBuses |
Returns an array of officially supported values for enum StorageBus, in the sense of what is e.g. | |
readonly attribute StorageControllerType[] | supportedStorageControllerTypes |
Returns an array of officially supported values for enum StorageControllerType, in the sense of what is e.g. | |
readonly attribute ChipsetType[] | supportedChipsetTypes |
Returns an array of officially supported values for enum ChipsetType, in the sense of what is e.g. | |
readonly attribute IommuType[] | supportedIommuTypes |
Returns an array of officially supported values for enum IommuType, in the sense of what is e.g. | |
readonly attribute TpmType[] | supportedTpmTypes |
Returns an array of officially supported values for enum TpmType, in the sense of what is e.g. | |
Properties of a specific virtualization platform.
{45DEF725-AB32-4A0A-A85E-FAE56249D547}
void IPlatformProperties::getMaxNetworkAdapters | ( | in ChipsetType | chipset, |
[retval] out unsigned long | maxNetworkAdapters | ||
) |
Maximum total number of network adapters associated with every IMachine instance.
chipset | The chipset type to get the value for. |
maxNetworkAdapters | The maximum total number of network adapters allowed. |
void IPlatformProperties::getMaxNetworkAdaptersOfType | ( | in ChipsetType | chipset, |
in NetworkAttachmentType | type, | ||
[retval] out unsigned long | maxNetworkAdapters | ||
) |
Maximum number of network adapters of a given attachment type, associated with every IMachine instance.
chipset | The chipset type to get the value for. |
type | Type of attachment. |
maxNetworkAdapters | The maximum number of network adapters allowed for particular chipset and attachment type. |
void IPlatformProperties::getMaxDevicesPerPortForStorageBus | ( | in StorageBus | bus, |
[retval] out unsigned long | maxDevicesPerPort | ||
) |
Returns the maximum number of devices which can be attached to a port for the given storage bus.
bus | The storage bus type to get the value for. |
maxDevicesPerPort | The maximum number of devices which can be attached to the port for the given storage bus. |
void IPlatformProperties::getMinPortCountForStorageBus | ( | in StorageBus | bus, |
[retval] out unsigned long | minPortCount | ||
) |
Returns the minimum number of ports the given storage bus supports.
bus | The storage bus type to get the value for. |
minPortCount | The minimum number of ports for the given storage bus. |
void IPlatformProperties::getMaxPortCountForStorageBus | ( | in StorageBus | bus, |
[retval] out unsigned long | maxPortCount | ||
) |
Returns the maximum number of ports the given storage bus supports.
bus | The storage bus type to get the value for. |
maxPortCount | The maximum number of ports for the given storage bus. |
void IPlatformProperties::getMaxInstancesOfStorageBus | ( | in ChipsetType | chipset, |
in StorageBus | bus, | ||
[retval] out unsigned long | maxInstances | ||
) |
Returns the maximum number of storage bus instances which can be configured for each VM.
This corresponds to the number of storage controllers one can have. Value may depend on chipset type used.
chipset | The chipset type to get the value for. |
bus | The storage bus type to get the value for. |
maxInstances | The maximum number of instances for the given storage bus. |
void IPlatformProperties::getDeviceTypesForStorageBus | ( | in StorageBus | bus, |
[retval] out DeviceType[] | deviceTypes | ||
) |
Returns list of all the supported device types (DeviceType) for the given type of storage bus.
bus | The storage bus type to get the value for. |
deviceTypes | The list of all supported device types for the given storage bus. |
void IPlatformProperties::getStorageBusForControllerType | ( | in StorageControllerType | storageControllerType, |
[retval] out StorageBus | storageBus | ||
) |
Returns the StorageBus enum value for a given storage controller type.
storageControllerType | The storage controller type to get the value for. |
storageBus | The storage bus which is applicable. |
void IPlatformProperties::getStorageControllerTypesForBus | ( | in StorageBus | storageBus, |
[retval] out StorageControllerType[] | storageControllerType | ||
) |
Returns the possible StorageControllerType enum values for a given storage bus.
storageBus | The storage bus type to get the values for. |
storageControllerType | The enum values (sorted by what should be a sensible decreasing importance of the type) which are valid. |
void IPlatformProperties::getStorageControllerHotplugCapable | ( | in StorageControllerType | controllerType, |
[retval] out boolean | hotplugCapable | ||
) |
Returns whether the given storage controller supports hot-plugging devices.
controllerType | The storage controller to check the setting for. |
hotplugCapable | Returned flag indicating whether the controller is hotplug capable |
void IPlatformProperties::getMaxInstancesOfUSBControllerType | ( | in ChipsetType | chipset, |
in USBControllerType | type, | ||
[retval] out unsigned long | maxInstances | ||
) |
Returns the maximum number of USB controller instances which can be configured for each VM.
This corresponds to the number of USB controllers one can have. Value may depend on chipset type used.
chipset | The chipset type to get the value for. |
type | The USB controller type to get the value for. |
maxInstances | The maximum number of instances for the given USB controller type. |
readonly attribute boolean IPlatformProperties::rawModeSupported |
Indicates whether VirtualBox was built with raw-mode support.
When this reads as False, the HWVirtExPropertyType_Enabled setting will be ignored and assumed to be True.
attribute boolean IPlatformProperties::exclusiveHwVirt |
Exclusive use of hardware virtualization by VirtualBox.
When enabled, VirtualBox assumes it can obtain full and exclusive access to the VT-x or AMD-V feature of the host. To share hardware virtualization with other hypervisors, this property must be disabled.
readonly attribute unsigned long IPlatformProperties::serialPortCount |
Maximum number of serial ports associated with every IMachine instance.
readonly attribute unsigned long IPlatformProperties::parallelPortCount |
Maximum number of parallel ports associated with every IMachine instance.
readonly attribute unsigned long IPlatformProperties::maxBootPosition |
Maximum device position in the boot order.
This value corresponds to the total number of devices a machine can boot from, to make it possible to include all possible devices to the boot list.
readonly attribute ParavirtProvider [] IPlatformProperties::supportedParavirtProviders |
Returns an array of officially supported values for enum ParavirtProvider, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute FirmwareType [] IPlatformProperties::supportedFirmwareTypes |
Returns an array of officially supported values for enum FirmwareType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute IGuestOSType [] IPlatformProperties::supportedGuestOSTypes |
Returns an array of officially supported values for enum IGuestOSType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute GraphicsControllerType [] IPlatformProperties::supportedGraphicsControllerTypes |
Returns an array of officially supported values for enum GraphicsControllerType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute NetworkAdapterPromiscModePolicy [] IPlatformProperties::supportedNetAdpPromiscModePols |
Returns an array of officially supported values for enum NetworkAdapterPromiscModePolicy, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute NetworkAdapterType [] IPlatformProperties::supportedNetworkAdapterTypes |
Returns an array of officially supported values for enum NetworkAdapterType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute UartType [] IPlatformProperties::supportedUartTypes |
Returns an array of officially supported values for enum UartType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute USBControllerType [] IPlatformProperties::supportedUSBControllerTypes |
Returns an array of officially supported values for enum USBControllerType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute AudioControllerType [] IPlatformProperties::supportedAudioControllerTypes |
Returns an array of officially supported values for enum AudioControllerType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute DeviceType [] IPlatformProperties::supportedBootDevices |
Returns an array of officially supported boot devices for enum DeviceType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
The returned array also defines the default boot device order for all supported devices.
readonly attribute StorageBus [] IPlatformProperties::supportedStorageBuses |
Returns an array of officially supported values for enum StorageBus, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute StorageControllerType [] IPlatformProperties::supportedStorageControllerTypes |
Returns an array of officially supported values for enum StorageControllerType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute ChipsetType [] IPlatformProperties::supportedChipsetTypes |
Returns an array of officially supported values for enum ChipsetType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.
readonly attribute IommuType [] IPlatformProperties::supportedIommuTypes |
Returns an array of officially supported values for enum IommuType, in the sense of what is e.g.
worth offering in the VirtualBox GUI.