|
||||||||
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.IHost
public class IHost
The IHost interface represents the physical machine that this VirtualBox
installation runs on.
An object implementing this interface is returned by theIVirtualBox.getHost()
attribute. This interface contains
read-only information about the host's physical hardware (such as what
processors and disks are available, what the host operating system is,
and so on) and also allows for manipulating some of the host's hardware,
such as global USB device filters and host interface networking.
Interface ID: {AFCA788C-4477-787D-60B2-3FA70E56FBBC}
Field Summary |
---|
Fields inherited from class org.virtualbox_5_1.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
IHost(java.lang.String wrapped,
org.virtualbox_5_1.ObjectRefManager objMgr,
org.virtualbox_5_1.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
void |
addUSBDeviceSource(java.lang.String backend,
java.lang.String id,
java.lang.String address,
java.util.List<java.lang.String> propertyNames,
java.util.List<java.lang.String> propertyValues)
Adds a new USB device source. |
IProgress |
createHostOnlyNetworkInterface(Holder<IHostNetworkInterface> hostInterface)
Creates a new adapter for Host Only Networking. |
IHostUSBDeviceFilter |
createUSBDeviceFilter(java.lang.String name)
Creates a new USB device filter. |
IMedium |
findHostDVDDrive(java.lang.String name)
Searches for a host DVD drive with the given name. |
IMedium |
findHostFloppyDrive(java.lang.String name)
Searches for a host floppy drive with the given name. |
IHostNetworkInterface |
findHostNetworkInterfaceById(java.lang.String id)
Searches through all host network interfaces for an interface with the given GUID. |
IHostNetworkInterface |
findHostNetworkInterfaceByName(java.lang.String name)
Searches through all host network interfaces for an interface with the given name. |
java.util.List<IHostNetworkInterface> |
findHostNetworkInterfacesOfType(HostNetworkInterfaceType type)
Searches through all host network interfaces and returns a list of interfaces of the specified type |
IHostUSBDevice |
findUSBDeviceByAddress(java.lang.String name)
Searches for a USB device with the given host address. |
IHostUSBDevice |
findUSBDeviceById(java.lang.String id)
Searches for a USB device with the given UUID. |
java.lang.String |
generateMACAddress()
Generates a valid Ethernet MAC address, 12 hexadecimal characters. |
java.lang.Boolean |
getAcceleration3DAvailable()
Returns true when the host supports 3D hardware acceleration. |
java.lang.String |
getDomainName()
Domain name used for name resolving. |
java.util.List<IMedium> |
getDVDDrives()
List of DVD drives available on the host. |
java.util.List<IMedium> |
getFloppyDrives()
List of floppy drives available on the host. |
java.lang.Long |
getMemoryAvailable()
Available system memory in the host system. |
java.lang.Long |
getMemorySize()
Amount of system memory in megabytes installed in the host system. |
java.util.List<java.lang.String> |
getNameServers()
The list of nameservers registered in host's name resolving system. |
java.util.List<IHostNetworkInterface> |
getNetworkInterfaces()
List of host network interfaces currently defined on the host. |
java.lang.String |
getOperatingSystem()
Name of the host system's operating system. |
java.lang.String |
getOSVersion()
Host operating system's version string. |
java.lang.Long |
getProcessorCoreCount()
Number of physical processor cores installed in the host system. |
java.lang.Long |
getProcessorCount()
Number of (logical) CPUs installed in the host system. |
void |
getProcessorCPUIDLeaf(java.lang.Long cpuId,
java.lang.Long leaf,
java.lang.Long subLeaf,
Holder<java.lang.Long> valEax,
Holder<java.lang.Long> valEbx,
Holder<java.lang.Long> valEcx,
Holder<java.lang.Long> valEdx)
Returns the CPU cpuid information for the specified leaf. |
java.lang.String |
getProcessorDescription(java.lang.Long cpuId)
Query the model string of a specified host CPU. |
java.lang.Boolean |
getProcessorFeature(ProcessorFeature feature)
Query whether a CPU feature is supported or not. |
java.lang.Long |
getProcessorOnlineCoreCount()
Number of physical processor cores online in the host system. |
java.lang.Long |
getProcessorOnlineCount()
Number of (logical) CPUs online in the host system. |
java.lang.Long |
getProcessorSpeed(java.lang.Long cpuId)
Query the (approximate) maximum speed of a specified host CPU in Megahertz. |
java.util.List<java.lang.String> |
getSearchStrings()
Search string registered for name resolving. |
java.util.List<IHostUSBDeviceFilter> |
getUSBDeviceFilters()
List of USB device filters in action. |
java.util.List<IHostUSBDevice> |
getUSBDevices()
List of USB devices currently attached to the host. |
java.lang.Long |
getUTCTime()
Returns the current host time in milliseconds since 1970-01-01 UTC. |
java.util.List<IHostVideoInputDevice> |
getVideoInputDevices()
List of currently available host video capture devices. |
void |
insertUSBDeviceFilter(java.lang.Long position,
IHostUSBDeviceFilter filter)
Inserts the given USB device to the specified position in the list of filters. |
static IHost |
queryInterface(IUnknown obj)
|
IProgress |
removeHostOnlyNetworkInterface(java.lang.String id)
Removes the given Host Only Networking interface. |
void |
removeUSBDeviceFilter(java.lang.Long position)
Removes a USB device filter from the specified position in the list of filters. |
void |
removeUSBDeviceSource(java.lang.String id)
Removes a previously added USB device source. |
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 IHost(java.lang.String wrapped, org.virtualbox_5_1.ObjectRefManager objMgr, org.virtualbox_5_1.jaxws.VboxPortType port)
Method Detail |
---|
public java.util.List<IMedium> getDVDDrives()
public java.util.List<IMedium> getFloppyDrives()
public java.util.List<IHostUSBDevice> getUSBDevices()
public java.util.List<IHostUSBDeviceFilter> getUSBDeviceFilters()
IHostUSBDeviceFilter.getAction()
performed on the device.
Unless the device is ignored by these filters, filters of all
currently running virtual machines
(IUSBDeviceFilters.getDeviceFilters()
) are applied to it.
NOTE: If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to E_NOTIMPL.
IHostUSBDeviceFilter
,
USBDeviceState
public java.util.List<IHostNetworkInterface> getNetworkInterfaces()
public java.util.List<java.lang.String> getNameServers()
public java.lang.String getDomainName()
public java.util.List<java.lang.String> getSearchStrings()
public java.lang.Long getProcessorCount()
public java.lang.Long getProcessorOnlineCount()
public java.lang.Long getProcessorCoreCount()
public java.lang.Long getProcessorOnlineCoreCount()
public java.lang.Long getMemorySize()
public java.lang.Long getMemoryAvailable()
public java.lang.String getOperatingSystem()
public java.lang.String getOSVersion()
public java.lang.Long getUTCTime()
public java.lang.Boolean getAcceleration3DAvailable()
public java.util.List<IHostVideoInputDevice> getVideoInputDevices()
public static IHost queryInterface(IUnknown obj)
public java.lang.Long getProcessorSpeed(java.lang.Long cpuId)
cpuId
- Identifier of the CPU.
public java.lang.Boolean getProcessorFeature(ProcessorFeature feature)
feature
- CPU Feature identifier.
public java.lang.String getProcessorDescription(java.lang.Long cpuId)
cpuId
- Identifier of the CPU.
public void getProcessorCPUIDLeaf(java.lang.Long cpuId, java.lang.Long leaf, java.lang.Long subLeaf, Holder<java.lang.Long> valEax, Holder<java.lang.Long> valEbx, Holder<java.lang.Long> valEcx, Holder<java.lang.Long> valEdx)
cpuId
- Identifier of the CPU. The CPU most be online.leaf
- CPUID leaf index (eax).subLeaf
- CPUID leaf sub index (ecx). This currently only applies to cache
information on Intel CPUs. Use 0 if retrieving values forIMachine.setCPUIDLeaf(Long,Long,Long,Long,Long)
.valEax
- CPUID leaf value for register eax.valEbx
- CPUID leaf value for register ebx.valEcx
- CPUID leaf value for register ecx.valEdx
- CPUID leaf value for register edx.
NOTE: The current implementation might not necessarily return the
description for this exact CPU.public IProgress createHostOnlyNetworkInterface(Holder<IHostNetworkInterface> hostInterface)
hostInterface
- Created host interface object.
E_INVALIDARG | Host network interface name already exists. |
public IProgress removeHostOnlyNetworkInterface(java.lang.String id)
id
- Adapter GUID.
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND | No host network interface matching id found. |
public IHostUSBDeviceFilter createUSBDeviceFilter(java.lang.String name)
insertUSBDeviceFilter(Long,org.virtualbox_5_1.IHostUSBDeviceFilter)
.
name
- Filter name. SeeIUSBDeviceFilter.getName()
for more information.
getUSBDeviceFilters()
public void insertUSBDeviceFilter(java.lang.Long position, IHostUSBDeviceFilter filter)
position
- Position to insert the filter to.filter
- USB device filter to insert.
Expected result codes:
@link ::VBOX_E_INVALID_OBJECT_STATE VBOX_E_INVALID_OBJECT_STATE | USB device filter is not created within this VirtualBox instance. |
E_INVALIDARG | USB device filter already in list. |
getUSBDeviceFilters()
public void removeUSBDeviceFilter(java.lang.Long position)
position
- Position to remove the filter from.
Expected result codes:
E_INVALIDARG | USB device filter list empty or invalid position. |
getUSBDeviceFilters()
public IMedium findHostDVDDrive(java.lang.String name)
name
- Name of the host drive to search for
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND | Given name does not correspond to any host drive. |
public IMedium findHostFloppyDrive(java.lang.String name)
name
- Name of the host floppy drive to search for
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND | Given name does not correspond to any host floppy drive. |
public IHostNetworkInterface findHostNetworkInterfaceByName(java.lang.String name)
name
- Name of the host network interface to search for.
public IHostNetworkInterface findHostNetworkInterfaceById(java.lang.String id)
id
- GUID of the host network interface to search for.
public java.util.List<IHostNetworkInterface> findHostNetworkInterfacesOfType(HostNetworkInterfaceType type)
type
- type of the host network interfaces to search for.
public IHostUSBDevice findUSBDeviceById(java.lang.String id)
id
- UUID of the USB device to search for.
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND | Given id does not correspond to any USB device. |
IUSBDevice.getId()
public IHostUSBDevice findUSBDeviceByAddress(java.lang.String name)
name
- Address of the USB device (as assigned by the host) to
search for.
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUND | Given name does not correspond to any USB device. |
IUSBDevice.getAddress()
public java.lang.String generateMACAddress()
public void addUSBDeviceSource(java.lang.String backend, java.lang.String id, java.lang.String address, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyValues)
backend
- The backend to use as the new device source.id
- Unique ID to identify the source.address
- Address to use, the format is dependent on the backend.
For USB/IP backends for example the notation is host[:port].propertyNames
- Array of property names for more detailed configuration. Not used at the moment.propertyValues
- Array of property values for more detailed configuration. Not used at the moment.public void removeUSBDeviceSource(java.lang.String id)
id
- The identifier used when the source was added.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |