org.virtualbox_7_1
Class IPlatformProperties

java.lang.Object
  extended by org.virtualbox_7_1.IUnknown
      extended by org.virtualbox_7_1.IPlatformProperties

public class IPlatformProperties
extends IUnknown

Properties of a specific virtualization platform. Interface ID: {45DEF725-AB32-4A0A-A85E-FAE56249D547}


Field Summary
 
Fields inherited from class org.virtualbox_7_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IPlatformProperties(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
           
 
Method Summary
 java.util.List<DeviceType> getDeviceTypesForStorageBus(StorageBus bus)
          Returns list of all the supported device types (DeviceType) for the given type of storage bus.
 java.lang.Boolean getExclusiveHwVirt()
          Exclusive use of hardware virtualization by VirtualBox.
 java.lang.Long getMaxBootPosition()
          Maximum device position in the boot order.
 java.lang.Long getMaxDevicesPerPortForStorageBus(StorageBus bus)
          Returns the maximum number of devices which can be attached to a port for the given storage bus.
 java.lang.Long getMaxInstancesOfStorageBus(ChipsetType chipset, StorageBus bus)
          Returns the maximum number of storage bus instances which can be configured for each VM.
 java.lang.Long getMaxInstancesOfUSBControllerType(ChipsetType chipset, USBControllerType type)
          Returns the maximum number of USB controller instances which can be configured for each VM.
 java.lang.Long getMaxNetworkAdapters(ChipsetType chipset)
          Maximum total number of network adapters associated with everyIMachineinstance.
 java.lang.Long getMaxNetworkAdaptersOfType(ChipsetType chipset, NetworkAttachmentType type)
          Maximum number of network adapters of a given attachment type, associated with everyIMachineinstance.
 java.lang.Long getMaxPortCountForStorageBus(StorageBus bus)
          Returns the maximum number of ports the given storage bus supports.
 java.lang.Long getMinPortCountForStorageBus(StorageBus bus)
          Returns the minimum number of ports the given storage bus supports.
 java.lang.Long getParallelPortCount()
          Maximum number of parallel ports associated with everyIMachineinstance.
 java.lang.Boolean getRawModeSupported()
          Indicates whether VirtualBox was built with raw-mode support.
 java.lang.Long getSerialPortCount()
          Maximum number of serial ports associated with everyIMachineinstance.
 StorageBus getStorageBusForControllerType(StorageControllerType storageControllerType)
          Returns theStorageBusenum value for a given storage controller type.
 java.lang.Boolean getStorageControllerHotplugCapable(StorageControllerType controllerType)
          Returns whether the given storage controller supports hot-plugging devices.
 java.util.List<StorageControllerType> getStorageControllerTypesForBus(StorageBus storageBus)
          Returns the possibleStorageControllerTypeenum values for a given storage bus.
 java.util.List<AudioControllerType> getSupportedAudioControllerTypes()
          Returns an array of officially supported values for enumAudioControllerType, in the sense of what is e.g.
 java.util.List<DeviceType> getSupportedBootDevices()
          Returns an array of officially supported boot devices for enumDeviceType, in the sense of what is e.g.
 java.util.List<ChipsetType> getSupportedChipsetTypes()
          Returns an array of officially supported values for enumChipsetType, in the sense of what is e.g.
 java.util.List<FirmwareType> getSupportedFirmwareTypes()
          Returns an array of officially supported values for enumFirmwareType, in the sense of what is e.g.
 java.util.List<GraphicsControllerType> getSupportedGraphicsControllerTypes()
          Returns an array of officially supported values for enumGraphicsControllerType, in the sense of what is e.g.
 java.util.List<IGuestOSType> getSupportedGuestOSTypes()
          Returns an array of officially supported values for enumIGuestOSType, in the sense of what is e.g.
 java.util.List<IommuType> getSupportedIommuTypes()
          Returns an array of officially supported values for enumIommuType, in the sense of what is e.g.
 java.util.List<NetworkAdapterPromiscModePolicy> getSupportedNetAdpPromiscModePols()
          Returns an array of officially supported values for enumNetworkAdapterPromiscModePolicy, in the sense of what is e.g.
 java.util.List<NetworkAdapterType> getSupportedNetworkAdapterTypes()
          Returns an array of officially supported values for enumNetworkAdapterType, in the sense of what is e.g.
 java.util.List<ParavirtProvider> getSupportedParavirtProviders()
          Returns an array of officially supported values for enumParavirtProvider, in the sense of what is e.g.
 java.util.List<StorageBus> getSupportedStorageBuses()
          Returns an array of officially supported values for enumStorageBus, in the sense of what is e.g.
 java.util.List<StorageControllerType> getSupportedStorageControllerTypes()
          Returns an array of officially supported values for enumStorageControllerType, in the sense of what is e.g.
 java.util.List<TpmType> getSupportedTpmTypes()
          Returns an array of officially supported values for enumTpmType, in the sense of what is e.g.
 java.util.List<UartType> getSupportedUartTypes()
          Returns an array of officially supported values for enumUartType, in the sense of what is e.g.
 java.util.List<USBControllerType> getSupportedUSBControllerTypes()
          Returns an array of officially supported values for enumUSBControllerType, in the sense of what is e.g.
static IPlatformProperties queryInterface(IUnknown obj)
           
 void setExclusiveHwVirt(java.lang.Boolean value)
          Exclusive use of hardware virtualization by VirtualBox.
 
Methods inherited from class org.virtualbox_7_1.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IPlatformProperties

public IPlatformProperties(java.lang.String wrapped,
                           org.virtualbox_7_1.ObjectRefManager objMgr,
                           org.virtualbox_7_1.jaxws.VboxPortType port)
Method Detail

getRawModeSupported

public java.lang.Boolean getRawModeSupported()
Indicates whether VirtualBox was built with raw-mode support. When this reads as False, theHWVirtExPropertyType.Enabledsetting will be ignored and assumed to be True. NOTE: For guest platform properties, this attribute is being ignored.

Returns:
Boolean

getExclusiveHwVirt

public java.lang.Boolean getExclusiveHwVirt()
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. NOTE: For hosts running on macOS this is being ignored, as the kernel mediates hardware access there. NOTE: For guest platform properties, this attribute is being ignored.

Returns:
Boolean

setExclusiveHwVirt

public void setExclusiveHwVirt(java.lang.Boolean value)
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. NOTE: For hosts running on macOS this is being ignored, as the kernel mediates hardware access there. NOTE: For guest platform properties, this attribute is being ignored.

Parameters:
value - Boolean

getSerialPortCount

public java.lang.Long getSerialPortCount()
Maximum number of serial ports associated with everyIMachineinstance.

Returns:
Long

getParallelPortCount

public java.lang.Long getParallelPortCount()
Maximum number of parallel ports associated with everyIMachineinstance.

Returns:
Long

getMaxBootPosition

public java.lang.Long getMaxBootPosition()
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.

Returns:
Long
See Also:
IMachine.setBootOrder(Long,org.virtualbox_7_1.DeviceType)

getSupportedParavirtProviders

public java.util.List<ParavirtProvider> getSupportedParavirtProviders()
Returns an array of officially supported values for enumParavirtProvider, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.ParavirtProvider>

getSupportedFirmwareTypes

public java.util.List<FirmwareType> getSupportedFirmwareTypes()
Returns an array of officially supported values for enumFirmwareType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.FirmwareType>

getSupportedGuestOSTypes

public java.util.List<IGuestOSType> getSupportedGuestOSTypes()
Returns an array of officially supported values for enumIGuestOSType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.IGuestOSType>

getSupportedGraphicsControllerTypes

public java.util.List<GraphicsControllerType> getSupportedGraphicsControllerTypes()
Returns an array of officially supported values for enumGraphicsControllerType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.GraphicsControllerType>

getSupportedNetAdpPromiscModePols

public java.util.List<NetworkAdapterPromiscModePolicy> getSupportedNetAdpPromiscModePols()
Returns an array of officially supported values for enumNetworkAdapterPromiscModePolicy, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.NetworkAdapterPromiscModePolicy>

getSupportedNetworkAdapterTypes

public java.util.List<NetworkAdapterType> getSupportedNetworkAdapterTypes()
Returns an array of officially supported values for enumNetworkAdapterType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.NetworkAdapterType>

getSupportedUartTypes

public java.util.List<UartType> getSupportedUartTypes()
Returns an array of officially supported values for enumUartType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.UartType>

getSupportedUSBControllerTypes

public java.util.List<USBControllerType> getSupportedUSBControllerTypes()
Returns an array of officially supported values for enumUSBControllerType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.USBControllerType>

getSupportedAudioControllerTypes

public java.util.List<AudioControllerType> getSupportedAudioControllerTypes()
Returns an array of officially supported values for enumAudioControllerType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.AudioControllerType>

getSupportedBootDevices

public java.util.List<DeviceType> getSupportedBootDevices()
Returns an array of officially supported boot devices for enumDeviceType, 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.

Returns:
List<org.virtualbox_7_1.DeviceType>

getSupportedStorageBuses

public java.util.List<StorageBus> getSupportedStorageBuses()
Returns an array of officially supported values for enumStorageBus, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.StorageBus>

getSupportedStorageControllerTypes

public java.util.List<StorageControllerType> getSupportedStorageControllerTypes()
Returns an array of officially supported values for enumStorageControllerType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.StorageControllerType>

getSupportedChipsetTypes

public java.util.List<ChipsetType> getSupportedChipsetTypes()
Returns an array of officially supported values for enumChipsetType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.ChipsetType>

getSupportedIommuTypes

public java.util.List<IommuType> getSupportedIommuTypes()
Returns an array of officially supported values for enumIommuType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.IommuType>

getSupportedTpmTypes

public java.util.List<TpmType> getSupportedTpmTypes()
Returns an array of officially supported values for enumTpmType, in the sense of what is e.g. worth offering in the VirtualBox GUI.

Returns:
List<org.virtualbox_7_1.TpmType>

queryInterface

public static IPlatformProperties queryInterface(IUnknown obj)

getMaxNetworkAdapters

public java.lang.Long getMaxNetworkAdapters(ChipsetType chipset)
Maximum total number of network adapters associated with everyIMachineinstance.

Parameters:
chipset - The chipset type to get the value for.
Returns:
The maximum total number of network adapters allowed.

getMaxNetworkAdaptersOfType

public java.lang.Long getMaxNetworkAdaptersOfType(ChipsetType chipset,
                                                  NetworkAttachmentType type)
Maximum number of network adapters of a given attachment type, associated with everyIMachineinstance.

Parameters:
chipset - The chipset type to get the value for.
type - Type of attachment.
Returns:
The maximum number of network adapters allowed for particular chipset and attachment type.

getMaxDevicesPerPortForStorageBus

public java.lang.Long getMaxDevicesPerPortForStorageBus(StorageBus bus)
Returns the maximum number of devices which can be attached to a port for the given storage bus.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The maximum number of devices which can be attached to the port for the given storage bus.

getMinPortCountForStorageBus

public java.lang.Long getMinPortCountForStorageBus(StorageBus bus)
Returns the minimum number of ports the given storage bus supports.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The minimum number of ports for the given storage bus.

getMaxPortCountForStorageBus

public java.lang.Long getMaxPortCountForStorageBus(StorageBus bus)
Returns the maximum number of ports the given storage bus supports.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The maximum number of ports for the given storage bus.

getMaxInstancesOfStorageBus

public java.lang.Long getMaxInstancesOfStorageBus(ChipsetType chipset,
                                                  StorageBus bus)
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.

Parameters:
chipset - The chipset type to get the value for.
bus - The storage bus type to get the value for.
Returns:
The maximum number of instances for the given storage bus.

getDeviceTypesForStorageBus

public java.util.List<DeviceType> getDeviceTypesForStorageBus(StorageBus bus)
Returns list of all the supported device types (DeviceType) for the given type of storage bus.

Parameters:
bus - The storage bus type to get the value for.
Returns:
The list of all supported device types for the given storage bus.

getStorageBusForControllerType

public StorageBus getStorageBusForControllerType(StorageControllerType storageControllerType)
Returns theStorageBusenum value for a given storage controller type.

Parameters:
storageControllerType - The storage controller type to get the value for.
Returns:
The storage bus which is applicable.

getStorageControllerTypesForBus

public java.util.List<StorageControllerType> getStorageControllerTypesForBus(StorageBus storageBus)
Returns the possibleStorageControllerTypeenum values for a given storage bus.

Parameters:
storageBus - The storage bus type to get the values for.
Returns:
The enum values (sorted by what should be a sensible decreasing importance of the type) which are valid.

getStorageControllerHotplugCapable

public java.lang.Boolean getStorageControllerHotplugCapable(StorageControllerType controllerType)
Returns whether the given storage controller supports hot-plugging devices.

Parameters:
controllerType - The storage controller to check the setting for.
Returns:
Returned flag indicating whether the controller is hotplug capable

getMaxInstancesOfUSBControllerType

public java.lang.Long getMaxInstancesOfUSBControllerType(ChipsetType chipset,
                                                         USBControllerType type)
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.

Parameters:
chipset - The chipset type to get the value for.
type - The USB controller type to get the value for.
Returns:
The maximum number of instances for the given USB controller type.