org.virtualbox_4_3
Class IConsole

java.lang.Object
  extended by org.virtualbox_4_3.IUnknown
      extended by org.virtualbox_4_3.IConsole

public class IConsole
extends IUnknown

The IConsole interface represents an interface to control virtual machine execution. A console object gets created when a machine has been locked for a particular session (client process) using IMachine.lockMachine(org.virtualbox_4_3.ISession,org.virtualbox_4_3.LockType)or IMachine.launchVMProcess(org.virtualbox_4_3.ISession,String,String). The console object can then be found in the session's ISession.getConsole()attribute. Methods of the IConsole interface allow the caller to query the current virtual machine execution state, pause the machine or power it down, save the machine state or take a snapshot, attach and detach removable media and so on.

See Also:
Interface ID: {8AB7C520-2442-4B66-8D74-4FF1E195D2B6}

Field Summary
 
Fields inherited from class org.virtualbox_4_3.IUnknown
obj, port
 
Constructor Summary
IConsole(java.lang.String wrapped, org.virtualbox_4_3.jaxws.VboxPortType port)
           
 
Method Summary
 void adoptSavedState(java.lang.String savedStateFile)
          Associates the given saved state file to the virtual machine.
 void attachUSBDevice(java.lang.String id)
          Attaches a host USB device with the given UUID to the USB controller of the virtual machine.
 void createSharedFolder(java.lang.String name, java.lang.String hostPath, java.lang.Boolean writable, java.lang.Boolean automount)
          Creates a transient new shared folder by associating the given logical name with the given host path, adds it to the collection of shared folders and starts sharing it.
 IProgress deleteSnapshot(java.lang.String id)
          Starts deleting the specified snapshot asynchronously.
 IProgress deleteSnapshotAndAllChildren(java.lang.String id)
          Starts deleting the specified snapshot and all its children asynchronously.
 IProgress deleteSnapshotRange(java.lang.String startId, java.lang.String endId)
          Starts deleting the specified snapshot range.
 IUSBDevice detachUSBDevice(java.lang.String id)
          Detaches an USB device with the given UUID from the USB controller of the virtual machine.
 void discardSavedState(java.lang.Boolean fRemoveFile)
          Forcibly resets the machine to "Powered Off" state if it is currently in the "Saved" state (previously created by saveState()).
 IUSBDevice findUSBDeviceByAddress(java.lang.String name)
          Searches for a USB device with the given host address.
 IUSBDevice findUSBDeviceById(java.lang.String id)
          Searches for a USB device with the given UUID.
 java.util.List<IPCIDeviceAttachment> getAttachedPCIDevices()
          Array of PCI devices attached to this machine.
 IMachineDebugger getDebugger()
          Debugging interface.
 DeviceActivity getDeviceActivity(DeviceType type)
          Gets the current activity type of a given device or device group.
 IDisplay getDisplay()
          Virtual display object.
 IEmulatedUSB getEmulatedUSB()
          Interface that manages emulated USB devices.
 IEventSource getEventSource()
          Event source for console events.
 IGuest getGuest()
          Guest object.
 java.lang.Boolean getGuestEnteredACPIMode()
          Checks if the guest entered the ACPI mode G0 (working) or G1 (sleeping).
 IKeyboard getKeyboard()
          Virtual keyboard object.
 IMachine getMachine()
          Machine object for this console session.
 IMouse getMouse()
          Virtual mouse object.
 java.lang.Boolean getPowerButtonHandled()
          Checks if the last power button event was handled by guest.
 java.util.List<IHostUSBDevice> getRemoteUSBDevices()
          List of USB devices currently attached to the remote VRDE client.
 java.util.List<ISharedFolder> getSharedFolders()
          Collection of shared folders for the current session.
 MachineState getState()
          Current execution state of the machine.
 java.util.List<IUSBDevice> getUSBDevices()
          Collection of USB devices currently attached to the virtual USB controller.
 java.lang.Boolean getUseHostClipboard()
          Whether the guest clipboard should be connected to the host one or whether it should only be allowed access to the VRDE clipboard.
 IVRDEServerInfo getVRDEServerInfo()
          Interface that provides information on Remote Desktop Extension (VRDE) connection.
 void pause()
          Pauses the virtual machine execution.
 void powerButton()
          Sends the ACPI power button event to the guest.
 IProgress powerDown()
          Initiates the power down procedure to stop the virtual machine execution.
 IProgress powerUp()
          Starts the virtual machine execution using the current machine state (that is, its current execution state, current settings and current storage devices).
 IProgress powerUpPaused()
          Identical to powerUp except that the VM will enter the MachineState.Pausedstate, instead of MachineState.Running.
static IConsole queryInterface(IUnknown obj)
           
 void removeSharedFolder(java.lang.String name)
          Removes a transient shared folder with the given name previously created by createSharedFolder(String,String,Boolean,Boolean)from the collection of shared folders and stops sharing it.
 void reset()
          Resets the virtual machine.
 IProgress restoreSnapshot(ISnapshot snapshot)
          Starts resetting the machine's current state to the state contained in the given snapshot, asynchronously.
 void resume()
          Resumes the virtual machine execution.
 IProgress saveState()
          Saves the current execution state of a running virtual machine and stops its execution.
 void setUseHostClipboard(java.lang.Boolean value)
          Whether the guest clipboard should be connected to the host one or whether it should only be allowed access to the VRDE clipboard.
 void sleepButton()
          Sends the ACPI sleep button event to the guest.
 IProgress takeSnapshot(java.lang.String name, java.lang.String description)
          Saves the current execution state and all settings of the machine and creates differencing images for all normal (non-independent) media.
 IProgress teleport(java.lang.String hostname, java.lang.Long tcpport, java.lang.String password, java.lang.Long maxDowntime)
          Teleport the VM to a different host machine or process.
 
Methods inherited from class org.virtualbox_4_3.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IConsole

public IConsole(java.lang.String wrapped,
                org.virtualbox_4_3.jaxws.VboxPortType port)
Method Detail

getMachine

public IMachine getMachine()
Machine object for this console session. NOTE: This is a convenience property, it has the same value as ISession.getMachine()of the corresponding session object.

Returns:
org.virtualbox_4_3.IMachine

getState

public MachineState getState()
Current execution state of the machine. NOTE: This property always returns the same value as the corresponding property of the IMachine object for this console session. For the process that owns (executes) the VM, this is the preferable way of querying the VM state, because no IPC calls are made.

Returns:
org.virtualbox_4_3.MachineState

getGuest

public IGuest getGuest()
Guest object.

Returns:
org.virtualbox_4_3.IGuest

getKeyboard

public IKeyboard getKeyboard()
Virtual keyboard object. NOTE: If the machine is not running, any attempt to use the returned object will result in an error.

Returns:
org.virtualbox_4_3.IKeyboard

getMouse

public IMouse getMouse()
Virtual mouse object. NOTE: If the machine is not running, any attempt to use the returned object will result in an error.

Returns:
org.virtualbox_4_3.IMouse

getDisplay

public IDisplay getDisplay()
Virtual display object. NOTE: If the machine is not running, any attempt to use the returned object will result in an error.

Returns:
org.virtualbox_4_3.IDisplay

getDebugger

public IMachineDebugger getDebugger()
Debugging interface.

Returns:
org.virtualbox_4_3.IMachineDebugger

getUSBDevices

public java.util.List<IUSBDevice> getUSBDevices()
Collection of USB devices currently attached to the virtual USB controller. NOTE: The collection is empty if the machine is not running.

Returns:
List

getRemoteUSBDevices

public java.util.List<IHostUSBDevice> getRemoteUSBDevices()
List of USB devices currently attached to the remote VRDE client. Once a new device is physically attached to the remote host computer, it appears in this list and remains there until detached.

Returns:
List

getSharedFolders

public java.util.List<ISharedFolder> getSharedFolders()
Collection of shared folders for the current session. These folders are called transient shared folders because they are available to the guest OS running inside the associated virtual machine only for the duration of the session (as opposed to IMachine.getSharedFolders()which represent permanent shared folders). When the session is closed (e.g. the machine is powered down), these folders are automatically discarded. New shared folders are added to the collection using createSharedFolder(String,String,Boolean,Boolean). Existing shared folders can be removed using removeSharedFolder(String).

Returns:
List

getVRDEServerInfo

public IVRDEServerInfo getVRDEServerInfo()
Interface that provides information on Remote Desktop Extension (VRDE) connection.

Returns:
org.virtualbox_4_3.IVRDEServerInfo

getEventSource

public IEventSource getEventSource()
Event source for console events.

Returns:
org.virtualbox_4_3.IEventSource

getAttachedPCIDevices

public java.util.List<IPCIDeviceAttachment> getAttachedPCIDevices()
Array of PCI devices attached to this machine.

Returns:
List

getUseHostClipboard

public java.lang.Boolean getUseHostClipboard()
Whether the guest clipboard should be connected to the host one or whether it should only be allowed access to the VRDE clipboard. This setting may not affect existing guest clipboard connections which are already connected to the host clipboard.

Returns:
Boolean

setUseHostClipboard

public void setUseHostClipboard(java.lang.Boolean value)
Whether the guest clipboard should be connected to the host one or whether it should only be allowed access to the VRDE clipboard. This setting may not affect existing guest clipboard connections which are already connected to the host clipboard.

Parameters:
value - Boolean

getEmulatedUSB

public IEmulatedUSB getEmulatedUSB()
Interface that manages emulated USB devices.

Returns:
org.virtualbox_4_3.IEmulatedUSB

queryInterface

public static IConsole queryInterface(IUnknown obj)

powerUp

public IProgress powerUp()
Starts the virtual machine execution using the current machine state (that is, its current execution state, current settings and current storage devices). If the machine is powered off or aborted, the execution will start from the beginning (as if the real hardware were just powered on). If the machine is in the MachineState.Savedstate, it will continue its execution the point where the state has been saved. If the machine IMachine.getTeleporterEnabled()property is enabled on the machine being powered up, the machine will wait for an incoming teleportation in the MachineState.TeleportingInstate. The returned progress object will have at least three operations where the last three are defined as: (1) powering up and starting TCP server, (2) waiting for incoming teleportations, and (3) perform teleportation. These operations will be reflected as the last three operations of the progress objected returned by IMachine.launchVMProcess(org.virtualbox_4_3.ISession,String,String)as well.

Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine already running.
@link ::VBOX_E_HOST_ERROR VBOX_E_HOST_ERRORHost interface does not exist or name not set.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERRORInvalid saved state file.
NOTE: This method is only useful for front-ends that want to actually execute virtual machines in their own process (like the VirtualBox or VBoxSDL front-ends). Unless you are intending to write such a front-end, do not call this method. If you simply want to start virtual machine execution using one of the existing front-ends (for example the VirtualBox GUI or headless server), use IMachine.launchVMProcess(org.virtualbox_4_3.ISession,String,String)instead; these front-ends will power up the machine automatically for you.
See Also:
saveState()

powerUpPaused

public IProgress powerUpPaused()
Identical to powerUp except that the VM will enter the MachineState.Pausedstate, instead of MachineState.Running.

Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine already running.
@link ::VBOX_E_HOST_ERROR VBOX_E_HOST_ERRORHost interface does not exist or name not set.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERRORInvalid saved state file.
See Also:
powerUp()

powerDown

public IProgress powerDown()
Initiates the power down procedure to stop the virtual machine execution. The completion of the power down procedure is tracked using the returned IProgress object. After the operation is complete, the machine will go to the PoweredOff state.

Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine must be Running, Paused or Stuck to be powered down.

reset

public void reset()
Resets the virtual machine. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Running state.
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVirtual machine error in reset operation.


pause

public void pause()
Pauses the virtual machine execution. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Running state.
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVirtual machine error in suspend operation.


resume

public void resume()
Resumes the virtual machine execution. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Paused state.
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVirtual machine error in resume operation.


powerButton

public void powerButton()
Sends the ACPI power button event to the guest. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Running state.
@link ::VBOX_E_PDM_ERROR VBOX_E_PDM_ERRORControlled power off failed.


sleepButton

public void sleepButton()
Sends the ACPI sleep button event to the guest. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Running state.
@link ::VBOX_E_PDM_ERROR VBOX_E_PDM_ERRORSending sleep button event failed.


getPowerButtonHandled

public java.lang.Boolean getPowerButtonHandled()
Checks if the last power button event was handled by guest. Expected result codes:
@link ::VBOX_E_PDM_ERROR VBOX_E_PDM_ERRORChecking if the event was handled by the guest OS failed.


getGuestEnteredACPIMode

public java.lang.Boolean getGuestEnteredACPIMode()
Checks if the guest entered the ACPI mode G0 (working) or G1 (sleeping). If this method returns false, the guest will most likely not respond to external ACPI events. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in Running state.


saveState

public IProgress saveState()
Saves the current execution state of a running virtual machine and stops its execution. After this operation completes, the machine will go to the Saved state. Next time it is powered up, this state will be restored and the machine will continue its execution from the place where it was saved. This operation differs from taking a snapshot to the effect that it doesn't create new differencing media. Also, once the machine is powered up from the state saved using this method, the saved state is deleted, so it will be impossible to return to this state later.

Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine state neither Running nor Paused.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERRORFailed to create directory for saved state file.
NOTE: On success, this method implicitly calls IMachine.saveSettings()to save all current machine settings (including runtime changes to the DVD medium, etc.). Together with the impossibility to change any VM settings when it is in the Saved state, this guarantees adequate hardware configuration of the machine when it is restored from the saved state file. NOTE: The machine must be in the Running or Paused state, otherwise the operation will fail.
See Also:
takeSnapshot(String,String)

adoptSavedState

public void adoptSavedState(java.lang.String savedStateFile)
Associates the given saved state file to the virtual machine. On success, the machine will go to the Saved state. Next time it is powered up, it will be restored from the adopted saved state and continue execution from the place where the saved state file was created. The specified saved state file path may be absolute or relative to the folder the VM normally saves the state to (usually, IMachine.getSnapshotFolder()).

Parameters:
savedStateFile - Path to the saved state file to adopt. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine state neither PoweredOff nor Aborted.
NOTE: It's a caller's responsibility to make sure the given saved state file is compatible with the settings of this virtual machine that represent its virtual hardware (memory size, storage disk configuration etc.). If there is a mismatch, the behavior of the virtual machine is undefined.

discardSavedState

public void discardSavedState(java.lang.Boolean fRemoveFile)
Forcibly resets the machine to "Powered Off" state if it is currently in the "Saved" state (previously created by saveState()). Next time the machine is powered up, a clean boot will occur. If fRemoveFile is true, the file in the machine directory into which the machine state was saved is also deleted. If this is false, then the state can be recovered and later re-inserted into a machine using adoptSavedState(String). The location of the file can be found in the IMachine.getStateFilePath()attribute.

Parameters:
fRemoveFile - Whether to also remove the saved state file. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not in state Saved.
NOTE: This operation is equivalent to resetting or powering off the machine without doing a proper shutdown of the guest operating system; as with resetting a running phyiscal computer, it can can lead to data loss.

getDeviceActivity

public DeviceActivity getDeviceActivity(DeviceType type)
Gets the current activity type of a given device or device group. Expected result codes:
E_INVALIDARGInvalid device type.


attachUSBDevice

public void attachUSBDevice(java.lang.String id)
Attaches a host USB device with the given UUID to the USB controller of the virtual machine. The device needs to be in one of the following states: USBDeviceState.Busy, USBDeviceState.Availableor USBDeviceState.Held, otherwise an error is immediately returned. When the device state is USBDeviceState.Busy, an error may also be returned if the host computer refuses to release it for some reason.

Parameters:
id - UUID of the host USB device to attach. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine state neither Running nor Paused.
@link ::VBOX_E_PDM_ERROR VBOX_E_PDM_ERRORVirtual machine does not have a USB controller.
See Also:
IUSBDeviceFilters.getDeviceFilters(), USBDeviceState

detachUSBDevice

public IUSBDevice detachUSBDevice(java.lang.String id)
Detaches an USB device with the given UUID from the USB controller of the virtual machine. After this method succeeds, the VirtualBox server re-initiates all USB filters as if the device were just physically attached to the host, but filters of this machine are ignored to avoid a possible automatic re-attachment.

Parameters:
id - UUID of the USB device to detach.
Returns:
Detached USB device. Expected result codes:
@link ::VBOX_E_PDM_ERROR VBOX_E_PDM_ERRORVirtual machine does not have a USB controller.
E_INVALIDARGUSB device not attached to this virtual machine.
See Also:
IUSBDeviceFilters.getDeviceFilters(), USBDeviceState

findUSBDeviceByAddress

public IUSBDevice findUSBDeviceByAddress(java.lang.String name)
Searches for a USB device with the given host address.

Parameters:
name - Address of the USB device (as assigned by the host) to search for.
Returns:
Found USB device object. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUNDGiven name does not correspond to any USB device.
See Also:
IUSBDevice.getAddress()

findUSBDeviceById

public IUSBDevice findUSBDeviceById(java.lang.String id)
Searches for a USB device with the given UUID.

Parameters:
id - UUID of the USB device to search for.
Returns:
Found USB device object. Expected result codes:
@link ::VBOX_E_OBJECT_NOT_FOUND VBOX_E_OBJECT_NOT_FOUNDGiven id does not correspond to any USB device.
See Also:
IUSBDevice.getId()

createSharedFolder

public void createSharedFolder(java.lang.String name,
                               java.lang.String hostPath,
                               java.lang.Boolean writable,
                               java.lang.Boolean automount)
Creates a transient new shared folder by associating the given logical name with the given host path, adds it to the collection of shared folders and starts sharing it. Refer to the description of ISharedFolderto read more about logical names.

Parameters:
name - Unique logical name of the shared folder.
hostPath - Full path to the shared folder in the host file system.
writable - Whether the share is writable or readonly
automount - Whether the share gets automatically mounted by the guest or not. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine in Saved state or currently changing state.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERRORShared folder already exists or not accessible.

removeSharedFolder

public void removeSharedFolder(java.lang.String name)
Removes a transient shared folder with the given name previously created by createSharedFolder(String,String,Boolean,Boolean)from the collection of shared folders and stops sharing it.

Parameters:
name - Logical name of the shared folder to remove. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine in Saved state or currently changing state.
@link ::VBOX_E_FILE_ERROR VBOX_E_FILE_ERRORShared folder does not exists.

takeSnapshot

public IProgress takeSnapshot(java.lang.String name,
                              java.lang.String description)
Saves the current execution state and all settings of the machine and creates differencing images for all normal (non-independent) media. See ISnapshotfor an introduction to snapshots. This method can be called for a PoweredOff, Saved (see saveState()), Running or Paused virtual machine. When the machine is PoweredOff, an offline snapshot is created. When the machine is Running a live snapshot is created, and an online snapshot is created when Paused. The taken snapshot is always based on the IMachine.getCurrentSnapshot()of the associated virtual machine and becomes a new current snapshot.

Parameters:
name - Short name for the snapshot.
description - Optional description of the snapshot.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine currently changing state.
NOTE: This method implicitly calls IMachine.saveSettings()to save all current machine settings before taking an offline snapshot.

deleteSnapshot

public IProgress deleteSnapshot(java.lang.String id)
Starts deleting the specified snapshot asynchronously. See ISnapshotfor an introduction to snapshots. The execution state and settings of the associated machine stored in the snapshot will be deleted. The contents of all differencing media of this snapshot will be merged with the contents of their dependent child media to keep the medium chain valid (in other words, all changes represented by media being deleted will be propagated to their child medium). After that, this snapshot's differencing medium will be deleted. The parent of this snapshot will become a new parent for all its child snapshots. If the deleted snapshot is the current one, its parent snapshot will become a new current snapshot. The current machine state is not directly affected in this case, except that currently attached differencing media based on media of the deleted snapshot will be also merged as described above. If the deleted snapshot is the first or current snapshot, then the respective IMachine attributes will be adjusted. Deleting the current snapshot will also implicitly call IMachine.saveSettings()to make all current machine settings permanent. Deleting a snapshot has the following preconditions: The virtual machine's IMachine.getState()is changed to "DeletingSnapshot", "DeletingSnapshotOnline" or "DeletingSnapshotPaused" while this operation is in progress.

Parameters:
id - UUID of the snapshot to delete.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEThe running virtual machine prevents deleting this snapshot. This happens only in very specific situations, usually snapshots can be deleted without trouble while a VM is running. The error message text explains the reason for the failure.
NOTE: Merging medium contents can be very time and disk space consuming, if these media are big in size and have many children. However, if the snapshot being deleted is the last (head) snapshot on the branch, the operation will be rather quick.

deleteSnapshotAndAllChildren

public IProgress deleteSnapshotAndAllChildren(java.lang.String id)
Starts deleting the specified snapshot and all its children asynchronously. See ISnapshotfor an introduction to snapshots. The conditions and many details are the same as with deleteSnapshot(String). This operation is very fast if the snapshot subtree does not include the current state. It is still significantly faster than deleting the snapshots one by one if the current state is in the subtree and there are more than one snapshots from current state to the snapshot which marks the subtree, since it eliminates the incremental image merging.

Parameters:
id - UUID of the snapshot to delete, including all its children.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEThe running virtual machine prevents deleting this snapshot. This happens only in very specific situations, usually snapshots can be deleted without trouble while a VM is running. The error message text explains the reason for the failure.
E_NOTIMPLThe method is not implemented yet.
NOTE: This API method is right now not implemented!

deleteSnapshotRange

public IProgress deleteSnapshotRange(java.lang.String startId,
                                     java.lang.String endId)
Starts deleting the specified snapshot range. This is limited to linear snapshot lists, which means there may not be any other child snapshots other than the direct sequence between the start and end snapshot. If the start and end snapshot point to the same snapshot this method is completely equivalent to deleteSnapshot(String). See ISnapshotfor an introduction to snapshots. The conditions and many details are the same as with deleteSnapshot(String). This operation is generally faster than deleting snapshots one by one and often also needs less extra disk space before freeing up disk space by deleting the removed disk images corresponding to the snapshot.

Parameters:
startId - UUID of the first snapshot to delete.
endId - UUID of the last snapshot to delete.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEThe running virtual machine prevents deleting this snapshot. This happens only in very specific situations, usually snapshots can be deleted without trouble while a VM is running. The error message text explains the reason for the failure.
E_NOTIMPLThe method is not implemented yet.
NOTE: This API method is right now not implemented!

restoreSnapshot

public IProgress restoreSnapshot(ISnapshot snapshot)
Starts resetting the machine's current state to the state contained in the given snapshot, asynchronously. All current settings of the machine will be reset and changes stored in differencing media will be lost. See ISnapshotfor an introduction to snapshots. After this operation is successfully completed, new empty differencing media are created for all normal media of the machine. If the given snapshot is an online snapshot, the machine will go to the MachineState.Saved, so that the next time it is powered on, the execution state will be restored from the state of the snapshot.

Parameters:
snapshot - The snapshot to restore the VM state from.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine is running.
NOTE: The machine must not be running, otherwise the operation will fail. NOTE: If the machine state is MachineState.Savedprior to this operation, the saved state file will be implicitly deleted (as if discardSavedState(Boolean)were called).

teleport

public IProgress teleport(java.lang.String hostname,
                          java.lang.Long tcpport,
                          java.lang.String password,
                          java.lang.Long maxDowntime)
Teleport the VM to a different host machine or process. TODO explain the details.

Parameters:
hostname - The name or IP of the host to teleport to.
tcpport - The TCP port to connect to (1..65535).
password - The password.
maxDowntime - The maximum allowed downtime given as milliseconds. 0 is not a valid value. Recommended value: 250 ms. The higher the value is, the greater the chance for a successful teleportation. A small value may easily result in the teleportation process taking hours and eventually fail.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_INVALID_VM_STATE VBOX_E_INVALID_VM_STATEVirtual machine not running or paused.
NOTE: The current implementation treats this a guideline, not as an absolute rule.