|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_5_1.IUnknown
org.virtualbox_5_1.ISystemProperties
public class ISystemProperties
The ISystemProperties interface represents global properties of the given VirtualBox installation. These properties define limits and default values for various attributes and parameters. Most of the properties are read-only, but some can be changed by a user. Interface ID: {0EB668D2-495E-5A36-8890-29999B5F030C}
Field Summary |
---|
Fields inherited from class org.virtualbox_5_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
ISystemProperties(java.lang.String wrapped,
org.virtualbox_5_1.ObjectRefManager objMgr,
org.virtualbox_5_1.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
java.lang.String |
getAutostartDatabasePath()
The path to the autostart database. |
java.lang.String |
getDefaultAdditionsISO()
The path to the default Guest Additions ISO image. |
AudioDriverType |
getDefaultAudioDriver()
This value hold the default audio driver for the current system. |
java.lang.String |
getDefaultFrontend()
Selects which VM frontend should be used by default when launching a VM through the IMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String) method. |
java.lang.String |
getDefaultHardDiskFormat()
Identifier of the default medium format used by VirtualBox. |
java.lang.Boolean |
getDefaultIoCacheSettingForStorageController(StorageControllerType controllerType)
Returns the default I/O cache setting for the given storage controller |
java.lang.String |
getDefaultMachineFolder()
Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path. |
java.lang.String |
getDefaultVRDEExtPack()
The name of the extension pack providing the default VRDE. |
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 |
getFreeDiskSpaceError()
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes. |
java.lang.Long |
getFreeDiskSpacePercentError()
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage. |
java.lang.Long |
getFreeDiskSpacePercentWarning()
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage. |
java.lang.Long |
getFreeDiskSpaceWarning()
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes. |
java.lang.Long |
getInfoVDSize()
Maximum size of a virtual disk image in bytes. |
java.lang.String |
getLoggingLevel()
Specifies the logging level in current use by VirtualBox. |
java.lang.Long |
getLogHistoryCount()
This value specifies how many old release log files are kept. |
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 |
getMaxGuestCPUCount()
Maximum CPU count. |
java.lang.Long |
getMaxGuestMonitors()
Maximum of monitors which could be connected. |
java.lang.Long |
getMaxGuestRAM()
Maximum guest system memory in Megabytes. |
java.lang.Long |
getMaxGuestVRAM()
Maximum guest video memory in Megabytes. |
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 every IMachine instance. |
java.lang.Long |
getMaxNetworkAdaptersOfType(ChipsetType chipset,
NetworkAttachmentType type)
Maximum number of network adapters of a given attachment type, associated with every IMachine instance. |
java.lang.Long |
getMaxPortCountForStorageBus(StorageBus bus)
Returns the maximum number of ports the given storage bus supports. |
java.util.List<IMediumFormat> |
getMediumFormats()
List of all medium storage formats supported by this VirtualBox installation. |
java.lang.Long |
getMinGuestCPUCount()
Minimum CPU count. |
java.lang.Long |
getMinGuestRAM()
Minimum guest system memory in Megabytes. |
java.lang.Long |
getMinGuestVRAM()
Minimum guest video memory in Megabytes. |
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 every IMachine instance. |
java.lang.Boolean |
getRawModeSupported()
Indicates whether VirtualBox was built with raw-mode support. |
java.util.List<BitmapFormat> |
getScreenShotFormats()
Supported bitmap formats which can be used with takeScreenShot and takeScreenShotToArray methods. |
java.lang.Long |
getSerialPortCount()
Maximum number of serial ports associated with every IMachine instance. |
java.lang.Boolean |
getStorageControllerHotplugCapable(StorageControllerType controllerType)
Returns whether the given storage controller supports hot-plugging devices. |
java.lang.String |
getVRDEAuthLibrary()
Library that provides authentication for Remote Desktop clients. |
java.lang.String |
getWebServiceAuthLibrary()
Library that provides authentication for webservice clients. |
static ISystemProperties |
queryInterface(IUnknown obj)
|
void |
setAutostartDatabasePath(java.lang.String value)
The path to the autostart database. |
void |
setDefaultAdditionsISO(java.lang.String value)
The path to the default Guest Additions ISO image. |
void |
setDefaultFrontend(java.lang.String value)
Selects which VM frontend should be used by default when launching a VM through the IMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String) method. |
void |
setDefaultHardDiskFormat(java.lang.String value)
Identifier of the default medium format used by VirtualBox. |
void |
setDefaultMachineFolder(java.lang.String value)
Full path to the default directory used to create new or open existing machines when a machine settings file name contains no path. |
void |
setDefaultVRDEExtPack(java.lang.String value)
The name of the extension pack providing the default VRDE. |
void |
setExclusiveHwVirt(java.lang.Boolean value)
Exclusive use of hardware virtualization by VirtualBox. |
void |
setFreeDiskSpaceError(java.lang.Long value)
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes. |
void |
setFreeDiskSpacePercentError(java.lang.Long value)
Issue an error if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage. |
void |
setFreeDiskSpacePercentWarning(java.lang.Long value)
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given percentage. |
void |
setFreeDiskSpaceWarning(java.lang.Long value)
Issue a warning if the free disk space is below (or in some disk intensive operation is expected to go below) the given size in bytes. |
void |
setLoggingLevel(java.lang.String value)
Specifies the logging level in current use by VirtualBox. |
void |
setLogHistoryCount(java.lang.Long value)
This value specifies how many old release log files are kept. |
void |
setVRDEAuthLibrary(java.lang.String value)
Library that provides authentication for Remote Desktop clients. |
void |
setWebServiceAuthLibrary(java.lang.String value)
Library that provides authentication for webservice clients. |
Methods inherited from class org.virtualbox_5_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 |
---|
public ISystemProperties(java.lang.String wrapped, org.virtualbox_5_1.ObjectRefManager objMgr, org.virtualbox_5_1.jaxws.VboxPortType port)
Method Detail |
---|
public java.lang.Long getMinGuestRAM()
public java.lang.Long getMaxGuestRAM()
public java.lang.Long getMinGuestVRAM()
public java.lang.Long getMaxGuestVRAM()
public java.lang.Long getMinGuestCPUCount()
public java.lang.Long getMaxGuestCPUCount()
public java.lang.Long getMaxGuestMonitors()
public java.lang.Long getInfoVDSize()
public java.lang.Long getSerialPortCount()
IMachine
instance.
public java.lang.Long getParallelPortCount()
IMachine
instance.
public java.lang.Long getMaxBootPosition()
IMachine.setBootOrder(Long,org.virtualbox_5_1.DeviceType)
public java.lang.Boolean getRawModeSupported()
HWVirtExPropertyType.Enabled
setting will be ignored and assumed to be True.
public java.lang.Boolean getExclusiveHwVirt()
public void setExclusiveHwVirt(java.lang.Boolean value)
value
- Booleanpublic java.lang.String getDefaultMachineFolder()
IVirtualBox.createMachine(String,String,List,String,String)
,
IVirtualBox.openMachine(String)
public void setDefaultMachineFolder(java.lang.String value)
value
- StringIVirtualBox.createMachine(String,String,List,String,String)
,
IVirtualBox.openMachine(String)
public java.lang.String getLoggingLevel()
public void setLoggingLevel(java.lang.String value)
value
- Stringpublic java.util.List<IMediumFormat> getMediumFormats()
IMediumFormat.getId()
) used in other API calls likeIVirtualBox.createMedium(String,String,org.virtualbox_5_1.AccessMode,org.virtualbox_5_1.DeviceType)
to refer to a particular
medium format is a case-insensitive string. This means that, for
example, all of the following strings:"VDI" "vdi" "VdI"refer to the same medium format. Note that the virtual medium framework is backend-based, therefore the list of supported formats depends on what backends are currently installed.
IMediumFormat
public java.lang.String getDefaultHardDiskFormat()
IVirtualBox.createMedium(String,String,org.virtualbox_5_1.AccessMode,org.virtualbox_5_1.DeviceType)
with the empty
format argument. A more complex example is implicit creation of
differencing media when taking a snapshot of a virtual machine:
this operation will try to use a format of the parent medium first
and if this format does not support differencing media the default
format specified by this argument will be used.
The list of supported medium formats may be obtained by thegetMediumFormats()
call. Note that the default medium
format must have a capability to create differencing media;
otherwise operations that create media implicitly may fail
unexpectedly.
The initial value of this property is"VDI"in the current
version of the VirtualBox product, but may change in the future.
NOTE: Setting this property to null or empty string will restore the
initial value.
getMediumFormats()
,
IMediumFormat.getId()
,
IVirtualBox.createMedium(String,String,org.virtualbox_5_1.AccessMode,org.virtualbox_5_1.DeviceType)
public void setDefaultHardDiskFormat(java.lang.String value)
IVirtualBox.createMedium(String,String,org.virtualbox_5_1.AccessMode,org.virtualbox_5_1.DeviceType)
with the empty
format argument. A more complex example is implicit creation of
differencing media when taking a snapshot of a virtual machine:
this operation will try to use a format of the parent medium first
and if this format does not support differencing media the default
format specified by this argument will be used.
The list of supported medium formats may be obtained by thegetMediumFormats()
call. Note that the default medium
format must have a capability to create differencing media;
otherwise operations that create media implicitly may fail
unexpectedly.
The initial value of this property is"VDI"in the current
version of the VirtualBox product, but may change in the future.
NOTE: Setting this property to null or empty string will restore the
initial value.
value
- StringgetMediumFormats()
,
IMediumFormat.getId()
,
IVirtualBox.createMedium(String,String,org.virtualbox_5_1.AccessMode,org.virtualbox_5_1.DeviceType)
public java.lang.Long getFreeDiskSpaceWarning()
public void setFreeDiskSpaceWarning(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpacePercentWarning()
public void setFreeDiskSpacePercentWarning(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpaceError()
public void setFreeDiskSpaceError(java.lang.Long value)
value
- Longpublic java.lang.Long getFreeDiskSpacePercentError()
public void setFreeDiskSpacePercentError(java.lang.Long value)
value
- Longpublic java.lang.String getVRDEAuthLibrary()
public void setVRDEAuthLibrary(java.lang.String value)
value
- Stringpublic java.lang.String getWebServiceAuthLibrary()
IWebsessionManager.logon(String,String)
implementation.
As opposed togetVRDEAuthLibrary()
,
there is no per-VM setting for this, as the webservice is a global
resource (if it is running). Only for this setting (for the webservice),
setting this value to a literal"null"string disables authentication,
meaning thatIWebsessionManager.logon(String,String)
will always succeed,
no matter what user name and password are supplied.
The initial value of this property is"VBoxAuth",
meaning that the webservice will use the same authentication
library that is used by default for VRDE (again, seegetVRDEAuthLibrary()
).
The format and calling convention of authentication libraries
is the same for the webservice as it is for VRDE.
NOTE: Setting this property to null or empty string will restore the
initial value.
public void setWebServiceAuthLibrary(java.lang.String value)
IWebsessionManager.logon(String,String)
implementation.
As opposed togetVRDEAuthLibrary()
,
there is no per-VM setting for this, as the webservice is a global
resource (if it is running). Only for this setting (for the webservice),
setting this value to a literal"null"string disables authentication,
meaning thatIWebsessionManager.logon(String,String)
will always succeed,
no matter what user name and password are supplied.
The initial value of this property is"VBoxAuth",
meaning that the webservice will use the same authentication
library that is used by default for VRDE (again, seegetVRDEAuthLibrary()
).
The format and calling convention of authentication libraries
is the same for the webservice as it is for VRDE.
NOTE: Setting this property to null or empty string will restore the
initial value.
value
- Stringpublic java.lang.String getDefaultVRDEExtPack()
public void setDefaultVRDEExtPack(java.lang.String value)
value
- Stringpublic java.lang.Long getLogHistoryCount()
public void setLogHistoryCount(java.lang.Long value)
value
- Longpublic AudioDriverType getDefaultAudioDriver()
public java.lang.String getAutostartDatabasePath()
public void setAutostartDatabasePath(java.lang.String value)
value
- Stringpublic java.lang.String getDefaultAdditionsISO()
public void setDefaultAdditionsISO(java.lang.String value)
value
- Stringpublic java.lang.String getDefaultFrontend()
IMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
method.
Empty or null strings do not define a particular default, it is up
toIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
to select one. See the
description ofIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
for the valid
frontend types.
This global setting is overridden by the per-VM attributeIMachine.getDefaultFrontend()
or a frontend type
passed toIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
.
public void setDefaultFrontend(java.lang.String value)
IMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
method.
Empty or null strings do not define a particular default, it is up
toIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
to select one. See the
description ofIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
for the valid
frontend types.
This global setting is overridden by the per-VM attributeIMachine.getDefaultFrontend()
or a frontend type
passed toIMachine.launchVMProcess(org.virtualbox_5_1.ISession,String,String)
.
value
- Stringpublic java.util.List<BitmapFormat> getScreenShotFormats()
public static ISystemProperties queryInterface(IUnknown obj)
public java.lang.Long getMaxNetworkAdapters(ChipsetType chipset)
IMachine
instance.
chipset
- The chipset type to get the value for.
public java.lang.Long getMaxNetworkAdaptersOfType(ChipsetType chipset, NetworkAttachmentType type)
IMachine
instance.
chipset
- The chipset type to get the value for.type
- Type of attachment.
public java.lang.Long getMaxDevicesPerPortForStorageBus(StorageBus bus)
bus
- The storage bus type to get the value for.
public java.lang.Long getMinPortCountForStorageBus(StorageBus bus)
bus
- The storage bus type to get the value for.
public java.lang.Long getMaxPortCountForStorageBus(StorageBus bus)
bus
- The storage bus type to get the value for.
public java.lang.Long getMaxInstancesOfStorageBus(ChipsetType chipset, StorageBus bus)
chipset
- The chipset type to get the value for.bus
- The storage bus type to get the value for.
public java.util.List<DeviceType> getDeviceTypesForStorageBus(StorageBus bus)
DeviceType
) for the given type of storage
bus.
bus
- The storage bus type to get the value for.
public java.lang.Boolean getDefaultIoCacheSettingForStorageController(StorageControllerType controllerType)
controllerType
- The storage controller type to get the setting for.
public java.lang.Boolean getStorageControllerHotplugCapable(StorageControllerType controllerType)
controllerType
- The storage controller to check the setting for.
public java.lang.Long getMaxInstancesOfUSBControllerType(ChipsetType chipset, USBControllerType type)
chipset
- The chipset type to get the value for.type
- The USB controller type to get the value for.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |