# A Pythonic VirtalBox Main API
#
# By Michael Dorman.
# [mjdorma+pyvbox@gmail.com]
#
# Note: Commenting, and API structure generation was carved from
# VirtualBox project's VirtualBox.xidl Main API definition.
#
from __future__ import absolute_import
from .library_base import Enum
from .library_base import Interface
from .library_base import VBoxError
# Py2 and Py3 compatibility
try:
import __builtin__ as builtin
except:
import builtins as builtin
try:
basestring = basestring
except:
basestring = (str, bytes)
try:
baseinteger = (int, long)
except:
baseinteger = (int, )
__doc__ = """\
Welcome to the **VirtualBox Main API documentation**. This documentation
describes the so-called *VirtualBox Main API* which comprises all public
COM interfaces and components provided by the VirtualBox server and by the
VirtualBox client library.
VirtualBox employs a client-server design, meaning that whenever any part of
VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
interface or any virtual machine --, a dedicated server process named
VBoxSVC runs in the background. This allows multiple processes working with
VirtualBox to cooperate without conflicts. These processes communicate to each
other using inter-process communication facilities provided by the COM
implementation of the host computer.
On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
implementation. On all other platforms, Mozilla XPCOM, an open-source COM
implementation, is used.
All the parts that a typical VirtualBox user interacts with (the Qt GUI
and the VBoxManage command-line interface) are technically
front-ends to the Main API and only use the interfaces that are documented
in this Main API documentation. This ensures that, with any given release
version of VirtualBox, all capabilities of the product that could be useful
to an external client program are always exposed by way of this API.
The VirtualBox Main API (also called the *VirtualBox COM library*)
contains two public component classes:
:py:class:`IVirtualBox` and :py:class:`ISession`, which
implement IVirtualBox and ISession interfaces respectively. These two classes
are of supreme importance and will be needed in order for any front-end
program to do anything useful. It is recommended to read the documentation of
the mentioned interfaces first.
The :py:class:`IVirtualBox` class is a singleton. This means that
there can be only one object of this class on the local machine at any given
time. This object is a parent of many other objects in the VirtualBox COM
library and lives in the VBoxSVC process. In fact, when you create an instance
of the :py:class:`IVirtualBox`, the COM subsystem checks if the VBoxSVC
process is already running, starts it if not, and returns you a reference to
the VirtualBox object created in this process. When the last reference
to this object is released, the VBoxSVC process ends (with a 5 second delay to
protect from too frequent restarts).
The :py:class:`ISession` class is a regular component. You can create
as many Session objects as you need but all of them will live in a
process which issues the object instantiation call. Session objects
represent virtual machine sessions which are used to configure virtual
machines and control their execution.
The naming of methods and attributes is very clearly defined: they all start
with a lowercase letter (except if they start with an acronym), and are using
CamelCase style otherwise. This naming only applies to the IDL description,
and is modified by the various language bindings (some convert the first
character to upper case, some not). See the SDK reference for more details
about how to call a method or attribute from a specific programming language.
"""
vbox_version = '5.1.1'
lib_version = 1.3
lib_app_uuid = '819B4D85-9CEE-493C-B6FC-64FFE759B3C9'
lib_uuid = 'd7569351-1750-46f0-936e-bd127d5bc264'
xidl_hash = '4c722fe37602c6217134f1c9f75a2bb3'
[docs]class VBoxErrorObjectNotFound(VBoxError):
"""Object corresponding to the supplied arguments does not exist."""
name = 'VBOX_E_OBJECT_NOT_FOUND'
value = 0x80BB0001
[docs]class VBoxErrorInvalidVmState(VBoxError):
"""Current virtual machine state prevents the operation."""
name = 'VBOX_E_INVALID_VM_STATE'
value = 0x80BB0002
[docs]class VBoxErrorVmError(VBoxError):
"""Virtual machine error occurred attempting the operation."""
name = 'VBOX_E_VM_ERROR'
value = 0x80BB0003
[docs]class VBoxErrorFileError(VBoxError):
"""File not accessible or erroneous file contents."""
name = 'VBOX_E_FILE_ERROR'
value = 0x80BB0004
[docs]class VBoxErrorIprtError(VBoxError):
"""Runtime subsystem error."""
name = 'VBOX_E_IPRT_ERROR'
value = 0x80BB0005
[docs]class VBoxErrorPdmError(VBoxError):
"""Pluggable Device Manager error."""
name = 'VBOX_E_PDM_ERROR'
value = 0x80BB0006
[docs]class VBoxErrorInvalidObjectState(VBoxError):
"""Current object state prohibits operation."""
name = 'VBOX_E_INVALID_OBJECT_STATE'
value = 0x80BB0007
[docs]class VBoxErrorHostError(VBoxError):
"""Host operating system related error."""
name = 'VBOX_E_HOST_ERROR'
value = 0x80BB0008
[docs]class VBoxErrorNotSupported(VBoxError):
"""Requested operation is not supported."""
name = 'VBOX_E_NOT_SUPPORTED'
value = 0x80BB0009
[docs]class VBoxErrorXmlError(VBoxError):
"""Invalid XML found."""
name = 'VBOX_E_XML_ERROR'
value = 0x80BB000A
[docs]class VBoxErrorInvalidSessionState(VBoxError):
"""Current session state prohibits operation."""
name = 'VBOX_E_INVALID_SESSION_STATE'
value = 0x80BB000B
[docs]class VBoxErrorObjectInUse(VBoxError):
"""Object being in use prohibits operation."""
name = 'VBOX_E_OBJECT_IN_USE'
value = 0x80BB000C
[docs]class VBoxErrorPasswordIncorrect(VBoxError):
"""A provided password was incorrect."""
name = 'VBOX_E_PASSWORD_INCORRECT'
value = 0x80BB000D
[docs]class OleErrorFail(VBoxError):
"""Unspecified error"""
name = 'E_FAIL'
value = 0x80004005
[docs]class OleErrorNointerface(VBoxError):
"""No such interface supported"""
name = 'E_NOINTERFACE'
value = 0x80004002
[docs]class OleErrorAccessdenied(VBoxError):
"""General access denied error"""
name = 'E_ACCESSDENIED'
value = 0x80070005
[docs]class OleErrorNotimpl(VBoxError):
"""Not implemented"""
name = 'E_NOTIMPL'
value = 0x80004001
[docs]class OleErrorUnexpected(VBoxError):
"""Catastrophic failure"""
name = 'E_UNEXPECTED'
value = 0x8000FFFF
[docs]class OleErrorInvalidarg(VBoxError):
"""One or more arguments are invalid"""
name = 'E_INVALIDARG'
value = 0x80070057
[docs]class SettingsVersion(Enum):
"""Settings version of VirtualBox settings files. This is written to
the "version" attribute of the root "VirtualBox" element in the settings
file XML and indicates which VirtualBox version wrote the file.
.. describe:: null(0)
Null value, indicates invalid version.
.. describe:: v1_0(1)
Legacy settings version, not currently supported.
.. describe:: v1_1(2)
Legacy settings version, not currently supported.
.. describe:: v1_2(3)
Legacy settings version, not currently supported.
.. describe:: v1_3pre(4)
Legacy settings version, not currently supported.
.. describe:: v1_3(5)
Settings version "1.3", written by VirtualBox 2.0.12.
.. describe:: v1_4(6)
Intermediate settings version, understood by VirtualBox 2.1.x.
.. describe:: v1_5(7)
Intermediate settings version, understood by VirtualBox 2.1.x.
.. describe:: v1_6(8)
Settings version "1.6", written by VirtualBox 2.1.4 (at least).
.. describe:: v1_7(9)
Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.
.. describe:: v1_8(10)
Intermediate settings version "1.8", understood by VirtualBox 3.1.x.
.. describe:: v1_9(11)
Settings version "1.9", written by VirtualBox 3.1.x.
.. describe:: v1_10(12)
Settings version "1.10", written by VirtualBox 3.2.x.
.. describe:: v1_11(13)
Settings version "1.11", written by VirtualBox 4.0.x.
.. describe:: v1_12(14)
Settings version "1.12", written by VirtualBox 4.1.x.
.. describe:: v1_13(15)
Settings version "1.13", written by VirtualBox 4.2.x.
.. describe:: v1_14(16)
Settings version "1.14", written by VirtualBox 4.3.x.
.. describe:: v1_15(17)
Settings version "1.15", written by VirtualBox 5.0.x.
.. describe:: v1_16(18)
Settings version "1.16", written by VirtualBox 5.1.x.
.. describe:: future(99999)
Settings version greater than "1.15", written by a future VirtualBox version.
"""
__uuid__ = 'b4cc23c2-96f2-419d-830b-bd13c1135dfb'
_enums = [\
('Null', 0,
'''Null value, indicates invalid version.'''),
('v1_0', 1,
'''Legacy settings version, not currently supported.'''),
('v1_1', 2,
'''Legacy settings version, not currently supported.'''),
('v1_2', 3,
'''Legacy settings version, not currently supported.'''),
('v1_3pre', 4,
'''Legacy settings version, not currently supported.'''),
('v1_3', 5,
'''Settings version "1.3", written by VirtualBox 2.0.12.'''),
('v1_4', 6,
'''Intermediate settings version, understood by VirtualBox 2.1.x.'''),
('v1_5', 7,
'''Intermediate settings version, understood by VirtualBox 2.1.x.'''),
('v1_6', 8,
'''Settings version "1.6", written by VirtualBox 2.1.4 (at least).'''),
('v1_7', 9,
'''Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.'''),
('v1_8', 10,
'''Intermediate settings version "1.8", understood by VirtualBox 3.1.x.'''),
('v1_9', 11,
'''Settings version "1.9", written by VirtualBox 3.1.x.'''),
('v1_10', 12,
'''Settings version "1.10", written by VirtualBox 3.2.x.'''),
('v1_11', 13,
'''Settings version "1.11", written by VirtualBox 4.0.x.'''),
('v1_12', 14,
'''Settings version "1.12", written by VirtualBox 4.1.x.'''),
('v1_13', 15,
'''Settings version "1.13", written by VirtualBox 4.2.x.'''),
('v1_14', 16,
'''Settings version "1.14", written by VirtualBox 4.3.x.'''),
('v1_15', 17,
'''Settings version "1.15", written by VirtualBox 5.0.x.'''),
('v1_16', 18,
'''Settings version "1.16", written by VirtualBox 5.1.x.'''),
('Future', 99999,
'''Settings version greater than "1.15", written by a future VirtualBox version.'''),
]
[docs]class AccessMode(Enum):
"""Access mode for opening files.
.. describe:: read_only(1)
.. describe:: read_write(2)
"""
__uuid__ = '1da0007c-ddf7-4be8-bcac-d84a1558785f'
_enums = [\
('ReadOnly', 1,
''''''),
('ReadWrite', 2,
''''''),
]
[docs]class MachineState(Enum):
"""Virtual machine execution state.
This enumeration represents possible values of the :py:func:`IMachine.state` attribute.
Below is the basic virtual machine state diagram. It shows how the state
changes during virtual machine execution. The text in square braces shows
a method of the IConsole or IMachine interface that performs the given state
transition.
::
+---------[powerDown()] <- Stuck <--[failure]-+
V |
+-> PoweredOff --+-->[powerUp()]--> Starting --+ | +-----[resume()]-----+
| | | | V |
| Aborted -----+ +--> Running --[pause()]--> Paused
| | ^ | ^ |
| Saved -----------[powerUp()]--> Restoring -+ | | | |
| ^ | | | |
| | +-----------------------------------------+-|-------------------+ +
| | | | |
| | +- OnlineSnapshotting <--[takeSnapshot()]<--+---------------------+
| | | |
| +-------- Saving <--------[saveState()]<----------+---------------------+
| | |
+-------------- Stopping -------[powerDown()]<----------+---------------------+
Note that states to the right from PoweredOff, Aborted and Saved in the
above diagram are called *online VM states*. These states
represent the virtual machine which is being executed in a dedicated
process (usually with a GUI window attached to it where you can see the
activity of the virtual machine and interact with it). There are two
special pseudo-states, FirstOnline and LastOnline, that can be used in
relational expressions to detect if the given machine state is online or
not:
::
if (machine.GetState() >= MachineState_FirstOnline &&
machine.GetState() <= MachineState_LastOnline)
{
...the machine is being executed...
}
When the virtual machine is in one of the online VM states (that is, being
executed), only a few machine settings can be modified. Methods working
with such settings contain an explicit note about that. An attempt to
change any other setting or perform a modifying operation during this time
will result in the @c VBOX_E_INVALID_VM_STATE error.
All online states except Running, Paused and Stuck are transitional: they
represent temporary conditions of the virtual machine that will last as
long as the operation that initiated such a condition.
The Stuck state is a special case. It means that execution of the machine
has reached the "Guru Meditation" condition. This condition indicates an
internal VMM (virtual machine manager) failure which may happen as a
result of either an unhandled low-level virtual hardware exception or one
of the recompiler exceptions (such as the *too-many-traps*
condition).
Note also that any online VM state may transit to the Aborted state. This
happens if the process that is executing the virtual machine terminates
unexpectedly (for example, crashes). Other than that, the Aborted state is
equivalent to PoweredOff.
There are also a few additional state diagrams that do not deal with
virtual machine execution and therefore are shown separately. The states
shown on these diagrams are called *offline VM states* (this includes
PoweredOff, Aborted and Saved too).
The first diagram shows what happens when a lengthy setup operation is
being executed (such as :py:func:`IMachine.attach_device` ).
::
+----------------------------------(same state as before the call)------+
| |
+-> PoweredOff --+ |
| | |
|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
| |
+-> Saved -------+
The next two diagrams demonstrate the process of taking a snapshot of a
powered off virtual machine, restoring the state to that as of a snapshot
or deleting a snapshot, respectively.
::
+----------------------------------(same state as before the call)------+
| |
+-> PoweredOff --+ |
| +-->[takeSnapshot()] ------------------> Snapshotting -+
+-> Aborted -----+
+-> PoweredOff --+
| |
| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
| | [deleteSnapshot() ]-------> DeletingSnapshot --+
+-> Saved -------+ |
| |
+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
For whoever decides to touch this enum: In order to keep the
comparisons involving FirstOnline and LastOnline pseudo-states valid,
the numeric values of these states must be correspondingly updated if
needed: for any online VM state, the condition
FirstOnline <= state <= LastOnline must be
@c true. The same relates to transient states for which
the condition FirstOnline <= state <= LastOnline must be
@c true.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: powered_off(1)
The machine is not running and has no saved execution state; it has
either never been started or been shut down successfully.
.. describe:: saved(2)
The machine is not currently running, but the execution state of the machine
has been saved to an external file when it was running, from where
it can be resumed.
.. describe:: teleported(3)
The machine was teleported to a different host (or process) and then
powered off. Take care when powering it on again may corrupt resources
it shares with the teleportation target (e.g. disk and network).
.. describe:: aborted(4)
The process running the machine has terminated abnormally. This may
indicate a crash of the VM process in host execution context, or
the VM process has been terminated externally.
.. describe:: running(5)
The machine is currently being executed.
For whoever decides to touch this enum: In order to keep the
comparisons in the old source code valid, this state must immediately
precede the Paused state.
@todo Lift this spectacularly wonderful restriction.
.. describe:: paused(6)
Execution of the machine has been paused.
For whoever decides to touch this enum: In order to keep the
comparisons in the old source code valid, this state must immediately
follow the Running state.
@todo Lift this spectacularly wonderful restriction.
.. describe:: stuck(7)
Execution of the machine has reached the "Guru Meditation"
condition. This indicates a severe error in the hypervisor itself.
bird: Why this uncool name? Could we rename it to "GuruMeditation" or
"Guru", perhaps? Or are there some other VMM states that are
intended to be lumped in here as well?
.. describe:: teleporting(8)
The machine is about to be teleported to a different host or process.
It is possible to pause a machine in this state, but it will go to the
@c TeleportingPausedVM state and it will not be
possible to resume it again unless the teleportation fails.
.. describe:: live_snapshotting(9)
A live snapshot is being taken. The machine is running normally, but
some of the runtime configuration options are inaccessible. Also, if
paused while in this state it will transition to
@c OnlineSnapshotting and it will not be resume the
execution until the snapshot operation has completed.
.. describe:: starting(10)
Machine is being started after powering it on from a
zero execution state.
.. describe:: stopping(11)
Machine is being normally stopped powering it off, or after the guest OS
has initiated a shutdown sequence.
.. describe:: saving(12)
Machine is saving its execution state to a file.
.. describe:: restoring(13)
Execution state of the machine is being restored from a file
after powering it on from the saved execution state.
.. describe:: teleporting_paused_vm(14)
The machine is being teleported to another host or process, but it is
not running. This is the paused variant of the
@c Teleporting state.
.. describe:: teleporting_in(15)
Teleporting the machine state in from another host or process.
.. describe:: fault_tolerant_syncing(16)
The machine is being synced with a fault tolerant VM running elsewhere.
.. describe:: deleting_snapshot_online(17)
Like @c DeletingSnapshot, but the merging of media is ongoing in
the background while the machine is running.
.. describe:: deleting_snapshot_paused(18)
Like @c DeletingSnapshotOnline, but the machine was paused when the
merging of differencing media was started.
.. describe:: online_snapshotting(19)
Like @c LiveSnapshotting, but the machine was paused when the
merging of differencing media was started.
.. describe:: restoring_snapshot(20)
A machine snapshot is being restored; this typically does not take long.
.. describe:: deleting_snapshot(21)
A machine snapshot is being deleted; this can take a long time since this
may require merging differencing media. This value indicates that the
machine is not running while the snapshot is being deleted.
.. describe:: setting_up(22)
Lengthy setup operation is in progress.
.. describe:: snapshotting(23)
Taking an (offline) snapshot.
.. describe:: first_online(5)
Pseudo-state: first online state (for use in relational expressions).
.. describe:: last_online(19)
Pseudo-state: last online state (for use in relational expressions).
.. describe:: first_transient(8)
Pseudo-state: first transient state (for use in relational expressions).
.. describe:: last_transient(23)
Pseudo-state: last transient state (for use in relational expressions).
"""
__uuid__ = '87f085c3-ca67-4e45-9225-6057f32e9e8e'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('PoweredOff', 1,
'''The machine is not running and has no saved execution state; it has
either never been started or been shut down successfully.'''),
('Saved', 2,
'''The machine is not currently running, but the execution state of the machine
has been saved to an external file when it was running, from where
it can be resumed.'''),
('Teleported', 3,
'''The machine was teleported to a different host (or process) and then
powered off. Take care when powering it on again may corrupt resources
it shares with the teleportation target (e.g. disk and network).'''),
('Aborted', 4,
'''The process running the machine has terminated abnormally. This may
indicate a crash of the VM process in host execution context, or
the VM process has been terminated externally.'''),
('Running', 5,
'''The machine is currently being executed.
For whoever decides to touch this enum: In order to keep the
comparisons in the old source code valid, this state must immediately
precede the Paused state.
@todo Lift this spectacularly wonderful restriction.'''),
('Paused', 6,
'''Execution of the machine has been paused.
For whoever decides to touch this enum: In order to keep the
comparisons in the old source code valid, this state must immediately
follow the Running state.
@todo Lift this spectacularly wonderful restriction.'''),
('Stuck', 7,
'''Execution of the machine has reached the "Guru Meditation"
condition. This indicates a severe error in the hypervisor itself.
bird: Why this uncool name? Could we rename it to "GuruMeditation" or
"Guru", perhaps? Or are there some other VMM states that are
intended to be lumped in here as well?'''),
('Teleporting', 8,
'''The machine is about to be teleported to a different host or process.
It is possible to pause a machine in this state, but it will go to the
@c TeleportingPausedVM state and it will not be
possible to resume it again unless the teleportation fails.'''),
('LiveSnapshotting', 9,
'''A live snapshot is being taken. The machine is running normally, but
some of the runtime configuration options are inaccessible. Also, if
paused while in this state it will transition to
@c OnlineSnapshotting and it will not be resume the
execution until the snapshot operation has completed.'''),
('Starting', 10,
'''Machine is being started after powering it on from a
zero execution state.'''),
('Stopping', 11,
'''Machine is being normally stopped powering it off, or after the guest OS
has initiated a shutdown sequence.'''),
('Saving', 12,
'''Machine is saving its execution state to a file.'''),
('Restoring', 13,
'''Execution state of the machine is being restored from a file
after powering it on from the saved execution state.'''),
('TeleportingPausedVM', 14,
'''The machine is being teleported to another host or process, but it is
not running. This is the paused variant of the
@c Teleporting state.'''),
('TeleportingIn', 15,
'''Teleporting the machine state in from another host or process.'''),
('FaultTolerantSyncing', 16,
'''The machine is being synced with a fault tolerant VM running elsewhere.'''),
('DeletingSnapshotOnline', 17,
'''Like @c DeletingSnapshot, but the merging of media is ongoing in
the background while the machine is running.'''),
('DeletingSnapshotPaused', 18,
'''Like @c DeletingSnapshotOnline, but the machine was paused when the
merging of differencing media was started.'''),
('OnlineSnapshotting', 19,
'''Like @c LiveSnapshotting, but the machine was paused when the
merging of differencing media was started.'''),
('RestoringSnapshot', 20,
'''A machine snapshot is being restored; this typically does not take long.'''),
('DeletingSnapshot', 21,
'''A machine snapshot is being deleted; this can take a long time since this
may require merging differencing media. This value indicates that the
machine is not running while the snapshot is being deleted.'''),
('SettingUp', 22,
'''Lengthy setup operation is in progress.'''),
('Snapshotting', 23,
'''Taking an (offline) snapshot.'''),
('FirstOnline', 5,
'''Pseudo-state: first online state (for use in relational expressions).'''),
('LastOnline', 19,
'''Pseudo-state: last online state (for use in relational expressions).'''),
('FirstTransient', 8,
'''Pseudo-state: first transient state (for use in relational expressions).'''),
('LastTransient', 23,
'''Pseudo-state: last transient state (for use in relational expressions).'''),
]
[docs]class SessionState(Enum):
"""Session state. This enumeration represents possible values of
:py:func:`IMachine.session_state` and :py:func:`ISession.state`
attributes.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: unlocked(1)
In :py:func:`IMachine.session_state` , this means that the machine
is not locked for any sessions.
In :py:func:`ISession.state` , this means that no machine is
currently locked for this session.
.. describe:: locked(2)
In :py:func:`IMachine.session_state` , this means that the machine
is currently locked for a session, whose process identifier can
then be found in the :py:func:`IMachine.session_pid` attribute.
In :py:func:`ISession.state` , this means that a machine is
currently locked for this session, and the mutable machine object
can be found in the :py:func:`ISession.machine` attribute
(see :py:func:`IMachine.lock_machine` for details).
.. describe:: spawning(3)
A new process is being spawned for the machine as a result of
:py:func:`IMachine.launch_vm_process` call. This state also occurs
as a short transient state during an :py:func:`IMachine.lock_machine`
call.
.. describe:: unlocking(4)
The session is being unlocked.
"""
__uuid__ = 'cf2700c0-ea4b-47ae-9725-7810114b94d8'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('Unlocked', 1,
'''In :py:func:`IMachine.session_state` , this means that the machine
is not locked for any sessions.
In :py:func:`ISession.state` , this means that no machine is
currently locked for this session.'''),
('Locked', 2,
'''In :py:func:`IMachine.session_state` , this means that the machine
is currently locked for a session, whose process identifier can
then be found in the :py:func:`IMachine.session_pid` attribute.
In :py:func:`ISession.state` , this means that a machine is
currently locked for this session, and the mutable machine object
can be found in the :py:func:`ISession.machine` attribute
(see :py:func:`IMachine.lock_machine` for details).'''),
('Spawning', 3,
'''A new process is being spawned for the machine as a result of
:py:func:`IMachine.launch_vm_process` call. This state also occurs
as a short transient state during an :py:func:`IMachine.lock_machine`
call.'''),
('Unlocking', 4,
'''The session is being unlocked.'''),
]
[docs]class CPUPropertyType(Enum):
"""Virtual CPU property type. This enumeration represents possible values of the
IMachine get- and setCPUProperty methods.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: pae(1)
This setting determines whether VirtualBox will expose the Physical Address
Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
is not available, it will not be reported.
.. describe:: long_mode(2)
This setting determines whether VirtualBox will advertise long mode
(i.e. 64-bit guest support) and let the guest enter it.
.. describe:: triple_fault_reset(3)
This setting determines whether a triple fault within a guest will
trigger an internal error condition and stop the VM (default) or reset
the virtual CPU/VM and continue execution.
.. describe:: apic(4)
This setting determines whether an APIC is part of the virtual CPU.
This feature can only be turned off when the X2APIC feature is off.
.. describe:: x2_apic(5)
This setting determines whether an x2APIC is part of the virtual CPU.
Since this feature implies that the APIC feature is present, it
automatically enables the APIC feature when set.
"""
__uuid__ = 'cc6ecdad-a07c-4e81-9c0e-d767e0678d5a'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('PAE', 1,
'''This setting determines whether VirtualBox will expose the Physical Address
Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
is not available, it will not be reported.'''),
('LongMode', 2,
'''This setting determines whether VirtualBox will advertise long mode
(i.e. 64-bit guest support) and let the guest enter it.'''),
('TripleFaultReset', 3,
'''This setting determines whether a triple fault within a guest will
trigger an internal error condition and stop the VM (default) or reset
the virtual CPU/VM and continue execution.'''),
('APIC', 4,
'''This setting determines whether an APIC is part of the virtual CPU.
This feature can only be turned off when the X2APIC feature is off.'''),
('X2APIC', 5,
'''This setting determines whether an x2APIC is part of the virtual CPU.
Since this feature implies that the APIC feature is present, it
automatically enables the APIC feature when set.'''),
]
[docs]class HWVirtExPropertyType(Enum):
"""Hardware virtualization property type. This enumeration represents possible values
for the :py:func:`IMachine.get_hw_virt_ex_property` and
:py:func:`IMachine.set_hw_virt_ex_property` methods.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: enabled(1)
Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
such extensions are not available, they will not be used.
.. describe:: vpid(2)
Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
.. describe:: nested_paging(3)
Whether Nested Paging is enabled. If this extension is not available, it will not be used.
.. describe:: unrestricted_execution(4)
Whether VT-x unrestricted execution is enabled. If this feature is not available, it will not be used.
.. describe:: large_pages(5)
Whether large page allocation is enabled; requires nested paging and a 64-bit host.
.. describe:: force(6)
Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
not set, there will be an automatic fallback to software virtualization.
"""
__uuid__ = '411ad0ea-aeeb-44cb-9d03-1624d0d025ac'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('Enabled', 1,
'''Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
such extensions are not available, they will not be used.'''),
('VPID', 2,
'''Whether VT-x VPID is enabled. If this extension is not available, it will not be used.'''),
('NestedPaging', 3,
'''Whether Nested Paging is enabled. If this extension is not available, it will not be used.'''),
('UnrestrictedExecution', 4,
'''Whether VT-x unrestricted execution is enabled. If this feature is not available, it will not be used.'''),
('LargePages', 5,
'''Whether large page allocation is enabled; requires nested paging and a 64-bit host.'''),
('Force', 6,
'''Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
not set, there will be an automatic fallback to software virtualization.'''),
]
[docs]class ParavirtProvider(Enum):
"""The paravirtualized guest interface provider. This enumeration represents possible
values for the :py:func:`IMachine.paravirt_provider` attribute.
.. describe:: none(0)
No provider is used.
.. describe:: default(1)
A default provider is automatically chosen according to the guest OS type.
.. describe:: legacy(2)
Used for VMs which didn't used to have any provider settings. Usually
interpreted as @c None for most VMs.
.. describe:: minimal(3)
A minimal set of features to expose to the paravirtualized guest.
.. describe:: hyper_v(4)
Microsoft Hyper-V.
.. describe:: kvm(5)
Linux KVM.
"""
__uuid__ = '696453ec-3742-4a05-bead-658ccbf2c944'
_enums = [\
('None', 0,
'''No provider is used.'''),
('Default', 1,
'''A default provider is automatically chosen according to the guest OS type.'''),
('Legacy', 2,
'''Used for VMs which didn't used to have any provider settings. Usually
interpreted as @c None for most VMs.'''),
('Minimal', 3,
'''A minimal set of features to expose to the paravirtualized guest.'''),
('HyperV', 4,
'''Microsoft Hyper-V.'''),
('KVM', 5,
'''Linux KVM.'''),
]
[docs]class FaultToleranceState(Enum):
"""Used with :py:func:`IMachine.fault_tolerance_state` .
.. describe:: inactive(1)
No fault tolerance enabled.
.. describe:: master(2)
Fault tolerant master VM.
.. describe:: standby(3)
Fault tolerant standby VM.
"""
__uuid__ = '5124f7ec-6b67-493c-9dee-ee45a44114e1'
_enums = [\
('Inactive', 1,
'''No fault tolerance enabled.'''),
('Master', 2,
'''Fault tolerant master VM.'''),
('Standby', 3,
'''Fault tolerant standby VM.'''),
]
[docs]class LockType(Enum):
"""Used with :py:func:`IMachine.lock_machine` .
.. describe:: null(0)
Placeholder value, do not use when obtaining a lock.
.. describe:: shared(1)
Request only a shared lock for remote-controlling the machine.
Such a lock allows changing certain VM settings which can be safely
modified for a running VM.
.. describe:: write(2)
Lock the machine for writing. This requests an exclusive lock, i.e.
there cannot be any other API client holding any type of lock for this
VM concurrently. Remember that a VM process counts as an API client
which implicitly holds the equivalent of a shared lock during the
entire VM runtime.
.. describe:: vm(3)
Lock the machine for writing, and create objects necessary for
running a VM in this process.
"""
__uuid__ = '678aaf14-2815-4c3e-b20a-e86ed0216498'
_enums = [\
('Null', 0,
'''Placeholder value, do not use when obtaining a lock.'''),
('Shared', 1,
'''Request only a shared lock for remote-controlling the machine.
Such a lock allows changing certain VM settings which can be safely
modified for a running VM.'''),
('Write', 2,
'''Lock the machine for writing. This requests an exclusive lock, i.e.
there cannot be any other API client holding any type of lock for this
VM concurrently. Remember that a VM process counts as an API client
which implicitly holds the equivalent of a shared lock during the
entire VM runtime.'''),
('VM', 3,
'''Lock the machine for writing, and create objects necessary for
running a VM in this process.'''),
]
[docs]class SessionType(Enum):
"""Session type. This enumeration represents possible values of the
:py:func:`ISession.type_p` attribute.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: write_lock(1)
Session has acquired an exclusive write lock on a machine
using :py:func:`IMachine.lock_machine` .
.. describe:: remote(2)
Session has launched a VM process using
:py:func:`IMachine.launch_vm_process`
.. describe:: shared(3)
Session has obtained a link to another session using
:py:func:`IMachine.lock_machine`
"""
__uuid__ = 'A13C02CB-0C2C-421E-8317-AC0E8AAA153A'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('WriteLock', 1,
'''Session has acquired an exclusive write lock on a machine
using :py:func:`IMachine.lock_machine` .'''),
('Remote', 2,
'''Session has launched a VM process using
:py:func:`IMachine.launch_vm_process` '''),
('Shared', 3,
'''Session has obtained a link to another session using
:py:func:`IMachine.lock_machine` '''),
]
[docs]class DeviceType(Enum):
"""Device type.
.. describe:: null(0)
Null value, may also mean "no device" (not allowed for
:py:func:`IConsole.get_device_activity` ).
.. describe:: floppy(1)
Floppy device.
.. describe:: dvd(2)
CD/DVD-ROM device.
.. describe:: hard_disk(3)
Hard disk device.
.. describe:: network(4)
Network device.
.. describe:: usb(5)
USB device.
.. describe:: shared_folder(6)
Shared folder device.
.. describe:: graphics3_d(7)
Graphics device 3D activity.
"""
__uuid__ = 'cb977be1-d1fb-41f8-ad7e-951736c6cb3e'
_enums = [\
('Null', 0,
'''Null value, may also mean "no device" (not allowed for
:py:func:`IConsole.get_device_activity` ).'''),
('Floppy', 1,
'''Floppy device.'''),
('DVD', 2,
'''CD/DVD-ROM device.'''),
('HardDisk', 3,
'''Hard disk device.'''),
('Network', 4,
'''Network device.'''),
('USB', 5,
'''USB device.'''),
('SharedFolder', 6,
'''Shared folder device.'''),
('Graphics3D', 7,
'''Graphics device 3D activity.'''),
]
[docs]class DeviceActivity(Enum):
"""Device activity for :py:func:`IConsole.get_device_activity` .
.. describe:: null(0)
.. describe:: idle(1)
.. describe:: reading(2)
.. describe:: writing(3)
"""
__uuid__ = '6FC8AEAA-130A-4eb5-8954-3F921422D707'
_enums = [\
('Null', 0,
''''''),
('Idle', 1,
''''''),
('Reading', 2,
''''''),
('Writing', 3,
''''''),
]
[docs]class ClipboardMode(Enum):
"""Host-Guest clipboard interchange mode.
.. describe:: disabled(0)
.. describe:: host_to_guest(1)
.. describe:: guest_to_host(2)
.. describe:: bidirectional(3)
"""
__uuid__ = '33364716-4008-4701-8f14-be0fa3d62950'
_enums = [\
('Disabled', 0,
''''''),
('HostToGuest', 1,
''''''),
('GuestToHost', 2,
''''''),
('Bidirectional', 3,
''''''),
]
[docs]class DnDMode(Enum):
"""Drag and drop interchange mode.
.. describe:: disabled(0)
.. describe:: host_to_guest(1)
.. describe:: guest_to_host(2)
.. describe:: bidirectional(3)
"""
__uuid__ = '07af8800-f936-4b33-9172-cd400e83c148'
_enums = [\
('Disabled', 0,
''''''),
('HostToGuest', 1,
''''''),
('GuestToHost', 2,
''''''),
('Bidirectional', 3,
''''''),
]
[docs]class Scope(Enum):
"""Scope of the operation.
A generic enumeration used in various methods to define the action or
argument scope.
.. describe:: global_p(0)
.. describe:: machine(1)
.. describe:: session(2)
"""
__uuid__ = '7c91096e-499e-4eca-9f9b-9001438d7855'
_enums = [\
('Global', 0,
''''''),
('Machine', 1,
''''''),
('Session', 2,
''''''),
]
[docs]class APICMode(Enum):
"""BIOS APIC initialization mode. If the hardware does not support the
mode then the code falls back to a lower mode.
.. describe:: disabled(0)
.. describe:: apic(1)
.. describe:: x2_apic(2)
"""
__uuid__ = 'c6884ba5-3cc4-4a92-a7f6-4410f9fd894e'
_enums = [\
('Disabled', 0,
''''''),
('APIC', 1,
''''''),
('X2APIC', 2,
''''''),
]
[docs]class ProcessorFeature(Enum):
"""CPU features.
.. describe:: hw_virt_ex(0)
.. describe:: pae(1)
.. describe:: long_mode(2)
.. describe:: nested_paging(3)
"""
__uuid__ = '64c38e6b-8bcf-45ad-ac03-9b406287c5bf'
_enums = [\
('HWVirtEx', 0,
''''''),
('PAE', 1,
''''''),
('LongMode', 2,
''''''),
('NestedPaging', 3,
''''''),
]
[docs]class FirmwareType(Enum):
"""Firmware type.
.. describe:: bios(1)
BIOS Firmware.
.. describe:: efi(2)
EFI Firmware, bitness detected basing on OS type.
.. describe:: efi32(3)
EFI firmware, 32-bit.
.. describe:: efi64(4)
EFI firmware, 64-bit.
.. describe:: efidual(5)
EFI firmware, combined 32 and 64-bit.
"""
__uuid__ = 'b903f264-c230-483e-ac74-2b37ce60d371'
_enums = [\
('BIOS', 1,
'''BIOS Firmware.'''),
('EFI', 2,
'''EFI Firmware, bitness detected basing on OS type.'''),
('EFI32', 3,
'''EFI firmware, 32-bit.'''),
('EFI64', 4,
'''EFI firmware, 64-bit.'''),
('EFIDUAL', 5,
'''EFI firmware, combined 32 and 64-bit.'''),
]
[docs]class PointingHIDType(Enum):
"""Type of pointing device used in a virtual machine.
.. describe:: none(1)
No mouse.
.. describe:: ps2_mouse(2)
PS/2 auxiliary device, a.k.a. mouse.
.. describe:: usb_mouse(3)
USB mouse (relative pointer).
.. describe:: usb_tablet(4)
USB tablet (absolute pointer). Also enables a relative USB mouse in
addition.
.. describe:: combo_mouse(5)
Combined device, working as PS/2 or USB mouse, depending on guest
behavior. Using this device can have negative performance implications.
.. describe:: usb_multi_touch(6)
USB multi-touch device. Also enables the USB tablet and mouse devices.
"""
__uuid__ = '19964e93-0050-45c4-9382-a7bccc53e666'
_enums = [\
('None', 1,
'''No mouse.'''),
('PS2Mouse', 2,
'''PS/2 auxiliary device, a.k.a. mouse.'''),
('USBMouse', 3,
'''USB mouse (relative pointer).'''),
('USBTablet', 4,
'''USB tablet (absolute pointer). Also enables a relative USB mouse in
addition.'''),
('ComboMouse', 5,
'''Combined device, working as PS/2 or USB mouse, depending on guest
behavior. Using this device can have negative performance implications.'''),
('USBMultiTouch', 6,
'''USB multi-touch device. Also enables the USB tablet and mouse devices.'''),
]
[docs]class KeyboardHIDType(Enum):
"""Type of keyboard device used in a virtual machine.
.. describe:: none(1)
No keyboard.
.. describe:: ps2_keyboard(2)
PS/2 keyboard.
.. describe:: usb_keyboard(3)
USB keyboard.
.. describe:: combo_keyboard(4)
Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
Using of such device can have negative performance implications.
"""
__uuid__ = '383e43d7-5c7c-4ec8-9cb8-eda1bccd6699'
_enums = [\
('None', 1,
'''No keyboard.'''),
('PS2Keyboard', 2,
'''PS/2 keyboard.'''),
('USBKeyboard', 3,
'''USB keyboard.'''),
('ComboKeyboard', 4,
'''Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
Using of such device can have negative performance implications.'''),
]
[docs]class DhcpOpt(Enum):
"""
.. describe:: subnet_mask(1)
.. describe:: time_offset(2)
.. describe:: router(3)
.. describe:: time_server(4)
.. describe:: name_server(5)
.. describe:: domain_name_server(6)
.. describe:: log_server(7)
.. describe:: cookie(8)
.. describe:: lpr_server(9)
.. describe:: impress_server(10)
.. describe:: resourse_location_server(11)
.. describe:: host_name(12)
.. describe:: boot_file_size(13)
.. describe:: merit_dump_file(14)
.. describe:: domain_name(15)
.. describe:: swap_server(16)
.. describe:: root_path(17)
.. describe:: extension_path(18)
.. describe:: ip_forwarding_enable_disable(19)
.. describe:: non_local_source_routing_enable_disable(20)
.. describe:: policy_filter(21)
.. describe:: maximum_datagram_reassembly_size(22)
.. describe:: default_ip_time2_live(23)
.. describe:: path_mtu_aging_timeout(24)
.. describe:: ip_layer_parameters_per_interface(25)
.. describe:: interface_mtu(26)
.. describe:: all_subnets_are_local(27)
.. describe:: broadcast_address(28)
.. describe:: perform_mask_discovery(29)
.. describe:: mask_supplier(30)
.. describe:: perform_route_discovery(31)
.. describe:: router_solicitation_address(32)
.. describe:: static_route(33)
.. describe:: trailer_encapsulation(34)
.. describe:: arp_cache_timeout(35)
.. describe:: ethernet_encapsulation(36)
.. describe:: tcp_default_ttl(37)
.. describe:: tcp_keep_alive_interval(38)
.. describe:: tcp_keep_alive_garbage(39)
.. describe:: network_information_service_domain(40)
.. describe:: network_information_service_servers(41)
.. describe:: network_time_protocol_servers(42)
.. describe:: vendor_specific_information(43)
.. describe:: option_44(44)
.. describe:: option_45(45)
.. describe:: option_46(46)
.. describe:: option_47(47)
.. describe:: option_48(48)
.. describe:: option_49(49)
.. describe:: ip_address_lease_time(51)
.. describe:: option_64(64)
.. describe:: option_65(65)
.. describe:: tftp_server_name(66)
.. describe:: bootfile_name(67)
.. describe:: option_68(68)
.. describe:: option_69(69)
.. describe:: option_70(70)
.. describe:: option_71(71)
.. describe:: option_72(72)
.. describe:: option_73(73)
.. describe:: option_74(74)
.. describe:: option_75(75)
.. describe:: option_119(119)
"""
__uuid__ = '40d99bd3-3ece-44d2-a07e-1085fe9c4f0b'
_enums = [\
('SubnetMask', 1,
''''''),
('TimeOffset', 2,
''''''),
('Router', 3,
''''''),
('TimeServer', 4,
''''''),
('NameServer', 5,
''''''),
('DomainNameServer', 6,
''''''),
('LogServer', 7,
''''''),
('Cookie', 8,
''''''),
('LPRServer', 9,
''''''),
('ImpressServer', 10,
''''''),
('ResourseLocationServer', 11,
''''''),
('HostName', 12,
''''''),
('BootFileSize', 13,
''''''),
('MeritDumpFile', 14,
''''''),
('DomainName', 15,
''''''),
('SwapServer', 16,
''''''),
('RootPath', 17,
''''''),
('ExtensionPath', 18,
''''''),
('IPForwardingEnableDisable', 19,
''''''),
('NonLocalSourceRoutingEnableDisable', 20,
''''''),
('PolicyFilter', 21,
''''''),
('MaximumDatagramReassemblySize', 22,
''''''),
('DefaultIPTime2Live', 23,
''''''),
('PathMTUAgingTimeout', 24,
''''''),
('IPLayerParametersPerInterface', 25,
''''''),
('InterfaceMTU', 26,
''''''),
('AllSubnetsAreLocal', 27,
''''''),
('BroadcastAddress', 28,
''''''),
('PerformMaskDiscovery', 29,
''''''),
('MaskSupplier', 30,
''''''),
('PerformRouteDiscovery', 31,
''''''),
('RouterSolicitationAddress', 32,
''''''),
('StaticRoute', 33,
''''''),
('TrailerEncapsulation', 34,
''''''),
('ARPCacheTimeout', 35,
''''''),
('EthernetEncapsulation', 36,
''''''),
('TCPDefaultTTL', 37,
''''''),
('TCPKeepAliveInterval', 38,
''''''),
('TCPKeepAliveGarbage', 39,
''''''),
('NetworkInformationServiceDomain', 40,
''''''),
('NetworkInformationServiceServers', 41,
''''''),
('NetworkTimeProtocolServers', 42,
''''''),
('VendorSpecificInformation', 43,
''''''),
('Option_44', 44,
''''''),
('Option_45', 45,
''''''),
('Option_46', 46,
''''''),
('Option_47', 47,
''''''),
('Option_48', 48,
''''''),
('Option_49', 49,
''''''),
('IPAddressLeaseTime', 51,
''''''),
('Option_64', 64,
''''''),
('Option_65', 65,
''''''),
('TFTPServerName', 66,
''''''),
('BootfileName', 67,
''''''),
('Option_68', 68,
''''''),
('Option_69', 69,
''''''),
('Option_70', 70,
''''''),
('Option_71', 71,
''''''),
('Option_72', 72,
''''''),
('Option_73', 73,
''''''),
('Option_74', 74,
''''''),
('Option_75', 75,
''''''),
('Option_119', 119,
''''''),
]
[docs]class DhcpOptEncoding(Enum):
"""
.. describe:: legacy(0)
.. describe:: hex_p(1)
"""
__uuid__ = '88ea6d70-8648-4871-ba30-1f49c61cfaa2'
_enums = [\
('Legacy', 0,
''''''),
('Hex', 1,
''''''),
]
[docs]class VFSType(Enum):
"""Virtual file systems supported by VFSExplorer.
.. describe:: file_p(1)
.. describe:: cloud(2)
.. describe:: s3(3)
.. describe:: web_dav(4)
"""
__uuid__ = '813999ba-b949-48a8-9230-aadc6285e2f2'
_enums = [\
('File', 1,
''''''),
('Cloud', 2,
''''''),
('S3', 3,
''''''),
('WebDav', 4,
''''''),
]
[docs]class ImportOptions(Enum):
"""Import options, used with :py:func:`IAppliance.import_machines` .
.. describe:: keep_all_ma_cs(1)
Don't generate new MAC addresses of the attached network adapters.
.. describe:: keep_natma_cs(2)
Don't generate new MAC addresses of the attached network adapters when they are using NAT.
.. describe:: import_to_vdi(3)
Import all disks to VDI format
"""
__uuid__ = '0a981523-3b20-4004-8ee3-dfd322202ace'
_enums = [\
('KeepAllMACs', 1,
'''Don't generate new MAC addresses of the attached network adapters.'''),
('KeepNATMACs', 2,
'''Don't generate new MAC addresses of the attached network adapters when they are using NAT.'''),
('ImportToVDI', 3,
'''Import all disks to VDI format'''),
]
[docs]class ExportOptions(Enum):
"""Export options, used with :py:func:`IAppliance.write` .
.. describe:: create_manifest(1)
Write the optional manifest file (.mf) which is used for integrity
checks prior import.
.. describe:: export_dvd_images(2)
Export DVD images. Default is not to export them as it is rarely
needed for typical VMs.
.. describe:: strip_all_ma_cs(3)
Do not export any MAC address information. Default is to keep them
to avoid losing information which can cause trouble after import, at the
price of risking duplicate MAC addresses, if the import options are used
to keep them.
.. describe:: strip_all_non_natma_cs(4)
Do not export any MAC address information, except for adapters
using NAT. Default is to keep them to avoid losing information which can
cause trouble after import, at the price of risking duplicate MAC
addresses, if the import options are used to keep them.
"""
__uuid__ = '8f45eb08-fd34-41ee-af95-a880bdee5554'
_enums = [\
('CreateManifest', 1,
'''Write the optional manifest file (.mf) which is used for integrity
checks prior import.'''),
('ExportDVDImages', 2,
'''Export DVD images. Default is not to export them as it is rarely
needed for typical VMs.'''),
('StripAllMACs', 3,
'''Do not export any MAC address information. Default is to keep them
to avoid losing information which can cause trouble after import, at the
price of risking duplicate MAC addresses, if the import options are used
to keep them.'''),
('StripAllNonNATMACs', 4,
'''Do not export any MAC address information, except for adapters
using NAT. Default is to keep them to avoid losing information which can
cause trouble after import, at the price of risking duplicate MAC
addresses, if the import options are used to keep them.'''),
]
[docs]class CertificateVersion(Enum):
"""X.509 certificate version numbers.
.. describe:: v1(1)
.. describe:: v2(2)
.. describe:: v3(3)
.. describe:: unknown(99)
"""
__uuid__ = '9e232a99-51d0-4dbd-96a0-ffac4bc3e2a8'
_enums = [\
('V1', 1,
''''''),
('V2', 2,
''''''),
('V3', 3,
''''''),
('Unknown', 99,
''''''),
]
[docs]class VirtualSystemDescriptionType(Enum):
"""Used with :py:class:`IVirtualSystemDescription` to describe the type of
a configuration value.
.. describe:: ignore(1)
.. describe:: os(2)
.. describe:: name(3)
.. describe:: product(4)
.. describe:: vendor(5)
.. describe:: version(6)
.. describe:: product_url(7)
.. describe:: vendor_url(8)
.. describe:: description(9)
.. describe:: license_p(10)
.. describe:: miscellaneous(11)
.. describe:: cpu(12)
.. describe:: memory(13)
.. describe:: hard_disk_controller_ide(14)
.. describe:: hard_disk_controller_sata(15)
.. describe:: hard_disk_controller_scsi(16)
.. describe:: hard_disk_controller_sas(17)
.. describe:: hard_disk_image(18)
.. describe:: floppy(19)
.. describe:: cdrom(20)
.. describe:: network_adapter(21)
.. describe:: usb_controller(22)
.. describe:: sound_card(23)
.. describe:: settings_file(24)
Not used/implemented right now, will be added later in 4.1.x.
"""
__uuid__ = '303c0900-a746-4612-8c67-79003e91f459'
_enums = [\
('Ignore', 1,
''''''),
('OS', 2,
''''''),
('Name', 3,
''''''),
('Product', 4,
''''''),
('Vendor', 5,
''''''),
('Version', 6,
''''''),
('ProductUrl', 7,
''''''),
('VendorUrl', 8,
''''''),
('Description', 9,
''''''),
('License', 10,
''''''),
('Miscellaneous', 11,
''''''),
('CPU', 12,
''''''),
('Memory', 13,
''''''),
('HardDiskControllerIDE', 14,
''''''),
('HardDiskControllerSATA', 15,
''''''),
('HardDiskControllerSCSI', 16,
''''''),
('HardDiskControllerSAS', 17,
''''''),
('HardDiskImage', 18,
''''''),
('Floppy', 19,
''''''),
('CDROM', 20,
''''''),
('NetworkAdapter', 21,
''''''),
('USBController', 22,
''''''),
('SoundCard', 23,
''''''),
('SettingsFile', 24,
'''Not used/implemented right now, will be added later in 4.1.x.'''),
]
[docs]class VirtualSystemDescriptionValueType(Enum):
"""Used with :py:func:`IVirtualSystemDescription.get_values_by_type` to describe the value
type to fetch.
.. describe:: reference(1)
.. describe:: original(2)
.. describe:: auto(3)
.. describe:: extra_config(4)
"""
__uuid__ = '56d9403f-3425-4118-9919-36f2a9b8c77c'
_enums = [\
('Reference', 1,
''''''),
('Original', 2,
''''''),
('Auto', 3,
''''''),
('ExtraConfig', 4,
''''''),
]
[docs]class GraphicsControllerType(Enum):
"""Graphics controller type, used with :py:func:`IMachine.unregister` .
.. describe:: null(0)
Reserved value, invalid.
.. describe:: v_box_vga(1)
Default VirtualBox VGA device.
.. describe:: vmsvga(2)
VMware SVGA II device.
"""
__uuid__ = '79c96ca0-9f39-4900-948e-68c41cbe127a'
_enums = [\
('Null', 0,
'''Reserved value, invalid.'''),
('VBoxVGA', 1,
'''Default VirtualBox VGA device.'''),
('VMSVGA', 2,
'''VMware SVGA II device.'''),
]
[docs]class CleanupMode(Enum):
"""Cleanup mode, used with :py:func:`IMachine.unregister` .
.. describe:: unregister_only(1)
Unregister only the machine, but neither delete snapshots nor detach media.
.. describe:: detach_all_return_none(2)
Delete all snapshots and detach all media but return none; this will keep all media registered.
.. describe:: detach_all_return_hard_disks_only(3)
Delete all snapshots, detach all media and return hard disks for closing, but not removable media.
.. describe:: full(4)
Delete all snapshots, detach all media and return all media for closing.
"""
__uuid__ = '67897c50-7cca-47a9-83f6-ce8fd8eb5441'
_enums = [\
('UnregisterOnly', 1,
'''Unregister only the machine, but neither delete snapshots nor detach media.'''),
('DetachAllReturnNone', 2,
'''Delete all snapshots and detach all media but return none; this will keep all media registered.'''),
('DetachAllReturnHardDisksOnly', 3,
'''Delete all snapshots, detach all media and return hard disks for closing, but not removable media.'''),
('Full', 4,
'''Delete all snapshots, detach all media and return all media for closing.'''),
]
[docs]class CloneMode(Enum):
"""Clone mode, used with :py:func:`IMachine.clone_to` .
.. describe:: machine_state(1)
Clone the state of the selected machine.
.. describe:: machine_and_child_states(2)
Clone the state of the selected machine and its child snapshots if present.
.. describe:: all_states(3)
Clone all states (including all snapshots) of the machine, regardless of the machine object used.
"""
__uuid__ = 'A7A159FE-5096-4B8D-8C3C-D033CB0B35A8'
_enums = [\
('MachineState', 1,
'''Clone the state of the selected machine.'''),
('MachineAndChildStates', 2,
'''Clone the state of the selected machine and its child snapshots if present.'''),
('AllStates', 3,
'''Clone all states (including all snapshots) of the machine, regardless of the machine object used.'''),
]
[docs]class CloneOptions(Enum):
"""Clone options, used with :py:func:`IMachine.clone_to` .
.. describe:: link(1)
Create a clone VM where all virtual disks are linked to the original VM.
.. describe:: keep_all_ma_cs(2)
Don't generate new MAC addresses of the attached network adapters.
.. describe:: keep_natma_cs(3)
Don't generate new MAC addresses of the attached network adapters when they are using NAT.
.. describe:: keep_disk_names(4)
Don't change the disk names.
"""
__uuid__ = '22243f8e-96ab-497c-8cf0-f40a566c630b'
_enums = [\
('Link', 1,
'''Create a clone VM where all virtual disks are linked to the original VM.'''),
('KeepAllMACs', 2,
'''Don't generate new MAC addresses of the attached network adapters.'''),
('KeepNATMACs', 3,
'''Don't generate new MAC addresses of the attached network adapters when they are using NAT.'''),
('KeepDiskNames', 4,
'''Don't change the disk names.'''),
]
[docs]class AutostopType(Enum):
"""Autostop types, used with :py:func:`IMachine.autostop_type` .
.. describe:: disabled(1)
Stopping the VM during system shutdown is disabled.
.. describe:: save_state(2)
The state of the VM will be saved when the system shuts down.
.. describe:: power_off(3)
The VM is powered off when the system shuts down.
.. describe:: acpi_shutdown(4)
An ACPI shutdown event is generated.
"""
__uuid__ = '6bb96740-cf34-470d-aab2-2cd48ea2e10e'
_enums = [\
('Disabled', 1,
'''Stopping the VM during system shutdown is disabled.'''),
('SaveState', 2,
'''The state of the VM will be saved when the system shuts down.'''),
('PowerOff', 3,
'''The VM is powered off when the system shuts down.'''),
('AcpiShutdown', 4,
'''An ACPI shutdown event is generated.'''),
]
[docs]class HostNetworkInterfaceMediumType(Enum):
"""Type of encapsulation. Ethernet encapsulation includes both wired and
wireless Ethernet connections.
:py:class:`IHostNetworkInterface`
.. describe:: unknown(0)
The type of interface cannot be determined.
.. describe:: ethernet(1)
Ethernet frame encapsulation.
.. describe:: ppp(2)
Point-to-point protocol encapsulation.
.. describe:: slip(3)
Serial line IP encapsulation.
"""
__uuid__ = '1aa54aaf-2497-45a2-bfb1-8eb225e93d5b'
_enums = [\
('Unknown', 0,
'''The type of interface cannot be determined.'''),
('Ethernet', 1,
'''Ethernet frame encapsulation.'''),
('PPP', 2,
'''Point-to-point protocol encapsulation.'''),
('SLIP', 3,
'''Serial line IP encapsulation.'''),
]
[docs]class HostNetworkInterfaceStatus(Enum):
"""Current status of the interface.
:py:class:`IHostNetworkInterface`
.. describe:: unknown(0)
The state of interface cannot be determined.
.. describe:: up(1)
The interface is fully operational.
.. describe:: down(2)
The interface is not functioning.
"""
__uuid__ = 'CC474A69-2710-434B-8D99-C38E5D5A6F41'
_enums = [\
('Unknown', 0,
'''The state of interface cannot be determined.'''),
('Up', 1,
'''The interface is fully operational.'''),
('Down', 2,
'''The interface is not functioning.'''),
]
[docs]class HostNetworkInterfaceType(Enum):
"""Network interface type.
.. describe:: bridged(1)
.. describe:: host_only(2)
"""
__uuid__ = '67431b00-9946-48a2-bc02-b25c5919f4f3'
_enums = [\
('Bridged', 1,
''''''),
('HostOnly', 2,
''''''),
]
[docs]class AdditionsFacilityType(Enum):
"""Guest Additions facility IDs.
.. describe:: none(0)
No/invalid facility.
.. describe:: v_box_guest_driver(20)
VirtualBox base driver (VBoxGuest).
.. describe:: auto_logon(90)
Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).
.. describe:: v_box_service(100)
VirtualBox system service (VBoxService).
.. describe:: v_box_tray_client(101)
VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).
.. describe:: seamless(1000)
Seamless guest desktop integration.
.. describe:: graphics(1100)
Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
are not immediately acted on and guest display resizes are probably not initiated by
the guest additions.
.. describe:: all_p(2147483646)
All facilities selected.
"""
__uuid__ = '98f7f957-89fb-49b6-a3b1-31e3285eb1d8'
_enums = [\
('None', 0,
'''No/invalid facility.'''),
('VBoxGuestDriver', 20,
'''VirtualBox base driver (VBoxGuest).'''),
('AutoLogon', 90,
'''Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).'''),
('VBoxService', 100,
'''VirtualBox system service (VBoxService).'''),
('VBoxTrayClient', 101,
'''VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).'''),
('Seamless', 1000,
'''Seamless guest desktop integration.'''),
('Graphics', 1100,
'''Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
are not immediately acted on and guest display resizes are probably not initiated by
the guest additions.'''),
('All', 2147483646,
'''All facilities selected.'''),
]
[docs]class AdditionsFacilityClass(Enum):
"""Guest Additions facility classes.
.. describe:: none(0)
No/invalid class.
.. describe:: driver(10)
Driver.
.. describe:: service(30)
System service.
.. describe:: program(50)
Program.
.. describe:: feature(100)
Feature.
.. describe:: third_party(999)
Third party.
.. describe:: all_p(2147483646)
All facility classes selected.
"""
__uuid__ = '446451b2-c88d-4e5d-84c9-91bc7f533f5f'
_enums = [\
('None', 0,
'''No/invalid class.'''),
('Driver', 10,
'''Driver.'''),
('Service', 30,
'''System service.'''),
('Program', 50,
'''Program.'''),
('Feature', 100,
'''Feature.'''),
('ThirdParty', 999,
'''Third party.'''),
('All', 2147483646,
'''All facility classes selected.'''),
]
[docs]class AdditionsFacilityStatus(Enum):
"""Guest Additions facility states.
.. describe:: inactive(0)
Facility is not active.
.. describe:: paused(1)
Facility has been paused.
.. describe:: pre_init(20)
Facility is preparing to initialize.
.. describe:: init(30)
Facility is initializing.
.. describe:: active(50)
Facility is up and running.
.. describe:: terminating(100)
Facility is shutting down.
.. describe:: terminated(101)
Facility successfully shut down.
.. describe:: failed(800)
Facility failed to start.
.. describe:: unknown(999)
Facility status is unknown.
"""
__uuid__ = 'ce06f9e1-394e-4fe9-9368-5a88c567dbde'
_enums = [\
('Inactive', 0,
'''Facility is not active.'''),
('Paused', 1,
'''Facility has been paused.'''),
('PreInit', 20,
'''Facility is preparing to initialize.'''),
('Init', 30,
'''Facility is initializing.'''),
('Active', 50,
'''Facility is up and running.'''),
('Terminating', 100,
'''Facility is shutting down.'''),
('Terminated', 101,
'''Facility successfully shut down.'''),
('Failed', 800,
'''Facility failed to start.'''),
('Unknown', 999,
'''Facility status is unknown.'''),
]
[docs]class AdditionsRunLevelType(Enum):
"""Guest Additions run level type.
.. describe:: none(0)
Guest Additions are not loaded.
.. describe:: system(1)
Guest drivers are loaded.
.. describe:: userland(2)
Common components (such as application services) are loaded.
.. describe:: desktop(3)
Per-user desktop components are loaded.
"""
__uuid__ = 'a25417ee-a9dd-4f5b-b0dc-377860087754'
_enums = [\
('None', 0,
'''Guest Additions are not loaded.'''),
('System', 1,
'''Guest drivers are loaded.'''),
('Userland', 2,
'''Common components (such as application services) are loaded.'''),
('Desktop', 3,
'''Per-user desktop components are loaded.'''),
]
[docs]class AdditionsUpdateFlag(Enum):
"""Guest Additions update flags.
.. describe:: none(0)
No flag set.
.. describe:: wait_for_update_start_only(1)
Starts the regular updating process and waits until the
actual Guest Additions update inside the guest was started.
This can be necessary due to needed interaction with the guest
OS during the installation phase.
"""
__uuid__ = '726a818d-18d6-4389-94e8-3e9e6826171a'
_enums = [\
('None', 0,
'''No flag set.'''),
('WaitForUpdateStartOnly', 1,
'''Starts the regular updating process and waits until the
actual Guest Additions update inside the guest was started.
This can be necessary due to needed interaction with the guest
OS during the installation phase.'''),
]
[docs]class GuestSessionStatus(Enum):
"""Guest session status. This enumeration represents possible values of
the :py:func:`IGuestSession.status` attribute.
.. describe:: undefined(0)
Guest session is in an undefined state.
.. describe:: starting(10)
Guest session is being started.
.. describe:: started(100)
Guest session has been started.
.. describe:: terminating(480)
Guest session is being terminated.
.. describe:: terminated(500)
Guest session terminated normally.
.. describe:: timed_out_killed(512)
Guest session timed out and was killed.
.. describe:: timed_out_abnormally(513)
Guest session timed out and was not killed successfully.
.. describe:: down(600)
Service/OS is stopping, guest session was killed.
.. describe:: error(800)
Something went wrong.
"""
__uuid__ = 'ac2669da-4624-44f2-85b5-0b0bfb8d8673'
_enums = [\
('Undefined', 0,
'''Guest session is in an undefined state.'''),
('Starting', 10,
'''Guest session is being started.'''),
('Started', 100,
'''Guest session has been started.'''),
('Terminating', 480,
'''Guest session is being terminated.'''),
('Terminated', 500,
'''Guest session terminated normally.'''),
('TimedOutKilled', 512,
'''Guest session timed out and was killed.'''),
('TimedOutAbnormally', 513,
'''Guest session timed out and was not killed successfully.'''),
('Down', 600,
'''Service/OS is stopping, guest session was killed.'''),
('Error', 800,
'''Something went wrong.'''),
]
[docs]class GuestSessionWaitForFlag(Enum):
"""Guest session waiting flags. Multiple flags can be combined.
.. describe:: none(0)
No waiting flags specified. Do not use this.
.. describe:: start(1)
Wait for the guest session being started.
.. describe:: terminate(2)
Wait for the guest session being terminated.
.. describe:: status(4)
Wait for the next guest session status change.
"""
__uuid__ = 'bb7a372a-f635-4e11-a81a-e707f3a52ef5'
_enums = [\
('None', 0,
'''No waiting flags specified. Do not use this.'''),
('Start', 1,
'''Wait for the guest session being started.'''),
('Terminate', 2,
'''Wait for the guest session being terminated.'''),
('Status', 4,
'''Wait for the next guest session status change.'''),
]
[docs]class GuestSessionWaitResult(Enum):
"""Guest session waiting results. Depending on the session waiting flags (for
more information see :py:class:`GuestSessionWaitForFlag` ) the waiting result
can vary based on the session's current status.
To wait for a guest session to terminate after it has been
created by :py:func:`IGuest.create_session` one would specify
GuestSessionWaitResult_Terminate.
.. describe:: none(0)
No result was returned. Not being used.
.. describe:: start(1)
The guest session has been started.
.. describe:: terminate(2)
The guest session has been terminated.
.. describe:: status(3)
The guest session has changed its status. The status then can
be retrieved via :py:func:`IGuestSession.status` .
.. describe:: error(4)
Error while executing the process.
.. describe:: timeout(5)
The waiting operation timed out. This also will happen
when no event has been occurred matching the
current waiting flags in a :py:func:`IGuestSession.wait_for` call.
.. describe:: wait_flag_not_supported(6)
A waiting flag specified in the :py:func:`IGuestSession.wait_for` call
is not supported by the guest.
"""
__uuid__ = 'c0f6a8a5-fdb6-42bf-a582-56c6f82bcd2d'
_enums = [\
('None', 0,
'''No result was returned. Not being used.'''),
('Start', 1,
'''The guest session has been started.'''),
('Terminate', 2,
'''The guest session has been terminated.'''),
('Status', 3,
'''The guest session has changed its status. The status then can
be retrieved via :py:func:`IGuestSession.status` .'''),
('Error', 4,
'''Error while executing the process.'''),
('Timeout', 5,
'''The waiting operation timed out. This also will happen
when no event has been occurred matching the
current waiting flags in a :py:func:`IGuestSession.wait_for` call.'''),
('WaitFlagNotSupported', 6,
'''A waiting flag specified in the :py:func:`IGuestSession.wait_for` call
is not supported by the guest.'''),
]
[docs]class GuestUserState(Enum):
"""State a guest user has been changed to.
.. describe:: unknown(0)
Unknown state. Not being used.
.. describe:: logged_in(1)
A guest user has been successfully logged into
the guest OS.
This property is not implemented yet!
.. describe:: logged_out(2)
A guest user has been successfully logged out
of the guest OS.
This property is not implemented yet!
.. describe:: locked(3)
A guest user has locked its account. This might
include running a password-protected screensaver
in the guest.
This property is not implemented yet!
.. describe:: unlocked(4)
A guest user has unlocked its account.
This property is not implemented yet!
.. describe:: disabled(5)
A guest user has been disabled by the guest OS.
This property is not implemented yet!
.. describe:: idle(6)
A guest user currently is not using the guest OS.
Currently only available for Windows guests since
Windows 2000 SP2.
On Windows guests this function currently only supports
reporting contiguous idle times up to 49.7 days per user.
The event will be triggered if a guest user is not active for
at least 5 seconds. This threshold can be adjusted by either altering
VBoxService's command line in the guest to
--vminfo-user-idle-threshold
, or by setting the per-VM guest property
/VirtualBox/GuestAdd/VBoxService/--vminfo-user-idle-threshold
with the RDONLYGUEST flag on the host. In both cases VBoxService needs
to be restarted in order to get the changes applied.
.. describe:: in_use(7)
A guest user continued using the guest OS after
being idle.
.. describe:: created(8)
A guest user has been successfully created.
This property is not implemented yet!
.. describe:: deleted(9)
A guest user has been successfully deleted.
This property is not implemented yet!
.. describe:: session_changed(10)
To guest OS has changed the session of a user.
This property is not implemented yet!
.. describe:: credentials_changed(11)
To guest OS has changed the authentication
credentials of a user. This might include changed passwords
and authentication types.
This property is not implemented yet!
.. describe:: role_changed(12)
To guest OS has changed the role of a user permanently,
e.g. granting / denying administrative rights.
This property is not implemented yet!
.. describe:: group_added(13)
To guest OS has added a user to a specific
user group.
This property is not implemented yet!
.. describe:: group_removed(14)
To guest OS has removed a user from a specific
user group.
This property is not implemented yet!
.. describe:: elevated(15)
To guest OS temporarily has elevated a user
to perform a certain task.
This property is not implemented yet!
"""
__uuid__ = 'b2a82b02-fd3d-4fc2-ba84-6ba5ac8be198'
_enums = [\
('Unknown', 0,
'''Unknown state. Not being used.'''),
('LoggedIn', 1,
'''A guest user has been successfully logged into
the guest OS.
This property is not implemented yet!'''),
('LoggedOut', 2,
'''A guest user has been successfully logged out
of the guest OS.
This property is not implemented yet!'''),
('Locked', 3,
'''A guest user has locked its account. This might
include running a password-protected screensaver
in the guest.
This property is not implemented yet!'''),
('Unlocked', 4,
'''A guest user has unlocked its account.
This property is not implemented yet!'''),
('Disabled', 5,
'''A guest user has been disabled by the guest OS.
This property is not implemented yet!'''),
('Idle', 6,
'''A guest user currently is not using the guest OS.
Currently only available for Windows guests since
Windows 2000 SP2.
On Windows guests this function currently only supports
reporting contiguous idle times up to 49.7 days per user.
The event will be triggered if a guest user is not active for
at least 5 seconds. This threshold can be adjusted by either altering
VBoxService's command line in the guest to
--vminfo-user-idle-threshold
, or by setting the per-VM guest property
/VirtualBox/GuestAdd/VBoxService/--vminfo-user-idle-threshold
with the RDONLYGUEST flag on the host. In both cases VBoxService needs
to be restarted in order to get the changes applied.'''),
('InUse', 7,
'''A guest user continued using the guest OS after
being idle.'''),
('Created', 8,
'''A guest user has been successfully created.
This property is not implemented yet!'''),
('Deleted', 9,
'''A guest user has been successfully deleted.
This property is not implemented yet!'''),
('SessionChanged', 10,
'''To guest OS has changed the session of a user.
This property is not implemented yet!'''),
('CredentialsChanged', 11,
'''To guest OS has changed the authentication
credentials of a user. This might include changed passwords
and authentication types.
This property is not implemented yet!'''),
('RoleChanged', 12,
'''To guest OS has changed the role of a user permanently,
e.g. granting / denying administrative rights.
This property is not implemented yet!'''),
('GroupAdded', 13,
'''To guest OS has added a user to a specific
user group.
This property is not implemented yet!'''),
('GroupRemoved', 14,
'''To guest OS has removed a user from a specific
user group.
This property is not implemented yet!'''),
('Elevated', 15,
'''To guest OS temporarily has elevated a user
to perform a certain task.
This property is not implemented yet!'''),
]
[docs]class FileSeekOrigin(Enum):
"""What a file seek (:py:func:`IFile.seek` ) is relative to.
.. describe:: begin(0)
Seek from the beginning of the file.
.. describe:: current(1)
Seek from the current file position.
.. describe:: end(2)
Seek relative to the end of the file. To seek to the position two
bytes from the end of the file, specify -2 as the seek offset.
"""
__uuid__ = 'ad32f789-4279-4530-979c-f16892e1c263'
_enums = [\
('Begin', 0,
'''Seek from the beginning of the file.'''),
('Current', 1,
'''Seek from the current file position.'''),
('End', 2,
'''Seek relative to the end of the file. To seek to the position two
bytes from the end of the file, specify -2 as the seek offset.'''),
]
[docs]class ProcessOutputFlag(Enum):
"""Guest process output flags for specifying which
type of output to retrieve.
.. describe:: none(0)
No flags set. Get output from stdout.
.. describe:: std_err(1)
Get output from stderr.
"""
__uuid__ = '9979e85a-52bb-40b7-870c-57115e27e0f1'
_enums = [\
('None', 0,
'''No flags set. Get output from stdout.'''),
('StdErr', 1,
'''Get output from stderr.'''),
]
[docs]class ProcessWaitForFlag(Enum):
"""Process waiting flags. Multiple flags can be combined.
.. describe:: none(0)
No waiting flags specified. Do not use this.
.. describe:: start(1)
Wait for the process being started.
.. describe:: terminate(2)
Wait for the process being terminated.
.. describe:: std_in(4)
Wait for stdin becoming available.
.. describe:: std_out(8)
Wait for data becoming available on stdout.
.. describe:: std_err(16)
Wait for data becoming available on stderr.
"""
__uuid__ = '23b550c7-78e1-437e-98f0-65fd9757bcd2'
_enums = [\
('None', 0,
'''No waiting flags specified. Do not use this.'''),
('Start', 1,
'''Wait for the process being started.'''),
('Terminate', 2,
'''Wait for the process being terminated.'''),
('StdIn', 4,
'''Wait for stdin becoming available.'''),
('StdOut', 8,
'''Wait for data becoming available on stdout.'''),
('StdErr', 16,
'''Wait for data becoming available on stderr.'''),
]
[docs]class ProcessWaitResult(Enum):
"""Process waiting results. Depending on the process waiting flags (for
more information see :py:class:`ProcessWaitForFlag` ) the waiting result
can vary based on the processes' current status.
To wait for a guest process to terminate after it has been
created by :py:func:`IGuestSession.process_create` or :py:func:`IGuestSession.process_create_ex`
one would specify ProcessWaitFor_Terminate.
If a guest process has been started with ProcessCreateFlag_WaitForStdOut
a client can wait with ProcessWaitResult_StdOut for new data to arrive on
stdout; same applies for ProcessCreateFlag_WaitForStdErr and
ProcessWaitResult_StdErr.
.. describe:: none(0)
No result was returned. Not being used.
.. describe:: start(1)
The process has been started.
.. describe:: terminate(2)
The process has been terminated.
.. describe:: status(3)
The process has changed its status. The status then can
be retrieved via :py:func:`IProcess.status` .
.. describe:: error(4)
Error while executing the process.
.. describe:: timeout(5)
The waiting operation timed out. Also use if the guest process has
timed out in the guest side (kill attempted).
.. describe:: std_in(6)
The process signalled that stdin became available for writing.
.. describe:: std_out(7)
Data on stdout became available for reading.
.. describe:: std_err(8)
Data on stderr became available for reading.
.. describe:: wait_flag_not_supported(9)
A waiting flag specified in the :py:func:`IProcess.wait_for` call
is not supported by the guest.
"""
__uuid__ = '40719cbe-f192-4fe9-a231-6697b3c8e2b4'
_enums = [\
('None', 0,
'''No result was returned. Not being used.'''),
('Start', 1,
'''The process has been started.'''),
('Terminate', 2,
'''The process has been terminated.'''),
('Status', 3,
'''The process has changed its status. The status then can
be retrieved via :py:func:`IProcess.status` .'''),
('Error', 4,
'''Error while executing the process.'''),
('Timeout', 5,
'''The waiting operation timed out. Also use if the guest process has
timed out in the guest side (kill attempted).'''),
('StdIn', 6,
'''The process signalled that stdin became available for writing.'''),
('StdOut', 7,
'''Data on stdout became available for reading.'''),
('StdErr', 8,
'''Data on stderr became available for reading.'''),
('WaitFlagNotSupported', 9,
'''A waiting flag specified in the :py:func:`IProcess.wait_for` call
is not supported by the guest.'''),
]
[docs]class FileCopyFlag(Enum):
"""File copying flags.
Not flags are implemented yet.
.. describe:: none(0)
No flag set.
.. describe:: no_replace(1)
Do not replace the destination file if it exists.
This flag is not implemented yet.
.. describe:: follow_links(2)
Follow symbolic links.
This flag is not implemented yet.
.. describe:: update(4)
Only copy when the source file is newer than the destination file
or when the destination file is missing.
This flag is not implemented yet.
"""
__uuid__ = '791909d7-4c64-2fa4-4303-adb10658d347'
_enums = [\
('None', 0,
'''No flag set.'''),
('NoReplace', 1,
'''Do not replace the destination file if it exists.
This flag is not implemented yet.'''),
('FollowLinks', 2,
'''Follow symbolic links.
This flag is not implemented yet.'''),
('Update', 4,
'''Only copy when the source file is newer than the destination file
or when the destination file is missing.
This flag is not implemented yet.'''),
]
[docs]class FsObjMoveFlags(Enum):
"""File moving flags.
.. describe:: none(0)
No flag set.
.. describe:: replace(1)
Replace the destination file, symlink, etc if it exists, however this
does not allow replacing any directories.
.. describe:: follow_links(2)
Follow symbolic links in the final components or not (only applied to
the given source and target paths, not to anything else).
.. describe:: allow_directory_moves(4)
Allow moving directories accross file system boundraries. Because it
is could be a big undertaking, we require extra assurance that we
should do it when requested.
"""
__uuid__ = '98fdd11f-4063-ac60-5737-e49092aab95f'
_enums = [\
('None', 0,
'''No flag set.'''),
('Replace', 1,
'''Replace the destination file, symlink, etc if it exists, however this
does not allow replacing any directories.'''),
('FollowLinks', 2,
'''Follow symbolic links in the final components or not (only applied to
the given source and target paths, not to anything else).'''),
('AllowDirectoryMoves', 4,
'''Allow moving directories accross file system boundraries. Because it
is could be a big undertaking, we require extra assurance that we
should do it when requested.'''),
]
[docs]class DirectoryCreateFlag(Enum):
"""Directory creation flags.
.. describe:: none(0)
No flag set.
.. describe:: parents(1)
No error if existing, make parent directories as needed.
"""
__uuid__ = 'bd721b0e-ced5-4f79-b368-249897c32a36'
_enums = [\
('None', 0,
'''No flag set.'''),
('Parents', 1,
'''No error if existing, make parent directories as needed.'''),
]
[docs]class DirectoryCopyFlags(Enum):
"""Directory copying flags.
Not flags are implemented yet.
.. describe:: none(0)
No flag set.
.. describe:: copy_into_existing(1)
Allow copying into an existing destination directory.
"""
__uuid__ = 'cc500f0c-4a54-88c9-56b3-7e9310416da7'
_enums = [\
('None', 0,
'''No flag set.'''),
('CopyIntoExisting', 1,
'''Allow copying into an existing destination directory.'''),
]
[docs]class DirectoryRemoveRecFlag(Enum):
"""Directory recursive removement flags.
WARNING!! THE FLAGS ARE CURRENTLY IGNORED. THE METHOD APPLIES
:py:attr:`DirectoryRemoveRecFlag.content_and_dir` REGARDLESS
OF THE INPUT.
.. describe:: none(0)
No flag set.
.. describe:: content_and_dir(1)
Delete the content of the directory and the directory itself.
.. describe:: content_only(2)
Only delete the content of the directory, omit the directory it self.
"""
__uuid__ = '455aabf0-7692-48f6-9061-f21579b65769'
_enums = [\
('None', 0,
'''No flag set.'''),
('ContentAndDir', 1,
'''Delete the content of the directory and the directory itself.'''),
('ContentOnly', 2,
'''Only delete the content of the directory, omit the directory it self.'''),
]
[docs]class FsObjRenameFlag(Enum):
"""Flags for use when renaming file system objects (files, directories,
symlink, etc), see :py:func:`IGuestSession.fs_obj_rename` .
.. describe:: no_replace(0)
Do not replace any destination object.
.. describe:: replace(1)
This will attempt to replace any destination object other except
directories. (The default is to fail if the destination exists.)
"""
__uuid__ = '59bbf3a1-4e23-d7cf-05d5-ccae32080ed2'
_enums = [\
('NoReplace', 0,
'''Do not replace any destination object.'''),
('Replace', 1,
'''This will attempt to replace any destination object other except
directories. (The default is to fail if the destination exists.)'''),
]
[docs]class ProcessCreateFlag(Enum):
"""Guest process execution flags.
The values are passed to the guest additions, so its not possible
to change (move) or reuse values.here. See EXECUTEPROCESSFLAG_XXX
in GuestControlSvc.h.
.. describe:: none(0)
No flag set.
.. describe:: wait_for_process_start_only(1)
Only use the specified timeout value to wait for starting the guest process - the guest
process itself then uses an infinite timeout.
.. describe:: ignore_orphaned_processes(2)
Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.
.. describe:: hidden(4)
Do not show the started process according to the guest OS guidelines.
.. describe:: profile(8)
Utilize the user's profile data when exeuting a process. Only available for Windows guests at the moment.
.. describe:: wait_for_std_out(16)
The guest process waits until all data from stdout is read out.
.. describe:: wait_for_std_err(32)
The guest process waits until all data from stderr is read out.
.. describe:: expand_arguments(64)
Expands environment variables in process arguments.
This is not yet implemented and is currently silently ignored.
We will document the protocolVersion number for this feature once it
appears, so don't use it till then.
.. describe:: unquoted_arguments(128)
Work around for Windows and OS/2 applications not following normal
argument quoting and escaping rules. The arguments are passed to the
application without any extra quoting, just a single space between each.
Present since VirtualBox 4.3.28 and 5.0 beta 3.
"""
__uuid__ = 'C544CD2B-F02D-4886-9901-71C523DB8DC5'
_enums = [\
('None', 0,
'''No flag set.'''),
('WaitForProcessStartOnly', 1,
'''Only use the specified timeout value to wait for starting the guest process - the guest
process itself then uses an infinite timeout.'''),
('IgnoreOrphanedProcesses', 2,
'''Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.'''),
('Hidden', 4,
'''Do not show the started process according to the guest OS guidelines.'''),
('Profile', 8,
'''Utilize the user's profile data when exeuting a process. Only available for Windows guests at the moment.'''),
('WaitForStdOut', 16,
'''The guest process waits until all data from stdout is read out.'''),
('WaitForStdErr', 32,
'''The guest process waits until all data from stderr is read out.'''),
('ExpandArguments', 64,
'''Expands environment variables in process arguments.
This is not yet implemented and is currently silently ignored.
We will document the protocolVersion number for this feature once it
appears, so don't use it till then.'''),
('UnquotedArguments', 128,
'''Work around for Windows and OS/2 applications not following normal
argument quoting and escaping rules. The arguments are passed to the
application without any extra quoting, just a single space between each.
Present since VirtualBox 4.3.28 and 5.0 beta 3.'''),
]
[docs]class ProcessPriority(Enum):
"""Process priorities.
.. describe:: invalid(0)
Invalid priority, do not use.
.. describe:: default(1)
Default process priority determined by the OS.
"""
__uuid__ = 'ee8cac50-e232-49fe-806b-d1214d9c2e49'
_enums = [\
('Invalid', 0,
'''Invalid priority, do not use.'''),
('Default', 1,
'''Default process priority determined by the OS.'''),
]
[docs]class SymlinkType(Enum):
"""Symbolic link types. This is significant when creating links on the
Windows platform, ignored elsewhere.
.. describe:: unknown(0)
It is not known what is being targeted.
.. describe:: directory(1)
The link targets a directory.
.. describe:: file_p(2)
The link targets a file (or whatever else except directories).
"""
__uuid__ = '37794668-f8f1-4714-98a5-6f8fa2ed0118'
_enums = [\
('Unknown', 0,
'''It is not known what is being targeted.'''),
('Directory', 1,
'''The link targets a directory.'''),
('File', 2,
'''The link targets a file (or whatever else except directories).'''),
]
[docs]class SymlinkReadFlag(Enum):
"""Symbolic link reading flags.
.. describe:: none(0)
No flags set.
.. describe:: no_symlinks(1)
Don't allow symbolic links as part of the path.
"""
__uuid__ = 'b7fe2b9d-790e-4b25-8adf-1ca33026931f'
_enums = [\
('None', 0,
'''No flags set.'''),
('NoSymlinks', 1,
'''Don't allow symbolic links as part of the path.'''),
]
[docs]class ProcessStatus(Enum):
"""Process execution statuses.
.. describe:: undefined(0)
Process is in an undefined state.
.. describe:: starting(10)
Process is being started.
.. describe:: started(100)
Process has been started.
.. describe:: paused(110)
Process has been paused.
.. describe:: terminating(480)
Process is being terminated.
.. describe:: terminated_normally(500)
Process terminated normally.
.. describe:: terminated_signal(510)
Process terminated via signal.
.. describe:: terminated_abnormally(511)
Process terminated abnormally.
.. describe:: timed_out_killed(512)
Process timed out and was killed.
.. describe:: timed_out_abnormally(513)
Process timed out and was not killed successfully.
.. describe:: down(600)
Service/OS is stopping, process was killed.
.. describe:: error(800)
Something went wrong.
"""
__uuid__ = '4d52368f-5b48-4bfe-b486-acf89139b52f'
_enums = [\
('Undefined', 0,
'''Process is in an undefined state.'''),
('Starting', 10,
'''Process is being started.'''),
('Started', 100,
'''Process has been started.'''),
('Paused', 110,
'''Process has been paused.'''),
('Terminating', 480,
'''Process is being terminated.'''),
('TerminatedNormally', 500,
'''Process terminated normally.'''),
('TerminatedSignal', 510,
'''Process terminated via signal.'''),
('TerminatedAbnormally', 511,
'''Process terminated abnormally.'''),
('TimedOutKilled', 512,
'''Process timed out and was killed.'''),
('TimedOutAbnormally', 513,
'''Process timed out and was not killed successfully.'''),
('Down', 600,
'''Service/OS is stopping, process was killed.'''),
('Error', 800,
'''Something went wrong.'''),
]
[docs]class PathStyle(Enum):
"""The path style of a system.
(Values matches the RTPATH_STR_F_STYLE_XXX defines in iprt/path.h!)
.. describe:: dos(1)
DOS-style paths with forward and backward slashes, drive
letters and UNC. Known from DOS, OS/2 and Windows.
.. describe:: unix(2)
UNIX-style paths with forward slashes only.
.. describe:: unknown(8)
The path style is not known, most likely because the guest additions
aren't active yet.
"""
__uuid__ = '97303a5b-42e8-0a55-d16f-d2a92c295261'
_enums = [\
('DOS', 1,
'''DOS-style paths with forward and backward slashes, drive
letters and UNC. Known from DOS, OS/2 and Windows.'''),
('UNIX', 2,
'''UNIX-style paths with forward slashes only.'''),
('Unknown', 8,
'''The path style is not known, most likely because the guest additions
aren't active yet.'''),
]
[docs]class FileAccessMode(Enum):
"""File open access mode for use with :py:func:`IGuestSession.file_open`
and :py:func:`IGuestSession.file_open_ex` .
.. describe:: read_only(1)
Open the file only with read access.
.. describe:: write_only(2)
Open the file only with write access.
.. describe:: read_write(3)
Open the file with both read and write access.
.. describe:: append_only(4)
Open the file for appending only, no read or seek access.
Not yet implemented.
.. describe:: append_read(5)
Open the file for appending and read. Writes always goes to the
end of the file while reads are done at the current or specified file
position.
Not yet implemented.
"""
__uuid__ = '231a578f-47fb-ea30-3b3e-8489558227f0'
_enums = [\
('ReadOnly', 1,
'''Open the file only with read access.'''),
('WriteOnly', 2,
'''Open the file only with write access.'''),
('ReadWrite', 3,
'''Open the file with both read and write access.'''),
('AppendOnly', 4,
'''Open the file for appending only, no read or seek access.
Not yet implemented.'''),
('AppendRead', 5,
'''Open the file for appending and read. Writes always goes to the
end of the file while reads are done at the current or specified file
position.
Not yet implemented.'''),
]
[docs]class FileOpenAction(Enum):
"""What action :py:func:`IGuestSession.file_open` and :py:func:`IGuestSession.file_open_ex`
should take whether the file being opened exists or not.
.. describe:: open_existing(1)
Opens an existing file, fails if no file exists. (Was "oe".)
.. describe:: open_or_create(2)
Opens an existing file, creates a new one if no file exists. (Was "oc".)
.. describe:: create_new(3)
Creates a new file is no file exists, fails if there is a file there already. (Was "ce".)
.. describe:: create_or_replace(4)
Creates a new file, replace any existing file. (Was "ca".)
Currently undefined whether we will inherit mode and ACLs from the
existing file or replace them.
.. describe:: open_existing_truncated(5)
Opens and truncate an existing file, fails if no file exists. (Was "ot".)
.. describe:: append_or_create(99)
Opens an existing file and places the file pointer at the end of
the file, creates the file if it does not exist. This action implies
write access. (Was "oa".)
<!-- @todo r=bird: See iprt/file.h, RTFILE_O_APPEND - not an action/disposition!
Moving the file pointer to the end, is almost fine, but implying 'write' access
isn't. That is something that is exclusively reserved for the opening mode. -->
Deprecated. Only here for historical reasons. Do not use!
"""
__uuid__ = '12bc97e2-4fc6-a8b4-4f84-0cbf4ab970d2'
_enums = [\
('OpenExisting', 1,
'''Opens an existing file, fails if no file exists. (Was "oe".)'''),
('OpenOrCreate', 2,
'''Opens an existing file, creates a new one if no file exists. (Was "oc".)'''),
('CreateNew', 3,
'''Creates a new file is no file exists, fails if there is a file there already. (Was "ce".)'''),
('CreateOrReplace', 4,
'''Creates a new file, replace any existing file. (Was "ca".)
Currently undefined whether we will inherit mode and ACLs from the
existing file or replace them.'''),
('OpenExistingTruncated', 5,
'''Opens and truncate an existing file, fails if no file exists. (Was "ot".)'''),
('AppendOrCreate', 99,
'''Opens an existing file and places the file pointer at the end of
the file, creates the file if it does not exist. This action implies
write access. (Was "oa".)
<!-- @todo r=bird: See iprt/file.h, RTFILE_O_APPEND - not an action/disposition!
Moving the file pointer to the end, is almost fine, but implying 'write' access
isn't. That is something that is exclusively reserved for the opening mode. -->
Deprecated. Only here for historical reasons. Do not use!'''),
]
[docs]class FileSharingMode(Enum):
"""File sharing mode for :py:func:`IGuestSession.file_open_ex` .
.. describe:: read(1)
Only share read access to the file.
.. describe:: write(2)
Only share write access to the file.
.. describe:: read_write(3)
Share both read and write access to the file, but deny deletion.
.. describe:: delete(4)
Only share delete access, denying read and write.
.. describe:: read_delete(5)
Share read and delete access to the file, denying writing.
.. describe:: write_delete(6)
Share write and delete access to the file, denying reading.
.. describe:: all_p(7)
Share all access, i.e. read, write and delete, to the file.
"""
__uuid__ = 'f87dfe58-425b-c5ba-7d6d-22adeea25de1'
_enums = [\
('Read', 1,
'''Only share read access to the file.'''),
('Write', 2,
'''Only share write access to the file.'''),
('ReadWrite', 3,
'''Share both read and write access to the file, but deny deletion.'''),
('Delete', 4,
'''Only share delete access, denying read and write.'''),
('ReadDelete', 5,
'''Share read and delete access to the file, denying writing.'''),
('WriteDelete', 6,
'''Share write and delete access to the file, denying reading.'''),
('All', 7,
'''Share all access, i.e. read, write and delete, to the file.'''),
]
[docs]class FileOpenExFlags(Enum):
"""Open flags for :py:func:`IGuestSession.file_open_ex` .
.. describe:: none(0)
No flag set.
"""
__uuid__ = '9d62017b-ddd3-4e5a-a08e-14d1c23bbac1'
_enums = [\
('None', 0,
'''No flag set.'''),
]
[docs]class FileStatus(Enum):
"""File statuses.
.. describe:: undefined(0)
File is in an undefined state.
.. describe:: opening(10)
Guest file is opening.
.. describe:: open_p(100)
Guest file has been successfully opened.
.. describe:: closing(150)
Guest file closing.
.. describe:: closed(200)
Guest file has been closed.
.. describe:: down(600)
Service/OS is stopping, guest file was closed.
.. describe:: error(800)
Something went wrong.
"""
__uuid__ = '8c86468b-b97b-4080-8914-e29f5b0abd2c'
_enums = [\
('Undefined', 0,
'''File is in an undefined state.'''),
('Opening', 10,
'''Guest file is opening.'''),
('Open', 100,
'''Guest file has been successfully opened.'''),
('Closing', 150,
'''Guest file closing.'''),
('Closed', 200,
'''Guest file has been closed.'''),
('Down', 600,
'''Service/OS is stopping, guest file was closed.'''),
('Error', 800,
'''Something went wrong.'''),
]
[docs]class FsObjType(Enum):
"""File system object (file) types.
.. describe:: unknown(1)
Used either if the object has type that is not in this enum, or
if the type has not yet been determined or set.
.. describe:: fifo(2)
FIFO or named pipe, depending on the platform/terminology.
.. describe:: dev_char(3)
Character device.
.. describe:: directory(4)
Directory.
.. describe:: dev_block(5)
Block device.
.. describe:: file_p(6)
Regular file.
.. describe:: symlink(7)
Symbolic link.
.. describe:: socket(8)
Socket.
.. describe:: white_out(9)
A white-out file. Found in union mounts where it is used for
hiding files after deletion, I think.
"""
__uuid__ = '34a0d1aa-491e-e209-e150-84964d6cee5f'
_enums = [\
('Unknown', 1,
'''Used either if the object has type that is not in this enum, or
if the type has not yet been determined or set.'''),
('Fifo', 2,
'''FIFO or named pipe, depending on the platform/terminology.'''),
('DevChar', 3,
'''Character device.'''),
('Directory', 4,
'''Directory.'''),
('DevBlock', 5,
'''Block device.'''),
('File', 6,
'''Regular file.'''),
('Symlink', 7,
'''Symbolic link.'''),
('Socket', 8,
'''Socket.'''),
('WhiteOut', 9,
'''A white-out file. Found in union mounts where it is used for
hiding files after deletion, I think.'''),
]
[docs]class DnDAction(Enum):
"""Possible actions of a drag'n drop operation.
.. describe:: ignore(0)
Do nothing.
.. describe:: copy(1)
Copy the item to the target.
.. describe:: move(2)
Move the item to the target.
.. describe:: link(3)
Link the item from within the target.
"""
__uuid__ = '17609e74-778e-4d0e-8827-35f5230f287b'
_enums = [\
('Ignore', 0,
'''Do nothing.'''),
('Copy', 1,
'''Copy the item to the target.'''),
('Move', 2,
'''Move the item to the target.'''),
('Link', 3,
'''Link the item from within the target.'''),
]
[docs]class DirectoryOpenFlag(Enum):
"""Directory open flags.
.. describe:: none(0)
No flag set.
.. describe:: no_symlinks(1)
Don't allow symbolic links as part of the path.
"""
__uuid__ = '5138837a-8fd2-4194-a1b0-08f7bc3949d0'
_enums = [\
('None', 0,
'''No flag set.'''),
('NoSymlinks', 1,
'''Don't allow symbolic links as part of the path.'''),
]
[docs]class MediumState(Enum):
"""Virtual medium state.
:py:class:`IMedium`
.. describe:: not_created(0)
Associated medium storage does not exist (either was not created yet or
was deleted).
.. describe:: created(1)
Associated storage exists and accessible; this gets set if the
accessibility check performed by :py:func:`IMedium.refresh_state`
was successful.
.. describe:: locked_read(2)
Medium is locked for reading (see :py:func:`IMedium.lock_read` ),
no data modification is possible.
.. describe:: locked_write(3)
Medium is locked for writing (see :py:func:`IMedium.lock_write` ),
no concurrent data reading or modification is possible.
.. describe:: inaccessible(4)
Medium accessibility check (see :py:func:`IMedium.refresh_state` ) has
not yet been performed, or else, associated medium storage is not
accessible. In the first case, :py:func:`IMedium.last_access_error`
is empty, in the second case, it describes the error that occurred.
.. describe:: creating(5)
Associated medium storage is being created.
.. describe:: deleting(6)
Associated medium storage is being deleted.
"""
__uuid__ = 'ef41e980-e012-43cd-9dea-479d4ef14d13'
_enums = [\
('NotCreated', 0,
'''Associated medium storage does not exist (either was not created yet or
was deleted).'''),
('Created', 1,
'''Associated storage exists and accessible; this gets set if the
accessibility check performed by :py:func:`IMedium.refresh_state`
was successful.'''),
('LockedRead', 2,
'''Medium is locked for reading (see :py:func:`IMedium.lock_read` ),
no data modification is possible.'''),
('LockedWrite', 3,
'''Medium is locked for writing (see :py:func:`IMedium.lock_write` ),
no concurrent data reading or modification is possible.'''),
('Inaccessible', 4,
'''Medium accessibility check (see :py:func:`IMedium.refresh_state` ) has
not yet been performed, or else, associated medium storage is not
accessible. In the first case, :py:func:`IMedium.last_access_error`
is empty, in the second case, it describes the error that occurred.'''),
('Creating', 5,
'''Associated medium storage is being created.'''),
('Deleting', 6,
'''Associated medium storage is being deleted.'''),
]
[docs]class MediumType(Enum):
"""Virtual medium type. For each :py:class:`IMedium` , this defines how the medium is
attached to a virtual machine (see :py:class:`IMediumAttachment` ) and what happens
when a snapshot (see :py:class:`ISnapshot` ) is taken of a virtual machine which has
the medium attached. At the moment DVD and floppy media are always of type "writethrough".
.. describe:: normal(0)
Normal medium (attached directly or indirectly, preserved
when taking snapshots).
.. describe:: immutable(1)
Immutable medium (attached indirectly, changes are wiped out
the next time the virtual machine is started).
.. describe:: writethrough(2)
Write through medium (attached directly, ignored when
taking snapshots).
.. describe:: shareable(3)
Allow using this medium concurrently by several machines.
Present since VirtualBox 3.2.0, and accepted since 3.2.8.
.. describe:: readonly(4)
A readonly medium, which can of course be used by several machines.
Present and accepted since VirtualBox 4.0.
.. describe:: multi_attach(5)
A medium which is indirectly attached, so that one base medium can
be used for several VMs which have their own differencing medium to
store their modifications. In some sense a variant of Immutable
with unset AutoReset flag in each differencing medium.
Present and accepted since VirtualBox 4.0.
"""
__uuid__ = 'fe663fb5-c244-4e1b-9d81-c628b417dd04'
_enums = [\
('Normal', 0,
'''Normal medium (attached directly or indirectly, preserved
when taking snapshots).'''),
('Immutable', 1,
'''Immutable medium (attached indirectly, changes are wiped out
the next time the virtual machine is started).'''),
('Writethrough', 2,
'''Write through medium (attached directly, ignored when
taking snapshots).'''),
('Shareable', 3,
'''Allow using this medium concurrently by several machines.
Present since VirtualBox 3.2.0, and accepted since 3.2.8.'''),
('Readonly', 4,
'''A readonly medium, which can of course be used by several machines.
Present and accepted since VirtualBox 4.0.'''),
('MultiAttach', 5,
'''A medium which is indirectly attached, so that one base medium can
be used for several VMs which have their own differencing medium to
store their modifications. In some sense a variant of Immutable
with unset AutoReset flag in each differencing medium.
Present and accepted since VirtualBox 4.0.'''),
]
[docs]class MediumVariant(Enum):
"""Virtual medium image variant. More than one flag may be set.
:py:class:`IMedium`
.. describe:: standard(0)
No particular variant requested, results in using the backend default.
.. describe:: vmdk_split2_g(1)
VMDK image split in chunks of less than 2GByte.
.. describe:: vmdk_raw_disk(2)
VMDK image representing a raw disk.
.. describe:: vmdk_stream_optimized(4)
VMDK streamOptimized image. Special import/export format which is
read-only/append-only.
.. describe:: vmdk_esx(8)
VMDK format variant used on ESX products.
.. describe:: vdi_zero_expand(256)
Fill new blocks with zeroes while expanding image file.
.. describe:: fixed(65536)
Fixed image. Only allowed for base images.
.. describe:: diff(131072)
Differencing image. Only allowed for child images.
.. describe:: no_create_dir(1073741824)
Special flag which suppresses automatic creation of the subdirectory.
Only used when passing the medium variant as an input parameter.
"""
__uuid__ = '0282e97f-4ef3-4411-a8e0-47c384803cb6'
_enums = [\
('Standard', 0,
'''No particular variant requested, results in using the backend default.'''),
('VmdkSplit2G', 1,
'''VMDK image split in chunks of less than 2GByte.'''),
('VmdkRawDisk', 2,
'''VMDK image representing a raw disk.'''),
('VmdkStreamOptimized', 4,
'''VMDK streamOptimized image. Special import/export format which is
read-only/append-only.'''),
('VmdkESX', 8,
'''VMDK format variant used on ESX products.'''),
('VdiZeroExpand', 256,
'''Fill new blocks with zeroes while expanding image file.'''),
('Fixed', 65536,
'''Fixed image. Only allowed for base images.'''),
('Diff', 131072,
'''Differencing image. Only allowed for child images.'''),
('NoCreateDir', 1073741824,
'''Special flag which suppresses automatic creation of the subdirectory.
Only used when passing the medium variant as an input parameter.'''),
]
[docs]class DataType(Enum):
"""
.. describe:: int32(0)
.. describe:: int8(1)
.. describe:: string(2)
"""
__uuid__ = 'd90ea51e-a3f1-4a01-beb1-c1723c0d3ba7'
_enums = [\
('Int32', 0,
''''''),
('Int8', 1,
''''''),
('String', 2,
''''''),
]
[docs]class DataFlags(Enum):
"""
.. describe:: none(0)
.. describe:: mandatory(1)
.. describe:: expert(2)
.. describe:: array(4)
.. describe:: flag_mask(7)
"""
__uuid__ = '86884dcf-1d6b-4f1b-b4bf-f5aa44959d60'
_enums = [\
('None', 0,
''''''),
('Mandatory', 1,
''''''),
('Expert', 2,
''''''),
('Array', 4,
''''''),
('FlagMask', 7,
''''''),
]
[docs]class KeyboardLED(Enum):
"""Keyboard LED indicators.
.. describe:: num_lock(1)
.. describe:: caps_lock(2)
.. describe:: scroll_lock(4)
"""
__uuid__ = 'ef29ea38-409b-49c7-a817-c858d426dfba'
_enums = [\
('NumLock', 1,
''''''),
('CapsLock', 2,
''''''),
('ScrollLock', 4,
''''''),
]
[docs]class FramebufferCapabilities(Enum):
"""Framebuffer capability flags.
.. describe:: update_image(1)
Requires NotifyUpdateImage. NotifyUpdate must not be called.
.. describe:: vhwa(2)
Supports VHWA interface. If set, then IFramebuffer::processVHWACommand can be called.
.. describe:: visible_region(4)
Supports visible region. If set, then IFramebuffer::setVisibleRegion can be called.
"""
__uuid__ = 'cc395839-30fa-4ca5-ae65-e6360e3edd7a'
_enums = [\
('UpdateImage', 1,
'''Requires NotifyUpdateImage. NotifyUpdate must not be called.'''),
('VHWA', 2,
'''Supports VHWA interface. If set, then IFramebuffer::processVHWACommand can be called.'''),
('VisibleRegion', 4,
'''Supports visible region. If set, then IFramebuffer::setVisibleRegion can be called.'''),
]
[docs]class GuestMonitorStatus(Enum):
"""The current status of the guest display.
.. describe:: disabled(0)
The guest monitor is disabled in the guest.
.. describe:: enabled(1)
The guest monitor is enabled in the guest.
.. describe:: blank(2)
The guest monitor is enabled in the guest but should display nothing.
"""
__uuid__ = '6b8d3f71-39cb-459e-a916-48917ed43e19'
_enums = [\
('Disabled', 0,
'''The guest monitor is disabled in the guest.'''),
('Enabled', 1,
'''The guest monitor is enabled in the guest.'''),
('Blank', 2,
'''The guest monitor is enabled in the guest but should display nothing.'''),
]
[docs]class ScreenLayoutMode(Enum):
"""How IDisplay::setScreenLayout method should work.
.. describe:: apply_p(0)
If the guest is already at desired mode then the API might avoid setting the mode.
.. describe:: reset(1)
Always set the new mode even if the guest is already at desired mode.
"""
__uuid__ = '9a982f4f-b815-4802-8539-d0b46435a7b7'
_enums = [\
('Apply', 0,
'''If the guest is already at desired mode then the API might avoid setting the mode.'''),
('Reset', 1,
'''Always set the new mode even if the guest is already at desired mode.'''),
]
[docs]class NetworkAttachmentType(Enum):
"""Network attachment type.
.. describe:: null(0)
Null value, also means "not attached".
.. describe:: nat(1)
.. describe:: bridged(2)
.. describe:: internal(3)
.. describe:: host_only(4)
.. describe:: generic(5)
.. describe:: nat_network(6)
"""
__uuid__ = '524a8f9d-4b86-4b51-877d-1aa27c4ebeac'
_enums = [\
('Null', 0,
'''Null value, also means "not attached".'''),
('NAT', 1,
''''''),
('Bridged', 2,
''''''),
('Internal', 3,
''''''),
('HostOnly', 4,
''''''),
('Generic', 5,
''''''),
('NATNetwork', 6,
''''''),
]
[docs]class NetworkAdapterType(Enum):
"""Network adapter type.
.. describe:: null(0)
Null value (never used by the API).
.. describe:: am79_c970_a(1)
AMD PCNet-PCI II network card (Am79C970A).
.. describe:: am79_c973(2)
AMD PCNet-FAST III network card (Am79C973).
.. describe:: i82540_em(3)
Intel PRO/1000 MT Desktop network card (82540EM).
.. describe:: i82543_gc(4)
Intel PRO/1000 T Server network card (82543GC).
.. describe:: i82545_em(5)
Intel PRO/1000 MT Server network card (82545EM).
.. describe:: virtio(6)
Virtio network device.
"""
__uuid__ = '3c2281e4-d952-4e87-8c7d-24379cb6a81c'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('Am79C970A', 1,
'''AMD PCNet-PCI II network card (Am79C970A).'''),
('Am79C973', 2,
'''AMD PCNet-FAST III network card (Am79C973).'''),
('I82540EM', 3,
'''Intel PRO/1000 MT Desktop network card (82540EM).'''),
('I82543GC', 4,
'''Intel PRO/1000 T Server network card (82543GC).'''),
('I82545EM', 5,
'''Intel PRO/1000 MT Server network card (82545EM).'''),
('Virtio', 6,
'''Virtio network device.'''),
]
[docs]class NetworkAdapterPromiscModePolicy(Enum):
"""The promiscuous mode policy of an interface.
.. describe:: deny(1)
Deny promiscuous mode requests.
.. describe:: allow_network(2)
Allow promiscuous mode, but restrict the scope it to the internal
network so that it only applies to other VMs.
.. describe:: allow_all(3)
Allow promiscuous mode, include unrelated traffic going over the wire
and internally on the host.
"""
__uuid__ = 'c963768a-376f-4c85-8d84-d8ced4b7269e'
_enums = [\
('Deny', 1,
'''Deny promiscuous mode requests.'''),
('AllowNetwork', 2,
'''Allow promiscuous mode, but restrict the scope it to the internal
network so that it only applies to other VMs.'''),
('AllowAll', 3,
'''Allow promiscuous mode, include unrelated traffic going over the wire
and internally on the host.'''),
]
[docs]class PortMode(Enum):
"""The PortMode enumeration represents possible communication modes for
the virtual serial port device.
.. describe:: disconnected(0)
Virtual device is not attached to any real host device.
.. describe:: host_pipe(1)
Virtual device is attached to a host pipe.
.. describe:: host_device(2)
Virtual device is attached to a host device.
.. describe:: raw_file(3)
Virtual device is attached to a raw file.
.. describe:: tcp(4)
Virtual device is attached to a TCP socket.
"""
__uuid__ = '7485fcfd-d603-470a-87af-26d33beb7de9'
_enums = [\
('Disconnected', 0,
'''Virtual device is not attached to any real host device.'''),
('HostPipe', 1,
'''Virtual device is attached to a host pipe.'''),
('HostDevice', 2,
'''Virtual device is attached to a host device.'''),
('RawFile', 3,
'''Virtual device is attached to a raw file.'''),
('TCP', 4,
'''Virtual device is attached to a TCP socket.'''),
]
[docs]class USBControllerType(Enum):
"""The USB controller type. :py:func:`IUSBController.type_p` .
.. describe:: null(0)
@c null value. Never used by the API.
.. describe:: ohci(1)
.. describe:: ehci(2)
.. describe:: xhci(3)
.. describe:: last(4)
Last element (invalid). Used for parameter checks.
"""
__uuid__ = '8fdd1c6a-5412-41da-ab07-7baed7d6e18e'
_enums = [\
('Null', 0,
'''@c null value. Never used by the API.'''),
('OHCI', 1,
''''''),
('EHCI', 2,
''''''),
('XHCI', 3,
''''''),
('Last', 4,
'''Last element (invalid). Used for parameter checks.'''),
]
[docs]class USBConnectionSpeed(Enum):
"""USB device/port speed state. This enumeration represents speeds at
which a USB device can communicate with the host.
The speed is a function of both the device itself and the port which
it is attached to, including hubs and cables in the path.
Due to differences in USB stack implementations on various hosts,
the reported speed may not exactly match the actual speed.
:py:class:`IHostUSBDevice`
.. describe:: null(0)
@c null value. Never returned by the API.
.. describe:: low(1)
Low speed, 1.5 Mbps.
.. describe:: full(2)
Full speed, 12 Mbps.
.. describe:: high(3)
High speed, 480 Mbps.
.. describe:: super_p(4)
SuperSpeed, 5 Gbps.
.. describe:: super_plus(5)
SuperSpeedPlus, 10 Gbps.
"""
__uuid__ = 'd2915840-ea26-4fb4-b72a-21eaf6b888ff'
_enums = [\
('Null', 0,
'''@c null value. Never returned by the API.'''),
('Low', 1,
'''Low speed, 1.5 Mbps.'''),
('Full', 2,
'''Full speed, 12 Mbps.'''),
('High', 3,
'''High speed, 480 Mbps.'''),
('Super', 4,
'''SuperSpeed, 5 Gbps.'''),
('SuperPlus', 5,
'''SuperSpeedPlus, 10 Gbps.'''),
]
[docs]class USBDeviceState(Enum):
"""USB device state. This enumeration represents all possible states
of the USB device physically attached to the host computer regarding
its state on the host computer and availability to guest computers
(all currently running virtual machines).
Once a supported USB device is attached to the host, global USB
filters (:py:func:`IHost.usb_device_filters` ) are activated. They can
either ignore the device, or put it to USBDeviceState_Held state, or do
nothing. Unless the device is ignored by global filters, filters of all
currently running guests (:py:func:`IUSBDeviceFilters.device_filters` ) are
activated that can put it to USBDeviceState_Captured state.
If the device was ignored by global filters, or didn't match
any filters at all (including guest ones), it is handled by the host
in a normal way. In this case, the device state is determined by
the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
or USBDeviceState_Available, depending on the current device usage.
Besides auto-capturing based on filters, the device can be manually
captured by guests (:py:func:`IConsole.attach_usb_device` ) if its
state is USBDeviceState_Busy, USBDeviceState_Available or
USBDeviceState_Held.
Due to differences in USB stack implementations in Linux and Win32,
states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
only to the Linux version of the product. This also means that (:py:func:`IConsole.attach_usb_device` ) can only succeed on Win32 if the
device state is USBDeviceState_Held.
:py:class:`IHostUSBDevice` , :py:class:`IHostUSBDeviceFilter`
.. describe:: not_supported(0)
Not supported by the VirtualBox server, not available to guests.
.. describe:: unavailable(1)
Being used by the host computer exclusively,
not available to guests.
.. describe:: busy(2)
Being used by the host computer, potentially available to guests.
.. describe:: available(3)
Not used by the host computer, available to guests (the host computer
can also start using the device at any time).
.. describe:: held(4)
Held by the VirtualBox server (ignored by the host computer),
available to guests.
.. describe:: captured(5)
Captured by one of the guest computers, not available
to anybody else.
"""
__uuid__ = 'b99a2e65-67fb-4882-82fd-f3e5e8193ab4'
_enums = [\
('NotSupported', 0,
'''Not supported by the VirtualBox server, not available to guests.'''),
('Unavailable', 1,
'''Being used by the host computer exclusively,
not available to guests.'''),
('Busy', 2,
'''Being used by the host computer, potentially available to guests.'''),
('Available', 3,
'''Not used by the host computer, available to guests (the host computer
can also start using the device at any time).'''),
('Held', 4,
'''Held by the VirtualBox server (ignored by the host computer),
available to guests.'''),
('Captured', 5,
'''Captured by one of the guest computers, not available
to anybody else.'''),
]
[docs]class USBDeviceFilterAction(Enum):
"""Actions for host USB device filters.
:py:class:`IHostUSBDeviceFilter` , :py:class:`USBDeviceState`
.. describe:: null(0)
Null value (never used by the API).
.. describe:: ignore(1)
Ignore the matched USB device.
.. describe:: hold(2)
Hold the matched USB device.
"""
__uuid__ = 'cbc30a49-2f4e-43b5-9da6-121320475933'
_enums = [\
('Null', 0,
'''Null value (never used by the API).'''),
('Ignore', 1,
'''Ignore the matched USB device.'''),
('Hold', 2,
'''Hold the matched USB device.'''),
]
[docs]class AudioDriverType(Enum):
"""Host audio driver type.
.. describe:: null(0)
Null value, also means "dummy audio driver".
.. describe:: win_mm(1)
Windows multimedia (Windows hosts only, not supported at the moment).
.. describe:: oss(2)
Open Sound System (Linux / Unix hosts only).
.. describe:: alsa(3)
Advanced Linux Sound Architecture (Linux hosts only).
.. describe:: direct_sound(4)
DirectSound (Windows hosts only).
.. describe:: core_audio(5)
CoreAudio (Mac hosts only).
.. describe:: mmpm(6)
Reserved for historical reasons.
.. describe:: pulse(7)
PulseAudio (Linux hosts only).
.. describe:: sol_audio(8)
Solaris audio (Solaris hosts only, not supported at the moment).
"""
__uuid__ = '4bcc3d73-c2fe-40db-b72f-0c2ca9d68496'
_enums = [\
('Null', 0,
'''Null value, also means "dummy audio driver".'''),
('WinMM', 1,
'''Windows multimedia (Windows hosts only, not supported at the moment).'''),
('OSS', 2,
'''Open Sound System (Linux / Unix hosts only).'''),
('ALSA', 3,
'''Advanced Linux Sound Architecture (Linux hosts only).'''),
('DirectSound', 4,
'''DirectSound (Windows hosts only).'''),
('CoreAudio', 5,
'''CoreAudio (Mac hosts only).'''),
('MMPM', 6,
'''Reserved for historical reasons.'''),
('Pulse', 7,
'''PulseAudio (Linux hosts only).'''),
('SolAudio', 8,
'''Solaris audio (Solaris hosts only, not supported at the moment).'''),
]
[docs]class AudioControllerType(Enum):
"""Virtual audio controller type.
.. describe:: ac97(0)
.. describe:: sb16(1)
.. describe:: hda(2)
"""
__uuid__ = '7afd395c-42c3-444e-8788-3ce80292f36c'
_enums = [\
('AC97', 0,
''''''),
('SB16', 1,
''''''),
('HDA', 2,
''''''),
]
[docs]class AudioCodecType(Enum):
"""The exact variant of audio codec hardware presented
to the guest; see :py:func:`IAudioAdapter.audio_codec` .
.. describe:: null(0)
@c null value. Never used by the API.
.. describe:: sb16(1)
SB16; this is the only option for the SB16 device.
.. describe:: stac9700(2)
A STAC9700 AC'97 codec.
.. describe:: ad1980(3)
An AD1980 AC'97 codec. Recommended for Linux guests.
.. describe:: stac9221(4)
A STAC9221 HDA codec.
"""
__uuid__ = '7b406301-f520-420c-9805-8ce11c086370'
_enums = [\
('Null', 0,
'''@c null value. Never used by the API.'''),
('SB16', 1,
'''SB16; this is the only option for the SB16 device.'''),
('STAC9700', 2,
'''A STAC9700 AC'97 codec.'''),
('AD1980', 3,
'''An AD1980 AC'97 codec. Recommended for Linux guests.'''),
('STAC9221', 4,
'''A STAC9221 HDA codec.'''),
]
[docs]class AuthType(Enum):
"""VirtualBox authentication type.
.. describe:: null(0)
Null value, also means "no authentication".
.. describe:: external(1)
.. describe:: guest(2)
"""
__uuid__ = '7eef6ef6-98c2-4dc2-ab35-10d2b292028d'
_enums = [\
('Null', 0,
'''Null value, also means "no authentication".'''),
('External', 1,
''''''),
('Guest', 2,
''''''),
]
[docs]class Reason(Enum):
"""Internal event reason type.
.. describe:: unspecified(0)
Null value, means "no known reason".
.. describe:: host_suspend(1)
Host is being suspended (power management event).
.. describe:: host_resume(2)
Host is being resumed (power management event).
.. describe:: host_battery_low(3)
Host is running low on battery (power management event).
.. describe:: snapshot(4)
A snapshot of the VM is being taken.
"""
__uuid__ = 'e7e8e097-299d-4e98-8bbc-c31c2d47d0cc'
_enums = [\
('Unspecified', 0,
'''Null value, means "no known reason".'''),
('HostSuspend', 1,
'''Host is being suspended (power management event).'''),
('HostResume', 2,
'''Host is being resumed (power management event).'''),
('HostBatteryLow', 3,
'''Host is running low on battery (power management event).'''),
('Snapshot', 4,
'''A snapshot of the VM is being taken.'''),
]
[docs]class StorageBus(Enum):
"""The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
see :py:func:`IStorageController.bus` .
.. describe:: null(0)
@c null value. Never used by the API.
.. describe:: ide(1)
.. describe:: sata(2)
.. describe:: scsi(3)
.. describe:: floppy(4)
.. describe:: sas(5)
.. describe:: usb(6)
.. describe:: pc_ie(7)
"""
__uuid__ = '21371490-8542-4b5a-a74d-ee9ac2d45a90'
_enums = [\
('Null', 0,
'''@c null value. Never used by the API.'''),
('IDE', 1,
''''''),
('SATA', 2,
''''''),
('SCSI', 3,
''''''),
('Floppy', 4,
''''''),
('SAS', 5,
''''''),
('USB', 6,
''''''),
('PCIe', 7,
''''''),
]
[docs]class StorageControllerType(Enum):
"""The exact variant of storage controller hardware presented
to the guest; see :py:func:`IStorageController.controller_type` .
.. describe:: null(0)
@c null value. Never used by the API.
.. describe:: lsi_logic(1)
A SCSI controller of the LsiLogic variant.
.. describe:: bus_logic(2)
A SCSI controller of the BusLogic variant.
.. describe:: intel_ahci(3)
An Intel AHCI SATA controller; this is the only variant for SATA.
.. describe:: piix3(4)
An IDE controller of the PIIX3 variant.
.. describe:: piix4(5)
An IDE controller of the PIIX4 variant.
.. describe:: ich6(6)
An IDE controller of the ICH6 variant.
.. describe:: i82078(7)
A floppy disk controller; this is the only variant for floppy drives.
.. describe:: lsi_logic_sas(8)
A variant of the LsiLogic controller using SAS.
.. describe:: usb(9)
Special USB based storage controller.
.. describe:: nv_me(10)
An NVMe storage controller.
"""
__uuid__ = '9427f309-82e7-468f-9964-abfefc4d3058'
_enums = [\
('Null', 0,
'''@c null value. Never used by the API.'''),
('LsiLogic', 1,
'''A SCSI controller of the LsiLogic variant.'''),
('BusLogic', 2,
'''A SCSI controller of the BusLogic variant.'''),
('IntelAhci', 3,
'''An Intel AHCI SATA controller; this is the only variant for SATA.'''),
('PIIX3', 4,
'''An IDE controller of the PIIX3 variant.'''),
('PIIX4', 5,
'''An IDE controller of the PIIX4 variant.'''),
('ICH6', 6,
'''An IDE controller of the ICH6 variant.'''),
('I82078', 7,
'''A floppy disk controller; this is the only variant for floppy drives.'''),
('LsiLogicSas', 8,
'''A variant of the LsiLogic controller using SAS.'''),
('USB', 9,
'''Special USB based storage controller.'''),
('NVMe', 10,
'''An NVMe storage controller.'''),
]
[docs]class ChipsetType(Enum):
"""Type of emulated chipset (mostly southbridge).
.. describe:: null(0)
@c null value. Never used by the API.
.. describe:: piix3(1)
A PIIX3 (PCI IDE ISA Xcelerator) chipset.
.. describe:: ich9(2)
A ICH9 (I/O Controller Hub) chipset.
"""
__uuid__ = '8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394'
_enums = [\
('Null', 0,
'''@c null value. Never used by the API.'''),
('PIIX3', 1,
'''A PIIX3 (PCI IDE ISA Xcelerator) chipset.'''),
('ICH9', 2,
'''A ICH9 (I/O Controller Hub) chipset.'''),
]
[docs]class NATAliasMode(Enum):
"""
.. describe:: alias_log(1)
.. describe:: alias_proxy_only(2)
.. describe:: alias_use_same_ports(4)
"""
__uuid__ = '67772168-50d9-11df-9669-7fb714ee4fa1'
_enums = [\
('AliasLog', 1,
''''''),
('AliasProxyOnly', 2,
''''''),
('AliasUseSamePorts', 4,
''''''),
]
[docs]class NATProtocol(Enum):
"""Protocol definitions used with NAT port-forwarding rules.
.. describe:: udp(0)
Port-forwarding uses UDP protocol.
.. describe:: tcp(1)
Port-forwarding uses TCP protocol.
"""
__uuid__ = 'e90164be-eb03-11de-94af-fff9b1c1b19f'
_enums = [\
('UDP', 0,
'''Port-forwarding uses UDP protocol.'''),
('TCP', 1,
'''Port-forwarding uses TCP protocol.'''),
]
[docs]class BandwidthGroupType(Enum):
"""Type of a bandwidth control group.
.. describe:: null(0)
Null type, must be first.
.. describe:: disk(1)
The bandwidth group controls disk I/O.
.. describe:: network(2)
The bandwidth group controls network I/O.
"""
__uuid__ = '1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e'
_enums = [\
('Null', 0,
'''Null type, must be first.'''),
('Disk', 1,
'''The bandwidth group controls disk I/O.'''),
('Network', 2,
'''The bandwidth group controls network I/O.'''),
]
[docs]class VBoxEventType(Enum):
"""Type of an event.
See :py:class:`IEvent` for an introduction to VirtualBox event handling.
.. describe:: invalid(0)
Invalid event, must be first.
.. describe:: any_p(1)
Wildcard for all events.
Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.
.. describe:: vetoable(2)
Wildcard for all vetoable events. Events of this type are never delivered, and only
used in :py:func:`IEventSource.register_listener` call to simplify registration.
.. describe:: machine_event(3)
Wildcard for all machine events. Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.
.. describe:: snapshot_event(4)
Wildcard for all snapshot events. Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.
.. describe:: input_event(5)
Wildcard for all input device (keyboard, mouse) events.
Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.
.. describe:: last_wildcard(31)
Last wildcard.
.. describe:: on_machine_state_changed(32)
See :py:class:`IMachineStateChangedEvent` IMachineStateChangedEvent.
.. describe:: on_machine_data_changed(33)
See :py:class:`IMachineDataChangedEvent` IMachineDataChangedEvent.
.. describe:: on_extra_data_changed(34)
See :py:class:`IExtraDataChangedEvent` IExtraDataChangedEvent.
.. describe:: on_extra_data_can_change(35)
See :py:class:`IExtraDataCanChangeEvent` IExtraDataCanChangeEvent.
.. describe:: on_medium_registered(36)
See :py:class:`IMediumRegisteredEvent` IMediumRegisteredEvent.
.. describe:: on_machine_registered(37)
See :py:class:`IMachineRegisteredEvent` IMachineRegisteredEvent.
.. describe:: on_session_state_changed(38)
See :py:class:`ISessionStateChangedEvent` ISessionStateChangedEvent.
.. describe:: on_snapshot_taken(39)
See :py:class:`ISnapshotTakenEvent` ISnapshotTakenEvent.
.. describe:: on_snapshot_deleted(40)
See :py:class:`ISnapshotDeletedEvent` ISnapshotDeletedEvent.
.. describe:: on_snapshot_changed(41)
See :py:class:`ISnapshotChangedEvent` ISnapshotChangedEvent.
.. describe:: on_guest_property_changed(42)
See :py:class:`IGuestPropertyChangedEvent` IGuestPropertyChangedEvent.
.. describe:: on_mouse_pointer_shape_changed(43)
See :py:class:`IMousePointerShapeChangedEvent` IMousePointerShapeChangedEvent.
.. describe:: on_mouse_capability_changed(44)
See :py:class:`IMouseCapabilityChangedEvent` IMouseCapabilityChangedEvent.
.. describe:: on_keyboard_leds_changed(45)
See :py:class:`IKeyboardLedsChangedEvent` IKeyboardLedsChangedEvent.
.. describe:: on_state_changed(46)
See :py:class:`IStateChangedEvent` IStateChangedEvent.
.. describe:: on_additions_state_changed(47)
See :py:class:`IAdditionsStateChangedEvent` IAdditionsStateChangedEvent.
.. describe:: on_network_adapter_changed(48)
See :py:class:`INetworkAdapterChangedEvent` INetworkAdapterChangedEvent.
.. describe:: on_serial_port_changed(49)
See :py:class:`ISerialPortChangedEvent` ISerialPortChangedEvent.
.. describe:: on_parallel_port_changed(50)
See :py:class:`IParallelPortChangedEvent` IParallelPortChangedEvent.
.. describe:: on_storage_controller_changed(51)
See :py:class:`IStorageControllerChangedEvent` IStorageControllerChangedEvent.
.. describe:: on_medium_changed(52)
See :py:class:`IMediumChangedEvent` IMediumChangedEvent.
.. describe:: on_vrde_server_changed(53)
See :py:class:`IVRDEServerChangedEvent` IVRDEServerChangedEvent.
.. describe:: on_usb_controller_changed(54)
See :py:class:`IUSBControllerChangedEvent` IUSBControllerChangedEvent.
.. describe:: on_usb_device_state_changed(55)
See :py:class:`IUSBDeviceStateChangedEvent` IUSBDeviceStateChangedEvent.
.. describe:: on_shared_folder_changed(56)
See :py:class:`ISharedFolderChangedEvent` ISharedFolderChangedEvent.
.. describe:: on_runtime_error(57)
See :py:class:`IRuntimeErrorEvent` IRuntimeErrorEvent.
.. describe:: on_can_show_window(58)
See :py:class:`ICanShowWindowEvent` ICanShowWindowEvent.
.. describe:: on_show_window(59)
See :py:class:`IShowWindowEvent` IShowWindowEvent.
.. describe:: on_cpu_changed(60)
See :py:class:`ICPUChangedEvent` ICPUChangedEvent.
.. describe:: on_vrde_server_info_changed(61)
See :py:class:`IVRDEServerInfoChangedEvent` IVRDEServerInfoChangedEvent.
.. describe:: on_event_source_changed(62)
See :py:class:`IEventSourceChangedEvent` IEventSourceChangedEvent.
.. describe:: on_cpu_execution_cap_changed(63)
See :py:class:`ICPUExecutionCapChangedEvent` ICPUExecutionCapChangedEvent.
.. describe:: on_guest_keyboard(64)
See :py:class:`IGuestKeyboardEvent` IGuestKeyboardEvent.
.. describe:: on_guest_mouse(65)
See :py:class:`IGuestMouseEvent` IGuestMouseEvent.
.. describe:: on_nat_redirect(66)
See :py:class:`INATRedirectEvent` INATRedirectEvent.
.. describe:: on_host_pci_device_plug(67)
See :py:class:`IHostPCIDevicePlugEvent` IHostPCIDevicePlugEvent.
.. describe:: on_v_box_svc_availability_changed(68)
See :py:class:`IVBoxSVCAvailabilityChangedEvent` IVBoxSVCAvailablityChangedEvent.
.. describe:: on_bandwidth_group_changed(69)
See :py:class:`IBandwidthGroupChangedEvent` IBandwidthGroupChangedEvent.
.. describe:: on_guest_monitor_changed(70)
See :py:class:`IGuestMonitorChangedEvent` IGuestMonitorChangedEvent.
.. describe:: on_storage_device_changed(71)
See :py:class:`IStorageDeviceChangedEvent` IStorageDeviceChangedEvent.
.. describe:: on_clipboard_mode_changed(72)
See :py:class:`IClipboardModeChangedEvent` IClipboardModeChangedEvent.
.. describe:: on_dn_d_mode_changed(73)
See :py:class:`IDnDModeChangedEvent` IDnDModeChangedEvent.
.. describe:: on_nat_network_changed(74)
See :py:class:`INATNetworkChangedEvent` INATNetworkChangedEvent.
.. describe:: on_nat_network_start_stop(75)
See :py:class:`INATNetworkStartStopEvent` INATNetworkStartStopEvent.
.. describe:: on_nat_network_alter(76)
See :py:class:`INATNetworkAlterEvent` INATNetworkAlterEvent.
.. describe:: on_nat_network_creation_deletion(77)
See :py:class:`INATNetworkCreationDeletionEvent` INATNetworkCreationDeletionEvent.
.. describe:: on_nat_network_setting(78)
See :py:class:`INATNetworkSettingEvent` INATNetworkSettingEvent.
.. describe:: on_nat_network_port_forward(79)
See :py:class:`INATNetworkPortForwardEvent` INATNetworkPortForwardEvent.
.. describe:: on_guest_session_state_changed(80)
See :py:class:`IGuestSessionStateChangedEvent` IGuestSessionStateChangedEvent.
.. describe:: on_guest_session_registered(81)
See :py:class:`IGuestSessionRegisteredEvent` IGuestSessionRegisteredEvent.
.. describe:: on_guest_process_registered(82)
See :py:class:`IGuestProcessRegisteredEvent` IGuestProcessRegisteredEvent.
.. describe:: on_guest_process_state_changed(83)
See :py:class:`IGuestProcessStateChangedEvent` IGuestProcessStateChangedEvent.
.. describe:: on_guest_process_input_notify(84)
See :py:class:`IGuestProcessInputNotifyEvent` IGuestProcessInputNotifyEvent.
.. describe:: on_guest_process_output(85)
See :py:class:`IGuestProcessOutputEvent` IGuestProcessOutputEvent.
.. describe:: on_guest_file_registered(86)
See :py:class:`IGuestFileRegisteredEvent` IGuestFileRegisteredEvent.
.. describe:: on_guest_file_state_changed(87)
See :py:class:`IGuestFileStateChangedEvent` IGuestFileStateChangedEvent.
.. describe:: on_guest_file_offset_changed(88)
See :py:class:`IGuestFileOffsetChangedEvent` IGuestFileOffsetChangedEvent.
.. describe:: on_guest_file_read(89)
See :py:class:`IGuestFileReadEvent` IGuestFileReadEvent.
For performance reasons this is a separate event to
not unnecessarily overflow the event queue.
.. describe:: on_guest_file_write(90)
See :py:class:`IGuestFileWriteEvent` IGuestFileWriteEvent.
For performance reasons this is a separate event to
not unnecessarily overflow the event queue.
.. describe:: on_video_capture_changed(91)
See :py:class:`IVideoCaptureChangedEvent` IVideoCapturedChangeEvent.
.. describe:: on_guest_user_state_changed(92)
See :py:class:`IGuestUserStateChangedEvent` IGuestUserStateChangedEvent.
.. describe:: on_guest_multi_touch(93)
See :py:class:`IGuestMouseEvent` IGuestMouseEvent.
.. describe:: on_host_name_resolution_configuration_change(94)
See :py:class:`IHostNameResolutionConfigurationChangeEvent` IHostNameResolutionConfigurationChangeEvent.
.. describe:: on_snapshot_restored(95)
See :py:class:`ISnapshotRestoredEvent` ISnapshotRestoredEvent.
.. describe:: on_medium_config_changed(96)
See :py:class:`IMediumConfigChangedEvent` IMediumConfigChangedEvent.
.. describe:: last(97)
Must be last event, used for iterations and structures relying on numerical event values.
"""
__uuid__ = 'b2ddb312-2f9e-4e69-98df-7235e43b2149'
_enums = [\
('Invalid', 0,
'''Invalid event, must be first.'''),
('Any', 1,
'''Wildcard for all events.
Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.'''),
('Vetoable', 2,
'''Wildcard for all vetoable events. Events of this type are never delivered, and only
used in :py:func:`IEventSource.register_listener` call to simplify registration.'''),
('MachineEvent', 3,
'''Wildcard for all machine events. Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.'''),
('SnapshotEvent', 4,
'''Wildcard for all snapshot events. Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.'''),
('InputEvent', 5,
'''Wildcard for all input device (keyboard, mouse) events.
Events of this type are never delivered, and only used in
:py:func:`IEventSource.register_listener` call to simplify registration.'''),
('LastWildcard', 31,
'''Last wildcard.'''),
('OnMachineStateChanged', 32,
'''See :py:class:`IMachineStateChangedEvent` IMachineStateChangedEvent.'''),
('OnMachineDataChanged', 33,
'''See :py:class:`IMachineDataChangedEvent` IMachineDataChangedEvent.'''),
('OnExtraDataChanged', 34,
'''See :py:class:`IExtraDataChangedEvent` IExtraDataChangedEvent.'''),
('OnExtraDataCanChange', 35,
'''See :py:class:`IExtraDataCanChangeEvent` IExtraDataCanChangeEvent.'''),
('OnMediumRegistered', 36,
'''See :py:class:`IMediumRegisteredEvent` IMediumRegisteredEvent.'''),
('OnMachineRegistered', 37,
'''See :py:class:`IMachineRegisteredEvent` IMachineRegisteredEvent.'''),
('OnSessionStateChanged', 38,
'''See :py:class:`ISessionStateChangedEvent` ISessionStateChangedEvent.'''),
('OnSnapshotTaken', 39,
'''See :py:class:`ISnapshotTakenEvent` ISnapshotTakenEvent.'''),
('OnSnapshotDeleted', 40,
'''See :py:class:`ISnapshotDeletedEvent` ISnapshotDeletedEvent.'''),
('OnSnapshotChanged', 41,
'''See :py:class:`ISnapshotChangedEvent` ISnapshotChangedEvent.'''),
('OnGuestPropertyChanged', 42,
'''See :py:class:`IGuestPropertyChangedEvent` IGuestPropertyChangedEvent.'''),
('OnMousePointerShapeChanged', 43,
'''See :py:class:`IMousePointerShapeChangedEvent` IMousePointerShapeChangedEvent.'''),
('OnMouseCapabilityChanged', 44,
'''See :py:class:`IMouseCapabilityChangedEvent` IMouseCapabilityChangedEvent.'''),
('OnKeyboardLedsChanged', 45,
'''See :py:class:`IKeyboardLedsChangedEvent` IKeyboardLedsChangedEvent.'''),
('OnStateChanged', 46,
'''See :py:class:`IStateChangedEvent` IStateChangedEvent.'''),
('OnAdditionsStateChanged', 47,
'''See :py:class:`IAdditionsStateChangedEvent` IAdditionsStateChangedEvent.'''),
('OnNetworkAdapterChanged', 48,
'''See :py:class:`INetworkAdapterChangedEvent` INetworkAdapterChangedEvent.'''),
('OnSerialPortChanged', 49,
'''See :py:class:`ISerialPortChangedEvent` ISerialPortChangedEvent.'''),
('OnParallelPortChanged', 50,
'''See :py:class:`IParallelPortChangedEvent` IParallelPortChangedEvent.'''),
('OnStorageControllerChanged', 51,
'''See :py:class:`IStorageControllerChangedEvent` IStorageControllerChangedEvent.'''),
('OnMediumChanged', 52,
'''See :py:class:`IMediumChangedEvent` IMediumChangedEvent.'''),
('OnVRDEServerChanged', 53,
'''See :py:class:`IVRDEServerChangedEvent` IVRDEServerChangedEvent.'''),
('OnUSBControllerChanged', 54,
'''See :py:class:`IUSBControllerChangedEvent` IUSBControllerChangedEvent.'''),
('OnUSBDeviceStateChanged', 55,
'''See :py:class:`IUSBDeviceStateChangedEvent` IUSBDeviceStateChangedEvent.'''),
('OnSharedFolderChanged', 56,
'''See :py:class:`ISharedFolderChangedEvent` ISharedFolderChangedEvent.'''),
('OnRuntimeError', 57,
'''See :py:class:`IRuntimeErrorEvent` IRuntimeErrorEvent.'''),
('OnCanShowWindow', 58,
'''See :py:class:`ICanShowWindowEvent` ICanShowWindowEvent.'''),
('OnShowWindow', 59,
'''See :py:class:`IShowWindowEvent` IShowWindowEvent.'''),
('OnCPUChanged', 60,
'''See :py:class:`ICPUChangedEvent` ICPUChangedEvent.'''),
('OnVRDEServerInfoChanged', 61,
'''See :py:class:`IVRDEServerInfoChangedEvent` IVRDEServerInfoChangedEvent.'''),
('OnEventSourceChanged', 62,
'''See :py:class:`IEventSourceChangedEvent` IEventSourceChangedEvent.'''),
('OnCPUExecutionCapChanged', 63,
'''See :py:class:`ICPUExecutionCapChangedEvent` ICPUExecutionCapChangedEvent.'''),
('OnGuestKeyboard', 64,
'''See :py:class:`IGuestKeyboardEvent` IGuestKeyboardEvent.'''),
('OnGuestMouse', 65,
'''See :py:class:`IGuestMouseEvent` IGuestMouseEvent.'''),
('OnNATRedirect', 66,
'''See :py:class:`INATRedirectEvent` INATRedirectEvent.'''),
('OnHostPCIDevicePlug', 67,
'''See :py:class:`IHostPCIDevicePlugEvent` IHostPCIDevicePlugEvent.'''),
('OnVBoxSVCAvailabilityChanged', 68,
'''See :py:class:`IVBoxSVCAvailabilityChangedEvent` IVBoxSVCAvailablityChangedEvent.'''),
('OnBandwidthGroupChanged', 69,
'''See :py:class:`IBandwidthGroupChangedEvent` IBandwidthGroupChangedEvent.'''),
('OnGuestMonitorChanged', 70,
'''See :py:class:`IGuestMonitorChangedEvent` IGuestMonitorChangedEvent.'''),
('OnStorageDeviceChanged', 71,
'''See :py:class:`IStorageDeviceChangedEvent` IStorageDeviceChangedEvent.'''),
('OnClipboardModeChanged', 72,
'''See :py:class:`IClipboardModeChangedEvent` IClipboardModeChangedEvent.'''),
('OnDnDModeChanged', 73,
'''See :py:class:`IDnDModeChangedEvent` IDnDModeChangedEvent.'''),
('OnNATNetworkChanged', 74,
'''See :py:class:`INATNetworkChangedEvent` INATNetworkChangedEvent.'''),
('OnNATNetworkStartStop', 75,
'''See :py:class:`INATNetworkStartStopEvent` INATNetworkStartStopEvent.'''),
('OnNATNetworkAlter', 76,
'''See :py:class:`INATNetworkAlterEvent` INATNetworkAlterEvent.'''),
('OnNATNetworkCreationDeletion', 77,
'''See :py:class:`INATNetworkCreationDeletionEvent` INATNetworkCreationDeletionEvent.'''),
('OnNATNetworkSetting', 78,
'''See :py:class:`INATNetworkSettingEvent` INATNetworkSettingEvent.'''),
('OnNATNetworkPortForward', 79,
'''See :py:class:`INATNetworkPortForwardEvent` INATNetworkPortForwardEvent.'''),
('OnGuestSessionStateChanged', 80,
'''See :py:class:`IGuestSessionStateChangedEvent` IGuestSessionStateChangedEvent.'''),
('OnGuestSessionRegistered', 81,
'''See :py:class:`IGuestSessionRegisteredEvent` IGuestSessionRegisteredEvent.'''),
('OnGuestProcessRegistered', 82,
'''See :py:class:`IGuestProcessRegisteredEvent` IGuestProcessRegisteredEvent.'''),
('OnGuestProcessStateChanged', 83,
'''See :py:class:`IGuestProcessStateChangedEvent` IGuestProcessStateChangedEvent.'''),
('OnGuestProcessInputNotify', 84,
'''See :py:class:`IGuestProcessInputNotifyEvent` IGuestProcessInputNotifyEvent.'''),
('OnGuestProcessOutput', 85,
'''See :py:class:`IGuestProcessOutputEvent` IGuestProcessOutputEvent.'''),
('OnGuestFileRegistered', 86,
'''See :py:class:`IGuestFileRegisteredEvent` IGuestFileRegisteredEvent.'''),
('OnGuestFileStateChanged', 87,
'''See :py:class:`IGuestFileStateChangedEvent` IGuestFileStateChangedEvent.'''),
('OnGuestFileOffsetChanged', 88,
'''See :py:class:`IGuestFileOffsetChangedEvent` IGuestFileOffsetChangedEvent.'''),
('OnGuestFileRead', 89,
'''See :py:class:`IGuestFileReadEvent` IGuestFileReadEvent.
For performance reasons this is a separate event to
not unnecessarily overflow the event queue.'''),
('OnGuestFileWrite', 90,
'''See :py:class:`IGuestFileWriteEvent` IGuestFileWriteEvent.
For performance reasons this is a separate event to
not unnecessarily overflow the event queue.'''),
('OnVideoCaptureChanged', 91,
'''See :py:class:`IVideoCaptureChangedEvent` IVideoCapturedChangeEvent.'''),
('OnGuestUserStateChanged', 92,
'''See :py:class:`IGuestUserStateChangedEvent` IGuestUserStateChangedEvent.'''),
('OnGuestMultiTouch', 93,
'''See :py:class:`IGuestMouseEvent` IGuestMouseEvent.'''),
('OnHostNameResolutionConfigurationChange', 94,
'''See :py:class:`IHostNameResolutionConfigurationChangeEvent` IHostNameResolutionConfigurationChangeEvent.'''),
('OnSnapshotRestored', 95,
'''See :py:class:`ISnapshotRestoredEvent` ISnapshotRestoredEvent.'''),
('OnMediumConfigChanged', 96,
'''See :py:class:`IMediumConfigChangedEvent` IMediumConfigChangedEvent.'''),
('Last', 97,
'''Must be last event, used for iterations and structures relying on numerical event values.'''),
]
[docs]class GuestMouseEventMode(Enum):
"""The mode (relative, absolute, multi-touch) of a pointer event.
@todo A clear pattern seems to be emerging that we should usually have
multiple input devices active for different types of reporting, so we
should really have different event types for relative (including wheel),
absolute (not including wheel) and multi-touch events.
.. describe:: relative(0)
Relative event.
.. describe:: absolute(1)
Absolute event.
"""
__uuid__ = '4b500146-ebba-4b7c-bc29-69c2d57a5caf'
_enums = [\
('Relative', 0,
'''Relative event.'''),
('Absolute', 1,
'''Absolute event.'''),
]
[docs]class GuestMonitorChangedEventType(Enum):
"""How the guest monitor has been changed.
.. describe:: enabled(0)
The guest monitor has been enabled by the guest.
.. describe:: disabled(1)
The guest monitor has been disabled by the guest.
.. describe:: new_origin(2)
The guest monitor origin has changed in the guest.
"""
__uuid__ = 'ef172985-7e36-4297-95be-e46396968d66'
_enums = [\
('Enabled', 0,
'''The guest monitor has been enabled by the guest.'''),
('Disabled', 1,
'''The guest monitor has been disabled by the guest.'''),
('NewOrigin', 2,
'''The guest monitor origin has changed in the guest.'''),
]
[docs]class IVirtualBoxErrorInfo(Interface):
"""
The IVirtualBoxErrorInfo interface represents extended error information.
Extended error information can be set by VirtualBox components after
unsuccessful or partially successful method invocation. This information
can be retrieved by the calling party as an IVirtualBoxErrorInfo object
and then shown to the client in addition to the plain 32-bit result code.
In MS COM, this interface extends the IErrorInfo interface,
in XPCOM, it extends the nsIException interface. In both cases,
it provides a set of common attributes to retrieve error
information.
Sometimes invocation of some component's method may involve methods of
other components that may also fail (independently of this method's
failure), or a series of non-fatal errors may precede a fatal error that
causes method failure. In cases like that, it may be desirable to preserve
information about all errors happened during method invocation and deliver
it to the caller. The :py:func:`next_p` attribute is intended
specifically for this purpose and allows to represent a chain of errors
through a single IVirtualBoxErrorInfo object set after method invocation.
errors are stored to a chain in the reverse order, i.e. the
initial error object you query right after method invocation is the last
error set by the callee, the object it points to in the @a next attribute
is the previous error and so on, up to the first error (which is the last
in the chain).
"""
__uuid__ = 'c1bcc6d5-7966-481d-ab0b-d0ed73e28135'
__wsmap__ = 'managed'
@property
def result_code(self):
"""Get int value for 'resultCode'
Result code of the error.
Usually, it will be the same as the result code returned
by the method that provided this error information, but not
always. For example, on Win32, CoCreateInstance() will most
likely return E_NOINTERFACE upon unsuccessful component
instantiation attempt, but not the value the component factory
returned. Value is typed 'long', not 'result',
to make interface usable from scripting languages.
In MS COM, there is no equivalent.
In XPCOM, it is the same as nsIException::result.
"""
ret = self._get_attr("resultCode")
return ret
@property
def result_detail(self):
"""Get int value for 'resultDetail'
Optional result data of this error. This will vary depending on the
actual error usage. By default this attribute is not being used.
"""
ret = self._get_attr("resultDetail")
return ret
@property
def interface_id(self):
"""Get str value for 'interfaceID'
UUID of the interface that defined the error.
In MS COM, it is the same as IErrorInfo::GetGUID, except for the
data type.
In XPCOM, there is no equivalent.
"""
ret = self._get_attr("interfaceID")
return ret
@property
def component(self):
"""Get str value for 'component'
Name of the component that generated the error.
In MS COM, it is the same as IErrorInfo::GetSource.
In XPCOM, there is no equivalent.
"""
ret = self._get_attr("component")
return ret
@property
def text(self):
"""Get str value for 'text'
Text description of the error.
In MS COM, it is the same as IErrorInfo::GetDescription.
In XPCOM, it is the same as nsIException::message.
"""
ret = self._get_attr("text")
return ret
@property
def next_p(self):
"""Get IVirtualBoxErrorInfo value for 'next'
Next error object if there is any, or @c null otherwise.
In MS COM, there is no equivalent.
In XPCOM, it is the same as nsIException::inner.
"""
ret = self._get_attr("next")
return IVirtualBoxErrorInfo(ret)
[docs]class INATNetwork(Interface):
"""
TBD: the idea, technically we can start any number of the NAT networks,
but we should expect that at some point we will get collisions because of
port-forwanding rules. so perhaps we should support only single instance of NAT
network.
"""
__uuid__ = '4bbc405d-f268-4483-9a52-f43ffdbf67f8'
__wsmap__ = 'managed'
@property
def network_name(self):
"""Get or set str value for 'networkName'
TBD: the idea, technically we can start any number of the NAT networks,
but we should expect that at some point we will get collisions because of
port-forwanding rules. so perhaps we should support only single instance of NAT
network.
"""
ret = self._get_attr("networkName")
return ret
@network_name.setter
def network_name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("networkName", value)
@property
def enabled(self):
"""Get or set bool value for 'enabled'"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def network(self):
"""Get or set str value for 'network'
This is CIDR IPv4 string. Specifying it user defines IPv4 addresses
of gateway (low address + 1) and DHCP server (= low address + 2).
Note: If there are defined IPv4 port-forward rules update of network
will be ignored (because new assignment could break existing rules).
"""
ret = self._get_attr("network")
return ret
@network.setter
def network(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("network", value)
@property
def gateway(self):
"""Get str value for 'gateway'
This attribute is read-only. It's recalculated on changing
network attribute (low address of network + 1).
"""
ret = self._get_attr("gateway")
return ret
@property
def i_pv6_enabled(self):
"""Get or set bool value for 'IPv6Enabled'
This attribute define whether gateway will support IPv6 or not.
"""
ret = self._get_attr("IPv6Enabled")
return ret
@i_pv6_enabled.setter
def i_pv6_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("IPv6Enabled", value)
@property
def i_pv6_prefix(self):
"""Get or set str value for 'IPv6Prefix'
This a CIDR IPv6 defining prefix for link-local addresses
autoconfiguration within network. Note: ignored if attribute
IPv6Enabled is false.
"""
ret = self._get_attr("IPv6Prefix")
return ret
@i_pv6_prefix.setter
def i_pv6_prefix(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("IPv6Prefix", value)
@property
def advertise_default_i_pv6_route_enabled(self):
"""Get or set bool value for 'advertiseDefaultIPv6RouteEnabled'"""
ret = self._get_attr("advertiseDefaultIPv6RouteEnabled")
return ret
@advertise_default_i_pv6_route_enabled.setter
def advertise_default_i_pv6_route_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("advertiseDefaultIPv6RouteEnabled", value)
@property
def need_dhcp_server(self):
"""Get or set bool value for 'needDhcpServer'"""
ret = self._get_attr("needDhcpServer")
return ret
@need_dhcp_server.setter
def need_dhcp_server(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("needDhcpServer", value)
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def port_forward_rules4(self):
"""Get str value for 'portForwardRules4'
Array of NAT port-forwarding rules in string representation,
in the following format:
"name:protocolid:[host ip]:host port:[guest ip]:guest port".
"""
ret = self._get_attr("portForwardRules4")
return ret
@property
def local_mappings(self):
"""Get str value for 'localMappings'
Array of mappings (address,offset),e.g. ("127.0.1.1=4") maps 127.0.1.1 to networkid + 4.
"""
ret = self._get_attr("localMappings")
return ret
[docs] def add_local_mapping(self, hostid, offset):
"""
in hostid of type str
in offset of type int
"""
if not isinstance(hostid, basestring):
raise TypeError("hostid can only be an instance of type basestring")
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
self._call("addLocalMapping",
in_p=[hostid, offset])
@property
def loopback_ip6(self):
"""Get or set int value for 'loopbackIp6'
Offset in ipv6 network from network id for address mapped into loopback6 interface of the host.
"""
ret = self._get_attr("loopbackIp6")
return ret
@loopback_ip6.setter
def loopback_ip6(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("loopbackIp6", value)
@property
def port_forward_rules6(self):
"""Get str value for 'portForwardRules6'
Array of NAT port-forwarding rules in string representation, in the
following format: "name:protocolid:[host ip]:host port:[guest ip]:guest port".
"""
ret = self._get_attr("portForwardRules6")
return ret
[docs] def add_port_forward_rule(self, is_ipv6, rule_name, proto, host_ip, host_port, guest_ip, guest_port):
"""Protocol handled with the rule.
in is_ipv6 of type bool
in rule_name of type str
in proto of type :class:`NATProtocol`
Protocol handled with the rule.
in host_ip of type str
IP of the host interface to which the rule should apply.
An empty ip address is acceptable, in which case the NAT engine
binds the handling socket to any interface.
in host_port of type int
The port number to listen on.
in guest_ip of type str
The IP address of the guest which the NAT engine will forward
matching packets to. An empty IP address is not acceptable.
in guest_port of type int
The port number to forward.
"""
if not isinstance(is_ipv6, bool):
raise TypeError("is_ipv6 can only be an instance of type bool")
if not isinstance(rule_name, basestring):
raise TypeError("rule_name can only be an instance of type basestring")
if not isinstance(proto, NATProtocol):
raise TypeError("proto can only be an instance of type NATProtocol")
if not isinstance(host_ip, basestring):
raise TypeError("host_ip can only be an instance of type basestring")
if not isinstance(host_port, baseinteger):
raise TypeError("host_port can only be an instance of type baseinteger")
if not isinstance(guest_ip, basestring):
raise TypeError("guest_ip can only be an instance of type basestring")
if not isinstance(guest_port, baseinteger):
raise TypeError("guest_port can only be an instance of type baseinteger")
self._call("addPortForwardRule",
in_p=[is_ipv6, rule_name, proto, host_ip, host_port, guest_ip, guest_port])
[docs] def remove_port_forward_rule(self, i_sipv6, rule_name):
"""
in i_sipv6 of type bool
in rule_name of type str
"""
if not isinstance(i_sipv6, bool):
raise TypeError("i_sipv6 can only be an instance of type bool")
if not isinstance(rule_name, basestring):
raise TypeError("rule_name can only be an instance of type basestring")
self._call("removePortForwardRule",
in_p=[i_sipv6, rule_name])
[docs] def start(self, trunk_type):
"""Type of internal network trunk.
in trunk_type of type str
Type of internal network trunk.
"""
if not isinstance(trunk_type, basestring):
raise TypeError("trunk_type can only be an instance of type basestring")
self._call("start",
in_p=[trunk_type])
[docs] def stop(self):
"""
"""
self._call("stop")
[docs]class IDHCPServer(Interface):
"""
The IDHCPServer interface represents the VirtualBox DHCP server configuration.
To enumerate all the DHCP servers on the host, use the
:py:func:`IVirtualBox.dhcp_servers` attribute.
"""
__uuid__ = '00c8f974-92c5-44a1-8f3f-702469fdd04b'
__wsmap__ = 'managed'
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def enabled(self):
"""Get or set bool value for 'enabled'
specifies if the DHCP server is enabled
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def ip_address(self):
"""Get str value for 'IPAddress'
specifies server IP
"""
ret = self._get_attr("IPAddress")
return ret
@property
def network_mask(self):
"""Get str value for 'networkMask'
specifies server network mask
"""
ret = self._get_attr("networkMask")
return ret
@property
def network_name(self):
"""Get str value for 'networkName'
specifies internal network name the server is used for
"""
ret = self._get_attr("networkName")
return ret
@property
def lower_ip(self):
"""Get str value for 'lowerIP'
specifies from IP address in server address range
"""
ret = self._get_attr("lowerIP")
return ret
@property
def upper_ip(self):
"""Get str value for 'upperIP'
specifies to IP address in server address range
"""
ret = self._get_attr("upperIP")
return ret
[docs] def add_global_option(self, option, value):
"""
in option of type :class:`DhcpOpt`
in value of type str
"""
if not isinstance(option, DhcpOpt):
raise TypeError("option can only be an instance of type DhcpOpt")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("addGlobalOption",
in_p=[option, value])
@property
def global_options(self):
"""Get str value for 'globalOptions'"""
ret = self._get_attr("globalOptions")
return ret
@property
def vm_configs(self):
"""Get str value for 'vmConfigs'"""
ret = self._get_attr("vmConfigs")
return ret
[docs] def add_vm_slot_option(self, vmname, slot, option, value):
"""
in vmname of type str
in slot of type int
in option of type :class:`DhcpOpt`
in value of type str
"""
if not isinstance(vmname, basestring):
raise TypeError("vmname can only be an instance of type basestring")
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
if not isinstance(option, DhcpOpt):
raise TypeError("option can only be an instance of type DhcpOpt")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("addVmSlotOption",
in_p=[vmname, slot, option, value])
[docs] def remove_vm_slot_options(self, vmname, slot):
"""
in vmname of type str
in slot of type int
"""
if not isinstance(vmname, basestring):
raise TypeError("vmname can only be an instance of type basestring")
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
self._call("removeVmSlotOptions",
in_p=[vmname, slot])
[docs] def get_vm_slot_options(self, vmname, slot):
"""
in vmname of type str
in slot of type int
return option of type str
"""
if not isinstance(vmname, basestring):
raise TypeError("vmname can only be an instance of type basestring")
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
option = self._call("getVmSlotOptions",
in_p=[vmname, slot])
return option
[docs] def get_mac_options(self, mac):
"""
in mac of type str
return option of type str
"""
if not isinstance(mac, basestring):
raise TypeError("mac can only be an instance of type basestring")
option = self._call("getMacOptions",
in_p=[mac])
return option
[docs] def set_configuration(self, ip_address, network_mask, from_ip_address, to_ip_address):
"""configures the server
in ip_address of type str
server IP address
in network_mask of type str
server network mask
in from_ip_address of type str
server From IP address for address range
in to_ip_address of type str
server To IP address for address range
raises :class:`OleErrorInvalidarg`
invalid configuration supplied
"""
if not isinstance(ip_address, basestring):
raise TypeError("ip_address can only be an instance of type basestring")
if not isinstance(network_mask, basestring):
raise TypeError("network_mask can only be an instance of type basestring")
if not isinstance(from_ip_address, basestring):
raise TypeError("from_ip_address can only be an instance of type basestring")
if not isinstance(to_ip_address, basestring):
raise TypeError("to_ip_address can only be an instance of type basestring")
self._call("setConfiguration",
in_p=[ip_address, network_mask, from_ip_address, to_ip_address])
[docs] def start(self, network_name, trunk_name, trunk_type):
"""Starts DHCP server process.
in network_name of type str
Name of internal network DHCP server should attach to.
in trunk_name of type str
Name of internal network trunk.
in trunk_type of type str
Type of internal network trunk.
raises :class:`OleErrorFail`
Failed to start the process.
"""
if not isinstance(network_name, basestring):
raise TypeError("network_name can only be an instance of type basestring")
if not isinstance(trunk_name, basestring):
raise TypeError("trunk_name can only be an instance of type basestring")
if not isinstance(trunk_type, basestring):
raise TypeError("trunk_type can only be an instance of type basestring")
self._call("start",
in_p=[network_name, trunk_name, trunk_type])
[docs] def stop(self):
"""Stops DHCP server process.
raises :class:`OleErrorFail`
Failed to stop the process.
"""
self._call("stop")
class IVirtualBox(Interface):
"""
The IVirtualBox interface represents the main interface exposed by the
product that provides virtual machine management.
An instance of IVirtualBox is required for the product to do anything
useful. Even though the interface does not expose this, internally,
IVirtualBox is implemented as a singleton and actually lives in the
process of the VirtualBox server (VBoxSVC.exe). This makes sure that
IVirtualBox can track the state of all virtual machines on a particular
host, regardless of which frontend started them.
To enumerate all the virtual machines on the host, use the
:py:func:`IVirtualBox.machines` attribute.
Error information handling is a bit special with IVirtualBox: creating
an instance will always succeed. The return of the actual error
code/information is postponed to any attribute or method call. The
reason for this is that COM likes to mutilate the error code and lose
the detailed error information returned by instance creation.
"""
__uuid__ = '0169423f-46b4-cde9-91af-1e9d5b6cd945'
__wsmap__ = 'managed'
@property
def version(self):
"""Get str value for 'version'
A string representing the version number of the product. The
format is 3 integer numbers divided by dots (e.g. 1.0.1). The
last number represents the build number and will frequently change.
This may be followed by a _ALPHA[0-9]*, _BETA[0-9]* or _RC[0-9]* tag
in prerelease builds. Non-Oracle builds may (/shall) also have a
publisher tag, at the end. The publisher tag starts with an underscore
just like the prerelease build type tag.
"""
ret = self._get_attr("version")
return ret
@property
def version_normalized(self):
"""Get str value for 'versionNormalized'
A string representing the version number of the product,
without the publisher information (but still with other tags).
See :py:func:`version` .
"""
ret = self._get_attr("versionNormalized")
return ret
@property
def revision(self):
"""Get int value for 'revision'
The internal build revision number of the product.
"""
ret = self._get_attr("revision")
return ret
@property
def package_type(self):
"""Get str value for 'packageType'
A string representing the package type of this product. The
format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
this.
"""
ret = self._get_attr("packageType")
return ret
@property
def api_version(self):
"""Get str value for 'APIVersion'
A string representing the VirtualBox API version number. The format is
2 integer numbers divided by an underscore (e.g. 1_0). After the
first public release of packages with a particular API version the
API will not be changed in an incompatible way. Note that this
guarantee does not apply to development builds, and also there is no
guarantee that this version is identical to the first two integer
numbers of the package version.
"""
ret = self._get_attr("APIVersion")
return ret
@property
def api_revision(self):
"""Get int value for 'APIRevision'
To be defined exactly, but we need something that the Validation Kit
can use to figure which methods and attributes can safely be used on a
continuously changing trunk (and occasional branch).
"""
ret = self._get_attr("APIRevision")
return ret
@property
def home_folder(self):
"""Get str value for 'homeFolder'
Full path to the directory where the global settings file,
VirtualBox.xml, is stored.
In this version of VirtualBox, the value of this property is
always <user_dir>/.VirtualBox (where
<user_dir> is the path to the user directory,
as determined by the host OS), and cannot be changed.
This path is also used as the base to resolve relative paths in
places where relative paths are allowed (unless otherwise
expressly indicated).
"""
ret = self._get_attr("homeFolder")
return ret
@property
def settings_file_path(self):
"""Get str value for 'settingsFilePath'
Full name of the global settings file.
The value of this property corresponds to the value of
:py:func:`home_folder` plus /VirtualBox.xml.
"""
ret = self._get_attr("settingsFilePath")
return ret
@property
def host(self):
"""Get IHost value for 'host'
Associated host object.
"""
ret = self._get_attr("host")
return IHost(ret)
@property
def system_properties(self):
"""Get ISystemProperties value for 'systemProperties'
Associated system information object.
"""
ret = self._get_attr("systemProperties")
return ISystemProperties(ret)
@property
def machines(self):
"""Get IMachine value for 'machines'
Array of machine objects registered within this VirtualBox instance.
"""
ret = self._get_attr("machines")
return [IMachine(a) for a in ret]
@property
def machine_groups(self):
"""Get str value for 'machineGroups'
Array of all machine group names which are used by the machines which
are accessible. Each group is only listed once, however they are listed
in no particular order and there is no guarantee that there are no gaps
in the group hierarchy (i.e. "/", "/group/subgroup"
is a valid result).
"""
ret = self._get_attr("machineGroups")
return ret
@property
def hard_disks(self):
"""Get IMedium value for 'hardDisks'
Array of medium objects known to this VirtualBox installation.
This array contains only base media. All differencing
media of the given base medium can be enumerated using
:py:func:`IMedium.children` .
"""
ret = self._get_attr("hardDisks")
return [IMedium(a) for a in ret]
@property
def dvd_images(self):
"""Get IMedium value for 'DVDImages'
Array of CD/DVD image objects currently in use by this VirtualBox instance.
"""
ret = self._get_attr("DVDImages")
return [IMedium(a) for a in ret]
@property
def floppy_images(self):
"""Get IMedium value for 'floppyImages'
Array of floppy image objects currently in use by this VirtualBox instance.
"""
ret = self._get_attr("floppyImages")
return [IMedium(a) for a in ret]
@property
def progress_operations(self):
"""Get IProgress value for 'progressOperations'"""
ret = self._get_attr("progressOperations")
return [IProgress(a) for a in ret]
@property
def guest_os_types(self):
"""Get IGuestOSType value for 'guestOSTypes'"""
ret = self._get_attr("guestOSTypes")
return [IGuestOSType(a) for a in ret]
@property
def shared_folders(self):
"""Get ISharedFolder value for 'sharedFolders'
Collection of global shared folders. Global shared folders are
available to all virtual machines.
New shared folders are added to the collection using
:py:func:`create_shared_folder` . Existing shared folders can be
removed using :py:func:`remove_shared_folder` .
In the current version of the product, global shared folders are not
implemented and therefore this collection is always empty.
"""
ret = self._get_attr("sharedFolders")
return [ISharedFolder(a) for a in ret]
@property
def performance_collector(self):
"""Get IPerformanceCollector value for 'performanceCollector'
Associated performance collector object.
"""
ret = self._get_attr("performanceCollector")
return IPerformanceCollector(ret)
@property
def dhcp_servers(self):
"""Get IDHCPServer value for 'DHCPServers'
DHCP servers.
"""
ret = self._get_attr("DHCPServers")
return [IDHCPServer(a) for a in ret]
@property
def nat_networks(self):
"""Get INATNetwork value for 'NATNetworks'"""
ret = self._get_attr("NATNetworks")
return [INATNetwork(a) for a in ret]
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for VirtualBox events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def extension_pack_manager(self):
"""Get IExtPackManager value for 'extensionPackManager'
The extension pack manager.
"""
ret = self._get_attr("extensionPackManager")
return IExtPackManager(ret)
@property
def internal_networks(self):
"""Get str value for 'internalNetworks'
Names of all internal networks.
"""
ret = self._get_attr("internalNetworks")
return ret
@property
def generic_network_drivers(self):
"""Get str value for 'genericNetworkDrivers'
Names of all generic network drivers.
"""
ret = self._get_attr("genericNetworkDrivers")
return ret
[docs] def compose_machine_filename(self, name, group, create_flags, base_folder):
"""Returns a recommended full path of the settings file name for a new virtual
machine.
This API serves two purposes:
It gets called by :py:func:`create_machine` if @c null or
empty string (which is recommended) is specified for the
@a settingsFile argument there, which means that API should use
a recommended default file name.
It can be called manually by a client software before creating a machine,
e.g. if that client wants to pre-create the machine directory to create
virtual hard disks in that directory together with the new machine
settings file. In that case, the file name should be stripped from the
full settings file path returned by this function to obtain the
machine directory.
See :py:func:`IMachine.name` and :py:func:`create_machine` for more
details about the machine name.
@a groupName defines which additional subdirectory levels should be
included. It must be either a valid group name or @c null or empty
string which designates that the machine will not be related to a
machine group.
If @a baseFolder is a @c null or empty string (which is recommended), the
default machine settings folder
(see :py:func:`ISystemProperties.default_machine_folder` ) will be used as
a base folder for the created machine, resulting in a file name like
"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
will be used.
This method does not access the host disks. In particular, it does not check
for whether a machine with this name already exists.
in name of type str
Suggested machine name.
in group of type str
Machine group name for the new machine or machine group. It is
used to determine the right subdirectory.
in create_flags of type str
Machine creation flags, see :py:func:`create_machine` (optional).
in base_folder of type str
Base machine folder (optional).
return file_p of type str
Fully qualified path where the machine would be created.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(group, basestring):
raise TypeError("group can only be an instance of type basestring")
if not isinstance(create_flags, basestring):
raise TypeError("create_flags can only be an instance of type basestring")
if not isinstance(base_folder, basestring):
raise TypeError("base_folder can only be an instance of type basestring")
file_p = self._call("composeMachineFilename",
in_p=[name, group, create_flags, base_folder])
return file_p
[docs] def create_machine(self, settings_file, name, groups, os_type_id, flags):
"""Creates a new virtual machine by creating a machine settings file at
the given location.
VirtualBox machine settings files use a custom XML dialect. Starting
with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
and machine files can be created at arbitrary locations.
However, it is recommended that machines are created in the default
machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
:py:func:`ISystemProperties.default_machine_folder` ). If you specify
@c null or empty string (which is recommended) for the @a settingsFile
argument, :py:func:`compose_machine_filename` is called automatically
to have such a recommended name composed based on the machine name
given in the @a name argument and the primary group.
If the resulting settings file already exists, this method will fail,
unless the forceOverwrite flag is set.
The new machine is created unregistered, with the initial configuration
set according to the specified guest OS type. A typical sequence of
actions to create a new virtual machine is as follows:
Call this method to have a new machine created. The returned machine
object will be "mutable" allowing to change any machine property.
Configure the machine using the appropriate attributes and methods.
Call :py:func:`IMachine.save_settings` to write the settings
to the machine's XML settings file. The configuration of the newly
created machine will not be saved to disk until this method is
called.
Call :py:func:`register_machine` to add the machine to the list
of machines known to VirtualBox.
The specified guest OS type identifier must match an ID of one of known
guest OS types listed in the :py:func:`IVirtualBox.guest_os_types`
array.
:py:func:`IMachine.settings_modified` will return
@c false for the created machine, until any of machine settings
are changed.
There is no way to change the name of the settings file or
subfolder of the created machine directly.
in settings_file of type str
Fully qualified path where the settings file should be created,
empty string or @c null for a default folder and file based on the
@a name argument and the primary group.
(see :py:func:`compose_machine_filename` ).
in name of type str
Machine name.
in groups of type str
Array of group names. @c null or an empty array have the same
meaning as an array with just the empty string or "/", i.e.
create a machine without group association.
in os_type_id of type str
Guest OS Type ID.
in flags of type str
Additional property parameters, passed as a comma-separated list of
"name=value" type entries. The following ones are recognized:
forceOverwrite=1 to overwrite an existing machine settings
file, UUID=<uuid> to specify a machine UUID and
directoryIncludesUUID=1 to switch to a special VM directory
naming scheme which should not be used unless necessary.
return machine of type :class:`IMachine`
Created machine object.
raises :class:`VBoxErrorObjectNotFound`
@a osTypeId is invalid.
raises :class:`VBoxErrorFileError`
Resulting settings file name is invalid or the settings file already
exists or could not be created due to an I/O error.
raises :class:`OleErrorInvalidarg`
@a name is empty or @c null.
"""
if not isinstance(settings_file, basestring):
raise TypeError("settings_file can only be an instance of type basestring")
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(groups, list):
raise TypeError("groups can only be an instance of type list")
for a in groups[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(os_type_id, basestring):
raise TypeError("os_type_id can only be an instance of type basestring")
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
machine = self._call("createMachine",
in_p=[settings_file, name, groups, os_type_id, flags])
machine = IMachine(machine)
return machine
[docs] def open_machine(self, settings_file):
"""Opens a virtual machine from the existing settings file.
The opened machine remains unregistered until you call
:py:func:`register_machine` .
The specified settings file name must be fully qualified.
The file must exist and be a valid machine XML settings file
whose contents will be used to construct the machine object.
:py:func:`IMachine.settings_modified` will return
@c false for the opened machine, until any of machine settings
are changed.
in settings_file of type str
Name of the machine settings file.
return machine of type :class:`IMachine`
Opened machine object.
raises :class:`VBoxErrorFileError`
Settings file name invalid, not found or sharing violation.
"""
if not isinstance(settings_file, basestring):
raise TypeError("settings_file can only be an instance of type basestring")
machine = self._call("openMachine",
in_p=[settings_file])
machine = IMachine(machine)
return machine
[docs] def register_machine(self, machine):
"""Registers the machine previously created using
:py:func:`create_machine` or opened using
:py:func:`open_machine` within this VirtualBox installation. After
successful method invocation, the
:py:class:`IMachineRegisteredEvent` event is fired.
This method implicitly calls :py:func:`IMachine.save_settings`
to save all current machine settings before registering it.
in machine of type :class:`IMachine`
raises :class:`VBoxErrorObjectNotFound`
No matching virtual machine found.
raises :class:`VBoxErrorInvalidObjectState`
Virtual machine was not created within this VirtualBox instance.
"""
if not isinstance(machine, IMachine):
raise TypeError("machine can only be an instance of type IMachine")
self._call("registerMachine",
in_p=[machine])
[docs] def find_machine(self, name_or_id):
"""Attempts to find a virtual machine given its name or UUID.
Inaccessible machines cannot be found by name, only by UUID, because their name
cannot safely be determined.
in name_or_id of type str
What to search for. This can either be the UUID or the name of a virtual machine.
return machine of type :class:`IMachine`
Machine object, if found.
raises :class:`VBoxErrorObjectNotFound`
Could not find registered machine matching @a nameOrId.
"""
if not isinstance(name_or_id, basestring):
raise TypeError("name_or_id can only be an instance of type basestring")
machine = self._call("findMachine",
in_p=[name_or_id])
machine = IMachine(machine)
return machine
[docs] def get_machines_by_groups(self, groups):
"""Gets all machine references which are in one of the specified groups.
in groups of type str
What groups to match. The usual group list rules apply, i.e.
passing an empty list will match VMs in the toplevel group, likewise
the empty string.
return machines of type :class:`IMachine`
All machines which matched.
"""
if not isinstance(groups, list):
raise TypeError("groups can only be an instance of type list")
for a in groups[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
machines = self._call("getMachinesByGroups",
in_p=[groups])
machines = [IMachine(a) for a in machines]
return machines
[docs] def get_machine_states(self, machines):
"""Gets the state of several machines in a single operation.
in machines of type :class:`IMachine`
Array with the machine references.
return states of type :class:`MachineState`
Machine states, corresponding to the machines.
"""
if not isinstance(machines, list):
raise TypeError("machines can only be an instance of type list")
for a in machines[:10]:
if not isinstance(a, IMachine):
raise TypeError(\
"array can only contain objects of type IMachine")
states = self._call("getMachineStates",
in_p=[machines])
states = [MachineState(a) for a in states]
return states
[docs] def create_appliance(self):
"""Creates a new appliance object, which represents an appliance in the Open Virtual Machine
Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
machines as an OVF appliance; see the documentation for :py:class:`IAppliance` for details.
return appliance of type :class:`IAppliance`
New appliance.
"""
appliance = self._call("createAppliance")
appliance = IAppliance(appliance)
return appliance
[docs] def create_medium(self, format_p, location, access_mode, a_device_type_type):
"""Creates a new base medium object that will use the given storage
format and location for medium data.
The actual storage unit is not created by this method. In order to
do it, and before you are able to attach the created medium to
virtual machines, you must call one of the following methods to
allocate a format-specific storage unit at the specified location:
:py:func:`IMedium.create_base_storage`
:py:func:`IMedium.create_diff_storage`
Some medium attributes, such as :py:func:`IMedium.id_p` , may
remain uninitialized until the medium storage unit is successfully
created by one of the above methods.
Depending on the given device type, the file at the storage location
must be in one of the media formats understood by VirtualBox:
With a "HardDisk" device type, the file must be a hard disk image
in one of the formats supported by VirtualBox (see
:py:func:`ISystemProperties.medium_formats` ).
After the storage unit is successfully created and this method succeeds,
if the medium is a base medium, it
will be added to the :py:func:`hard_disks` array attribute.
With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
After this method succeeds, the medium will be added to the
:py:func:`dvd_images` array attribute.
With a "Floppy" device type, the file must be an RAW floppy image.
After this method succeeds, the medium will be added to the
:py:func:`floppy_images` array attribute.
The list of all storage formats supported by this VirtualBox
installation can be obtained using
:py:func:`ISystemProperties.medium_formats` . If the @a format
attribute is empty or @c null then the default storage format
specified by :py:func:`ISystemProperties.default_hard_disk_format` will
be used for disks r creating a storage unit of the medium.
Note that the format of the location string is storage format specific.
See :py:func:`IMedium.location` and IMedium for more details.
in format_p of type str
Identifier of the storage format to use for the new medium.
in location of type str
Location of the storage unit for the new medium.
in access_mode of type :class:`AccessMode`
Whether to open the image in read/write or read-only mode. For
a "DVD" device type, this is ignored and read-only mode is always assumed.
in a_device_type_type of type :class:`DeviceType`
Must be one of "HardDisk", "DVD" or "Floppy".
return medium of type :class:`IMedium`
Created medium object.
raises :class:`VBoxErrorObjectNotFound`
@a format identifier is invalid. See
raises :class:`VBoxErrorFileError`
@a location is a not valid file name (for file-based formats only).
"""
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(location, basestring):
raise TypeError("location can only be an instance of type basestring")
if not isinstance(access_mode, AccessMode):
raise TypeError("access_mode can only be an instance of type AccessMode")
if not isinstance(a_device_type_type, DeviceType):
raise TypeError("a_device_type_type can only be an instance of type DeviceType")
medium = self._call("createMedium",
in_p=[format_p, location, access_mode, a_device_type_type])
medium = IMedium(medium)
return medium
[docs] def open_medium(self, location, device_type, access_mode, force_new_uuid):
"""Finds existing media or opens a medium from an existing storage location.
Once a medium has been opened, it can be passed to other VirtualBox
methods, in particular to :py:func:`IMachine.attach_device` .
Depending on the given device type, the file at the storage location
must be in one of the media formats understood by VirtualBox:
With a "HardDisk" device type, the file must be a hard disk image
in one of the formats supported by VirtualBox (see
:py:func:`ISystemProperties.medium_formats` ).
After this method succeeds, if the medium is a base medium, it
will be added to the :py:func:`hard_disks` array attribute.
With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
After this method succeeds, the medium will be added to the
:py:func:`dvd_images` array attribute.
With a "Floppy" device type, the file must be an RAW floppy image.
After this method succeeds, the medium will be added to the
:py:func:`floppy_images` array attribute.
After having been opened, the medium can be re-found by this method
and can be attached to virtual machines. See :py:class:`IMedium` for
more details.
The UUID of the newly opened medium will either be retrieved from the
storage location, if the format supports it (e.g. for hard disk images),
or a new UUID will be randomly generated (e.g. for ISO and RAW files).
If for some reason you need to change the medium's UUID, use
:py:func:`IMedium.set_ids` .
If a differencing hard disk medium is to be opened by this method, the
operation will succeed only if its parent medium and all ancestors,
if any, are already known to this VirtualBox installation (for example,
were opened by this method before).
This method attempts to guess the storage format of the specified medium
by reading medium data at the specified location.
If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
the image is opened for read/write access and must have according permissions,
as VirtualBox may actually write status information into the disk's metadata
sections.
Note that write access is required for all typical hard disk usage in VirtualBox,
since VirtualBox may need to write metadata such as a UUID into the image.
The only exception is opening a source image temporarily for copying and
cloning (see :py:func:`IMedium.clone_to` when the image will be closed
again soon.
The format of the location string is storage format specific. See
:py:func:`IMedium.location` and IMedium for more details.
in location of type str
Location of the storage unit that contains medium data in one of
the supported storage formats.
in device_type of type :class:`DeviceType`
Must be one of "HardDisk", "DVD" or "Floppy".
in access_mode of type :class:`AccessMode`
Whether to open the image in read/write or read-only mode. For
a "DVD" device type, this is ignored and read-only mode is always assumed.
in force_new_uuid of type bool
Allows the caller to request a completely new medium UUID for
the image which is to be opened. Useful if one intends to open an exact
copy of a previously opened image, as this would normally fail due to
the duplicate UUID.
return medium of type :class:`IMedium`
Opened medium object.
raises :class:`VBoxErrorFileError`
Invalid medium storage file location or could not find the medium
at the specified location.
raises :class:`VBoxErrorIprtError`
Could not get medium storage format.
raises :class:`OleErrorInvalidarg`
Invalid medium storage format.
raises :class:`VBoxErrorInvalidObjectState`
Medium has already been added to a media registry.
"""
if not isinstance(location, basestring):
raise TypeError("location can only be an instance of type basestring")
if not isinstance(device_type, DeviceType):
raise TypeError("device_type can only be an instance of type DeviceType")
if not isinstance(access_mode, AccessMode):
raise TypeError("access_mode can only be an instance of type AccessMode")
if not isinstance(force_new_uuid, bool):
raise TypeError("force_new_uuid can only be an instance of type bool")
medium = self._call("openMedium",
in_p=[location, device_type, access_mode, force_new_uuid])
medium = IMedium(medium)
return medium
[docs] def get_guest_os_type(self, id_p):
"""Returns an object describing the specified guest OS type.
The requested guest OS type is specified using a string which is a
mnemonic identifier of the guest operating system, such as
"win31" or "ubuntu". The guest OS type ID of a
particular virtual machine can be read or set using the
:py:func:`IMachine.os_type_id` attribute.
The :py:func:`IVirtualBox.guest_os_types` collection contains all
available guest OS type objects. Each object has an
:py:func:`IGuestOSType.id_p` attribute which contains an identifier of
the guest OS this object describes.
in id_p of type str
Guest OS type ID string.
return type_p of type :class:`IGuestOSType`
Guest OS type object.
raises :class:`OleErrorInvalidarg`
@a id is not a valid Guest OS type.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
type_p = self._call("getGuestOSType",
in_p=[id_p])
type_p = IGuestOSType(type_p)
return type_p
[docs] def create_shared_folder(self, name, host_path, writable, automount):
"""Creates a new global 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
:py:class:`ISharedFolder` to read more about logical names.
In the current implementation, this operation is not
implemented.
in name of type str
Unique logical name of the shared folder.
in host_path of type str
Full path to the shared folder in the host file system.
in writable of type bool
Whether the share is writable or readonly
in automount of type bool
Whether the share gets automatically mounted by the guest
or not.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(host_path, basestring):
raise TypeError("host_path can only be an instance of type basestring")
if not isinstance(writable, bool):
raise TypeError("writable can only be an instance of type bool")
if not isinstance(automount, bool):
raise TypeError("automount can only be an instance of type bool")
self._call("createSharedFolder",
in_p=[name, host_path, writable, automount])
[docs] def remove_shared_folder(self, name):
"""Removes the global shared folder with the given name previously
created by :py:func:`create_shared_folder` from the collection of
shared folders and stops sharing it.
In the current implementation, this operation is not
implemented.
in name of type str
Logical name of the shared folder to remove.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeSharedFolder",
in_p=[name])
[docs] def set_settings_secret(self, password):
"""Unlocks the secret data by passing the unlock password to the
server. The server will cache the password for that machine.
in password of type str
The cipher key.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable.
"""
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
self._call("setSettingsSecret",
in_p=[password])
[docs] def create_dhcp_server(self, name):
"""Creates a DHCP server settings to be used for the given internal network name
in name of type str
server name
return server of type :class:`IDHCPServer`
DHCP server settings
raises :class:`OleErrorInvalidarg`
Host network interface @a name already exists.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
server = self._call("createDHCPServer",
in_p=[name])
server = IDHCPServer(server)
return server
[docs] def find_dhcp_server_by_network_name(self, name):
"""Searches a DHCP server settings to be used for the given internal network name
in name of type str
server name
return server of type :class:`IDHCPServer`
DHCP server settings
raises :class:`OleErrorInvalidarg`
Host network interface @a name already exists.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
server = self._call("findDHCPServerByNetworkName",
in_p=[name])
server = IDHCPServer(server)
return server
[docs] def remove_dhcp_server(self, server):
"""Removes the DHCP server settings
in server of type :class:`IDHCPServer`
DHCP server settings to be removed
raises :class:`OleErrorInvalidarg`
Host network interface @a name already exists.
"""
if not isinstance(server, IDHCPServer):
raise TypeError("server can only be an instance of type IDHCPServer")
self._call("removeDHCPServer",
in_p=[server])
[docs] def create_nat_network(self, network_name):
"""
in network_name of type str
return network of type :class:`INATNetwork`
"""
if not isinstance(network_name, basestring):
raise TypeError("network_name can only be an instance of type basestring")
network = self._call("createNATNetwork",
in_p=[network_name])
network = INATNetwork(network)
return network
[docs] def find_nat_network_by_name(self, network_name):
"""
in network_name of type str
return network of type :class:`INATNetwork`
"""
if not isinstance(network_name, basestring):
raise TypeError("network_name can only be an instance of type basestring")
network = self._call("findNATNetworkByName",
in_p=[network_name])
network = INATNetwork(network)
return network
[docs] def remove_nat_network(self, network):
"""
in network of type :class:`INATNetwork`
"""
if not isinstance(network, INATNetwork):
raise TypeError("network can only be an instance of type INATNetwork")
self._call("removeNATNetwork",
in_p=[network])
[docs] def check_firmware_present(self, firmware_type, version):
"""Check if this VirtualBox installation has a firmware
of the given type available, either system-wide or per-user.
Optionally, this may return a hint where this firmware can be
downloaded from.
in firmware_type of type :class:`FirmwareType`
Type of firmware to check.
in version of type str
Expected version number, usually empty string (presently ignored).
out url of type str
Suggested URL to download this firmware from.
out file_p of type str
Filename of firmware, only valid if result == TRUE.
return result of type bool
If firmware of this type and version is available.
"""
if not isinstance(firmware_type, FirmwareType):
raise TypeError("firmware_type can only be an instance of type FirmwareType")
if not isinstance(version, basestring):
raise TypeError("version can only be an instance of type basestring")
(result, url, file_p) = self._call("checkFirmwarePresent",
in_p=[firmware_type, version])
return (result, url, file_p)
[docs]class IVFSExplorer(Interface):
"""
The VFSExplorer interface unifies access to different file system
types. This includes local file systems as well remote file systems like
S3. For a list of supported types see :py:class:`VFSType` .
An instance of this is returned by :py:func:`IAppliance.create_vfs_explorer` .
"""
__uuid__ = 'fb220201-2fd3-47e2-a5dc-2c2431d833cc'
__wsmap__ = 'managed'
@property
def path(self):
"""Get str value for 'path'
Returns the current path in the virtual file system.
"""
ret = self._get_attr("path")
return ret
@property
def type_p(self):
"""Get VFSType value for 'type'
Returns the file system type which is currently in use.
"""
ret = self._get_attr("type")
return VFSType(ret)
[docs] def update(self):
"""Updates the internal list of files/directories from the
current directory level. Use :py:func:`entry_list` to get the full list
after a call to this method.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
progress = self._call("update")
progress = IProgress(progress)
return progress
[docs] def cd(self, dir_p):
"""Change the current directory level.
in dir_p of type str
The name of the directory to go in.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(dir_p, basestring):
raise TypeError("dir_p can only be an instance of type basestring")
progress = self._call("cd",
in_p=[dir_p])
progress = IProgress(progress)
return progress
[docs] def cd_up(self):
"""Go one directory upwards from the current directory level.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
progress = self._call("cdUp")
progress = IProgress(progress)
return progress
[docs] def entry_list(self):
"""Returns a list of files/directories after a call to :py:func:`update` . The user is responsible for keeping this internal
list up do date.
out names of type str
The list of names for the entries.
out types of type int
The list of types for the entries. :py:class:`FsObjType`
out sizes of type int
The list of sizes (in bytes) for the entries.
out modes of type int
The list of file modes (in octal form) for the entries.
"""
(names, types, sizes, modes) = self._call("entryList")
return (names, types, sizes, modes)
[docs] def exists(self, names):
"""Checks if the given file list exists in the current directory
level.
in names of type str
The names to check.
return exists of type str
The names which exist.
"""
if not isinstance(names, list):
raise TypeError("names can only be an instance of type list")
for a in names[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
exists = self._call("exists",
in_p=[names])
return exists
[docs] def remove(self, names):
"""Deletes the given files in the current directory level.
in names of type str
The names to remove.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(names, list):
raise TypeError("names can only be an instance of type list")
for a in names[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
progress = self._call("remove",
in_p=[names])
progress = IProgress(progress)
return progress
[docs]class ICertificate(Interface):
"""
X.509 certificate details.
"""
__uuid__ = '392f1de4-80e1-4a8a-93a1-67c5f92a838a'
__wsmap__ = 'managed'
@property
def version_number(self):
"""Get CertificateVersion value for 'versionNumber'
Certificate version number.
"""
ret = self._get_attr("versionNumber")
return CertificateVersion(ret)
@property
def serial_number(self):
"""Get str value for 'serialNumber'
Certificate serial number.
"""
ret = self._get_attr("serialNumber")
return ret
@property
def signature_algorithm_oid(self):
"""Get str value for 'signatureAlgorithmOID'
The dotted OID of the signature algorithm.
"""
ret = self._get_attr("signatureAlgorithmOID")
return ret
@property
def signature_algorithm_name(self):
"""Get str value for 'signatureAlgorithmName'
The signature algorithm name if known (if known).
"""
ret = self._get_attr("signatureAlgorithmName")
return ret
@property
def issuer_name(self):
"""Get str value for 'issuerName'
Issuer name. Each member of the array is on the format
COMPONENT=NAME, e.g. "C=DE", "ST=Example", "L=For Instance", "O=Beispiel GmbH",
"CN=beispiel.example.org".
"""
ret = self._get_attr("issuerName")
return ret
@property
def subject_name(self):
"""Get str value for 'subjectName'
Subject name. Same format as issuerName.
"""
ret = self._get_attr("subjectName")
return ret
@property
def friendly_name(self):
"""Get str value for 'friendlyName'
Friendly subject name or similar.
"""
ret = self._get_attr("friendlyName")
return ret
@property
def validity_period_not_before(self):
"""Get str value for 'validityPeriodNotBefore'
Certificate not valid before ISO time stamp.
"""
ret = self._get_attr("validityPeriodNotBefore")
return ret
@property
def validity_period_not_after(self):
"""Get str value for 'validityPeriodNotAfter'
Certificate not valid after ISO time stamp.
"""
ret = self._get_attr("validityPeriodNotAfter")
return ret
@property
def public_key_algorithm_oid(self):
"""Get str value for 'publicKeyAlgorithmOID'
The dotted OID of the public key algorithm.
"""
ret = self._get_attr("publicKeyAlgorithmOID")
return ret
@property
def public_key_algorithm(self):
"""Get str value for 'publicKeyAlgorithm'
The public key algorithm name (if known).
"""
ret = self._get_attr("publicKeyAlgorithm")
return ret
@property
def subject_public_key(self):
"""Get str value for 'subjectPublicKey'
The raw public key bytes.
"""
ret = self._get_attr("subjectPublicKey")
return ret
@property
def issuer_unique_identifier(self):
"""Get str value for 'issuerUniqueIdentifier'
Unique identifier of the issuer (empty string if not present).
"""
ret = self._get_attr("issuerUniqueIdentifier")
return ret
@property
def subject_unique_identifier(self):
"""Get str value for 'subjectUniqueIdentifier'
Unique identifier of this certificate (empty string if not present).
"""
ret = self._get_attr("subjectUniqueIdentifier")
return ret
@property
def certificate_authority(self):
"""Get bool value for 'certificateAuthority'
Whether this certificate is a certificate authority. Will return E_FAIL
if this attribute is not present.
"""
ret = self._get_attr("certificateAuthority")
return ret
@property
def key_usage(self):
"""Get int value for 'keyUsage'
Key usage mask. Will return 0 if not present.
"""
ret = self._get_attr("keyUsage")
return ret
@property
def extended_key_usage(self):
"""Get str value for 'extendedKeyUsage'
Array of dotted extended key usage OIDs. Empty array if not present.
"""
ret = self._get_attr("extendedKeyUsage")
return ret
@property
def raw_cert_data(self):
"""Get str value for 'rawCertData'
The raw certificate bytes.
"""
ret = self._get_attr("rawCertData")
return ret
@property
def self_signed(self):
"""Get bool value for 'selfSigned'
Set if self signed certificate.
"""
ret = self._get_attr("selfSigned")
return ret
@property
def trusted(self):
"""Get bool value for 'trusted'
Set if the certificate is trusted (by the parent object).
"""
ret = self._get_attr("trusted")
return ret
@property
def expired(self):
"""Get bool value for 'expired'
Set if the certificate has expired (relevant to the parent object)/
"""
ret = self._get_attr("expired")
return ret
[docs] def is_currently_expired(self):
"""Tests if the certificate has expired at the present time according to
the X.509 validity of the certificate.
return result of type bool
"""
result = self._call("isCurrentlyExpired")
return result
[docs] def query_info(self, what):
"""Way to extend the interface.
in what of type int
return result of type str
"""
if not isinstance(what, baseinteger):
raise TypeError("what can only be an instance of type baseinteger")
result = self._call("queryInfo",
in_p=[what])
return result
class IAppliance(Interface):
"""
Represents a platform-independent appliance in OVF format. An instance of this is returned
by :py:func:`IVirtualBox.create_appliance` , which can then be used to import and export
virtual machines within an appliance with VirtualBox.
The OVF standard suggests two different physical file formats:
If the appliance is distributed as a set of files, there must be at least one XML descriptor
file that conforms to the OVF standard and carries an .ovf file extension. If
this descriptor file references other files such as disk images, as OVF appliances typically
do, those additional files must be in the same directory as the descriptor file.
If the appliance is distributed as a single file, it must be in TAR format and have the
.ova file extension. This TAR file must then contain at least the OVF descriptor
files and optionally other files.
At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
be added with a later version.
**Importing** an OVF appliance into VirtualBox as instances of
:py:class:`IMachine` involves the following sequence of API calls:
Call :py:func:`IVirtualBox.create_appliance` . This will create an empty IAppliance object.
On the new object, call :py:func:`read` with the full path of the OVF file you
would like to import. So long as this file is syntactically valid, this will succeed
and fill the appliance object with the parsed data from the OVF file.
Next, call :py:func:`interpret` , which analyzes the OVF data and sets up the
contents of the IAppliance attributes accordingly. These can be inspected by a
VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
user. In particular, the :py:func:`virtual_system_descriptions` array contains
instances of :py:class:`IVirtualSystemDescription` which represent the virtual
systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
The GUI can then give the user the option to confirm and/or change these suggestions.
If desired, call :py:func:`IVirtualSystemDescription.set_final_values` for each
virtual system (machine) to override the suggestions made by the :py:func:`interpret` routine.
Finally, call :py:func:`import_machines` to create virtual machines in
VirtualBox as instances of :py:class:`IMachine` that match the information in the
virtual system descriptions. After this call succeeded, the UUIDs of the machines created
can be found in the :py:func:`machines` array attribute.
**Exporting** VirtualBox machines into an OVF appliance involves the following steps:
As with importing, first call :py:func:`IVirtualBox.create_appliance` to create
an empty IAppliance object.
For each machine you would like to export, call :py:func:`IMachine.export_to`
with the IAppliance object you just created. Each such call creates one instance of
:py:class:`IVirtualSystemDescription` inside the appliance.
If desired, call :py:func:`IVirtualSystemDescription.set_final_values` for each
virtual system (machine) to override the suggestions made by the :py:func:`IMachine.export_to` routine.
Finally, call :py:func:`write` with a path specification to have the OVF
file written.
"""
__uuid__ = '8398f026-4add-4474-5bc3-2f9f2140b23e'
__wsmap__ = 'managed'
@property
def path(self):
"""Get str value for 'path'
Path to the main file of the OVF appliance, which is either the .ovf or
the .ova file passed to :py:func:`read` (for import) or
:py:func:`write` (for export).
This attribute is empty until one of these methods has been called.
"""
ret = self._get_attr("path")
return ret
@property
def disks(self):
"""Get str value for 'disks'
Array of virtual disk definitions. One such description exists for each
disk definition in the OVF; each string array item represents one such piece of
disk information, with the information fields separated by tab (\\t) characters.
The caller should be prepared for additional fields being appended to
this string in future versions of VirtualBox and therefore check for
the number of tabs in the strings returned.
In the current version, the following eight fields are returned per string
in the array:
Disk ID (unique string identifier given to disk)
Capacity (unsigned integer indicating the maximum capacity of the disk)
Populated size (optional unsigned integer indicating the current size of the
disk; can be approximate; -1 if unspecified)
Format (string identifying the disk format, typically
"http://www.vmware.com/specifications/vmdk.html#sparse")
Reference (where to find the disk image, typically a file name; if empty,
then the disk should be created on import)
Image size (optional unsigned integer indicating the size of the image,
which need not necessarily be the same as the values specified above, since
the image may be compressed or sparse; -1 if not specified)
Chunk size (optional unsigned integer if the image is split into chunks;
presently unsupported and always -1)
Compression (optional string equaling "gzip" if the image is gzip-compressed)
"""
ret = self._get_attr("disks")
return ret
@property
def virtual_system_descriptions(self):
"""Get IVirtualSystemDescription value for 'virtualSystemDescriptions'
Array of virtual system descriptions. One such description is created
for each virtual system (machine) found in the OVF.
This array is empty until either :py:func:`interpret` (for import) or :py:func:`IMachine.export_to`
(for export) has been called.
"""
ret = self._get_attr("virtualSystemDescriptions")
return [IVirtualSystemDescription(a) for a in ret]
@property
def machines(self):
"""Get str value for 'machines'
Contains the UUIDs of the machines created from the information in this appliances. This is only
relevant for the import case, and will only contain data after a call to :py:func:`import_machines`
succeeded.
"""
ret = self._get_attr("machines")
return ret
@property
def certificate(self):
"""Get ICertificate value for 'certificate'
The X.509 signing certificate, if the imported OVF was signed, @c null
if not signed. This is available after calling :py:func:`read` .
"""
ret = self._get_attr("certificate")
return ICertificate(ret)
def read(self, file_p):
"""Reads an OVF file into the appliance object.
This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
mere fact that this method returns successfully does not mean that VirtualBox supports all
features requested by the appliance; this can only be examined after a call to :py:func:`interpret` .
in file_p of type str
Name of appliance file to open (either with an .ovf or .ova extension, depending
on whether the appliance is distributed as a set of files or as a single file, respectively).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(file_p, basestring):
raise TypeError("file_p can only be an instance of type basestring")
progress = self._call("read",
in_p=[file_p])
progress = IProgress(progress)
return progress
[docs] def interpret(self):
"""Interprets the OVF data that was read when the appliance was constructed. After
calling this method, one can inspect the
:py:func:`virtual_system_descriptions` array attribute, which will then contain
one :py:class:`IVirtualSystemDescription` for each virtual machine found in
the appliance.
Calling this method is the second step of importing an appliance into VirtualBox;
see :py:class:`IAppliance` for an overview.
After calling this method, one should call :py:func:`get_warnings` to find out
if problems were encountered during the processing which might later lead to
errors.
"""
self._call("interpret")
def import_machines(self, options):
"""Imports the appliance into VirtualBox by creating instances of :py:class:`IMachine`
and other interfaces that match the information contained in the appliance as
closely as possible, as represented by the import instructions in the
:py:func:`virtual_system_descriptions` array.
Calling this method is the final step of importing an appliance into VirtualBox;
see :py:class:`IAppliance` for an overview.
Since importing the appliance will most probably involve copying and converting
disk images, which can take a long time, this method operates asynchronously and
returns an IProgress object to allow the caller to monitor the progress.
After the import succeeded, the UUIDs of the IMachine instances created can be
retrieved from the :py:func:`machines` array attribute.
in options of type :class:`ImportOptions`
Options for the importing operation.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(options, list):
raise TypeError("options can only be an instance of type list")
for a in options[:10]:
if not isinstance(a, ImportOptions):
raise TypeError(\
"array can only contain objects of type ImportOptions")
progress = self._call("importMachines",
in_p=[options])
progress = IProgress(progress)
return progress
[docs] def create_vfs_explorer(self, uri):
"""Returns a :py:class:`IVFSExplorer` object for the given URI.
in uri of type str
The URI describing the file system to use.
return explorer of type :class:`IVFSExplorer`
"""
if not isinstance(uri, basestring):
raise TypeError("uri can only be an instance of type basestring")
explorer = self._call("createVFSExplorer",
in_p=[uri])
explorer = IVFSExplorer(explorer)
return explorer
[docs] def write(self, format_p, options, path):
"""Writes the contents of the appliance exports into a new OVF file.
Calling this method is the final step of exporting an appliance from VirtualBox;
see :py:class:`IAppliance` for an overview.
Since exporting the appliance will most probably involve copying and converting
disk images, which can take a long time, this method operates asynchronously and
returns an IProgress object to allow the caller to monitor the progress.
in format_p of type str
Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
and "ovf-2.0"; future versions of VirtualBox may support additional formats.
in options of type :class:`ExportOptions`
Options for the exporting operation.
in path of type str
Name of appliance file to open (either with an .ovf or .ova extension, depending
on whether the appliance is distributed as a set of files or as a single file, respectively).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(options, list):
raise TypeError("options can only be an instance of type list")
for a in options[:10]:
if not isinstance(a, ExportOptions):
raise TypeError(\
"array can only contain objects of type ExportOptions")
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
progress = self._call("write",
in_p=[format_p, options, path])
progress = IProgress(progress)
return progress
[docs] def get_warnings(self):
"""Returns textual warnings which occurred during execution of :py:func:`interpret` .
return warnings of type str
"""
warnings = self._call("getWarnings")
return warnings
[docs] def get_password_ids(self):
"""Returns a list of password identifiers which must be supplied to import or export
encrypted virtual machines.
return identifiers of type str
The list of password identifiers required for export on success.
"""
identifiers = self._call("getPasswordIds")
return identifiers
[docs] def get_medium_ids_for_password_id(self, password_id):
"""Returns a list of medium identifiers which use the given password identifier.
in password_id of type str
The password identifier to get the medium identifiers for.
return identifiers of type str
The list of medium identifiers returned on success.
"""
if not isinstance(password_id, basestring):
raise TypeError("password_id can only be an instance of type basestring")
identifiers = self._call("getMediumIdsForPasswordId",
in_p=[password_id])
return identifiers
[docs] def add_passwords(self, identifiers, passwords):
"""Adds a list of passwords required to import or export encrypted virtual
machines.
in identifiers of type str
List of identifiers.
in passwords of type str
List of matching passwords.
"""
if not isinstance(identifiers, list):
raise TypeError("identifiers can only be an instance of type list")
for a in identifiers[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(passwords, list):
raise TypeError("passwords can only be an instance of type list")
for a in passwords[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("addPasswords",
in_p=[identifiers, passwords])
class IVirtualSystemDescription(Interface):
"""
Represents one virtual system (machine) in an appliance. This interface is used in
the :py:func:`IAppliance.virtual_system_descriptions` array. After
:py:func:`IAppliance.interpret` has been called, that array contains information
about how the virtual systems described in the OVF should best be imported into
VirtualBox virtual machines. See :py:class:`IAppliance` for the steps required to
import an OVF into VirtualBox.
"""
__uuid__ = '316c99a2-405d-41af-8508-46889144d067'
__wsmap__ = 'managed'
@property
def count(self):
"""Get int value for 'count'
Return the number of virtual system description entries.
"""
ret = self._get_attr("count")
return ret
[docs] def get_description(self):
"""Returns information about the virtual system as arrays of instruction items. In each array, the
items with the same indices correspond and jointly represent an import instruction for VirtualBox.
The list below identifies the value sets that are possible depending on the
:py:class:`VirtualSystemDescriptionType` enum value in the array item in @a aTypes[]. In each case,
the array item with the same index in @a OVFValues[] will contain the original value as contained
in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
will contain a suggested value to be used for VirtualBox. Depending on the description type,
the @a aExtraConfigValues[] array item may also be used.
"OS": the guest operating system type. There must be exactly one such array item on import. The
corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
This will be one of the values listed in :py:func:`IVirtualBox.guest_os_types` . The corresponding
item in @a OVFValues[] will contain a numerical value that described the operating system in the OVF.
"Name": the name to give to the new virtual machine. There can be at most one such array item;
if none is present on import, then an automatic name will be created from the operating system
type. The corresponding item im @a OVFValues[] will contain the suggested virtual machine name
from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
:py:class:`IMachine` name that does not exist yet.
"Description": an arbitrary description.
"License": the EULA section from the OVF, if present. It is the responsibility of the calling
code to display such a license for agreement; the Main API does not enforce any such policy.
Miscellaneous: reserved for future use.
"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
is present on import, then VirtualBox will set a meaningful default based on the operating system
type.
"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
An optional value in @a OVFValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
writes into the OVF.
The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
type can use to specify which hard disk controller a virtual disk should be connected to.
Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
its virtual machines supports four channels (primary master, primary slave, secondary master,
secondary slave) and thus maps to two IDE controllers in the OVF sense.
"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
has no value in @a OVFValues[] or @a aVBoxValues[].
The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
The items in @a OVFValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
whereas VirtualBox considers it a class of storage controllers of its own; see
:py:class:`StorageControllerType` ).
The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
The array item in @a OVFValues[] will contain the file specification from the OVF file (without
a path since the image file should be in the same location as the OVF file itself), whereas the
item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
hard disk image. This means that on import the image will be copied and converted from the
"ovf" location to the "vbox" location; on export, this will be handled the other way round.
The matching item in the @a aExtraConfigValues[] array must contain a string of the following
format: "controller=<index>;channel=<c>"
In this string, <index> must be an integer specifying the hard disk controller to connect
the image to. That number must be the index of an array item with one of the hard disk controller
types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
In addition, <c> must specify the channel to use on that controller. For IDE controllers,
this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
attachment information as with "HardDiskImage" items.
"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
attachment information as with "HardDiskImage" items.
"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
"USBController": a USB controller. There can be at most one such item. If, and only if, such an
item is present, USB support will be enabled for the new virtual machine.
"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
present, sound support will be enabled for the new virtual machine. Note that the virtual
machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
may be different from the virtual soundcard expected by the appliance.
out types of type :class:`VirtualSystemDescriptionType`
out refs of type str
out ovf_values of type str
out v_box_values of type str
out extra_config_values of type str
"""
(types, refs, ovf_values, v_box_values, extra_config_values) = self._call("getDescription")
types = [VirtualSystemDescriptionType(a) for a in types]
return (types, refs, ovf_values, v_box_values, extra_config_values)
[docs] def get_description_by_type(self, type_p):
"""This is the same as :py:func:`get_description` except that you can specify which types
should be returned.
in type_p of type :class:`VirtualSystemDescriptionType`
out types of type :class:`VirtualSystemDescriptionType`
out refs of type str
out ovf_values of type str
out v_box_values of type str
out extra_config_values of type str
"""
if not isinstance(type_p, VirtualSystemDescriptionType):
raise TypeError("type_p can only be an instance of type VirtualSystemDescriptionType")
(types, refs, ovf_values, v_box_values, extra_config_values) = self._call("getDescriptionByType",
in_p=[type_p])
types = [VirtualSystemDescriptionType(a) for a in types]
return (types, refs, ovf_values, v_box_values, extra_config_values)
[docs] def get_values_by_type(self, type_p, which):
"""This is the same as :py:func:`get_description_by_type` except that you can specify which
value types should be returned. See :py:class:`VirtualSystemDescriptionValueType` for possible
values.
in type_p of type :class:`VirtualSystemDescriptionType`
in which of type :class:`VirtualSystemDescriptionValueType`
return values of type str
"""
if not isinstance(type_p, VirtualSystemDescriptionType):
raise TypeError("type_p can only be an instance of type VirtualSystemDescriptionType")
if not isinstance(which, VirtualSystemDescriptionValueType):
raise TypeError("which can only be an instance of type VirtualSystemDescriptionValueType")
values = self._call("getValuesByType",
in_p=[type_p, which])
return values
[docs] def set_final_values(self, enabled, v_box_values, extra_config_values):
"""This method allows the appliance's user to change the configuration for the virtual
system descriptions. For each array item returned from :py:func:`get_description` ,
you must pass in one boolean value and one configuration value.
Each item in the boolean array determines whether the particular configuration item
should be enabled.
You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
and SoundCard.
For the "vbox" and "extra configuration" values, if you pass in the same arrays
as returned in the aVBoxValues and aExtraConfigValues arrays from :py:func:`get_description` ,
the configuration remains unchanged. Please see the documentation for :py:func:`get_description`
for valid configuration values for the individual array item types. If the
corresponding item in the aEnabled array is @c false, the configuration value is ignored.
in enabled of type bool
in v_box_values of type str
in extra_config_values of type str
"""
if not isinstance(enabled, list):
raise TypeError("enabled can only be an instance of type list")
for a in enabled[:10]:
if not isinstance(a, bool):
raise TypeError(\
"array can only contain objects of type bool")
if not isinstance(v_box_values, list):
raise TypeError("v_box_values can only be an instance of type list")
for a in v_box_values[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(extra_config_values, list):
raise TypeError("extra_config_values can only be an instance of type list")
for a in extra_config_values[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("setFinalValues",
in_p=[enabled, v_box_values, extra_config_values])
[docs] def add_description(self, type_p, v_box_value, extra_config_value):
"""This method adds an additional description entry to the stack of already
available descriptions for this virtual system. This is handy for writing
values which aren't directly supported by VirtualBox. One example would
be the License type of :py:class:`VirtualSystemDescriptionType` .
in type_p of type :class:`VirtualSystemDescriptionType`
in v_box_value of type str
in extra_config_value of type str
"""
if not isinstance(type_p, VirtualSystemDescriptionType):
raise TypeError("type_p can only be an instance of type VirtualSystemDescriptionType")
if not isinstance(v_box_value, basestring):
raise TypeError("v_box_value can only be an instance of type basestring")
if not isinstance(extra_config_value, basestring):
raise TypeError("extra_config_value can only be an instance of type basestring")
self._call("addDescription",
in_p=[type_p, v_box_value, extra_config_value])
[docs]class IInternalMachineControl(Interface):
"""
Updates the VM state.
This operation will also update the settings file with the correct
information about the saved state file and delete this file from disk
when appropriate.
"""
__uuid__ = 'cdbc59df-4f4d-4cf2-809c-917601355afc'
__wsmap__ = 'suppress'
[docs] def update_state(self, state):
"""Updates the VM state.
This operation will also update the settings file with the correct
information about the saved state file and delete this file from disk
when appropriate.
in state of type :class:`MachineState`
"""
if not isinstance(state, MachineState):
raise TypeError("state can only be an instance of type MachineState")
self._call("updateState",
in_p=[state])
[docs] def begin_power_up(self, progress):
"""Tells VBoxSVC that :py:func:`IConsole.power_up` is under ways and
gives it the progress object that should be part of any pending
:py:func:`IMachine.launch_vm_process` operations. The progress
object may be called back to reflect an early cancelation, so some care
have to be taken with respect to any cancelation callbacks. The console
object will call :py:func:`IInternalMachineControl.end_power_up`
to signal the completion of the progress object.
in progress of type :class:`IProgress`
"""
if not isinstance(progress, IProgress):
raise TypeError("progress can only be an instance of type IProgress")
self._call("beginPowerUp",
in_p=[progress])
[docs] def end_power_up(self, result):
"""Tells VBoxSVC that :py:func:`IConsole.power_up` has completed.
This method may query status information from the progress object it
received in :py:func:`IInternalMachineControl.begin_power_up` and copy
it over to any in-progress :py:func:`IMachine.launch_vm_process`
call in order to complete that progress object.
in result of type int
"""
if not isinstance(result, baseinteger):
raise TypeError("result can only be an instance of type baseinteger")
self._call("endPowerUp",
in_p=[result])
[docs] def begin_powering_down(self):
"""Called by the VM process to inform the server it wants to
stop the VM execution and power down.
out progress of type :class:`IProgress`
Progress object created by VBoxSVC to wait until
the VM is powered down.
"""
progress = self._call("beginPoweringDown")
progress = IProgress(progress)
return progress
[docs] def end_powering_down(self, result, err_msg):
"""Called by the VM process to inform the server that powering
down previously requested by #beginPoweringDown is either
successfully finished or there was a failure.
in result of type int
@c S_OK to indicate success.
in err_msg of type str
@c human readable error message in case of failure.
raises :class:`VBoxErrorFileError`
Settings file not accessible.
raises :class:`VBoxErrorXmlError`
Could not parse the settings file.
"""
if not isinstance(result, baseinteger):
raise TypeError("result can only be an instance of type baseinteger")
if not isinstance(err_msg, basestring):
raise TypeError("err_msg can only be an instance of type basestring")
self._call("endPoweringDown",
in_p=[result, err_msg])
[docs] def run_usb_device_filters(self, device):
"""Asks the server to run USB devices filters of the associated
machine against the given USB device and tell if there is
a match.
Intended to be used only for remote USB devices. Local
ones don't require to call this method (this is done
implicitly by the Host and USBProxyService).
in device of type :class:`IUSBDevice`
out matched of type bool
out masked_interfaces of type int
"""
if not isinstance(device, IUSBDevice):
raise TypeError("device can only be an instance of type IUSBDevice")
(matched, masked_interfaces) = self._call("runUSBDeviceFilters",
in_p=[device])
return (matched, masked_interfaces)
[docs] def capture_usb_device(self, id_p, capture_filename):
"""Requests a capture of the given host USB device.
When the request is completed, the VM process will
get a :py:func:`IInternalSessionControl.on_usb_device_attach`
notification.
in id_p of type str
in capture_filename of type str
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(capture_filename, basestring):
raise TypeError("capture_filename can only be an instance of type basestring")
self._call("captureUSBDevice",
in_p=[id_p, capture_filename])
[docs] def detach_usb_device(self, id_p, done):
"""Notification that a VM is going to detach (@a done = @c false) or has
already detached (@a done = @c true) the given USB device.
When the @a done = @c true request is completed, the VM process will
get a :py:func:`IInternalSessionControl.on_usb_device_detach`
notification.
In the @a done = @c true case, the server must run its own filters
and filters of all VMs but this one on the detached device
as if it were just attached to the host computer.
in id_p of type str
in done of type bool
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(done, bool):
raise TypeError("done can only be an instance of type bool")
self._call("detachUSBDevice",
in_p=[id_p, done])
[docs] def auto_capture_usb_devices(self):
"""Requests a capture all matching USB devices attached to the host.
When the request is completed, the VM process will
get a :py:func:`IInternalSessionControl.on_usb_device_attach`
notification per every captured device.
"""
self._call("autoCaptureUSBDevices")
[docs] def detach_all_usb_devices(self, done):
"""Notification that a VM that is being powered down. The done
parameter indicates whether which stage of the power down
we're at. When @a done = @c false the VM is announcing its
intentions, while when @a done = @c true the VM is reporting
what it has done.
In the @a done = @c true case, the server must run its own filters
and filters of all VMs but this one on all detach devices as
if they were just attached to the host computer.
in done of type bool
"""
if not isinstance(done, bool):
raise TypeError("done can only be an instance of type bool")
self._call("detachAllUSBDevices",
in_p=[done])
[docs] def on_session_end(self, session):
"""Triggered by the given session object when the session is about
to close normally.
in session of type :class:`ISession`
Session that is being closed
return progress of type :class:`IProgress`
Used to wait until the corresponding machine is actually
dissociated from the given session on the server.
Returned only when this session is a direct one.
"""
if not isinstance(session, ISession):
raise TypeError("session can only be an instance of type ISession")
progress = self._call("onSessionEnd",
in_p=[session])
progress = IProgress(progress)
return progress
[docs] def finish_online_merge_medium(self):
"""Gets called by :py:func:`IInternalSessionControl.online_merge_medium` .
All necessary state information is available at the called object.
"""
self._call("finishOnlineMergeMedium")
[docs] def pull_guest_properties(self):
"""Get the list of the guest properties matching a set of patterns along
with their values, time stamps and flags and give responsibility for
managing properties to the console.
out names of type str
The names of the properties returned.
out values of type str
The values of the properties returned. The array entries match the
corresponding entries in the @a name array.
out timestamps of type int
The time stamps of the properties returned. The array entries match
the corresponding entries in the @a name array.
out flags of type str
The flags of the properties returned. The array entries match the
corresponding entries in the @a name array.
"""
(names, values, timestamps, flags) = self._call("pullGuestProperties")
return (names, values, timestamps, flags)
[docs] def push_guest_property(self, name, value, timestamp, flags):
"""Update a single guest property in IMachine.
in name of type str
The name of the property to be updated.
in value of type str
The value of the property.
in timestamp of type int
The timestamp of the property.
in flags of type str
The flags of the property.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
if not isinstance(timestamp, baseinteger):
raise TypeError("timestamp can only be an instance of type baseinteger")
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
self._call("pushGuestProperty",
in_p=[name, value, timestamp, flags])
[docs] def eject_medium(self, attachment):
"""Tells VBoxSVC that the guest has ejected the medium associated with
the medium attachment.
in attachment of type :class:`IMediumAttachment`
The medium attachment where the eject happened.
return new_attachment of type :class:`IMediumAttachment`
A new reference to the medium attachment, as the config change can
result in the creation of a new instance.
"""
if not isinstance(attachment, IMediumAttachment):
raise TypeError("attachment can only be an instance of type IMediumAttachment")
new_attachment = self._call("ejectMedium",
in_p=[attachment])
new_attachment = IMediumAttachment(new_attachment)
return new_attachment
[docs] def report_vm_statistics(self, valid_stats, cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared, mem_cache, paged_total, mem_alloc_total, mem_free_total, mem_balloon_total, mem_shared_total, vm_net_rx, vm_net_tx):
"""Passes statistics collected by VM (including guest statistics) to VBoxSVC.
in valid_stats of type int
Mask defining which parameters are valid. For example: 0x11 means
that cpuIdle and XXX are valid. Other parameters should be ignored.
in cpu_user of type int
Percentage of processor time spent in user mode as seen by the guest.
in cpu_kernel of type int
Percentage of processor time spent in kernel mode as seen by the guest.
in cpu_idle of type int
Percentage of processor time spent idling as seen by the guest.
in mem_total of type int
Total amount of physical guest RAM.
in mem_free of type int
Free amount of physical guest RAM.
in mem_balloon of type int
Amount of ballooned physical guest RAM.
in mem_shared of type int
Amount of shared physical guest RAM.
in mem_cache of type int
Total amount of guest (disk) cache memory.
in paged_total of type int
Total amount of space in the page file.
in mem_alloc_total of type int
Total amount of memory allocated by the hypervisor.
in mem_free_total of type int
Total amount of free memory available in the hypervisor.
in mem_balloon_total of type int
Total amount of memory ballooned by the hypervisor.
in mem_shared_total of type int
Total amount of shared memory in the hypervisor.
in vm_net_rx of type int
Network receive rate for VM.
in vm_net_tx of type int
Network transmit rate for VM.
"""
if not isinstance(valid_stats, baseinteger):
raise TypeError("valid_stats can only be an instance of type baseinteger")
if not isinstance(cpu_user, baseinteger):
raise TypeError("cpu_user can only be an instance of type baseinteger")
if not isinstance(cpu_kernel, baseinteger):
raise TypeError("cpu_kernel can only be an instance of type baseinteger")
if not isinstance(cpu_idle, baseinteger):
raise TypeError("cpu_idle can only be an instance of type baseinteger")
if not isinstance(mem_total, baseinteger):
raise TypeError("mem_total can only be an instance of type baseinteger")
if not isinstance(mem_free, baseinteger):
raise TypeError("mem_free can only be an instance of type baseinteger")
if not isinstance(mem_balloon, baseinteger):
raise TypeError("mem_balloon can only be an instance of type baseinteger")
if not isinstance(mem_shared, baseinteger):
raise TypeError("mem_shared can only be an instance of type baseinteger")
if not isinstance(mem_cache, baseinteger):
raise TypeError("mem_cache can only be an instance of type baseinteger")
if not isinstance(paged_total, baseinteger):
raise TypeError("paged_total can only be an instance of type baseinteger")
if not isinstance(mem_alloc_total, baseinteger):
raise TypeError("mem_alloc_total can only be an instance of type baseinteger")
if not isinstance(mem_free_total, baseinteger):
raise TypeError("mem_free_total can only be an instance of type baseinteger")
if not isinstance(mem_balloon_total, baseinteger):
raise TypeError("mem_balloon_total can only be an instance of type baseinteger")
if not isinstance(mem_shared_total, baseinteger):
raise TypeError("mem_shared_total can only be an instance of type baseinteger")
if not isinstance(vm_net_rx, baseinteger):
raise TypeError("vm_net_rx can only be an instance of type baseinteger")
if not isinstance(vm_net_tx, baseinteger):
raise TypeError("vm_net_tx can only be an instance of type baseinteger")
self._call("reportVmStatistics",
in_p=[valid_stats, cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared, mem_cache, paged_total, mem_alloc_total, mem_free_total, mem_balloon_total, mem_shared_total, vm_net_rx, vm_net_tx])
[docs] def authenticate_external(self, auth_params):
"""Verify credentials using the external auth library.
in auth_params of type str
The auth parameters, credentials, etc.
out result of type str
The authentification result.
"""
if not isinstance(auth_params, list):
raise TypeError("auth_params can only be an instance of type list")
for a in auth_params[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
result = self._call("authenticateExternal",
in_p=[auth_params])
return result
[docs]class IBIOSSettings(Interface):
"""
The IBIOSSettings interface represents BIOS settings of the virtual
machine. This is used only in the :py:func:`IMachine.bios_settings` attribute.
"""
__uuid__ = 'f13f667d-3624-4ac5-99c1-3d982ebd8d98'
__wsmap__ = 'managed'
@property
def logo_fade_in(self):
"""Get or set bool value for 'logoFadeIn'
Fade in flag for BIOS logo animation.
"""
ret = self._get_attr("logoFadeIn")
return ret
@logo_fade_in.setter
def logo_fade_in(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("logoFadeIn", value)
@property
def logo_fade_out(self):
"""Get or set bool value for 'logoFadeOut'
Fade out flag for BIOS logo animation.
"""
ret = self._get_attr("logoFadeOut")
return ret
@logo_fade_out.setter
def logo_fade_out(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("logoFadeOut", value)
@property
def logo_display_time(self):
"""Get or set int value for 'logoDisplayTime'
BIOS logo display time in milliseconds (0 = default).
"""
ret = self._get_attr("logoDisplayTime")
return ret
@logo_display_time.setter
def logo_display_time(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("logoDisplayTime", value)
@property
def logo_image_path(self):
"""Get or set str value for 'logoImagePath'
Local file system path for external BIOS splash image. Empty string
means the default image is shown on boot.
"""
ret = self._get_attr("logoImagePath")
return ret
@logo_image_path.setter
def logo_image_path(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("logoImagePath", value)
@property
def boot_menu_mode(self):
"""Get or set BIOSBootMenuMode value for 'bootMenuMode'
Mode of the BIOS boot device menu.
"""
ret = self._get_attr("bootMenuMode")
return BIOSBootMenuMode(ret)
@boot_menu_mode.setter
def boot_menu_mode(self, value):
if not isinstance(value, BIOSBootMenuMode):
raise TypeError("value is not an instance of BIOSBootMenuMode")
return self._set_attr("bootMenuMode", value)
@property
def acpi_enabled(self):
"""Get or set bool value for 'ACPIEnabled'
ACPI support flag.
"""
ret = self._get_attr("ACPIEnabled")
return ret
@acpi_enabled.setter
def acpi_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("ACPIEnabled", value)
@property
def ioapic_enabled(self):
"""Get or set bool value for 'IOAPICEnabled'
I/O-APIC support flag. If set, VirtualBox will provide an I/O-APIC
and support IRQs above 15.
"""
ret = self._get_attr("IOAPICEnabled")
return ret
@ioapic_enabled.setter
def ioapic_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("IOAPICEnabled", value)
@property
def apic_mode(self):
"""Get or set APICMode value for 'APICMode'
APIC mode to set up by the firmware.
"""
ret = self._get_attr("APICMode")
return APICMode(ret)
@apic_mode.setter
def apic_mode(self, value):
if not isinstance(value, APICMode):
raise TypeError("value is not an instance of APICMode")
return self._set_attr("APICMode", value)
@property
def time_offset(self):
"""Get or set int value for 'timeOffset'
Offset in milliseconds from the host system time. This allows for
guests running with a different system date/time than the host.
It is equivalent to setting the system date/time in the BIOS except
it is not an absolute value but a relative one. Guest Additions
time synchronization honors this offset.
"""
ret = self._get_attr("timeOffset")
return ret
@time_offset.setter
def time_offset(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("timeOffset", value)
@property
def pxe_debug_enabled(self):
"""Get or set bool value for 'PXEDebugEnabled'
PXE debug logging flag. If set, VirtualBox will write extensive
PXE trace information to the release log.
"""
ret = self._get_attr("PXEDebugEnabled")
return ret
@pxe_debug_enabled.setter
def pxe_debug_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("PXEDebugEnabled", value)
@property
def non_volatile_storage_file(self):
"""Get str value for 'nonVolatileStorageFile'
The location of the file storing the non-volatile memory content when
the VM is powered off. The file does not always exist.
This feature will be realized after VirtualBox v4.3.0.
"""
ret = self._get_attr("nonVolatileStorageFile")
return ret
[docs]class IPCIAddress(Interface):
"""
Address on the PCI bus.
"""
__uuid__ = 'c984d15f-e191-400b-840e-970f3dad7296'
__wsmap__ = 'managed'
@property
def bus(self):
"""Get or set int value for 'bus'
Bus number.
"""
ret = self._get_attr("bus")
return ret
@bus.setter
def bus(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("bus", value)
@property
def device(self):
"""Get or set int value for 'device'
Device number.
"""
ret = self._get_attr("device")
return ret
@device.setter
def device(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("device", value)
@property
def dev_function(self):
"""Get or set int value for 'devFunction'
Device function number.
"""
ret = self._get_attr("devFunction")
return ret
@dev_function.setter
def dev_function(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("devFunction", value)
[docs] def as_long(self):
"""Convert PCI address into long.
return result of type int
"""
result = self._call("asLong")
return result
[docs] def from_long(self, number):
"""Make PCI address from long.
in number of type int
"""
if not isinstance(number, baseinteger):
raise TypeError("number can only be an instance of type baseinteger")
self._call("fromLong",
in_p=[number])
[docs]class IPCIDeviceAttachment(Interface):
"""
Information about PCI attachments.
"""
__uuid__ = '91f33d6f-e621-4f70-a77e-15f0e3c714d5'
__wsmap__ = 'struct'
@property
def name(self):
"""Get str value for 'name'
Device name.
"""
ret = self._get_attr("name")
return ret
@property
def is_physical_device(self):
"""Get bool value for 'isPhysicalDevice'
If this is physical or virtual device.
"""
ret = self._get_attr("isPhysicalDevice")
return ret
@property
def host_address(self):
"""Get int value for 'hostAddress'
Address of device on the host, applicable only to host devices.
"""
ret = self._get_attr("hostAddress")
return ret
@property
def guest_address(self):
"""Get int value for 'guestAddress'
Address of device in the guest.
"""
ret = self._get_attr("guestAddress")
return ret
class IMachine(Interface):
"""
The IMachine interface represents a virtual machine, or guest, created
in VirtualBox.
This interface is used in two contexts. First of all, a collection of
objects implementing this interface is stored in the
:py:func:`IVirtualBox.machines` attribute which lists all the virtual
machines that are currently registered with this VirtualBox
installation. Also, once a session has been opened for the given virtual
machine (e.g. the virtual machine is running), the machine object
associated with the open session can be queried from the session object;
see :py:class:`ISession` for details.
The main role of this interface is to expose the settings of the virtual
machine and provide methods to change various aspects of the virtual
machine's configuration. For machine objects stored in the
:py:func:`IVirtualBox.machines` collection, all attributes are
read-only unless explicitly stated otherwise in individual attribute
and method descriptions.
In order to change a machine setting, a session for this machine must be
opened using one of the :py:func:`IMachine.lock_machine` or
:py:func:`IMachine.launch_vm_process` methods. After the
machine has been successfully locked for a session, a mutable machine object
needs to be queried from the session object and then the desired settings
changes can be applied to the returned object using IMachine attributes and
methods. See the :py:class:`ISession` interface description for more
information about sessions.
Note that IMachine does not provide methods to control virtual machine
execution (such as start the machine, or power it down) -- these methods
are grouped in a separate interface called :py:class:`IConsole` .
:py:class:`ISession` , :py:class:`IConsole`
"""
__uuid__ = 'b2547866-a0a1-4391-8b86-6952d82efaa0'
__wsmap__ = 'managed'
@property
def parent(self):
"""Get IVirtualBox value for 'parent'
Associated parent object.
"""
ret = self._get_attr("parent")
return IVirtualBox(ret)
@property
def icon(self):
"""Get or set str value for 'icon'
Overridden VM Icon details.
"""
ret = self._get_attr("icon")
return ret
@icon.setter
def icon(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("icon", value)
@property
def accessible(self):
"""Get bool value for 'accessible'
Whether this virtual machine is currently accessible or not.
A machine is always deemed accessible unless it is registered *and*
its settings file cannot be read or parsed (either because the file itself
is unavailable or has invalid XML contents).
Every time this property is read, the accessibility state of
this machine is re-evaluated. If the returned value is @c false,
the :py:func:`access_error` property may be used to get the
detailed error information describing the reason of
inaccessibility, including XML error messages.
When the machine is inaccessible, only the following properties
can be used on it:
:py:func:`parent`
:py:func:`id_p`
:py:func:`settings_file_path`
:py:func:`accessible`
:py:func:`access_error`
An attempt to access any other property or method will return
an error.
The only possible action you can perform on an inaccessible
machine is to unregister it using the
:py:func:`IMachine.unregister` call (or, to check
for the accessibility state once more by querying this
property).
In the current implementation, once this property returns
@c true, the machine will never become inaccessible
later, even if its settings file cannot be successfully
read/written any more (at least, until the VirtualBox
server is restarted). This limitation may be removed in
future releases.
"""
ret = self._get_attr("accessible")
return ret
@property
def access_error(self):
"""Get IVirtualBoxErrorInfo value for 'accessError'
Error information describing the reason of machine
inaccessibility.
Reading this property is only valid after the last call to
:py:func:`accessible` returned @c false (i.e. the
machine is currently inaccessible). Otherwise, a @c null
IVirtualBoxErrorInfo object will be returned.
"""
ret = self._get_attr("accessError")
return IVirtualBoxErrorInfo(ret)
@property
def name(self):
"""Get or set str value for 'name'
Name of the virtual machine.
Besides being used for human-readable identification purposes
everywhere in VirtualBox, the virtual machine name is also used
as a name of the machine's settings file and as a name of the
subdirectory this settings file resides in. Thus, every time you
change the value of this property, the settings file will be
renamed once you call :py:func:`save_settings` to confirm the
change. The containing subdirectory will be also renamed, but
only if it has exactly the same name as the settings file
itself prior to changing this property (for backward compatibility
with previous API releases). The above implies the following
limitations:
The machine name cannot be empty.
The machine name can contain only characters that are valid
file name characters according to the rules of the file
system used to store VirtualBox configuration.
You cannot have two or more machines with the same name
if they use the same subdirectory for storing the machine
settings files.
You cannot change the name of the machine if it is running,
or if any file in the directory containing the settings file
is being used by another running machine or by any other
process in the host operating system at a time when
:py:func:`save_settings` is called.
If any of the above limitations are hit, :py:func:`save_settings`
will return an appropriate error message explaining the exact
reason and the changes you made to this machine will not be saved.
Starting with VirtualBox 4.0, a ".vbox" extension of the settings
file is recommended, but not enforced. (Previous versions always
used a generic ".xml" extension.)
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def description(self):
"""Get or set str value for 'description'
Description of the virtual machine.
The description attribute can contain any text and is
typically used to describe the hardware and software
configuration of the virtual machine in detail (i.e. network
settings, versions of the installed software and so on).
"""
ret = self._get_attr("description")
return ret
@description.setter
def description(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("description", value)
@property
def id_p(self):
"""Get str value for 'id'
UUID of the virtual machine.
"""
ret = self._get_attr("id")
return ret
@property
def groups(self):
"""Get or set str value for 'groups'
Array of machine group names of which this machine is a member.
"" and "/" are synonyms for the toplevel group. Each
group is only listed once, however they are listed in no particular
order and there is no guarantee that there are no gaps in the group
hierarchy (i.e. "/group",
"/group/subgroup/subsubgroup" is a valid result).
"""
ret = self._get_attr("groups")
return ret
@groups.setter
def groups(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("groups", value)
@property
def os_type_id(self):
"""Get or set str value for 'OSTypeId'
User-defined identifier of the Guest OS type.
You may use :py:func:`IVirtualBox.get_guest_os_type` to obtain
an IGuestOSType object representing details about the given
Guest OS type.
This value may differ from the value returned by
:py:func:`IGuest.os_type_id` if Guest Additions are
installed to the guest OS.
"""
ret = self._get_attr("OSTypeId")
return ret
@os_type_id.setter
def os_type_id(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("OSTypeId", value)
@property
def hardware_version(self):
"""Get or set str value for 'hardwareVersion'
Hardware version identifier. Internal use only for now.
"""
ret = self._get_attr("hardwareVersion")
return ret
@hardware_version.setter
def hardware_version(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("hardwareVersion", value)
@property
def hardware_uuid(self):
"""Get or set str value for 'hardwareUUID'
The UUID presented to the guest via memory tables, hardware and guest
properties. For most VMs this is the same as the @a id, but for VMs
which have been cloned or teleported it may be the same as the source
VM. The latter is because the guest shouldn't notice that it was
cloned or teleported.
"""
ret = self._get_attr("hardwareUUID")
return ret
@hardware_uuid.setter
def hardware_uuid(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("hardwareUUID", value)
@property
def cpu_count(self):
"""Get or set int value for 'CPUCount'
Number of virtual CPUs in the VM.
"""
ret = self._get_attr("CPUCount")
return ret
@cpu_count.setter
def cpu_count(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("CPUCount", value)
@property
def cpu_hot_plug_enabled(self):
"""Get or set bool value for 'CPUHotPlugEnabled'
This setting determines whether VirtualBox allows CPU
hotplugging for this machine.
"""
ret = self._get_attr("CPUHotPlugEnabled")
return ret
@cpu_hot_plug_enabled.setter
def cpu_hot_plug_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("CPUHotPlugEnabled", value)
@property
def cpu_execution_cap(self):
"""Get or set int value for 'CPUExecutionCap'
Means to limit the number of CPU cycles a guest can use. The unit
is percentage of host CPU cycles per second. The valid range
is 1 - 100. 100 (the default) implies no limit.
"""
ret = self._get_attr("CPUExecutionCap")
return ret
@cpu_execution_cap.setter
def cpu_execution_cap(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("CPUExecutionCap", value)
@property
def cpuid_portability_level(self):
"""Get or set int value for 'CPUIDPortabilityLevel'
Virtual CPUID portability level, the higher number the fewer newer
or vendor specific CPU feature is reported to the guest (via the CPUID
instruction). The default level of zero (0) means that all virtualized
feautres supported by the host is pass thru to the guest. While the
three (3) is currently the level supressing the most features.
Exactly which of the CPUID features are left out by the VMM at which
level is subject to change with each major version.
"""
ret = self._get_attr("CPUIDPortabilityLevel")
return ret
@cpuid_portability_level.setter
def cpuid_portability_level(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("CPUIDPortabilityLevel", value)
@property
def memory_size(self):
"""Get or set int value for 'memorySize'
System memory size in megabytes.
"""
ret = self._get_attr("memorySize")
return ret
@memory_size.setter
def memory_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("memorySize", value)
@property
def memory_balloon_size(self):
"""Get or set int value for 'memoryBalloonSize'
Memory balloon size in megabytes.
"""
ret = self._get_attr("memoryBalloonSize")
return ret
@memory_balloon_size.setter
def memory_balloon_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("memoryBalloonSize", value)
@property
def page_fusion_enabled(self):
"""Get or set bool value for 'pageFusionEnabled'
This setting determines whether VirtualBox allows page
fusion for this machine (64-bit hosts only).
"""
ret = self._get_attr("pageFusionEnabled")
return ret
@page_fusion_enabled.setter
def page_fusion_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("pageFusionEnabled", value)
@property
def graphics_controller_type(self):
"""Get or set GraphicsControllerType value for 'graphicsControllerType'
Graphics controller type.
"""
ret = self._get_attr("graphicsControllerType")
return GraphicsControllerType(ret)
@graphics_controller_type.setter
def graphics_controller_type(self, value):
if not isinstance(value, GraphicsControllerType):
raise TypeError("value is not an instance of GraphicsControllerType")
return self._set_attr("graphicsControllerType", value)
@property
def vram_size(self):
"""Get or set int value for 'VRAMSize'
Video memory size in megabytes.
"""
ret = self._get_attr("VRAMSize")
return ret
@vram_size.setter
def vram_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("VRAMSize", value)
@property
def accelerate3_d_enabled(self):
"""Get or set bool value for 'accelerate3DEnabled'
This setting determines whether VirtualBox allows this machine to make
use of the 3D graphics support available on the host.
"""
ret = self._get_attr("accelerate3DEnabled")
return ret
@accelerate3_d_enabled.setter
def accelerate3_d_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("accelerate3DEnabled", value)
@property
def accelerate2_d_video_enabled(self):
"""Get or set bool value for 'accelerate2DVideoEnabled'
This setting determines whether VirtualBox allows this machine to make
use of the 2D video acceleration support available on the host.
"""
ret = self._get_attr("accelerate2DVideoEnabled")
return ret
@accelerate2_d_video_enabled.setter
def accelerate2_d_video_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("accelerate2DVideoEnabled", value)
@property
def monitor_count(self):
"""Get or set int value for 'monitorCount'
Number of virtual monitors.
Only effective on Windows XP and later guests with
Guest Additions installed.
"""
ret = self._get_attr("monitorCount")
return ret
@monitor_count.setter
def monitor_count(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("monitorCount", value)
@property
def video_capture_enabled(self):
"""Get or set bool value for 'videoCaptureEnabled'
This setting determines whether VirtualBox uses video recording to
record VM session.
"""
ret = self._get_attr("videoCaptureEnabled")
return ret
@video_capture_enabled.setter
def video_capture_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("videoCaptureEnabled", value)
@property
def video_capture_screens(self):
"""Get or set bool value for 'videoCaptureScreens'
This setting determines for which screens video recording is
enabled.
"""
ret = self._get_attr("videoCaptureScreens")
return ret
@video_capture_screens.setter
def video_capture_screens(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("videoCaptureScreens", value)
@property
def video_capture_file(self):
"""Get or set str value for 'videoCaptureFile'
This setting determines the filename VirtualBox uses to save
the recorded content. This setting cannot be changed while video
capturing is enabled.
When setting this attribute, the specified path has to be
absolute (full path). When reading this attribute, a full path is
always returned.
"""
ret = self._get_attr("videoCaptureFile")
return ret
@video_capture_file.setter
def video_capture_file(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("videoCaptureFile", value)
@property
def video_capture_width(self):
"""Get or set int value for 'videoCaptureWidth'
This setting determines the horizontal resolution of the recorded
video. This setting cannot be changed while video capturing is
enabled.
"""
ret = self._get_attr("videoCaptureWidth")
return ret
@video_capture_width.setter
def video_capture_width(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureWidth", value)
@property
def video_capture_height(self):
"""Get or set int value for 'videoCaptureHeight'
This setting determines the vertical resolution of the recorded
video. This setting cannot be changed while video capturing is
enabled.
"""
ret = self._get_attr("videoCaptureHeight")
return ret
@video_capture_height.setter
def video_capture_height(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureHeight", value)
@property
def video_capture_rate(self):
"""Get or set int value for 'videoCaptureRate'
This setting determines the bitrate in kilobits per second.
Increasing this value makes the video look better for the
cost of an increased file size. This setting cannot be changed
while video capturing is enabled.
"""
ret = self._get_attr("videoCaptureRate")
return ret
@video_capture_rate.setter
def video_capture_rate(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureRate", value)
@property
def video_capture_fps(self):
"""Get or set int value for 'videoCaptureFPS'
This setting determines the maximum number of frames per second.
Frames with a higher frequency will be skipped. Reducing this
value increases the number of skipped frames and reduces the
file size. This setting cannot be changed while video capturing
is enabled.
"""
ret = self._get_attr("videoCaptureFPS")
return ret
@video_capture_fps.setter
def video_capture_fps(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureFPS", value)
@property
def video_capture_max_time(self):
"""Get or set int value for 'videoCaptureMaxTime'
This setting determines the maximum amount of time in milliseconds
the video capture will work for. The capture stops as the defined time
interval has elapsed. If this value is zero the capturing will not be
limited by time. This setting cannot be changed while video capturing is
enabled.
"""
ret = self._get_attr("videoCaptureMaxTime")
return ret
@video_capture_max_time.setter
def video_capture_max_time(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureMaxTime", value)
@property
def video_capture_max_file_size(self):
"""Get or set int value for 'videoCaptureMaxFileSize'
This setting determines the maximal number of captured video file
size in MB. The capture stops as the captured video file size
has reached the defined. If this value is zero the capturing
will not be limited by file size. This setting cannot be changed
while video capturing is enabled.
"""
ret = self._get_attr("videoCaptureMaxFileSize")
return ret
@video_capture_max_file_size.setter
def video_capture_max_file_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("videoCaptureMaxFileSize", value)
@property
def video_capture_options(self):
"""Get or set str value for 'videoCaptureOptions'
This setting contains any additional video capture options
required in comma-separated key=value format. This setting
cannot be changed while video capturing is enabled.
"""
ret = self._get_attr("videoCaptureOptions")
return ret
@video_capture_options.setter
def video_capture_options(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("videoCaptureOptions", value)
@property
def bios_settings(self):
"""Get IBIOSSettings value for 'BIOSSettings'
Object containing all BIOS settings.
"""
ret = self._get_attr("BIOSSettings")
return IBIOSSettings(ret)
@property
def firmware_type(self):
"""Get or set FirmwareType value for 'firmwareType'
Type of firmware (such as legacy BIOS or EFI), used for initial
bootstrap in this VM.
"""
ret = self._get_attr("firmwareType")
return FirmwareType(ret)
@firmware_type.setter
def firmware_type(self, value):
if not isinstance(value, FirmwareType):
raise TypeError("value is not an instance of FirmwareType")
return self._set_attr("firmwareType", value)
@property
def pointing_hid_type(self):
"""Get or set PointingHIDType value for 'pointingHIDType'
Type of pointing HID (such as mouse or tablet) used in this VM.
The default is typically "PS2Mouse" but can vary depending on the
requirements of the guest operating system.
"""
ret = self._get_attr("pointingHIDType")
return PointingHIDType(ret)
@pointing_hid_type.setter
def pointing_hid_type(self, value):
if not isinstance(value, PointingHIDType):
raise TypeError("value is not an instance of PointingHIDType")
return self._set_attr("pointingHIDType", value)
@property
def keyboard_hid_type(self):
"""Get or set KeyboardHIDType value for 'keyboardHIDType'
Type of keyboard HID used in this VM.
The default is typically "PS2Keyboard" but can vary depending on the
requirements of the guest operating system.
"""
ret = self._get_attr("keyboardHIDType")
return KeyboardHIDType(ret)
@keyboard_hid_type.setter
def keyboard_hid_type(self, value):
if not isinstance(value, KeyboardHIDType):
raise TypeError("value is not an instance of KeyboardHIDType")
return self._set_attr("keyboardHIDType", value)
@property
def hpet_enabled(self):
"""Get or set bool value for 'HPETEnabled'
This attribute controls if High Precision Event Timer (HPET) is
enabled in this VM. Use this property if you want to provide guests
with additional time source, or if guest requires HPET to function correctly.
Default is false.
"""
ret = self._get_attr("HPETEnabled")
return ret
@hpet_enabled.setter
def hpet_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("HPETEnabled", value)
@property
def chipset_type(self):
"""Get or set ChipsetType value for 'chipsetType'
Chipset type used in this VM.
"""
ret = self._get_attr("chipsetType")
return ChipsetType(ret)
@chipset_type.setter
def chipset_type(self, value):
if not isinstance(value, ChipsetType):
raise TypeError("value is not an instance of ChipsetType")
return self._set_attr("chipsetType", value)
@property
def snapshot_folder(self):
"""Get or set str value for 'snapshotFolder'
Full path to the directory used to store snapshot data
(differencing media and saved state files) of this machine.
The initial value of this property is
<:py:func:`settings_file_path` path_to_settings_file>/<
:py:func:`id_p` machine_uuid
>.
Currently, it is an error to try to change this property on
a machine that has snapshots (because this would require to
move possibly large files to a different location).
A separate method will be available for this purpose later.
Setting this property to @c null or to an empty string will restore
the initial value.
When setting this property, the specified path can be
absolute (full path) or relative to the directory where the
:py:func:`settings_file_path` machine settings file
is located. When reading this property, a full path is
always returned.
The specified path may not exist, it will be created
when necessary.
"""
ret = self._get_attr("snapshotFolder")
return ret
@snapshot_folder.setter
def snapshot_folder(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("snapshotFolder", value)
@property
def vrde_server(self):
"""Get IVRDEServer value for 'VRDEServer'
VirtualBox Remote Desktop Extension (VRDE) server object.
"""
ret = self._get_attr("VRDEServer")
return IVRDEServer(ret)
@property
def emulated_usb_card_reader_enabled(self):
"""Get or set bool value for 'emulatedUSBCardReaderEnabled'"""
ret = self._get_attr("emulatedUSBCardReaderEnabled")
return ret
@emulated_usb_card_reader_enabled.setter
def emulated_usb_card_reader_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("emulatedUSBCardReaderEnabled", value)
@property
def medium_attachments(self):
"""Get IMediumAttachment value for 'mediumAttachments'
Array of media attached to this machine.
"""
ret = self._get_attr("mediumAttachments")
return [IMediumAttachment(a) for a in ret]
@property
def usb_controllers(self):
"""Get IUSBController value for 'USBControllers'
Array of USB controllers attached to this machine.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
"""
ret = self._get_attr("USBControllers")
return [IUSBController(a) for a in ret]
@property
def usb_device_filters(self):
"""Get IUSBDeviceFilters value for 'USBDeviceFilters'
Associated USB device filters object.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
"""
ret = self._get_attr("USBDeviceFilters")
return IUSBDeviceFilters(ret)
@property
def audio_adapter(self):
"""Get IAudioAdapter value for 'audioAdapter'
Associated audio adapter, always present.
"""
ret = self._get_attr("audioAdapter")
return IAudioAdapter(ret)
@property
def storage_controllers(self):
"""Get IStorageController value for 'storageControllers'
Array of storage controllers attached to this machine.
"""
ret = self._get_attr("storageControllers")
return [IStorageController(a) for a in ret]
@property
def settings_file_path(self):
"""Get str value for 'settingsFilePath'
Full name of the file containing machine settings data.
"""
ret = self._get_attr("settingsFilePath")
return ret
@property
def settings_aux_file_path(self):
"""Get str value for 'settingsAuxFilePath'
Full name of the file containing auxiliary machine settings data.
"""
ret = self._get_attr("settingsAuxFilePath")
return ret
@property
def settings_modified(self):
"""Get bool value for 'settingsModified'
Whether the settings of this machine have been modified
(but neither yet saved nor discarded).
Reading this property is only valid on instances returned
by :py:func:`ISession.machine` and on new machines
created by :py:func:`IVirtualBox.create_machine` or opened
by :py:func:`IVirtualBox.open_machine` but not
yet registered, or on unregistered machines after calling
:py:func:`IMachine.unregister` . For all other
cases, the settings can never be modified.
For newly created unregistered machines, the value of this
property is always @c true until :py:func:`save_settings`
is called (no matter if any machine settings have been
changed after the creation or not). For opened machines
the value is set to @c false (and then follows to normal rules).
"""
ret = self._get_attr("settingsModified")
return ret
@property
def session_state(self):
"""Get SessionState value for 'sessionState'
Current session state for this machine.
"""
ret = self._get_attr("sessionState")
return SessionState(ret)
@property
def session_name(self):
"""Get str value for 'sessionName'
Name of the session. If :py:func:`session_state` is
Spawning or Locked, this attribute contains the
same value as passed to the
:py:func:`IMachine.launch_vm_process` method in the
@a name parameter. If the session was established with
:py:func:`IMachine.lock_machine` , it is the name of the session
(if set, otherwise empty string). If
:py:func:`session_state` is SessionClosed, the value of this
attribute is an empty string.
"""
ret = self._get_attr("sessionName")
return ret
@property
def session_pid(self):
"""Get int value for 'sessionPID'
Identifier of the session process. This attribute contains the
platform-dependent identifier of the process whose session was
used with :py:func:`IMachine.lock_machine` call. The returned
value is only valid if :py:func:`session_state` is Locked or
Unlocking by the time this property is read.
"""
ret = self._get_attr("sessionPID")
return ret
@property
def state(self):
"""Get MachineState value for 'state'
Current execution state of this machine.
"""
ret = self._get_attr("state")
return MachineState(ret)
@property
def last_state_change(self):
"""Get int value for 'lastStateChange'
Time stamp of the last execution state change,
in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("lastStateChange")
return ret
@property
def state_file_path(self):
"""Get str value for 'stateFilePath'
Full path to the file that stores the execution state of
the machine when it is in the :py:attr:`MachineState.saved` state.
When the machine is not in the Saved state, this attribute is
an empty string.
"""
ret = self._get_attr("stateFilePath")
return ret
@property
def log_folder(self):
"""Get str value for 'logFolder'
Full path to the folder that stores a set of rotated log files
recorded during machine execution. The most recent log file is
named VBox.log, the previous log file is
named VBox.log.1 and so on (up to VBox.log.3
in the current version).
"""
ret = self._get_attr("logFolder")
return ret
@property
def current_snapshot(self):
"""Get ISnapshot value for 'currentSnapshot'
Current snapshot of this machine. This is @c null if the machine
currently has no snapshots. If it is not @c null, then it was
set by one of :py:func:`take_snapshot` , :py:func:`delete_snapshot`
or :py:func:`restore_snapshot` , depending on which was called last.
See :py:class:`ISnapshot` for details.
"""
ret = self._get_attr("currentSnapshot")
return ISnapshot(ret)
@property
def snapshot_count(self):
"""Get int value for 'snapshotCount'
Number of snapshots taken on this machine. Zero means the
machine doesn't have any snapshots.
"""
ret = self._get_attr("snapshotCount")
return ret
@property
def current_state_modified(self):
"""Get bool value for 'currentStateModified'
Returns @c true if the current state of the machine is not
identical to the state stored in the current snapshot.
The current state is identical to the current snapshot only
directly after one of the following calls are made:
:py:func:`restore_snapshot`
:py:func:`take_snapshot` (issued on a "powered off" or "saved"
machine, for which :py:func:`settings_modified` returns @c false)
The current state remains identical until one of the following
happens:
settings of the machine are changed
the saved state is deleted
the current snapshot is deleted
an attempt to execute the machine is made
For machines that don't have snapshots, this property is
always @c false.
"""
ret = self._get_attr("currentStateModified")
return ret
@property
def shared_folders(self):
"""Get ISharedFolder value for 'sharedFolders'
Collection of shared folders for this machine (permanent shared
folders). These folders are shared automatically at machine startup
and available only to the guest OS installed within this machine.
New shared folders are added to the collection using
:py:func:`create_shared_folder` . Existing shared folders can be
removed using :py:func:`remove_shared_folder` .
"""
ret = self._get_attr("sharedFolders")
return [ISharedFolder(a) for a in ret]
@property
def clipboard_mode(self):
"""Get or set ClipboardMode value for 'clipboardMode'
Synchronization mode between the host OS clipboard
and the guest OS clipboard.
"""
ret = self._get_attr("clipboardMode")
return ClipboardMode(ret)
@clipboard_mode.setter
def clipboard_mode(self, value):
if not isinstance(value, ClipboardMode):
raise TypeError("value is not an instance of ClipboardMode")
return self._set_attr("clipboardMode", value)
@property
def dn_d_mode(self):
"""Get or set DnDMode value for 'dnDMode'
Sets or retrieves the current drag'n drop mode.
"""
ret = self._get_attr("dnDMode")
return DnDMode(ret)
@dn_d_mode.setter
def dn_d_mode(self, value):
if not isinstance(value, DnDMode):
raise TypeError("value is not an instance of DnDMode")
return self._set_attr("dnDMode", value)
@property
def teleporter_enabled(self):
"""Get or set bool value for 'teleporterEnabled'
When set to @a true, the virtual machine becomes a target teleporter
the next time it is powered on. This can only set to @a true when the
VM is in the @a PoweredOff or @a Aborted state.
<!-- This property is automatically set to @a false when the VM is powered
on. (bird: This doesn't work yet ) -->
"""
ret = self._get_attr("teleporterEnabled")
return ret
@teleporter_enabled.setter
def teleporter_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("teleporterEnabled", value)
@property
def teleporter_port(self):
"""Get or set int value for 'teleporterPort'
The TCP port the target teleporter will listen for incoming
teleportations on.
0 means the port is automatically selected upon power on. The actual
value can be read from this property while the machine is waiting for
incoming teleportations.
"""
ret = self._get_attr("teleporterPort")
return ret
@teleporter_port.setter
def teleporter_port(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("teleporterPort", value)
@property
def teleporter_address(self):
"""Get or set str value for 'teleporterAddress'
The address the target teleporter will listen on. If set to an empty
string, it will listen on all addresses.
"""
ret = self._get_attr("teleporterAddress")
return ret
@teleporter_address.setter
def teleporter_address(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("teleporterAddress", value)
@property
def teleporter_password(self):
"""Get or set str value for 'teleporterPassword'
The password to check for on the target teleporter. This is just a
very basic measure to prevent simple hacks and operators accidentally
beaming a virtual machine to the wrong place.
Note that you SET a plain text password while reading back a HASHED
password. Setting a hashed password is currently not supported.
"""
ret = self._get_attr("teleporterPassword")
return ret
@teleporter_password.setter
def teleporter_password(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("teleporterPassword", value)
@property
def paravirt_provider(self):
"""Get or set ParavirtProvider value for 'paravirtProvider'
The paravirtualized guest interface provider.
"""
ret = self._get_attr("paravirtProvider")
return ParavirtProvider(ret)
@paravirt_provider.setter
def paravirt_provider(self, value):
if not isinstance(value, ParavirtProvider):
raise TypeError("value is not an instance of ParavirtProvider")
return self._set_attr("paravirtProvider", value)
@property
def fault_tolerance_state(self):
"""Get or set FaultToleranceState value for 'faultToleranceState'
Fault tolerance state; disabled, source or target.
This property can be changed at any time. If you change it for a running
VM, then the fault tolerance address and port must be set beforehand.
"""
ret = self._get_attr("faultToleranceState")
return FaultToleranceState(ret)
@fault_tolerance_state.setter
def fault_tolerance_state(self, value):
if not isinstance(value, FaultToleranceState):
raise TypeError("value is not an instance of FaultToleranceState")
return self._set_attr("faultToleranceState", value)
@property
def fault_tolerance_port(self):
"""Get or set int value for 'faultTolerancePort'
The TCP port the fault tolerance source or target will use for
communication.
"""
ret = self._get_attr("faultTolerancePort")
return ret
@fault_tolerance_port.setter
def fault_tolerance_port(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("faultTolerancePort", value)
@property
def fault_tolerance_address(self):
"""Get or set str value for 'faultToleranceAddress'
The address the fault tolerance source or target.
"""
ret = self._get_attr("faultToleranceAddress")
return ret
@fault_tolerance_address.setter
def fault_tolerance_address(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("faultToleranceAddress", value)
@property
def fault_tolerance_password(self):
"""Get or set str value for 'faultTolerancePassword'
The password to check for on the standby VM. This is just a
very basic measure to prevent simple hacks and operators accidentally
choosing the wrong standby VM.
"""
ret = self._get_attr("faultTolerancePassword")
return ret
@fault_tolerance_password.setter
def fault_tolerance_password(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("faultTolerancePassword", value)
@property
def fault_tolerance_sync_interval(self):
"""Get or set int value for 'faultToleranceSyncInterval'
The interval in ms used for syncing the state between source and target.
"""
ret = self._get_attr("faultToleranceSyncInterval")
return ret
@fault_tolerance_sync_interval.setter
def fault_tolerance_sync_interval(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("faultToleranceSyncInterval", value)
@property
def rtc_use_utc(self):
"""Get or set bool value for 'RTCUseUTC'
When set to @a true, the RTC device of the virtual machine will run
in UTC time, otherwise in local time. Especially Unix guests prefer
the time in UTC.
"""
ret = self._get_attr("RTCUseUTC")
return ret
@rtc_use_utc.setter
def rtc_use_utc(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("RTCUseUTC", value)
@property
def io_cache_enabled(self):
"""Get or set bool value for 'IOCacheEnabled'
When set to @a true, the builtin I/O cache of the virtual machine
will be enabled.
"""
ret = self._get_attr("IOCacheEnabled")
return ret
@io_cache_enabled.setter
def io_cache_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("IOCacheEnabled", value)
@property
def io_cache_size(self):
"""Get or set int value for 'IOCacheSize'
Maximum size of the I/O cache in MB.
"""
ret = self._get_attr("IOCacheSize")
return ret
@io_cache_size.setter
def io_cache_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("IOCacheSize", value)
@property
def pci_device_assignments(self):
"""Get IPCIDeviceAttachment value for 'PCIDeviceAssignments'
Array of PCI devices assigned to this machine, to get list of all
PCI devices attached to the machine use
:py:func:`IConsole.attached_pci_devices` attribute, as this attribute
is intended to list only devices additional to what described in
virtual hardware config. Usually, this list keeps host's physical
devices assigned to the particular machine.
"""
ret = self._get_attr("PCIDeviceAssignments")
return [IPCIDeviceAttachment(a) for a in ret]
@property
def bandwidth_control(self):
"""Get IBandwidthControl value for 'bandwidthControl'
Bandwidth control manager.
"""
ret = self._get_attr("bandwidthControl")
return IBandwidthControl(ret)
@property
def tracing_enabled(self):
"""Get or set bool value for 'tracingEnabled'
Enables the tracing facility in the VMM (including PDM devices +
drivers). The VMM will consume about 0.5MB of more memory when
enabled and there may be some extra overhead from tracepoints that are
always enabled.
"""
ret = self._get_attr("tracingEnabled")
return ret
@tracing_enabled.setter
def tracing_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("tracingEnabled", value)
@property
def tracing_config(self):
"""Get or set str value for 'tracingConfig'
Tracepoint configuration to apply at startup when
:py:func:`IMachine.tracing_enabled` is true. The string specifies
a space separated of tracepoint group names to enable. The special
group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
more details on available tracepoint groups and such.
Note that on hosts supporting DTrace (or similar), a lot of the
tracepoints may be implemented exclusively as DTrace probes. So, the
effect of the same config may differ between Solaris and Windows for
example.
"""
ret = self._get_attr("tracingConfig")
return ret
@tracing_config.setter
def tracing_config(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("tracingConfig", value)
@property
def allow_tracing_to_access_vm(self):
"""Get or set bool value for 'allowTracingToAccessVM'
Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
structures when firing off trace points. This is especially useful
with DTrace tracepoints, as it allows you to use the VMCPU or VM
pointer to obtain useful information such as guest register state.
This is disabled by default because devices and drivers normally has no
business accessing the VMCPU or VM structures, and are therefore unable
to get any pointers to these.
"""
ret = self._get_attr("allowTracingToAccessVM")
return ret
@allow_tracing_to_access_vm.setter
def allow_tracing_to_access_vm(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("allowTracingToAccessVM", value)
@property
def autostart_enabled(self):
"""Get or set bool value for 'autostartEnabled'
Enables autostart of the VM during system boot.
"""
ret = self._get_attr("autostartEnabled")
return ret
@autostart_enabled.setter
def autostart_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("autostartEnabled", value)
@property
def autostart_delay(self):
"""Get or set int value for 'autostartDelay'
Number of seconds to wait until the VM should be started during system boot.
"""
ret = self._get_attr("autostartDelay")
return ret
@autostart_delay.setter
def autostart_delay(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("autostartDelay", value)
@property
def autostop_type(self):
"""Get or set AutostopType value for 'autostopType'
Action type to do when the system is shutting down.
"""
ret = self._get_attr("autostopType")
return AutostopType(ret)
@autostop_type.setter
def autostop_type(self, value):
if not isinstance(value, AutostopType):
raise TypeError("value is not an instance of AutostopType")
return self._set_attr("autostopType", value)
@property
def default_frontend(self):
"""Get or set str value for 'defaultFrontend'
Selects which VM frontend should be used by default when launching
this VM through the :py:func:`IMachine.launch_vm_process` method.
Empty or @c null strings do not define a particular default, it is up
to :py:func:`IMachine.launch_vm_process` to select one. See the
description of :py:func:`IMachine.launch_vm_process` for the valid
frontend types.
This per-VM setting overrides the default defined by
:py:func:`ISystemProperties.default_frontend` attribute, and is
overridden by a frontend type passed to
:py:func:`IMachine.launch_vm_process` .
"""
ret = self._get_attr("defaultFrontend")
return ret
@default_frontend.setter
def default_frontend(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultFrontend", value)
@property
def usb_proxy_available(self):
"""Get bool value for 'USBProxyAvailable'
Returns whether there is an USB proxy available.
"""
ret = self._get_attr("USBProxyAvailable")
return ret
@property
def vm_process_priority(self):
"""Get or set str value for 'VMProcessPriority'
Sets the priority of the VM process. It is a VM setting which can
be changed both before starting the VM and at runtime. The valid
values are system specific, and if a value is specified which does
not get recognized, then it will be remembered (useful for preparing
VM configs for other host OSes), with a successful result.
The default value is the empty string, which selects the default
process priority.
"""
ret = self._get_attr("VMProcessPriority")
return ret
@vm_process_priority.setter
def vm_process_priority(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("VMProcessPriority", value)
@property
def paravirt_debug(self):
"""Get or set str value for 'paravirtDebug'
Debug parameters for the paravirtualized guest interface provider.
"""
ret = self._get_attr("paravirtDebug")
return ret
@paravirt_debug.setter
def paravirt_debug(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("paravirtDebug", value)
@property
def cpu_profile(self):
"""Get or set str value for 'CPUProfile'
Experimental feature to select the guest CPU profile. The default
is "host", which indicates the host CPU. All other names are subject
to change.
The profiles are found in src/VBox/VMM/VMMR3/cpus/.
"""
ret = self._get_attr("CPUProfile")
return ret
@cpu_profile.setter
def cpu_profile(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("CPUProfile", value)
[docs] def lock_machine(self, session, lock_type):
"""Locks the machine for the given session to enable the caller
to make changes to the machine or start the VM or control
VM execution.
There are two ways to lock a machine for such uses:
If you want to make changes to the machine settings,
you must obtain an exclusive write lock on the machine
by setting @a lockType to @c Write.
This will only succeed if no other process has locked
the machine to prevent conflicting changes. Only after
an exclusive write lock has been obtained using this method, one
can change all VM settings or execute the VM in the process
space of the session object. (Note that the latter is only of
interest if you actually want to write a new front-end for
virtual machines; but this API gets called internally by
the existing front-ends such as VBoxHeadless and the VirtualBox
GUI to acquire a write lock on the machine that they are running.)
On success, write-locking the machine for a session creates
a second copy of the IMachine object. It is this second object
upon which changes can be made; in VirtualBox terminology, the
second copy is "mutable". It is only this second, mutable machine
object upon which you can call methods that change the
machine state. After having called this method, you can
obtain this second, mutable machine object using the
:py:func:`ISession.machine` attribute.
If you only want to check the machine state or control
machine execution without actually changing machine
settings (e.g. to get access to VM statistics or take
a snapshot or save the machine state), then set the
@a lockType argument to @c Shared.
If no other session has obtained a lock, you will obtain an
exclusive write lock as described above. However, if another
session has already obtained such a lock, then a link to that
existing session will be established which allows you
to control that existing session.
To find out which type of lock was obtained, you can
inspect :py:func:`ISession.type_p` , which will have been
set to either @c WriteLock or @c Shared.
In either case, you can get access to the :py:class:`IConsole`
object which controls VM execution.
Also in all of the above cases, one must always call
:py:func:`ISession.unlock_machine` to release the lock on the machine, or
the machine's state will eventually be set to "Aborted".
To change settings on a machine, the following sequence is typically
performed:
Call this method to obtain an exclusive write lock for the current session.
Obtain a mutable IMachine object from :py:func:`ISession.machine` .
Change the settings of the machine by invoking IMachine methods.
Call :py:func:`IMachine.save_settings` .
Release the write lock by calling :py:func:`ISession.unlock_machine` .
in session of type :class:`ISession`
Session object for which the machine will be locked.
in lock_type of type :class:`LockType`
If set to @c Write, then attempt to acquire an exclusive write lock or fail.
If set to @c Shared, then either acquire an exclusive write lock or establish
a link to an existing session.
raises :class:`OleErrorUnexpected`
Virtual machine not registered.
raises :class:`OleErrorAccessdenied`
Process not started by
raises :class:`VBoxErrorInvalidObjectState`
Session already open or being opened.
raises :class:`VBoxErrorVmError`
Failed to assign machine to session.
"""
if not isinstance(session, ISession):
raise TypeError("session can only be an instance of type ISession")
if not isinstance(lock_type, LockType):
raise TypeError("lock_type can only be an instance of type LockType")
self._call("lockMachine",
in_p=[session, lock_type])
def launch_vm_process(self, session, name, environment):
"""Spawns a new process that will execute the virtual machine and obtains a shared
lock on the machine for the calling session.
If launching the VM succeeds, the new VM process will create its own session
and write-lock the machine for it, preventing conflicting changes from other
processes. If the machine is already locked (because it is already running or
because another session has a write lock), launching the VM process will therefore
fail. Reversely, future attempts to obtain a write lock will also fail while the
machine is running.
The caller's session object remains separate from the session opened by the new
VM process. It receives its own :py:class:`IConsole` object which can be used
to control machine execution, but it cannot be used to change all VM settings
which would be available after a :py:func:`lock_machine` call.
The caller must eventually release the session's shared lock by calling
:py:func:`ISession.unlock_machine` on the local session object once this call
has returned. However, the session's state (see :py:func:`ISession.state` )
will not return to "Unlocked" until the remote session has also unlocked
the machine (i.e. the machine has stopped running).
Launching a VM process can take some time (a new VM is started in a new process,
for which memory and other resources need to be set up). Because of this,
an :py:class:`IProgress` object is returned to allow the caller to wait
for this asynchronous operation to be completed. Until then, the caller's
session object remains in the "Unlocked" state, and its :py:func:`ISession.machine`
and :py:func:`ISession.console` attributes cannot be accessed.
It is recommended to use :py:func:`IProgress.wait_for_completion` or
similar calls to wait for completion. Completion is signalled when the VM
is powered on. If launching the VM fails, error messages can be queried
via the progress object, if available.
The progress object will have at least 2 sub-operations. The first
operation covers the period up to the new VM process calls powerUp.
The subsequent operations mirror the :py:func:`IConsole.power_up`
progress object. Because :py:func:`IConsole.power_up` may require
some extra sub-operations, the :py:func:`IProgress.operation_count`
may change at the completion of operation.
For details on the teleportation progress operation, see
:py:func:`IConsole.power_up` .
<!-- TODO/r=bird: What about making @a environment into a smart array? Guess
this predates our safe array support by a year or so... Dmitry wrote the text here, right?
Just rename it to @a environmentChanges and shorten the documentation to say the string
are applied onto the server environment putenv style, i.e. "VAR=VALUE" for setting/replacing
and "VAR" for unsetting. -->
The @a environment argument is a string containing definitions of
environment variables in the following format:
::
NAME[=VALUE]\n
NAME[=VALUE]\n
...
where \\n is the new line character. These environment
variables will be appended to the environment of the VirtualBox server
process. If an environment variable exists both in the server process
and in this list, the value from this list takes precedence over the
server's variable. If the value of the environment variable is
omitted, this variable will be removed from the resulting environment.
If the environment string is @c null or empty, the server environment
is inherited by the started process as is.
in session of type :class:`ISession`
Client session object to which the VM process will be connected (this
must be in "Unlocked" state).
in name of type str
Front-end to use for the new VM process. The following are currently supported:
"gui": VirtualBox Qt GUI front-end
"headless": VBoxHeadless (VRDE Server) front-end
"sdl": VirtualBox SDL front-end
"emergencystop": reserved value, used for aborting
the currently running VM or session owner. In this case the
@a session parameter may be @c null (if it is non-null it isn't
used in any way), and the @a progress return value will be always
@c null. The operation completes immediately.
"": use the per-VM default frontend if set, otherwise
the global default defined in the system properties. If neither
are set, the API will launch a "gui" session, which may
fail if there is no windowing environment available. See
:py:func:`IMachine.default_frontend` and
:py:func:`ISystemProperties.default_frontend` .
in environment of type str
Environment to pass to the VM process.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorUnexpected`
Virtual machine not registered.
raises :class:`OleErrorInvalidarg`
Invalid session type @a type.
raises :class:`VBoxErrorObjectNotFound`
No machine matching @a machineId found.
raises :class:`VBoxErrorInvalidObjectState`
Session already open or being opened.
raises :class:`VBoxErrorIprtError`
Launching process for machine failed.
raises :class:`VBoxErrorVmError`
Failed to assign machine to session.
"""
if not isinstance(session, ISession):
raise TypeError("session can only be an instance of type ISession")
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(environment, basestring):
raise TypeError("environment can only be an instance of type basestring")
progress = self._call("launchVMProcess",
in_p=[session, name, environment])
progress = IProgress(progress)
return progress
[docs] def set_boot_order(self, position, device):
"""Puts the given device to the specified position in
the boot order.
To indicate that no device is associated with the given position,
:py:attr:`DeviceType.null` should be used.
@todo setHardDiskBootOrder(), setNetworkBootOrder()
in position of type int
Position in the boot order (@c 1 to the total number of
devices the machine can boot from, as returned by
:py:func:`ISystemProperties.max_boot_position` ).
in device of type :class:`DeviceType`
The type of the device used to boot at the given position.
raises :class:`OleErrorInvalidarg`
Boot @a position out of range.
raises :class:`OleErrorNotimpl`
Booting from USB @a device currently not supported.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
if not isinstance(device, DeviceType):
raise TypeError("device can only be an instance of type DeviceType")
self._call("setBootOrder",
in_p=[position, device])
[docs] def get_boot_order(self, position):
"""Returns the device type that occupies the specified
position in the boot order.
@todo [remove?]
If the machine can have more than one device of the returned type
(such as hard disks), then a separate method should be used to
retrieve the individual device that occupies the given position.
If here are no devices at the given position, then
:py:attr:`DeviceType.null` is returned.
@todo getHardDiskBootOrder(), getNetworkBootOrder()
in position of type int
Position in the boot order (@c 1 to the total number of
devices the machine can boot from, as returned by
:py:func:`ISystemProperties.max_boot_position` ).
return device of type :class:`DeviceType`
Device at the given position.
raises :class:`OleErrorInvalidarg`
Boot @a position out of range.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
device = self._call("getBootOrder",
in_p=[position])
device = DeviceType(device)
return device
[docs] def attach_device(self, name, controller_port, device, type_p, medium):
"""Attaches a device and optionally mounts a medium to the given storage
controller (:py:class:`IStorageController` , identified by @a name),
at the indicated port and device.
This method is intended for managing storage devices in general while a
machine is powered off. It can be used to attach and detach fixed
and removable media. The following kind of media can be attached
to a machine:
For fixed and removable media, you can pass in a medium that was
previously opened using :py:func:`IVirtualBox.open_medium` .
Only for storage devices supporting removable media (such as
DVDs and floppies), you can also specify a null pointer to
indicate an empty drive or one of the medium objects listed
in the :py:func:`IHost.dvd_drives` and :py:func:`IHost.floppy_drives`
arrays to indicate a host drive.
For removable devices, you can also use :py:func:`IMachine.mount_medium`
to change the media while the machine is running.
In a VM's default configuration of virtual machines, the secondary
master of the IDE controller is used for a CD/DVD drive.
After calling this returns successfully, a new instance of
:py:class:`IMediumAttachment` will appear in the machine's list of medium
attachments (see :py:func:`IMachine.medium_attachments` ).
See :py:class:`IMedium` and :py:class:`IMediumAttachment` for more
information about attaching media.
The specified device slot must not have a device attached to it,
or this method will fail.
You cannot attach a device to a newly created machine until
this machine's settings are saved to disk using
:py:func:`save_settings` .
If the medium is being attached indirectly, a new differencing medium
will implicitly be created for it and attached instead. If the
changes made to the machine settings (including this indirect
attachment) are later cancelled using :py:func:`discard_settings` ,
this implicitly created differencing medium will implicitly
be deleted.
in name of type str
Name of the storage controller to attach the device to.
in controller_port of type int
Port to attach the device to. For an IDE controller, 0 specifies
the primary controller and 1 specifies the secondary controller.
For a SCSI controller, this must range from 0 to 15; for a SATA controller,
from 0 to 29; for an SAS controller, from 0 to 7.
in device of type int
Device slot in the given port to attach the device to. This is only
relevant for IDE controllers, for which 0 specifies the master device and
1 specifies the slave device. For all other controller types, this must
be 0.
in type_p of type :class:`DeviceType`
Device type of the attached device. For media opened by
:py:func:`IVirtualBox.open_medium` , this must match the device type
specified there.
in medium of type :class:`IMedium`
Medium to mount or @c null for an empty drive.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range, or
file or UUID not found.
raises :class:`VBoxErrorInvalidObjectState`
Machine must be registered before media can be attached.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
raises :class:`VBoxErrorObjectInUse`
A medium is already attached to this or another virtual machine.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(type_p, DeviceType):
raise TypeError("type_p can only be an instance of type DeviceType")
if not isinstance(medium, IMedium):
raise TypeError("medium can only be an instance of type IMedium")
self._call("attachDevice",
in_p=[name, controller_port, device, type_p, medium])
[docs] def attach_device_without_medium(self, name, controller_port, device, type_p):
"""Attaches a device and optionally mounts a medium to the given storage
controller (:py:class:`IStorageController` , identified by @a name),
at the indicated port and device.
This method is intended for managing storage devices in general while a
machine is powered off. It can be used to attach and detach fixed
and removable media. The following kind of media can be attached
to a machine:
For fixed and removable media, you can pass in a medium that was
previously opened using :py:func:`IVirtualBox.open_medium` .
Only for storage devices supporting removable media (such as
DVDs and floppies) with an empty drive or one of the medium objects listed
in the :py:func:`IHost.dvd_drives` and :py:func:`IHost.floppy_drives`
arrays to indicate a host drive.
For removable devices, you can also use :py:func:`IMachine.mount_medium`
to change the media while the machine is running.
In a VM's default configuration of virtual machines, the secondary
master of the IDE controller is used for a CD/DVD drive.
:py:class:`IMediumAttachment` will appear in the machine's list of medium
attachments (see :py:func:`IMachine.medium_attachments` ).
See :py:class:`IMedium` and :py:class:`IMediumAttachment` for more
information about attaching media.
The specified device slot must not have a device attached to it,
or this method will fail.
You cannot attach a device to a newly created machine until
this machine's settings are saved to disk using
:py:func:`save_settings` .
If the medium is being attached indirectly, a new differencing medium
will implicitly be created for it and attached instead. If the
changes made to the machine settings (including this indirect
attachment) are later cancelled using :py:func:`discard_settings` ,
this implicitly created differencing medium will implicitly
be deleted.
in name of type str
Name of the storage controller to attach the device to.
in controller_port of type int
Port to attach the device to. For an IDE controller, 0 specifies
the primary controller and 1 specifies the secondary controller.
For a SCSI controller, this must range from 0 to 15; for a SATA controller,
from 0 to 29; for an SAS controller, from 0 to 7.
in device of type int
Device slot in the given port to attach the device to. This is only
relevant for IDE controllers, for which 0 specifies the master device and
1 specifies the slave device. For all other controller types, this must
be 0.
in type_p of type :class:`DeviceType`
Device type of the attached device. For media opened by
:py:func:`IVirtualBox.open_medium` , this must match the device type
specified there.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range, or
file or UUID not found.
raises :class:`VBoxErrorInvalidObjectState`
Machine must be registered before media can be attached.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
raises :class:`VBoxErrorObjectInUse`
A medium is already attached to this or another virtual machine.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(type_p, DeviceType):
raise TypeError("type_p can only be an instance of type DeviceType")
self._call("attachDeviceWithoutMedium",
in_p=[name, controller_port, device, type_p])
[docs] def detach_device(self, name, controller_port, device):
"""Detaches the device attached to a device slot of the specified bus.
Detaching the device from the virtual machine is deferred. This means
that the medium remains associated with the machine when this method
returns and gets actually de-associated only after a successful
:py:func:`save_settings` call. See :py:class:`IMedium`
for more detailed information about attaching media.
You cannot detach a device from a running machine.
Detaching differencing media implicitly created by :py:func:`attach_device` for the indirect attachment using this
method will **not** implicitly delete them. The
:py:func:`IMedium.delete_storage` operation should be
explicitly performed by the caller after the medium is successfully
detached and the settings are saved with
:py:func:`save_settings` , if it is the desired action.
in name of type str
Name of the storage controller to detach the medium from.
in controller_port of type int
Port number to detach the medium from.
in device of type int
Device slot number to detach the medium from.
raises :class:`VBoxErrorInvalidVmState`
Attempt to detach medium from a running virtual machine.
raises :class:`VBoxErrorObjectNotFound`
No medium attached to given slot/bus.
raises :class:`VBoxErrorNotSupported`
Medium format does not support storage deletion (only for implicitly
created differencing media, should not happen).
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
self._call("detachDevice",
in_p=[name, controller_port, device])
[docs] def passthrough_device(self, name, controller_port, device, passthrough):
"""Sets the passthrough mode of an existing DVD device. Changing the
setting while the VM is running is forbidden. The setting is only used
if at VM start the device is configured as a host DVD drive, in all
other cases it is ignored. The device must already exist; see
:py:func:`IMachine.attach_device` for how to attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in passthrough of type bool
New value for the passthrough setting.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(passthrough, bool):
raise TypeError("passthrough can only be an instance of type bool")
self._call("passthroughDevice",
in_p=[name, controller_port, device, passthrough])
[docs] def temporary_eject_device(self, name, controller_port, device, temporary_eject):
"""Sets the behavior for guest-triggered medium eject. In some situations
it is desirable that such ejects update the VM configuration, and in
others the eject should keep the VM configuration. The device must
already exist; see :py:func:`IMachine.attach_device` for how to
attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in temporary_eject of type bool
New value for the eject behavior.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(temporary_eject, bool):
raise TypeError("temporary_eject can only be an instance of type bool")
self._call("temporaryEjectDevice",
in_p=[name, controller_port, device, temporary_eject])
[docs] def non_rotational_device(self, name, controller_port, device, non_rotational):
"""Sets a flag in the device information which indicates that the medium
is not based on rotational technology, i.e. that the access times are
more or less independent of the position on the medium. This may or may
not be supported by a particular drive, and is silently ignored in the
latter case. At the moment only hard disks (which is a misnomer in this
context) accept this setting. Changing the setting while the VM is
running is forbidden. The device must already exist; see
:py:func:`IMachine.attach_device` for how to attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in non_rotational of type bool
New value for the non-rotational device flag.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(non_rotational, bool):
raise TypeError("non_rotational can only be an instance of type bool")
self._call("nonRotationalDevice",
in_p=[name, controller_port, device, non_rotational])
[docs] def set_auto_discard_for_device(self, name, controller_port, device, discard):
"""Sets a flag in the device information which indicates that the medium
supports discarding unused blocks (called trimming for SATA or unmap
for SCSI devices) .This may or may not be supported by a particular drive,
and is silently ignored in the latter case. At the moment only hard disks
(which is a misnomer in this context) accept this setting. Changing the
setting while the VM is running is forbidden. The device must already
exist; see :py:func:`IMachine.attach_device` for how to attach a new
device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in discard of type bool
New value for the discard device flag.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, SCSI port out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(discard, bool):
raise TypeError("discard can only be an instance of type bool")
self._call("setAutoDiscardForDevice",
in_p=[name, controller_port, device, discard])
[docs] def set_hot_pluggable_for_device(self, name, controller_port, device, hot_pluggable):
"""Sets a flag in the device information which indicates that the attached
device is hot pluggable or not. This may or may not be supported by a
particular controller and/or drive, and is silently ignored in the
latter case. Changing the setting while the VM is running is forbidden.
The device must already exist; see :py:func:`IMachine.attach_device`
for how to attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in hot_pluggable of type bool
New value for the hot-pluggable device flag.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
raises :class:`VBoxErrorNotSupported`
Controller doesn't support hot plugging.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(hot_pluggable, bool):
raise TypeError("hot_pluggable can only be an instance of type bool")
self._call("setHotPluggableForDevice",
in_p=[name, controller_port, device, hot_pluggable])
[docs] def set_bandwidth_group_for_device(self, name, controller_port, device, bandwidth_group):
"""Sets the bandwidth group of an existing storage device.
The device must already exist; see :py:func:`IMachine.attach_device`
for how to attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
in bandwidth_group of type :class:`IBandwidthGroup`
New value for the bandwidth group or @c null for no group.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(bandwidth_group, IBandwidthGroup):
raise TypeError("bandwidth_group can only be an instance of type IBandwidthGroup")
self._call("setBandwidthGroupForDevice",
in_p=[name, controller_port, device, bandwidth_group])
[docs] def set_no_bandwidth_group_for_device(self, name, controller_port, device):
"""Sets no bandwidth group for an existing storage device.
The device must already exist; see :py:func:`IMachine.attach_device`
for how to attach a new device.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
in name of type str
Name of the storage controller.
in controller_port of type int
Storage controller port.
in device of type int
Device slot in the given port.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to modify an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
self._call("setNoBandwidthGroupForDevice",
in_p=[name, controller_port, device])
[docs] def unmount_medium(self, name, controller_port, device, force):
"""Unmounts any currently mounted medium (:py:class:`IMedium` ,
identified by the given UUID @a id) to the given storage controller
(:py:class:`IStorageController` , identified by @a name),
at the indicated port and device. The device must already exist;
This method is intended only for managing removable media, where the
device is fixed but media is changeable at runtime (such as DVDs
and floppies). It cannot be used for fixed media such as hard disks.
The @a controllerPort and @a device parameters specify the device slot
and have have the same meaning as with
:py:func:`IMachine.attach_device` .
The specified device slot must have a medium mounted, which will be
unmounted. If there is no mounted medium it will do nothing.
See :py:class:`IMedium` for more detailed information about
attaching/unmounting media.
in name of type str
Name of the storage controller to unmount the medium from.
in controller_port of type int
Port to unmount the medium from.
in device of type int
Device slot in the given port to unmount the medium from.
in force of type bool
Allows to force unmount of a medium which is locked by
the device slot in the given port medium is attached to.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to unmount medium that is not removable - not DVD or floppy.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
raises :class:`VBoxErrorObjectInUse`
Medium already attached to this or another virtual machine.
raises :class:`VBoxErrorObjectNotFound`
Medium not attached to specified port, device, controller.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(force, bool):
raise TypeError("force can only be an instance of type bool")
self._call("unmountMedium",
in_p=[name, controller_port, device, force])
[docs] def mount_medium(self, name, controller_port, device, medium, force):
"""Mounts a medium (:py:class:`IMedium` , identified
by the given UUID @a id) to the given storage controller
(:py:class:`IStorageController` , identified by @a name),
at the indicated port and device. The device must already exist;
see :py:func:`IMachine.attach_device` for how to attach a new device.
This method is intended only for managing removable media, where the
device is fixed but media is changeable at runtime (such as DVDs
and floppies). It cannot be used for fixed media such as hard disks.
The @a controllerPort and @a device parameters specify the device slot and
have have the same meaning as with :py:func:`IMachine.attach_device` .
The specified device slot can have a medium mounted, which will be
unmounted first. Specifying a zero UUID (or an empty string) for
@a medium does just an unmount.
See :py:class:`IMedium` for more detailed information about
attaching media.
in name of type str
Name of the storage controller to attach the medium to.
in controller_port of type int
Port to attach the medium to.
in device of type int
Device slot in the given port to attach the medium to.
in medium of type :class:`IMedium`
Medium to mount or @c null for an empty drive.
in force of type bool
Allows to force unmount/mount of a medium which is locked by
the device slot in the given port to attach the medium to.
raises :class:`OleErrorInvalidarg`
SATA device, SATA port, IDE port or IDE slot out of range.
raises :class:`VBoxErrorInvalidObjectState`
Attempt to attach medium to an unregistered virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Invalid machine state.
raises :class:`VBoxErrorObjectInUse`
Medium already attached to this or another virtual machine.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
if not isinstance(medium, IMedium):
raise TypeError("medium can only be an instance of type IMedium")
if not isinstance(force, bool):
raise TypeError("force can only be an instance of type bool")
self._call("mountMedium",
in_p=[name, controller_port, device, medium, force])
[docs] def get_medium(self, name, controller_port, device):
"""Returns the virtual medium attached to a device slot of the specified
bus.
Note that if the medium was indirectly attached by
:py:func:`mount_medium` to the given device slot then this
method will return not the same object as passed to the
:py:func:`mount_medium` call. See :py:class:`IMedium` for
more detailed information about mounting a medium.
in name of type str
Name of the storage controller the medium is attached to.
in controller_port of type int
Port to query.
in device of type int
Device slot in the given port to query.
return medium of type :class:`IMedium`
Attached medium object.
raises :class:`VBoxErrorObjectNotFound`
No medium attached to given slot/bus.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
medium = self._call("getMedium",
in_p=[name, controller_port, device])
medium = IMedium(medium)
return medium
[docs] def get_medium_attachments_of_controller(self, name):
"""Returns an array of medium attachments which are attached to the
the controller with the given name.
in name of type str
return medium_attachments of type :class:`IMediumAttachment`
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given name doesn't exist.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
medium_attachments = self._call("getMediumAttachmentsOfController",
in_p=[name])
medium_attachments = [IMediumAttachment(a) for a in medium_attachments]
return medium_attachments
[docs] def get_medium_attachment(self, name, controller_port, device):
"""Returns a medium attachment which corresponds to the controller with
the given name, on the given port and device slot.
in name of type str
in controller_port of type int
in device of type int
return attachment of type :class:`IMediumAttachment`
raises :class:`VBoxErrorObjectNotFound`
No attachment exists for the given controller/port/device combination.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(controller_port, baseinteger):
raise TypeError("controller_port can only be an instance of type baseinteger")
if not isinstance(device, baseinteger):
raise TypeError("device can only be an instance of type baseinteger")
attachment = self._call("getMediumAttachment",
in_p=[name, controller_port, device])
attachment = IMediumAttachment(attachment)
return attachment
[docs] def attach_host_pci_device(self, host_address, desired_guest_address, try_to_unbind):
"""Attaches host PCI device with the given (host) PCI address to the
PCI bus of the virtual machine. Please note, that this operation
is two phase, as real attachment will happen when VM will start,
and most information will be delivered as IHostPCIDevicePlugEvent
on IVirtualBox event source.
:py:class:`IHostPCIDevicePlugEvent`
in host_address of type int
Address of the host PCI device.
in desired_guest_address of type int
Desired position of this device on guest PCI bus.
in try_to_unbind of type bool
If VMM shall try to unbind existing drivers from the
device before attaching it to the guest.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state is not stopped (PCI hotplug not yet implemented).
raises :class:`VBoxErrorPdmError`
Virtual machine does not have a PCI controller allowing attachment of physical devices.
raises :class:`VBoxErrorNotSupported`
Hardware or host OS doesn't allow PCI device passthrough.
"""
if not isinstance(host_address, baseinteger):
raise TypeError("host_address can only be an instance of type baseinteger")
if not isinstance(desired_guest_address, baseinteger):
raise TypeError("desired_guest_address can only be an instance of type baseinteger")
if not isinstance(try_to_unbind, bool):
raise TypeError("try_to_unbind can only be an instance of type bool")
self._call("attachHostPCIDevice",
in_p=[host_address, desired_guest_address, try_to_unbind])
[docs] def detach_host_pci_device(self, host_address):
"""Detach host PCI device from the virtual machine.
Also HostPCIDevicePlugEvent on IVirtualBox event source
will be delivered. As currently we don't support hot device
unplug, IHostPCIDevicePlugEvent event is delivered immediately.
:py:class:`IHostPCIDevicePlugEvent`
in host_address of type int
Address of the host PCI device.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state is not stopped (PCI hotplug not yet implemented).
raises :class:`VBoxErrorObjectNotFound`
This host device is not attached to this machine.
raises :class:`VBoxErrorPdmError`
Virtual machine does not have a PCI controller allowing attachment of physical devices.
raises :class:`VBoxErrorNotSupported`
Hardware or host OS doesn't allow PCI device passthrough.
"""
if not isinstance(host_address, baseinteger):
raise TypeError("host_address can only be an instance of type baseinteger")
self._call("detachHostPCIDevice",
in_p=[host_address])
[docs] def get_network_adapter(self, slot):
"""Returns the network adapter associated with the given slot.
Slots are numbered sequentially, starting with zero. The total
number of adapters per machine is defined by the
:py:func:`ISystemProperties.get_max_network_adapters` property,
so the maximum slot number is one less than that property's value.
in slot of type int
return adapter of type :class:`INetworkAdapter`
raises :class:`OleErrorInvalidarg`
Invalid @a slot number.
"""
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
adapter = self._call("getNetworkAdapter",
in_p=[slot])
adapter = INetworkAdapter(adapter)
return adapter
[docs] def add_storage_controller(self, name, connection_type):
"""Adds a new storage controller (SCSI, SAS or SATA controller) to the
machine and returns it as an instance of
:py:class:`IStorageController` .
@a name identifies the controller for subsequent calls such as
:py:func:`get_storage_controller_by_name` ,
:py:func:`get_storage_controller_by_instance` ,
:py:func:`remove_storage_controller` ,
:py:func:`attach_device` or :py:func:`mount_medium` .
After the controller has been added, you can set its exact
type by setting the :py:func:`IStorageController.controller_type` .
in name of type str
in connection_type of type :class:`StorageBus`
return controller of type :class:`IStorageController`
raises :class:`VBoxErrorObjectInUse`
A storage controller with given name exists already.
raises :class:`OleErrorInvalidarg`
Invalid @a controllerType.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(connection_type, StorageBus):
raise TypeError("connection_type can only be an instance of type StorageBus")
controller = self._call("addStorageController",
in_p=[name, connection_type])
controller = IStorageController(controller)
return controller
[docs] def get_storage_controller_by_name(self, name):
"""Returns a storage controller with the given name.
in name of type str
return storage_controller of type :class:`IStorageController`
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given name doesn't exist.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
storage_controller = self._call("getStorageControllerByName",
in_p=[name])
storage_controller = IStorageController(storage_controller)
return storage_controller
[docs] def get_storage_controller_by_instance(self, connection_type, instance):
"""Returns a storage controller of a specific storage bus
with the given instance number.
in connection_type of type :class:`StorageBus`
in instance of type int
return storage_controller of type :class:`IStorageController`
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given instance number doesn't exist.
"""
if not isinstance(connection_type, StorageBus):
raise TypeError("connection_type can only be an instance of type StorageBus")
if not isinstance(instance, baseinteger):
raise TypeError("instance can only be an instance of type baseinteger")
storage_controller = self._call("getStorageControllerByInstance",
in_p=[connection_type, instance])
storage_controller = IStorageController(storage_controller)
return storage_controller
[docs] def remove_storage_controller(self, name):
"""Removes a storage controller from the machine with all devices attached to it.
in name of type str
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given name doesn't exist.
raises :class:`VBoxErrorNotSupported`
Medium format does not support storage deletion (only for implicitly
created differencing media, should not happen).
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeStorageController",
in_p=[name])
[docs] def set_storage_controller_bootable(self, name, bootable):
"""Sets the bootable flag of the storage controller with the given name.
in name of type str
in bootable of type bool
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given name doesn't exist.
raises :class:`VBoxErrorObjectInUse`
Another storage controller is marked as bootable already.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(bootable, bool):
raise TypeError("bootable can only be an instance of type bool")
self._call("setStorageControllerBootable",
in_p=[name, bootable])
[docs] def add_usb_controller(self, name, type_p):
"""Adds a new USB controller to the machine and returns it as an instance of
:py:class:`IUSBController` .
in name of type str
in type_p of type :class:`USBControllerType`
return controller of type :class:`IUSBController`
raises :class:`VBoxErrorObjectInUse`
A USB controller with given type exists already.
raises :class:`OleErrorInvalidarg`
Invalid @a controllerType.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
controller = self._call("addUSBController",
in_p=[name, type_p])
controller = IUSBController(controller)
return controller
[docs] def remove_usb_controller(self, name):
"""Removes a USB controller from the machine.
in name of type str
raises :class:`VBoxErrorObjectNotFound`
A USB controller with given type doesn't exist.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeUSBController",
in_p=[name])
[docs] def get_usb_controller_by_name(self, name):
"""Returns a USB controller with the given type.
in name of type str
return controller of type :class:`IUSBController`
raises :class:`VBoxErrorObjectNotFound`
A USB controller with given name doesn't exist.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
controller = self._call("getUSBControllerByName",
in_p=[name])
controller = IUSBController(controller)
return controller
[docs] def get_usb_controller_count_by_type(self, type_p):
"""Returns the number of USB controllers of the given type attached to the VM.
in type_p of type :class:`USBControllerType`
return controllers of type int
"""
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
controllers = self._call("getUSBControllerCountByType",
in_p=[type_p])
return controllers
[docs] def get_serial_port(self, slot):
"""Returns the serial port associated with the given slot.
Slots are numbered sequentially, starting with zero. The total
number of serial ports per machine is defined by the
:py:func:`ISystemProperties.serial_port_count` property,
so the maximum slot number is one less than that property's value.
in slot of type int
return port of type :class:`ISerialPort`
raises :class:`OleErrorInvalidarg`
Invalid @a slot number.
"""
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
port = self._call("getSerialPort",
in_p=[slot])
port = ISerialPort(port)
return port
[docs] def get_parallel_port(self, slot):
"""Returns the parallel port associated with the given slot.
Slots are numbered sequentially, starting with zero. The total
number of parallel ports per machine is defined by the
:py:func:`ISystemProperties.parallel_port_count` property,
so the maximum slot number is one less than that property's value.
in slot of type int
return port of type :class:`IParallelPort`
raises :class:`OleErrorInvalidarg`
Invalid @a slot number.
"""
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
port = self._call("getParallelPort",
in_p=[slot])
port = IParallelPort(port)
return port
[docs] def get_cpu_property(self, property_p):
"""Returns the virtual CPU boolean value of the specified property.
in property_p of type :class:`CPUPropertyType`
Property type to query.
return value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property.
"""
if not isinstance(property_p, CPUPropertyType):
raise TypeError("property_p can only be an instance of type CPUPropertyType")
value = self._call("getCPUProperty",
in_p=[property_p])
return value
[docs] def set_cpu_property(self, property_p, value):
"""Sets the virtual CPU boolean value of the specified property.
in property_p of type :class:`CPUPropertyType`
Property type to query.
in value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property.
"""
if not isinstance(property_p, CPUPropertyType):
raise TypeError("property_p can only be an instance of type CPUPropertyType")
if not isinstance(value, bool):
raise TypeError("value can only be an instance of type bool")
self._call("setCPUProperty",
in_p=[property_p, value])
[docs] def get_cpuid_leaf(self, id_p):
"""Returns the virtual CPU cpuid information for the specified leaf.
Currently supported index values for cpuid:
Standard CPUID leafs: 0 - 0xA
Extended CPUID leafs: 0x80000000 - 0x8000000A
See the Intel and AMD programmer's manuals for detailed information
about the cpuid instruction and its leafs.
in id_p of type int
CPUID leaf index.
out val_eax of type int
CPUID leaf value for register eax.
out val_ebx of type int
CPUID leaf value for register ebx.
out val_ecx of type int
CPUID leaf value for register ecx.
out val_edx of type int
CPUID leaf value for register edx.
raises :class:`OleErrorInvalidarg`
Invalid id.
"""
if not isinstance(id_p, baseinteger):
raise TypeError("id_p can only be an instance of type baseinteger")
(val_eax, val_ebx, val_ecx, val_edx) = self._call("getCPUIDLeaf",
in_p=[id_p])
return (val_eax, val_ebx, val_ecx, val_edx)
[docs] def set_cpuid_leaf(self, id_p, val_eax, val_ebx, val_ecx, val_edx):
"""Sets the virtual CPU cpuid information for the specified leaf. Note that these values
are not passed unmodified. VirtualBox clears features that it doesn't support.
Currently supported index values for cpuid:
Standard CPUID leafs: 0 - 0xA
Extended CPUID leafs: 0x80000000 - 0x8000000A
See the Intel and AMD programmer's manuals for detailed information
about the cpuid instruction and its leafs.
Do not use this method unless you know exactly what you're doing. Misuse can lead to
random crashes inside VMs.
in id_p of type int
CPUID leaf index.
in val_eax of type int
CPUID leaf value for register eax.
in val_ebx of type int
CPUID leaf value for register ebx.
in val_ecx of type int
CPUID leaf value for register ecx.
in val_edx of type int
CPUID leaf value for register edx.
raises :class:`OleErrorInvalidarg`
Invalid id.
"""
if not isinstance(id_p, baseinteger):
raise TypeError("id_p can only be an instance of type baseinteger")
if not isinstance(val_eax, baseinteger):
raise TypeError("val_eax can only be an instance of type baseinteger")
if not isinstance(val_ebx, baseinteger):
raise TypeError("val_ebx can only be an instance of type baseinteger")
if not isinstance(val_ecx, baseinteger):
raise TypeError("val_ecx can only be an instance of type baseinteger")
if not isinstance(val_edx, baseinteger):
raise TypeError("val_edx can only be an instance of type baseinteger")
self._call("setCPUIDLeaf",
in_p=[id_p, val_eax, val_ebx, val_ecx, val_edx])
[docs] def remove_cpuid_leaf(self, id_p):
"""Removes the virtual CPU cpuid leaf for the specified index
in id_p of type int
CPUID leaf index.
raises :class:`OleErrorInvalidarg`
Invalid id.
"""
if not isinstance(id_p, baseinteger):
raise TypeError("id_p can only be an instance of type baseinteger")
self._call("removeCPUIDLeaf",
in_p=[id_p])
[docs] def remove_all_cpuid_leaves(self):
"""Removes all the virtual CPU cpuid leaves
"""
self._call("removeAllCPUIDLeaves")
[docs] def get_hw_virt_ex_property(self, property_p):
"""Returns the value of the specified hardware virtualization boolean property.
in property_p of type :class:`HWVirtExPropertyType`
Property type to query.
return value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property.
"""
if not isinstance(property_p, HWVirtExPropertyType):
raise TypeError("property_p can only be an instance of type HWVirtExPropertyType")
value = self._call("getHWVirtExProperty",
in_p=[property_p])
return value
[docs] def set_hw_virt_ex_property(self, property_p, value):
"""Sets a new value for the specified hardware virtualization boolean property.
in property_p of type :class:`HWVirtExPropertyType`
Property type to set.
in value of type bool
New property value.
raises :class:`OleErrorInvalidarg`
Invalid property.
"""
if not isinstance(property_p, HWVirtExPropertyType):
raise TypeError("property_p can only be an instance of type HWVirtExPropertyType")
if not isinstance(value, bool):
raise TypeError("value can only be an instance of type bool")
self._call("setHWVirtExProperty",
in_p=[property_p, value])
[docs] def set_settings_file_path(self, settings_file_path):
"""Currently, it is an error to change this property on any machine.
Later this will allow setting a new path for the settings file, with
automatic relocation of all files (including snapshots and disk images)
which are inside the base directory. This operation is only allowed
when there are no pending unsaved settings.
Setting this property to @c null or to an empty string is forbidden.
When setting this property, the specified path must be absolute.
The specified path may not exist, it will be created when necessary.
in settings_file_path of type str
New settings file path, will be used to determine the new
location for the attached media if it is in the same directory or
below as the original settings file.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorNotimpl`
The operation is not implemented yet.
"""
if not isinstance(settings_file_path, basestring):
raise TypeError("settings_file_path can only be an instance of type basestring")
progress = self._call("setSettingsFilePath",
in_p=[settings_file_path])
progress = IProgress(progress)
return progress
[docs] def save_settings(self):
"""Saves any changes to machine settings made since the session
has been opened or a new machine has been created, or since the
last call to :py:func:`save_settings` or :py:func:`discard_settings` .
For registered machines, new settings become visible to all
other VirtualBox clients after successful invocation of this
method.
The method sends :py:class:`IMachineDataChangedEvent`
notification event after the configuration has been successfully
saved (only for registered machines).
Calling this method is only valid on instances returned
by :py:func:`ISession.machine` and on new machines
created by :py:func:`IVirtualBox.create_machine` but not
yet registered, or on unregistered machines after calling
:py:func:`IMachine.unregister` .
raises :class:`VBoxErrorFileError`
Settings file not accessible.
raises :class:`VBoxErrorXmlError`
Could not parse the settings file.
raises :class:`OleErrorAccessdenied`
Modification request refused.
"""
self._call("saveSettings")
[docs] def discard_settings(self):
"""Discards any changes to the machine settings made since the session
has been opened or since the last call to :py:func:`save_settings`
or :py:func:`discard_settings` .
Calling this method is only valid on instances returned
by :py:func:`ISession.machine` and on new machines
created by :py:func:`IVirtualBox.create_machine` or
opened by :py:func:`IVirtualBox.open_machine` but not
yet registered, or on unregistered machines after calling
:py:func:`IMachine.unregister` .
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable.
"""
self._call("discardSettings")
[docs] def unregister(self, cleanup_mode):
"""Unregisters a machine previously registered with
:py:func:`IVirtualBox.register_machine` and optionally do additional
cleanup before the machine is unregistered.
This method does not delete any files. It only changes the machine configuration and
the list of registered machines in the VirtualBox object. To delete the files which
belonged to the machine, including the XML file of the machine itself, call
:py:func:`delete_config` , optionally with the array of IMedium objects which was returned
from this method.
How thoroughly this method cleans up the machine configuration before unregistering
the machine depends on the @a cleanupMode argument.
With "UnregisterOnly", the machine will only be unregistered, but no additional
cleanup will be performed. The call will fail if the machine is in "Saved" state
or has any snapshots or any media attached (see :py:class:`IMediumAttachment` ).
It is the responsibility of the caller to delete all such configuration in this mode.
In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
which it replaces.
With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
state or if it has snapshots or media attached. All media attached to the current machine
state or in snapshots will be detached. No medium objects will be returned;
all of the machine's media will remain open.
With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
except that all the hard disk medium objects which were detached from the machine will
be returned as an array. This allows for quickly passing them to the :py:func:`delete_config`
API for closing and deletion.
With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
that all media will be returned in the array, including removable media like DVDs and
floppies. This might be useful if the user wants to inspect in detail which media were
attached to the machine. Be careful when passing the media array to :py:func:`delete_config`
in that case because users will typically want to preserve ISO and RAW image files.
A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
resulting IMedium array to :py:func:`delete_config` . This way, the machine is completely
deleted with all its saved states and hard disk images, but images for removable
drives (such as ISO and RAW files) will remain on disk.
This API does not verify whether the media files returned in the array are still
attached to other machines (i.e. shared between several machines). If such a shared
image is passed to :py:func:`delete_config` however, closing the image will fail there
and the image will be silently skipped.
This API may, however, move media from this machine's media registry to other media
registries (see :py:class:`IMedium` for details on media registries). For machines
created with VirtualBox 4.0 or later, if media from this machine's media registry
are also attached to another machine (shared attachments), each such medium will be
moved to another machine's registry. This is because without this machine's media
registry, the other machine cannot find its media any more and would become inaccessible.
This API implicitly calls :py:func:`save_settings` to save all current machine settings
before unregistering it. It may also silently call :py:func:`save_settings` on other machines
if media are moved to other machines' media registries.
After successful method invocation, the :py:class:`IMachineRegisteredEvent` event
is fired.
The call will fail if the machine is currently locked (see :py:class:`ISession` ).
If the given machine is inaccessible (see :py:func:`accessible` ), it
will be unregistered and fully uninitialized right afterwards. As a result,
the returned machine object will be unusable and an attempt to call
**any** method will return the "Object not ready" error.
in cleanup_mode of type :class:`CleanupMode`
How to clean up after the machine has been unregistered.
return media of type :class:`IMedium`
List of media detached from the machine, depending on the @a cleanupMode parameter.
raises :class:`VBoxErrorInvalidObjectState`
Machine is currently locked for a session.
"""
if not isinstance(cleanup_mode, CleanupMode):
raise TypeError("cleanup_mode can only be an instance of type CleanupMode")
media = self._call("unregister",
in_p=[cleanup_mode])
media = [IMedium(a) for a in media]
return media
[docs] def delete_config(self, media):
"""Deletes the files associated with this machine from disk. If medium objects are passed
in with the @a aMedia argument, they are closed and, if closing was successful, their
storage files are deleted as well. For convenience, this array of media files can be
the same as the one returned from a previous :py:func:`unregister` call.
This method must only be called on machines which are either write-locked (i.e. on instances
returned by :py:func:`ISession.machine` ) or on unregistered machines (i.e. not yet
registered machines created by :py:func:`IVirtualBox.create_machine` or opened by
:py:func:`IVirtualBox.open_machine` , or after having called :py:func:`unregister` ).
The following files will be deleted by this method:
If :py:func:`unregister` had been previously called with a @a cleanupMode
argument other than "UnregisterOnly", this will delete all saved state files that
the machine had in use; possibly one if the machine was in "Saved" state and one
for each online snapshot that the machine had.
On each medium object passed in the @a aMedia array, this will call
:py:func:`IMedium.close` . If that succeeds, this will attempt to delete the
medium's storage on disk. Since the :py:func:`IMedium.close` call will fail if the medium is still
in use, e.g. because it is still attached to a second machine; in that case the
storage will not be deleted.
Finally, the machine's own XML file will be deleted.
Since deleting large disk image files can be a time-consuming I/O operation, this
method operates asynchronously and returns an IProgress object to allow the caller
to monitor the progress. There will be one sub-operation for each file that is
being deleted (saved state or medium storage file).
:py:func:`settings_modified` will return @c true after this
method successfully returns.
in media of type :class:`IMedium`
List of media to be closed and whose storage files will be deleted.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Machine is registered but not write-locked.
raises :class:`VBoxErrorIprtError`
Could not delete the settings file.
"""
if not isinstance(media, list):
raise TypeError("media can only be an instance of type list")
for a in media[:10]:
if not isinstance(a, IMedium):
raise TypeError(\
"array can only contain objects of type IMedium")
progress = self._call("deleteConfig",
in_p=[media])
progress = IProgress(progress)
return progress
def export_to(self, appliance, location):
"""Exports the machine to an OVF appliance. See :py:class:`IAppliance` for the
steps required to export VirtualBox machines to OVF.
in appliance of type :class:`IAppliance`
Appliance to export this machine to.
in location of type str
The target location.
return description of type :class:`IVirtualSystemDescription`
VirtualSystemDescription object which is created for this machine.
"""
if not isinstance(appliance, IAppliance):
raise TypeError("appliance can only be an instance of type IAppliance")
if not isinstance(location, basestring):
raise TypeError("location can only be an instance of type basestring")
description = self._call("exportTo",
in_p=[appliance, location])
description = IVirtualSystemDescription(description)
return description
[docs] def find_snapshot(self, name_or_id):
"""Returns a snapshot of this machine with the given name or UUID.
Returns a snapshot of this machine with the given UUID.
A @c null argument can be used to obtain the first snapshot
taken on this machine. To traverse the whole tree of snapshots
starting from the root, inspect the root snapshot's
:py:func:`ISnapshot.children` attribute and recurse over those children.
in name_or_id of type str
What to search for. Name or UUID of the snapshot to find
return snapshot of type :class:`ISnapshot`
Snapshot object with the given name.
raises :class:`VBoxErrorObjectNotFound`
Virtual machine has no snapshots or snapshot not found.
"""
if not isinstance(name_or_id, basestring):
raise TypeError("name_or_id can only be an instance of type basestring")
snapshot = self._call("findSnapshot",
in_p=[name_or_id])
snapshot = ISnapshot(snapshot)
return snapshot
[docs] def create_shared_folder(self, name, host_path, writable, automount):
"""Creates a new permanent 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
:py:class:`ISharedFolder` to read more about logical names.
in name of type str
Unique logical name of the shared folder.
in host_path of type str
Full path to the shared folder in the host file system.
in writable of type bool
Whether the share is writable or read-only.
in automount of type bool
Whether the share gets automatically mounted by the guest
or not.
raises :class:`VBoxErrorObjectInUse`
Shared folder already exists.
raises :class:`VBoxErrorFileError`
Shared folder @a hostPath not accessible.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(host_path, basestring):
raise TypeError("host_path can only be an instance of type basestring")
if not isinstance(writable, bool):
raise TypeError("writable can only be an instance of type bool")
if not isinstance(automount, bool):
raise TypeError("automount can only be an instance of type bool")
self._call("createSharedFolder",
in_p=[name, host_path, writable, automount])
[docs] def remove_shared_folder(self, name):
"""Removes the permanent shared folder with the given name previously
created by :py:func:`create_shared_folder` from the collection of
shared folders and stops sharing it.
in name of type str
Logical name of the shared folder to remove.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable.
raises :class:`VBoxErrorObjectNotFound`
Shared folder @a name does not exist.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeSharedFolder",
in_p=[name])
[docs] def can_show_console_window(self):
"""Returns @c true if the VM console process can activate the
console window and bring it to foreground on the desktop of
the host PC.
This method will fail if a session for this machine is not
currently open.
return can_show of type bool
@c true if the console window can be shown and @c false otherwise.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
can_show = self._call("canShowConsoleWindow")
return can_show
[docs] def show_console_window(self):
"""Activates the console window and brings it to foreground on
the desktop of the host PC. Many modern window managers on
many platforms implement some sort of focus stealing
prevention logic, so that it may be impossible to activate
a window without the help of the currently active
application. In this case, this method will return a non-zero
identifier that represents the top-level window of the VM
console process. The caller, if it represents a currently
active process, is responsible to use this identifier (in a
platform-dependent manner) to perform actual window
activation.
This method will fail if a session for this machine is not
currently open.
return win_id of type int
Platform-dependent identifier of the top-level VM console
window, or zero if this method has performed all actions
necessary to implement the *show window* semantics for
the given platform and/or VirtualBox front-end.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
win_id = self._call("showConsoleWindow")
return win_id
[docs] def get_guest_property(self, name):
"""Reads an entry from the machine's guest property store.
in name of type str
The name of the property to read.
out value of type str
The value of the property. If the property does not exist then this
will be empty.
out timestamp of type int
The time at which the property was last modified, as seen by the
server process.
out flags of type str
Additional property parameters, passed as a comma-separated list of
"name=value" type entries.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
(value, timestamp, flags) = self._call("getGuestProperty",
in_p=[name])
return (value, timestamp, flags)
[docs] def get_guest_property_value(self, property_p):
"""Reads a value from the machine's guest property store.
in property_p of type str
The name of the property to read.
return value of type str
The value of the property. If the property does not exist then this
will be empty.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
value = self._call("getGuestPropertyValue",
in_p=[property_p])
return value
[docs] def get_guest_property_timestamp(self, property_p):
"""Reads a property timestamp from the machine's guest property store.
in property_p of type str
The name of the property to read.
return value of type int
The timestamp. If the property does not exist then this will be
empty.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
value = self._call("getGuestPropertyTimestamp",
in_p=[property_p])
return value
[docs] def set_guest_property(self, property_p, value, flags):
"""Sets, changes or deletes an entry in the machine's guest property
store.
in property_p of type str
The name of the property to set, change or delete.
in value of type str
The new value of the property to set, change or delete. If the
property does not yet exist and value is non-empty, it will be
created. If the value is @c null or empty, the property will be
deleted if it exists.
in flags of type str
Additional property parameters, passed as a comma-separated list of
"name=value" type entries.
raises :class:`OleErrorAccessdenied`
Property cannot be changed.
raises :class:`OleErrorInvalidarg`
Invalid @a flags.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable or session not open.
raises :class:`VBoxErrorInvalidObjectState`
Cannot set transient property when machine not running.
"""
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
self._call("setGuestProperty",
in_p=[property_p, value, flags])
[docs] def set_guest_property_value(self, property_p, value):
"""Sets or changes a value in the machine's guest property
store. The flags field will be left unchanged or created empty for a
new property.
in property_p of type str
The name of the property to set or change.
in value of type str
The new value of the property to set or change. If the
property does not yet exist and value is non-empty, it will be
created.
raises :class:`OleErrorAccessdenied`
Property cannot be changed.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable or session not open.
raises :class:`VBoxErrorInvalidObjectState`
Cannot set transient property when machine not running.
"""
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setGuestPropertyValue",
in_p=[property_p, value])
[docs] def delete_guest_property(self, name):
"""Deletes an entry from the machine's guest property store.
in name of type str
The name of the property to delete.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("deleteGuestProperty",
in_p=[name])
[docs] def enumerate_guest_properties(self, patterns):
"""Return a list of the guest properties matching a set of patterns along
with their values, time stamps and flags.
in patterns of type str
The patterns to match the properties against, separated by '|'
characters. If this is empty or @c null, all properties will match.
out names of type str
The names of the properties returned.
out values of type str
The values of the properties returned. The array entries match the
corresponding entries in the @a name array.
out timestamps of type int
The time stamps of the properties returned. The array entries match
the corresponding entries in the @a name array.
out flags of type str
The flags of the properties returned. The array entries match the
corresponding entries in the @a name array.
"""
if not isinstance(patterns, basestring):
raise TypeError("patterns can only be an instance of type basestring")
(names, values, timestamps, flags) = self._call("enumerateGuestProperties",
in_p=[patterns])
return (names, values, timestamps, flags)
[docs] def query_saved_guest_screen_info(self, screen_id):
"""Returns the guest dimensions from the saved state.
in screen_id of type int
Saved guest screen to query info from.
out origin_x of type int
The X position of the guest monitor top left corner.
out origin_y of type int
The Y position of the guest monitor top left corner.
out width of type int
Guest width at the time of the saved state was taken.
out height of type int
Guest height at the time of the saved state was taken.
out enabled of type bool
Whether the monitor is enabled in the guest.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(origin_x, origin_y, width, height, enabled) = self._call("querySavedGuestScreenInfo",
in_p=[screen_id])
return (origin_x, origin_y, width, height, enabled)
[docs] def read_saved_thumbnail_to_array(self, screen_id, bitmap_format):
"""Thumbnail is retrieved to an array of bytes in the requested format.
in screen_id of type int
Saved guest screen to read from.
in bitmap_format of type :class:`BitmapFormat`
The requested format.
out width of type int
Bitmap width.
out height of type int
Bitmap height.
return data of type str
Array with resulting bitmap data.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(bitmap_format, BitmapFormat):
raise TypeError("bitmap_format can only be an instance of type BitmapFormat")
(data, width, height) = self._call("readSavedThumbnailToArray",
in_p=[screen_id, bitmap_format])
return (data, width, height)
[docs] def query_saved_screenshot_info(self, screen_id):
"""Returns available formats and size of the screenshot from saved state.
in screen_id of type int
Saved guest screen to query info from.
out width of type int
Image width.
out height of type int
Image height.
return bitmap_formats of type :class:`BitmapFormat`
Formats supported by readSavedScreenshotToArray.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(bitmap_formats, width, height) = self._call("querySavedScreenshotInfo",
in_p=[screen_id])
bitmap_formats = [BitmapFormat(a) for a in bitmap_formats]
return (bitmap_formats, width, height)
[docs] def read_saved_screenshot_to_array(self, screen_id, bitmap_format):
"""Screenshot in requested format is retrieved to an array of bytes.
in screen_id of type int
Saved guest screen to read from.
in bitmap_format of type :class:`BitmapFormat`
The requested format.
out width of type int
Image width.
out height of type int
Image height.
return data of type str
Array with resulting image data.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(bitmap_format, BitmapFormat):
raise TypeError("bitmap_format can only be an instance of type BitmapFormat")
(data, width, height) = self._call("readSavedScreenshotToArray",
in_p=[screen_id, bitmap_format])
return (data, width, height)
[docs] def hot_plug_cpu(self, cpu):
"""Plugs a CPU into the machine.
in cpu of type int
The CPU id to insert.
"""
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
self._call("hotPlugCPU",
in_p=[cpu])
[docs] def hot_unplug_cpu(self, cpu):
"""Removes a CPU from the machine.
in cpu of type int
The CPU id to remove.
"""
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
self._call("hotUnplugCPU",
in_p=[cpu])
[docs] def get_cpu_status(self, cpu):
"""Returns the current status of the given CPU.
in cpu of type int
The CPU id to check for.
return attached of type bool
Status of the CPU.
"""
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
attached = self._call("getCPUStatus",
in_p=[cpu])
return attached
[docs] def get_effective_paravirt_provider(self):
"""Returns the effective paravirtualization provider for this VM.
return paravirt_provider of type :class:`ParavirtProvider`
The effective paravirtualization provider for this VM.
"""
paravirt_provider = self._call("getEffectiveParavirtProvider")
paravirt_provider = ParavirtProvider(paravirt_provider)
return paravirt_provider
[docs] def query_log_filename(self, idx):
"""Queries for the VM log file name of an given index. Returns an empty
string if a log file with that index doesn't exists.
in idx of type int
Which log file name to query. 0=current log file.
return filename of type str
On return the full path to the log file or an empty string on error.
"""
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
filename = self._call("queryLogFilename",
in_p=[idx])
return filename
[docs] def read_log(self, idx, offset, size):
"""Reads the VM log file. The chunk size is limited, so even if you
ask for a big piece there might be less data returned.
in idx of type int
Which log file to read. 0=current log file.
in offset of type int
Offset in the log file.
in size of type int
Chunk size to read in the log file.
return data of type str
Data read from the log file. A data size of 0 means end of file
if the requested chunk size was not 0. This is the unprocessed
file data, i.e. the line ending style depends on the platform of
the system the server is running on.
"""
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
data = self._call("readLog",
in_p=[idx, offset, size])
return data
[docs] def clone_to(self, target, mode, options):
"""Creates a clone of this machine, either as a full clone (which means
creating independent copies of the hard disk media, save states and so
on), or as a linked clone (which uses its own differencing media,
sharing the parent media with the source machine).
The target machine object must have been created previously with :py:func:`IVirtualBox.create_machine` , and all the settings will be
transferred except the VM name and the hardware UUID. You can set the
VM name and the new hardware UUID when creating the target machine. The
network MAC addresses are newly created for all enabled network
adapters. You can change that behaviour with the options parameter.
The operation is performed asynchronously, so the machine object will
be not be usable until the @a progress object signals completion.
in target of type :class:`IMachine`
Target machine object.
in mode of type :class:`CloneMode`
Which states should be cloned.
in options of type :class:`CloneOptions`
Options for the cloning operation.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorInvalidarg`
@a target is @c null.
"""
if not isinstance(target, IMachine):
raise TypeError("target can only be an instance of type IMachine")
if not isinstance(mode, CloneMode):
raise TypeError("mode can only be an instance of type CloneMode")
if not isinstance(options, list):
raise TypeError("options can only be an instance of type list")
for a in options[:10]:
if not isinstance(a, CloneOptions):
raise TypeError(\
"array can only contain objects of type CloneOptions")
progress = self._call("cloneTo",
in_p=[target, mode, options])
progress = IProgress(progress)
return progress
[docs] def save_state(self):
"""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.
On success, this method implicitly calls
:py:func:`save_settings` 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.
The machine must be in the Running or Paused state, otherwise
the operation will fail.
:py:func:`take_snapshot`
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state neither Running nor Paused.
raises :class:`VBoxErrorFileError`
Failed to create directory for saved state file.
"""
progress = self._call("saveState")
progress = IProgress(progress)
return progress
[docs] def adopt_saved_state(self, saved_state_file):
"""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,
:py:func:`snapshot_folder` ).
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.
in saved_state_file of type str
Path to the saved state file to adopt.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state neither PoweredOff nor Aborted.
"""
if not isinstance(saved_state_file, basestring):
raise TypeError("saved_state_file can only be an instance of type basestring")
self._call("adoptSavedState",
in_p=[saved_state_file])
[docs] def discard_saved_state(self, f_remove_file):
"""Forcibly resets the machine to "Powered Off" state if it is
currently in the "Saved" state (previously created by :py:func:`save_state` ).
Next time the machine is powered up, a clean boot will occur.
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.
If @a fRemoveFile is @c true, the file in the machine directory
into which the machine state was saved is also deleted. If
this is @c false, then the state can be recovered and later
re-inserted into a machine using :py:func:`adopt_saved_state` .
The location of the file can be found in the
:py:func:`state_file_path` attribute.
in f_remove_file of type bool
Whether to also remove the saved state file.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in state Saved.
"""
if not isinstance(f_remove_file, bool):
raise TypeError("f_remove_file can only be an instance of type bool")
self._call("discardSavedState",
in_p=[f_remove_file])
[docs] def take_snapshot(self, name, description, pause):
"""Saves the current execution state
and all settings of the machine and creates differencing images
for all normal (non-independent) media.
See :py:class:`ISnapshot` for an introduction to snapshots.
This method can be called for a PoweredOff, Saved (see
:py:func:`save_state` ), 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
:py:func:`current_snapshot` current snapshot
of the associated virtual machine and becomes a new current snapshot.
This method implicitly calls :py:func:`save_settings` to
save all current machine settings before taking an offline snapshot.
in name of type str
Short name for the snapshot.
in description of type str
Optional description of the snapshot.
in pause of type bool
Whether the VM should be paused while taking the snapshot. Only
relevant when the VM is running, and distinguishes between online
(@c true) and live (@c false) snapshots. When the VM is not running
the result is always an offline snapshot.
out id_p of type str
UUID of the snapshot which will be created. Useful for follow-up
operations after the snapshot has been created.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine currently changing state.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(description, basestring):
raise TypeError("description can only be an instance of type basestring")
if not isinstance(pause, bool):
raise TypeError("pause can only be an instance of type bool")
(progress, id_p) = self._call("takeSnapshot",
in_p=[name, description, pause])
progress = IProgress(progress)
return (progress, id_p)
[docs] def delete_snapshot(self, id_p):
"""Starts deleting the specified snapshot asynchronously.
See :py:class:`ISnapshot` for 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 :py:func:`save_settings`
to make all current machine settings permanent.
Deleting a snapshot has the following preconditions:
Child media of all normal media of the deleted snapshot
must be accessible (see :py:func:`IMedium.state` ) for this
operation to succeed. If only one running VM refers to all images
which participates in merging the operation can be performed while
the VM is running. Otherwise all virtual machines whose media are
directly or indirectly based on the media of deleted snapshot must
be powered off. In any case, online snapshot deleting usually is
slower than the same operation without any running VM.
You cannot delete the snapshot if a medium attached to it has
more than one child medium (differencing images) because otherwise
merging would be impossible. This might be the case if there is
more than one child snapshot or differencing images were created
for other reason (e.g. implicitly because of multiple machine
attachments).
The virtual machine's :py:func:`state` state is
changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
"DeletingSnapshotPaused" while this operation is in progress.
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.
in id_p of type str
UUID of the snapshot to delete.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
The 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.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
progress = self._call("deleteSnapshot",
in_p=[id_p])
progress = IProgress(progress)
return progress
[docs] def delete_snapshot_and_all_children(self, id_p):
"""Starts deleting the specified snapshot and all its children
asynchronously. See :py:class:`ISnapshot` for an introduction to
snapshots. The conditions and many details are the same as with
:py:func:`delete_snapshot` .
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.
This API method is right now not implemented!
in id_p of type str
UUID of the snapshot to delete, including all its children.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
The 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.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
progress = self._call("deleteSnapshotAndAllChildren",
in_p=[id_p])
progress = IProgress(progress)
return progress
[docs] def delete_snapshot_range(self, start_id, end_id):
"""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 :py:func:`delete_snapshot` . See
:py:class:`ISnapshot` for an introduction to snapshots. The
conditions and many details are the same as with
:py:func:`delete_snapshot` .
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.
This API method is right now not implemented!
in start_id of type str
UUID of the first snapshot to delete.
in end_id of type str
UUID of the last snapshot to delete.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
The 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.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(start_id, basestring):
raise TypeError("start_id can only be an instance of type basestring")
if not isinstance(end_id, basestring):
raise TypeError("end_id can only be an instance of type basestring")
progress = self._call("deleteSnapshotRange",
in_p=[start_id, end_id])
progress = IProgress(progress)
return progress
def restore_snapshot(self, 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 :py:class:`ISnapshot` for 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 :py:attr:`MachineState.saved` saved state, so that the
next time it is powered on, the execution state will be restored
from the state of the snapshot.
The machine must not be running, otherwise the operation will fail.
If the machine state is :py:attr:`MachineState.saved` Saved
prior to this operation, the saved state file will be implicitly
deleted (as if :py:func:`IMachine.discard_saved_state` were
called).
in snapshot of type :class:`ISnapshot`
The snapshot to restore the VM state from.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is running.
"""
if not isinstance(snapshot, ISnapshot):
raise TypeError("snapshot can only be an instance of type ISnapshot")
progress = self._call("restoreSnapshot",
in_p=[snapshot])
progress = IProgress(progress)
return progress
[docs] def apply_defaults(self, flags):
"""Applies the defaults for the configured guest OS type. This is
primarily for getting sane settings straight after creating a
new VM, but it can also be applied later.
This is primarily a shortcut, centralizing the tedious job of
getting the recommended settings and translating them into
settings updates. The settings are made at the end of the call,
but not saved.
in flags of type str
Additional flags, to be defined later.
raises :class:`OleErrorNotimpl`
This method is not implemented yet.
"""
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
self._call("applyDefaults",
in_p=[flags])
[docs]class IEmulatedUSB(Interface):
"""
Manages emulated USB devices.
"""
__uuid__ = '6e253ee8-477a-2497-6759-88b8292a5af0'
__wsmap__ = 'managed'
[docs] def webcam_attach(self, path, settings):
"""Attaches the emulated USB webcam to the VM, which will use a host video capture device.
in path of type str
The host path of the capture device to use.
in settings of type str
Optional settings.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(settings, basestring):
raise TypeError("settings can only be an instance of type basestring")
self._call("webcamAttach",
in_p=[path, settings])
[docs] def webcam_detach(self, path):
"""Detaches the emulated USB webcam from the VM
in path of type str
The host path of the capture device to detach.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
self._call("webcamDetach",
in_p=[path])
@property
def webcams(self):
"""Get str value for 'webcams'
Lists attached virtual webcams.
"""
ret = self._get_attr("webcams")
return ret
[docs]class IVRDEServerInfo(Interface):
"""
Contains information about the remote desktop (VRDE) server capabilities and status.
This is used in the :py:func:`IConsole.vrde_server_info` attribute.
"""
__uuid__ = 'c39ef4d6-7532-45e8-96da-eb5986ae76e4'
__wsmap__ = 'struct'
@property
def active(self):
"""Get bool value for 'active'
Whether the remote desktop connection is active.
"""
ret = self._get_attr("active")
return ret
@property
def port(self):
"""Get int value for 'port'
VRDE server port number. If this property is equal to 0, then
the VRDE server failed to start, usually because there are no free IP
ports to bind to. If this property is equal to -1, then the VRDE
server has not yet been started.
"""
ret = self._get_attr("port")
return ret
@property
def number_of_clients(self):
"""Get int value for 'numberOfClients'
How many times a client connected.
"""
ret = self._get_attr("numberOfClients")
return ret
@property
def begin_time(self):
"""Get int value for 'beginTime'
When the last connection was established, in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("beginTime")
return ret
@property
def end_time(self):
"""Get int value for 'endTime'
When the last connection was terminated or the current time, if
connection is still active, in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("endTime")
return ret
@property
def bytes_sent(self):
"""Get int value for 'bytesSent'
How many bytes were sent in last or current, if still active, connection.
"""
ret = self._get_attr("bytesSent")
return ret
@property
def bytes_sent_total(self):
"""Get int value for 'bytesSentTotal'
How many bytes were sent in all connections.
"""
ret = self._get_attr("bytesSentTotal")
return ret
@property
def bytes_received(self):
"""Get int value for 'bytesReceived'
How many bytes were received in last or current, if still active, connection.
"""
ret = self._get_attr("bytesReceived")
return ret
@property
def bytes_received_total(self):
"""Get int value for 'bytesReceivedTotal'
How many bytes were received in all connections.
"""
ret = self._get_attr("bytesReceivedTotal")
return ret
@property
def user(self):
"""Get str value for 'user'
Login user name supplied by the client.
"""
ret = self._get_attr("user")
return ret
@property
def domain(self):
"""Get str value for 'domain'
Login domain name supplied by the client.
"""
ret = self._get_attr("domain")
return ret
@property
def client_name(self):
"""Get str value for 'clientName'
The client name supplied by the client.
"""
ret = self._get_attr("clientName")
return ret
@property
def client_ip(self):
"""Get str value for 'clientIP'
The IP address of the client.
"""
ret = self._get_attr("clientIP")
return ret
@property
def client_version(self):
"""Get int value for 'clientVersion'
The client software version number.
"""
ret = self._get_attr("clientVersion")
return ret
@property
def encryption_style(self):
"""Get int value for 'encryptionStyle'
Public key exchange method used when connection was established.
Values: 0 - RDP4 public key exchange scheme.
1 - X509 certificates were sent to client.
"""
ret = self._get_attr("encryptionStyle")
return ret
class IConsole(Interface):
"""
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 :py:func:`IMachine.lock_machine`
or :py:func:`IMachine.launch_vm_process` . The console object can
then be found in the session's :py:func:`ISession.console` 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.
:py:class:`ISession`
"""
__uuid__ = '872da645-4a9b-1727-bee2-5585105b9eed'
__wsmap__ = 'managed'
@property
def machine(self):
"""Get IMachine value for 'machine'
Machine object for this console session.
This is a convenience property, it has the same value as
:py:func:`ISession.machine` of the corresponding session
object.
"""
ret = self._get_attr("machine")
return IMachine(ret)
@property
def state(self):
"""Get MachineState value for 'state'
Current execution state of the machine.
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.
"""
ret = self._get_attr("state")
return MachineState(ret)
@property
def guest(self):
"""Get IGuest value for 'guest'
Guest object.
"""
ret = self._get_attr("guest")
return IGuest(ret)
@property
def keyboard(self):
"""Get IKeyboard value for 'keyboard'
Virtual keyboard object.
If the machine is not running, any attempt to use
the returned object will result in an error.
"""
ret = self._get_attr("keyboard")
return IKeyboard(ret)
@property
def mouse(self):
"""Get IMouse value for 'mouse'
Virtual mouse object.
If the machine is not running, any attempt to use
the returned object will result in an error.
"""
ret = self._get_attr("mouse")
return IMouse(ret)
@property
def display(self):
"""Get IDisplay value for 'display'
Virtual display object.
If the machine is not running, any attempt to use
the returned object will result in an error.
"""
ret = self._get_attr("display")
return IDisplay(ret)
@property
def debugger(self):
"""Get IMachineDebugger value for 'debugger'
Debugging interface.
"""
ret = self._get_attr("debugger")
return IMachineDebugger(ret)
@property
def usb_devices(self):
"""Get IUSBDevice value for 'USBDevices'
Collection of USB devices currently attached to the virtual
USB controller.
The collection is empty if the machine is not running.
"""
ret = self._get_attr("USBDevices")
return [IUSBDevice(a) for a in ret]
@property
def remote_usb_devices(self):
"""Get IHostUSBDevice value for 'remoteUSBDevices'
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.
"""
ret = self._get_attr("remoteUSBDevices")
return [IHostUSBDevice(a) for a in ret]
@property
def shared_folders(self):
"""Get ISharedFolder value for 'sharedFolders'
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
:py:func:`IMachine.shared_folders` 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
:py:func:`create_shared_folder` . Existing shared folders can be
removed using :py:func:`remove_shared_folder` .
"""
ret = self._get_attr("sharedFolders")
return [ISharedFolder(a) for a in ret]
@property
def vrde_server_info(self):
"""Get IVRDEServerInfo value for 'VRDEServerInfo'
Interface that provides information on Remote Desktop Extension (VRDE) connection.
"""
ret = self._get_attr("VRDEServerInfo")
return IVRDEServerInfo(ret)
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for console events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def attached_pci_devices(self):
"""Get IPCIDeviceAttachment value for 'attachedPCIDevices'
Array of PCI devices attached to this machine.
"""
ret = self._get_attr("attachedPCIDevices")
return [IPCIDeviceAttachment(a) for a in ret]
@property
def use_host_clipboard(self):
"""Get or set bool value for 'useHostClipboard'
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.
"""
ret = self._get_attr("useHostClipboard")
return ret
@use_host_clipboard.setter
def use_host_clipboard(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("useHostClipboard", value)
@property
def emulated_usb(self):
"""Get IEmulatedUSB value for 'emulatedUSB'
Interface that manages emulated USB devices.
"""
ret = self._get_attr("emulatedUSB")
return IEmulatedUSB(ret)
[docs] def power_up(self):
"""Starts the virtual machine execution using the current machine
state (that is, its current execution state, current settings and
current storage devices).
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
:py:func:`IMachine.launch_vm_process` instead; these
front-ends will power up the machine automatically for you.
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 :py:attr:`MachineState.saved` state,
it will continue its execution the point where the state has
been saved.
If the machine :py:func:`IMachine.teleporter_enabled` property is
enabled on the machine being powered up, the machine will wait for an
incoming teleportation in the :py:attr:`MachineState.teleporting_in`
state. 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
:py:func:`IMachine.launch_vm_process` as well.
:py:func:`IMachine.save_state`
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine already running.
raises :class:`VBoxErrorHostError`
Host interface does not exist or name not set.
raises :class:`VBoxErrorFileError`
Invalid saved state file.
"""
progress = self._call("powerUp")
progress = IProgress(progress)
return progress
[docs] def power_up_paused(self):
"""Identical to powerUp except that the VM will enter the
:py:attr:`MachineState.paused` state, instead of
:py:attr:`MachineState.running` .
:py:func:`power_up`
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine already running.
raises :class:`VBoxErrorHostError`
Host interface does not exist or name not set.
raises :class:`VBoxErrorFileError`
Invalid saved state file.
"""
progress = self._call("powerUpPaused")
progress = IProgress(progress)
return progress
[docs] def power_down(self):
"""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.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine must be Running, Paused or Stuck to be powered down.
"""
progress = self._call("powerDown")
progress = IProgress(progress)
return progress
[docs] def reset(self):
"""Resets the virtual machine.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Running state.
raises :class:`VBoxErrorVmError`
Virtual machine error in reset operation.
"""
self._call("reset")
[docs] def pause(self):
"""Pauses the virtual machine execution.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Running state.
raises :class:`VBoxErrorVmError`
Virtual machine error in suspend operation.
"""
self._call("pause")
[docs] def resume(self):
"""Resumes the virtual machine execution.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Paused state.
raises :class:`VBoxErrorVmError`
Virtual machine error in resume operation.
"""
self._call("resume")
[docs] def get_guest_entered_acpi_mode(self):
"""Checks if the guest entered the ACPI mode G0 (working) or
G1 (sleeping). If this method returns @c false, the guest will
most likely not respond to external ACPI events.
return entered of type bool
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Running state.
"""
entered = self._call("getGuestEnteredACPIMode")
return entered
[docs] def get_device_activity(self, type_p):
"""Gets the current activity type of given devices or device groups.
in type_p of type :class:`DeviceType`
return activity of type :class:`DeviceActivity`
raises :class:`OleErrorInvalidarg`
Invalid device type.
"""
if not isinstance(type_p, list):
raise TypeError("type_p can only be an instance of type list")
for a in type_p[:10]:
if not isinstance(a, DeviceType):
raise TypeError(\
"array can only contain objects of type DeviceType")
activity = self._call("getDeviceActivity",
in_p=[type_p])
activity = [DeviceActivity(a) for a in activity]
return activity
[docs] def attach_usb_device(self, id_p, capture_filename):
"""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:
:py:attr:`USBDeviceState.busy` ,
:py:attr:`USBDeviceState.available` or
:py:attr:`USBDeviceState.held` ,
otherwise an error is immediately returned.
When the device state is
:py:attr:`USBDeviceState.busy` Busy, an error may also
be returned if the host computer refuses to release it for some reason.
:py:func:`IUSBDeviceFilters.device_filters` ,
:py:class:`USBDeviceState`
in id_p of type str
UUID of the host USB device to attach.
in capture_filename of type str
Filename to capture the USB traffic to.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state neither Running nor Paused.
raises :class:`VBoxErrorPdmError`
Virtual machine does not have a USB controller.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(capture_filename, basestring):
raise TypeError("capture_filename can only be an instance of type basestring")
self._call("attachUSBDevice",
in_p=[id_p, capture_filename])
[docs] def detach_usb_device(self, id_p):
"""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.
:py:func:`IUSBDeviceFilters.device_filters` ,
:py:class:`USBDeviceState`
in id_p of type str
UUID of the USB device to detach.
return device of type :class:`IUSBDevice`
Detached USB device.
raises :class:`VBoxErrorPdmError`
Virtual machine does not have a USB controller.
raises :class:`OleErrorInvalidarg`
USB device not attached to this virtual machine.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
device = self._call("detachUSBDevice",
in_p=[id_p])
device = IUSBDevice(device)
return device
[docs] def find_usb_device_by_address(self, name):
"""Searches for a USB device with the given host address.
:py:func:`IUSBDevice.address`
in name of type str
Address of the USB device (as assigned by the host) to
search for.
return device of type :class:`IUSBDevice`
Found USB device object.
raises :class:`VBoxErrorObjectNotFound`
Given @c name does not correspond to any USB device.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
device = self._call("findUSBDeviceByAddress",
in_p=[name])
device = IUSBDevice(device)
return device
[docs] def find_usb_device_by_id(self, id_p):
"""Searches for a USB device with the given UUID.
:py:func:`IUSBDevice.id_p`
in id_p of type str
UUID of the USB device to search for.
return device of type :class:`IUSBDevice`
Found USB device object.
raises :class:`VBoxErrorObjectNotFound`
Given @c id does not correspond to any USB device.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
device = self._call("findUSBDeviceById",
in_p=[id_p])
device = IUSBDevice(device)
return device
[docs] def create_shared_folder(self, name, host_path, writable, 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
:py:class:`ISharedFolder` to read more about logical names.
in name of type str
Unique logical name of the shared folder.
in host_path of type str
Full path to the shared folder in the host file system.
in writable of type bool
Whether the share is writable or readonly
in automount of type bool
Whether the share gets automatically mounted by the guest
or not.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine in Saved state or currently changing state.
raises :class:`VBoxErrorFileError`
Shared folder already exists or not accessible.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(host_path, basestring):
raise TypeError("host_path can only be an instance of type basestring")
if not isinstance(writable, bool):
raise TypeError("writable can only be an instance of type bool")
if not isinstance(automount, bool):
raise TypeError("automount can only be an instance of type bool")
self._call("createSharedFolder",
in_p=[name, host_path, writable, automount])
[docs] def remove_shared_folder(self, name):
"""Removes a transient shared folder with the given name previously
created by :py:func:`create_shared_folder` from the collection of
shared folders and stops sharing it.
in name of type str
Logical name of the shared folder to remove.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine in Saved state or currently changing state.
raises :class:`VBoxErrorFileError`
Shared folder does not exists.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeSharedFolder",
in_p=[name])
[docs] def teleport(self, hostname, tcpport, password, max_downtime):
"""Teleport the VM to a different host machine or process.
@todo Explain the details.
in hostname of type str
The name or IP of the host to teleport to.
in tcpport of type int
The TCP port to connect to (1..65535).
in password of type str
The password.
in max_downtime of type int
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.
The current implementation treats this a guideline, not as an
absolute rule.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not running or paused.
"""
if not isinstance(hostname, basestring):
raise TypeError("hostname can only be an instance of type basestring")
if not isinstance(tcpport, baseinteger):
raise TypeError("tcpport can only be an instance of type baseinteger")
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
if not isinstance(max_downtime, baseinteger):
raise TypeError("max_downtime can only be an instance of type baseinteger")
progress = self._call("teleport",
in_p=[hostname, tcpport, password, max_downtime])
progress = IProgress(progress)
return progress
[docs] def add_disk_encryption_password(self, id_p, password, clear_on_suspend):
"""Adds a password used for hard disk encryption/decryption.
in id_p of type str
The identifier used for the password. Must match the identifier
used when the encrypted medium was created.
in password of type str
The password.
in clear_on_suspend of type bool
Flag whether to clear the password on VM suspend (due to a suspending host
for example). The password must be supplied again before the VM can resume.
raises :class:`VBoxErrorPasswordIncorrect`
The password provided wasn't correct for at least one disk using the provided
ID.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
if not isinstance(clear_on_suspend, bool):
raise TypeError("clear_on_suspend can only be an instance of type bool")
self._call("addDiskEncryptionPassword",
in_p=[id_p, password, clear_on_suspend])
[docs] def add_disk_encryption_passwords(self, ids, passwords, clear_on_suspend):
"""Adds a password used for hard disk encryption/decryption.
in ids of type str
List of identifiers for the passwords. Must match the identifier
used when the encrypted medium was created.
in passwords of type str
List of passwords.
in clear_on_suspend of type bool
Flag whether to clear the given passwords on VM suspend (due to a suspending host
for example). The passwords must be supplied again before the VM can resume.
raises :class:`VBoxErrorPasswordIncorrect`
The password provided wasn't correct for at least one disk using the provided
ID.
"""
if not isinstance(ids, list):
raise TypeError("ids can only be an instance of type list")
for a in ids[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(passwords, list):
raise TypeError("passwords can only be an instance of type list")
for a in passwords[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(clear_on_suspend, bool):
raise TypeError("clear_on_suspend can only be an instance of type bool")
self._call("addDiskEncryptionPasswords",
in_p=[ids, passwords, clear_on_suspend])
[docs] def remove_disk_encryption_password(self, id_p):
"""Removes a password used for hard disk encryption/decryption from
the running VM. As soon as the medium requiring this password
is accessed the VM is paused with an error and the password must be
provided again.
in id_p of type str
The identifier used for the password. Must match the identifier
used when the encrypted medium was created.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
self._call("removeDiskEncryptionPassword",
in_p=[id_p])
[docs] def clear_all_disk_encryption_passwords(self):
"""Clears all provided supplied disk encryption passwords.
"""
self._call("clearAllDiskEncryptionPasswords")
[docs]class IHostNetworkInterface(Interface):
"""
Represents one of host's network interfaces. IP V6 address and network
mask are strings of 32 hexadecimal digits grouped by four. Groups are
separated by colons.
For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
"""
__uuid__ = '455f8c45-44a0-a470-ba20-27890b96dba9'
__wsmap__ = 'managed'
@property
def name(self):
"""Get str value for 'name'
Returns the host network interface name.
"""
ret = self._get_attr("name")
return ret
@property
def short_name(self):
"""Get str value for 'shortName'
Returns the host network interface short name.
"""
ret = self._get_attr("shortName")
return ret
@property
def id_p(self):
"""Get str value for 'id'
Returns the interface UUID.
"""
ret = self._get_attr("id")
return ret
@property
def network_name(self):
"""Get str value for 'networkName'
Returns the name of a virtual network the interface gets attached to.
"""
ret = self._get_attr("networkName")
return ret
@property
def dhcp_enabled(self):
"""Get bool value for 'DHCPEnabled'
Specifies whether the DHCP is enabled for the interface.
"""
ret = self._get_attr("DHCPEnabled")
return ret
@property
def ip_address(self):
"""Get str value for 'IPAddress'
Returns the IP V4 address of the interface.
"""
ret = self._get_attr("IPAddress")
return ret
@property
def network_mask(self):
"""Get str value for 'networkMask'
Returns the network mask of the interface.
"""
ret = self._get_attr("networkMask")
return ret
@property
def ipv6_supported(self):
"""Get bool value for 'IPV6Supported'
Specifies whether the IP V6 is supported/enabled for the interface.
"""
ret = self._get_attr("IPV6Supported")
return ret
@property
def ipv6_address(self):
"""Get str value for 'IPV6Address'
Returns the IP V6 address of the interface.
"""
ret = self._get_attr("IPV6Address")
return ret
@property
def ipv6_network_mask_prefix_length(self):
"""Get int value for 'IPV6NetworkMaskPrefixLength'
Returns the length IP V6 network mask prefix of the interface.
"""
ret = self._get_attr("IPV6NetworkMaskPrefixLength")
return ret
@property
def hardware_address(self):
"""Get str value for 'hardwareAddress'
Returns the hardware address. For Ethernet it is MAC address.
"""
ret = self._get_attr("hardwareAddress")
return ret
@property
def medium_type(self):
"""Get HostNetworkInterfaceMediumType value for 'mediumType'
Type of protocol encapsulation used.
"""
ret = self._get_attr("mediumType")
return HostNetworkInterfaceMediumType(ret)
@property
def status(self):
"""Get HostNetworkInterfaceStatus value for 'status'
Status of the interface.
"""
ret = self._get_attr("status")
return HostNetworkInterfaceStatus(ret)
@property
def interface_type(self):
"""Get HostNetworkInterfaceType value for 'interfaceType'
specifies the host interface type.
"""
ret = self._get_attr("interfaceType")
return HostNetworkInterfaceType(ret)
[docs] def enable_static_ip_config(self, ip_address, network_mask):
"""sets and enables the static IP V4 configuration for the given interface.
in ip_address of type str
IP address.
in network_mask of type str
network mask.
"""
if not isinstance(ip_address, basestring):
raise TypeError("ip_address can only be an instance of type basestring")
if not isinstance(network_mask, basestring):
raise TypeError("network_mask can only be an instance of type basestring")
self._call("enableStaticIPConfig",
in_p=[ip_address, network_mask])
[docs] def enable_static_ip_config_v6(self, ipv6_address, ipv6_network_mask_prefix_length):
"""sets and enables the static IP V6 configuration for the given interface.
in ipv6_address of type str
IP address.
in ipv6_network_mask_prefix_length of type int
network mask.
"""
if not isinstance(ipv6_address, basestring):
raise TypeError("ipv6_address can only be an instance of type basestring")
if not isinstance(ipv6_network_mask_prefix_length, baseinteger):
raise TypeError("ipv6_network_mask_prefix_length can only be an instance of type baseinteger")
self._call("enableStaticIPConfigV6",
in_p=[ipv6_address, ipv6_network_mask_prefix_length])
[docs] def enable_dynamic_ip_config(self):
"""enables the dynamic IP configuration.
"""
self._call("enableDynamicIPConfig")
[docs] def dhcp_rediscover(self):
"""refreshes the IP configuration for DHCP-enabled interface.
"""
self._call("DHCPRediscover")
class IHost(Interface):
"""
The IHost interface represents the physical machine that this VirtualBox
installation runs on.
An object implementing this interface is returned by the
:py:func:`IVirtualBox.host` 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.
"""
__uuid__ = 'afca788c-4477-787d-60b2-3fa70e56fbbc'
__wsmap__ = 'managed'
@property
def dvd_drives(self):
"""Get IMedium value for 'DVDDrives'
List of DVD drives available on the host.
"""
ret = self._get_attr("DVDDrives")
return [IMedium(a) for a in ret]
@property
def floppy_drives(self):
"""Get IMedium value for 'floppyDrives'
List of floppy drives available on the host.
"""
ret = self._get_attr("floppyDrives")
return [IMedium(a) for a in ret]
@property
def usb_devices(self):
"""Get IHostUSBDevice value for 'USBDevices'
List of USB devices currently attached to the host.
Once a new device is physically attached to the host computer,
it appears in this list and remains there until detached.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
"""
ret = self._get_attr("USBDevices")
return [IHostUSBDevice(a) for a in ret]
@property
def usb_device_filters(self):
"""Get IHostUSBDeviceFilter value for 'USBDeviceFilters'
List of USB device filters in action.
When a new device is physically attached to the host computer,
filters from this list are applied to it (in order they are stored
in the list). The first matched filter will determine the
:py:func:`IHostUSBDeviceFilter.action` action
performed on the device.
Unless the device is ignored by these filters, filters of all
currently running virtual machines
(:py:func:`IUSBDeviceFilters.device_filters` ) are applied to it.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
:py:class:`IHostUSBDeviceFilter` ,
:py:class:`USBDeviceState`
"""
ret = self._get_attr("USBDeviceFilters")
return [IHostUSBDeviceFilter(a) for a in ret]
@property
def network_interfaces(self):
"""Get IHostNetworkInterface value for 'networkInterfaces'
List of host network interfaces currently defined on the host.
"""
ret = self._get_attr("networkInterfaces")
return [IHostNetworkInterface(a) for a in ret]
@property
def name_servers(self):
"""Get str value for 'nameServers'
The list of nameservers registered in host's name resolving system.
"""
ret = self._get_attr("nameServers")
return ret
@property
def domain_name(self):
"""Get str value for 'domainName'
Domain name used for name resolving.
"""
ret = self._get_attr("domainName")
return ret
@property
def search_strings(self):
"""Get str value for 'searchStrings'
Search string registered for name resolving.
"""
ret = self._get_attr("searchStrings")
return ret
@property
def processor_count(self):
"""Get int value for 'processorCount'
Number of (logical) CPUs installed in the host system.
"""
ret = self._get_attr("processorCount")
return ret
@property
def processor_online_count(self):
"""Get int value for 'processorOnlineCount'
Number of (logical) CPUs online in the host system.
"""
ret = self._get_attr("processorOnlineCount")
return ret
@property
def processor_core_count(self):
"""Get int value for 'processorCoreCount'
Number of physical processor cores installed in the host system.
"""
ret = self._get_attr("processorCoreCount")
return ret
@property
def processor_online_core_count(self):
"""Get int value for 'processorOnlineCoreCount'
Number of physical processor cores online in the host system.
"""
ret = self._get_attr("processorOnlineCoreCount")
return ret
def get_processor_speed(self, cpu_id):
"""Query the (approximate) maximum speed of a specified host CPU in
Megahertz.
in cpu_id of type int
Identifier of the CPU.
return speed of type int
Speed value. 0 is returned if value is not known or @a cpuId is
invalid.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
speed = self._call("getProcessorSpeed",
in_p=[cpu_id])
return speed
def get_processor_feature(self, feature):
"""Query whether a CPU feature is supported or not.
in feature of type :class:`ProcessorFeature`
CPU Feature identifier.
return supported of type bool
Feature is supported or not.
"""
if not isinstance(feature, ProcessorFeature):
raise TypeError("feature can only be an instance of type ProcessorFeature")
supported = self._call("getProcessorFeature",
in_p=[feature])
return supported
def get_processor_description(self, cpu_id):
"""Query the model string of a specified host CPU.
in cpu_id of type int
Identifier of the CPU.
The current implementation might not necessarily return the
description for this exact CPU.
return description of type str
Model string. An empty string is returned if value is not known or
@a cpuId is invalid.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
description = self._call("getProcessorDescription",
in_p=[cpu_id])
return description
def get_processor_cpuid_leaf(self, cpu_id, leaf, sub_leaf):
"""Returns the CPU cpuid information for the specified leaf.
in cpu_id of type int
Identifier of the CPU. The CPU most be online.
The current implementation might not necessarily return the
description for this exact CPU.
in leaf of type int
CPUID leaf index (eax).
in sub_leaf of type int
CPUID leaf sub index (ecx). This currently only applies to cache
information on Intel CPUs. Use 0 if retrieving values for
:py:func:`IMachine.set_cpuid_leaf` .
out val_eax of type int
CPUID leaf value for register eax.
out val_ebx of type int
CPUID leaf value for register ebx.
out val_ecx of type int
CPUID leaf value for register ecx.
out val_edx of type int
CPUID leaf value for register edx.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(leaf, baseinteger):
raise TypeError("leaf can only be an instance of type baseinteger")
if not isinstance(sub_leaf, baseinteger):
raise TypeError("sub_leaf can only be an instance of type baseinteger")
(val_eax, val_ebx, val_ecx, val_edx) = self._call("getProcessorCPUIDLeaf",
in_p=[cpu_id, leaf, sub_leaf])
return (val_eax, val_ebx, val_ecx, val_edx)
@property
def memory_size(self):
"""Get int value for 'memorySize'
Amount of system memory in megabytes installed in the host system.
"""
ret = self._get_attr("memorySize")
return ret
@property
def memory_available(self):
"""Get int value for 'memoryAvailable'
Available system memory in the host system.
"""
ret = self._get_attr("memoryAvailable")
return ret
@property
def operating_system(self):
"""Get str value for 'operatingSystem'
Name of the host system's operating system.
"""
ret = self._get_attr("operatingSystem")
return ret
@property
def os_version(self):
"""Get str value for 'OSVersion'
Host operating system's version string.
"""
ret = self._get_attr("OSVersion")
return ret
@property
def utc_time(self):
"""Get int value for 'UTCTime'
Returns the current host time in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("UTCTime")
return ret
@property
def acceleration3_d_available(self):
"""Get bool value for 'acceleration3DAvailable'
Returns @c true when the host supports 3D hardware acceleration.
"""
ret = self._get_attr("acceleration3DAvailable")
return ret
def create_host_only_network_interface(self):
"""Creates a new adapter for Host Only Networking.
out host_interface of type :class:`IHostNetworkInterface`
Created host interface object.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorInvalidarg`
Host network interface @a name already exists.
"""
(progress, host_interface) = self._call("createHostOnlyNetworkInterface")
progress = IProgress(progress)
host_interface = IHostNetworkInterface(host_interface)
return (progress, host_interface)
def remove_host_only_network_interface(self, id_p):
"""Removes the given Host Only Networking interface.
in id_p of type str
Adapter GUID.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorObjectNotFound`
No host network interface matching @a id found.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
progress = self._call("removeHostOnlyNetworkInterface",
in_p=[id_p])
progress = IProgress(progress)
return progress
def create_usb_device_filter(self, name):
"""Creates a new USB device filter. All attributes except
the filter name are set to empty (any match),
*active* is @c false (the filter is not active).
The created filter can be added to the list of filters using
:py:func:`insert_usb_device_filter` .
:py:func:`usb_device_filters`
in name of type str
Filter name. See :py:func:`IUSBDeviceFilter.name` for more information.
return filter_p of type :class:`IHostUSBDeviceFilter`
Created filter object.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
filter_p = self._call("createUSBDeviceFilter",
in_p=[name])
filter_p = IHostUSBDeviceFilter(filter_p)
return filter_p
def insert_usb_device_filter(self, position, filter_p):
"""Inserts the given USB device to the specified position
in the list of filters.
Positions are numbered starting from @c 0. If the specified
position is equal to or greater than the number of elements in
the list, the filter is added at the end of the collection.
Duplicates are not allowed, so an attempt to insert a
filter already in the list is an error.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
:py:func:`usb_device_filters`
in position of type int
Position to insert the filter to.
in filter_p of type :class:`IHostUSBDeviceFilter`
USB device filter to insert.
raises :class:`VBoxErrorInvalidObjectState`
USB device filter is not created within this VirtualBox instance.
raises :class:`OleErrorInvalidarg`
USB device filter already in list.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
if not isinstance(filter_p, IHostUSBDeviceFilter):
raise TypeError("filter_p can only be an instance of type IHostUSBDeviceFilter")
self._call("insertUSBDeviceFilter",
in_p=[position, filter_p])
def remove_usb_device_filter(self, position):
"""Removes a USB device filter from the specified position in the
list of filters.
Positions are numbered starting from @c 0. Specifying a
position equal to or greater than the number of elements in
the list will produce an error.
If USB functionality is not available in the given edition of
VirtualBox, this method will set the result code to @c E_NOTIMPL.
:py:func:`usb_device_filters`
in position of type int
Position to remove the filter from.
raises :class:`OleErrorInvalidarg`
USB device filter list empty or invalid @a position.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
self._call("removeUSBDeviceFilter",
in_p=[position])
def find_host_dvd_drive(self, name):
"""Searches for a host DVD drive with the given @c name.
in name of type str
Name of the host drive to search for
return drive of type :class:`IMedium`
Found host drive object
raises :class:`VBoxErrorObjectNotFound`
Given @c name does not correspond to any host drive.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
drive = self._call("findHostDVDDrive",
in_p=[name])
drive = IMedium(drive)
return drive
def find_host_floppy_drive(self, name):
"""Searches for a host floppy drive with the given @c name.
in name of type str
Name of the host floppy drive to search for
return drive of type :class:`IMedium`
Found host floppy drive object
raises :class:`VBoxErrorObjectNotFound`
Given @c name does not correspond to any host floppy drive.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
drive = self._call("findHostFloppyDrive",
in_p=[name])
drive = IMedium(drive)
return drive
def find_host_network_interface_by_name(self, name):
"""Searches through all host network interfaces for an interface with
the given @c name.
The method returns an error if the given @c name does not
correspond to any host network interface.
in name of type str
Name of the host network interface to search for.
return network_interface of type :class:`IHostNetworkInterface`
Found host network interface object.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
network_interface = self._call("findHostNetworkInterfaceByName",
in_p=[name])
network_interface = IHostNetworkInterface(network_interface)
return network_interface
def find_host_network_interface_by_id(self, id_p):
"""Searches through all host network interfaces for an interface with
the given GUID.
The method returns an error if the given GUID does not
correspond to any host network interface.
in id_p of type str
GUID of the host network interface to search for.
return network_interface of type :class:`IHostNetworkInterface`
Found host network interface object.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
network_interface = self._call("findHostNetworkInterfaceById",
in_p=[id_p])
network_interface = IHostNetworkInterface(network_interface)
return network_interface
def find_host_network_interfaces_of_type(self, type_p):
"""Searches through all host network interfaces and returns a list of interfaces of the specified type
in type_p of type :class:`HostNetworkInterfaceType`
type of the host network interfaces to search for.
return network_interfaces of type :class:`IHostNetworkInterface`
Found host network interface objects.
"""
if not isinstance(type_p, HostNetworkInterfaceType):
raise TypeError("type_p can only be an instance of type HostNetworkInterfaceType")
network_interfaces = self._call("findHostNetworkInterfacesOfType",
in_p=[type_p])
network_interfaces = [IHostNetworkInterface(a) for a in network_interfaces]
return network_interfaces
def find_usb_device_by_id(self, id_p):
"""Searches for a USB device with the given UUID.
:py:func:`IUSBDevice.id_p`
in id_p of type str
UUID of the USB device to search for.
return device of type :class:`IHostUSBDevice`
Found USB device object.
raises :class:`VBoxErrorObjectNotFound`
Given @c id does not correspond to any USB device.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
device = self._call("findUSBDeviceById",
in_p=[id_p])
device = IHostUSBDevice(device)
return device
def find_usb_device_by_address(self, name):
"""Searches for a USB device with the given host address.
:py:func:`IUSBDevice.address`
in name of type str
Address of the USB device (as assigned by the host) to
search for.
return device of type :class:`IHostUSBDevice`
Found USB device object.
raises :class:`VBoxErrorObjectNotFound`
Given @c name does not correspond to any USB device.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
device = self._call("findUSBDeviceByAddress",
in_p=[name])
device = IHostUSBDevice(device)
return device
def generate_mac_address(self):
"""Generates a valid Ethernet MAC address, 12 hexadecimal characters.
return address of type str
New Ethernet MAC address.
"""
address = self._call("generateMACAddress")
return address
@property
def video_input_devices(self):
"""Get IHostVideoInputDevice value for 'videoInputDevices'
List of currently available host video capture devices.
"""
ret = self._get_attr("videoInputDevices")
return [IHostVideoInputDevice(a) for a in ret]
def add_usb_device_source(self, backend, id_p, address, property_names, property_values):
"""Adds a new USB device source.
in backend of type str
The backend to use as the new device source.
in id_p of type str
Unique ID to identify the source.
in address of type str
Address to use, the format is dependent on the backend.
For USB/IP backends for example the notation is host[:port].
in property_names of type str
Array of property names for more detailed configuration. Not used at the moment.
in property_values of type str
Array of property values for more detailed configuration. Not used at the moment.
"""
if not isinstance(backend, basestring):
raise TypeError("backend can only be an instance of type basestring")
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(address, basestring):
raise TypeError("address can only be an instance of type basestring")
if not isinstance(property_names, list):
raise TypeError("property_names can only be an instance of type list")
for a in property_names[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(property_values, list):
raise TypeError("property_values can only be an instance of type list")
for a in property_values[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("addUSBDeviceSource",
in_p=[backend, id_p, address, property_names, property_values])
def remove_usb_device_source(self, id_p):
"""Removes a previously added USB device source.
in id_p of type str
The identifier used when the source was added.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
self._call("removeUSBDeviceSource",
in_p=[id_p])
[docs]class ISystemProperties(Interface):
"""
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.
"""
__uuid__ = '0eb668d2-495e-5a36-8890-29999b5f030c'
__wsmap__ = 'managed'
@property
def min_guest_ram(self):
"""Get int value for 'minGuestRAM'
Minimum guest system memory in Megabytes.
"""
ret = self._get_attr("minGuestRAM")
return ret
@property
def max_guest_ram(self):
"""Get int value for 'maxGuestRAM'
Maximum guest system memory in Megabytes.
"""
ret = self._get_attr("maxGuestRAM")
return ret
@property
def min_guest_vram(self):
"""Get int value for 'minGuestVRAM'
Minimum guest video memory in Megabytes.
"""
ret = self._get_attr("minGuestVRAM")
return ret
@property
def max_guest_vram(self):
"""Get int value for 'maxGuestVRAM'
Maximum guest video memory in Megabytes.
"""
ret = self._get_attr("maxGuestVRAM")
return ret
@property
def min_guest_cpu_count(self):
"""Get int value for 'minGuestCPUCount'
Minimum CPU count.
"""
ret = self._get_attr("minGuestCPUCount")
return ret
@property
def max_guest_cpu_count(self):
"""Get int value for 'maxGuestCPUCount'
Maximum CPU count.
"""
ret = self._get_attr("maxGuestCPUCount")
return ret
@property
def max_guest_monitors(self):
"""Get int value for 'maxGuestMonitors'
Maximum of monitors which could be connected.
"""
ret = self._get_attr("maxGuestMonitors")
return ret
@property
def info_vd_size(self):
"""Get int value for 'infoVDSize'
Maximum size of a virtual disk image in bytes. Informational value,
does not reflect the limits of any virtual disk image format.
"""
ret = self._get_attr("infoVDSize")
return ret
@property
def serial_port_count(self):
"""Get int value for 'serialPortCount'
Maximum number of serial ports associated with every
:py:class:`IMachine` instance.
"""
ret = self._get_attr("serialPortCount")
return ret
@property
def parallel_port_count(self):
"""Get int value for 'parallelPortCount'
Maximum number of parallel ports associated with every
:py:class:`IMachine` instance.
"""
ret = self._get_attr("parallelPortCount")
return ret
@property
def max_boot_position(self):
"""Get int value for '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.
:py:func:`IMachine.set_boot_order`
"""
ret = self._get_attr("maxBootPosition")
return ret
@property
def raw_mode_supported(self):
"""Get bool value for 'rawModeSupported'
Indicates whether VirtualBox was built with raw-mode support.
When this reads as False, the :py:attr:`HWVirtExPropertyType.enabled`
setting will be ignored and assumed to be True.
"""
ret = self._get_attr("rawModeSupported")
return ret
@property
def exclusive_hw_virt(self):
"""Get or set bool value for '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.
This is ignored on OS X, the kernel mediates hardware
access there.
"""
ret = self._get_attr("exclusiveHwVirt")
return ret
@exclusive_hw_virt.setter
def exclusive_hw_virt(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("exclusiveHwVirt", value)
@property
def default_machine_folder(self):
"""Get or set str value for 'defaultMachineFolder'
Full path to the default directory used to create new or open
existing machines when a machine settings file name contains no
path.
Starting with VirtualBox 4.0, by default, this attribute contains
the full path of folder named "VirtualBox VMs" in the user's
home directory, which depends on the host platform.
When setting this attribute, a full path must be specified.
Setting this property to @c null or an empty string or the
special value "Machines" (for compatibility reasons) will restore
that default value.
If the folder specified herein does not exist, it will be created
automatically as needed.
:py:func:`IVirtualBox.create_machine` ,
:py:func:`IVirtualBox.open_machine`
"""
ret = self._get_attr("defaultMachineFolder")
return ret
@default_machine_folder.setter
def default_machine_folder(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultMachineFolder", value)
@property
def logging_level(self):
"""Get or set str value for 'loggingLevel'
Specifies the logging level in current use by VirtualBox.
"""
ret = self._get_attr("loggingLevel")
return ret
@logging_level.setter
def logging_level(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("loggingLevel", value)
@property
def medium_formats(self):
"""Get IMediumFormat value for 'mediumFormats'
List of all medium storage formats supported by this VirtualBox
installation.
Keep in mind that the medium format identifier
(:py:func:`IMediumFormat.id_p` ) used in other API calls like
:py:func:`IVirtualBox.create_medium` 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.
:py:class:`IMediumFormat`
"""
ret = self._get_attr("mediumFormats")
return [IMediumFormat(a) for a in ret]
@property
def default_hard_disk_format(self):
"""Get or set str value for 'defaultHardDiskFormat'
Identifier of the default medium format used by VirtualBox.
The medium format set by this attribute is used by VirtualBox
when the medium format was not specified explicitly. One example is
:py:func:`IVirtualBox.create_medium` 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 the
:py:func:`medium_formats` 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.
Setting this property to @c null or empty string will restore the
initial value.
:py:func:`medium_formats` ,
:py:func:`IMediumFormat.id_p` ,
:py:func:`IVirtualBox.create_medium`
"""
ret = self._get_attr("defaultHardDiskFormat")
return ret
@default_hard_disk_format.setter
def default_hard_disk_format(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultHardDiskFormat", value)
@property
def free_disk_space_warning(self):
"""Get or set int value for 'freeDiskSpaceWarning'
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.
"""
ret = self._get_attr("freeDiskSpaceWarning")
return ret
@free_disk_space_warning.setter
def free_disk_space_warning(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("freeDiskSpaceWarning", value)
@property
def free_disk_space_percent_warning(self):
"""Get or set int value for 'freeDiskSpacePercentWarning'
Issue a warning if the free disk space is below (or in some disk
intensive operation is expected to go below) the given percentage.
"""
ret = self._get_attr("freeDiskSpacePercentWarning")
return ret
@free_disk_space_percent_warning.setter
def free_disk_space_percent_warning(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("freeDiskSpacePercentWarning", value)
@property
def free_disk_space_error(self):
"""Get or set int value for 'freeDiskSpaceError'
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.
"""
ret = self._get_attr("freeDiskSpaceError")
return ret
@free_disk_space_error.setter
def free_disk_space_error(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("freeDiskSpaceError", value)
@property
def free_disk_space_percent_error(self):
"""Get or set int value for 'freeDiskSpacePercentError'
Issue an error if the free disk space is below (or in some disk
intensive operation is expected to go below) the given percentage.
"""
ret = self._get_attr("freeDiskSpacePercentError")
return ret
@free_disk_space_percent_error.setter
def free_disk_space_percent_error(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("freeDiskSpacePercentError", value)
@property
def vrde_auth_library(self):
"""Get or set str value for 'VRDEAuthLibrary'
Library that provides authentication for Remote Desktop clients. The library
is used if a virtual machine's authentication type is set to "external"
in the VM RemoteDisplay configuration.
The system library extension (".DLL" or ".so") must be omitted.
A full path can be specified; if not, then the library must reside on the
system's default library path.
The default value of this property is "VBoxAuth". There is a library
of that name in one of the default VirtualBox library directories.
For details about VirtualBox authentication libraries and how to implement
them, please refer to the VirtualBox manual.
Setting this property to @c null or empty string will restore the
initial value.
"""
ret = self._get_attr("VRDEAuthLibrary")
return ret
@vrde_auth_library.setter
def vrde_auth_library(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("VRDEAuthLibrary", value)
@property
def web_service_auth_library(self):
"""Get or set str value for 'webServiceAuthLibrary'
Library that provides authentication for webservice clients. The library
is used if a virtual machine's authentication type is set to "external"
in the VM RemoteDisplay configuration and will be called from
within the :py:func:`IWebsessionManager.logon` implementation.
As opposed to :py:func:`ISystemProperties.vrde_auth_library` ,
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 that :py:func:`IWebsessionManager.logon` 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, see
:py:func:`ISystemProperties.vrde_auth_library` ).
The format and calling convention of authentication libraries
is the same for the webservice as it is for VRDE.
Setting this property to @c null or empty string will restore the
initial value.
"""
ret = self._get_attr("webServiceAuthLibrary")
return ret
@web_service_auth_library.setter
def web_service_auth_library(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("webServiceAuthLibrary", value)
@property
def default_vrde_ext_pack(self):
"""Get or set str value for 'defaultVRDEExtPack'
The name of the extension pack providing the default VRDE.
This attribute is for choosing between multiple extension packs
providing VRDE. If only one is installed, it will automatically be the
default one. The attribute value can be empty if no VRDE extension
pack is installed.
For details about VirtualBox Remote Desktop Extension and how to
implement one, please refer to the VirtualBox SDK.
"""
ret = self._get_attr("defaultVRDEExtPack")
return ret
@default_vrde_ext_pack.setter
def default_vrde_ext_pack(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultVRDEExtPack", value)
@property
def log_history_count(self):
"""Get or set int value for 'logHistoryCount'
This value specifies how many old release log files are kept.
"""
ret = self._get_attr("logHistoryCount")
return ret
@log_history_count.setter
def log_history_count(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("logHistoryCount", value)
@property
def default_audio_driver(self):
"""Get AudioDriverType value for 'defaultAudioDriver'
This value hold the default audio driver for the current
system.
"""
ret = self._get_attr("defaultAudioDriver")
return AudioDriverType(ret)
@property
def autostart_database_path(self):
"""Get or set str value for 'autostartDatabasePath'
The path to the autostart database. Depending on the host this might
be a filesystem path or something else.
"""
ret = self._get_attr("autostartDatabasePath")
return ret
@autostart_database_path.setter
def autostart_database_path(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("autostartDatabasePath", value)
@property
def default_additions_iso(self):
"""Get or set str value for 'defaultAdditionsISO'
The path to the default Guest Additions ISO image. Can be empty if
the location is not known in this installation.
"""
ret = self._get_attr("defaultAdditionsISO")
return ret
@default_additions_iso.setter
def default_additions_iso(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultAdditionsISO", value)
@property
def default_frontend(self):
"""Get or set str value for 'defaultFrontend'
Selects which VM frontend should be used by default when launching
a VM through the :py:func:`IMachine.launch_vm_process` method.
Empty or @c null strings do not define a particular default, it is up
to :py:func:`IMachine.launch_vm_process` to select one. See the
description of :py:func:`IMachine.launch_vm_process` for the valid
frontend types.
This global setting is overridden by the per-VM attribute
:py:func:`IMachine.default_frontend` or a frontend type
passed to :py:func:`IMachine.launch_vm_process` .
"""
ret = self._get_attr("defaultFrontend")
return ret
@default_frontend.setter
def default_frontend(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("defaultFrontend", value)
@property
def screen_shot_formats(self):
"""Get BitmapFormat value for 'screenShotFormats'
Supported bitmap formats which can be used with takeScreenShot
and takeScreenShotToArray methods.
"""
ret = self._get_attr("screenShotFormats")
return [BitmapFormat(a) for a in ret]
[docs] def get_max_network_adapters(self, chipset):
"""Maximum total number of network adapters associated with every
:py:class:`IMachine` instance.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
return max_network_adapters of type int
The maximum total number of network adapters allowed.
"""
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
max_network_adapters = self._call("getMaxNetworkAdapters",
in_p=[chipset])
return max_network_adapters
[docs] def get_max_network_adapters_of_type(self, chipset, type_p):
"""Maximum number of network adapters of a given attachment type,
associated with every :py:class:`IMachine` instance.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
in type_p of type :class:`NetworkAttachmentType`
Type of attachment.
return max_network_adapters of type int
The maximum number of network adapters allowed for
particular chipset and attachment type.
"""
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(type_p, NetworkAttachmentType):
raise TypeError("type_p can only be an instance of type NetworkAttachmentType")
max_network_adapters = self._call("getMaxNetworkAdaptersOfType",
in_p=[chipset, type_p])
return max_network_adapters
[docs] def get_max_devices_per_port_for_storage_bus(self, bus):
"""Returns the maximum number of devices which can be attached to a port
for the given storage bus.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return max_devices_per_port of type int
The maximum number of devices which can be attached to the port for the given
storage bus.
"""
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_devices_per_port = self._call("getMaxDevicesPerPortForStorageBus",
in_p=[bus])
return max_devices_per_port
[docs] def get_min_port_count_for_storage_bus(self, bus):
"""Returns the minimum number of ports the given storage bus supports.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return min_port_count of type int
The minimum number of ports for the given storage bus.
"""
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
min_port_count = self._call("getMinPortCountForStorageBus",
in_p=[bus])
return min_port_count
[docs] def get_max_port_count_for_storage_bus(self, bus):
"""Returns the maximum number of ports the given storage bus supports.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return max_port_count of type int
The maximum number of ports for the given storage bus.
"""
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_port_count = self._call("getMaxPortCountForStorageBus",
in_p=[bus])
return max_port_count
[docs] def get_max_instances_of_storage_bus(self, chipset, 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.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return max_instances of type int
The maximum number of instances for the given storage bus.
"""
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_instances = self._call("getMaxInstancesOfStorageBus",
in_p=[chipset, bus])
return max_instances
[docs] def get_device_types_for_storage_bus(self, bus):
"""Returns list of all the supported device types
(:py:class:`DeviceType` ) for the given type of storage
bus.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return device_types of type :class:`DeviceType`
The list of all supported device types for the given storage bus.
"""
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
device_types = self._call("getDeviceTypesForStorageBus",
in_p=[bus])
device_types = [DeviceType(a) for a in device_types]
return device_types
[docs] def get_default_io_cache_setting_for_storage_controller(self, controller_type):
"""Returns the default I/O cache setting for the
given storage controller
in controller_type of type :class:`StorageControllerType`
The storage controller type to get the setting for.
return enabled of type bool
Returned flag indicating the default value
"""
if not isinstance(controller_type, StorageControllerType):
raise TypeError("controller_type can only be an instance of type StorageControllerType")
enabled = self._call("getDefaultIoCacheSettingForStorageController",
in_p=[controller_type])
return enabled
[docs] def get_storage_controller_hotplug_capable(self, controller_type):
"""Returns whether the given storage controller supports
hot-plugging devices.
in controller_type of type :class:`StorageControllerType`
The storage controller to check the setting for.
return hotplug_capable of type bool
Returned flag indicating whether the controller is hotplug capable
"""
if not isinstance(controller_type, StorageControllerType):
raise TypeError("controller_type can only be an instance of type StorageControllerType")
hotplug_capable = self._call("getStorageControllerHotplugCapable",
in_p=[controller_type])
return hotplug_capable
[docs] def get_max_instances_of_usb_controller_type(self, chipset, type_p):
"""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.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
in type_p of type :class:`USBControllerType`
The USB controller type to get the value for.
return max_instances of type int
The maximum number of instances for the given USB controller type.
"""
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
max_instances = self._call("getMaxInstancesOfUSBControllerType",
in_p=[chipset, type_p])
return max_instances
class IGuestOSType(Interface):
""""""
__uuid__ = 'b1336a0a-2546-4d99-8cff-8efb130cfa9d'
__wsmap__ = 'struct'
@property
def family_id(self):
"""Get str value for 'familyId'
Guest OS family identifier string.
"""
ret = self._get_attr("familyId")
return ret
@property
def family_description(self):
"""Get str value for 'familyDescription'
Human readable description of the guest OS family.
"""
ret = self._get_attr("familyDescription")
return ret
@property
def id_p(self):
"""Get str value for 'id'
Guest OS identifier string.
"""
ret = self._get_attr("id")
return ret
@property
def description(self):
"""Get str value for 'description'
Human readable description of the guest OS.
"""
ret = self._get_attr("description")
return ret
@property
def is64_bit(self):
"""Get bool value for 'is64Bit'
Returns @c true if the given OS is 64-bit
"""
ret = self._get_attr("is64Bit")
return ret
@property
def recommended_ioapic(self):
"""Get bool value for 'recommendedIOAPIC'
Returns @c true if I/O-APIC recommended for this OS type.
"""
ret = self._get_attr("recommendedIOAPIC")
return ret
@property
def recommended_virt_ex(self):
"""Get bool value for 'recommendedVirtEx'
Returns @c true if VT-x or AMD-V recommended for this OS type.
"""
ret = self._get_attr("recommendedVirtEx")
return ret
@property
def recommended_ram(self):
"""Get int value for 'recommendedRAM'
Recommended RAM size in Megabytes.
"""
ret = self._get_attr("recommendedRAM")
return ret
@property
def recommended_vram(self):
"""Get int value for 'recommendedVRAM'
Recommended video RAM size in Megabytes.
"""
ret = self._get_attr("recommendedVRAM")
return ret
@property
def recommended2_d_video_acceleration(self):
"""Get bool value for 'recommended2DVideoAcceleration'
Returns @c true if 2D video acceleration is recommended for this OS type.
"""
ret = self._get_attr("recommended2DVideoAcceleration")
return ret
@property
def recommended3_d_acceleration(self):
"""Get bool value for 'recommended3DAcceleration'
Returns @c true if 3D acceleration is recommended for this OS type.
"""
ret = self._get_attr("recommended3DAcceleration")
return ret
@property
def recommended_hdd(self):
"""Get int value for 'recommendedHDD'
Recommended hard disk size in bytes.
"""
ret = self._get_attr("recommendedHDD")
return ret
@property
def adapter_type(self):
"""Get NetworkAdapterType value for 'adapterType'
Returns recommended network adapter for this OS type.
"""
ret = self._get_attr("adapterType")
return NetworkAdapterType(ret)
@property
def recommended_pae(self):
"""Get bool value for 'recommendedPAE'
Returns @c true if using PAE is recommended for this OS type.
"""
ret = self._get_attr("recommendedPAE")
return ret
@property
def recommended_dvd_storage_controller(self):
"""Get StorageControllerType value for 'recommendedDVDStorageController'
Recommended storage controller type for DVD/CD drives.
"""
ret = self._get_attr("recommendedDVDStorageController")
return StorageControllerType(ret)
@property
def recommended_dvd_storage_bus(self):
"""Get StorageBus value for 'recommendedDVDStorageBus'
Recommended storage bus type for DVD/CD drives.
"""
ret = self._get_attr("recommendedDVDStorageBus")
return StorageBus(ret)
@property
def recommended_hd_storage_controller(self):
"""Get StorageControllerType value for 'recommendedHDStorageController'
Recommended storage controller type for HD drives.
"""
ret = self._get_attr("recommendedHDStorageController")
return StorageControllerType(ret)
@property
def recommended_hd_storage_bus(self):
"""Get StorageBus value for 'recommendedHDStorageBus'
Recommended storage bus type for HD drives.
"""
ret = self._get_attr("recommendedHDStorageBus")
return StorageBus(ret)
@property
def recommended_firmware(self):
"""Get FirmwareType value for 'recommendedFirmware'
Recommended firmware type.
"""
ret = self._get_attr("recommendedFirmware")
return FirmwareType(ret)
@property
def recommended_usbhid(self):
"""Get bool value for 'recommendedUSBHID'
Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.
"""
ret = self._get_attr("recommendedUSBHID")
return ret
@property
def recommended_hpet(self):
"""Get bool value for 'recommendedHPET'
Returns @c true if using HPET is recommended for this OS type.
"""
ret = self._get_attr("recommendedHPET")
return ret
@property
def recommended_usb_tablet(self):
"""Get bool value for 'recommendedUSBTablet'
Returns @c true if using a USB Tablet is recommended.
"""
ret = self._get_attr("recommendedUSBTablet")
return ret
@property
def recommended_rtc_use_utc(self):
"""Get bool value for 'recommendedRTCUseUTC'
Returns @c true if the RTC of this VM should be set to UTC
"""
ret = self._get_attr("recommendedRTCUseUTC")
return ret
@property
def recommended_chipset(self):
"""Get ChipsetType value for 'recommendedChipset'
Recommended chipset type.
"""
ret = self._get_attr("recommendedChipset")
return ChipsetType(ret)
@property
def recommended_audio_controller(self):
"""Get AudioControllerType value for 'recommendedAudioController'
Recommended audio controller type.
"""
ret = self._get_attr("recommendedAudioController")
return AudioControllerType(ret)
@property
def recommended_audio_codec(self):
"""Get AudioCodecType value for 'recommendedAudioCodec'
Recommended audio codec type.
"""
ret = self._get_attr("recommendedAudioCodec")
return AudioCodecType(ret)
@property
def recommended_floppy(self):
"""Get bool value for 'recommendedFloppy'
Returns @c true a floppy drive is recommended for this OS type.
"""
ret = self._get_attr("recommendedFloppy")
return ret
@property
def recommended_usb(self):
"""Get bool value for 'recommendedUSB'
Returns @c true a USB controller is recommended for this OS type.
"""
ret = self._get_attr("recommendedUSB")
return ret
@property
def recommended_usb3(self):
"""Get bool value for 'recommendedUSB3'
Returns @c true an xHCI (USB 3) controller is recommended for this OS type.
"""
ret = self._get_attr("recommendedUSB3")
return ret
@property
def recommended_tf_reset(self):
"""Get bool value for 'recommendedTFReset'
Returns @c true if using VCPU reset on triple fault is recommended for this OS type.
"""
ret = self._get_attr("recommendedTFReset")
return ret
@property
def recommended_x2_apic(self):
"""Get bool value for 'recommendedX2APIC'
Returns @c true if X2APIC is recommended for this OS type.
"""
ret = self._get_attr("recommendedX2APIC")
return ret
[docs]class IAdditionsFacility(Interface):
"""
Structure representing a Guest Additions facility.
"""
__uuid__ = 'f2f7fae4-4a06-81fc-a916-78b2da1fa0e5'
__wsmap__ = 'struct'
@property
def class_type(self):
"""Get AdditionsFacilityClass value for 'classType'
The class this facility is part of.
"""
ret = self._get_attr("classType")
return AdditionsFacilityClass(ret)
@property
def last_updated(self):
"""Get int value for 'lastUpdated'
Time stamp of the last status update,
in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("lastUpdated")
return ret
@property
def name(self):
"""Get str value for 'name'
The facility's friendly name.
"""
ret = self._get_attr("name")
return ret
@property
def status(self):
"""Get AdditionsFacilityStatus value for 'status'
The current status.
"""
ret = self._get_attr("status")
return AdditionsFacilityStatus(ret)
@property
def type_p(self):
"""Get AdditionsFacilityType value for 'type'
The facility's type ID.
"""
ret = self._get_attr("type")
return AdditionsFacilityType(ret)
[docs]class IDnDBase(Interface):
"""
Base abstract interface for drag'n drop.
"""
__uuid__ = '4132147b-42f8-cd96-7570-6a8800e3342c'
__wsmap__ = 'managed'
@property
def formats(self):
"""Get str value for 'formats'
Returns all supported drag'n drop formats.
"""
ret = self._get_attr("formats")
return ret
@property
def protocol_version(self):
"""Get int value for 'protocolVersion'
Returns the protocol version which is used to communicate
with the guest.
"""
ret = self._get_attr("protocolVersion")
return ret
[docs]class IDnDSource(IDnDBase):
"""
Abstract interface for handling drag'n drop sources.
"""
__uuid__ = 'd23a9ca3-42da-c94b-8aec-21968e08355d'
__wsmap__ = 'managed'
[docs] def drag_is_pending(self, screen_id):
"""Ask the source if there is any drag and drop operation pending.
If no drag and drop operation is pending currently, DnDAction_Ignore is returned.
in screen_id of type int
The screen ID where the drag and drop event occurred.
out formats of type str
On return the supported mime types.
out allowed_actions of type :class:`DnDAction`
On return the actions which are allowed.
return default_action of type :class:`DnDAction`
On return the default action to use.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(default_action, formats, allowed_actions) = self._call("dragIsPending",
in_p=[screen_id])
default_action = DnDAction(default_action)
allowed_actions = [DnDAction(a) for a in allowed_actions]
return (default_action, formats, allowed_actions)
[docs] def drop(self, format_p, action):
"""Informs the source that a drop event occurred for a pending
drag and drop operation.
in format_p of type str
The mime type the data must be in.
in action of type :class:`DnDAction`
The action to use.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(action, DnDAction):
raise TypeError("action can only be an instance of type DnDAction")
progress = self._call("drop",
in_p=[format_p, action])
progress = IProgress(progress)
return progress
[docs] def receive_data(self):
"""Receive the data of a previously drag and drop event from the source.
return data of type str
The actual data.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
data = self._call("receiveData")
return data
[docs]class IGuestDnDSource(IDnDSource):
"""
Implementation of the :py:class:`IDnDSource` object
for source drag'n drop operations on the guest.
"""
__uuid__ = 'dedfb5d9-4c1b-edf7-fdf3-c1be6827dc28'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IDnDTarget(IDnDBase):
"""
Abstract interface for handling drag'n drop targets.
"""
__uuid__ = 'ff5befc3-4ba3-7903-2aa4-43988ba11554'
__wsmap__ = 'managed'
[docs] def enter(self, screen_id, y, x, default_action, allowed_actions, formats):
"""Informs the target about a drag and drop enter event.
in screen_id of type int
The screen ID where the drag and drop event occurred.
in y of type int
Y-position of the event.
in x of type int
X-position of the event.
in default_action of type :class:`DnDAction`
The default action to use.
in allowed_actions of type :class:`DnDAction`
The actions which are allowed.
in formats of type str
The supported MIME types.
return result_action of type :class:`DnDAction`
The resulting action of this event.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(default_action, DnDAction):
raise TypeError("default_action can only be an instance of type DnDAction")
if not isinstance(allowed_actions, list):
raise TypeError("allowed_actions can only be an instance of type list")
for a in allowed_actions[:10]:
if not isinstance(a, DnDAction):
raise TypeError(\
"array can only contain objects of type DnDAction")
if not isinstance(formats, list):
raise TypeError("formats can only be an instance of type list")
for a in formats[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
result_action = self._call("enter",
in_p=[screen_id, y, x, default_action, allowed_actions, formats])
result_action = DnDAction(result_action)
return result_action
[docs] def move(self, screen_id, x, y, default_action, allowed_actions, formats):
"""Informs the target about a drag and drop move event.
in screen_id of type int
The screen ID where the drag and drop event occurred.
in x of type int
X-position of the event.
in y of type int
Y-position of the event.
in default_action of type :class:`DnDAction`
The default action to use.
in allowed_actions of type :class:`DnDAction`
The actions which are allowed.
in formats of type str
The supported MIME types.
return result_action of type :class:`DnDAction`
The resulting action of this event.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(default_action, DnDAction):
raise TypeError("default_action can only be an instance of type DnDAction")
if not isinstance(allowed_actions, list):
raise TypeError("allowed_actions can only be an instance of type list")
for a in allowed_actions[:10]:
if not isinstance(a, DnDAction):
raise TypeError(\
"array can only contain objects of type DnDAction")
if not isinstance(formats, list):
raise TypeError("formats can only be an instance of type list")
for a in formats[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
result_action = self._call("move",
in_p=[screen_id, x, y, default_action, allowed_actions, formats])
result_action = DnDAction(result_action)
return result_action
[docs] def leave(self, screen_id):
"""Informs the target about a drag and drop leave event.
in screen_id of type int
The screen ID where the drag and drop event occurred.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
self._call("leave",
in_p=[screen_id])
[docs] def drop(self, screen_id, x, y, default_action, allowed_actions, formats):
"""Informs the target about a drop event.
in screen_id of type int
The screen ID where the Drag and Drop event occurred.
in x of type int
X-position of the event.
in y of type int
Y-position of the event.
in default_action of type :class:`DnDAction`
The default action to use.
in allowed_actions of type :class:`DnDAction`
The actions which are allowed.
in formats of type str
The supported MIME types.
out format_p of type str
The resulting format of this event.
return result_action of type :class:`DnDAction`
The resulting action of this event.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(default_action, DnDAction):
raise TypeError("default_action can only be an instance of type DnDAction")
if not isinstance(allowed_actions, list):
raise TypeError("allowed_actions can only be an instance of type list")
for a in allowed_actions[:10]:
if not isinstance(a, DnDAction):
raise TypeError(\
"array can only contain objects of type DnDAction")
if not isinstance(formats, list):
raise TypeError("formats can only be an instance of type list")
for a in formats[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
(result_action, format_p) = self._call("drop",
in_p=[screen_id, x, y, default_action, allowed_actions, formats])
result_action = DnDAction(result_action)
return (result_action, format_p)
[docs] def send_data(self, screen_id, format_p, data):
"""Initiates sending data to the target.
in screen_id of type int
The screen ID where the drag and drop event occurred.
in format_p of type str
The MIME type the data is in.
in data of type str
The actual data.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
progress = self._call("sendData",
in_p=[screen_id, format_p, data])
progress = IProgress(progress)
return progress
[docs] def cancel(self):
"""Requests cancelling the current operation. The target can veto
the request in case the operation is not cancelable at the moment.
return veto of type bool
Whether the target has vetoed cancelling the operation.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
veto = self._call("cancel")
return veto
[docs]class IGuestDnDTarget(IDnDTarget):
"""
Implementation of the :py:class:`IDnDTarget` object
for target drag'n drop operations on the guest.
"""
__uuid__ = '50ce4b51-0ff7-46b7-a138-3c6e5ac946b4'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
class IGuestSession(Interface):
"""
A guest session represents one impersonated user account in the guest, so
every operation will use the same credentials specified when creating
the session object via :py:func:`IGuest.create_session` .
There can be a maximum of 32 sessions at once per VM, whereas session 0
is reserved for the root session.
<!-- r=bird: Is the root session part of the maximum of 32?? Not really clear. -->
This root session is controlling all other guest sessions and also is
responsible for actions which require system level privileges.
Each guest session keeps track of the guest directories and files that
it opened as well as guest processes it has created. To work on guest
files or directories a guest session offers methods to open or create
such objects (see :py:func:`IGuestSession.file_open` or
:py:func:`IGuestSession.directory_open` for instance). Similarly,
there a methods for creating guest processes.
There can be up to 2048 objects (guest processes, files and directories)
a time per guest session. Exceeding the limit will result in an error.
<!-- @todo r=bird: Add specific VBOX_E_XXX error for this and document it here! -->
When done with either of these objects, including the guest session itself,
use the appropriate close() method to let the object do its cleanup work.
Closing a session via :py:func:`IGuestSession.close` will try to close
all the mentioned objects above unless these objects are still used by
a client.
A set of environment variables changes is associated with each session
(:py:func:`IGuestSession.environment_changes` ). These are applied to
the base environment of the impersonated guest user when creating a new
guest process. For additional flexibility the :py:func:`IGuestSession.process_create`
and :py:func:`IGuestSession.process_create_ex` methods allows you to
specify individual environment changes for each process you create.
With newer guest addition versions, the base environment is also made
available via :py:func:`IGuestSession.environment_base` . (One reason
for why we record changes to a base environment instead of working
directly on an environment block is that we need to be compatible
with older guest additions. Another reason is that this way it is always
possible to undo all the changes you've scheduled.)
"""
__uuid__ = '486fd828-4c6b-239b-a846-c4bb69e41038'
__wsmap__ = 'managed'
@property
def user(self):
"""Get str value for 'user'
Returns the user name used by this session to impersonate
users in the guest.
"""
ret = self._get_attr("user")
return ret
@property
def domain(self):
"""Get str value for 'domain'
Returns the domain name used by this session to impersonate
users in the guest.
"""
ret = self._get_attr("domain")
return ret
@property
def name(self):
"""Get str value for 'name'
Returns the session's friendly name.
"""
ret = self._get_attr("name")
return ret
@property
def id_p(self):
"""Get int value for 'id'
Returns the internal session ID.
"""
ret = self._get_attr("id")
return ret
@property
def timeout(self):
"""Get or set int value for 'timeout'
<!-- r=bird: Using 'Returns' for writable attributes is misleading. -->
Returns the session timeout (in ms).
"""
ret = self._get_attr("timeout")
return ret
@timeout.setter
def timeout(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("timeout", value)
@property
def protocol_version(self):
"""Get int value for 'protocolVersion'
Returns the protocol version which is used by this session to
communicate with the guest.
"""
ret = self._get_attr("protocolVersion")
return ret
@property
def status(self):
"""Get GuestSessionStatus value for 'status'
Returns the current session status.
"""
ret = self._get_attr("status")
return GuestSessionStatus(ret)
@property
def environment_changes(self):
"""Get or set str value for 'environmentChanges'
The set of scheduled environment changes to the base environment of the
session. They are in putenv format, i.e. "VAR=VALUE" for setting and
"VAR" for unsetting. One entry per variable (change). The changes are
applied when creating new guest processes.
This is writable, so to undo all the scheduled changes, assign it an
empty array.
"""
ret = self._get_attr("environmentChanges")
return ret
@environment_changes.setter
def environment_changes(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("environmentChanges", value)
@property
def environment_base(self):
"""Get str value for 'environmentBase'
The base environment of the session. They are on the "VAR=VALUE" form,
one array entry per variable.
<!-- @todo/TODO/FIXME: This doesn't end up in the PDF.
-->
Access fails with VBOX_E_NOT_SUPPORTED if the guest additions does not
support the session base environment feature. Support for this was
introduced with protocol version XXXX.
Access fails with VBOX_E_INVALID_OBJECT_STATE if the guest additions
has yet to report the session base environment.
"""
ret = self._get_attr("environmentBase")
return ret
@property
def processes(self):
"""Get IGuestProcess value for 'processes'
Returns all current guest processes.
"""
ret = self._get_attr("processes")
return [IGuestProcess(a) for a in ret]
@property
def path_style(self):
"""Get PathStyle value for 'pathStyle'
The style of paths used by the guest. Handy for giving the right kind
of path specifications to :py:func:`IGuestSession.file_open` and similar methods.
"""
ret = self._get_attr("pathStyle")
return PathStyle(ret)
@property
def current_directory(self):
"""Get or set str value for 'currentDirectory'
The current directory of the session. Guest path style.
"""
ret = self._get_attr("currentDirectory")
return ret
@current_directory.setter
def current_directory(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("currentDirectory", value)
@property
def directories(self):
"""Get IGuestDirectory value for 'directories'
Returns all currently opened guest directories.
"""
ret = self._get_attr("directories")
return [IGuestDirectory(a) for a in ret]
@property
def files(self):
"""Get IGuestFile value for 'files'
Returns all currently opened guest files.
"""
ret = self._get_attr("files")
return [IGuestFile(a) for a in ret]
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for guest session events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
[docs] def close(self):
"""Closes this session. All opened guest directories, files and
processes which are not referenced by clients anymore will be
closed. Guest processes which fall into this category and still
are running in the guest will be terminated automatically.
"""
self._call("close")
[docs] def directory_copy(self, source, destination, flags):
"""Recursively copies a directory from one guest location to another.
in source of type str
The path to the directory to copy (in the guest). Guest path style.
in destination of type str
The path to the target directory (in the guest). Unless the
:py:attr:`DirectoryCopyFlags.copy_into_existing` flag is given, the
directory shall not already exist. Guest path style.
in flags of type :class:`DirectoryCopyFlags`
Zero or more :py:class:`DirectoryCopyFlags` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`OleErrorNotimpl`
Not yet implemented.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryCopyFlags):
raise TypeError(\
"array can only contain objects of type DirectoryCopyFlags")
progress = self._call("directoryCopy",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def directory_copy_from_guest(self, source, destination, flags):
"""Recursively copies a directory from the guest to the host.
in source of type str
Path to the directory on the guest side that should be copied to
the host. Guest path style.
in destination of type str
Where to put the directory on the host. Unless the
:py:attr:`DirectoryCopyFlags.copy_into_existing` flag is given, the
directory shall not already exist. Host path style.
in flags of type :class:`DirectoryCopyFlags`
Zero or more :py:class:`DirectoryCopyFlags` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`OleErrorNotimpl`
Not yet implemented.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryCopyFlags):
raise TypeError(\
"array can only contain objects of type DirectoryCopyFlags")
progress = self._call("directoryCopyFromGuest",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def directory_copy_to_guest(self, source, destination, flags):
"""Recursively copies a directory from the host to the guest.
in source of type str
Path to the directory on the host side that should be copied to
the guest. Host path style.
in destination of type str
Where to put the file in the guest. Unless the
:py:attr:`DirectoryCopyFlags.copy_into_existing` flag is given, the
directory shall not already exist. Guest style path.
in flags of type :class:`DirectoryCopyFlags`
Zero or more :py:class:`DirectoryCopyFlags` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`OleErrorNotimpl`
Not yet implemented.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryCopyFlags):
raise TypeError(\
"array can only contain objects of type DirectoryCopyFlags")
progress = self._call("directoryCopyToGuest",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def directory_create(self, path, mode, flags):
"""Creates a directory in the guest.
in path of type str
Path to the directory directory to be created. Guest path style.
in mode of type int
The UNIX-style access mode mask to create the directory with.
Whether/how all three access groups and associated access rights are
realized is guest OS dependent. The API does the best it can on each
OS.
in flags of type :class:`DirectoryCreateFlag`
Zero or more :py:class:`DirectoryCreateFlag` flags.
raises :class:`VBoxErrorIprtError`
Error while creating the directory.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryCreateFlag):
raise TypeError(\
"array can only contain objects of type DirectoryCreateFlag")
self._call("directoryCreate",
in_p=[path, mode, flags])
[docs] def directory_create_temp(self, template_name, mode, path, secure):
"""Creates a temporary directory in the guest.
in template_name of type str
Template for the name of the directory to create. This must
contain at least one 'X' character. The first group of consecutive
'X' characters in the template will be replaced by a random
alphanumeric string to produce a unique name.
in mode of type int
The UNIX-style access mode mask to create the directory with.
Whether/how all three access groups and associated access rights are
realized is guest OS dependent. The API does the best it can on each
OS.
This parameter is ignore if the @a secure parameter is set to @c true.
It is strongly recommended to use 0700.
in path of type str
The path to the directory in which the temporary directory should
be created. Guest path style.
in secure of type bool
Whether to fail if the directory can not be securely created.
Currently this means that another unprivileged user cannot
manipulate the path specified or remove the temporary directory
after it has been created. Also causes the mode specified to be
ignored. May not be supported on all guest types.
return directory of type str
On success this will contain the full path to the created
directory. Guest path style.
raises :class:`VBoxErrorNotSupported`
The operation is not possible as requested on this particular
guest type.
raises :class:`OleErrorInvalidarg`
Invalid argument. This includes an incorrectly formatted template,
or a non-absolute path.
raises :class:`VBoxErrorIprtError`
The temporary directory could not be created. Possible reasons
include a non-existing path or an insecure path when the secure
option was requested.
"""
if not isinstance(template_name, basestring):
raise TypeError("template_name can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(secure, bool):
raise TypeError("secure can only be an instance of type bool")
directory = self._call("directoryCreateTemp",
in_p=[template_name, mode, path, secure])
return directory
def directory_exists(self, path, follow_symlinks):
"""Checks whether a directory exists in the guest or not.
in path of type str
Path to the directory to check if exists. Guest path style.
in follow_symlinks of type bool
If @c true, symbolic links in the final component will be followed
and the existance of the symlink target made the question for this method.
If @c false, a symbolic link in the final component will make the
method return @c false (because a symlink isn't a directory).
return exists of type bool
Returns @c true if the directory exists, @c false if not.
raises :class:`VBoxErrorIprtError`
Error while checking existence of the directory specified.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
exists = self._call("directoryExists",
in_p=[path, follow_symlinks])
return exists
[docs] def directory_open(self, path, filter_p, flags):
"""Opens a directory in the guest and creates a :py:class:`IGuestDirectory`
object that can be used for further operations.
This method follows symbolic links by default at the moment, this
may change in the future.
in path of type str
Path to the directory to open. Guest path style.
in filter_p of type str
Optional directory listing filter to apply. This uses the DOS/NT
style wildcard characters '?' and '*'.
in flags of type :class:`DirectoryOpenFlag`
Zero or more :py:class:`DirectoryOpenFlag` flags.
return directory of type :class:`IGuestDirectory`
:py:class:`IGuestDirectory` object containing the opened directory.
raises :class:`VBoxErrorObjectNotFound`
Directory to open was not found.
raises :class:`VBoxErrorIprtError`
Error while opening the directory.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(filter_p, basestring):
raise TypeError("filter_p can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryOpenFlag):
raise TypeError(\
"array can only contain objects of type DirectoryOpenFlag")
directory = self._call("directoryOpen",
in_p=[path, filter_p, flags])
directory = IGuestDirectory(directory)
return directory
[docs] def directory_remove(self, path):
"""Removes a guest directory if empty.
Symbolic links in the final component will not be followed,
instead an not-a-directory error is reported.
in path of type str
Path to the directory that should be removed. Guest path style.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
self._call("directoryRemove",
in_p=[path])
def directory_remove_recursive(self, path, flags):
"""Removes a guest directory recursively.
<!-- Add this back when the warning can be removed:
Unless :py:attr:`DirectoryRemoveRecFlag.content_and_dir` or
:py:attr:`DirectoryRemoveRecFlag.content_only` is given, only the
directory structure is removed. Which means it will fail if there are
directories which are not empty in the directory tree @a path points to.
-->
WARNING!! THE FLAGS ARE NOT CURRENTLY IMPLEMENTED. THE IMPLEMENTATION
WORKS AS IF FLAGS WAS SET TO :py:attr:`DirectoryRemoveRecFlag.content_and_dir` .
If the final path component is a symbolic link, this method will
fail as it can only be applied to directories.
in path of type str
Path of the directory that is to be removed recursively. Guest
path style.
in flags of type :class:`DirectoryRemoveRecFlag`
Zero or more :py:class:`DirectoryRemoveRecFlag` flags.
WARNING! SPECIFYING :py:attr:`DirectoryRemoveRecFlag.content_and_dir` IS
MANDATORY AT THE MOMENT!!
return progress of type :class:`IProgress`
Progress object to track the operation completion. This is not implemented
yet and therefore this method call will block until deletion is completed.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryRemoveRecFlag):
raise TypeError(\
"array can only contain objects of type DirectoryRemoveRecFlag")
progress = self._call("directoryRemoveRecursive",
in_p=[path, flags])
progress = IProgress(progress)
return progress
[docs] def environment_schedule_set(self, name, value):
"""Schedules setting an environment variable when creating the next guest
process. This affects the :py:func:`IGuestSession.environment_changes`
attribute.
in name of type str
Name of the environment variable to set. This cannot be empty
nor can it contain any equal signs.
in value of type str
Value to set the session environment variable to.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("environmentScheduleSet",
in_p=[name, value])
[docs] def environment_schedule_unset(self, name):
"""Schedules unsetting (removing) an environment variable when creating
the next guest process. This affects the
:py:func:`IGuestSession.environment_changes` attribute.
in name of type str
Name of the environment variable to unset. This cannot be empty
nor can it contain any equal signs.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("environmentScheduleUnset",
in_p=[name])
[docs] def environment_get_base_variable(self, name):
"""Gets an environment variable from the session's base environment
(:py:func:`IGuestSession.environment_base` ).
in name of type str
Name of the environment variable to get.This cannot be empty
nor can it contain any equal signs.
return value of type str
The value of the variable. Empty if not found. To deal with
variables that may have empty values, use
:py:func:`IGuestSession.environment_does_base_variable_exist` .
raises :class:`VBoxErrorNotSupported`
If the guest additions does not
support the session base environment feature. Support for this was
introduced with protocol version XXXX.
raises :class:`VBoxErrorInvalidObjectState`
If the guest additions has
yet to report the session base environment.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
value = self._call("environmentGetBaseVariable",
in_p=[name])
return value
[docs] def environment_does_base_variable_exist(self, name):
"""Checks if the given environment variable exists in the session's base
environment (:py:func:`IGuestSession.environment_base` ).
in name of type str
Name of the environment variable to look for. This cannot be
empty nor can it contain any equal signs.
return exists of type bool
TRUE if the variable exists, FALSE if not.
raises :class:`VBoxErrorNotSupported`
If the guest additions does not
support the session base environment feature. Support for this was
introduced with protocol version XXXX.
raises :class:`VBoxErrorInvalidObjectState`
If the guest additions has
yet to report the session base environment.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
exists = self._call("environmentDoesBaseVariableExist",
in_p=[name])
return exists
[docs] def file_copy(self, source, destination, flags):
"""Copies a file from one guest location to another.
Will overwrite the destination file unless
:py:attr:`FileCopyFlag.no_replace` is specified.
in source of type str
The path to the file to copy (in the guest). Guest path style.
in destination of type str
The path to the target file (in the guest). This cannot be a
directory. Guest path style.
in flags of type :class:`FileCopyFlag`
Zero or more :py:class:`FileCopyFlag` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`OleErrorNotimpl`
Not yet implemented.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FileCopyFlag):
raise TypeError(\
"array can only contain objects of type FileCopyFlag")
progress = self._call("fileCopy",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def file_copy_from_guest(self, source, destination, flags):
"""Copies a file from the guest to the host.
Will overwrite the destination file unless
:py:attr:`FileCopyFlag.no_replace` is specified.
in source of type str
Path to the file on the guest side that should be copied to the
host. Guest path style.
in destination of type str
Where to put the file on the host (file, not directory). Host
path style.
in flags of type :class:`FileCopyFlag`
Zero or more :py:class:`FileCopyFlag` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`VBoxErrorIprtError`
Error starting the copy operation.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FileCopyFlag):
raise TypeError(\
"array can only contain objects of type FileCopyFlag")
progress = self._call("fileCopyFromGuest",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def file_copy_to_guest(self, source, destination, flags):
"""Copies a file from the host to the guest.
Will overwrite the destination file unless
:py:attr:`FileCopyFlag.no_replace` is specified.
in source of type str
Path to the file on the host side that should be copied to the
guest. Host path style.
in destination of type str
Where to put the file in the guest (file, not directory). Guest
style path.
in flags of type :class:`FileCopyFlag`
Zero or more :py:class:`FileCopyFlag` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`VBoxErrorIprtError`
Error starting the copy operation.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FileCopyFlag):
raise TypeError(\
"array can only contain objects of type FileCopyFlag")
progress = self._call("fileCopyToGuest",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def file_create_temp(self, template_name, mode, path, secure):
"""Creates a temporary file in the guest.
in template_name of type str
Template for the name of the file to create. This must contain
at least one 'X' character. The first group of consecutive 'X'
characters in the template will be replaced by a random
alphanumeric string to produce a unique name.
in mode of type int
The UNIX-style access mode mask to create the file with.
Whether/how all three access groups and associated access rights are
realized is guest OS dependent. The API does the best it can on each
OS.
This parameter is ignore if the @a secure parameter is set to @c true.
It is strongly recommended to use 0600.
in path of type str
The path to the directory in which the temporary file should be
created.
in secure of type bool
Whether to fail if the file can not be securely created.
Currently this means that another unprivileged user cannot
manipulate the path specified or remove the temporary file after
it has been created. Also causes the mode specified to be ignored.
May not be supported on all guest types.
return file_p of type :class:`IGuestFile`
On success this will contain an open file object for the new
temporary file.
raises :class:`VBoxErrorNotSupported`
The operation is not possible as requested on this particular
guest OS.
raises :class:`OleErrorInvalidarg`
Invalid argument. This includes an incorrectly formatted template,
or a non-absolute path.
raises :class:`VBoxErrorIprtError`
The temporary file could not be created. Possible reasons include
a non-existing path or an insecure path when the secure
option was requested.
"""
if not isinstance(template_name, basestring):
raise TypeError("template_name can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(secure, bool):
raise TypeError("secure can only be an instance of type bool")
file_p = self._call("fileCreateTemp",
in_p=[template_name, mode, path, secure])
file_p = IGuestFile(file_p)
return file_p
def file_exists(self, path, follow_symlinks):
"""Checks whether a regular file exists in the guest or not.
in path of type str
Path to the alleged regular file. Guest path style.
in follow_symlinks of type bool
If @c true, symbolic links in the final component will be followed
and the existance of the symlink target made the question for this method.
If @c false, a symbolic link in the final component will make the
method return @c false (because a symlink isn't a regular file).
return exists of type bool
Returns @c true if the file exists, @c false if not. @c false is
also return if this @a path does not point to a file object.
raises :class:`VBoxErrorIprtError`
Error while checking existence of the file specified.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
exists = self._call("fileExists",
in_p=[path, follow_symlinks])
return exists
[docs] def file_open(self, path, access_mode, open_action, creation_mode):
"""Opens a file and creates a :py:class:`IGuestFile` object that
can be used for further operations.
in path of type str
Path to file to open. Guest path style.
in access_mode of type :class:`FileAccessMode`
The file access mode (read, write and/or append).
See :py:class:`FileAccessMode` for details.
in open_action of type :class:`FileOpenAction`
What action to take depending on whether the file exists or not.
See :py:class:`FileOpenAction` for details.
in creation_mode of type int
The UNIX-style access mode mask to create the file with if @a openAction
requested the file to be created (otherwise ignored). Whether/how all
three access groups and associated access rights are realized is guest
OS dependent. The API does the best it can on each OS.
return file_p of type :class:`IGuestFile`
:py:class:`IGuestFile` object representing the opened file.
raises :class:`VBoxErrorObjectNotFound`
File to open was not found.
raises :class:`VBoxErrorIprtError`
Error while opening the file.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(access_mode, FileAccessMode):
raise TypeError("access_mode can only be an instance of type FileAccessMode")
if not isinstance(open_action, FileOpenAction):
raise TypeError("open_action can only be an instance of type FileOpenAction")
if not isinstance(creation_mode, baseinteger):
raise TypeError("creation_mode can only be an instance of type baseinteger")
file_p = self._call("fileOpen",
in_p=[path, access_mode, open_action, creation_mode])
file_p = IGuestFile(file_p)
return file_p
[docs] def file_open_ex(self, path, access_mode, open_action, sharing_mode, creation_mode, flags):
"""Opens a file and creates a :py:class:`IGuestFile` object that
can be used for further operations, extended version.
in path of type str
Path to file to open. Guest path style.
in access_mode of type :class:`FileAccessMode`
The file access mode (read, write and/or append).
See :py:class:`FileAccessMode` for details.
in open_action of type :class:`FileOpenAction`
What action to take depending on whether the file exists or not.
See :py:class:`FileOpenAction` for details.
in sharing_mode of type :class:`FileSharingMode`
The file sharing mode in the guest. This parameter is currently
ignore for all guest OSes. It will in the future be implemented for
Windows, OS/2 and maybe Solaris guests only, the others will ignore it.
Use :py:attr:`FileSharingMode.all_p` .
in creation_mode of type int
The UNIX-style access mode mask to create the file with if @a openAction
requested the file to be created (otherwise ignored). Whether/how all
three access groups and associated access rights are realized is guest
OS dependent. The API does the best it can on each OS.
in flags of type :class:`FileOpenExFlags`
Zero or more :py:class:`FileOpenExFlags` values.
return file_p of type :class:`IGuestFile`
:py:class:`IGuestFile` object representing the opened file.
raises :class:`VBoxErrorObjectNotFound`
File to open was not found.
raises :class:`VBoxErrorIprtError`
Error while opening the file.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(access_mode, FileAccessMode):
raise TypeError("access_mode can only be an instance of type FileAccessMode")
if not isinstance(open_action, FileOpenAction):
raise TypeError("open_action can only be an instance of type FileOpenAction")
if not isinstance(sharing_mode, FileSharingMode):
raise TypeError("sharing_mode can only be an instance of type FileSharingMode")
if not isinstance(creation_mode, baseinteger):
raise TypeError("creation_mode can only be an instance of type baseinteger")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FileOpenExFlags):
raise TypeError(\
"array can only contain objects of type FileOpenExFlags")
file_p = self._call("fileOpenEx",
in_p=[path, access_mode, open_action, sharing_mode, creation_mode, flags])
file_p = IGuestFile(file_p)
return file_p
[docs] def file_query_size(self, path, follow_symlinks):
"""Queries the size of a regular file in the guest.
in path of type str
Path to the file which size is requested. Guest path style.
in follow_symlinks of type bool
It @c true, symbolic links in the final path component will be
followed to their target, and the size of the target is returned.
If @c false, symbolic links in the final path component will make
the method call fail (symblink is not a regular file).
return size of type int
Queried file size.
raises :class:`VBoxErrorObjectNotFound`
File to was not found.
raises :class:`VBoxErrorIprtError`
Error querying file size.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
size = self._call("fileQuerySize",
in_p=[path, follow_symlinks])
return size
[docs] def fs_obj_exists(self, path, follow_symlinks):
"""Checks whether a file system object (file, directory, etc) exists in
the guest or not.
in path of type str
Path to the file system object to check the existance of. Guest
path style.
in follow_symlinks of type bool
If @c true, symbolic links in the final component will be followed
and the method will instead check if the target exists.
If @c false, symbolic links in the final component will satisfy the
method and it will return @c true in @a exists.
return exists of type bool
Returns @c true if the file exists, @c false if not.
raises :class:`VBoxErrorIprtError`
Error while checking existence of the file specified.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
exists = self._call("fsObjExists",
in_p=[path, follow_symlinks])
return exists
[docs] def fs_obj_query_info(self, path, follow_symlinks):
"""Queries information about a file system object (file, directory, etc)
in the guest.
in path of type str
Path to the file system object to gather information about.
Guest path style.
in follow_symlinks of type bool
Information about symbolic links is returned if @c false. Otherwise,
symbolic links are followed and the returned information concerns
itself with the symlink target if @c true.
return info of type :class:`IGuestFsObjInfo`
:py:class:`IGuestFsObjInfo` object containing the information.
raises :class:`VBoxErrorObjectNotFound`
The file system object was not found.
raises :class:`VBoxErrorIprtError`
Error while querying information.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
info = self._call("fsObjQueryInfo",
in_p=[path, follow_symlinks])
info = IGuestFsObjInfo(info)
return info
[docs] def fs_obj_remove(self, path):
"""Removes a file system object (file, symlink, etc) in the guest. Will
not work on directories, use :py:func:`IGuestSession.directory_remove`
to remove directories.
This method will remove symbolic links in the final path
component, not follow them.
in path of type str
Path to the file system object to remove. Guest style path.
raises :class:`OleErrorNotimpl`
The method has not been implemented yet.
raises :class:`VBoxErrorObjectNotFound`
The file system object was not found.
raises :class:`VBoxErrorIprtError`
For most other errors. We know this is unhelpful, will fix shortly...
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
self._call("fsObjRemove",
in_p=[path])
[docs] def fs_obj_rename(self, old_path, new_path, flags):
"""Renames a file system object (file, directory, symlink, etc) in the
guest.
in old_path of type str
The current path to the object. Guest path style.
in new_path of type str
The new path to the object. Guest path style.
in flags of type :class:`FsObjRenameFlag`
Zero or more :py:class:`FsObjRenameFlag` values.
raises :class:`VBoxErrorObjectNotFound`
The file system object was not found.
raises :class:`VBoxErrorIprtError`
For most other errors. We know this is unhelpful, will fix shortly...
"""
if not isinstance(old_path, basestring):
raise TypeError("old_path can only be an instance of type basestring")
if not isinstance(new_path, basestring):
raise TypeError("new_path can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FsObjRenameFlag):
raise TypeError(\
"array can only contain objects of type FsObjRenameFlag")
self._call("fsObjRename",
in_p=[old_path, new_path, flags])
[docs] def fs_obj_move(self, source, destination, flags):
"""Moves a file system object (file, directory, symlink, etc) from one
guest location to another.
This differs from :py:func:`IGuestSession.fs_obj_rename` in that it
can move accross file system boundraries. In that case it will
perform a copy and then delete the original. For directories, this
can take a while and is subject to races.
in source of type str
Path to the file to move. Guest path style.
in destination of type str
Where to move the file to (file, not directory). Guest path
style.
in flags of type :class:`FsObjMoveFlags`
Zero or more :py:class:`FsObjMoveFlags` values.
return progress of type :class:`IProgress`
Progress object to track the operation to completion.
raises :class:`OleErrorNotimpl`
Not yet implemented.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, FsObjMoveFlags):
raise TypeError(\
"array can only contain objects of type FsObjMoveFlags")
progress = self._call("fsObjMove",
in_p=[source, destination, flags])
progress = IProgress(progress)
return progress
[docs] def fs_obj_set_acl(self, path, follow_symlinks, acl, mode):
"""Sets the access control list (ACL) of a file system object (file,
directory, etc) in the guest.
in path of type str
Full path of the file system object which ACL to set
in follow_symlinks of type bool
If @c true symbolic links in the final component will be followed,
otherwise, if @c false, the method will work directly on a symbolic
link in the final component.
in acl of type str
The ACL specification string. To-be-defined.
in mode of type int
UNIX-style mode mask to use if @a acl is empty. As mention in
:py:func:`IGuestSession.directory_create` this is realized on
a best effort basis and the exact behavior depends on the Guest OS.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
if not isinstance(acl, basestring):
raise TypeError("acl can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
self._call("fsObjSetACL",
in_p=[path, follow_symlinks, acl, mode])
[docs] def process_create(self, executable, arguments, environment_changes, flags, timeout_ms):
"""Creates a new process running in the guest. The new process will be
started asynchronously, meaning on return of this function it is not
be guaranteed that the guest process is in a started state. To wait for
successful startup, use the :py:func:`IProcess.wait_for` call.
Starting at VirtualBox 4.2 guest process execution by is default limited
to serve up to 255 guest processes at a time. If all 255 guest processes
are active and running, creating a new guest process will result in an
error.
If ProcessCreateFlag_WaitForStdOut and/or ProcessCreateFlag_WaitForStdErr
are set, the guest process will not enter the terminated state until
all data from the specified streams have been read read.
in executable of type str
Full path to the file to execute in the guest. The file has to
exists in the guest VM with executable right to the session user in
order to succeed. If empty/null, the first entry in the
@a arguments array will be used instead (i.e. argv[0]).
in arguments of type str
Array of arguments passed to the new process.
Starting with VirtualBox 5.0 this array starts with argument 0
instead of argument 1 as in previous versions. Whether the zeroth
argument can be passed to the guest depends on the VBoxService
version running there. If you depend on this, check that the
:py:func:`IGuestSession.protocol_version` is 3 or higher.
in environment_changes of type str
Set of environment changes to complement
:py:func:`IGuestSession.environment_changes` . Takes precedence
over the session ones. The changes are in putenv format, i.e.
"VAR=VALUE" for setting and "VAR" for unsetting.
The changes are applied to the base environment of the impersonated
guest user (:py:func:`IGuestSession.environment_base` ) when
creating the process. (This is done on the guest side of things in
order to be compatible with older guest additions. That is one of
the motivations for not passing in the whole environment here.)
in flags of type :class:`ProcessCreateFlag`
Process creation flags;
see :py:class:`ProcessCreateFlag` for more information.
in timeout_ms of type int
Timeout (in ms) for limiting the guest process' running time.
Pass 0 for an infinite timeout. On timeout the guest process will be
killed and its status will be put to an appropriate value. See
:py:class:`ProcessStatus` for more information.
return guest_process of type :class:`IGuestProcess`
Guest process object of the newly created process.
raises :class:`VBoxErrorIprtError`
Error creating guest process.
"""
if not isinstance(executable, basestring):
raise TypeError("executable can only be an instance of type basestring")
if not isinstance(arguments, list):
raise TypeError("arguments can only be an instance of type list")
for a in arguments[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(environment_changes, list):
raise TypeError("environment_changes can only be an instance of type list")
for a in environment_changes[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, ProcessCreateFlag):
raise TypeError(\
"array can only contain objects of type ProcessCreateFlag")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
guest_process = self._call("processCreate",
in_p=[executable, arguments, environment_changes, flags, timeout_ms])
guest_process = IGuestProcess(guest_process)
return guest_process
[docs] def process_create_ex(self, executable, arguments, environment_changes, flags, timeout_ms, priority, affinity):
"""Creates a new process running in the guest with the extended options
for setting the process priority and affinity.
See :py:func:`IGuestSession.process_create` for more information.
in executable of type str
Full path to the file to execute in the guest. The file has to
exists in the guest VM with executable right to the session user in
order to succeed. If empty/null, the first entry in the
@a arguments array will be used instead (i.e. argv[0]).
in arguments of type str
Array of arguments passed to the new process.
Starting with VirtualBox 5.0 this array starts with argument 0
instead of argument 1 as in previous versions. Whether the zeroth
argument can be passed to the guest depends on the VBoxService
version running there. If you depend on this, check that the
:py:func:`IGuestSession.protocol_version` is 3 or higher.
in environment_changes of type str
Set of environment changes to complement
:py:func:`IGuestSession.environment_changes` . Takes precedence
over the session ones. The changes are in putenv format, i.e.
"VAR=VALUE" for setting and "VAR" for unsetting.
The changes are applied to the base environment of the impersonated
guest user (:py:func:`IGuestSession.environment_base` ) when
creating the process. (This is done on the guest side of things in
order to be compatible with older guest additions. That is one of
the motivations for not passing in the whole environment here.)
in flags of type :class:`ProcessCreateFlag`
Process creation flags, see :py:class:`ProcessCreateFlag` for
detailed description of available flags.
in timeout_ms of type int
Timeout (in ms) for limiting the guest process' running time.
Pass 0 for an infinite timeout. On timeout the guest process will be
killed and its status will be put to an appropriate value. See
:py:class:`ProcessStatus` for more information.
in priority of type :class:`ProcessPriority`
Process priority to use for execution, see :py:class:`ProcessPriority`
for available priority levels.
This is silently ignored if not supported by guest additions.
in affinity of type int
Processor affinity to set for the new process. This is a list of
guest CPU numbers the process is allowed to run on.
This is silently ignored if the guest does not support setting the
affinity of processes, or if the guest additions does not implemet
this feature.
return guest_process of type :class:`IGuestProcess`
Guest process object of the newly created process.
"""
if not isinstance(executable, basestring):
raise TypeError("executable can only be an instance of type basestring")
if not isinstance(arguments, list):
raise TypeError("arguments can only be an instance of type list")
for a in arguments[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(environment_changes, list):
raise TypeError("environment_changes can only be an instance of type list")
for a in environment_changes[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, ProcessCreateFlag):
raise TypeError(\
"array can only contain objects of type ProcessCreateFlag")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
if not isinstance(priority, ProcessPriority):
raise TypeError("priority can only be an instance of type ProcessPriority")
if not isinstance(affinity, list):
raise TypeError("affinity can only be an instance of type list")
for a in affinity[:10]:
if not isinstance(a, baseinteger):
raise TypeError(\
"array can only contain objects of type baseinteger")
guest_process = self._call("processCreateEx",
in_p=[executable, arguments, environment_changes, flags, timeout_ms, priority, affinity])
guest_process = IGuestProcess(guest_process)
return guest_process
[docs] def process_get(self, pid):
"""Gets a certain guest process by its process ID (PID).
in pid of type int
Process ID (PID) to get guest process for.
return guest_process of type :class:`IGuestProcess`
Guest process of specified process ID (PID).
"""
if not isinstance(pid, baseinteger):
raise TypeError("pid can only be an instance of type baseinteger")
guest_process = self._call("processGet",
in_p=[pid])
guest_process = IGuestProcess(guest_process)
return guest_process
[docs] def symlink_create(self, symlink, target, type_p):
"""Creates a symbolic link in the guest.
in symlink of type str
Path to the symbolic link that should be created. Guest path
style.
in target of type str
The path to the symbolic link target. If not an absolute, this will
be relative to the @a symlink location at access time. Guest path
style.
in type_p of type :class:`SymlinkType`
The symbolic link type (mainly for Windows). See :py:class:`SymlinkType`
for more information.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(symlink, basestring):
raise TypeError("symlink can only be an instance of type basestring")
if not isinstance(target, basestring):
raise TypeError("target can only be an instance of type basestring")
if not isinstance(type_p, SymlinkType):
raise TypeError("type_p can only be an instance of type SymlinkType")
self._call("symlinkCreate",
in_p=[symlink, target, type_p])
def symlink_exists(self, symlink):
"""Checks whether a symbolic link exists in the guest.
in symlink of type str
Path to the alleged symbolic link. Guest path style.
return exists of type bool
Returns @c true if the symbolic link exists. Returns @c false if it
does not exist, if the file system object identified by the path is
not a symbolic link, or if the object type is inaccessible to the
user, or if the @a symlink argument is empty.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(symlink, basestring):
raise TypeError("symlink can only be an instance of type basestring")
exists = self._call("symlinkExists",
in_p=[symlink])
return exists
[docs] def symlink_read(self, symlink, flags):
"""Reads the target value of a symbolic link in the guest.
in symlink of type str
Path to the symbolic link to read.
in flags of type :class:`SymlinkReadFlag`
Zero or more :py:class:`SymlinkReadFlag` values.
return target of type str
Target value of the symbolic link. Guest path style.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(symlink, basestring):
raise TypeError("symlink can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, SymlinkReadFlag):
raise TypeError(\
"array can only contain objects of type SymlinkReadFlag")
target = self._call("symlinkRead",
in_p=[symlink, flags])
return target
[docs] def wait_for(self, wait_for, timeout_ms):
"""Waits for one or more events to happen.
in wait_for of type int
Specifies what to wait for;
see :py:class:`GuestSessionWaitForFlag` for more information.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return reason of type :class:`GuestSessionWaitResult`
The overall wait result;
see :py:class:`GuestSessionWaitResult` for more information.
"""
if not isinstance(wait_for, baseinteger):
raise TypeError("wait_for can only be an instance of type baseinteger")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
reason = self._call("waitFor",
in_p=[wait_for, timeout_ms])
reason = GuestSessionWaitResult(reason)
return reason
[docs] def wait_for_array(self, wait_for, timeout_ms):
"""Waits for one or more events to happen.
Scriptable version of :py:func:`wait_for` .
in wait_for of type :class:`GuestSessionWaitForFlag`
Specifies what to wait for;
see :py:class:`GuestSessionWaitForFlag` for more information.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return reason of type :class:`GuestSessionWaitResult`
The overall wait result;
see :py:class:`GuestSessionWaitResult` for more information.
"""
if not isinstance(wait_for, list):
raise TypeError("wait_for can only be an instance of type list")
for a in wait_for[:10]:
if not isinstance(a, GuestSessionWaitForFlag):
raise TypeError(\
"array can only contain objects of type GuestSessionWaitForFlag")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
reason = self._call("waitForArray",
in_p=[wait_for, timeout_ms])
reason = GuestSessionWaitResult(reason)
return reason
class IProcess(Interface):
"""
Abstract parent interface for processes handled by VirtualBox.
"""
__uuid__ = '2e20707d-4325-9a83-83cf-3faf5b97457c'
__wsmap__ = 'managed'
@property
def arguments(self):
"""Get str value for 'arguments'
The arguments this process is using for execution.
"""
ret = self._get_attr("arguments")
return ret
@property
def environment(self):
"""Get str value for 'environment'
The initial process environment. Not yet implemented.
"""
ret = self._get_attr("environment")
return ret
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for process events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def executable_path(self):
"""Get str value for 'executablePath'
Full path of the actual executable image.
"""
ret = self._get_attr("executablePath")
return ret
@property
def exit_code(self):
"""Get int value for 'exitCode'
The exit code. Only available when the process has been
terminated normally.
"""
ret = self._get_attr("exitCode")
return ret
@property
def name(self):
"""Get str value for 'name'
The friendly name of this process.
"""
ret = self._get_attr("name")
return ret
@property
def pid(self):
"""Get int value for 'PID'
The process ID (PID).
"""
ret = self._get_attr("PID")
return ret
@property
def status(self):
"""Get ProcessStatus value for 'status'
The current process status; see :py:class:`ProcessStatus`
for more information.
"""
ret = self._get_attr("status")
return ProcessStatus(ret)
def wait_for(self, wait_for, timeout_ms):
"""Waits for one or more events to happen.
in wait_for of type int
Specifies what to wait for;
see :py:class:`ProcessWaitForFlag` for more information.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return reason of type :class:`ProcessWaitResult`
The overall wait result;
see :py:class:`ProcessWaitResult` for more information.
"""
if not isinstance(wait_for, baseinteger):
raise TypeError("wait_for can only be an instance of type baseinteger")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
reason = self._call("waitFor",
in_p=[wait_for, timeout_ms])
reason = ProcessWaitResult(reason)
return reason
[docs] def wait_for_array(self, wait_for, timeout_ms):
"""Waits for one or more events to happen.
Scriptable version of :py:func:`wait_for` .
in wait_for of type :class:`ProcessWaitForFlag`
Specifies what to wait for;
see :py:class:`ProcessWaitForFlag` for more information.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return reason of type :class:`ProcessWaitResult`
The overall wait result;
see :py:class:`ProcessWaitResult` for more information.
"""
if not isinstance(wait_for, list):
raise TypeError("wait_for can only be an instance of type list")
for a in wait_for[:10]:
if not isinstance(a, ProcessWaitForFlag):
raise TypeError(\
"array can only contain objects of type ProcessWaitForFlag")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
reason = self._call("waitForArray",
in_p=[wait_for, timeout_ms])
reason = ProcessWaitResult(reason)
return reason
[docs] def read(self, handle, to_read, timeout_ms):
"""Reads data from a running process.
in handle of type int
Handle to read from. Usually 0 is stdin.
in to_read of type int
Number of bytes to read.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return data of type str
Array of data read.
"""
if not isinstance(handle, baseinteger):
raise TypeError("handle can only be an instance of type baseinteger")
if not isinstance(to_read, baseinteger):
raise TypeError("to_read can only be an instance of type baseinteger")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
data = self._call("read",
in_p=[handle, to_read, timeout_ms])
return data
[docs] def write(self, handle, flags, data, timeout_ms):
"""Writes data to a running process.
in handle of type int
Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.
in flags of type int
A combination of :py:class:`ProcessInputFlag` flags.
in data of type str
Array of bytes to write. The size of the array also specifies
how much to write.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return written of type int
How much bytes were written.
"""
if not isinstance(handle, baseinteger):
raise TypeError("handle can only be an instance of type baseinteger")
if not isinstance(flags, baseinteger):
raise TypeError("flags can only be an instance of type baseinteger")
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
written = self._call("write",
in_p=[handle, flags, data, timeout_ms])
return written
[docs] def write_array(self, handle, flags, data, timeout_ms):
"""Writes data to a running process.
Scriptable version of :py:func:`write` .
in handle of type int
Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.
in flags of type :class:`ProcessInputFlag`
A combination of :py:class:`ProcessInputFlag` flags.
in data of type str
Array of bytes to write. The size of the array also specifies
how much to write.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return written of type int
How much bytes were written.
"""
if not isinstance(handle, baseinteger):
raise TypeError("handle can only be an instance of type baseinteger")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, ProcessInputFlag):
raise TypeError(\
"array can only contain objects of type ProcessInputFlag")
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
written = self._call("writeArray",
in_p=[handle, flags, data, timeout_ms])
return written
[docs] def terminate(self):
"""Terminates (kills) a running process.
It can take up to 30 seconds to get a guest process killed. In
case a guest process could not be killed an appropriate error is
returned.
"""
self._call("terminate")
class IGuestProcess(IProcess):
"""
Implementation of the :py:class:`IProcess` object
for processes the host has started in the guest.
"""
__uuid__ = '35cf4b3f-4453-4f3e-c9b8-5686939c80b6'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IDirectory(Interface):
"""
Abstract parent interface for directories handled by VirtualBox.
"""
__uuid__ = 'f73650f4-4506-50ca-045a-23a0e32ea508'
__wsmap__ = 'managed'
@property
def directory_name(self):
"""Get str value for 'directoryName'
The path specified when opening the directory.
"""
ret = self._get_attr("directoryName")
return ret
@property
def filter_p(self):
"""Get str value for 'filter'
Directory listing filter to (specified when opening the directory).
"""
ret = self._get_attr("filter")
return ret
[docs] def close(self):
"""Closes this directory. After closing operations like reading the next
directory entry will not be possible anymore.
"""
self._call("close")
[docs] def read(self):
"""Reads the next directory entry of this directory.
return obj_info of type :class:`IFsObjInfo`
Object information of the current directory entry read. Also see
:py:class:`IFsObjInfo` .
raises :class:`VBoxErrorObjectNotFound`
No more directory entries to read.
"""
obj_info = self._call("read")
obj_info = IFsObjInfo(obj_info)
return obj_info
[docs]class IGuestDirectory(IDirectory):
"""
Implementation of the :py:class:`IDirectory` object
for directories in the guest.
"""
__uuid__ = 'cc830458-4974-a19c-4dc6-cc98c2269626'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IFile(Interface):
"""
Abstract parent interface for files handled by VirtualBox.
"""
__uuid__ = '14c66b23-404c-f24a-3cc1-ee9501d44f2a'
__wsmap__ = 'managed'
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for file events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def id_p(self):
"""Get int value for 'id'
The ID VirtualBox internally assigned to the open file.
"""
ret = self._get_attr("id")
return ret
@property
def initial_size(self):
"""Get int value for 'initialSize'
The initial size in bytes when opened.
"""
ret = self._get_attr("initialSize")
return ret
@property
def offset(self):
"""Get int value for 'offset'
The current file position.
The file current position always applies to the :py:func:`IFile.read`
method, which updates it upon return. Same goes for the :py:func:`IFile.write`
method except when :py:func:`IFile.access_mode` is :py:attr:`FileAccessMode.append_only`
or :py:attr:`FileAccessMode.append_read` , where it will always write
to the end of the file and will leave this attribute unchanged.
The :py:func:`IFile.seek` is used to change this attribute without
transfering any file data like read and write does.
"""
ret = self._get_attr("offset")
return ret
@property
def status(self):
"""Get FileStatus value for 'status'
Current file status.
"""
ret = self._get_attr("status")
return FileStatus(ret)
@property
def file_name(self):
"""Get str value for 'fileName'
Full path of the actual file name of this file.
<!-- r=bird: The 'actual' file name is too tough, we cannot guarentee
that on unix guests. Seeing how IGuestDirectory did things,
I'm questioning the 'Full path' part too. Not urgent to check. -->
"""
ret = self._get_attr("fileName")
return ret
@property
def creation_mode(self):
"""Get int value for 'creationMode'
The UNIX-style creation mode specified when opening the file.
"""
ret = self._get_attr("creationMode")
return ret
@property
def open_action(self):
"""Get FileOpenAction value for 'openAction'
The opening action specified when opening the file.
"""
ret = self._get_attr("openAction")
return FileOpenAction(ret)
@property
def access_mode(self):
"""Get FileAccessMode value for 'accessMode'
The file access mode.
"""
ret = self._get_attr("accessMode")
return FileAccessMode(ret)
[docs] def close(self):
"""Closes this file. After closing operations like reading data,
writing data or querying information will not be possible anymore.
"""
self._call("close")
[docs] def query_info(self):
"""Queries information about this file.
return obj_info of type :class:`IFsObjInfo`
Object information of this file. Also see
:py:class:`IFsObjInfo` .
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
obj_info = self._call("queryInfo")
obj_info = IFsObjInfo(obj_info)
return obj_info
[docs] def query_size(self):
"""Queries the current file size.
return size of type int
Queried file size.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
size = self._call("querySize")
return size
[docs] def read(self, to_read, timeout_ms):
"""Reads data from this file.
in to_read of type int
Number of bytes to read.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return data of type str
Array of data read.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(to_read, baseinteger):
raise TypeError("to_read can only be an instance of type baseinteger")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
data = self._call("read",
in_p=[to_read, timeout_ms])
return data
[docs] def read_at(self, offset, to_read, timeout_ms):
"""Reads data from an offset of this file.
in offset of type int
Offset in bytes to start reading.
in to_read of type int
Number of bytes to read.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return data of type str
Array of data read.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
if not isinstance(to_read, baseinteger):
raise TypeError("to_read can only be an instance of type baseinteger")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
data = self._call("readAt",
in_p=[offset, to_read, timeout_ms])
return data
[docs] def seek(self, offset, whence):
"""Changes the current file position of this file.
The file current position always applies to the :py:func:`IFile.read`
method. Same for the :py:func:`IFile.write` method it except when
the :py:func:`IFile.access_mode` is :py:attr:`FileAccessMode.append_only`
or :py:attr:`FileAccessMode.append_read` .
in offset of type int
Offset to seek relative to the position specified by @a whence.
in whence of type :class:`FileSeekOrigin`
One of the :py:class:`FileSeekOrigin` seek starting points.
return new_offset of type int
The new file offset after the seek operation.
"""
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
if not isinstance(whence, FileSeekOrigin):
raise TypeError("whence can only be an instance of type FileSeekOrigin")
new_offset = self._call("seek",
in_p=[offset, whence])
return new_offset
[docs] def set_acl(self, acl, mode):
"""Sets the ACL of this file.
in acl of type str
The ACL specification string. To-be-defined.
in mode of type int
UNIX-style mode mask to use if @a acl is empty. As mention in
:py:func:`IGuestSession.directory_create` this is realized on
a best effort basis and the exact behavior depends on the Guest OS.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(acl, basestring):
raise TypeError("acl can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
self._call("setACL",
in_p=[acl, mode])
[docs] def set_size(self, size):
"""Changes the file size.
in size of type int
The new file size.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
self._call("setSize",
in_p=[size])
[docs] def write(self, data, timeout_ms):
"""Writes bytes to this file.
in data of type str
Array of bytes to write. The size of the array also specifies
how much to write.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return written of type int
How much bytes were written.
"""
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
written = self._call("write",
in_p=[data, timeout_ms])
return written
[docs] def write_at(self, offset, data, timeout_ms):
"""Writes bytes at a certain offset to this file.
in offset of type int
Offset in bytes to start writing.
in data of type str
Array of bytes to write. The size of the array also specifies
how much to write.
in timeout_ms of type int
Timeout (in ms) to wait for the operation to complete.
Pass 0 for an infinite timeout.
return written of type int
How much bytes were written.
raises :class:`OleErrorNotimpl`
The method is not implemented yet.
"""
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(timeout_ms, baseinteger):
raise TypeError("timeout_ms can only be an instance of type baseinteger")
written = self._call("writeAt",
in_p=[offset, data, timeout_ms])
return written
[docs]class IGuestFile(IFile):
"""
Implementation of the :py:class:`IFile` object
for files in the guest.
"""
__uuid__ = '92f21dc0-44de-1653-b717-2ebf0ca9b664'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IFsObjInfo(Interface):
"""
Abstract parent interface for VirtualBox file system object information.
This can be information about a file or a directory, for example.
"""
__uuid__ = 'd344626e-4b0a-10bc-9c2b-68973052de16'
__wsmap__ = 'managed'
@property
def access_time(self):
"""Get int value for 'accessTime'
Time of last access (st_atime).
"""
ret = self._get_attr("accessTime")
return ret
@property
def allocated_size(self):
"""Get int value for 'allocatedSize'
Disk allocation size (st_blocks * DEV_BSIZE).
"""
ret = self._get_attr("allocatedSize")
return ret
@property
def birth_time(self):
"""Get int value for 'birthTime'
Time of file birth (st_birthtime).
"""
ret = self._get_attr("birthTime")
return ret
@property
def change_time(self):
"""Get int value for 'changeTime'
Time of last status change (st_ctime).
"""
ret = self._get_attr("changeTime")
return ret
@property
def device_number(self):
"""Get int value for 'deviceNumber'
The device number of a character or block device type object (st_rdev).
"""
ret = self._get_attr("deviceNumber")
return ret
@property
def file_attributes(self):
"""Get str value for 'fileAttributes'
File attributes. Not implemented yet.
"""
ret = self._get_attr("fileAttributes")
return ret
@property
def generation_id(self):
"""Get int value for 'generationId'
The current generation number (st_gen).
"""
ret = self._get_attr("generationId")
return ret
@property
def gid(self):
"""Get int value for 'GID'
The group the filesystem object is assigned (st_gid).
"""
ret = self._get_attr("GID")
return ret
@property
def group_name(self):
"""Get str value for 'groupName'
The group name.
"""
ret = self._get_attr("groupName")
return ret
@property
def hard_links(self):
"""Get int value for 'hardLinks'
Number of hard links to this filesystem object (st_nlink).
"""
ret = self._get_attr("hardLinks")
return ret
@property
def modification_time(self):
"""Get int value for 'modificationTime'
Time of last data modification (st_mtime).
"""
ret = self._get_attr("modificationTime")
return ret
@property
def name(self):
"""Get str value for 'name'
The object's name.
"""
ret = self._get_attr("name")
return ret
@property
def node_id(self):
"""Get int value for 'nodeId'
The unique identifier (within the filesystem) of this filesystem object (st_ino).
"""
ret = self._get_attr("nodeId")
return ret
@property
def node_id_device(self):
"""Get int value for 'nodeIdDevice'
The device number of the device which this filesystem object resides on (st_dev).
"""
ret = self._get_attr("nodeIdDevice")
return ret
@property
def object_size(self):
"""Get int value for 'objectSize'
The logical size (st_size). For normal files this is the size of the file.
For symbolic links, this is the length of the path name contained in the
symbolic link. For other objects this fields needs to be specified.
"""
ret = self._get_attr("objectSize")
return ret
@property
def type_p(self):
"""Get FsObjType value for 'type'
The object type. See :py:class:`FsObjType` for more.
"""
ret = self._get_attr("type")
return FsObjType(ret)
@property
def uid(self):
"""Get int value for 'UID'
The user owning the filesystem object (st_uid).
"""
ret = self._get_attr("UID")
return ret
@property
def user_flags(self):
"""Get int value for 'userFlags'
User flags (st_flags).
"""
ret = self._get_attr("userFlags")
return ret
@property
def user_name(self):
"""Get str value for 'userName'
The user name.
"""
ret = self._get_attr("userName")
return ret
[docs]class IGuestFsObjInfo(IFsObjInfo):
"""
Represents the guest implementation of the
:py:class:`IFsObjInfo` object.
"""
__uuid__ = '6620db85-44e0-ca69-e9e0-d4907ceccbe5'
__wsmap__ = 'managed'
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
class IGuest(Interface):
"""
The IGuest interface represents information about the operating system
running inside the virtual machine. Used in
:py:func:`IConsole.guest` .
IGuest provides information about the guest operating system, whether
Guest Additions are installed and other OS-specific virtual machine
properties.
"""
__uuid__ = '13a11514-402e-022e-6180-c3944de3f9c8'
__wsmap__ = 'managed'
@property
def os_type_id(self):
"""Get str value for 'OSTypeId'
Identifier of the Guest OS type as reported by the Guest
Additions.
You may use :py:func:`IVirtualBox.get_guest_os_type` to obtain
an IGuestOSType object representing details about the given
Guest OS type.
If Guest Additions are not installed, this value will be
the same as :py:func:`IMachine.os_type_id` .
"""
ret = self._get_attr("OSTypeId")
return ret
@property
def additions_run_level(self):
"""Get AdditionsRunLevelType value for 'additionsRunLevel'
Current run level of the installed Guest Additions.
"""
ret = self._get_attr("additionsRunLevel")
return AdditionsRunLevelType(ret)
@property
def additions_version(self):
"""Get str value for 'additionsVersion'
Version of the installed Guest Additions in the same format as
:py:func:`IVirtualBox.version` .
"""
ret = self._get_attr("additionsVersion")
return ret
@property
def additions_revision(self):
"""Get int value for 'additionsRevision'
The internal build revision number of the installed Guest Additions.
See also :py:func:`IVirtualBox.revision` .
"""
ret = self._get_attr("additionsRevision")
return ret
@property
def dn_d_source(self):
"""Get IGuestDnDSource value for 'dnDSource'
Retrieves the drag'n drop source implementation for the guest side, that
is, handling and retrieving drag'n drop data from the guest.
"""
ret = self._get_attr("dnDSource")
return IGuestDnDSource(ret)
@property
def dn_d_target(self):
"""Get IGuestDnDTarget value for 'dnDTarget'
Retrieves the drag'n drop source implementation for the host side. This
will allow the host to handle and initiate a drag'n drop operation to copy
data from the host to the guest.
"""
ret = self._get_attr("dnDTarget")
return IGuestDnDTarget(ret)
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for guest events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
@property
def facilities(self):
"""Get IAdditionsFacility value for 'facilities'
Returns a collection of current known facilities. Only returns facilities where
a status is known, e.g. facilities with an unknown status will not be returned.
"""
ret = self._get_attr("facilities")
return [IAdditionsFacility(a) for a in ret]
@property
def sessions(self):
"""Get IGuestSession value for 'sessions'
Returns a collection of all opened guest sessions.
"""
ret = self._get_attr("sessions")
return [IGuestSession(a) for a in ret]
@property
def memory_balloon_size(self):
"""Get or set int value for 'memoryBalloonSize'
Guest system memory balloon size in megabytes (transient property).
"""
ret = self._get_attr("memoryBalloonSize")
return ret
@memory_balloon_size.setter
def memory_balloon_size(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("memoryBalloonSize", value)
@property
def statistics_update_interval(self):
"""Get or set int value for 'statisticsUpdateInterval'
Interval to update guest statistics in seconds.
"""
ret = self._get_attr("statisticsUpdateInterval")
return ret
@statistics_update_interval.setter
def statistics_update_interval(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("statisticsUpdateInterval", value)
[docs] def internal_get_statistics(self):
"""Internal method; do not use as it might change at any time.
out cpu_user of type int
Percentage of processor time spent in user mode as seen by the guest.
out cpu_kernel of type int
Percentage of processor time spent in kernel mode as seen by the guest.
out cpu_idle of type int
Percentage of processor time spent idling as seen by the guest.
out mem_total of type int
Total amount of physical guest RAM.
out mem_free of type int
Free amount of physical guest RAM.
out mem_balloon of type int
Amount of ballooned physical guest RAM.
out mem_shared of type int
Amount of shared physical guest RAM.
out mem_cache of type int
Total amount of guest (disk) cache memory.
out paged_total of type int
Total amount of space in the page file.
out mem_alloc_total of type int
Total amount of memory allocated by the hypervisor.
out mem_free_total of type int
Total amount of free memory available in the hypervisor.
out mem_balloon_total of type int
Total amount of memory ballooned by the hypervisor.
out mem_shared_total of type int
Total amount of shared memory in the hypervisor.
"""
(cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared, mem_cache, paged_total, mem_alloc_total, mem_free_total, mem_balloon_total, mem_shared_total) = self._call("internalGetStatistics")
return (cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared, mem_cache, paged_total, mem_alloc_total, mem_free_total, mem_balloon_total, mem_shared_total)
[docs] def get_facility_status(self, facility):
"""Get the current status of a Guest Additions facility.
in facility of type :class:`AdditionsFacilityType`
Facility to check status for.
out timestamp of type int
Timestamp (in ms) of last status update seen by the host.
return status of type :class:`AdditionsFacilityStatus`
The current (latest) facility status.
"""
if not isinstance(facility, AdditionsFacilityType):
raise TypeError("facility can only be an instance of type AdditionsFacilityType")
(status, timestamp) = self._call("getFacilityStatus",
in_p=[facility])
status = AdditionsFacilityStatus(status)
return (status, timestamp)
[docs] def get_additions_status(self, level):
"""Retrieve the current status of a certain Guest Additions run level.
in level of type :class:`AdditionsRunLevelType`
Status level to check
return active of type bool
Flag whether the status level has been reached or not
raises :class:`VBoxErrorNotSupported`
Wrong status level specified.
"""
if not isinstance(level, AdditionsRunLevelType):
raise TypeError("level can only be an instance of type AdditionsRunLevelType")
active = self._call("getAdditionsStatus",
in_p=[level])
return active
[docs] def set_credentials(self, user_name, password, domain, allow_interactive_logon):
"""Store login credentials that can be queried by guest operating
systems with Additions installed. The credentials are transient
to the session and the guest may also choose to erase them. Note
that the caller cannot determine whether the guest operating system
has queried or made use of the credentials.
in user_name of type str
User name string, can be empty
in password of type str
Password string, can be empty
in domain of type str
Domain name (guest logon scheme specific), can be empty
in allow_interactive_logon of type bool
Flag whether the guest should alternatively allow the user to
interactively specify different credentials. This flag might
not be supported by all versions of the Additions.
raises :class:`VBoxErrorVmError`
VMM device is not available.
"""
if not isinstance(user_name, basestring):
raise TypeError("user_name can only be an instance of type basestring")
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
if not isinstance(domain, basestring):
raise TypeError("domain can only be an instance of type basestring")
if not isinstance(allow_interactive_logon, bool):
raise TypeError("allow_interactive_logon can only be an instance of type bool")
self._call("setCredentials",
in_p=[user_name, password, domain, allow_interactive_logon])
def create_session(self, user, password, domain, session_name):
"""Creates a new guest session for controlling the guest. The new session
will be started asynchronously, meaning on return of this function it is
not guaranteed that the guest session is in a started and/or usable state.
To wait for successful startup, use the :py:func:`IGuestSession.wait_for`
call.
A guest session represents one impersonated user account in the guest, so
every operation will use the same credentials specified when creating
the session object via :py:func:`IGuest.create_session` . Anonymous
sessions, that is, sessions without specifying a valid
user account in the guest are not allowed reasons of security.
There can be a maximum of 32 sessions at once per VM. An error will
be returned if this has been reached. <!-- This should actually read:
VBOX_E_IPRT_ERROR will be return if this limit has been reached.
However, keep in mind that VBOX_E_IPRT_ERROR can be returned for about
88 unrelated reasons, so you don't know what happend unless you parse
the error text. (bird) -->
<!-- @todo r=bird: Seriously, add an dedicated VBOX_E_MAX_GUEST_SESSIONS status
for this condition. Do the same for all other maximums and things that could be
useful to the API client. -->
For more information please consult :py:class:`IGuestSession`
in user of type str
User name this session will be using to control the guest; has to exist
and have the appropriate rights to execute programs in the VM. Must not
be empty.
in password of type str
Password of the user account to be used. Empty passwords are allowed.
in domain of type str
Domain name of the user account to be used if the guest is part of
a domain. Optional. This feature is not implemented yet.
in session_name of type str
The session's friendly name. Optional, can be empty.
return guest_session of type :class:`IGuestSession`
The newly created session object.
"""
if not isinstance(user, basestring):
raise TypeError("user can only be an instance of type basestring")
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
if not isinstance(domain, basestring):
raise TypeError("domain can only be an instance of type basestring")
if not isinstance(session_name, basestring):
raise TypeError("session_name can only be an instance of type basestring")
guest_session = self._call("createSession",
in_p=[user, password, domain, session_name])
guest_session = IGuestSession(guest_session)
return guest_session
[docs] def find_session(self, session_name):
"""Finds guest sessions by their friendly name and returns an interface
array with all found guest sessions.
in session_name of type str
The session's friendly name to find. Wildcards like ? and * are allowed.
return sessions of type :class:`IGuestSession`
Array with all guest sessions found matching the name specified.
"""
if not isinstance(session_name, basestring):
raise TypeError("session_name can only be an instance of type basestring")
sessions = self._call("findSession",
in_p=[session_name])
sessions = [IGuestSession(a) for a in sessions]
return sessions
def update_guest_additions(self, source, arguments, flags):
"""Automatically updates already installed Guest Additions in a VM.
At the moment only Windows guests are supported.
Because the VirtualBox Guest Additions drivers are not WHQL-certified
yet there might be warning dialogs during the actual Guest Additions
update. These need to be confirmed manually in order to continue the
installation process. This applies to Windows 2000 and Windows XP guests
and therefore these guests can't be updated in a fully automated fashion
without user interaction. However, to start a Guest Additions update for
the mentioned Windows versions anyway, the flag
AdditionsUpdateFlag_WaitForUpdateStartOnly can be specified. See
:py:class:`AdditionsUpdateFlag` for more information.
in source of type str
Path to the Guest Additions .ISO file to use for the update.
in arguments of type str
Optional command line arguments to use for the Guest Additions
installer. Useful for retrofitting features which weren't installed
before in the guest.
in flags of type :class:`AdditionsUpdateFlag`
:py:class:`AdditionsUpdateFlag` flags.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
Guest OS is not supported for automated Guest Additions updates or the
already installed Guest Additions are not ready yet.
raises :class:`VBoxErrorIprtError`
Error while updating.
"""
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(arguments, list):
raise TypeError("arguments can only be an instance of type list")
for a in arguments[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, AdditionsUpdateFlag):
raise TypeError(\
"array can only contain objects of type AdditionsUpdateFlag")
progress = self._call("updateGuestAdditions",
in_p=[source, arguments, flags])
progress = IProgress(progress)
return progress
class IProgress(Interface):
"""
The IProgress interface is used to track and control
asynchronous tasks within VirtualBox.
An instance of this is returned every time VirtualBox starts
an asynchronous task (in other words, a separate thread) which
continues to run after a method call returns. For example,
:py:func:`IMachine.save_state` , which saves the state of
a running virtual machine, can take a long time to complete.
To be able to display a progress bar, a user interface such as
the VirtualBox graphical user interface can use the IProgress
object returned by that method.
Note that IProgress is a "read-only" interface in the sense
that only the VirtualBox internals behind the Main API can
create and manipulate progress objects, whereas client code
can only use the IProgress object to monitor a task's
progress and, if :py:func:`cancelable` is @c true,
cancel the task by calling :py:func:`cancel` .
A task represented by IProgress consists of either one or
several sub-operations that run sequentially, one by one (see
:py:func:`operation` and :py:func:`operation_count` ).
Every operation is identified by a number (starting from 0)
and has a separate description.
You can find the individual percentage of completion of the current
operation in :py:func:`operation_percent` and the
percentage of completion of the task as a whole
in :py:func:`percent` .
Similarly, you can wait for the completion of a particular
operation via :py:func:`wait_for_operation_completion` or
for the completion of the whole task via
:py:func:`wait_for_completion` .
"""
__uuid__ = '77faf1c0-489d-b123-274c-5a95e77ab286'
__wsmap__ = 'managed'
@property
def id_p(self):
"""Get str value for 'id'
ID of the task.
"""
ret = self._get_attr("id")
return ret
@property
def description(self):
"""Get str value for 'description'
Description of the task.
"""
ret = self._get_attr("description")
return ret
@property
def initiator(self):
"""Get Interface value for 'initiator'
Initiator of the task.
"""
ret = self._get_attr("initiator")
return Interface(ret)
@property
def cancelable(self):
"""Get bool value for 'cancelable'
Whether the task can be interrupted.
"""
ret = self._get_attr("cancelable")
return ret
@property
def percent(self):
"""Get int value for 'percent'
Current progress value of the task as a whole, in percent.
This value depends on how many operations are already complete.
Returns 100 if :py:func:`completed` is @c true.
"""
ret = self._get_attr("percent")
return ret
@property
def time_remaining(self):
"""Get int value for 'timeRemaining'
Estimated remaining time until the task completes, in
seconds. Returns 0 once the task has completed; returns -1
if the remaining time cannot be computed, in particular if
the current progress is 0.
Even if a value is returned, the estimate will be unreliable
for low progress values. It will become more reliable as the
task progresses; it is not recommended to display an ETA
before at least 20% of a task have completed.
"""
ret = self._get_attr("timeRemaining")
return ret
@property
def completed(self):
"""Get bool value for 'completed'
Whether the task has been completed.
"""
ret = self._get_attr("completed")
return ret
@property
def canceled(self):
"""Get bool value for 'canceled'
Whether the task has been canceled.
"""
ret = self._get_attr("canceled")
return ret
@property
def result_code(self):
"""Get int value for 'resultCode'
Result code of the progress task.
Valid only if :py:func:`completed` is @c true.
"""
ret = self._get_attr("resultCode")
return ret
@property
def error_info(self):
"""Get IVirtualBoxErrorInfo value for 'errorInfo'
Extended information about the unsuccessful result of the
progress operation. May be @c null if no extended information
is available.
Valid only if :py:func:`completed` is @c true and
:py:func:`result_code` indicates a failure.
"""
ret = self._get_attr("errorInfo")
return IVirtualBoxErrorInfo(ret)
@property
def operation_count(self):
"""Get int value for 'operationCount'
Number of sub-operations this task is divided into.
Every task consists of at least one suboperation.
"""
ret = self._get_attr("operationCount")
return ret
@property
def operation(self):
"""Get int value for 'operation'
Number of the sub-operation being currently executed.
"""
ret = self._get_attr("operation")
return ret
@property
def operation_description(self):
"""Get str value for 'operationDescription'
Description of the sub-operation being currently executed.
"""
ret = self._get_attr("operationDescription")
return ret
@property
def operation_percent(self):
"""Get int value for 'operationPercent'
Progress value of the current sub-operation only, in percent.
"""
ret = self._get_attr("operationPercent")
return ret
@property
def operation_weight(self):
"""Get int value for 'operationWeight'
Weight value of the current sub-operation only.
"""
ret = self._get_attr("operationWeight")
return ret
@property
def timeout(self):
"""Get or set int value for 'timeout'
When non-zero, this specifies the number of milliseconds after which
the operation will automatically be canceled. This can only be set on
cancelable objects.
"""
ret = self._get_attr("timeout")
return ret
@timeout.setter
def timeout(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("timeout", value)
[docs] def set_current_operation_progress(self, percent):
"""Internal method, not to be called externally.
in percent of type int
"""
if not isinstance(percent, baseinteger):
raise TypeError("percent can only be an instance of type baseinteger")
self._call("setCurrentOperationProgress",
in_p=[percent])
[docs] def set_next_operation(self, next_operation_description, next_operations_weight):
"""Internal method, not to be called externally.
in next_operation_description of type str
in next_operations_weight of type int
"""
if not isinstance(next_operation_description, basestring):
raise TypeError("next_operation_description can only be an instance of type basestring")
if not isinstance(next_operations_weight, baseinteger):
raise TypeError("next_operations_weight can only be an instance of type baseinteger")
self._call("setNextOperation",
in_p=[next_operation_description, next_operations_weight])
def wait_for_completion(self, timeout):
"""Waits until the task is done (including all sub-operations)
with a given timeout in milliseconds; specify -1 for an indefinite wait.
Note that the VirtualBox/XPCOM/COM/native event queues of the calling
thread are not processed while waiting. Neglecting event queues may
have dire consequences (degrade performance, resource hogs,
deadlocks, etc.), this is specially so for the main thread on
platforms using XPCOM. Callers are advised wait for short periods
and service their event queues between calls, or to create a worker
thread to do the waiting.
in timeout of type int
Maximum time in milliseconds to wait or -1 to wait indefinitely.
raises :class:`VBoxErrorIprtError`
Failed to wait for task completion.
"""
if not isinstance(timeout, baseinteger):
raise TypeError("timeout can only be an instance of type baseinteger")
self._call("waitForCompletion",
in_p=[timeout])
[docs] def wait_for_operation_completion(self, operation, timeout):
"""Waits until the given operation is done with a given timeout in
milliseconds; specify -1 for an indefinite wait.
See :py:func:`wait_for_completion` for event queue considerations.
in operation of type int
Number of the operation to wait for.
Must be less than :py:func:`operation_count` .
in timeout of type int
Maximum time in milliseconds to wait or -1 to wait indefinitely.
raises :class:`VBoxErrorIprtError`
Failed to wait for operation completion.
"""
if not isinstance(operation, baseinteger):
raise TypeError("operation can only be an instance of type baseinteger")
if not isinstance(timeout, baseinteger):
raise TypeError("timeout can only be an instance of type baseinteger")
self._call("waitForOperationCompletion",
in_p=[operation, timeout])
[docs] def wait_for_async_progress_completion(self, p_progress_async):
"""Waits until the other task is completed (including all
sub-operations) and forward all changes from the other progress to
this progress. This means sub-operation number, description, percent
and so on.
You have to take care on setting up at least the same count on
sub-operations in this progress object like there are in the other
progress object.
If the other progress object supports cancel and this object gets any
cancel request (when here enabled as well), it will be forwarded to
the other progress object.
If there is an error in the other progress, this error isn't
automatically transfered to this progress object. So you have to
check any operation error within the other progress object, after
this method returns.
in p_progress_async of type :class:`IProgress`
The progress object of the asynchrony process.
"""
if not isinstance(p_progress_async, IProgress):
raise TypeError("p_progress_async can only be an instance of type IProgress")
self._call("waitForAsyncProgressCompletion",
in_p=[p_progress_async])
[docs] def cancel(self):
"""Cancels the task.
If :py:func:`cancelable` is @c false, then this method will fail.
raises :class:`VBoxErrorInvalidObjectState`
Operation cannot be canceled.
"""
self._call("cancel")
[docs]class ISnapshot(Interface):
"""
The ISnapshot interface represents a snapshot of the virtual
machine.
Together with the differencing media that are created
when a snapshot is taken, a machine can be brought back to
the exact state it was in when the snapshot was taken.
The ISnapshot interface has no methods, only attributes; snapshots
are controlled through methods of the :py:class:`IMachine` interface
which also manage the media associated with the snapshot.
The following operations exist:
:py:func:`IMachine.take_snapshot` creates a new snapshot
by creating new, empty differencing images for the machine's
media and saving the VM settings and (if the VM is running)
the current VM state in the snapshot.
The differencing images will then receive all data written to
the machine's media, while their parent (base) images
remain unmodified after the snapshot has been taken (see
:py:class:`IMedium` for details about differencing images).
This simplifies restoring a machine to the state of a snapshot:
only the differencing images need to be deleted.
The current machine state is not changed by taking a snapshot
except that :py:func:`IMachine.current_snapshot` is set to
the newly created snapshot, which is also added to the machine's
snapshots tree.
:py:func:`IMachine.restore_snapshot` resets a machine to
the state of a previous snapshot by deleting the differencing
image of each of the machine's media and setting the machine's
settings and state to the state that was saved in the snapshot (if any).
This destroys the machine's current state. After calling this,
:py:func:`IMachine.current_snapshot` points to the snapshot
that was restored.
:py:func:`IMachine.delete_snapshot` deletes a snapshot
without affecting the current machine state.
This does not change the current machine state, but instead frees the
resources allocated when the snapshot was taken: the settings and machine
state file are deleted (if any), and the snapshot's differencing image for
each of the machine's media gets merged with its parent image.
Neither the current machine state nor other snapshots are affected
by this operation, except that parent media will be modified
to contain the disk data associated with the snapshot being deleted.
When deleting the current snapshot, the :py:func:`IMachine.current_snapshot`
attribute is set to the current snapshot's parent or @c null if it
has no parent. Otherwise the attribute is unchanged.
Each snapshot contains a copy of virtual machine's settings (hardware
configuration etc.). This copy is contained in an immutable (read-only)
instance of :py:class:`IMachine` which is available from the snapshot's
:py:func:`machine` attribute. When restoring the snapshot, these
settings are copied back to the original machine.
In addition, if the machine was running when the
snapshot was taken (:py:func:`IMachine.state` is :py:attr:`MachineState.running` ),
the current VM state is saved in the snapshot (similarly to what happens
when a VM's state is saved). The snapshot is then said to be *online*
because when restoring it, the VM will be running.
If the machine was in :py:attr:`MachineState.saved` saved saved,
the snapshot receives a copy of the execution state file
(:py:func:`IMachine.state_file_path` ).
Otherwise, if the machine was not running (:py:attr:`MachineState.powered_off`
or :py:attr:`MachineState.aborted` ), the snapshot is *offline*;
it then contains a so-called "zero execution state", representing a
machine that is powered off.
"""
__uuid__ = '5732f030-4194-ec8b-c761-e1a99327e9f0'
__wsmap__ = 'managed'
@property
def id_p(self):
"""Get str value for 'id'
UUID of the snapshot.
"""
ret = self._get_attr("id")
return ret
@property
def name(self):
"""Get or set str value for 'name'
Short name of the snapshot.
Setting this attribute causes :py:func:`IMachine.save_settings` to
be called implicitly.
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def description(self):
"""Get or set str value for 'description'
Optional description of the snapshot.
Setting this attribute causes :py:func:`IMachine.save_settings` to
be called implicitly.
"""
ret = self._get_attr("description")
return ret
@description.setter
def description(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("description", value)
@property
def time_stamp(self):
"""Get int value for 'timeStamp'
Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
"""
ret = self._get_attr("timeStamp")
return ret
@property
def online(self):
"""Get bool value for 'online'
@c true if this snapshot is an online snapshot and @c false otherwise.
When this attribute is @c true, the
:py:func:`IMachine.state_file_path` attribute of the
:py:func:`machine` object associated with this snapshot
will point to the saved state file. Otherwise, it will be
an empty string.
"""
ret = self._get_attr("online")
return ret
@property
def machine(self):
"""Get IMachine value for 'machine'
Virtual machine this snapshot is taken on. This object
stores all settings the machine had when taking this snapshot.
The returned machine object is immutable, i.e. no
any settings can be changed.
"""
ret = self._get_attr("machine")
return IMachine(ret)
@property
def parent(self):
"""Get ISnapshot value for 'parent'
Parent snapshot (a snapshot this one is based on), or
@c null if the snapshot has no parent (i.e. is the first snapshot).
"""
ret = self._get_attr("parent")
return ISnapshot(ret)
@property
def children(self):
"""Get ISnapshot value for 'children'
Child snapshots (all snapshots having this one as a parent).
By inspecting this attribute starting with a machine's root snapshot
(which can be obtained by calling :py:func:`IMachine.find_snapshot`
with a @c null UUID), a machine's snapshots tree can be iterated over.
"""
ret = self._get_attr("children")
return [ISnapshot(a) for a in ret]
[docs] def get_children_count(self):
"""Returns the number of direct children of this snapshot.
return children_count of type int
"""
children_count = self._call("getChildrenCount")
return children_count
[docs]class IMediumAttachment(Interface):
"""
The IMediumAttachment interface links storage media to virtual machines.
For each medium (:py:class:`IMedium` ) which has been attached to a
storage controller (:py:class:`IStorageController` ) of a machine
(:py:class:`IMachine` ) via the :py:func:`IMachine.attach_device`
method, one instance of IMediumAttachment is added to the machine's
:py:func:`IMachine.medium_attachments` array attribute.
Each medium attachment specifies the storage controller as well as a
port and device number and the IMedium instance representing a virtual
hard disk or floppy or DVD image.
For removable media (DVDs or floppies), there are two additional
options. For one, the IMedium instance can be @c null to represent
an empty drive with no media inserted (see :py:func:`IMachine.mount_medium` );
secondly, the medium can be one of the pseudo-media for host drives
listed in :py:func:`IHost.dvd_drives` or :py:func:`IHost.floppy_drives` .
Attaching Hard Disks
Hard disks are attached to virtual machines using the
:py:func:`IMachine.attach_device` method and detached using the
:py:func:`IMachine.detach_device` method. Depending on a medium's
type (see :py:func:`IMedium.type_p` ), hard disks are attached either
*directly* or *indirectly*.
When a hard disk is being attached directly, it is associated with the
virtual machine and used for hard disk operations when the machine is
running. When a hard disk is being attached indirectly, a new differencing
hard disk linked to it is implicitly created and this differencing hard
disk is associated with the machine and used for hard disk operations.
This also means that if :py:func:`IMachine.attach_device` performs
a direct attachment then the same hard disk will be returned in response
to the subsequent :py:func:`IMachine.get_medium` call; however if
an indirect attachment is performed then
:py:func:`IMachine.get_medium` will return the implicitly created
differencing hard disk, not the original one passed to :py:func:`IMachine.attach_device` . In detail:
**Normal base** hard disks that do not have children (i.e.
differencing hard disks linked to them) and that are not already
attached to virtual machines in snapshots are attached **directly**.
Otherwise, they are attached **indirectly** because having
dependent children or being part of the snapshot makes it impossible
to modify hard disk contents without breaking the integrity of the
dependent party. The :py:func:`IMedium.read_only` attribute allows to
quickly determine the kind of the attachment for the given hard
disk. Note that if a normal base hard disk is to be indirectly
attached to a virtual machine with snapshots then a special
procedure called *smart attachment* is performed (see below).
**Normal differencing** hard disks are like normal base hard disks:
they are attached **directly** if they do not have children and are
not attached to virtual machines in snapshots, and **indirectly**
otherwise. Note that the smart attachment procedure is never performed
for differencing hard disks.
**Immutable** hard disks are always attached **indirectly** because
they are designed to be non-writable. If an immutable hard disk is
attached to a virtual machine with snapshots then a special
procedure called smart attachment is performed (see below).
**Writethrough** hard disks are always attached **directly**,
also as designed. This also means that writethrough hard disks cannot
have other hard disks linked to them at all.
**Shareable** hard disks are always attached **directly**,
also as designed. This also means that shareable hard disks cannot
have other hard disks linked to them at all. They behave almost
like writethrough hard disks, except that shareable hard disks can
be attached to several virtual machines which are running, allowing
concurrent accesses. You need special cluster software running in
the virtual machines to make use of such disks.
Note that the same hard disk, regardless of its type, may be attached to
more than one virtual machine at a time. In this case, the machine that is
started first gains exclusive access to the hard disk and attempts to
start other machines having this hard disk attached will fail until the
first machine is powered down.
Detaching hard disks is performed in a *deferred* fashion. This means
that the given hard disk remains associated with the given machine after a
successful :py:func:`IMachine.detach_device` call until
:py:func:`IMachine.save_settings` is called to save all changes to
machine settings to disk. This deferring is necessary to guarantee that
the hard disk configuration may be restored at any time by a call to
:py:func:`IMachine.discard_settings` before the settings
are saved (committed).
Note that if :py:func:`IMachine.discard_settings` is called after
indirectly attaching some hard disks to the machine but before a call to
:py:func:`IMachine.save_settings` is made, it will implicitly delete
all differencing hard disks implicitly created by
:py:func:`IMachine.attach_device` for these indirect attachments.
Such implicitly created hard disks will also be immediately deleted when
detached explicitly using the :py:func:`IMachine.detach_device`
call if it is made before :py:func:`IMachine.save_settings` . This
implicit deletion is safe because newly created differencing hard
disks do not contain any user data.
However, keep in mind that detaching differencing hard disks that were
implicitly created by :py:func:`IMachine.attach_device`
before the last :py:func:`IMachine.save_settings` call will
**not** implicitly delete them as they may already contain some data
(for example, as a result of virtual machine execution). If these hard
disks are no more necessary, the caller can always delete them explicitly
using :py:func:`IMedium.delete_storage` after they are actually de-associated
from this machine by the :py:func:`IMachine.save_settings` call.
Smart Attachment
When normal base or immutable hard disks are indirectly attached to a
virtual machine then some additional steps are performed to make sure the
virtual machine will have the most recent "view" of the hard disk being
attached. These steps include walking through the machine's snapshots
starting from the current one and going through ancestors up to the first
snapshot. Hard disks attached to the virtual machine in all
of the encountered snapshots are checked whether they are descendants of
the given normal base or immutable hard disk. The first found child (which
is the differencing hard disk) will be used instead of the normal base or
immutable hard disk as a parent for creating a new differencing hard disk
that will be actually attached to the machine. And only if no descendants
are found or if the virtual machine does not have any snapshots then the
normal base or immutable hard disk will be used itself as a parent for
this differencing hard disk.
It is easier to explain what smart attachment does using the
following example:
::
BEFORE attaching B.vdi: AFTER attaching B.vdi:
Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
Snapshot 4 (none) Snapshot 4 (none)
CurState (none) CurState (D3->D2.vdi)
NOT
...
CurState (D3->B.vdi)
The first column is the virtual machine configuration before the base hard
disk B.vdi is attached, the second column shows the machine after
this hard disk is attached. Constructs like D1->B.vdi and similar
mean that the hard disk that is actually attached to the machine is a
differencing hard disk, D1.vdi, which is linked to (based on)
another hard disk, B.vdi.
As we can see from the example, the hard disk B.vdi was detached
from the machine before taking Snapshot 4. Later, after Snapshot 4 was
taken, the user decides to attach B.vdi again. B.vdi has
dependent child hard disks (D1.vdi, D2.vdi), therefore
it cannot be attached directly and needs an indirect attachment (i.e.
implicit creation of a new differencing hard disk). Due to the smart
attachment procedure, the new differencing hard disk
(D3.vdi) will be based on D2.vdi, not on
B.vdi itself, since D2.vdi is the most recent view of
B.vdi existing for this snapshot branch of the given virtual
machine.
Note that if there is more than one descendant hard disk of the given base
hard disk found in a snapshot, and there is an exact device, channel and
bus match, then this exact match will be used. Otherwise, the youngest
descendant will be picked up.
There is one more important aspect of the smart attachment procedure which
is not related to snapshots at all. Before walking through the snapshots
as described above, the backup copy of the current list of hard disk
attachment is searched for descendants. This backup copy is created when
the hard disk configuration is changed for the first time after the last
:py:func:`IMachine.save_settings` call and used by
:py:func:`IMachine.discard_settings` to undo the recent hard disk
changes. When such a descendant is found in this backup copy, it will be
simply re-attached back, without creating a new differencing hard disk for
it. This optimization is necessary to make it possible to re-attach the
base or immutable hard disk to a different bus, channel or device slot
without losing the contents of the differencing hard disk actually
attached to the machine in place of it.
"""
__uuid__ = '3785b3f7-7b5f-4000-8842-ad0cc6ab30b7'
__wsmap__ = 'struct'
@property
def medium(self):
"""Get IMedium value for 'medium'
Medium object associated with this attachment; it
can be @c null for removable devices.
"""
ret = self._get_attr("medium")
return IMedium(ret)
@property
def controller(self):
"""Get str value for 'controller'
Name of the storage controller of this attachment; this
refers to one of the controllers in :py:func:`IMachine.storage_controllers`
by name.
"""
ret = self._get_attr("controller")
return ret
@property
def port(self):
"""Get int value for 'port'
Port number of this attachment.
See :py:func:`IMachine.attach_device` for the meaning of this value for the different controller types.
"""
ret = self._get_attr("port")
return ret
@property
def device(self):
"""Get int value for 'device'
Device slot number of this attachment.
See :py:func:`IMachine.attach_device` for the meaning of this value for the different controller types.
"""
ret = self._get_attr("device")
return ret
@property
def type_p(self):
"""Get DeviceType value for 'type'
Device type of this attachment.
"""
ret = self._get_attr("type")
return DeviceType(ret)
@property
def passthrough(self):
"""Get bool value for 'passthrough'
Pass I/O requests through to a device on the host.
"""
ret = self._get_attr("passthrough")
return ret
@property
def temporary_eject(self):
"""Get bool value for 'temporaryEject'
Whether guest-triggered eject results in unmounting the medium.
"""
ret = self._get_attr("temporaryEject")
return ret
@property
def is_ejected(self):
"""Get bool value for 'isEjected'
Signals that the removable medium has been ejected. This is not
necessarily equivalent to having a @c null medium association.
"""
ret = self._get_attr("isEjected")
return ret
@property
def non_rotational(self):
"""Get bool value for 'nonRotational'
Whether the associated medium is non-rotational.
"""
ret = self._get_attr("nonRotational")
return ret
@property
def discard(self):
"""Get bool value for 'discard'
Whether the associated medium supports discarding unused blocks.
"""
ret = self._get_attr("discard")
return ret
@property
def hot_pluggable(self):
"""Get bool value for 'hotPluggable'
Whether this attachment is hot pluggable or not.
"""
ret = self._get_attr("hotPluggable")
return ret
@property
def bandwidth_group(self):
"""Get IBandwidthGroup value for 'bandwidthGroup'
The bandwidth group this medium attachment is assigned to.
"""
ret = self._get_attr("bandwidthGroup")
return IBandwidthGroup(ret)
[docs]class IMedium(Interface):
"""
The IMedium interface represents virtual storage for a machine's
hard disks, CD/DVD or floppy drives. It will typically represent
a disk image on the host, for example a VDI or VMDK file representing
a virtual hard disk, or an ISO or RAW file representing virtual
removable media, but can also point to a network location (e.g.
for iSCSI targets).
Instances of IMedium are connected to virtual machines by way of medium
attachments, which link the storage medium to a particular device slot
of a storage controller of the virtual machine.
In the VirtualBox API, virtual storage is therefore always represented
by the following chain of object links:
:py:func:`IMachine.storage_controllers` contains an array of
storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
these are instances of :py:class:`IStorageController` ).
:py:func:`IMachine.medium_attachments` contains an array of
medium attachments (instances of :py:class:`IMediumAttachment`
created by :py:func:`IMachine.attach_device` ),
each containing a storage controller from the above array, a
port/device specification, and an instance of IMedium representing
the medium storage (image file).
For removable media, the storage medium is optional; a medium
attachment with no medium represents a CD/DVD or floppy drive
with no medium inserted. By contrast, hard disk attachments
will always have an IMedium object attached.
Each IMedium in turn points to a storage unit (such as a file
on the host computer or a network resource) that holds actual
data. This location is represented by the :py:func:`location`
attribute.
Existing media are opened using :py:func:`IVirtualBox.open_medium` ;
new hard disk media can be created with the VirtualBox API using the
:py:func:`IVirtualBox.create_medium` method. Differencing hard
disks (see below) are usually implicitly created by VirtualBox as
needed, but may also be created explicitly using :py:func:`create_diff_storage` .
VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
should be created with external tools and then opened from within VirtualBox.
Only for CD/DVDs and floppies, an IMedium instance can also represent a host
drive. In that case the :py:func:`id_p` attribute contains the UUID of
one of the drives in :py:func:`IHost.dvd_drives` or :py:func:`IHost.floppy_drives` .
Media registries
When a medium has been opened or created using one of the aforementioned
APIs, it becomes "known" to VirtualBox. Known media can be attached
to virtual machines and re-found through :py:func:`IVirtualBox.open_medium` .
They also appear in the global
:py:func:`IVirtualBox.hard_disks` ,
:py:func:`IVirtualBox.dvd_images` and
:py:func:`IVirtualBox.floppy_images` arrays.
Prior to VirtualBox 4.0, opening a medium added it to a global media registry
in the VirtualBox.xml file, which was shared between all machines and made
transporting machines and their media from one host to another difficult.
Starting with VirtualBox 4.0, media are only added to a registry when they are
*attached* to a machine using :py:func:`IMachine.attach_device` . For
backwards compatibility, which registry a medium is added to depends on which
VirtualBox version created a machine:
If the medium has first been attached to a machine which was created by
VirtualBox 4.0 or later, it is added to that machine's media registry in
the machine XML settings file. This way all information about a machine's
media attachments is contained in a single file and can be transported
easily.
For older media attachments (i.e. if the medium was first attached to a
machine which was created with a VirtualBox version before 4.0), media
continue to be registered in the global VirtualBox settings file, for
backwards compatibility.
See :py:func:`IVirtualBox.open_medium` for more information.
Media are removed from media registries by the :py:func:`IMedium.close` ,
:py:func:`delete_storage` and :py:func:`merge_to` methods.
Accessibility checks
VirtualBox defers media accessibility checks until the :py:func:`refresh_state`
method is called explicitly on a medium. This is done to make the VirtualBox object
ready for serving requests as fast as possible and let the end-user
application decide if it needs to check media accessibility right away or not.
As a result, when VirtualBox starts up (e.g. the VirtualBox
object gets created for the first time), all known media are in the
"Inaccessible" state, but the value of the :py:func:`last_access_error`
attribute is an empty string because no actual accessibility check has
been made yet.
After calling :py:func:`refresh_state` , a medium is considered
*accessible* if its storage unit can be read. In that case, the
:py:func:`state` attribute has a value of "Created". If the storage
unit cannot be read (for example, because it is located on a disconnected
network resource, or was accidentally deleted outside VirtualBox),
the medium is considered *inaccessible*, which is indicated by the
"Inaccessible" state. The exact reason why the medium is inaccessible can be
obtained by reading the :py:func:`last_access_error` attribute.
Medium types
There are five types of medium behavior which are stored in the
:py:func:`type_p` attribute (see :py:class:`MediumType` ) and
which define the medium's behavior with attachments and snapshots.
All media can be also divided in two groups: *base* media and
*differencing* media. A base medium contains all sectors of the
medium data in its own storage and therefore can be used independently.
In contrast, a differencing medium is a "delta" to some other medium and
contains only those sectors which differ from that other medium, which is
then called a *parent*. The differencing medium is said to be
*linked to* that parent. The parent may be itself a differencing
medium, thus forming a chain of linked media. The last element in that
chain must always be a base medium. Note that several differencing
media may be linked to the same parent medium.
Differencing media can be distinguished from base media by querying the
:py:func:`parent` attribute: base media do not have parents they would
depend on, so the value of this attribute is always @c null for them.
Using this attribute, it is possible to walk up the medium tree (from the
child medium to its parent). It is also possible to walk down the tree
using the :py:func:`children` attribute.
Note that the type of all differencing media is "normal"; all other
values are meaningless for them. Base media may be of any type.
Automatic composition of the file name part
Another extension to the :py:func:`IMedium.location` attribute is that
there is a possibility to cause VirtualBox to compose a unique value for
the file name part of the location using the UUID of the hard disk. This
applies only to hard disks in :py:attr:`MediumState.not_created` state,
e.g. before the storage unit is created, and works as follows. You set the
value of the :py:func:`IMedium.location` attribute to a location
specification which only contains the path specification but not the file
name part and ends with either a forward slash or a backslash character.
In response, VirtualBox will generate a new UUID for the hard disk and
compose the file name using the following pattern:
::
<path>/{<uuid>}.<ext>
where <path> is the supplied path specification,
<uuid> is the newly generated UUID and <ext>
is the default extension for the storage format of this hard disk. After
that, you may call any of the methods that create a new hard disk storage
unit and they will use the generated UUID and file name.
"""
__uuid__ = '4afe423b-43e0-e9d0-82e8-ceb307940dda'
__wsmap__ = 'managed'
@property
def id_p(self):
"""Get str value for 'id'
UUID of the medium. For a newly created medium, this value is a randomly
generated UUID.
For media in one of MediumState_NotCreated, MediumState_Creating or
MediumState_Deleting states, the value of this property is undefined
and will most likely be an empty UUID.
"""
ret = self._get_attr("id")
return ret
@property
def description(self):
"""Get or set str value for 'description'
Optional description of the medium. For a newly created medium the value
of this attribute is an empty string.
Medium types that don't support this attribute will return E_NOTIMPL in
attempt to get or set this attribute's value.
For some storage types, reading this attribute may return an outdated
(last known) value when :py:func:`state` is :py:attr:`MediumState.inaccessible` or :py:attr:`MediumState.locked_write` because the value of this attribute is
stored within the storage unit itself. Also note that changing the
attribute value is not possible in such case, as well as when the
medium is the :py:attr:`MediumState.locked_read` state.
"""
ret = self._get_attr("description")
return ret
@description.setter
def description(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("description", value)
@property
def state(self):
"""Get MediumState value for 'state'
Returns the current medium state, which is the last state set by
the accessibility check performed by :py:func:`refresh_state` .
If that method has not yet been called on the medium, the state
is "Inaccessible"; as opposed to truly inaccessible media, the
value of :py:func:`last_access_error` will be an empty string in
that case.
As of version 3.1, this no longer performs an accessibility check
automatically; call :py:func:`refresh_state` for that.
"""
ret = self._get_attr("state")
return MediumState(ret)
@property
def variant(self):
"""Get MediumVariant value for 'variant'
Returns the storage format variant information for this medium
as an array of the flags described at :py:class:`MediumVariant` .
Before :py:func:`refresh_state` is called this method returns
an undefined value.
"""
ret = self._get_attr("variant")
return [MediumVariant(a) for a in ret]
@property
def location(self):
"""Get str value for 'location'
Location of the storage unit holding medium data.
The format of the location string is medium type specific. For medium
types using regular files in a host's file system, the location
string is the full file name.
"""
ret = self._get_attr("location")
return ret
@property
def name(self):
"""Get str value for 'name'
Name of the storage unit holding medium data.
The returned string is a short version of the :py:func:`location`
attribute that is suitable for representing the medium in situations
where the full location specification is too long (such as lists
and comboboxes in GUI frontends). This string is also used by frontends
to sort the media list alphabetically when needed.
For example, for locations that are regular files in the host's file
system, the value of this attribute is just the file name (+ extension),
without the path specification.
Note that as opposed to the :py:func:`location` attribute, the name
attribute will not necessary be unique for a list of media of the
given type and format.
"""
ret = self._get_attr("name")
return ret
@property
def device_type(self):
"""Get DeviceType value for 'deviceType'
Kind of device (DVD/Floppy/HardDisk) which is applicable to this
medium.
"""
ret = self._get_attr("deviceType")
return DeviceType(ret)
@property
def host_drive(self):
"""Get bool value for 'hostDrive'
True if this corresponds to a drive on the host.
"""
ret = self._get_attr("hostDrive")
return ret
@property
def size(self):
"""Get int value for 'size'
Physical size of the storage unit used to hold medium data (in bytes).
For media whose :py:func:`state` is :py:attr:`MediumState.inaccessible` , the value of this property is the
last known size. For :py:attr:`MediumState.not_created` media,
the returned value is zero.
"""
ret = self._get_attr("size")
return ret
@property
def format_p(self):
"""Get str value for 'format'
Storage format of this medium.
The value of this attribute is a string that specifies a backend used
to store medium data. The storage format is defined when you create a
new medium or automatically detected when you open an existing medium,
and cannot be changed later.
The list of all storage formats supported by this VirtualBox
installation can be obtained using
:py:func:`ISystemProperties.medium_formats` .
"""
ret = self._get_attr("format")
return ret
@property
def medium_format(self):
"""Get IMediumFormat value for 'mediumFormat'
Storage medium format object corresponding to this medium.
The value of this attribute is a reference to the medium format object
that specifies the backend properties used to store medium data. The
storage format is defined when you create a new medium or automatically
detected when you open an existing medium, and cannot be changed later.
@c null is returned if there is no associated medium format
object. This can e.g. happen for medium objects representing host
drives and other special medium objects.
"""
ret = self._get_attr("mediumFormat")
return IMediumFormat(ret)
@property
def type_p(self):
"""Get or set MediumType value for 'type'
Type (role) of this medium.
The following constraints apply when changing the value of this
attribute:
If a medium is attached to a virtual machine (either in the
current state or in one of the snapshots), its type cannot be
changed.
As long as the medium has children, its type cannot be set
to :py:attr:`MediumType.writethrough` .
The type of all differencing media is
:py:attr:`MediumType.normal` and cannot be changed.
The type of a newly created or opened medium is set to
:py:attr:`MediumType.normal` , except for DVD and floppy media,
which have a type of :py:attr:`MediumType.writethrough` .
"""
ret = self._get_attr("type")
return MediumType(ret)
@type_p.setter
def type_p(self, value):
if not isinstance(value, MediumType):
raise TypeError("value is not an instance of MediumType")
return self._set_attr("type", value)
@property
def allowed_types(self):
"""Get MediumType value for 'allowedTypes'
Returns which medium types can selected for this medium.
"""
ret = self._get_attr("allowedTypes")
return [MediumType(a) for a in ret]
@property
def parent(self):
"""Get IMedium value for 'parent'
Parent of this medium (the medium this medium is directly based
on).
Only differencing media have parents. For base (non-differencing)
media, @c null is returned.
"""
ret = self._get_attr("parent")
return IMedium(ret)
@property
def children(self):
"""Get IMedium value for 'children'
Children of this medium (all differencing media directly based
on this medium). A @c null array is returned if this medium
does not have any children.
"""
ret = self._get_attr("children")
return [IMedium(a) for a in ret]
@property
def base(self):
"""Get IMedium value for 'base'
Base medium of this medium.
If this is a differencing medium, its base medium is the medium
the given medium branch starts from. For all other types of media, this
property returns the medium object itself (i.e. the same object this
property is read on).
"""
ret = self._get_attr("base")
return IMedium(ret)
@property
def read_only(self):
"""Get bool value for 'readOnly'
Returns @c true if this medium is read-only and @c false otherwise.
A medium is considered to be read-only when its contents cannot be
modified without breaking the integrity of other parties that depend on
this medium such as its child media or snapshots of virtual machines
where this medium is attached to these machines. If there are no
children and no such snapshots then there is no dependency and the
medium is not read-only.
The value of this attribute can be used to determine the kind of the
attachment that will take place when attaching this medium to a
virtual machine. If the value is @c false then the medium will
be attached directly. If the value is @c true then the medium
will be attached indirectly by creating a new differencing child
medium for that. See the interface description for more information.
Note that all :py:attr:`MediumType.immutable` Immutable media
are always read-only while all
:py:attr:`MediumType.writethrough` Writethrough media are
always not.
The read-only condition represented by this attribute is related to
the medium type and usage, not to the current
:py:func:`IMedium.state` medium state and not to the read-only
state of the storage unit.
"""
ret = self._get_attr("readOnly")
return ret
@property
def logical_size(self):
"""Get int value for 'logicalSize'
Logical size of this medium (in bytes), as reported to the
guest OS running inside the virtual machine this medium is
attached to. The logical size is defined when the medium is created
and cannot be changed later.
For media whose state is :py:func:`state` is :py:attr:`MediumState.inaccessible` , the value of this property is the
last known logical size. For :py:attr:`MediumState.not_created`
media, the returned value is zero.
"""
ret = self._get_attr("logicalSize")
return ret
@property
def auto_reset(self):
"""Get or set bool value for 'autoReset'
Whether this differencing medium will be automatically reset each
time a virtual machine it is attached to is powered up. This
attribute is automatically set to @c true for the last
differencing image of an "immutable" medium (see
:py:class:`MediumType` ).
See :py:func:`reset` for more information about resetting
differencing media.
Reading this property on a base (non-differencing) medium will
always @c false. Changing the value of this property in this
case is not supported.
"""
ret = self._get_attr("autoReset")
return ret
@auto_reset.setter
def auto_reset(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("autoReset", value)
@property
def last_access_error(self):
"""Get str value for 'lastAccessError'
Text message that represents the result of the last accessibility
check performed by :py:func:`refresh_state` .
An empty string is returned if the last accessibility check
was successful or has not yet been called. As a result, if
:py:func:`state` is "Inaccessible" and this attribute is empty,
then :py:func:`refresh_state` has yet to be called; this is the
default value of media after VirtualBox initialization.
A non-empty string indicates a failure and should normally describe
a reason of the failure (for example, a file read error).
"""
ret = self._get_attr("lastAccessError")
return ret
@property
def machine_ids(self):
"""Get str value for 'machineIds'
Array of UUIDs of all machines this medium is attached to.
A @c null array is returned if this medium is not attached to any
machine or to any machine's snapshot.
The returned array will include a machine even if this medium is not
attached to that machine in the current state but attached to it in
one of the machine's snapshots. See :py:func:`get_snapshot_ids` for
details.
"""
ret = self._get_attr("machineIds")
return ret
[docs] def set_ids(self, set_image_id, image_id, set_parent_id, parent_id):
"""Changes the UUID and parent UUID for a hard disk medium.
in set_image_id of type bool
Select whether a new image UUID is set or not.
in image_id of type str
New UUID for the image. If an empty string is passed, then a new
UUID is automatically created, provided that @a setImageId is @c true.
Specifying a zero UUID is not allowed.
in set_parent_id of type bool
Select whether a new parent UUID is set or not.
in parent_id of type str
New parent UUID for the image. If an empty string is passed, then a
new UUID is automatically created, provided @a setParentId is
@c true. A zero UUID is valid.
raises :class:`OleErrorInvalidarg`
Invalid parameter combination.
raises :class:`VBoxErrorNotSupported`
Medium is not a hard disk medium.
"""
if not isinstance(set_image_id, bool):
raise TypeError("set_image_id can only be an instance of type bool")
if not isinstance(image_id, basestring):
raise TypeError("image_id can only be an instance of type basestring")
if not isinstance(set_parent_id, bool):
raise TypeError("set_parent_id can only be an instance of type bool")
if not isinstance(parent_id, basestring):
raise TypeError("parent_id can only be an instance of type basestring")
self._call("setIds",
in_p=[set_image_id, image_id, set_parent_id, parent_id])
[docs] def refresh_state(self):
"""If the current medium state (see :py:class:`MediumState` ) is one of
"Created", "Inaccessible" or "LockedRead", then this performs an
accessibility check on the medium and sets the value of the :py:func:`state`
attribute accordingly; that value is also returned for convenience.
For all other state values, this does not perform a refresh but returns
the state only.
The refresh, if performed, may take a long time (several seconds or even
minutes, depending on the storage unit location and format) because it performs an
accessibility check of the storage unit. This check may cause a significant
delay if the storage unit of the given medium is, for example, a file located
on a network share which is not currently accessible due to connectivity
problems. In that case, the call will not return until a timeout
interval defined by the host OS for this operation expires. For this reason,
it is recommended to never read this attribute on the main UI thread to avoid
making the UI unresponsive.
If the last known state of the medium is "Created" and the accessibility
check fails, then the state would be set to "Inaccessible", and
:py:func:`last_access_error` may be used to get more details about the
failure. If the state of the medium is "LockedRead", then it remains the
same, and a non-empty value of :py:func:`last_access_error` will
indicate a failed accessibility check in this case.
Note that not all medium states are applicable to all medium types.
return state of type :class:`MediumState`
New medium state.
"""
state = self._call("refreshState")
state = MediumState(state)
return state
[docs] def get_snapshot_ids(self, machine_id):
"""Returns an array of UUIDs of all snapshots of the given machine where
this medium is attached to.
If the medium is attached to the machine in the current state, then the
first element in the array will always be the ID of the queried machine
(i.e. the value equal to the @c machineId argument), followed by
snapshot IDs (if any).
If the medium is not attached to the machine in the current state, then
the array will contain only snapshot IDs.
The returned array may be @c null if this medium is not attached
to the given machine at all, neither in the current state nor in one of
the snapshots.
in machine_id of type str
UUID of the machine to query.
return snapshot_ids of type str
Array of snapshot UUIDs of the given machine using this medium.
"""
if not isinstance(machine_id, basestring):
raise TypeError("machine_id can only be an instance of type basestring")
snapshot_ids = self._call("getSnapshotIds",
in_p=[machine_id])
return snapshot_ids
[docs] def lock_read(self):
"""Locks this medium for reading.
A read lock is shared: many clients can simultaneously lock the
same medium for reading unless it is already locked for writing (see
:py:func:`lock_write` ) in which case an error is returned.
When the medium is locked for reading, it cannot be modified
from within VirtualBox. This means that any method that changes
the properties of this medium or contents of the storage unit
will return an error (unless explicitly stated otherwise). That
includes an attempt to start a virtual machine that wants to
write to the medium.
When the virtual machine is started up, it locks for reading all
media it uses in read-only mode. If some medium cannot be locked
for reading, the startup procedure will fail.
A medium is typically locked for reading while it is used by a running
virtual machine but has a depending differencing image that receives
the actual write operations. This way one base medium can have
multiple child differencing images which can be written to
simultaneously. Read-only media such as DVD and floppy images are
also locked for reading only (so they can be in use by multiple
machines simultaneously).
A medium is also locked for reading when it is the source of a
write operation such as :py:func:`clone_to` or :py:func:`merge_to` .
The medium locked for reading must be unlocked by abandoning the
returned token object, see :py:class:`IToken` . Calls to
:py:func:`lock_read` can be nested and the lock is actually released
when all callers have abandoned the token.
This method sets the medium state (see :py:func:`state` ) to
"LockedRead" on success. The medium's previous state must be
one of "Created", "Inaccessible" or "LockedRead".
Locking an inaccessible medium is not an error; this method performs
a logical lock that prevents modifications of this medium through
the VirtualBox API, not a physical file-system lock of the underlying
storage unit.
This method returns the current state of the medium
*before* the operation.
return token of type :class:`IToken`
Token object, when this is released (reference count reaches 0) then
the lock count is decreased. The lock is released when the lock count
reaches 0.
raises :class:`VBoxErrorInvalidObjectState`
Invalid medium state (e.g. not created, locked, inaccessible,
creating, deleting).
"""
token = self._call("lockRead")
token = IToken(token)
return token
[docs] def lock_write(self):
"""Locks this medium for writing.
A write lock, as opposed to :py:func:`lock_read` , is
exclusive: there may be only one client holding a write lock,
and there may be no read locks while the write lock is held.
As a result, read-locking fails if a write lock is held, and
write-locking fails if either a read or another write lock is held.
When a medium is locked for writing, it cannot be modified
from within VirtualBox, and it is not guaranteed that the values
of its properties are up-to-date. Any method that changes the
properties of this medium or contents of the storage unit will
return an error (unless explicitly stated otherwise).
When a virtual machine is started up, it locks for writing all
media it uses to write data to. If any medium could not be locked
for writing, the startup procedure will fail. If a medium has
differencing images, then while the machine is running, only
the last ("leaf") differencing image is locked for writing,
whereas its parents are locked for reading only.
A medium is also locked for writing when it is the target of a
write operation such as :py:func:`clone_to` or :py:func:`merge_to` .
The medium locked for writing must be unlocked by abandoning the
returned token object, see :py:class:`IToken` . Write locks
*cannot* be nested.
This method sets the medium state (see :py:func:`state` ) to
"LockedWrite" on success. The medium's previous state must be
either "Created" or "Inaccessible".
Locking an inaccessible medium is not an error; this method performs
a logical lock that prevents modifications of this medium through
the VirtualBox API, not a physical file-system lock of the underlying
storage unit.
return token of type :class:`IToken`
Token object, when this is released (reference count reaches 0) then
the lock is released.
raises :class:`VBoxErrorInvalidObjectState`
Invalid medium state (e.g. not created, locked, inaccessible,
creating, deleting).
"""
token = self._call("lockWrite")
token = IToken(token)
return token
[docs] def close(self):
"""Closes this medium.
The medium must not be attached to any known virtual machine
and must not have any known child media, otherwise the
operation will fail.
When the medium is successfully closed, it is removed from
the list of registered media, but its storage unit is not
deleted. In particular, this means that this medium can
later be opened again using the :py:func:`IVirtualBox.open_medium`
call.
Note that after this method successfully returns, the given medium
object becomes uninitialized. This means that any attempt
to call any of its methods or attributes will fail with the
"Object not ready" (E_ACCESSDENIED) error.
raises :class:`VBoxErrorInvalidObjectState`
Invalid medium state (other than not created, created or
inaccessible).
raises :class:`VBoxErrorObjectInUse`
Medium attached to virtual machine.
raises :class:`VBoxErrorFileError`
Settings file not accessible.
raises :class:`VBoxErrorXmlError`
Could not parse the settings file.
"""
self._call("close")
[docs] def get_property(self, name):
"""Returns the value of the custom medium property with the given name.
The list of all properties supported by the given medium format can
be obtained with :py:func:`IMediumFormat.describe_properties` .
If this method returns an empty string in @a value, the requested
property is supported but currently not assigned any value.
in name of type str
Name of the property to get.
return value of type str
Current property value.
raises :class:`VBoxErrorObjectNotFound`
Requested property does not exist (not supported by the format).
raises :class:`OleErrorInvalidarg`
@a name is @c null or empty.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
value = self._call("getProperty",
in_p=[name])
return value
[docs] def set_property(self, name, value):
"""Sets the value of the custom medium property with the given name.
The list of all properties supported by the given medium format can
be obtained with :py:func:`IMediumFormat.describe_properties` .
Setting the property value to @c null or an empty string is
equivalent to deleting the existing value. A default value (if it is
defined for this property) will be used by the format backend in this
case.
in name of type str
Name of the property to set.
in value of type str
Property value to set.
raises :class:`VBoxErrorObjectNotFound`
Requested property does not exist (not supported by the format).
raises :class:`OleErrorInvalidarg`
@a name is @c null or empty.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setProperty",
in_p=[name, value])
[docs] def get_properties(self, names):
"""Returns values for a group of properties in one call.
The names of the properties to get are specified using the @a names
argument which is a list of comma-separated property names or
an empty string if all properties are to be returned.
Currently the value of this argument is ignored and the method
always returns all existing properties.
The list of all properties supported by the given medium format can
be obtained with :py:func:`IMediumFormat.describe_properties` .
The method returns two arrays, the array of property names corresponding
to the @a names argument and the current values of these properties.
Both arrays have the same number of elements with each element at the
given index in the first array corresponds to an element at the same
index in the second array.
For properties that do not have assigned values, an empty string is
returned at the appropriate index in the @a returnValues array.
in names of type str
Names of properties to get.
out return_names of type str
Names of returned properties.
return return_values of type str
Values of returned properties.
"""
if not isinstance(names, basestring):
raise TypeError("names can only be an instance of type basestring")
(return_values, return_names) = self._call("getProperties",
in_p=[names])
return (return_values, return_names)
[docs] def set_properties(self, names, values):
"""Sets values for a group of properties in one call.
The names of the properties to set are passed in the @a names
array along with the new values for them in the @a values array. Both
arrays have the same number of elements with each element at the given
index in the first array corresponding to an element at the same index
in the second array.
If there is at least one property name in @a names that is not valid,
the method will fail before changing the values of any other properties
from the @a names array.
Using this method over :py:func:`set_property` is preferred if you
need to set several properties at once since it is more efficient.
The list of all properties supported by the given medium format can
be obtained with :py:func:`IMediumFormat.describe_properties` .
Setting the property value to @c null or an empty string is equivalent
to deleting the existing value. A default value (if it is defined for
this property) will be used by the format backend in this case.
in names of type str
Names of properties to set.
in values of type str
Values of properties to set.
"""
if not isinstance(names, list):
raise TypeError("names can only be an instance of type list")
for a in names[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(values, list):
raise TypeError("values can only be an instance of type list")
for a in values[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("setProperties",
in_p=[names, values])
[docs] def create_base_storage(self, logical_size, variant):
"""Starts creating a hard disk storage unit (fixed/dynamic, according
to the variant flags) in in the background. The previous storage unit
created for this object, if any, must first be deleted using
:py:func:`delete_storage` , otherwise the operation will fail.
Before the operation starts, the medium is placed in
:py:attr:`MediumState.creating` state. If the create operation
fails, the medium will be placed back in :py:attr:`MediumState.not_created`
state.
After the returned progress object reports that the operation has
successfully completed, the medium state will be set to :py:attr:`MediumState.created` , the medium will be remembered by this
VirtualBox installation and may be attached to virtual machines.
in logical_size of type int
Maximum logical size of the medium in bytes.
in variant of type :class:`MediumVariant`
Exact image variant which should be created (as a combination of
:py:class:`MediumVariant` flags).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
The variant of storage creation operation is not supported. See
"""
if not isinstance(logical_size, baseinteger):
raise TypeError("logical_size can only be an instance of type baseinteger")
if not isinstance(variant, list):
raise TypeError("variant can only be an instance of type list")
for a in variant[:10]:
if not isinstance(a, MediumVariant):
raise TypeError(\
"array can only contain objects of type MediumVariant")
progress = self._call("createBaseStorage",
in_p=[logical_size, variant])
progress = IProgress(progress)
return progress
[docs] def delete_storage(self):
"""Starts deleting the storage unit of this medium.
The medium must not be attached to any known virtual machine and must
not have any known child media, otherwise the operation will fail.
It will also fail if there is no storage unit to delete or if deletion
is already in progress, or if the medium is being in use (locked for
read or for write) or inaccessible. Therefore, the only valid state for
this operation to succeed is :py:attr:`MediumState.created` .
Before the operation starts, the medium is placed in
:py:attr:`MediumState.deleting` state and gets removed from the list
of remembered hard disks (media registry). If the delete operation
fails, the medium will be remembered again and placed back to
:py:attr:`MediumState.created` state.
After the returned progress object reports that the operation is
complete, the medium state will be set to
:py:attr:`MediumState.not_created` and you will be able to use one of
the storage creation methods to create it again.
:py:func:`close`
If the deletion operation fails, it is not guaranteed that the storage
unit still exists. You may check the :py:func:`IMedium.state` value
to answer this question.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorObjectInUse`
Medium is attached to a virtual machine.
raises :class:`VBoxErrorNotSupported`
Storage deletion is not allowed because neither of storage creation
operations are supported. See
"""
progress = self._call("deleteStorage")
progress = IProgress(progress)
return progress
[docs] def create_diff_storage(self, target, variant):
"""Starts creating an empty differencing storage unit based on this
medium in the format and at the location defined by the @a target
argument.
The target medium must be in :py:attr:`MediumState.not_created`
state (i.e. must not have an existing storage unit). Upon successful
completion, this operation will set the type of the target medium to
:py:attr:`MediumType.normal` and create a storage unit necessary to
represent the differencing medium data in the given format (according
to the storage format of the target object).
After the returned progress object reports that the operation is
successfully complete, the target medium gets remembered by this
VirtualBox installation and may be attached to virtual machines.
The medium will be set to :py:attr:`MediumState.locked_read`
state for the duration of this operation.
in target of type :class:`IMedium`
Target medium.
in variant of type :class:`MediumVariant`
Exact image variant which should be created (as a combination of
:py:class:`MediumVariant` flags).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorObjectInUse`
Medium not in @c NotCreated state.
"""
if not isinstance(target, IMedium):
raise TypeError("target can only be an instance of type IMedium")
if not isinstance(variant, list):
raise TypeError("variant can only be an instance of type list")
for a in variant[:10]:
if not isinstance(a, MediumVariant):
raise TypeError(\
"array can only contain objects of type MediumVariant")
progress = self._call("createDiffStorage",
in_p=[target, variant])
progress = IProgress(progress)
return progress
[docs] def merge_to(self, target):
"""Starts merging the contents of this medium and all intermediate
differencing media in the chain to the given target medium.
The target medium must be either a descendant of this medium or
its ancestor (otherwise this method will immediately return a failure).
It follows that there are two logical directions of the merge operation:
from ancestor to descendant (*forward merge*) and from descendant to
ancestor (*backward merge*). Let us consider the following medium
chain:
Base <- Diff_1 <- Diff_2
Here, calling this method on the Base medium object with
Diff_2 as an argument will be a forward merge; calling it on
Diff_2 with Base as an argument will be a backward
merge. Note that in both cases the contents of the resulting medium
will be the same, the only difference is the medium object that takes
the result of the merge operation. In case of the forward merge in the
above example, the result will be written to Diff_2; in case of
the backward merge, the result will be written to Base. In
other words, the result of the operation is always stored in the target
medium.
Upon successful operation completion, the storage units of all media in
the chain between this (source) medium and the target medium, including
the source medium itself, will be automatically deleted and the
relevant medium objects (including this medium) will become
uninitialized. This means that any attempt to call any of
their methods or attributes will fail with the
"Object not ready" (E_ACCESSDENIED) error. Applied to the above
example, the forward merge of Base to Diff_2 will
delete and uninitialize both Base and Diff_1 media.
Note that Diff_2 in this case will become a base medium
itself since it will no longer be based on any other medium.
Considering the above, all of the following conditions must be met in
order for the merge operation to succeed:
Neither this (source) medium nor any intermediate
differencing medium in the chain between it and the target
medium is attached to any virtual machine.
Neither the source medium nor the target medium is an
:py:attr:`MediumType.immutable` medium.
The part of the medium tree from the source medium to the
target medium is a linear chain, i.e. all medium in this
chain have exactly one child which is the next medium in this
chain. The only exception from this rule is the target medium in
the forward merge operation; it is allowed to have any number of
child media because the merge operation will not change its
logical contents (as it is seen by the guest OS or by children).
None of the involved media are in
:py:attr:`MediumState.locked_read` or
:py:attr:`MediumState.locked_write` state.
This (source) medium and all intermediates will be placed to :py:attr:`MediumState.deleting` state and the target medium will be
placed to :py:attr:`MediumState.locked_write` state and for the
duration of this operation.
in target of type :class:`IMedium`
Target medium.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
"""
if not isinstance(target, IMedium):
raise TypeError("target can only be an instance of type IMedium")
progress = self._call("mergeTo",
in_p=[target])
progress = IProgress(progress)
return progress
[docs] def clone_to(self, target, variant, parent):
"""Starts creating a clone of this medium in the format and at the
location defined by the @a target argument.
The target medium must be either in :py:attr:`MediumState.not_created`
state (i.e. must not have an existing storage unit) or in
:py:attr:`MediumState.created` state (i.e. created and not locked, and
big enough to hold the data or else the copy will be partial). Upon
successful completion, the cloned medium will contain exactly the
same sector data as the medium being cloned, except that in the
first case a new UUID for the clone will be randomly generated, and in
the second case the UUID will remain unchanged.
The @a parent argument defines which medium will be the parent
of the clone. Passing a @c null reference indicates that the clone will
be a base image, i.e. completely independent. It is possible to specify
an arbitrary medium for this parameter, including the parent of the
medium which is being cloned. Even cloning to a child of the source
medium is possible. Note that when cloning to an existing image, the
@a parent argument is ignored.
After the returned progress object reports that the operation is
successfully complete, the target medium gets remembered by this
VirtualBox installation and may be attached to virtual machines.
This medium will be placed to :py:attr:`MediumState.locked_read`
state for the duration of this operation.
in target of type :class:`IMedium`
Target medium.
in variant of type :class:`MediumVariant`
Exact image variant which should be created (as a combination of
:py:class:`MediumVariant` flags).
in parent of type :class:`IMedium`
Parent of the cloned medium.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorNotimpl`
The specified cloning variant is not supported at the moment.
"""
if not isinstance(target, IMedium):
raise TypeError("target can only be an instance of type IMedium")
if not isinstance(variant, list):
raise TypeError("variant can only be an instance of type list")
for a in variant[:10]:
if not isinstance(a, MediumVariant):
raise TypeError(\
"array can only contain objects of type MediumVariant")
if not isinstance(parent, IMedium):
raise TypeError("parent can only be an instance of type IMedium")
progress = self._call("cloneTo",
in_p=[target, variant, parent])
progress = IProgress(progress)
return progress
[docs] def clone_to_base(self, target, variant):
"""Starts creating a clone of this medium in the format and at the
location defined by the @a target argument.
The target medium must be either in :py:attr:`MediumState.not_created`
state (i.e. must not have an existing storage unit) or in
:py:attr:`MediumState.created` state (i.e. created and not locked, and
big enough to hold the data or else the copy will be partial). Upon
successful completion, the cloned medium will contain exactly the
same sector data as the medium being cloned, except that in the
first case a new UUID for the clone will be randomly generated, and in
the second case the UUID will remain unchanged.
The @a parent argument defines which medium will be the parent
of the clone. In this case the clone will be a base image, i.e.
completely independent. It is possible to specify an arbitrary
medium for this parameter, including the parent of the
medium which is being cloned. Even cloning to a child of the source
medium is possible. Note that when cloning to an existing image, the
@a parent argument is ignored.
After the returned progress object reports that the operation is
successfully complete, the target medium gets remembered by this
VirtualBox installation and may be attached to virtual machines.
This medium will be placed to :py:attr:`MediumState.locked_read`
state for the duration of this operation.
in target of type :class:`IMedium`
Target medium.
in variant of type :class:`MediumVariant`
:py:class:`MediumVariant` flags).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorNotimpl`
The specified cloning variant is not supported at the moment.
"""
if not isinstance(target, IMedium):
raise TypeError("target can only be an instance of type IMedium")
if not isinstance(variant, list):
raise TypeError("variant can only be an instance of type list")
for a in variant[:10]:
if not isinstance(a, MediumVariant):
raise TypeError(\
"array can only contain objects of type MediumVariant")
progress = self._call("cloneToBase",
in_p=[target, variant])
progress = IProgress(progress)
return progress
[docs] def set_location(self, location):
"""Changes the location of this medium. Some medium types may support
changing the storage unit location by simply changing the value of the
associated property. In this case the operation is performed
immediately, and @a progress is returning a @c null reference.
Otherwise on success there is a progress object returned, which
signals progress and completion of the operation. This distinction is
necessary because for some formats the operation is very fast, while
for others it can be very slow (moving the image file by copying all
data), and in the former case it'd be a waste of resources to create
a progress object which will immediately signal completion.
When setting a location for a medium which corresponds to a/several
regular file(s) in the host's file system, the given file name may be
either relative to the :py:func:`IVirtualBox.home_folder` VirtualBox
home folder or absolute. Note that if the given location
specification does not contain the file extension part then a proper
default extension will be automatically appended by the implementation
depending on the medium type.
in location of type str
New location.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorNotimpl`
The operation is not implemented yet.
raises :class:`VBoxErrorNotSupported`
Medium format does not support changing the location.
"""
if not isinstance(location, basestring):
raise TypeError("location can only be an instance of type basestring")
progress = self._call("setLocation",
in_p=[location])
progress = IProgress(progress)
return progress
[docs] def compact(self):
"""Starts compacting of this medium. This means that the medium is
transformed into a possibly more compact storage representation.
This potentially creates temporary images, which can require a
substantial amount of additional disk space.
This medium will be placed to :py:attr:`MediumState.locked_write`
state and all its parent media (if any) will be placed to
:py:attr:`MediumState.locked_read` state for the duration of this
operation.
Please note that the results can be either returned straight away,
or later as the result of the background operation via the object
returned via the @a progress parameter.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
Medium format does not support compacting (but potentially
needs it).
"""
progress = self._call("compact")
progress = IProgress(progress)
return progress
[docs] def resize(self, logical_size):
"""Starts resizing this medium. This means that the nominal size of the
medium is set to the new value. Both increasing and decreasing the
size is possible, and there are no safety checks, since VirtualBox
does not make any assumptions about the medium contents.
Resizing usually needs additional disk space, and possibly also
some temporary disk space. Note that resize does not create a full
temporary copy of the medium, so the additional disk space requirement
is usually much lower than using the clone operation.
This medium will be placed to :py:attr:`MediumState.locked_write`
state for the duration of this operation.
Please note that the results can be either returned straight away,
or later as the result of the background operation via the object
returned via the @a progress parameter.
in logical_size of type int
New nominal capacity of the medium in bytes.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
Medium format does not support resizing.
"""
if not isinstance(logical_size, baseinteger):
raise TypeError("logical_size can only be an instance of type baseinteger")
progress = self._call("resize",
in_p=[logical_size])
progress = IProgress(progress)
return progress
[docs] def reset(self):
"""Starts erasing the contents of this differencing medium.
This operation will reset the differencing medium to its initial
state when it does not contain any sector data and any read operation is
redirected to its parent medium. This automatically gets called
during VM power-up for every medium whose :py:func:`auto_reset`
attribute is @c true.
The medium will be write-locked for the duration of this operation (see
:py:func:`lock_write` ).
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
This is not a differencing medium.
raises :class:`VBoxErrorInvalidObjectState`
Medium is not in
"""
progress = self._call("reset")
progress = IProgress(progress)
return progress
[docs] def change_encryption(self, current_password, cipher, new_password, new_password_id):
"""Starts encryption of this medium. This means that the stored data in the
medium is encrypted.
This medium will be placed to :py:attr:`MediumState.locked_write`
state.
Please note that the results can be either returned straight away,
or later as the result of the background operation via the object
returned via the @a progress parameter.
in current_password of type str
The current password the medium is protected with. Use an empty string to indicate
that the medium isn't encrypted.
in cipher of type str
The cipher to use for encryption. An empty string indicates no encryption for the
result.
in new_password of type str
The new password the medium should be protected with. An empty password and password ID
will result in the medium being encrypted with the current password.
in new_password_id of type str
The ID of the new password when unlocking the medium.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorNotSupported`
Encryption is not supported for this medium because it is attached to more than one VM
or has children.
"""
if not isinstance(current_password, basestring):
raise TypeError("current_password can only be an instance of type basestring")
if not isinstance(cipher, basestring):
raise TypeError("cipher can only be an instance of type basestring")
if not isinstance(new_password, basestring):
raise TypeError("new_password can only be an instance of type basestring")
if not isinstance(new_password_id, basestring):
raise TypeError("new_password_id can only be an instance of type basestring")
progress = self._call("changeEncryption",
in_p=[current_password, cipher, new_password, new_password_id])
progress = IProgress(progress)
return progress
[docs] def get_encryption_settings(self):
"""Returns the encryption settings for this medium.
out cipher of type str
The cipher used for encryption.
return password_id of type str
The ID of the password when unlocking the medium.
raises :class:`VBoxErrorNotSupported`
Encryption is not configured for this medium.
"""
(password_id, cipher) = self._call("getEncryptionSettings")
return (password_id, cipher)
[docs] def check_encryption_password(self, password):
"""Checks whether the supplied password is correct for the medium.
in password of type str
The password to check.
raises :class:`VBoxErrorNotSupported`
Encryption is not configured for this medium.
raises :class:`VBoxErrorPasswordIncorrect`
The given password is incorrect.
"""
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
self._call("checkEncryptionPassword",
in_p=[password])
[docs]class IToken(Interface):
"""
The IToken interface represents a token passed to an API client, which
triggers cleanup actions when it is explicitly released by calling the
:py:func:`abandon` method (preferred, as it is accurately defined
when the release happens), or when the object reference count drops
to 0. The latter way is implicitly used when an API client crashes,
however the discovery that there was a crash can take rather long,
depending on the platform (COM needs 6 minutes). So better don't rely
on the crash behavior too much.
"""
__uuid__ = '20479eaf-d8ed-44cf-85ac-c83a26c95a4d'
__wsmap__ = 'managed'
[docs] def abandon(self):
"""Releases this token. Cannot be undone in any way, and makes the
token object unusable (even the :py:func:`dummy` method will return
an error), ready for releasing. It is a more defined way than just
letting the reference count drop to 0, because the latter (depending
on the platform) can trigger asynchronous cleanup activity.
"""
self._call("abandon")
[docs] def dummy(self):
"""Purely a NOOP. Useful when using proxy type API bindings (e.g. the
webservice) which manage objects on behalf of the actual client, using
an object reference expiration time based garbage collector.
"""
self._call("dummy")
class IKeyboard(Interface):
"""
The IKeyboard interface represents the virtual machine's keyboard. Used
in :py:func:`IConsole.keyboard` .
Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
to the virtual machine.
"""
__uuid__ = 'da91d4c9-4c02-fdb1-c5ac-d89e22e81302'
__wsmap__ = 'managed'
@property
def keyboard_le_ds(self):
"""Get KeyboardLED value for 'keyboardLEDs'
Current status of the guest keyboard LEDs.
"""
ret = self._get_attr("keyboardLEDs")
return [KeyboardLED(a) for a in ret]
[docs] def put_scancode(self, scancode):
"""Sends a scancode to the keyboard.
in scancode of type int
raises :class:`VBoxErrorIprtError`
Could not send scan code to virtual keyboard.
"""
if not isinstance(scancode, baseinteger):
raise TypeError("scancode can only be an instance of type baseinteger")
self._call("putScancode",
in_p=[scancode])
[docs] def put_scancodes(self, scancodes):
"""Sends an array of scancodes to the keyboard.
in scancodes of type int
return codes_stored of type int
raises :class:`VBoxErrorIprtError`
Could not send all scan codes to virtual keyboard.
"""
if not isinstance(scancodes, list):
raise TypeError("scancodes can only be an instance of type list")
for a in scancodes[:10]:
if not isinstance(a, baseinteger):
raise TypeError(\
"array can only contain objects of type baseinteger")
codes_stored = self._call("putScancodes",
in_p=[scancodes])
return codes_stored
[docs] def put_cad(self):
"""Sends the Ctrl-Alt-Del sequence to the keyboard. This
function is nothing special, it is just a convenience function
calling :py:func:`IKeyboard.put_scancodes` with the proper scancodes.
raises :class:`VBoxErrorIprtError`
Could not send all scan codes to virtual keyboard.
"""
self._call("putCAD")
[docs] def release_keys(self):
"""Causes the virtual keyboard to release any keys which are
currently pressed. Useful when host and guest keyboard may be out
of sync.
raises :class:`VBoxErrorIprtError`
Could not release some or all keys.
"""
self._call("releaseKeys")
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for keyboard events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
[docs]class IMousePointerShape(Interface):
"""
The guest mouse pointer description.
"""
__uuid__ = 'e04e5545-4a0f-f9d2-5bef-f9b25b6557ed'
__wsmap__ = 'managed'
@property
def visible(self):
"""Get bool value for 'visible'
Flag whether the pointer is visible.
"""
ret = self._get_attr("visible")
return ret
@property
def alpha(self):
"""Get bool value for 'alpha'
Flag whether the pointer has an alpha channel.
"""
ret = self._get_attr("alpha")
return ret
@property
def hot_x(self):
"""Get int value for 'hotX'
The pointer hot spot X coordinate.
"""
ret = self._get_attr("hotX")
return ret
@property
def hot_y(self):
"""Get int value for 'hotY'
The pointer hot spot Y coordinate.
"""
ret = self._get_attr("hotY")
return ret
@property
def width(self):
"""Get int value for 'width'
Width of the pointer shape in pixels.
"""
ret = self._get_attr("width")
return ret
@property
def height(self):
"""Get int value for 'height'
Height of the pointer shape in pixels.
"""
ret = self._get_attr("height")
return ret
@property
def shape(self):
"""Get str value for 'shape'
Shape bitmaps.
The @a shape buffer contains a 1bpp (bits per pixel) AND mask
followed by a 32bpp XOR (color) mask.
For pointers without alpha channel the XOR mask pixels are
32 bit values: (lsb)BGR0(msb). For pointers with alpha channel
the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
An AND mask is provided for pointers with alpha channel, so if the
client does not support alpha, the pointer could be
displayed as a normal color pointer.
The AND mask is a 1bpp bitmap with byte aligned scanlines. The
size of the AND mask therefore is cbAnd = (width + 7) / 8 *
height. The padding bits at the end of each scanline are
undefined.
The XOR mask follows the AND mask on the next 4-byte aligned
offset: uint8_t *pu8Xor = pu8And + (cbAnd + 3) & ~3.
Bytes in the gap between the AND and the XOR mask are undefined.
The XOR mask scanlines have no gap between them and the size of
the XOR mask is: cbXor = width * 4 * height.
If @a shape size is 0, then the shape is not known or did not change.
This can happen if only the pointer visibility is changed.
"""
ret = self._get_attr("shape")
return ret
class IMouse(Interface):
"""
The IMouse interface represents the virtual machine's mouse. Used in
:py:func:`IConsole.mouse` .
Through this interface, the virtual machine's virtual mouse can be
controlled.
"""
__uuid__ = 'ee35adb0-4748-3e12-e7fd-5aad957bba0f'
__wsmap__ = 'managed'
@property
def absolute_supported(self):
"""Get bool value for 'absoluteSupported'
Whether the guest OS supports absolute mouse pointer positioning
or not.
You can use the :py:class:`IMouseCapabilityChangedEvent`
event to be instantly informed about changes of this attribute
during virtual machine execution.
:py:func:`put_mouse_event_absolute`
"""
ret = self._get_attr("absoluteSupported")
return ret
@property
def relative_supported(self):
"""Get bool value for 'relativeSupported'
Whether the guest OS supports relative mouse pointer positioning
or not.
You can use the :py:class:`IMouseCapabilityChangedEvent`
event to be instantly informed about changes of this attribute
during virtual machine execution.
:py:func:`put_mouse_event`
"""
ret = self._get_attr("relativeSupported")
return ret
@property
def multi_touch_supported(self):
"""Get bool value for 'multiTouchSupported'
Whether the guest OS has enabled the multi-touch reporting device.
You can use the :py:class:`IMouseCapabilityChangedEvent`
event to be instantly informed about changes of this attribute
during virtual machine execution.
:py:func:`put_mouse_event`
"""
ret = self._get_attr("multiTouchSupported")
return ret
@property
def needs_host_cursor(self):
"""Get bool value for 'needsHostCursor'
Whether the guest OS can currently switch to drawing it's own mouse
cursor on demand.
You can use the :py:class:`IMouseCapabilityChangedEvent`
event to be instantly informed about changes of this attribute
during virtual machine execution.
:py:func:`put_mouse_event`
"""
ret = self._get_attr("needsHostCursor")
return ret
@property
def pointer_shape(self):
"""Get IMousePointerShape value for 'pointerShape'
The current mouse pointer used by the guest.
"""
ret = self._get_attr("pointerShape")
return IMousePointerShape(ret)
[docs] def put_mouse_event(self, dx, dy, dz, dw, button_state):
"""Initiates a mouse event using relative pointer movements
along x and y axis.
in dx of type int
Amount of pixels the mouse should move to the right.
Negative values move the mouse to the left.
in dy of type int
Amount of pixels the mouse should move downwards.
Negative values move the mouse upwards.
in dz of type int
Amount of mouse wheel moves.
Positive values describe clockwise wheel rotations,
negative values describe counterclockwise rotations.
in dw of type int
Amount of horizontal mouse wheel moves.
Positive values describe a movement to the left,
negative values describe a movement to the right.
in button_state of type int
The current state of mouse buttons. Every bit represents
a mouse button as follows:
Bit 0 (0x01)left mouse button
Bit 1 (0x02)right mouse button
Bit 2 (0x04)middle mouse button
A value of 1 means the corresponding button is pressed.
otherwise it is released.
raises :class:`OleErrorAccessdenied`
Console not powered up.
raises :class:`VBoxErrorIprtError`
Could not send mouse event to virtual mouse.
"""
if not isinstance(dx, baseinteger):
raise TypeError("dx can only be an instance of type baseinteger")
if not isinstance(dy, baseinteger):
raise TypeError("dy can only be an instance of type baseinteger")
if not isinstance(dz, baseinteger):
raise TypeError("dz can only be an instance of type baseinteger")
if not isinstance(dw, baseinteger):
raise TypeError("dw can only be an instance of type baseinteger")
if not isinstance(button_state, baseinteger):
raise TypeError("button_state can only be an instance of type baseinteger")
self._call("putMouseEvent",
in_p=[dx, dy, dz, dw, button_state])
[docs] def put_mouse_event_absolute(self, x, y, dz, dw, button_state):
"""Positions the mouse pointer using absolute x and y coordinates.
These coordinates are expressed in pixels and
start from [1,1] which corresponds to the top left
corner of the virtual display.
This method will have effect only if absolute mouse
positioning is supported by the guest OS.
:py:func:`absolute_supported`
in x of type int
X coordinate of the pointer in pixels, starting from @c 1.
in y of type int
Y coordinate of the pointer in pixels, starting from @c 1.
in dz of type int
Amount of mouse wheel moves.
Positive values describe clockwise wheel rotations,
negative values describe counterclockwise rotations.
in dw of type int
Amount of horizontal mouse wheel moves.
Positive values describe a movement to the left,
negative values describe a movement to the right.
in button_state of type int
The current state of mouse buttons. Every bit represents
a mouse button as follows:
Bit 0 (0x01)left mouse button
Bit 1 (0x02)right mouse button
Bit 2 (0x04)middle mouse button
A value of @c 1 means the corresponding button is pressed.
otherwise it is released.
raises :class:`OleErrorAccessdenied`
Console not powered up.
raises :class:`VBoxErrorIprtError`
Could not send mouse event to virtual mouse.
"""
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(dz, baseinteger):
raise TypeError("dz can only be an instance of type baseinteger")
if not isinstance(dw, baseinteger):
raise TypeError("dw can only be an instance of type baseinteger")
if not isinstance(button_state, baseinteger):
raise TypeError("button_state can only be an instance of type baseinteger")
self._call("putMouseEventAbsolute",
in_p=[x, y, dz, dw, button_state])
[docs] def put_event_multi_touch(self, count, contacts, scan_time):
"""Sends a multi-touch pointer event. The coordinates are expressed in
pixels and start from [1,1] which corresponds to the top left
corner of the virtual display.
The guest may not understand or may choose to ignore this event.
:py:func:`multi_touch_supported`
in count of type int
Number of contacts in the event.
in contacts of type int
Each array element contains packed information about one contact.
Bits 0..15: X coordinate in pixels.
Bits 16..31: Y coordinate in pixels.
Bits 32..39: contact identifier.
Bit 40: "in contact" flag, which indicates that there is a contact with the touch surface.
Bit 41: "in range" flag, the contact is close enough to the touch surface.
All other bits are reserved for future use and must be set to 0.
in scan_time of type int
Timestamp of the event in milliseconds. Only relative time between events is important.
raises :class:`OleErrorAccessdenied`
Console not powered up.
raises :class:`VBoxErrorIprtError`
Could not send event to virtual device.
"""
if not isinstance(count, baseinteger):
raise TypeError("count can only be an instance of type baseinteger")
if not isinstance(contacts, list):
raise TypeError("contacts can only be an instance of type list")
for a in contacts[:10]:
if not isinstance(a, baseinteger):
raise TypeError(\
"array can only contain objects of type baseinteger")
if not isinstance(scan_time, baseinteger):
raise TypeError("scan_time can only be an instance of type baseinteger")
self._call("putEventMultiTouch",
in_p=[count, contacts, scan_time])
[docs] def put_event_multi_touch_string(self, count, contacts, scan_time):
""":py:func:`put_event_multi_touch`
in count of type int
:py:func:`put_event_multi_touch`
in contacts of type str
Contains information about all contacts:
"id1,x1,y1,inContact1,inRange1;...;idN,xN,yN,inContactN,inRangeN".
For example for two contacts: "0,10,20,1,1;1,30,40,1,1"
in scan_time of type int
:py:func:`put_event_multi_touch`
"""
if not isinstance(count, baseinteger):
raise TypeError("count can only be an instance of type baseinteger")
if not isinstance(contacts, basestring):
raise TypeError("contacts can only be an instance of type basestring")
if not isinstance(scan_time, baseinteger):
raise TypeError("scan_time can only be an instance of type baseinteger")
self._call("putEventMultiTouchString",
in_p=[count, contacts, scan_time])
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for mouse events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
[docs]class IDisplaySourceBitmap(Interface):
"""
Information about the screen bitmap.
"""
__uuid__ = '0b78daeb-f52f-43b9-99e8-4a3c226cbe2d'
__wsmap__ = 'suppress'
@property
def screen_id(self):
"""Get int value for 'screenId'"""
ret = self._get_attr("screenId")
return ret
[docs] def query_bitmap_info(self):
"""Information about the screen bitmap.
out address of type str
out width of type int
out height of type int
out bits_per_pixel of type int
out bytes_per_line of type int
out bitmap_format of type :class:`BitmapFormat`
"""
(address, width, height, bits_per_pixel, bytes_per_line, bitmap_format) = self._call("queryBitmapInfo")
bitmap_format = BitmapFormat(bitmap_format)
return (address, width, height, bits_per_pixel, bytes_per_line, bitmap_format)
[docs]class IFramebuffer(Interface):
"""
Frame buffer width, in pixels.
"""
__uuid__ = '8b82295f-415f-1aa1-17fd-9fbbac8edf44'
__wsmap__ = 'managed'
@property
def width(self):
"""Get int value for 'width'
Frame buffer width, in pixels.
"""
ret = self._get_attr("width")
return ret
@property
def height(self):
"""Get int value for 'height'
Frame buffer height, in pixels.
"""
ret = self._get_attr("height")
return ret
@property
def bits_per_pixel(self):
"""Get int value for 'bitsPerPixel'
Color depth, in bits per pixel.
"""
ret = self._get_attr("bitsPerPixel")
return ret
@property
def bytes_per_line(self):
"""Get int value for 'bytesPerLine'
Scan line size, in bytes.
"""
ret = self._get_attr("bytesPerLine")
return ret
@property
def pixel_format(self):
"""Get BitmapFormat value for 'pixelFormat'
Frame buffer pixel format. It's one of the values defined by :py:class:`BitmapFormat` .
This attribute must never (and will never) return :py:attr:`BitmapFormat.opaque` -- the format of the frame
buffer must be always known.
"""
ret = self._get_attr("pixelFormat")
return BitmapFormat(ret)
@property
def height_reduction(self):
"""Get int value for 'heightReduction'
Hint from the frame buffer about how much of the standard
screen height it wants to use for itself. This information is
exposed to the guest through the VESA BIOS and VMMDev interface
so that it can use it for determining its video mode table. It
is not guaranteed that the guest respects the value.
"""
ret = self._get_attr("heightReduction")
return ret
@property
def overlay(self):
"""Get IFramebufferOverlay value for 'overlay'
An alpha-blended overlay which is superposed over the frame buffer.
The initial purpose is to allow the display of icons providing
information about the VM state, including disk activity, in front
ends which do not have other means of doing that. The overlay is
designed to controlled exclusively by IDisplay. It has no locking
of its own, and any changes made to it are not guaranteed to be
visible until the affected portion of IFramebuffer is updated. The
overlay can be created lazily the first time it is requested. This
attribute can also return @c null to signal that the overlay is not
implemented.
"""
ret = self._get_attr("overlay")
return IFramebufferOverlay(ret)
@property
def win_id(self):
"""Get int value for 'winId'
Platform-dependent identifier of the window where context of this
frame buffer is drawn, or zero if there's no such window.
"""
ret = self._get_attr("winId")
return ret
@property
def capabilities(self):
"""Get FramebufferCapabilities value for 'capabilities'
Capabilities of the framebuffer instance.
For the meaning of individual capability flags see
:py:class:`FramebufferCapabilities` .
"""
ret = self._get_attr("capabilities")
return [FramebufferCapabilities(a) for a in ret]
[docs] def notify_update(self, x, y, width, height):
"""Informs about an update.
Gets called by the display object where this buffer is
registered.
in x of type int
in y of type int
in width of type int
in height of type int
"""
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
self._call("notifyUpdate",
in_p=[x, y, width, height])
[docs] def notify_update_image(self, x, y, width, height, image):
"""Informs about an update and provides 32bpp bitmap.
in x of type int
in y of type int
in width of type int
in height of type int
in image of type str
Array with 32BPP image data.
"""
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
if not isinstance(image, list):
raise TypeError("image can only be an instance of type list")
for a in image[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("notifyUpdateImage",
in_p=[x, y, width, height, image])
[docs] def notify_change(self, screen_id, x_origin, y_origin, width, height):
"""Requests a size change.
in screen_id of type int
Logical guest screen number.
in x_origin of type int
Location of the screen in the guest.
in y_origin of type int
Location of the screen in the guest.
in width of type int
Width of the guest display, in pixels.
in height of type int
Height of the guest display, in pixels.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(x_origin, baseinteger):
raise TypeError("x_origin can only be an instance of type baseinteger")
if not isinstance(y_origin, baseinteger):
raise TypeError("y_origin can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
self._call("notifyChange",
in_p=[screen_id, x_origin, y_origin, width, height])
[docs] def video_mode_supported(self, width, height, bpp):
"""Returns whether the frame buffer implementation is willing to
support a given video mode. In case it is not able to render
the video mode (or for some reason not willing), it should
return @c false. Usually this method is called when the guest
asks the VMM device whether a given video mode is supported
so the information returned is directly exposed to the guest.
It is important that this method returns very quickly.
in width of type int
in height of type int
in bpp of type int
return supported of type bool
"""
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
if not isinstance(bpp, baseinteger):
raise TypeError("bpp can only be an instance of type baseinteger")
supported = self._call("videoModeSupported",
in_p=[width, height, bpp])
return supported
[docs] def get_visible_region(self, rectangles, count):
"""Returns the visible region of this frame buffer.
If the @a rectangles parameter is @c null then the value of the
@a count parameter is ignored and the number of elements necessary to
describe the current visible region is returned in @a countCopied.
If @a rectangles is not @c null but @a count is less
than the required number of elements to store region data, the method
will report a failure. If @a count is equal or greater than the
required number of elements, then the actual number of elements copied
to the provided array will be returned in @a countCopied.
The address of the provided array must be in the process space of
this IFramebuffer object.
Method not yet implemented.
in rectangles of type str
Pointer to the @c RTRECT array to receive region data.
in count of type int
Number of @c RTRECT elements in the @a rectangles array.
return count_copied of type int
Number of elements copied to the @a rectangles array.
"""
if not isinstance(rectangles, basestring):
raise TypeError("rectangles can only be an instance of type basestring")
if not isinstance(count, baseinteger):
raise TypeError("count can only be an instance of type baseinteger")
count_copied = self._call("getVisibleRegion",
in_p=[rectangles, count])
return count_copied
[docs] def set_visible_region(self, rectangles, count):
"""Suggests a new visible region to this frame buffer. This region
represents the area of the VM display which is a union of regions of
all top-level windows of the guest operating system running inside the
VM (if the Guest Additions for this system support this
functionality). This information may be used by the frontends to
implement the seamless desktop integration feature.
The address of the provided array must be in the process space of
this IFramebuffer object.
The IFramebuffer implementation must make a copy of the provided
array of rectangles.
Method not yet implemented.
in rectangles of type str
Pointer to the @c RTRECT array.
in count of type int
Number of @c RTRECT elements in the @a rectangles array.
"""
if not isinstance(rectangles, basestring):
raise TypeError("rectangles can only be an instance of type basestring")
if not isinstance(count, baseinteger):
raise TypeError("count can only be an instance of type baseinteger")
self._call("setVisibleRegion",
in_p=[rectangles, count])
[docs] def process_vhwa_command(self, command):
"""Posts a Video HW Acceleration Command to the frame buffer for processing.
The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
are posted from quest to the host to be processed by the host hardware.
The address of the provided command must be in the process space of
this IFramebuffer object.
in command of type str
Pointer to VBOXVHWACMD containing the command to execute.
"""
if not isinstance(command, basestring):
raise TypeError("command can only be an instance of type basestring")
self._call("processVHWACommand",
in_p=[command])
[docs] def notify3_d_event(self, type_p, data):
"""Notifies framebuffer about 3D backend event.
in type_p of type int
event type. Currently only VBOX3D_NOTIFY_EVENT_TYPE_VISIBLE_3DDATA is supported.
in data of type str
event-specific data, depends on the supplied event type
"""
if not isinstance(type_p, baseinteger):
raise TypeError("type_p can only be an instance of type baseinteger")
if not isinstance(data, list):
raise TypeError("data can only be an instance of type list")
for a in data[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("notify3DEvent",
in_p=[type_p, data])
[docs]class IFramebufferOverlay(IFramebuffer):
"""
The IFramebufferOverlay interface represents an alpha blended overlay
for displaying status icons above an IFramebuffer. It is always created
not visible, so that it must be explicitly shown. It only covers a
portion of the IFramebuffer, determined by its width, height and
co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
that order) format, and may be written to directly. Do re-read the
width though, after setting it, as it may be adjusted (increased) to
make it more suitable for the front end.
"""
__uuid__ = 'af398a9a-6b76-4805-8fab-00a9dcf4732b'
__wsmap__ = 'managed'
@property
def x(self):
"""Get int value for 'x'
X position of the overlay, relative to the frame buffer.
"""
ret = self._get_attr("x")
return ret
@property
def y(self):
"""Get int value for 'y'
Y position of the overlay, relative to the frame buffer.
"""
ret = self._get_attr("y")
return ret
@property
def visible(self):
"""Get or set bool value for 'visible'
Whether the overlay is currently visible.
"""
ret = self._get_attr("visible")
return ret
@visible.setter
def visible(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("visible", value)
@property
def alpha(self):
"""Get or set int value for 'alpha'
The global alpha value for the overlay. This may or may not be
supported by a given front end.
"""
ret = self._get_attr("alpha")
return ret
@alpha.setter
def alpha(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("alpha", value)
[docs] def move(self, x, y):
"""Changes the overlay's position relative to the IFramebuffer.
in x of type int
in y of type int
"""
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
self._call("move",
in_p=[x, y])
class IGuestScreenInfo(Interface):
""""""
__uuid__ = '5f99cd4d-bbd2-49ba-b24d-4b5b42fb4c3a'
__wsmap__ = 'managed'
@property
def screen_id(self):
"""Get int value for 'screenId'"""
ret = self._get_attr("screenId")
return ret
@property
def guest_monitor_status(self):
"""Get GuestMonitorStatus value for 'guestMonitorStatus'"""
ret = self._get_attr("guestMonitorStatus")
return GuestMonitorStatus(ret)
@property
def primary(self):
"""Get bool value for 'primary'"""
ret = self._get_attr("primary")
return ret
@property
def origin(self):
"""Get bool value for 'origin'"""
ret = self._get_attr("origin")
return ret
@property
def origin_x(self):
"""Get int value for 'originX'"""
ret = self._get_attr("originX")
return ret
@property
def origin_y(self):
"""Get int value for 'originY'"""
ret = self._get_attr("originY")
return ret
@property
def width(self):
"""Get int value for 'width'"""
ret = self._get_attr("width")
return ret
@property
def height(self):
"""Get int value for 'height'"""
ret = self._get_attr("height")
return ret
@property
def bits_per_pixel(self):
"""Get int value for 'bitsPerPixel'"""
ret = self._get_attr("bitsPerPixel")
return ret
[docs]class IDisplay(Interface):
"""
The IDisplay interface represents the virtual machine's display.
The object implementing this interface is contained in each
:py:func:`IConsole.display` attribute and represents the visual
output of the virtual machine.
The virtual display supports pluggable output targets represented by the
IFramebuffer interface. Examples of the output target are a window on
the host computer or an RDP session's display on a remote computer.
"""
__uuid__ = '02326f63-bcb3-4481-96e0-30d1c2ee97f6'
__wsmap__ = 'managed'
@property
def guest_screen_layout(self):
"""Get IGuestScreenInfo value for 'guestScreenLayout'
Layout of the guest screens.
"""
ret = self._get_attr("guestScreenLayout")
return [IGuestScreenInfo(a) for a in ret]
[docs] def get_screen_resolution(self, screen_id):
"""Queries certain attributes such as display width, height, color depth
and the X and Y origin for a given guest screen.
The parameters @a xOrigin and @a yOrigin return the X and Y
coordinates of the framebuffer's origin.
All return parameters are optional.
in screen_id of type int
out width of type int
out height of type int
out bits_per_pixel of type int
out x_origin of type int
out y_origin of type int
out guest_monitor_status of type :class:`GuestMonitorStatus`
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(width, height, bits_per_pixel, x_origin, y_origin, guest_monitor_status) = self._call("getScreenResolution",
in_p=[screen_id])
guest_monitor_status = GuestMonitorStatus(guest_monitor_status)
return (width, height, bits_per_pixel, x_origin, y_origin, guest_monitor_status)
[docs] def attach_framebuffer(self, screen_id, framebuffer):
"""Sets the graphics update target for a screen.
in screen_id of type int
in framebuffer of type :class:`IFramebuffer`
return id_p of type str
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(framebuffer, IFramebuffer):
raise TypeError("framebuffer can only be an instance of type IFramebuffer")
id_p = self._call("attachFramebuffer",
in_p=[screen_id, framebuffer])
return id_p
[docs] def detach_framebuffer(self, screen_id, id_p):
"""Removes the graphics updates target for a screen.
in screen_id of type int
in id_p of type str
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
self._call("detachFramebuffer",
in_p=[screen_id, id_p])
[docs] def query_framebuffer(self, screen_id):
"""Queries the graphics updates targets for a screen.
in screen_id of type int
return framebuffer of type :class:`IFramebuffer`
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
framebuffer = self._call("queryFramebuffer",
in_p=[screen_id])
framebuffer = IFramebuffer(framebuffer)
return framebuffer
[docs] def set_video_mode_hint(self, display, enabled, change_origin, origin_x, origin_y, width, height, bits_per_pixel):
"""Asks VirtualBox to request the given video mode from
the guest. This is just a hint and it cannot be guaranteed
that the requested resolution will be used. Guest Additions
are required for the request to be seen by guests. The caller
should issue the request and wait for a resolution change and
after a timeout retry.
Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
parameters means that the corresponding values should be taken from the
current video mode (i.e. left unchanged).
If the guest OS supports multi-monitor configuration then the @a display
parameter specifies the number of the guest display to send the hint to:
@c 0 is the primary display, @c 1 is the first secondary and
so on. If the multi-monitor configuration is not supported, @a display
must be @c 0.
in display of type int
The number of the guest display to send the hint to.
in enabled of type bool
@c True, if this guest screen is enabled,
@c False otherwise.
in change_origin of type bool
@c True, if the origin of the guest screen should be changed,
@c False otherwise.
in origin_x of type int
The X origin of the guest screen.
in origin_y of type int
The Y origin of the guest screen.
in width of type int
The width of the guest screen.
in height of type int
The height of the guest screen.
in bits_per_pixel of type int
The number of bits per pixel of the guest screen.
raises :class:`OleErrorInvalidarg`
The @a display is not associated with any monitor.
"""
if not isinstance(display, baseinteger):
raise TypeError("display can only be an instance of type baseinteger")
if not isinstance(enabled, bool):
raise TypeError("enabled can only be an instance of type bool")
if not isinstance(change_origin, bool):
raise TypeError("change_origin can only be an instance of type bool")
if not isinstance(origin_x, baseinteger):
raise TypeError("origin_x can only be an instance of type baseinteger")
if not isinstance(origin_y, baseinteger):
raise TypeError("origin_y can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
if not isinstance(bits_per_pixel, baseinteger):
raise TypeError("bits_per_pixel can only be an instance of type baseinteger")
self._call("setVideoModeHint",
in_p=[display, enabled, change_origin, origin_x, origin_y, width, height, bits_per_pixel])
[docs] def set_seamless_mode(self, enabled):
"""Enables or disables seamless guest display rendering (seamless desktop
integration) mode.
Calling this method has no effect if :py:func:`IGuest.get_facility_status` with facility @c Seamless
does not return @c Active.
in enabled of type bool
"""
if not isinstance(enabled, bool):
raise TypeError("enabled can only be an instance of type bool")
self._call("setSeamlessMode",
in_p=[enabled])
[docs] def take_screen_shot(self, screen_id, address, width, height, bitmap_format):
"""Takes a screen shot of the requested size and format and copies it to the
buffer allocated by the caller and pointed to by @a address.
The buffer size must be enough for a 32 bits per pixel bitmap,
i.e. width * height * 4 bytes.
This API can be used only locally by a VM process through the
COM/XPCOM C++ API as it requires pointer support. It is not
available for scripting languages, Java or any webservice clients.
Unless you are writing a new VM frontend use
:py:func:`take_screen_shot_to_array` .
in screen_id of type int
in address of type str
in width of type int
in height of type int
in bitmap_format of type :class:`BitmapFormat`
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(address, basestring):
raise TypeError("address can only be an instance of type basestring")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
if not isinstance(bitmap_format, BitmapFormat):
raise TypeError("bitmap_format can only be an instance of type BitmapFormat")
self._call("takeScreenShot",
in_p=[screen_id, address, width, height, bitmap_format])
[docs] def take_screen_shot_to_array(self, screen_id, width, height, bitmap_format):
"""Takes a guest screen shot of the requested size and format
and returns it as an array of bytes.
in screen_id of type int
The guest monitor to take screenshot from.
in width of type int
Desired image width.
in height of type int
Desired image height.
in bitmap_format of type :class:`BitmapFormat`
The requested format.
return screen_data of type str
Array with resulting screen data.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
if not isinstance(bitmap_format, BitmapFormat):
raise TypeError("bitmap_format can only be an instance of type BitmapFormat")
screen_data = self._call("takeScreenShotToArray",
in_p=[screen_id, width, height, bitmap_format])
return screen_data
[docs] def draw_to_screen(self, screen_id, address, x, y, width, height):
"""Draws a 32-bpp image of the specified size from the given buffer
to the given point on the VM display.
in screen_id of type int
Monitor to take the screenshot from.
in address of type str
Address to store the screenshot to
in x of type int
Relative to the screen top left corner.
in y of type int
Relative to the screen top left corner.
in width of type int
Desired image width.
in height of type int
Desired image height.
raises :class:`OleErrorNotimpl`
Feature not implemented.
raises :class:`VBoxErrorIprtError`
Could not draw to screen.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(address, basestring):
raise TypeError("address can only be an instance of type basestring")
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
self._call("drawToScreen",
in_p=[screen_id, address, x, y, width, height])
[docs] def invalidate_and_update(self):
"""Does a full invalidation of the VM display and instructs the VM
to update it.
raises :class:`VBoxErrorIprtError`
Could not invalidate and update screen.
"""
self._call("invalidateAndUpdate")
[docs] def invalidate_and_update_screen(self, screen_id):
"""Redraw the specified VM screen.
in screen_id of type int
The guest screen to redraw.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
self._call("invalidateAndUpdateScreen",
in_p=[screen_id])
[docs] def complete_vhwa_command(self, command):
"""Signals that the Video HW Acceleration command has completed.
in command of type str
Pointer to VBOXVHWACMD containing the completed command.
"""
if not isinstance(command, basestring):
raise TypeError("command can only be an instance of type basestring")
self._call("completeVHWACommand",
in_p=[command])
[docs] def viewport_changed(self, screen_id, x, y, width, height):
"""Signals that framebuffer window viewport has changed.
in screen_id of type int
Monitor to take the screenshot from.
in x of type int
Framebuffer x offset.
in y of type int
Framebuffer y offset.
in width of type int
Viewport width.
in height of type int
Viewport height.
raises :class:`OleErrorInvalidarg`
The specified viewport data is invalid.
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(x, baseinteger):
raise TypeError("x can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(width, baseinteger):
raise TypeError("width can only be an instance of type baseinteger")
if not isinstance(height, baseinteger):
raise TypeError("height can only be an instance of type baseinteger")
self._call("viewportChanged",
in_p=[screen_id, x, y, width, height])
[docs] def query_source_bitmap(self, screen_id):
"""Obtains the guest screen bitmap parameters.
in screen_id of type int
out display_source_bitmap of type :class:`IDisplaySourceBitmap`
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
display_source_bitmap = self._call("querySourceBitmap",
in_p=[screen_id])
display_source_bitmap = IDisplaySourceBitmap(display_source_bitmap)
return display_source_bitmap
[docs] def notify_scale_factor_change(self, screen_id, u32_scale_factor_w_multiplied, u32_scale_factor_h_multiplied):
"""Notify OpenGL HGCM host service about graphics content scaling factor change.
in screen_id of type int
in u32_scale_factor_w_multiplied of type int
in u32_scale_factor_h_multiplied of type int
"""
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(u32_scale_factor_w_multiplied, baseinteger):
raise TypeError("u32_scale_factor_w_multiplied can only be an instance of type baseinteger")
if not isinstance(u32_scale_factor_h_multiplied, baseinteger):
raise TypeError("u32_scale_factor_h_multiplied can only be an instance of type baseinteger")
self._call("notifyScaleFactorChange",
in_p=[screen_id, u32_scale_factor_w_multiplied, u32_scale_factor_h_multiplied])
[docs] def notify_hi_dpi_output_policy_change(self, f_unscaled_hi_dpi):
"""Notify OpenGL HGCM host service about HiDPI monitor scaling policy change.
in f_unscaled_hi_dpi of type bool
"""
if not isinstance(f_unscaled_hi_dpi, bool):
raise TypeError("f_unscaled_hi_dpi can only be an instance of type bool")
self._call("notifyHiDPIOutputPolicyChange",
in_p=[f_unscaled_hi_dpi])
[docs] def set_screen_layout(self, screen_layout_mode, guest_screen_info):
"""Set video modes for the guest screens.
in screen_layout_mode of type :class:`ScreenLayoutMode`
in guest_screen_info of type :class:`IGuestScreenInfo`
"""
if not isinstance(screen_layout_mode, ScreenLayoutMode):
raise TypeError("screen_layout_mode can only be an instance of type ScreenLayoutMode")
if not isinstance(guest_screen_info, list):
raise TypeError("guest_screen_info can only be an instance of type list")
for a in guest_screen_info[:10]:
if not isinstance(a, IGuestScreenInfo):
raise TypeError(\
"array can only contain objects of type IGuestScreenInfo")
self._call("setScreenLayout",
in_p=[screen_layout_mode, guest_screen_info])
[docs]class INetworkAdapter(Interface):
"""
Represents a virtual network adapter that is attached to a virtual machine.
Each virtual machine has a fixed number of network adapter slots with one
instance of this attached to each of them. Call
:py:func:`IMachine.get_network_adapter` to get the network adapter that
is attached to a given slot in a given machine.
Each network adapter can be in one of five attachment modes, which are
represented by the :py:class:`NetworkAttachmentType` enumeration;
see the :py:func:`attachment_type` attribute.
"""
__uuid__ = 'e925c2aa-4fe4-aaf6-91c5-e9b8ea4151ee'
__wsmap__ = 'managed'
@property
def adapter_type(self):
"""Get or set NetworkAdapterType value for 'adapterType'
Type of the virtual network adapter. Depending on this value,
VirtualBox will provide a different virtual network hardware
to the guest.
"""
ret = self._get_attr("adapterType")
return NetworkAdapterType(ret)
@adapter_type.setter
def adapter_type(self, value):
if not isinstance(value, NetworkAdapterType):
raise TypeError("value is not an instance of NetworkAdapterType")
return self._set_attr("adapterType", value)
@property
def slot(self):
"""Get int value for 'slot'
Slot number this adapter is plugged into. Corresponds to
the value you pass to :py:func:`IMachine.get_network_adapter`
to obtain this instance.
"""
ret = self._get_attr("slot")
return ret
@property
def enabled(self):
"""Get or set bool value for 'enabled'
Flag whether the network adapter is present in the
guest system. If disabled, the virtual guest hardware will
not contain this network adapter. Can only be changed when
the VM is not running.
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def mac_address(self):
"""Get or set str value for 'MACAddress'
Ethernet MAC address of the adapter, 12 hexadecimal characters. When
setting it to @c null or an empty string for an enabled adapter,
VirtualBox will generate a unique MAC address. Disabled adapters can
have an empty MAC address.
"""
ret = self._get_attr("MACAddress")
return ret
@mac_address.setter
def mac_address(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("MACAddress", value)
@property
def attachment_type(self):
"""Get or set NetworkAttachmentType value for 'attachmentType'
Sets/Gets network attachment type of this network adapter.
"""
ret = self._get_attr("attachmentType")
return NetworkAttachmentType(ret)
@attachment_type.setter
def attachment_type(self, value):
if not isinstance(value, NetworkAttachmentType):
raise TypeError("value is not an instance of NetworkAttachmentType")
return self._set_attr("attachmentType", value)
@property
def bridged_interface(self):
"""Get or set str value for 'bridgedInterface'
Name of the network interface the VM should be bridged to.
"""
ret = self._get_attr("bridgedInterface")
return ret
@bridged_interface.setter
def bridged_interface(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("bridgedInterface", value)
@property
def host_only_interface(self):
"""Get or set str value for 'hostOnlyInterface'
Name of the host only network interface the VM is attached to.
"""
ret = self._get_attr("hostOnlyInterface")
return ret
@host_only_interface.setter
def host_only_interface(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("hostOnlyInterface", value)
@property
def internal_network(self):
"""Get or set str value for 'internalNetwork'
Name of the internal network the VM is attached to.
"""
ret = self._get_attr("internalNetwork")
return ret
@internal_network.setter
def internal_network(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("internalNetwork", value)
@property
def nat_network(self):
"""Get or set str value for 'NATNetwork'
Name of the NAT network the VM is attached to.
"""
ret = self._get_attr("NATNetwork")
return ret
@nat_network.setter
def nat_network(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("NATNetwork", value)
@property
def generic_driver(self):
"""Get or set str value for 'genericDriver'
Name of the driver to use for the "Generic" network attachment type.
"""
ret = self._get_attr("genericDriver")
return ret
@generic_driver.setter
def generic_driver(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("genericDriver", value)
@property
def cable_connected(self):
"""Get or set bool value for 'cableConnected'
Flag whether the adapter reports the cable as connected or not.
It can be used to report offline situations to a VM.
"""
ret = self._get_attr("cableConnected")
return ret
@cable_connected.setter
def cable_connected(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("cableConnected", value)
@property
def line_speed(self):
"""Get or set int value for 'lineSpeed'
Line speed reported by custom drivers, in units of 1 kbps.
"""
ret = self._get_attr("lineSpeed")
return ret
@line_speed.setter
def line_speed(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("lineSpeed", value)
@property
def promisc_mode_policy(self):
"""Get or set NetworkAdapterPromiscModePolicy value for 'promiscModePolicy'
The promiscuous mode policy of the network adapter when attached to an
internal network, host only network or a bridge.
"""
ret = self._get_attr("promiscModePolicy")
return NetworkAdapterPromiscModePolicy(ret)
@promisc_mode_policy.setter
def promisc_mode_policy(self, value):
if not isinstance(value, NetworkAdapterPromiscModePolicy):
raise TypeError("value is not an instance of NetworkAdapterPromiscModePolicy")
return self._set_attr("promiscModePolicy", value)
@property
def trace_enabled(self):
"""Get or set bool value for 'traceEnabled'
Flag whether network traffic from/to the network card should be traced.
Can only be toggled when the VM is turned off.
"""
ret = self._get_attr("traceEnabled")
return ret
@trace_enabled.setter
def trace_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("traceEnabled", value)
@property
def trace_file(self):
"""Get or set str value for 'traceFile'
Filename where a network trace will be stored. If not set, VBox-pid.pcap
will be used.
"""
ret = self._get_attr("traceFile")
return ret
@trace_file.setter
def trace_file(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("traceFile", value)
@property
def nat_engine(self):
"""Get INATEngine value for 'NATEngine'
Points to the NAT engine which handles the network address translation
for this interface. This is active only when the interface actually uses
NAT.
"""
ret = self._get_attr("NATEngine")
return INATEngine(ret)
@property
def boot_priority(self):
"""Get or set int value for 'bootPriority'
Network boot priority of the adapter. Priority 1 is highest. If not set,
the priority is considered to be at the lowest possible setting.
"""
ret = self._get_attr("bootPriority")
return ret
@boot_priority.setter
def boot_priority(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("bootPriority", value)
@property
def bandwidth_group(self):
"""Get or set IBandwidthGroup value for 'bandwidthGroup'
The bandwidth group this network adapter is assigned to.
"""
ret = self._get_attr("bandwidthGroup")
return IBandwidthGroup(ret)
@bandwidth_group.setter
def bandwidth_group(self, value):
if not isinstance(value, IBandwidthGroup):
raise TypeError("value is not an instance of IBandwidthGroup")
return self._set_attr("bandwidthGroup", value)
[docs] def get_property(self, key):
"""Returns the value of the network attachment property with the given name.
If the requested data @a key does not exist, this function will
succeed and return an empty string in the @a value argument.
in key of type str
Name of the property to get.
return value of type str
Current property value.
raises :class:`OleErrorInvalidarg`
@a name is @c null or empty.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
value = self._call("getProperty",
in_p=[key])
return value
[docs] def set_property(self, key, value):
"""Sets the value of the network attachment property with the given name.
Setting the property value to @c null or an empty string is equivalent
to deleting the existing value.
in key of type str
Name of the property to set.
in value of type str
Property value to set.
raises :class:`OleErrorInvalidarg`
@a name is @c null or empty.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setProperty",
in_p=[key, value])
[docs] def get_properties(self, names):
"""Returns values for a group of properties in one call.
The names of the properties to get are specified using the @a names
argument which is a list of comma-separated property names or
an empty string if all properties are to be returned.
Currently the value of this argument is ignored and the method
always returns all existing properties.
The method returns two arrays, the array of property names corresponding
to the @a names argument and the current values of these properties.
Both arrays have the same number of elements with each element at the
given index in the first array corresponds to an element at the same
index in the second array.
in names of type str
Names of properties to get.
out return_names of type str
Names of returned properties.
return return_values of type str
Values of returned properties.
"""
if not isinstance(names, basestring):
raise TypeError("names can only be an instance of type basestring")
(return_values, return_names) = self._call("getProperties",
in_p=[names])
return (return_values, return_names)
[docs]class ISerialPort(Interface):
"""
The ISerialPort interface represents the virtual serial port device.
The virtual serial port device acts like an ordinary serial port
inside the virtual machine. This device communicates to the real
serial port hardware in one of two modes: host pipe or host device.
In host pipe mode, the #path attribute specifies the path to the pipe on
the host computer that represents a serial port. The #server attribute
determines if this pipe is created by the virtual machine process at
machine startup or it must already exist before starting machine
execution.
In host device mode, the #path attribute specifies the name of the
serial port device on the host computer.
There is also a third communication mode: the disconnected mode. In this
mode, the guest OS running inside the virtual machine will be able to
detect the serial port, but all port write operations will be discarded
and all port read operations will return no data.
:py:func:`IMachine.get_serial_port`
"""
__uuid__ = 'cb0a4a29-43a3-9040-0c25-34845db7b042'
__wsmap__ = 'managed'
@property
def slot(self):
"""Get int value for 'slot'
Slot number this serial port is plugged into. Corresponds to
the value you pass to :py:func:`IMachine.get_serial_port`
to obtain this instance.
"""
ret = self._get_attr("slot")
return ret
@property
def enabled(self):
"""Get or set bool value for 'enabled'
Flag whether the serial port is enabled. If disabled,
the serial port will not be reported to the guest OS.
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def io_base(self):
"""Get or set int value for 'IOBase'
Base I/O address of the serial port.
"""
ret = self._get_attr("IOBase")
return ret
@io_base.setter
def io_base(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("IOBase", value)
@property
def irq(self):
"""Get or set int value for 'IRQ'
IRQ number of the serial port.
"""
ret = self._get_attr("IRQ")
return ret
@irq.setter
def irq(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("IRQ", value)
@property
def host_mode(self):
"""Get or set PortMode value for 'hostMode'
How is this port connected to the host.
Changing this attribute may fail if the conditions for
:py:func:`path` are not met.
"""
ret = self._get_attr("hostMode")
return PortMode(ret)
@host_mode.setter
def host_mode(self, value):
if not isinstance(value, PortMode):
raise TypeError("value is not an instance of PortMode")
return self._set_attr("hostMode", value)
@property
def server(self):
"""Get or set bool value for 'server'
Flag whether this serial port acts as a server (creates a new pipe on
the host) or as a client (uses the existing pipe). This attribute is
used only when :py:func:`host_mode` is PortMode_HostPipe or PortMode_TCP.
"""
ret = self._get_attr("server")
return ret
@server.setter
def server(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("server", value)
@property
def path(self):
"""Get or set str value for 'path'
Path to the serial port's pipe on the host when :py:func:`ISerialPort.host_mode` is
PortMode_HostPipe, the host serial device name when
:py:func:`ISerialPort.host_mode` is PortMode_HostDevice or the TCP
**port** (server) or **hostname:port** (client) when
:py:func:`ISerialPort.host_mode` is PortMode_TCP.
For those cases, setting a @c null or empty string as the attribute's
value is an error. Otherwise, the value of this property is ignored.
"""
ret = self._get_attr("path")
return ret
@path.setter
def path(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("path", value)
[docs]class IParallelPort(Interface):
"""
The IParallelPort interface represents the virtual parallel port device.
The virtual parallel port device acts like an ordinary parallel port
inside the virtual machine. This device communicates to the real
parallel port hardware using the name of the parallel device on the host
computer specified in the #path attribute.
Each virtual parallel port device is assigned a base I/O address and an
IRQ number that will be reported to the guest operating system and used
to operate the given parallel port from within the virtual machine.
:py:func:`IMachine.get_parallel_port`
"""
__uuid__ = '788b87df-7708-444b-9eef-c116ce423d39'
__wsmap__ = 'managed'
@property
def slot(self):
"""Get int value for 'slot'
Slot number this parallel port is plugged into. Corresponds to
the value you pass to :py:func:`IMachine.get_parallel_port`
to obtain this instance.
"""
ret = self._get_attr("slot")
return ret
@property
def enabled(self):
"""Get or set bool value for 'enabled'
Flag whether the parallel port is enabled. If disabled,
the parallel port will not be reported to the guest OS.
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def io_base(self):
"""Get or set int value for 'IOBase'
Base I/O address of the parallel port.
"""
ret = self._get_attr("IOBase")
return ret
@io_base.setter
def io_base(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("IOBase", value)
@property
def irq(self):
"""Get or set int value for 'IRQ'
IRQ number of the parallel port.
"""
ret = self._get_attr("IRQ")
return ret
@irq.setter
def irq(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("IRQ", value)
@property
def path(self):
"""Get or set str value for 'path'
Host parallel device name. If this parallel port is enabled, setting a
@c null or an empty string as this attribute's value will result in
the parallel port behaving as if not connected to any device.
"""
ret = self._get_attr("path")
return ret
@path.setter
def path(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("path", value)
[docs]class IMachineDebugger(Interface):
"""
Takes a core dump of the guest.
See include/VBox/dbgfcorefmt.h for details on the file format.
"""
__uuid__ = '9c0f5269-47ae-ee34-c2fe-53a16e388925'
__wsmap__ = 'managed'
[docs] def dump_guest_core(self, filename, compression):
"""Takes a core dump of the guest.
See include/VBox/dbgfcorefmt.h for details on the file format.
in filename of type str
The name of the output file. The file must not exist.
in compression of type str
Reserved for future compression method indicator.
"""
if not isinstance(filename, basestring):
raise TypeError("filename can only be an instance of type basestring")
if not isinstance(compression, basestring):
raise TypeError("compression can only be an instance of type basestring")
self._call("dumpGuestCore",
in_p=[filename, compression])
[docs] def dump_host_process_core(self, filename, compression):
"""Takes a core dump of the VM process on the host.
This feature is not implemented in the 4.0.0 release but it may show up
in a dot release.
in filename of type str
The name of the output file. The file must not exist.
in compression of type str
Reserved for future compression method indicator.
"""
if not isinstance(filename, basestring):
raise TypeError("filename can only be an instance of type basestring")
if not isinstance(compression, basestring):
raise TypeError("compression can only be an instance of type basestring")
self._call("dumpHostProcessCore",
in_p=[filename, compression])
[docs] def info(self, name, args):
"""Interfaces with the info dumpers (DBGFInfo).
This feature is not implemented in the 4.0.0 release but it may show up
in a dot release.
in name of type str
The name of the info item.
in args of type str
Arguments to the info dumper.
return info of type str
The into string.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(args, basestring):
raise TypeError("args can only be an instance of type basestring")
info = self._call("info",
in_p=[name, args])
return info
[docs] def inject_nmi(self):
"""Inject an NMI into a running VT-x/AMD-V VM.
"""
self._call("injectNMI")
[docs] def modify_log_groups(self, settings):
"""Modifies the group settings of the debug or release logger.
in settings of type str
The group settings string. See iprt/log.h for details. To target the
release logger, prefix the string with "release:".
"""
if not isinstance(settings, basestring):
raise TypeError("settings can only be an instance of type basestring")
self._call("modifyLogGroups",
in_p=[settings])
[docs] def modify_log_flags(self, settings):
"""Modifies the debug or release logger flags.
in settings of type str
The flags settings string. See iprt/log.h for details. To target the
release logger, prefix the string with "release:".
"""
if not isinstance(settings, basestring):
raise TypeError("settings can only be an instance of type basestring")
self._call("modifyLogFlags",
in_p=[settings])
[docs] def modify_log_destinations(self, settings):
"""Modifies the debug or release logger destinations.
in settings of type str
The destination settings string. See iprt/log.h for details. To target the
release logger, prefix the string with "release:".
"""
if not isinstance(settings, basestring):
raise TypeError("settings can only be an instance of type basestring")
self._call("modifyLogDestinations",
in_p=[settings])
[docs] def read_physical_memory(self, address, size):
"""Reads guest physical memory, no side effects (MMIO++).
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in address of type int
The guest physical address.
in size of type int
The number of bytes to read.
return bytes_p of type str
The bytes read.
"""
if not isinstance(address, baseinteger):
raise TypeError("address can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
bytes_p = self._call("readPhysicalMemory",
in_p=[address, size])
return bytes_p
[docs] def write_physical_memory(self, address, size, bytes_p):
"""Writes guest physical memory, access handles (MMIO++) are ignored.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in address of type int
The guest physical address.
in size of type int
The number of bytes to read.
in bytes_p of type str
The bytes to write.
"""
if not isinstance(address, baseinteger):
raise TypeError("address can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
if not isinstance(bytes_p, list):
raise TypeError("bytes_p can only be an instance of type list")
for a in bytes_p[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("writePhysicalMemory",
in_p=[address, size, bytes_p])
[docs] def read_virtual_memory(self, cpu_id, address, size):
"""Reads guest virtual memory, no side effects (MMIO++).
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in cpu_id of type int
The identifier of the Virtual CPU.
in address of type int
The guest virtual address.
in size of type int
The number of bytes to read.
return bytes_p of type str
The bytes read.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(address, baseinteger):
raise TypeError("address can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
bytes_p = self._call("readVirtualMemory",
in_p=[cpu_id, address, size])
return bytes_p
[docs] def write_virtual_memory(self, cpu_id, address, size, bytes_p):
"""Writes guest virtual memory, access handles (MMIO++) are ignored.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in cpu_id of type int
The identifier of the Virtual CPU.
in address of type int
The guest virtual address.
in size of type int
The number of bytes to read.
in bytes_p of type str
The bytes to write.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(address, baseinteger):
raise TypeError("address can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
raise TypeError("size can only be an instance of type baseinteger")
if not isinstance(bytes_p, list):
raise TypeError("bytes_p can only be an instance of type list")
for a in bytes_p[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("writeVirtualMemory",
in_p=[cpu_id, address, size, bytes_p])
[docs] def load_plug_in(self, name):
"""Loads a DBGF plug-in.
in name of type str
The plug-in name or DLL. Special name 'all' loads all installed plug-ins.
return plug_in_name of type str
The name of the loaded plug-in.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
plug_in_name = self._call("loadPlugIn",
in_p=[name])
return plug_in_name
[docs] def unload_plug_in(self, name):
"""Unloads a DBGF plug-in.
in name of type str
The plug-in name or DLL. Special name 'all' unloads all plug-ins.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("unloadPlugIn",
in_p=[name])
[docs] def detect_os(self):
"""Tries to (re-)detect the guest OS kernel.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
return os of type str
The detected OS kernel on success.
"""
os = self._call("detectOS")
return os
[docs] def query_os_kernel_log(self, max_messages):
"""Tries to get the kernel log (dmesg) of the guest OS.
in max_messages of type int
Max number of messages to return, counting from the end of the
log. If 0, there is no limit.
return dmesg of type str
The kernel log.
"""
if not isinstance(max_messages, baseinteger):
raise TypeError("max_messages can only be an instance of type baseinteger")
dmesg = self._call("queryOSKernelLog",
in_p=[max_messages])
return dmesg
[docs] def get_register(self, cpu_id, name):
"""Gets one register.
in cpu_id of type int
The identifier of the Virtual CPU.
in name of type str
The register name, case is ignored.
return value of type str
The register value. This is usually a hex value (always 0x prefixed)
but other format may be used for floating point registers (TBD).
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
value = self._call("getRegister",
in_p=[cpu_id, name])
return value
[docs] def get_registers(self, cpu_id):
"""Gets all the registers for the given CPU.
in cpu_id of type int
The identifier of the Virtual CPU.
out names of type str
Array containing the lowercase register names.
out values of type str
Array parallel to the names holding the register values as if the
register was returned by :py:func:`IMachineDebugger.get_register` .
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
(names, values) = self._call("getRegisters",
in_p=[cpu_id])
return (names, values)
[docs] def set_register(self, cpu_id, name, value):
"""Gets one register.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in cpu_id of type int
The identifier of the Virtual CPU.
in name of type str
The register name, case is ignored.
in value of type str
The new register value. Hexadecimal, decimal and octal formattings
are supported in addition to any special formattings returned by
the getters.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setRegister",
in_p=[cpu_id, name, value])
[docs] def set_registers(self, cpu_id, names, values):
"""Sets zero or more registers atomically.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in cpu_id of type int
The identifier of the Virtual CPU.
in names of type str
Array containing the register names, case ignored.
in values of type str
Array paralell to the names holding the register values. See
:py:func:`IMachineDebugger.set_register` for formatting
guidelines.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(names, list):
raise TypeError("names can only be an instance of type list")
for a in names[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
if not isinstance(values, list):
raise TypeError("values can only be an instance of type list")
for a in values[:10]:
if not isinstance(a, basestring):
raise TypeError(\
"array can only contain objects of type basestring")
self._call("setRegisters",
in_p=[cpu_id, names, values])
[docs] def dump_guest_stack(self, cpu_id):
"""Produce a simple stack dump using the current guest state.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
in cpu_id of type int
The identifier of the Virtual CPU.
return stack of type str
String containing the formatted stack dump.
"""
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
stack = self._call("dumpGuestStack",
in_p=[cpu_id])
return stack
[docs] def reset_stats(self, pattern):
"""Reset VM statistics.
in pattern of type str
The selection pattern. A bit similar to filename globbing.
"""
if not isinstance(pattern, basestring):
raise TypeError("pattern can only be an instance of type basestring")
self._call("resetStats",
in_p=[pattern])
[docs] def dump_stats(self, pattern):
"""Dumps VM statistics.
in pattern of type str
The selection pattern. A bit similar to filename globbing.
"""
if not isinstance(pattern, basestring):
raise TypeError("pattern can only be an instance of type basestring")
self._call("dumpStats",
in_p=[pattern])
[docs] def get_stats(self, pattern, with_descriptions):
"""Get the VM statistics in a XMLish format.
in pattern of type str
The selection pattern. A bit similar to filename globbing.
in with_descriptions of type bool
Whether to include the descriptions.
return stats of type str
The XML document containing the statistics.
"""
if not isinstance(pattern, basestring):
raise TypeError("pattern can only be an instance of type basestring")
if not isinstance(with_descriptions, bool):
raise TypeError("with_descriptions can only be an instance of type bool")
stats = self._call("getStats",
in_p=[pattern, with_descriptions])
return stats
@property
def single_step(self):
"""Get or set bool value for 'singleStep'
Switch for enabling single-stepping.
"""
ret = self._get_attr("singleStep")
return ret
@single_step.setter
def single_step(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("singleStep", value)
@property
def recompile_user(self):
"""Get or set bool value for 'recompileUser'
Switch for forcing code recompilation for user mode code.
"""
ret = self._get_attr("recompileUser")
return ret
@recompile_user.setter
def recompile_user(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("recompileUser", value)
@property
def recompile_supervisor(self):
"""Get or set bool value for 'recompileSupervisor'
Switch for forcing code recompilation for supervisor mode code.
"""
ret = self._get_attr("recompileSupervisor")
return ret
@recompile_supervisor.setter
def recompile_supervisor(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("recompileSupervisor", value)
@property
def execute_all_in_iem(self):
"""Get or set bool value for 'executeAllInIEM'
Whether to execute all the code in the instruction interpreter. This
is mainly for testing the interpreter and not an execution mode
intended for general consumption.
"""
ret = self._get_attr("executeAllInIEM")
return ret
@execute_all_in_iem.setter
def execute_all_in_iem(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("executeAllInIEM", value)
@property
def patm_enabled(self):
"""Get or set bool value for 'PATMEnabled'
Switch for enabling and disabling the PATM component.
"""
ret = self._get_attr("PATMEnabled")
return ret
@patm_enabled.setter
def patm_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("PATMEnabled", value)
@property
def csam_enabled(self):
"""Get or set bool value for 'CSAMEnabled'
Switch for enabling and disabling the CSAM component.
"""
ret = self._get_attr("CSAMEnabled")
return ret
@csam_enabled.setter
def csam_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("CSAMEnabled", value)
@property
def log_enabled(self):
"""Get or set bool value for 'logEnabled'
Switch for enabling and disabling the debug logger.
"""
ret = self._get_attr("logEnabled")
return ret
@log_enabled.setter
def log_enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("logEnabled", value)
@property
def log_dbg_flags(self):
"""Get str value for 'logDbgFlags'
The debug logger flags.
"""
ret = self._get_attr("logDbgFlags")
return ret
@property
def log_dbg_groups(self):
"""Get str value for 'logDbgGroups'
The debug logger's group settings.
"""
ret = self._get_attr("logDbgGroups")
return ret
@property
def log_dbg_destinations(self):
"""Get str value for 'logDbgDestinations'
The debug logger's destination settings.
"""
ret = self._get_attr("logDbgDestinations")
return ret
@property
def log_rel_flags(self):
"""Get str value for 'logRelFlags'
The release logger flags.
"""
ret = self._get_attr("logRelFlags")
return ret
@property
def log_rel_groups(self):
"""Get str value for 'logRelGroups'
The release logger's group settings.
"""
ret = self._get_attr("logRelGroups")
return ret
@property
def log_rel_destinations(self):
"""Get str value for 'logRelDestinations'
The relase logger's destination settings.
"""
ret = self._get_attr("logRelDestinations")
return ret
@property
def hw_virt_ex_enabled(self):
"""Get bool value for 'HWVirtExEnabled'
Flag indicating whether the VM is currently making use of CPU hardware
virtualization extensions.
"""
ret = self._get_attr("HWVirtExEnabled")
return ret
@property
def hw_virt_ex_nested_paging_enabled(self):
"""Get bool value for 'HWVirtExNestedPagingEnabled'
Flag indicating whether the VM is currently making use of the nested paging
CPU hardware virtualization extension.
"""
ret = self._get_attr("HWVirtExNestedPagingEnabled")
return ret
@property
def hw_virt_ex_vpid_enabled(self):
"""Get bool value for 'HWVirtExVPIDEnabled'
Flag indicating whether the VM is currently making use of the VPID
VT-x extension.
"""
ret = self._get_attr("HWVirtExVPIDEnabled")
return ret
@property
def hw_virt_ex_ux_enabled(self):
"""Get bool value for 'HWVirtExUXEnabled'
Flag indicating whether the VM is currently making use of the
unrestricted execution feature of VT-x.
"""
ret = self._get_attr("HWVirtExUXEnabled")
return ret
@property
def os_name(self):
"""Get str value for 'OSName'
Query the guest OS kernel name as detected by the DBGF.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
"""
ret = self._get_attr("OSName")
return ret
@property
def os_version(self):
"""Get str value for 'OSVersion'
Query the guest OS kernel version string as detected by the DBGF.
This feature is not implemented in the 4.0.0 release but may show up
in a dot release.
"""
ret = self._get_attr("OSVersion")
return ret
@property
def pae_enabled(self):
"""Get bool value for 'PAEEnabled'
Flag indicating whether the VM is currently making use of the Physical
Address Extension CPU feature.
"""
ret = self._get_attr("PAEEnabled")
return ret
@property
def virtual_time_rate(self):
"""Get or set int value for 'virtualTimeRate'
The rate at which the virtual time runs expressed as a percentage.
The accepted range is 2% to 20000%.
"""
ret = self._get_attr("virtualTimeRate")
return ret
@virtual_time_rate.setter
def virtual_time_rate(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("virtualTimeRate", value)
@property
def vm(self):
"""Get int value for 'VM'
Gets the user-mode VM handle, with a reference. Must be passed to
VMR3ReleaseUVM when done. This is only for internal use while we carve
the details of this interface.
"""
ret = self._get_attr("VM")
return ret
@property
def uptime(self):
"""Get int value for 'uptime'
VM uptime in milliseconds, i.e. time in which it could have been
executing guest code. Excludes the time when the VM was paused.
"""
ret = self._get_attr("uptime")
return ret
[docs]class IUSBDeviceFilters(Interface):
"""
List of USB device filters associated with the machine.
If the machine is currently running, these filters are activated
every time a new (supported) USB device is attached to the host
computer that was not ignored by global filters
(:py:func:`IHost.usb_device_filters` ).
These filters are also activated when the machine is powered up.
They are run against a list of all currently available USB
devices (in states
:py:attr:`USBDeviceState.available` ,
:py:attr:`USBDeviceState.busy` ,
:py:attr:`USBDeviceState.held` ) that were not previously
ignored by global filters.
If at least one filter matches the USB device in question, this
device is automatically captured (attached to) the virtual USB
controller of this machine.
:py:class:`IUSBDeviceFilter` , :py:class:`IUSBController`
"""
__uuid__ = '9709db9b-3346-49d6-8f1c-41b0c4784ff2'
__wsmap__ = 'managed'
@property
def device_filters(self):
"""Get IUSBDeviceFilter value for 'deviceFilters'
List of USB device filters associated with the machine.
If the machine is currently running, these filters are activated
every time a new (supported) USB device is attached to the host
computer that was not ignored by global filters
(:py:func:`IHost.usb_device_filters` ).
These filters are also activated when the machine is powered up.
They are run against a list of all currently available USB
devices (in states
:py:attr:`USBDeviceState.available` ,
:py:attr:`USBDeviceState.busy` ,
:py:attr:`USBDeviceState.held` ) that were not previously
ignored by global filters.
If at least one filter matches the USB device in question, this
device is automatically captured (attached to) the virtual USB
controller of this machine.
:py:class:`IUSBDeviceFilter` , :py:class:`IUSBController`
"""
ret = self._get_attr("deviceFilters")
return [IUSBDeviceFilter(a) for a in ret]
[docs] def create_device_filter(self, name):
"""Creates a new USB device filter. All attributes except
the filter name are set to empty (any match),
*active* is @c false (the filter is not active).
The created filter can then be added to the list of filters using
:py:func:`insert_device_filter` .
:py:func:`device_filters`
in name of type str
Filter name. See :py:func:`IUSBDeviceFilter.name`
for more info.
return filter_p of type :class:`IUSBDeviceFilter`
Created filter object.
raises :class:`VBoxErrorInvalidVmState`
The virtual machine is not mutable.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
filter_p = self._call("createDeviceFilter",
in_p=[name])
filter_p = IUSBDeviceFilter(filter_p)
return filter_p
[docs] def insert_device_filter(self, position, filter_p):
"""Inserts the given USB device to the specified position
in the list of filters.
Positions are numbered starting from 0. If the specified
position is equal to or greater than the number of elements in
the list, the filter is added to the end of the collection.
Duplicates are not allowed, so an attempt to insert a
filter that is already in the collection, will return an
error.
:py:func:`device_filters`
in position of type int
Position to insert the filter to.
in filter_p of type :class:`IUSBDeviceFilter`
USB device filter to insert.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable.
raises :class:`OleErrorInvalidarg`
USB device filter not created within this VirtualBox instance.
raises :class:`VBoxErrorInvalidObjectState`
USB device filter already in list.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
if not isinstance(filter_p, IUSBDeviceFilter):
raise TypeError("filter_p can only be an instance of type IUSBDeviceFilter")
self._call("insertDeviceFilter",
in_p=[position, filter_p])
[docs] def remove_device_filter(self, position):
"""Removes a USB device filter from the specified position in the
list of filters.
Positions are numbered starting from 0. Specifying a
position equal to or greater than the number of elements in
the list will produce an error.
:py:func:`device_filters`
in position of type int
Position to remove the filter from.
return filter_p of type :class:`IUSBDeviceFilter`
Removed USB device filter.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine is not mutable.
raises :class:`OleErrorInvalidarg`
USB device filter list empty or invalid @a position.
"""
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
filter_p = self._call("removeDeviceFilter",
in_p=[position])
filter_p = IUSBDeviceFilter(filter_p)
return filter_p
[docs]class IUSBController(Interface):
"""
The USB Controller name.
"""
__uuid__ = '0c293c51-4810-e174-4f78-199376c63bbe'
__wsmap__ = 'managed'
@property
def name(self):
"""Get or set str value for 'name'
The USB Controller name.
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def type_p(self):
"""Get or set USBControllerType value for 'type'
The USB Controller type.
"""
ret = self._get_attr("type")
return USBControllerType(ret)
@type_p.setter
def type_p(self, value):
if not isinstance(value, USBControllerType):
raise TypeError("value is not an instance of USBControllerType")
return self._set_attr("type", value)
@property
def usb_standard(self):
"""Get int value for 'USBStandard'
USB standard version which the controller implements.
This is a BCD which means that the major version is in the
high byte and minor version is in the low byte.
"""
ret = self._get_attr("USBStandard")
return ret
[docs]class IUSBDevice(Interface):
"""
The IUSBDevice interface represents a virtual USB device attached to the
virtual machine.
A collection of objects implementing this interface is stored in the
:py:func:`IConsole.usb_devices` attribute which lists all USB devices
attached to a running virtual machine's USB controller.
"""
__uuid__ = '5915d179-83c7-4f2b-a323-9a97f46f4e29'
__wsmap__ = 'managed'
@property
def id_p(self):
"""Get str value for 'id'
Unique USB device ID. This ID is built from #vendorId,
#productId, #revision and #serialNumber.
"""
ret = self._get_attr("id")
return ret
@property
def vendor_id(self):
"""Get int value for 'vendorId'
Vendor ID.
"""
ret = self._get_attr("vendorId")
return ret
@property
def product_id(self):
"""Get int value for 'productId'
Product ID.
"""
ret = self._get_attr("productId")
return ret
@property
def revision(self):
"""Get int value for 'revision'
Product revision number. This is a packed BCD represented as
unsigned short. The high byte is the integer part and the low
byte is the decimal.
"""
ret = self._get_attr("revision")
return ret
@property
def manufacturer(self):
"""Get str value for 'manufacturer'
Manufacturer string.
"""
ret = self._get_attr("manufacturer")
return ret
@property
def product(self):
"""Get str value for 'product'
Product string.
"""
ret = self._get_attr("product")
return ret
@property
def serial_number(self):
"""Get str value for 'serialNumber'
Serial number string.
"""
ret = self._get_attr("serialNumber")
return ret
@property
def address(self):
"""Get str value for 'address'
Host specific address of the device.
"""
ret = self._get_attr("address")
return ret
@property
def port(self):
"""Get int value for 'port'
Host USB port number the device is physically
connected to.
"""
ret = self._get_attr("port")
return ret
@property
def version(self):
"""Get int value for 'version'
The major USB version of the device - 1, 2 or 3.
"""
ret = self._get_attr("version")
return ret
@property
def port_version(self):
"""Get int value for 'portVersion'
The major USB version of the host USB port the device is
physically connected to - 1, 2 or 3. For devices not connected to
anything this will have the same value as the version attribute.
"""
ret = self._get_attr("portVersion")
return ret
@property
def speed(self):
"""Get USBConnectionSpeed value for 'speed'
The speed at which the device is currently communicating.
"""
ret = self._get_attr("speed")
return USBConnectionSpeed(ret)
@property
def remote(self):
"""Get bool value for 'remote'
Whether the device is physically connected to a remote VRDE
client or to a local host machine.
"""
ret = self._get_attr("remote")
return ret
@property
def device_info(self):
"""Get str value for 'deviceInfo'
Array of device attributes as single strings.
So far the following are used:
0: The manufacturer string, if the device doesn't expose the ID one is taken
from an internal database or an empty string if none is found.
1: The product string, if the device doesn't expose the ID one is taken
from an internal database or an empty string if none is found.
"""
ret = self._get_attr("deviceInfo")
return ret
@property
def backend(self):
"""Get str value for 'backend'
The backend which will be used to communicate with this device.
"""
ret = self._get_attr("backend")
return ret
[docs]class IUSBDeviceFilter(Interface):
"""
The IUSBDeviceFilter interface represents an USB device filter used
to perform actions on a group of USB devices.
This type of filters is used by running virtual machines to
automatically capture selected USB devices once they are physically
attached to the host computer.
A USB device is matched to the given device filter if and only if all
attributes of the device match the corresponding attributes of the
filter (that is, attributes are joined together using the logical AND
operation). On the other hand, all together, filters in the list of
filters carry the semantics of the logical OR operation. So if it is
desirable to create a match like "this vendor id OR this product id",
one needs to create two filters and specify "any match" (see below)
for unused attributes.
All filter attributes used for matching are strings. Each string
is an expression representing a set of values of the corresponding
device attribute, that will match the given filter. Currently, the
following filtering expressions are supported:
*Interval filters*. Used to specify valid intervals for
integer device attributes (Vendor ID, Product ID and Revision).
The format of the string is:
int:((m)|([m]-[n]))(,(m)|([m]-[n]))*
where m and n are integer numbers, either in octal
(starting from 0), hexadecimal (starting from 0x)
or decimal (otherwise) form, so that m < n. If m
is omitted before a dash (-), the minimum possible integer
is assumed; if n is omitted after a dash, the maximum
possible integer is assumed.
*Boolean filters*. Used to specify acceptable values for
boolean device attributes. The format of the string is:
true|false|yes|no|0|1
*Exact match*. Used to specify a single value for the given
device attribute. Any string that doesn't start with int:
represents the exact match. String device attributes are compared to
this string including case of symbols. Integer attributes are first
converted to a string (see individual filter attributes) and then
compared ignoring case.
*Any match*. Any value of the corresponding device attribute
will match the given filter. An empty or @c null string is
used to construct this type of filtering expressions.
On the Windows host platform, interval filters are not currently
available. Also all string filter attributes
(:py:func:`manufacturer` , :py:func:`product` ,
:py:func:`serial_number` ) are ignored, so they behave as
*any match* no matter what string expression is specified.
:py:func:`IUSBDeviceFilters.device_filters` ,
:py:class:`IHostUSBDeviceFilter`
"""
__uuid__ = '45587218-4289-ef4e-8e6a-e5b07816b631'
__wsmap__ = 'managed'
@property
def name(self):
"""Get or set str value for 'name'
Visible name for this filter.
This name is used to visually distinguish one filter from another,
so it can neither be @c null nor an empty string.
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def active(self):
"""Get or set bool value for 'active'
Whether this filter active or has been temporarily disabled.
"""
ret = self._get_attr("active")
return ret
@active.setter
def active(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("active", value)
@property
def vendor_id(self):
"""Get or set str value for 'vendorId'
:py:func:`IUSBDevice.vendor_id` Vendor ID filter.
The string representation for the *exact matching*
has the form XXXX, where X is the hex digit
(including leading zeroes).
"""
ret = self._get_attr("vendorId")
return ret
@vendor_id.setter
def vendor_id(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("vendorId", value)
@property
def product_id(self):
"""Get or set str value for 'productId'
:py:func:`IUSBDevice.product_id` Product ID filter.
The string representation for the *exact matching*
has the form XXXX, where X is the hex digit
(including leading zeroes).
"""
ret = self._get_attr("productId")
return ret
@product_id.setter
def product_id(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("productId", value)
@property
def revision(self):
"""Get or set str value for 'revision'
:py:func:`IUSBDevice.product_id` Product revision number
filter. The string representation for the *exact matching*
has the form IIFF, where I is the decimal digit
of the integer part of the revision, and F is the
decimal digit of its fractional part (including leading and
trailing zeros).
Note that for interval filters, it's best to use the hexadecimal
form, because the revision is stored as a 16 bit packed BCD value;
so the expression int:0x0100-0x0199 will match any
revision from 1.0 to 1.99.
"""
ret = self._get_attr("revision")
return ret
@revision.setter
def revision(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("revision", value)
@property
def manufacturer(self):
"""Get or set str value for 'manufacturer'
:py:func:`IUSBDevice.manufacturer` Manufacturer filter.
"""
ret = self._get_attr("manufacturer")
return ret
@manufacturer.setter
def manufacturer(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("manufacturer", value)
@property
def product(self):
"""Get or set str value for 'product'
:py:func:`IUSBDevice.product` Product filter.
"""
ret = self._get_attr("product")
return ret
@product.setter
def product(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("product", value)
@property
def serial_number(self):
"""Get or set str value for 'serialNumber'
:py:func:`IUSBDevice.serial_number` Serial number filter.
"""
ret = self._get_attr("serialNumber")
return ret
@serial_number.setter
def serial_number(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("serialNumber", value)
@property
def port(self):
"""Get or set str value for 'port'
:py:func:`IUSBDevice.port` Host USB port filter.
"""
ret = self._get_attr("port")
return ret
@port.setter
def port(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("port", value)
@property
def remote(self):
"""Get or set str value for 'remote'
:py:func:`IUSBDevice.remote` Remote state filter.
This filter makes sense only for machine USB filters,
i.e. it is ignored by IHostUSBDeviceFilter objects.
"""
ret = self._get_attr("remote")
return ret
@remote.setter
def remote(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("remote", value)
@property
def masked_interfaces(self):
"""Get or set int value for 'maskedInterfaces'
This is an advanced option for hiding one or more USB interfaces
from the guest. The value is a bit mask where the bits that are set
means the corresponding USB interface should be hidden, masked off
if you like.
This feature only works on Linux hosts.
"""
ret = self._get_attr("maskedInterfaces")
return ret
@masked_interfaces.setter
def masked_interfaces(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("maskedInterfaces", value)
[docs]class IHostUSBDevice(IUSBDevice):
"""
The IHostUSBDevice interface represents a physical USB device attached
to the host computer.
Besides properties inherited from IUSBDevice, this interface adds the
:py:func:`state` property that holds the current state of the USB
device.
:py:func:`IHost.usb_devices` ,
:py:func:`IHost.usb_device_filters`
"""
__uuid__ = 'c19073dd-cc7b-431b-98b2-951fda8eab89'
__wsmap__ = 'managed'
@property
def state(self):
"""Get USBDeviceState value for 'state'
Current state of the device.
"""
ret = self._get_attr("state")
return USBDeviceState(ret)
[docs]class IHostUSBDeviceFilter(IUSBDeviceFilter):
"""
The IHostUSBDeviceFilter interface represents a global filter for a
physical USB device used by the host computer. Used indirectly in
:py:func:`IHost.usb_device_filters` .
Using filters of this type, the host computer determines the initial
state of the USB device after it is physically attached to the
host's USB controller.
The :py:func:`IUSBDeviceFilter.remote` attribute is ignored by this type of
filters, because it makes sense only for
:py:func:`IUSBDeviceFilters.device_filters` machine USB filters.
:py:func:`IHost.usb_device_filters`
"""
__uuid__ = '01adb2d6-aedf-461c-be2c-99e91bdad8a1'
__wsmap__ = 'managed'
@property
def action(self):
"""Get or set USBDeviceFilterAction value for 'action'
Action performed by the host when an attached USB device
matches this filter.
"""
ret = self._get_attr("action")
return USBDeviceFilterAction(ret)
@action.setter
def action(self, value):
if not isinstance(value, USBDeviceFilterAction):
raise TypeError("value is not an instance of USBDeviceFilterAction")
return self._set_attr("action", value)
[docs]class IUSBProxyBackend(Interface):
"""
The USBProxyBackend interface represents a source for USB devices available
to the host for attaching to the VM.
"""
__uuid__ = 'dfe56449-6989-4002-80cf-3607f377d40c'
__wsmap__ = 'managed'
@property
def name(self):
"""Get str value for 'name'
The unique name of the proxy backend.
"""
ret = self._get_attr("name")
return ret
@property
def type_p(self):
"""Get str value for 'type'
The type of the backend.
"""
ret = self._get_attr("type")
return ret
[docs]class IAudioAdapter(Interface):
"""
The IAudioAdapter interface represents the virtual audio adapter of
the virtual machine. Used in :py:func:`IMachine.audio_adapter` .
"""
__uuid__ = 'aeccc0a8-e0a0-427f-b946-c42063f54d81'
__wsmap__ = 'managed'
@property
def enabled(self):
"""Get or set bool value for 'enabled'
Flag whether the audio adapter is present in the
guest system. If disabled, the virtual guest hardware will
not contain any audio adapter. Can only be changed when
the VM is not running.
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def enabled_in(self):
"""Get or set bool value for 'enabledIn'
Flag whether the audio adapter is enabled for audio
input. Only relevant if the adapter is enabled.
"""
ret = self._get_attr("enabledIn")
return ret
@enabled_in.setter
def enabled_in(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabledIn", value)
@property
def enabled_out(self):
"""Get or set bool value for 'enabledOut'
Flag whether the audio adapter is enabled for audio
output. Only relevant if the adapter is enabled.
"""
ret = self._get_attr("enabledOut")
return ret
@enabled_out.setter
def enabled_out(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabledOut", value)
@property
def audio_controller(self):
"""Get or set AudioControllerType value for 'audioController'
The emulated audio controller.
"""
ret = self._get_attr("audioController")
return AudioControllerType(ret)
@audio_controller.setter
def audio_controller(self, value):
if not isinstance(value, AudioControllerType):
raise TypeError("value is not an instance of AudioControllerType")
return self._set_attr("audioController", value)
@property
def audio_codec(self):
"""Get or set AudioCodecType value for 'audioCodec'
The exact variant of audio codec hardware presented
to the guest.
For HDA and SB16, only one variant is available, but for AC'97,
there are several.
"""
ret = self._get_attr("audioCodec")
return AudioCodecType(ret)
@audio_codec.setter
def audio_codec(self, value):
if not isinstance(value, AudioCodecType):
raise TypeError("value is not an instance of AudioCodecType")
return self._set_attr("audioCodec", value)
@property
def audio_driver(self):
"""Get or set AudioDriverType value for 'audioDriver'
Audio driver the adapter is connected to. This setting
can only be changed when the VM is not running.
"""
ret = self._get_attr("audioDriver")
return AudioDriverType(ret)
@audio_driver.setter
def audio_driver(self, value):
if not isinstance(value, AudioDriverType):
raise TypeError("value is not an instance of AudioDriverType")
return self._set_attr("audioDriver", value)
@property
def properties_list(self):
"""Get str value for 'propertiesList'
Array of names of tunable properties, which can be supported by audio driver.
"""
ret = self._get_attr("propertiesList")
return ret
[docs] def set_property(self, key, value):
"""Sets an audio specific property string.
If you pass @c null or empty string as a key @a value, the given @a key
will be deleted.
in key of type str
Name of the key to set.
in value of type str
Value to assign to the key.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setProperty",
in_p=[key, value])
[docs] def get_property(self, key):
"""Returns an audio specific property string.
If the requested data @a key does not exist, this function will
succeed and return an empty string in the @a value argument.
in key of type str
Name of the key to get.
return value of type str
Value of the requested key.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
value = self._call("getProperty",
in_p=[key])
return value
[docs]class IVRDEServer(Interface):
"""
Flag if VRDE server is enabled.
"""
__uuid__ = '6e758489-453a-6f98-9cb9-2da2cb8eabb5'
__wsmap__ = 'managed'
@property
def enabled(self):
"""Get or set bool value for 'enabled'
Flag if VRDE server is enabled.
"""
ret = self._get_attr("enabled")
return ret
@enabled.setter
def enabled(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("enabled", value)
@property
def auth_type(self):
"""Get or set AuthType value for 'authType'
VRDE authentication method.
"""
ret = self._get_attr("authType")
return AuthType(ret)
@auth_type.setter
def auth_type(self, value):
if not isinstance(value, AuthType):
raise TypeError("value is not an instance of AuthType")
return self._set_attr("authType", value)
@property
def auth_timeout(self):
"""Get or set int value for 'authTimeout'
Timeout for guest authentication. Milliseconds.
"""
ret = self._get_attr("authTimeout")
return ret
@auth_timeout.setter
def auth_timeout(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("authTimeout", value)
@property
def allow_multi_connection(self):
"""Get or set bool value for 'allowMultiConnection'
Flag whether multiple simultaneous connections to the VM are permitted.
Note that this will be replaced by a more powerful mechanism in the future.
"""
ret = self._get_attr("allowMultiConnection")
return ret
@allow_multi_connection.setter
def allow_multi_connection(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("allowMultiConnection", value)
@property
def reuse_single_connection(self):
"""Get or set bool value for 'reuseSingleConnection'
Flag whether the existing connection must be dropped and a new connection
must be established by the VRDE server, when a new client connects in single
connection mode.
"""
ret = self._get_attr("reuseSingleConnection")
return ret
@reuse_single_connection.setter
def reuse_single_connection(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("reuseSingleConnection", value)
@property
def vrde_ext_pack(self):
"""Get or set str value for 'VRDEExtPack'
The name of Extension Pack providing VRDE for this VM. Overrides
:py:func:`ISystemProperties.default_vrde_ext_pack` .
"""
ret = self._get_attr("VRDEExtPack")
return ret
@vrde_ext_pack.setter
def vrde_ext_pack(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("VRDEExtPack", value)
@property
def auth_library(self):
"""Get or set str value for 'authLibrary'
Library used for authentication of RDP clients by this VM. Overrides
:py:func:`ISystemProperties.vrde_auth_library` .
"""
ret = self._get_attr("authLibrary")
return ret
@auth_library.setter
def auth_library(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("authLibrary", value)
@property
def vrde_properties(self):
"""Get str value for 'VRDEProperties'
Array of names of properties, which are supported by this VRDE server.
"""
ret = self._get_attr("VRDEProperties")
return ret
[docs] def set_vrde_property(self, key, value):
"""Sets a VRDE specific property string.
If you pass @c null or empty string as a key @a value, the given @a key
will be deleted.
in key of type str
Name of the key to set.
in value of type str
Value to assign to the key.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setVRDEProperty",
in_p=[key, value])
[docs] def get_vrde_property(self, key):
"""Returns a VRDE specific property string.
If the requested data @a key does not exist, this function will
succeed and return an empty string in the @a value argument.
in key of type str
Name of the key to get.
return value of type str
Value of the requested key.
"""
if not isinstance(key, basestring):
raise TypeError("key can only be an instance of type basestring")
value = self._call("getVRDEProperty",
in_p=[key])
return value
[docs]class ISharedFolder(Interface):
"""
The ISharedFolder interface represents a folder in the host computer's
file system accessible from the guest OS running inside a virtual
machine using an associated logical name.
There are three types of shared folders:
*Global* (:py:func:`IVirtualBox.shared_folders` ), shared
folders available to all virtual machines.
*Permanent* (:py:func:`IMachine.shared_folders` ),
VM-specific shared folders available to the given virtual machine at
startup.
*Transient* (:py:func:`IConsole.shared_folders` ),
VM-specific shared folders created in the session context (for
example, when the virtual machine is running) and automatically
discarded when the session is closed (the VM is powered off).
Logical names of shared folders must be unique within the given scope
(global, permanent or transient). However, they do not need to be unique
across scopes. In this case, the definition of the shared folder in a
more specific scope takes precedence over definitions in all other
scopes. The order of precedence is (more specific to more general):
Transient definitions
Permanent definitions
Global definitions
For example, if MyMachine has a shared folder named
C_DRIVE (that points to C:\\), then creating a
transient shared folder named C_DRIVE (that points
to C:\\\\WINDOWS) will change the definition
of C_DRIVE in the guest OS so
that \\\\VBOXSVR\\C_DRIVE will give access
to C:\\WINDOWS instead of C:\\ on the host
PC. Removing the transient shared folder C_DRIVE will restore
the previous (permanent) definition of C_DRIVE that points
to C:\\ if it still exists.
Note that permanent and transient shared folders of different machines
are in different name spaces, so they don't overlap and don't need to
have unique logical names.
Global shared folders are not implemented in the current version of the
product.
"""
__uuid__ = '15aabe95-e594-4e18-9222-b5e83a23f1da'
__wsmap__ = 'struct'
@property
def name(self):
"""Get str value for 'name'
Logical name of the shared folder.
"""
ret = self._get_attr("name")
return ret
@property
def host_path(self):
"""Get str value for 'hostPath'
Full path to the shared folder in the host file system.
"""
ret = self._get_attr("hostPath")
return ret
@property
def accessible(self):
"""Get bool value for 'accessible'
Whether the folder defined by the host path is currently
accessible or not.
For example, the folder can be inaccessible if it is placed
on the network share that is not available by the time
this property is read.
"""
ret = self._get_attr("accessible")
return ret
@property
def writable(self):
"""Get bool value for 'writable'
Whether the folder defined by the host path is writable or
not.
"""
ret = self._get_attr("writable")
return ret
@property
def auto_mount(self):
"""Get bool value for 'autoMount'
Whether the folder gets automatically mounted by the guest or not.
"""
ret = self._get_attr("autoMount")
return ret
@property
def last_access_error(self):
"""Get str value for 'lastAccessError'
Text message that represents the result of the last accessibility
check.
Accessibility checks are performed each time the :py:func:`accessible`
attribute is read. An empty string is returned if the last
accessibility check was successful. A non-empty string indicates a
failure and should normally describe a reason of the failure (for
example, a file read error).
"""
ret = self._get_attr("lastAccessError")
return ret
[docs]class IInternalSessionControl(Interface):
"""
PID of the process that has created this Session object.
"""
__uuid__ = '747e397e-69c8-45a0-88d9-f7f070960718'
__wsmap__ = 'suppress'
@property
def pid(self):
"""Get int value for 'PID'
PID of the process that has created this Session object.
"""
ret = self._get_attr("PID")
return ret
@property
def remote_console(self):
"""Get IConsole value for 'remoteConsole'
Returns the console object suitable for remote control.
"""
ret = self._get_attr("remoteConsole")
return IConsole(ret)
@property
def nominal_state(self):
"""Get MachineState value for 'nominalState'
Returns suitable machine state for the VM execution state. Useful
for choosing a sensible machine state after a complex operation which
failed or otherwise resulted in an unclear situation.
"""
ret = self._get_attr("nominalState")
return MachineState(ret)
[docs] def assign_machine(self, machine, lock_type, token):
"""Assigns the machine object associated with this direct-type
session or informs the session that it will be a remote one
(if @a machine == @c null).
in machine of type :class:`IMachine`
in lock_type of type :class:`LockType`
in token of type :class:`IToken`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(machine, IMachine):
raise TypeError("machine can only be an instance of type IMachine")
if not isinstance(lock_type, LockType):
raise TypeError("lock_type can only be an instance of type LockType")
if not isinstance(token, IToken):
raise TypeError("token can only be an instance of type IToken")
self._call("assignMachine",
in_p=[machine, lock_type, token])
[docs] def assign_remote_machine(self, machine, console):
"""Assigns the machine and the (remote) console object associated with
this remote-type session.
in machine of type :class:`IMachine`
in console of type :class:`IConsole`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
"""
if not isinstance(machine, IMachine):
raise TypeError("machine can only be an instance of type IMachine")
if not isinstance(console, IConsole):
raise TypeError("console can only be an instance of type IConsole")
self._call("assignRemoteMachine",
in_p=[machine, console])
[docs] def update_machine_state(self, machine_state):
"""Updates the machine state in the VM process.
Must be called only in certain cases
(see the method implementation).
in machine_state of type :class:`MachineState`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(machine_state, MachineState):
raise TypeError("machine_state can only be an instance of type MachineState")
self._call("updateMachineState",
in_p=[machine_state])
[docs] def uninitialize(self):
"""Uninitializes (closes) this session. Used by VirtualBox to close
the corresponding remote session when the direct session dies
or gets closed.
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
"""
self._call("uninitialize")
[docs] def on_network_adapter_change(self, network_adapter, change_adapter):
"""Triggered when settings of a network adapter of the
associated virtual machine have changed.
in network_adapter of type :class:`INetworkAdapter`
in change_adapter of type bool
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(network_adapter, INetworkAdapter):
raise TypeError("network_adapter can only be an instance of type INetworkAdapter")
if not isinstance(change_adapter, bool):
raise TypeError("change_adapter can only be an instance of type bool")
self._call("onNetworkAdapterChange",
in_p=[network_adapter, change_adapter])
[docs] def on_serial_port_change(self, serial_port):
"""Triggered when settings of a serial port of the
associated virtual machine have changed.
in serial_port of type :class:`ISerialPort`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(serial_port, ISerialPort):
raise TypeError("serial_port can only be an instance of type ISerialPort")
self._call("onSerialPortChange",
in_p=[serial_port])
[docs] def on_parallel_port_change(self, parallel_port):
"""Triggered when settings of a parallel port of the
associated virtual machine have changed.
in parallel_port of type :class:`IParallelPort`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(parallel_port, IParallelPort):
raise TypeError("parallel_port can only be an instance of type IParallelPort")
self._call("onParallelPortChange",
in_p=[parallel_port])
[docs] def on_storage_controller_change(self):
"""Triggered when settings of a storage controller of the
associated virtual machine have changed.
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
self._call("onStorageControllerChange")
[docs] def on_medium_change(self, medium_attachment, force):
"""Triggered when attached media of the
associated virtual machine have changed.
in medium_attachment of type :class:`IMediumAttachment`
The medium attachment which changed.
in force of type bool
If the medium change was forced.
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(medium_attachment, IMediumAttachment):
raise TypeError("medium_attachment can only be an instance of type IMediumAttachment")
if not isinstance(force, bool):
raise TypeError("force can only be an instance of type bool")
self._call("onMediumChange",
in_p=[medium_attachment, force])
[docs] def on_storage_device_change(self, medium_attachment, remove, silent):
"""Triggered when attached storage devices of the
associated virtual machine have changed.
in medium_attachment of type :class:`IMediumAttachment`
The medium attachment which changed.
in remove of type bool
TRUE if the device is removed, FALSE if it was added.
in silent of type bool
TRUE if the device is is silently reconfigured without
notifying the guest about it.
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(medium_attachment, IMediumAttachment):
raise TypeError("medium_attachment can only be an instance of type IMediumAttachment")
if not isinstance(remove, bool):
raise TypeError("remove can only be an instance of type bool")
if not isinstance(silent, bool):
raise TypeError("silent can only be an instance of type bool")
self._call("onStorageDeviceChange",
in_p=[medium_attachment, remove, silent])
[docs] def on_clipboard_mode_change(self, clipboard_mode):
"""Notification when the shared clipboard mode changes.
in clipboard_mode of type :class:`ClipboardMode`
The new shared clipboard mode.
"""
if not isinstance(clipboard_mode, ClipboardMode):
raise TypeError("clipboard_mode can only be an instance of type ClipboardMode")
self._call("onClipboardModeChange",
in_p=[clipboard_mode])
[docs] def on_dn_d_mode_change(self, dnd_mode):
"""Notification when the drag'n drop mode changes.
in dnd_mode of type :class:`DnDMode`
The new mode for drag'n drop.
"""
if not isinstance(dnd_mode, DnDMode):
raise TypeError("dnd_mode can only be an instance of type DnDMode")
self._call("onDnDModeChange",
in_p=[dnd_mode])
[docs] def on_cpu_change(self, cpu, add):
"""Notification when a CPU changes.
in cpu of type int
The CPU which changed
in add of type bool
Flag whether the CPU was added or removed
"""
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
if not isinstance(add, bool):
raise TypeError("add can only be an instance of type bool")
self._call("onCPUChange",
in_p=[cpu, add])
[docs] def on_cpu_execution_cap_change(self, execution_cap):
"""Notification when the CPU execution cap changes.
in execution_cap of type int
The new CPU execution cap value. (1-100)
"""
if not isinstance(execution_cap, baseinteger):
raise TypeError("execution_cap can only be an instance of type baseinteger")
self._call("onCPUExecutionCapChange",
in_p=[execution_cap])
[docs] def on_vrde_server_change(self, restart):
"""Triggered when settings of the VRDE server object of the
associated virtual machine have changed.
in restart of type bool
Flag whether the server must be restarted
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(restart, bool):
raise TypeError("restart can only be an instance of type bool")
self._call("onVRDEServerChange",
in_p=[restart])
[docs] def on_video_capture_change(self):
"""Triggered when video capture settings have changed.
"""
self._call("onVideoCaptureChange")
[docs] def on_usb_controller_change(self):
"""Triggered when settings of the USB controller object of the
associated virtual machine have changed.
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
self._call("onUSBControllerChange")
[docs] def on_shared_folder_change(self, global_p):
"""Triggered when a permanent (global or machine) shared folder has been
created or removed.
We don't pass shared folder parameters in this notification because
the order in which parallel notifications are delivered is not defined,
therefore it could happen that these parameters were outdated by the
time of processing this notification.
in global_p of type bool
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(global_p, bool):
raise TypeError("global_p can only be an instance of type bool")
self._call("onSharedFolderChange",
in_p=[global_p])
[docs] def on_usb_device_attach(self, device, error, masked_interfaces, capture_filename):
"""Triggered when a request to capture a USB device (as a result
of matched USB filters or direct call to
:py:func:`IConsole.attach_usb_device` ) has completed.
A @c null @a error object means success, otherwise it
describes a failure.
in device of type :class:`IUSBDevice`
in error of type :class:`IVirtualBoxErrorInfo`
in masked_interfaces of type int
in capture_filename of type str
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(device, IUSBDevice):
raise TypeError("device can only be an instance of type IUSBDevice")
if not isinstance(error, IVirtualBoxErrorInfo):
raise TypeError("error can only be an instance of type IVirtualBoxErrorInfo")
if not isinstance(masked_interfaces, baseinteger):
raise TypeError("masked_interfaces can only be an instance of type baseinteger")
if not isinstance(capture_filename, basestring):
raise TypeError("capture_filename can only be an instance of type basestring")
self._call("onUSBDeviceAttach",
in_p=[device, error, masked_interfaces, capture_filename])
[docs] def on_usb_device_detach(self, id_p, error):
"""Triggered when a request to release the USB device (as a result
of machine termination or direct call to
:py:func:`IConsole.detach_usb_device` ) has completed.
A @c null @a error object means success, otherwise it
describes a failure.
in id_p of type str
in error of type :class:`IVirtualBoxErrorInfo`
raises :class:`VBoxErrorInvalidVmState`
Session state prevents operation.
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(error, IVirtualBoxErrorInfo):
raise TypeError("error can only be an instance of type IVirtualBoxErrorInfo")
self._call("onUSBDeviceDetach",
in_p=[id_p, error])
[docs] def on_show_window(self, check):
"""Called by :py:func:`IMachine.can_show_console_window` and by
:py:func:`IMachine.show_console_window` in order to notify
console listeners
:py:class:`ICanShowWindowEvent`
and :py:class:`IShowWindowEvent` .
in check of type bool
out can_show of type bool
out win_id of type int
raises :class:`VBoxErrorInvalidObjectState`
Session type prevents operation.
"""
if not isinstance(check, bool):
raise TypeError("check can only be an instance of type bool")
(can_show, win_id) = self._call("onShowWindow",
in_p=[check])
return (can_show, win_id)
[docs] def on_bandwidth_group_change(self, bandwidth_group):
"""Notification when one of the bandwidth groups change.
in bandwidth_group of type :class:`IBandwidthGroup`
The bandwidth group which changed.
"""
if not isinstance(bandwidth_group, IBandwidthGroup):
raise TypeError("bandwidth_group can only be an instance of type IBandwidthGroup")
self._call("onBandwidthGroupChange",
in_p=[bandwidth_group])
[docs] def access_guest_property(self, name, value, flags, access_mode):
"""Called by :py:func:`IMachine.get_guest_property` and by
:py:func:`IMachine.set_guest_property` in order to read and
modify guest properties.
in name of type str
in value of type str
in flags of type str
in access_mode of type int
0 = get, 1 = set, 2 = delete.
out ret_value of type str
out ret_timestamp of type int
out ret_flags of type str
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
raises :class:`VBoxErrorInvalidObjectState`
Session type is not direct.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
if not isinstance(access_mode, baseinteger):
raise TypeError("access_mode can only be an instance of type baseinteger")
(ret_value, ret_timestamp, ret_flags) = self._call("accessGuestProperty",
in_p=[name, value, flags, access_mode])
return (ret_value, ret_timestamp, ret_flags)
[docs] def enumerate_guest_properties(self, patterns):
"""Return a list of the guest properties matching a set of patterns along
with their values, time stamps and flags.
in patterns of type str
The patterns to match the properties against as a comma-separated
string. If this is empty, all properties currently set will be
returned.
out keys of type str
The key names of the properties returned.
out values of type str
The values of the properties returned. The array entries match the
corresponding entries in the @a key array.
out timestamps of type int
The time stamps of the properties returned. The array entries match
the corresponding entries in the @a key array.
out flags of type str
The flags of the properties returned. The array entries match the
corresponding entries in the @a key array.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
raises :class:`VBoxErrorInvalidObjectState`
Session type is not direct.
"""
if not isinstance(patterns, basestring):
raise TypeError("patterns can only be an instance of type basestring")
(keys, values, timestamps, flags) = self._call("enumerateGuestProperties",
in_p=[patterns])
return (keys, values, timestamps, flags)
[docs] def online_merge_medium(self, medium_attachment, source_idx, target_idx, progress):
"""Triggers online merging of a hard disk. Used internally when deleting
a snapshot while a VM referring to the same hard disk chain is running.
in medium_attachment of type :class:`IMediumAttachment`
The medium attachment to identify the medium chain.
in source_idx of type int
The index of the source image in the chain.
Redundant, but drastically reduces IPC.
in target_idx of type int
The index of the target image in the chain.
Redundant, but drastically reduces IPC.
in progress of type :class:`IProgress`
Progress object for this operation.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
raises :class:`VBoxErrorInvalidObjectState`
Session type is not direct.
"""
if not isinstance(medium_attachment, IMediumAttachment):
raise TypeError("medium_attachment can only be an instance of type IMediumAttachment")
if not isinstance(source_idx, baseinteger):
raise TypeError("source_idx can only be an instance of type baseinteger")
if not isinstance(target_idx, baseinteger):
raise TypeError("target_idx can only be an instance of type baseinteger")
if not isinstance(progress, IProgress):
raise TypeError("progress can only be an instance of type IProgress")
self._call("onlineMergeMedium",
in_p=[medium_attachment, source_idx, target_idx, progress])
[docs] def enable_vmm_statistics(self, enable):
"""Enables or disables collection of VMM RAM statistics.
in enable of type bool
True enables statistics collection.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open.
raises :class:`VBoxErrorInvalidObjectState`
Session type is not direct.
"""
if not isinstance(enable, bool):
raise TypeError("enable can only be an instance of type bool")
self._call("enableVMMStatistics",
in_p=[enable])
[docs] def pause_with_reason(self, reason):
"""Internal method for triggering a VM pause with a specified reason code.
The reason code can be interpreted by device/drivers and thus it might
behave slightly differently than a normal VM pause.
:py:func:`IConsole.pause`
in reason of type :class:`Reason`
Specify the best matching reason code please.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Running state.
raises :class:`VBoxErrorVmError`
Virtual machine error in suspend operation.
"""
if not isinstance(reason, Reason):
raise TypeError("reason can only be an instance of type Reason")
self._call("pauseWithReason",
in_p=[reason])
[docs] def resume_with_reason(self, reason):
"""Internal method for triggering a VM resume with a specified reason code.
The reason code can be interpreted by device/drivers and thus it might
behave slightly differently than a normal VM resume.
:py:func:`IConsole.resume`
in reason of type :class:`Reason`
Specify the best matching reason code please.
raises :class:`VBoxErrorInvalidVmState`
Virtual machine not in Paused state.
raises :class:`VBoxErrorVmError`
Virtual machine error in resume operation.
"""
if not isinstance(reason, Reason):
raise TypeError("reason can only be an instance of type Reason")
self._call("resumeWithReason",
in_p=[reason])
[docs] def save_state_with_reason(self, reason, progress, state_file_path, pause_vm):
"""Internal method for triggering a VM save state with a specified reason
code. The reason code can be interpreted by device/drivers and thus it
might behave slightly differently than a normal VM save state.
This call is fully synchronous, and the caller is expected to have set
the machine state appropriately (and has to set the follow-up machine
state if this call failed).
:py:func:`IMachine.save_state`
in reason of type :class:`Reason`
Specify the best matching reason code please.
in progress of type :class:`IProgress`
Progress object to track the operation completion.
in state_file_path of type str
File path the VM process must save the execution state to.
in pause_vm of type bool
The VM should be paused before saving state. It is automatically
unpaused on error in the "vanilla save state" case.
return left_paused of type bool
Returns if the VM was left in paused state, which is necessary
in many situations (snapshots, teleportation).
raises :class:`VBoxErrorInvalidVmState`
Virtual machine state is not one of the expected values.
raises :class:`VBoxErrorFileError`
Failed to create directory for saved state file.
"""
if not isinstance(reason, Reason):
raise TypeError("reason can only be an instance of type Reason")
if not isinstance(progress, IProgress):
raise TypeError("progress can only be an instance of type IProgress")
if not isinstance(state_file_path, basestring):
raise TypeError("state_file_path can only be an instance of type basestring")
if not isinstance(pause_vm, bool):
raise TypeError("pause_vm can only be an instance of type bool")
left_paused = self._call("saveStateWithReason",
in_p=[reason, progress, state_file_path, pause_vm])
return left_paused
[docs] def cancel_save_state_with_reason(self):
"""Internal method for cancelling a VM save state.
:py:func:`IInternalSessionControl.save_state_with_reason`
"""
self._call("cancelSaveStateWithReason")
class ISession(Interface):
"""
The ISession interface represents a client process and allows for locking
virtual machines (represented by IMachine objects) to prevent conflicting
changes to the machine.
Any caller wishing to manipulate a virtual machine needs to create a session
object first, which lives in its own process space. Such session objects are
then associated with :py:class:`IMachine` objects living in the VirtualBox
server process to coordinate such changes.
There are two typical scenarios in which sessions are used:
To alter machine settings or control a running virtual machine, one
needs to lock a machine for a given session (client process) by calling
:py:func:`IMachine.lock_machine` .
Whereas multiple sessions may control a running virtual machine, only
one process can obtain a write lock on the machine to prevent conflicting
changes. A write lock is also needed if a process wants to actually run a
virtual machine in its own context, such as the VirtualBox GUI or
VBoxHeadless front-ends. They must also lock a machine for their own
sessions before they are allowed to power up the virtual machine.
As a result, no machine settings can be altered while another process is
already using it, either because that process is modifying machine settings
or because the machine is running.
To start a VM using one of the existing VirtualBox front-ends (e.g. the
VirtualBox GUI or VBoxHeadless), one would use
:py:func:`IMachine.launch_vm_process` , which also takes a session object
as its first parameter. This session then identifies the caller and lets the
caller control the started machine (for example, pause machine execution or
power it down) as well as be notified about machine execution state changes.
How sessions objects are created in a client process depends on whether you use
the Main API via COM or via the webservice:
When using the COM API directly, an object of the Session class from the
VirtualBox type library needs to be created. In regular COM C++ client code,
this can be done by calling createLocalObject(), a standard COM API.
This object will then act as a local session object in further calls to open
a session.
In the webservice, the session manager (IWebsessionManager) instead creates
a session object automatically whenever :py:func:`IWebsessionManager.logon`
is called. A managed object reference to that session object can be retrieved by
calling :py:func:`IWebsessionManager.get_session_object` .
"""
__uuid__ = '7844aa05-b02e-4cdd-a04f-ade4a762e6b7'
__wsmap__ = 'managed'
@property
def state(self):
"""Get SessionState value for 'state'
Current state of this session.
"""
ret = self._get_attr("state")
return SessionState(ret)
@property
def type_p(self):
"""Get SessionType value for 'type'
Type of this session. The value of this attribute is valid only
if the session currently has a machine locked (i.e. its
:py:func:`state` is Locked), otherwise an error will be returned.
"""
ret = self._get_attr("type")
return SessionType(ret)
@property
def name(self):
"""Get or set str value for 'name'
Name of this session. Important only for VM sessions, otherwise it
it will be remembered, but not used for anything significant (and can
be left at the empty string which is the default). The value can only
be changed when the session state is SessionState_Unlocked. Make sure
that you use a descriptive name which does not conflict with the VM
process session names: "GUI/Qt", "GUI/SDL" and "headless".
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def machine(self):
"""Get IMachine value for 'machine'
Machine object associated with this session.
"""
ret = self._get_attr("machine")
return IMachine(ret)
@property
def console(self):
"""Get IConsole value for 'console'
Console object associated with this session. Only sessions
which locked the machine for a VM process have a non-null console.
"""
ret = self._get_attr("console")
return IConsole(ret)
[docs] def unlock_machine(self):
"""Unlocks a machine that was previously locked for the current session.
Calling this method is required every time a machine has been locked
for a particular session using the :py:func:`IMachine.launch_vm_process`
or :py:func:`IMachine.lock_machine` calls. Otherwise the state of
the machine will be set to :py:attr:`MachineState.aborted` on the
server, and changes made to the machine settings will be lost.
Generally, it is recommended to unlock all machines explicitly
before terminating the application (regardless of the reason for
the termination).
Do not expect the session state (:py:func:`ISession.state`
to return to "Unlocked" immediately after you invoke this method,
particularly if you have started a new VM process. The session
state will automatically return to "Unlocked" once the VM is no
longer executing, which can of course take a very long time.
raises :class:`OleErrorUnexpected`
Session is not locked.
"""
self._call("unlockMachine")
[docs]class IStorageController(Interface):
"""
Represents a storage controller that is attached to a virtual machine
(:py:class:`IMachine` ). Just as drives (hard disks, DVDs, FDs) are
attached to storage controllers in a real computer, virtual drives
(represented by :py:class:`IMediumAttachment` ) are attached to virtual
storage controllers, represented by this interface.
As opposed to physical hardware, VirtualBox has a very generic concept
of a storage controller, and for purposes of the Main API, all virtual
storage is attached to virtual machines via instances of this interface.
There are five types of such virtual storage controllers: IDE, SCSI, SATA,
SAS and Floppy (see :py:func:`bus` ). Depending on which of these four
is used, certain sub-types may be available and can be selected in
:py:func:`controller_type` .
Depending on these settings, the guest operating system might see
significantly different virtual hardware.
"""
__uuid__ = '49b19d41-4a75-7bd5-c124-259acba3c41d'
__wsmap__ = 'managed'
@property
def name(self):
"""Get or set str value for 'name'
Name of the storage controller, as originally specified with
:py:func:`IMachine.add_storage_controller` . This then uniquely
identifies this controller with other method calls such as
:py:func:`IMachine.attach_device` and :py:func:`IMachine.mount_medium` .
"""
ret = self._get_attr("name")
return ret
@name.setter
def name(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("name", value)
@property
def max_devices_per_port_count(self):
"""Get int value for 'maxDevicesPerPortCount'
Maximum number of devices which can be attached to one port.
"""
ret = self._get_attr("maxDevicesPerPortCount")
return ret
@property
def min_port_count(self):
"""Get int value for 'minPortCount'
Minimum number of ports that :py:func:`IStorageController.port_count` can be set to.
"""
ret = self._get_attr("minPortCount")
return ret
@property
def max_port_count(self):
"""Get int value for 'maxPortCount'
Maximum number of ports that :py:func:`IStorageController.port_count` can be set to.
"""
ret = self._get_attr("maxPortCount")
return ret
@property
def instance(self):
"""Get or set int value for 'instance'
The instance number of the device in the running VM.
"""
ret = self._get_attr("instance")
return ret
@instance.setter
def instance(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("instance", value)
@property
def port_count(self):
"""Get or set int value for 'portCount'
The number of currently usable ports on the controller.
The minimum and maximum number of ports for one controller are
stored in :py:func:`IStorageController.min_port_count`
and :py:func:`IStorageController.max_port_count` .
"""
ret = self._get_attr("portCount")
return ret
@port_count.setter
def port_count(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("portCount", value)
@property
def bus(self):
"""Get StorageBus value for 'bus'
The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
"""
ret = self._get_attr("bus")
return StorageBus(ret)
@property
def controller_type(self):
"""Get or set StorageControllerType value for 'controllerType'
The exact variant of storage controller hardware presented
to the guest.
Depending on this value, VirtualBox will provide a different
virtual storage controller hardware to the guest.
For SATA, SAS and floppy controllers, only one variant is
available, but for IDE and SCSI, there are several.
For SCSI controllers, the default type is LsiLogic.
"""
ret = self._get_attr("controllerType")
return StorageControllerType(ret)
@controller_type.setter
def controller_type(self, value):
if not isinstance(value, StorageControllerType):
raise TypeError("value is not an instance of StorageControllerType")
return self._set_attr("controllerType", value)
@property
def use_host_io_cache(self):
"""Get or set bool value for 'useHostIOCache'
If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
caches and use synchronous file APIs on the host. This was the only option in the API before
VirtualBox 3.2 and is still the default for IDE controllers.
If false, the host I/O cache will be disabled for image files attached to this storage controller.
Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
it possible to turn off the host I/O caches because the emulation can handle unaligned access to
the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
virtual machines are running at the same time to prevent I/O cache related hangs.
This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
"""
ret = self._get_attr("useHostIOCache")
return ret
@use_host_io_cache.setter
def use_host_io_cache(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("useHostIOCache", value)
@property
def bootable(self):
"""Get bool value for 'bootable'
Returns whether it is possible to boot from disks attached to this controller.
"""
ret = self._get_attr("bootable")
return ret
[docs]class INATEngine(Interface):
"""
Interface for managing a NAT engine which is used with a virtual machine. This
allows for changing NAT behavior such as port-forwarding rules. This interface is
used in the :py:func:`INetworkAdapter.nat_engine` attribute.
"""
__uuid__ = 'c1cdb6bf-44cb-e334-66fa-469a17fd09df'
__wsmap__ = 'managed'
@property
def network(self):
"""Get or set str value for 'network'
The network attribute of the NAT engine (the same value is used with built-in
DHCP server to fill corresponding fields of DHCP leases).
"""
ret = self._get_attr("network")
return ret
@network.setter
def network(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("network", value)
@property
def host_ip(self):
"""Get or set str value for 'hostIP'
IP of host interface to bind all opened sockets to.
Changing this does not change binding of port forwarding.
"""
ret = self._get_attr("hostIP")
return ret
@host_ip.setter
def host_ip(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("hostIP", value)
@property
def tftp_prefix(self):
"""Get or set str value for 'TFTPPrefix'
TFTP prefix attribute which is used with the built-in DHCP server to fill
the corresponding fields of DHCP leases.
"""
ret = self._get_attr("TFTPPrefix")
return ret
@tftp_prefix.setter
def tftp_prefix(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("TFTPPrefix", value)
@property
def tftp_boot_file(self):
"""Get or set str value for 'TFTPBootFile'
TFTP boot file attribute which is used with the built-in DHCP server to fill
the corresponding fields of DHCP leases.
"""
ret = self._get_attr("TFTPBootFile")
return ret
@tftp_boot_file.setter
def tftp_boot_file(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("TFTPBootFile", value)
@property
def tftp_next_server(self):
"""Get or set str value for 'TFTPNextServer'
TFTP server attribute which is used with the built-in DHCP server to fill
the corresponding fields of DHCP leases.
The preferred form is IPv4 addresses.
"""
ret = self._get_attr("TFTPNextServer")
return ret
@tftp_next_server.setter
def tftp_next_server(self, value):
if not isinstance(value, basestring):
raise TypeError("value is not an instance of basestring")
return self._set_attr("TFTPNextServer", value)
@property
def alias_mode(self):
"""Get or set int value for 'aliasMode'"""
ret = self._get_attr("aliasMode")
return ret
@alias_mode.setter
def alias_mode(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("aliasMode", value)
@property
def dns_pass_domain(self):
"""Get or set bool value for 'DNSPassDomain'
Whether the DHCP server should pass the DNS domain used by the host.
"""
ret = self._get_attr("DNSPassDomain")
return ret
@dns_pass_domain.setter
def dns_pass_domain(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("DNSPassDomain", value)
@property
def dns_proxy(self):
"""Get or set bool value for 'DNSProxy'
Whether the DHCP server (and the DNS traffic by NAT) should pass the address
of the DNS proxy and process traffic using DNS servers registered on the host.
"""
ret = self._get_attr("DNSProxy")
return ret
@dns_proxy.setter
def dns_proxy(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("DNSProxy", value)
@property
def dns_use_host_resolver(self):
"""Get or set bool value for 'DNSUseHostResolver'
Whether the DHCP server (and the DNS traffic by NAT) should pass the address
of the DNS proxy and process traffic using the host resolver mechanism.
"""
ret = self._get_attr("DNSUseHostResolver")
return ret
@dns_use_host_resolver.setter
def dns_use_host_resolver(self, value):
if not isinstance(value, bool):
raise TypeError("value is not an instance of bool")
return self._set_attr("DNSUseHostResolver", value)
@property
def redirects(self):
"""Get str value for 'redirects'
Array of NAT port-forwarding rules in string representation, in the following
format: "name,protocol id,host ip,host port,guest ip,guest port".
"""
ret = self._get_attr("redirects")
return ret
[docs] def set_network_settings(self, mtu, sock_snd, sock_rcv, tcp_wnd_snd, tcp_wnd_rcv):
"""Sets network configuration of the NAT engine.
in mtu of type int
MTU (maximum transmission unit) of the NAT engine in bytes.
in sock_snd of type int
Capacity of the socket send buffer in bytes when creating a new socket.
in sock_rcv of type int
Capacity of the socket receive buffer in bytes when creating a new socket.
in tcp_wnd_snd of type int
Initial size of the NAT engine's sending TCP window in bytes when
establishing a new TCP connection.
in tcp_wnd_rcv of type int
Initial size of the NAT engine's receiving TCP window in bytes when
establishing a new TCP connection.
"""
if not isinstance(mtu, baseinteger):
raise TypeError("mtu can only be an instance of type baseinteger")
if not isinstance(sock_snd, baseinteger):
raise TypeError("sock_snd can only be an instance of type baseinteger")
if not isinstance(sock_rcv, baseinteger):
raise TypeError("sock_rcv can only be an instance of type baseinteger")
if not isinstance(tcp_wnd_snd, baseinteger):
raise TypeError("tcp_wnd_snd can only be an instance of type baseinteger")
if not isinstance(tcp_wnd_rcv, baseinteger):
raise TypeError("tcp_wnd_rcv can only be an instance of type baseinteger")
self._call("setNetworkSettings",
in_p=[mtu, sock_snd, sock_rcv, tcp_wnd_snd, tcp_wnd_rcv])
[docs] def get_network_settings(self):
"""Returns network configuration of NAT engine. See :py:func:`set_network_settings`
for parameter descriptions.
out mtu of type int
out sock_snd of type int
out sock_rcv of type int
out tcp_wnd_snd of type int
out tcp_wnd_rcv of type int
"""
(mtu, sock_snd, sock_rcv, tcp_wnd_snd, tcp_wnd_rcv) = self._call("getNetworkSettings")
return (mtu, sock_snd, sock_rcv, tcp_wnd_snd, tcp_wnd_rcv)
[docs] def add_redirect(self, name, proto, host_ip, host_port, guest_ip, guest_port):
"""Adds a new NAT port-forwarding rule.
in name of type str
The name of the rule. An empty name is acceptable, in which case the NAT engine
auto-generates one using the other parameters.
in proto of type :class:`NATProtocol`
Protocol handled with the rule.
in host_ip of type str
IP of the host interface to which the rule should apply. An empty ip address is
acceptable, in which case the NAT engine binds the handling socket to any interface.
in host_port of type int
The port number to listen on.
in guest_ip of type str
The IP address of the guest which the NAT engine will forward matching packets
to. An empty IP address is acceptable, in which case the NAT engine will forward
packets to the first DHCP lease (x.x.x.15).
in guest_port of type int
The port number to forward.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(proto, NATProtocol):
raise TypeError("proto can only be an instance of type NATProtocol")
if not isinstance(host_ip, basestring):
raise TypeError("host_ip can only be an instance of type basestring")
if not isinstance(host_port, baseinteger):
raise TypeError("host_port can only be an instance of type baseinteger")
if not isinstance(guest_ip, basestring):
raise TypeError("guest_ip can only be an instance of type basestring")
if not isinstance(guest_port, baseinteger):
raise TypeError("guest_port can only be an instance of type baseinteger")
self._call("addRedirect",
in_p=[name, proto, host_ip, host_port, guest_ip, guest_port])
[docs] def remove_redirect(self, name):
"""Removes a port-forwarding rule that was previously registered.
in name of type str
The name of the rule to delete.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeRedirect",
in_p=[name])
[docs]class IExtPackPlugIn(Interface):
"""
Interface for keeping information about a plug-in that ships with an
extension pack.
"""
__uuid__ = 'c8e667b2-4234-1f9c-6508-afa9cea4efa1'
__wsmap__ = 'suppress'
@property
def name(self):
"""Get str value for 'name'
The plug-in name.
"""
ret = self._get_attr("name")
return ret
@property
def description(self):
"""Get str value for 'description'
The plug-in description.
"""
ret = self._get_attr("description")
return ret
@property
def frontend(self):
"""Get str value for 'frontend'
The name of the frontend or component name this plug-in plugs into.
"""
ret = self._get_attr("frontend")
return ret
@property
def module_path(self):
"""Get str value for 'modulePath'
The module path.
"""
ret = self._get_attr("modulePath")
return ret
[docs]class IExtPackBase(Interface):
"""
Interface for querying information about an extension pack as well as
accessing COM objects within it.
"""
__uuid__ = '4bd17415-4438-8657-e78e-80a40713a23c'
__wsmap__ = 'suppress'
@property
def name(self):
"""Get str value for 'name'
The extension pack name. This is unique.
"""
ret = self._get_attr("name")
return ret
@property
def description(self):
"""Get str value for 'description'
The extension pack description.
"""
ret = self._get_attr("description")
return ret
@property
def version(self):
"""Get str value for 'version'
The extension pack version string. This is restricted to the dotted
version number and optionally a build indicator. No tree revision or
tag will be included in the string as those things are available as
separate properties. An optional publisher tag may be present like for
:py:func:`IVirtualBox.version` .
Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
"""
ret = self._get_attr("version")
return ret
@property
def revision(self):
"""Get int value for 'revision'
The extension pack internal revision number.
"""
ret = self._get_attr("revision")
return ret
@property
def edition(self):
"""Get str value for 'edition'
Edition indicator. This is usually empty.
Can for instance be used to help distinguishing between two editions
of the same extension pack where only the license, service contract or
something differs.
"""
ret = self._get_attr("edition")
return ret
@property
def vrde_module(self):
"""Get str value for 'VRDEModule'
The name of the VRDE module if the extension pack sports one.
"""
ret = self._get_attr("VRDEModule")
return ret
@property
def plug_ins(self):
"""Get IExtPackPlugIn value for 'plugIns'
Plug-ins provided by this extension pack.
"""
ret = self._get_attr("plugIns")
return [IExtPackPlugIn(a) for a in ret]
@property
def usable(self):
"""Get bool value for 'usable'
Indicates whether the extension pack is usable or not.
There are a number of reasons why an extension pack might be unusable,
typical examples would be broken installation/file or that it is
incompatible with the current VirtualBox version.
"""
ret = self._get_attr("usable")
return ret
@property
def why_unusable(self):
"""Get str value for 'whyUnusable'
String indicating why the extension pack is not usable. This is an
empty string if usable and always a non-empty string if not usable.
"""
ret = self._get_attr("whyUnusable")
return ret
@property
def show_license(self):
"""Get bool value for 'showLicense'
Whether to show the license before installation
"""
ret = self._get_attr("showLicense")
return ret
@property
def license_p(self):
"""Get str value for 'license'
The default HTML license text for the extension pack. Same as
calling :py:func:`query_license` queryLicense with
preferredLocale and preferredLanguage as empty strings and format set
to html.
"""
ret = self._get_attr("license")
return ret
[docs] def query_license(self, preferred_locale, preferred_language, format_p):
"""Full feature version of the license attribute.
in preferred_locale of type str
The preferred license locale. Pass an empty string to get the default
license.
in preferred_language of type str
The preferred license language. Pass an empty string to get the
default language for the locale.
in format_p of type str
The license format: html, rtf or txt. If a license is present there
will always be an HTML of it, the rich text format (RTF) and plain
text (txt) versions are optional. If
return license_text of type str
The license text.
"""
if not isinstance(preferred_locale, basestring):
raise TypeError("preferred_locale can only be an instance of type basestring")
if not isinstance(preferred_language, basestring):
raise TypeError("preferred_language can only be an instance of type basestring")
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
license_text = self._call("queryLicense",
in_p=[preferred_locale, preferred_language, format_p])
return license_text
[docs]class IExtPack(IExtPackBase):
"""
Interface for querying information about an extension pack as well as
accessing COM objects within it.
"""
__uuid__ = '431685da-3618-4ebc-b038-833ba829b4b2'
__wsmap__ = 'suppress'
[docs] def query_object(self, obj_uuid):
"""Queries the IUnknown interface to an object in the extension pack
main module. This allows plug-ins and others to talk directly to an
extension pack.
in obj_uuid of type str
The object ID. What exactly this is
return return_interface of type Interface
The queried interface.
"""
if not isinstance(obj_uuid, basestring):
raise TypeError("obj_uuid can only be an instance of type basestring")
return_interface = self._call("queryObject",
in_p=[obj_uuid])
return_interface = Interface(return_interface)
return return_interface
[docs]class IExtPackFile(IExtPackBase):
"""
Extension pack file (aka tarball, .vbox-extpack) representation returned
by :py:func:`IExtPackManager.open_ext_pack_file` . This provides the base
extension pack information with the addition of the file name.
"""
__uuid__ = '4c7f4bf6-4671-2f75-0fbb-a99f6218cdfc'
__wsmap__ = 'suppress'
@property
def file_path(self):
"""Get str value for 'filePath'
The path to the extension pack file.
"""
ret = self._get_attr("filePath")
return ret
[docs] def install(self, replace, display_info):
"""Install the extension pack.
in replace of type bool
Set this to automatically uninstall any existing extension pack with
the same name as the one being installed.
in display_info of type str
Platform specific display information. Reserved for future hacks.
return progess of type :class:`IProgress`
Progress object for the operation.
"""
if not isinstance(replace, bool):
raise TypeError("replace can only be an instance of type bool")
if not isinstance(display_info, basestring):
raise TypeError("display_info can only be an instance of type basestring")
progess = self._call("install",
in_p=[replace, display_info])
progess = IProgress(progess)
return progess
[docs]class IExtPackManager(Interface):
"""
Interface for managing VirtualBox Extension Packs.
@todo Describe extension packs, how they are managed and how to create one.
"""
__uuid__ = 'edba9d10-45d8-b440-1712-46ac0c9bc4c5'
__wsmap__ = 'suppress'
@property
def installed_ext_packs(self):
"""Get IExtPack value for 'installedExtPacks'
List of the installed extension packs.
"""
ret = self._get_attr("installedExtPacks")
return [IExtPack(a) for a in ret]
[docs] def find(self, name):
"""Returns the extension pack with the specified name if found.
in name of type str
The name of the extension pack to locate.
return return_data of type :class:`IExtPack`
The extension pack if found.
raises :class:`VBoxErrorObjectNotFound`
No extension pack matching @a name was found.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
return_data = self._call("find",
in_p=[name])
return_data = IExtPack(return_data)
return return_data
[docs] def open_ext_pack_file(self, path):
"""Attempts to open an extension pack file in preparation for
installation.
in path of type str
The path of the extension pack tarball. This can optionally be
followed by a "::SHA-256=hex-digit" of the tarball.
return file_p of type :class:`IExtPackFile`
The interface of the extension pack file object.
"""
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
file_p = self._call("openExtPackFile",
in_p=[path])
file_p = IExtPackFile(file_p)
return file_p
[docs] def uninstall(self, name, forced_removal, display_info):
"""Uninstalls an extension pack, removing all related files.
in name of type str
The name of the extension pack to uninstall.
in forced_removal of type bool
Forced removal of the extension pack. This means that the uninstall
hook will not be called.
in display_info of type str
Platform specific display information. Reserved for future hacks.
return progess of type :class:`IProgress`
Progress object for the operation.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(forced_removal, bool):
raise TypeError("forced_removal can only be an instance of type bool")
if not isinstance(display_info, basestring):
raise TypeError("display_info can only be an instance of type basestring")
progess = self._call("uninstall",
in_p=[name, forced_removal, display_info])
progess = IProgress(progess)
return progess
[docs] def cleanup(self):
"""Cleans up failed installs and uninstalls
"""
self._call("cleanup")
[docs] def query_all_plug_ins_for_frontend(self, frontend_name):
"""Gets the path to all the plug-in modules for a given frontend.
This is a convenience method that is intended to simplify the plug-in
loading process for a frontend.
in frontend_name of type str
The name of the frontend or component.
return plug_in_modules of type str
Array containing the plug-in modules (full paths).
"""
if not isinstance(frontend_name, basestring):
raise TypeError("frontend_name can only be an instance of type basestring")
plug_in_modules = self._call("queryAllPlugInsForFrontend",
in_p=[frontend_name])
return plug_in_modules
[docs] def is_ext_pack_usable(self, name):
"""Check if the given extension pack is loaded and usable.
in name of type str
The name of the extension pack to check for.
return usable of type bool
Is the given extension pack loaded and usable.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
usable = self._call("isExtPackUsable",
in_p=[name])
return usable
[docs]class IBandwidthGroup(Interface):
"""
Represents one bandwidth group.
"""
__uuid__ = '31587f93-2d12-4d7c-ba6d-ce51d0d5b265'
__wsmap__ = 'managed'
@property
def name(self):
"""Get str value for 'name'
Name of the group.
"""
ret = self._get_attr("name")
return ret
@property
def type_p(self):
"""Get BandwidthGroupType value for 'type'
Type of the group.
"""
ret = self._get_attr("type")
return BandwidthGroupType(ret)
@property
def reference(self):
"""Get int value for 'reference'
How many devices/medium attachments use this group.
"""
ret = self._get_attr("reference")
return ret
@property
def max_bytes_per_sec(self):
"""Get or set int value for 'maxBytesPerSec'
The maximum number of bytes which can be transfered by all
entities attached to this group during one second.
"""
ret = self._get_attr("maxBytesPerSec")
return ret
@max_bytes_per_sec.setter
def max_bytes_per_sec(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("maxBytesPerSec", value)
[docs]class IBandwidthControl(Interface):
"""
Controls the bandwidth groups of one machine used to cap I/O done by a VM.
This includes network and disk I/O.
"""
__uuid__ = '48c7f4c0-c9d6-4742-957c-a6fd52e8c4ae'
__wsmap__ = 'managed'
@property
def num_groups(self):
"""Get int value for 'numGroups'
The current number of existing bandwidth groups managed.
"""
ret = self._get_attr("numGroups")
return ret
[docs] def create_bandwidth_group(self, name, type_p, max_bytes_per_sec):
"""Creates a new bandwidth group.
in name of type str
Name of the bandwidth group.
in type_p of type :class:`BandwidthGroupType`
The type of the bandwidth group (network or disk).
in max_bytes_per_sec of type int
The maximum number of bytes which can be transfered by all
entities attached to this group during one second.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(type_p, BandwidthGroupType):
raise TypeError("type_p can only be an instance of type BandwidthGroupType")
if not isinstance(max_bytes_per_sec, baseinteger):
raise TypeError("max_bytes_per_sec can only be an instance of type baseinteger")
self._call("createBandwidthGroup",
in_p=[name, type_p, max_bytes_per_sec])
[docs] def delete_bandwidth_group(self, name):
"""Deletes a new bandwidth group.
in name of type str
Name of the bandwidth group to delete.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("deleteBandwidthGroup",
in_p=[name])
[docs] def get_bandwidth_group(self, name):
"""Get a bandwidth group by name.
in name of type str
Name of the bandwidth group to get.
return bandwidth_group of type :class:`IBandwidthGroup`
Where to store the bandwidth group on success.
"""
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
bandwidth_group = self._call("getBandwidthGroup",
in_p=[name])
bandwidth_group = IBandwidthGroup(bandwidth_group)
return bandwidth_group
[docs] def get_all_bandwidth_groups(self):
"""Get all managed bandwidth groups.
return bandwidth_groups of type :class:`IBandwidthGroup`
The array of managed bandwidth groups.
"""
bandwidth_groups = self._call("getAllBandwidthGroups")
bandwidth_groups = [IBandwidthGroup(a) for a in bandwidth_groups]
return bandwidth_groups
[docs]class IVirtualBoxClient(Interface):
"""
Convenience interface for client applications. Treat this as a
singleton, i.e. never create more than one instance of this interface.
At the moment only available for clients of the local API (not usable
via the webservice). Once the session logic is redesigned this might
change.
Error information handling is a bit special with IVirtualBoxClient:
creating an instance will always succeed. The return of the actual error
code/information is postponed to any attribute or method call. The
reason for this is that COM likes to mutilate the error code and lose
the detailed error information returned by instance creation.
"""
__uuid__ = 'd2937a8e-cb8d-4382-90ba-b7da78a74573'
__wsmap__ = 'suppress'
@property
def virtual_box(self):
"""Get IVirtualBox value for 'virtualBox'
Reference to the server-side API root object.
"""
ret = self._get_attr("virtualBox")
return IVirtualBox(ret)
@property
def session(self):
"""Get ISession value for 'session'
Create a new session object and return the reference to it.
"""
ret = self._get_attr("session")
return ISession(ret)
@property
def event_source(self):
"""Get IEventSource value for 'eventSource'
Event source for VirtualBoxClient events.
"""
ret = self._get_attr("eventSource")
return IEventSource(ret)
[docs] def check_machine_error(self, machine):
"""Perform error checking before using an :py:class:`IMachine` object.
Generally useful before starting a VM and all other uses. If anything
is not as it should be then this method will return an appropriate
error.
in machine of type :class:`IMachine`
The machine object to check.
"""
if not isinstance(machine, IMachine):
raise TypeError("machine can only be an instance of type IMachine")
self._call("checkMachineError",
in_p=[machine])
class IEventSource(Interface):
"""
Event source. Generally, any object which could generate events can be an event source,
or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
an event source can work with listeners in either active or passive mode. In active mode it is up to
the IEventSource implementation to call :py:func:`IEventListener.handle_event` , in passive mode the
event source keeps track of pending events for each listener and returns available events on demand.
See :py:class:`IEvent` for an introduction to VirtualBox event handling.
"""
__uuid__ = '9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538'
__wsmap__ = 'managed'
[docs] def create_listener(self):
"""Creates a new listener object, useful for passive mode.
return listener of type :class:`IEventListener`
"""
listener = self._call("createListener")
listener = IEventListener(listener)
return listener
[docs] def create_aggregator(self, subordinates):
"""Creates an aggregator event source, collecting events from multiple sources.
This way a single listener can listen for events coming from multiple sources,
using a single blocking :py:func:`get_event` on the returned aggregator.
in subordinates of type :class:`IEventSource`
Subordinate event source this one aggregates.
return result of type :class:`IEventSource`
Event source aggregating passed sources.
"""
if not isinstance(subordinates, list):
raise TypeError("subordinates can only be an instance of type list")
for a in subordinates[:10]:
if not isinstance(a, IEventSource):
raise TypeError(\
"array can only contain objects of type IEventSource")
result = self._call("createAggregator",
in_p=[subordinates])
result = IEventSource(result)
return result
[docs] def register_listener(self, listener, interesting, active):
"""Register an event listener.
To avoid system overload, the VirtualBox server process checks if passive event
listeners call :py:func:`IEventSource.get_event` frequently enough. In the
current implementation, if more than 500 pending events are detected for a passive
event listener, it is forcefully unregistered by the system, and further
:py:func:`get_event` calls will return @c VBOX_E_OBJECT_NOT_FOUND.
in listener of type :class:`IEventListener`
Listener to register.
in interesting of type :class:`VBoxEventType`
Event types listener is interested in. One can use wildcards like -
:py:attr:`VBoxEventType.any_p` to specify wildcards, matching more
than one event.
in active of type bool
Which mode this listener is operating in.
In active mode, :py:func:`IEventListener.handle_event` is called directly.
In passive mode, an internal event queue is created for this this IEventListener.
For each event coming in, it is added to queues for all interested registered passive
listeners. It is then up to the external code to call the listener's
:py:func:`IEventListener.handle_event` method. When done with an event, the
external code must call :py:func:`event_processed` .
"""
if not isinstance(listener, IEventListener):
raise TypeError("listener can only be an instance of type IEventListener")
if not isinstance(interesting, list):
raise TypeError("interesting can only be an instance of type list")
for a in interesting[:10]:
if not isinstance(a, VBoxEventType):
raise TypeError(\
"array can only contain objects of type VBoxEventType")
if not isinstance(active, bool):
raise TypeError("active can only be an instance of type bool")
self._call("registerListener",
in_p=[listener, interesting, active])
[docs] def unregister_listener(self, listener):
"""Unregister an event listener. If listener is passive, and some waitable events are still
in queue they are marked as processed automatically.
in listener of type :class:`IEventListener`
Listener to unregister.
"""
if not isinstance(listener, IEventListener):
raise TypeError("listener can only be an instance of type IEventListener")
self._call("unregisterListener",
in_p=[listener])
[docs] def fire_event(self, event, timeout):
"""Fire an event for this source.
in event of type :class:`IEvent`
Event to deliver.
in timeout of type int
Maximum time to wait for event processing (if event is waitable), in ms;
0 = no wait, -1 = indefinite wait.
return result of type bool
true if an event was delivered to all targets, or is non-waitable.
"""
if not isinstance(event, IEvent):
raise TypeError("event can only be an instance of type IEvent")
if not isinstance(timeout, baseinteger):
raise TypeError("timeout can only be an instance of type baseinteger")
result = self._call("fireEvent",
in_p=[event, timeout])
return result
[docs] def get_event(self, listener, timeout):
"""Get events from this peer's event queue (for passive mode). Calling this method
regularly is required for passive event listeners to avoid system overload;
see :py:func:`IEventSource.register_listener` for details.
in listener of type :class:`IEventListener`
Which listener to get data for.
in timeout of type int
Maximum time to wait for events, in ms;
0 = no wait, -1 = indefinite wait.
return event of type :class:`IEvent`
Event retrieved, or null if none available.
raises :class:`VBoxErrorObjectNotFound`
Listener is not registered, or autounregistered.
"""
if not isinstance(listener, IEventListener):
raise TypeError("listener can only be an instance of type IEventListener")
if not isinstance(timeout, baseinteger):
raise TypeError("timeout can only be an instance of type baseinteger")
event = self._call("getEvent",
in_p=[listener, timeout])
event = IEvent(event)
return event
[docs] def event_processed(self, listener, event):
"""Must be called for waitable events after a particular listener finished its
event processing. When all listeners of a particular event have called this
method, the system will then call :py:func:`IEvent.set_processed` .
in listener of type :class:`IEventListener`
Which listener processed event.
in event of type :class:`IEvent`
Which event.
"""
if not isinstance(listener, IEventListener):
raise TypeError("listener can only be an instance of type IEventListener")
if not isinstance(event, IEvent):
raise TypeError("event can only be an instance of type IEvent")
self._call("eventProcessed",
in_p=[listener, event])
[docs]class IEventListener(Interface):
"""
Event listener. An event listener can work in either active or passive mode, depending on the way
it was registered.
See :py:class:`IEvent` for an introduction to VirtualBox event handling.
"""
__uuid__ = '67099191-32e7-4f6c-85ee-422304c71b90'
__wsmap__ = 'managed'
[docs] def handle_event(self, event):
"""Handle event callback for active listeners. It is not called for
passive listeners. After calling :py:func:`handle_event` on all active listeners
and having received acknowledgement from all passive listeners via
:py:func:`IEventSource.event_processed` , the event is marked as
processed and :py:func:`IEvent.wait_processed` will return
immediately.
in event of type :class:`IEvent`
Event available.
"""
if not isinstance(event, IEvent):
raise TypeError("event can only be an instance of type IEvent")
self._call("handleEvent",
in_p=[event])
[docs]class IEvent(Interface):
"""
Abstract parent interface for VirtualBox events. Actual events will typically implement
a more specific interface which derives from this (see below).
**Introduction to VirtualBox events**
Generally speaking, an event (represented by this interface) signals that something
happened, while an event listener (see :py:class:`IEventListener` ) represents an
entity that is interested in certain events. In order for this to work with
unidirectional protocols (i.e. web services), the concepts of passive and active
listener are used.
Event consumers can register themselves as listeners, providing an array of
events they are interested in (see :py:func:`IEventSource.register_listener` ).
When an event triggers, the listener is notified about the event. The exact
mechanism of the notification depends on whether the listener was registered as
an active or passive listener:
An active listener is very similar to a callback: it is a function invoked
by the API. As opposed to the callbacks that were used in the API before
VirtualBox 4.0 however, events are now objects with an interface hierarchy.
Passive listeners are somewhat trickier to implement, but do not require
a client function to be callable, which is not an option with scripting
languages or web service clients. Internally the :py:class:`IEventSource`
implementation maintains an event queue for each passive listener, and
newly arrived events are put in this queue. When the listener calls
:py:func:`IEventSource.get_event` , first element from its internal event
queue is returned. When the client completes processing of an event,
the :py:func:`IEventSource.event_processed` function must be called,
acknowledging that the event was processed. It supports implementing
waitable events. On passive listener unregistration, all events from its
queue are auto-acknowledged.
Waitable events are useful in situations where the event generator wants to track
delivery or a party wants to wait until all listeners have completed the event. A
typical example would be a vetoable event (see :py:class:`IVetoEvent` ) where a
listeners might veto a certain action, and thus the event producer has to make
sure that all listeners have processed the event and not vetoed before taking
the action.
A given event may have both passive and active listeners at the same time.
**Using events**
Any VirtualBox object capable of producing externally visible events provides an
@c eventSource read-only attribute, which is of the type :py:class:`IEventSource` .
This event source object is notified by VirtualBox once something has happened, so
consumers may register event listeners with this event source. To register a listener,
an object implementing the :py:class:`IEventListener` interface must be provided.
For active listeners, such an object is typically created by the consumer, while for
passive listeners :py:func:`IEventSource.create_listener` should be used. Please
note that a listener created with :py:func:`IEventSource.create_listener` must not be used as an active listener.
Once created, the listener must be registered to listen for the desired events
(see :py:func:`IEventSource.register_listener` ), providing an array of
:py:class:`VBoxEventType` enums. Those elements can either be the individual
event IDs or wildcards matching multiple event IDs.
After registration, the callback's :py:func:`IEventListener.handle_event` method is
called automatically when the event is triggered, while passive listeners have to call
:py:func:`IEventSource.get_event` and :py:func:`IEventSource.event_processed` in
an event processing loop.
The IEvent interface is an abstract parent interface for all such VirtualBox events
coming in. As a result, the standard use pattern inside :py:func:`IEventListener.handle_event`
or the event processing loop is to check the :py:func:`type_p` attribute of the event and
then cast to the appropriate specific interface using @c QueryInterface().
"""
__uuid__ = '0ca2adba-8f30-401b-a8cd-fe31dbe839c0'
__wsmap__ = 'managed'
@property
def type_p(self):
"""Get VBoxEventType value for 'type'
Event type.
"""
ret = self._get_attr("type")
return VBoxEventType(ret)
@property
def source(self):
"""Get IEventSource value for 'source'
Source of this event.
"""
ret = self._get_attr("source")
return IEventSource(ret)
@property
def waitable(self):
"""Get bool value for 'waitable'
If we can wait for this event being processed. If false, :py:func:`wait_processed` returns immediately,
and :py:func:`set_processed` doesn't make sense. Non-waitable events are generally better performing,
as no additional overhead associated with waitability imposed.
Waitable events are needed when one need to be able to wait for particular event processed,
for example for vetoable changes, or if event refers to some resource which need to be kept immutable
until all consumers confirmed events.
"""
ret = self._get_attr("waitable")
return ret
[docs] def set_processed(self):
"""Internal method called by the system when all listeners of a particular event have called
:py:func:`IEventSource.event_processed` . This should not be called by client code.
"""
self._call("setProcessed")
[docs] def wait_processed(self, timeout):
"""Wait until time outs, or this event is processed. Event must be waitable for this operation to have
described semantics, for non-waitable returns true immediately.
in timeout of type int
Maximum time to wait for event processing, in ms;
0 = no wait, -1 = indefinite wait.
return result of type bool
If this event was processed before timeout.
"""
if not isinstance(timeout, baseinteger):
raise TypeError("timeout can only be an instance of type baseinteger")
result = self._call("waitProcessed",
in_p=[timeout])
return result
[docs]class IReusableEvent(IEvent):
"""
Base abstract interface for all reusable events.
"""
__uuid__ = '69bfb134-80f6-4266-8e20-16371f68fa25'
__wsmap__ = 'managed'
@property
def generation(self):
"""Get int value for 'generation'
Current generation of event, incremented on reuse.
"""
ret = self._get_attr("generation")
return ret
[docs] def reuse(self):
"""Marks an event as reused, increments 'generation', fields shall no
longer be considered valid.
"""
self._call("reuse")
[docs]class IMachineEvent(IEvent):
"""
Base abstract interface for all machine events.
"""
__uuid__ = '92ed7b1a-0d96-40ed-ae46-a564d484325e'
__wsmap__ = 'managed'
id = VBoxEventType.machine_event
@property
def machine_id(self):
"""Get str value for 'machineId'
ID of the machine this event relates to.
"""
ret = self._get_attr("machineId")
return ret
[docs]class IMachineStateChangedEvent(IMachineEvent):
"""
Machine state change event.
"""
__uuid__ = '5748F794-48DF-438D-85EB-98FFD70D18C9'
__wsmap__ = 'managed'
id = VBoxEventType.on_machine_state_changed
@property
def state(self):
"""Get MachineState value for 'state'
New execution state.
"""
ret = self._get_attr("state")
return MachineState(ret)
[docs]class IMachineDataChangedEvent(IMachineEvent):
"""
Any of the settings of the given machine has changed.
"""
__uuid__ = 'abe94809-2e88-4436-83d7-50f3e64d0503'
__wsmap__ = 'managed'
id = VBoxEventType.on_machine_data_changed
@property
def temporary(self):
"""Get bool value for 'temporary'
@c true if the settings change is temporary. All permanent
settings changes will trigger an event, and only temporary settings
changes for running VMs will trigger an event. Note: sending events
for temporary changes is NOT IMPLEMENTED.
"""
ret = self._get_attr("temporary")
return ret
[docs]class IMediumRegisteredEvent(IEvent):
"""
The given medium was registered or unregistered
within this VirtualBox installation.
This event is not yet implemented.
"""
__uuid__ = '53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458'
__wsmap__ = 'managed'
id = VBoxEventType.on_medium_registered
@property
def medium_id(self):
"""Get str value for 'mediumId'
ID of the medium this event relates to.
"""
ret = self._get_attr("mediumId")
return ret
@property
def medium_type(self):
"""Get DeviceType value for 'mediumType'
Type of the medium this event relates to.
"""
ret = self._get_attr("mediumType")
return DeviceType(ret)
@property
def registered(self):
"""Get bool value for 'registered'
If @c true, the medium was registered, otherwise it was
unregistered.
"""
ret = self._get_attr("registered")
return ret
[docs]class IMediumConfigChangedEvent(IEvent):
"""
The configuration of the given medium was changed (location, properties,
child/parent or anything else).
This event is not yet implemented.
"""
__uuid__ = 'dd3e2654-a161-41f1-b583-4892f4a9d5d5'
__wsmap__ = 'managed'
id = VBoxEventType.on_medium_config_changed
@property
def medium(self):
"""Get IMedium value for 'medium'
ID of the medium this event relates to.
"""
ret = self._get_attr("medium")
return IMedium(ret)
[docs]class IMachineRegisteredEvent(IMachineEvent):
"""
The given machine was registered or unregistered
within this VirtualBox installation.
"""
__uuid__ = 'c354a762-3ff2-4f2e-8f09-07382ee25088'
__wsmap__ = 'managed'
id = VBoxEventType.on_machine_registered
@property
def registered(self):
"""Get bool value for 'registered'
If @c true, the machine was registered, otherwise it was
unregistered.
"""
ret = self._get_attr("registered")
return ret
[docs]class ISessionStateChangedEvent(IMachineEvent):
"""
The state of the session for the given machine was changed.
:py:func:`IMachine.session_state`
"""
__uuid__ = '714a3eef-799a-4489-86cd-fe8e45b2ff8e'
__wsmap__ = 'managed'
id = VBoxEventType.on_session_state_changed
@property
def state(self):
"""Get SessionState value for 'state'
New session state.
"""
ret = self._get_attr("state")
return SessionState(ret)
[docs]class IGuestPropertyChangedEvent(IMachineEvent):
"""
Notification when a guest property has changed.
"""
__uuid__ = '3f63597a-26f1-4edb-8dd2-6bddd0912368'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_property_changed
@property
def name(self):
"""Get str value for 'name'
The name of the property that has changed.
"""
ret = self._get_attr("name")
return ret
@property
def value(self):
"""Get str value for 'value'
The new property value.
"""
ret = self._get_attr("value")
return ret
@property
def flags(self):
"""Get str value for 'flags'
The new property flags.
"""
ret = self._get_attr("flags")
return ret
[docs]class ISnapshotEvent(IMachineEvent):
"""
Base interface for all snapshot events.
"""
__uuid__ = '21637b0e-34b8-42d3-acfb-7e96daf77c22'
__wsmap__ = 'managed'
id = VBoxEventType.snapshot_event
@property
def snapshot_id(self):
"""Get str value for 'snapshotId'
ID of the snapshot this event relates to.
"""
ret = self._get_attr("snapshotId")
return ret
[docs]class ISnapshotTakenEvent(ISnapshotEvent):
"""
A new snapshot of the machine has been taken.
:py:class:`ISnapshot`
"""
__uuid__ = 'd27c0b3d-6038-422c-b45e-6d4a0503d9f1'
__wsmap__ = 'managed'
id = VBoxEventType.on_snapshot_taken
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class ISnapshotDeletedEvent(ISnapshotEvent):
"""
Snapshot of the given machine has been deleted.
This notification is delivered **after** the snapshot
object has been uninitialized on the server (so that any
attempt to call its methods will return an error).
:py:class:`ISnapshot`
"""
__uuid__ = 'c48f3401-4a9e-43f4-b7a7-54bd285e22f4'
__wsmap__ = 'managed'
id = VBoxEventType.on_snapshot_deleted
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class ISnapshotRestoredEvent(ISnapshotEvent):
"""
Snapshot of the given machine has been restored.
:py:class:`ISnapshot`
"""
__uuid__ = 'f4d803b4-9b2d-4377-bfe6-9702e881516b'
__wsmap__ = 'managed'
id = VBoxEventType.on_snapshot_restored
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class ISnapshotChangedEvent(ISnapshotEvent):
"""
Snapshot properties (name and/or description) have been changed.
:py:class:`ISnapshot`
"""
__uuid__ = '07541941-8079-447a-a33e-47a69c7980db'
__wsmap__ = 'managed'
id = VBoxEventType.on_snapshot_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IMousePointerShapeChangedEvent(IEvent):
"""
Notification when the guest mouse pointer shape has
changed. The new shape data is given.
"""
__uuid__ = 'a6dcf6e8-416b-4181-8c4a-45ec95177aef'
__wsmap__ = 'managed'
id = VBoxEventType.on_mouse_pointer_shape_changed
@property
def visible(self):
"""Get bool value for 'visible'
Flag whether the pointer is visible.
"""
ret = self._get_attr("visible")
return ret
@property
def alpha(self):
"""Get bool value for 'alpha'
Flag whether the pointer has an alpha channel.
"""
ret = self._get_attr("alpha")
return ret
@property
def xhot(self):
"""Get int value for 'xhot'
The pointer hot spot X coordinate.
"""
ret = self._get_attr("xhot")
return ret
@property
def yhot(self):
"""Get int value for 'yhot'
The pointer hot spot Y coordinate.
"""
ret = self._get_attr("yhot")
return ret
@property
def width(self):
"""Get int value for 'width'
Width of the pointer shape in pixels.
"""
ret = self._get_attr("width")
return ret
@property
def height(self):
"""Get int value for 'height'
Height of the pointer shape in pixels.
"""
ret = self._get_attr("height")
return ret
@property
def shape(self):
"""Get str value for 'shape'
Shape buffer arrays.
The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
followed by a 32-bpp XOR (color) mask.
For pointers without alpha channel the XOR mask pixels are
32-bit values: (lsb)BGR0(msb). For pointers with alpha channel
the XOR mask consists of (lsb)BGRA(msb) 32-bit values.
An AND mask is used for pointers with alpha channel, so if the
callback does not support alpha, the pointer could be
displayed as a normal color pointer.
The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
size of the AND mask therefore is cbAnd = (width + 7) / 8 *
height. The padding bits at the end of each scanline are
undefined.
The XOR mask follows the AND mask on the next 4-byte aligned
offset: uint8_t *pXor = pAnd + (cbAnd + 3) & ~3.
Bytes in the gap between the AND and the XOR mask are undefined.
The XOR mask scanlines have no gap between them and the size of
the XOR mask is: cXor = width * 4 * height.
If @a shape is 0, only the pointer visibility is changed.
"""
ret = self._get_attr("shape")
return ret
[docs]class IMouseCapabilityChangedEvent(IEvent):
"""
Notification when the mouse capabilities reported by the
guest have changed. The new capabilities are passed.
"""
__uuid__ = '70e7779a-e64a-4908-804e-371cad23a756'
__wsmap__ = 'managed'
id = VBoxEventType.on_mouse_capability_changed
@property
def supports_absolute(self):
"""Get bool value for 'supportsAbsolute'
Supports absolute coordinates.
"""
ret = self._get_attr("supportsAbsolute")
return ret
@property
def supports_relative(self):
"""Get bool value for 'supportsRelative'
Supports relative coordinates.
"""
ret = self._get_attr("supportsRelative")
return ret
@property
def supports_multi_touch(self):
"""Get bool value for 'supportsMultiTouch'
Supports multi-touch events coordinates.
"""
ret = self._get_attr("supportsMultiTouch")
return ret
@property
def needs_host_cursor(self):
"""Get bool value for 'needsHostCursor'
If host cursor is needed.
"""
ret = self._get_attr("needsHostCursor")
return ret
[docs]class IKeyboardLedsChangedEvent(IEvent):
"""
Notification when the guest OS executes the KBD_CMD_SET_LEDS command
to alter the state of the keyboard LEDs.
"""
__uuid__ = '6DDEF35E-4737-457B-99FC-BC52C851A44F'
__wsmap__ = 'managed'
id = VBoxEventType.on_keyboard_leds_changed
@property
def num_lock(self):
"""Get bool value for 'numLock'
NumLock status.
"""
ret = self._get_attr("numLock")
return ret
@property
def caps_lock(self):
"""Get bool value for 'capsLock'
CapsLock status.
"""
ret = self._get_attr("capsLock")
return ret
@property
def scroll_lock(self):
"""Get bool value for 'scrollLock'
ScrollLock status.
"""
ret = self._get_attr("scrollLock")
return ret
[docs]class IStateChangedEvent(IEvent):
"""
Notification when the execution state of the machine has changed.
The new state is given.
"""
__uuid__ = '4376693C-CF37-453B-9289-3B0F521CAF27'
__wsmap__ = 'managed'
id = VBoxEventType.on_state_changed
@property
def state(self):
"""Get MachineState value for 'state'
New machine state.
"""
ret = self._get_attr("state")
return MachineState(ret)
[docs]class IAdditionsStateChangedEvent(IEvent):
"""
Notification when a Guest Additions property changes.
Interested callees should query IGuest attributes to
find out what has changed.
"""
__uuid__ = 'D70F7915-DA7C-44C8-A7AC-9F173490446A'
__wsmap__ = 'managed'
id = VBoxEventType.on_additions_state_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class INetworkAdapterChangedEvent(IEvent):
"""
Notification when a property of one of the
virtual :py:func:`IMachine.get_network_adapter` network adapters
changes. Interested callees should use INetworkAdapter methods and
attributes to find out what has changed.
"""
__uuid__ = '08889892-1EC6-4883-801D-77F56CFD0103'
__wsmap__ = 'managed'
id = VBoxEventType.on_network_adapter_changed
@property
def network_adapter(self):
"""Get INetworkAdapter value for 'networkAdapter'
Network adapter that is subject to change.
"""
ret = self._get_attr("networkAdapter")
return INetworkAdapter(ret)
[docs]class ISerialPortChangedEvent(IEvent):
"""
Notification when a property of one of the
virtual :py:func:`IMachine.get_serial_port` serial ports changes.
Interested callees should use ISerialPort methods and attributes
to find out what has changed.
"""
__uuid__ = '3BA329DC-659C-488B-835C-4ECA7AE71C6C'
__wsmap__ = 'managed'
id = VBoxEventType.on_serial_port_changed
@property
def serial_port(self):
"""Get ISerialPort value for 'serialPort'
Serial port that is subject to change.
"""
ret = self._get_attr("serialPort")
return ISerialPort(ret)
[docs]class IParallelPortChangedEvent(IEvent):
"""
Notification when a property of one of the
virtual :py:func:`IMachine.get_parallel_port` parallel ports
changes. Interested callees should use ISerialPort methods and
attributes to find out what has changed.
"""
__uuid__ = '813C99FC-9849-4F47-813E-24A75DC85615'
__wsmap__ = 'managed'
id = VBoxEventType.on_parallel_port_changed
@property
def parallel_port(self):
"""Get IParallelPort value for 'parallelPort'
Parallel port that is subject to change.
"""
ret = self._get_attr("parallelPort")
return IParallelPort(ret)
[docs]class IStorageControllerChangedEvent(IEvent):
"""
Notification when a
:py:func:`IMachine.medium_attachments` medium attachment
changes.
"""
__uuid__ = '715212BF-DA59-426E-8230-3831FAA52C56'
__wsmap__ = 'managed'
id = VBoxEventType.on_storage_controller_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IMediumChangedEvent(IEvent):
"""
Notification when a
:py:func:`IMachine.medium_attachments` medium attachment
changes.
This event is not yet implemented.
"""
__uuid__ = '0FE2DA40-5637-472A-9736-72019EABD7DE'
__wsmap__ = 'managed'
id = VBoxEventType.on_medium_changed
@property
def medium_attachment(self):
"""Get IMediumAttachment value for 'mediumAttachment'
Medium attachment that is subject to change.
"""
ret = self._get_attr("mediumAttachment")
return IMediumAttachment(ret)
[docs]class IClipboardModeChangedEvent(IEvent):
"""
Notification when the shared clipboard mode changes.
"""
__uuid__ = 'cac21692-7997-4595-a731-3a509db604e5'
__wsmap__ = 'managed'
id = VBoxEventType.on_clipboard_mode_changed
@property
def clipboard_mode(self):
"""Get ClipboardMode value for 'clipboardMode'
The new clipboard mode.
"""
ret = self._get_attr("clipboardMode")
return ClipboardMode(ret)
[docs]class IDnDModeChangedEvent(IEvent):
"""
Notification when the drag'n drop mode changes.
"""
__uuid__ = 'b55cf856-1f8b-4692-abb4-462429fae5e9'
__wsmap__ = 'managed'
id = VBoxEventType.on_dn_d_mode_changed
@property
def dnd_mode(self):
"""Get DnDMode value for 'dndMode'
The new drag'n drop mode.
"""
ret = self._get_attr("dndMode")
return DnDMode(ret)
[docs]class ICPUChangedEvent(IEvent):
"""
Notification when a CPU changes.
"""
__uuid__ = '4da2dec7-71b2-4817-9a64-4ed12c17388e'
__wsmap__ = 'managed'
id = VBoxEventType.on_cpu_changed
@property
def cpu(self):
"""Get int value for 'CPU'
The CPU which changed.
"""
ret = self._get_attr("CPU")
return ret
@property
def add(self):
"""Get bool value for 'add'
Flag whether the CPU was added or removed.
"""
ret = self._get_attr("add")
return ret
[docs]class ICPUExecutionCapChangedEvent(IEvent):
"""
Notification when the CPU execution cap changes.
"""
__uuid__ = 'dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc'
__wsmap__ = 'managed'
id = VBoxEventType.on_cpu_execution_cap_changed
@property
def execution_cap(self):
"""Get int value for 'executionCap'
The new CPU execution cap value. (1-100)
"""
ret = self._get_attr("executionCap")
return ret
[docs]class IGuestKeyboardEvent(IEvent):
"""
Notification when guest keyboard event happens.
"""
__uuid__ = '88394258-7006-40d4-b339-472ee3801844'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_keyboard
@property
def scancodes(self):
"""Get int value for 'scancodes'
Array of scancodes.
"""
ret = self._get_attr("scancodes")
return ret
[docs]class IGuestMouseEvent(IReusableEvent):
"""
Notification when guest mouse event happens.
"""
__uuid__ = '179f8647-319c-4e7e-8150-c5837bd265f6'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_mouse
@property
def mode(self):
"""Get GuestMouseEventMode value for 'mode'
If this event is relative, absolute or multi-touch.
"""
ret = self._get_attr("mode")
return GuestMouseEventMode(ret)
@property
def x(self):
"""Get int value for 'x'
New X position, or X delta.
"""
ret = self._get_attr("x")
return ret
@property
def y(self):
"""Get int value for 'y'
New Y position, or Y delta.
"""
ret = self._get_attr("y")
return ret
@property
def z(self):
"""Get int value for 'z'
Z delta.
"""
ret = self._get_attr("z")
return ret
@property
def w(self):
"""Get int value for 'w'
W delta.
"""
ret = self._get_attr("w")
return ret
@property
def buttons(self):
"""Get int value for 'buttons'
Button state bitmask.
"""
ret = self._get_attr("buttons")
return ret
[docs]class IGuestMultiTouchEvent(IEvent):
"""
Notification when guest touch screen event happens.
"""
__uuid__ = 'be8a0eb5-f4f4-4dd0-9d30-c89b873247ec'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_multi_touch
@property
def contact_count(self):
"""Get int value for 'contactCount'
Number of contacts in the event.
"""
ret = self._get_attr("contactCount")
return ret
@property
def x_positions(self):
"""Get int value for 'xPositions'
X positions.
"""
ret = self._get_attr("xPositions")
return ret
@property
def y_positions(self):
"""Get int value for 'yPositions'
Y positions.
"""
ret = self._get_attr("yPositions")
return ret
@property
def contact_ids(self):
"""Get int value for 'contactIds'
Contact identifiers.
"""
ret = self._get_attr("contactIds")
return ret
@property
def contact_flags(self):
"""Get int value for 'contactFlags'
Contact state.
Bit 0: in contact.
Bit 1: in range.
"""
ret = self._get_attr("contactFlags")
return ret
@property
def scan_time(self):
"""Get int value for 'scanTime'
Timestamp of the event in milliseconds. Only relative time between events is important.
"""
ret = self._get_attr("scanTime")
return ret
[docs]class IGuestSessionEvent(IEvent):
"""
Base abstract interface for all guest session events.
"""
__uuid__ = 'b9acd33f-647d-45ac-8fe9-f49b3183ba37'
__wsmap__ = 'managed'
@property
def session(self):
"""Get IGuestSession value for 'session'
Guest session that is subject to change.
"""
ret = self._get_attr("session")
return IGuestSession(ret)
[docs]class IGuestSessionStateChangedEvent(IGuestSessionEvent):
"""
Notification when a guest session changed its state.
"""
__uuid__ = '327e3c00-ee61-462f-aed3-0dff6cbf9904'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_session_state_changed
@property
def id_p(self):
"""Get int value for 'id'
Session ID of guest session which was changed.
"""
ret = self._get_attr("id")
return ret
@property
def status(self):
"""Get GuestSessionStatus value for 'status'
New session status.
"""
ret = self._get_attr("status")
return GuestSessionStatus(ret)
@property
def error(self):
"""Get IVirtualBoxErrorInfo value for 'error'
Error information in case of new session status is indicating an error.
The attribute :py:func:`IVirtualBoxErrorInfo.result_detail` will contain
the runtime (IPRT) error code from the guest. See include/iprt/err.h and
include/VBox/err.h for details.
"""
ret = self._get_attr("error")
return IVirtualBoxErrorInfo(ret)
[docs]class IGuestSessionRegisteredEvent(IGuestSessionEvent):
"""
Notification when a guest session was registered or unregistered.
"""
__uuid__ = 'b79de686-eabd-4fa6-960a-f1756c99ea1c'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_session_registered
@property
def registered(self):
"""Get bool value for 'registered'
If @c true, the guest session was registered, otherwise it was
unregistered.
"""
ret = self._get_attr("registered")
return ret
[docs]class IGuestProcessEvent(IGuestSessionEvent):
"""
Base abstract interface for all guest process events.
"""
__uuid__ = '2405f0e5-6588-40a3-9b0a-68c05ba52c4b'
__wsmap__ = 'managed'
@property
def process(self):
"""Get IGuestProcess value for 'process'
Guest process object which is related to this event.
"""
ret = self._get_attr("process")
return IGuestProcess(ret)
@property
def pid(self):
"""Get int value for 'pid'
Guest process ID (PID).
"""
ret = self._get_attr("pid")
return ret
[docs]class IGuestProcessRegisteredEvent(IGuestProcessEvent):
"""
Notification when a guest process was registered or unregistered.
"""
__uuid__ = '1d89e2b3-c6ea-45b6-9d43-dc6f70cc9f02'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_process_registered
@property
def registered(self):
"""Get bool value for 'registered'
If @c true, the guest process was registered, otherwise it was
unregistered.
"""
ret = self._get_attr("registered")
return ret
[docs]class IGuestProcessStateChangedEvent(IGuestProcessEvent):
"""
Notification when a guest process changed its state.
"""
__uuid__ = 'c365fb7b-4430-499f-92c8-8bed814a567a'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_process_state_changed
@property
def status(self):
"""Get ProcessStatus value for 'status'
New guest process status.
"""
ret = self._get_attr("status")
return ProcessStatus(ret)
@property
def error(self):
"""Get IVirtualBoxErrorInfo value for 'error'
Error information in case of new session status is indicating an error.
The attribute :py:func:`IVirtualBoxErrorInfo.result_detail` will contain
the runtime (IPRT) error code from the guest. See include/iprt/err.h and
include/VBox/err.h for details.
"""
ret = self._get_attr("error")
return IVirtualBoxErrorInfo(ret)
[docs]class IGuestProcessIOEvent(IGuestProcessEvent):
"""
Base abstract interface for all guest process input/output (IO) events.
"""
__uuid__ = '9ea9227c-e9bb-49b3-bfc7-c5171e93ef38'
__wsmap__ = 'managed'
@property
def handle(self):
"""Get int value for 'handle'
Input/output (IO) handle involved in this event. Usually 0 is stdin,
1 is stdout and 2 is stderr.
"""
ret = self._get_attr("handle")
return ret
@property
def processed(self):
"""Get int value for 'processed'
Processed input or output (in bytes).
"""
ret = self._get_attr("processed")
return ret
[docs]class IGuestProcessOutputEvent(IGuestProcessIOEvent):
"""
Notification when there is guest process output available for reading.
"""
__uuid__ = 'd3d5f1ee-bcb2-4905-a7ab-cc85448a742b'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_process_output
@property
def data(self):
"""Get str value for 'data'
Actual output data.
"""
ret = self._get_attr("data")
return ret
[docs]class IGuestFileEvent(IGuestSessionEvent):
"""
Base abstract interface for all guest file events.
"""
__uuid__ = 'c8adb7b0-057d-4391-b928-f14b06b710c5'
__wsmap__ = 'managed'
@property
def file_p(self):
"""Get IGuestFile value for 'file'
Guest file object which is related to this event.
"""
ret = self._get_attr("file")
return IGuestFile(ret)
[docs]class IGuestFileRegisteredEvent(IGuestFileEvent):
"""
Notification when a guest file was registered or unregistered.
"""
__uuid__ = 'd0d93830-70a2-487e-895e-d3fc9679f7b3'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_file_registered
@property
def registered(self):
"""Get bool value for 'registered'
If @c true, the guest file was registered, otherwise it was
unregistered.
"""
ret = self._get_attr("registered")
return ret
[docs]class IGuestFileStateChangedEvent(IGuestFileEvent):
"""
Notification when a guest file changed its state.
"""
__uuid__ = 'd37fe88f-0979-486c-baa1-3abb144dc82d'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_file_state_changed
@property
def status(self):
"""Get FileStatus value for 'status'
New guest file status.
"""
ret = self._get_attr("status")
return FileStatus(ret)
@property
def error(self):
"""Get IVirtualBoxErrorInfo value for 'error'
Error information in case of new session status is indicating an error.
The attribute :py:func:`IVirtualBoxErrorInfo.result_detail` will contain
the runtime (IPRT) error code from the guest. See include/iprt/err.h and
include/VBox/err.h for details.
"""
ret = self._get_attr("error")
return IVirtualBoxErrorInfo(ret)
[docs]class IGuestFileIOEvent(IGuestFileEvent):
"""
Base abstract interface for all guest file input/output (IO) events.
"""
__uuid__ = 'b5191a7c-9536-4ef8-820e-3b0e17e5bbc8'
__wsmap__ = 'managed'
@property
def offset(self):
"""Get int value for 'offset'
Current offset (in bytes).
"""
ret = self._get_attr("offset")
return ret
@property
def processed(self):
"""Get int value for 'processed'
Processed input or output (in bytes).
"""
ret = self._get_attr("processed")
return ret
[docs]class IGuestFileOffsetChangedEvent(IGuestFileIOEvent):
"""
Notification when a guest file changed its current offset.
"""
__uuid__ = 'e8f79a21-1207-4179-94cf-ca250036308f'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_file_offset_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IGuestFileReadEvent(IGuestFileIOEvent):
"""
Notification when data has been read from a guest file.
"""
__uuid__ = '4ee3cbcb-486f-40db-9150-deee3fd24189'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_file_read
@property
def data(self):
"""Get str value for 'data'
Actual data read.
"""
ret = self._get_attr("data")
return ret
[docs]class IGuestFileWriteEvent(IGuestFileIOEvent):
"""
Notification when data has been written to a guest file.
"""
__uuid__ = 'e062a915-3cf5-4c0a-bc90-9b8d4cc94d89'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_file_write
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IVRDEServerChangedEvent(IEvent):
"""
Notification when a property of the
:py:func:`IMachine.vrde_server` VRDE server changes.
Interested callees should use IVRDEServer methods and attributes to
find out what has changed.
"""
__uuid__ = 'a06fd66a-3188-4c8c-8756-1395e8cb691c'
__wsmap__ = 'managed'
id = VBoxEventType.on_vrde_server_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IVRDEServerInfoChangedEvent(IEvent):
"""
Notification when the status of the VRDE server changes. Interested callees
should use :py:func:`IConsole.vrde_server_info` IVRDEServerInfo
attributes to find out what is the current status.
"""
__uuid__ = 'dd6a1080-e1b7-4339-a549-f0878115596e'
__wsmap__ = 'managed'
id = VBoxEventType.on_vrde_server_info_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IVideoCaptureChangedEvent(IEvent):
"""
Notification when video capture settings have changed.
"""
__uuid__ = '6215d169-25dd-4719-ab34-c908701efb58'
__wsmap__ = 'managed'
id = VBoxEventType.on_video_capture_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IUSBControllerChangedEvent(IEvent):
"""
Notification when a property of the virtual
:py:func:`IMachine.usb_controllers` USB controllers changes.
Interested callees should use IUSBController methods and attributes to
find out what has changed.
"""
__uuid__ = '93BADC0C-61D9-4940-A084-E6BB29AF3D83'
__wsmap__ = 'managed'
id = VBoxEventType.on_usb_controller_changed
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IUSBDeviceStateChangedEvent(IEvent):
"""
Notification when a USB device is attached to or detached from
the virtual USB controller.
This notification is sent as a result of the indirect
request to attach the device because it matches one of the
machine USB filters, or as a result of the direct request
issued by :py:func:`IConsole.attach_usb_device` or
:py:func:`IConsole.detach_usb_device` .
This notification is sent in case of both a succeeded and a
failed request completion. When the request succeeds, the
@a error parameter is @c null, and the given device has been
already added to (when @a attached is @c true) or removed from
(when @a attached is @c false) the collection represented by
:py:func:`IConsole.usb_devices` . On failure, the collection
doesn't change and the @a error parameter represents the error
message describing the failure.
"""
__uuid__ = '806da61b-6679-422a-b629-51b06b0c6d93'
__wsmap__ = 'managed'
id = VBoxEventType.on_usb_device_state_changed
@property
def device(self):
"""Get IUSBDevice value for 'device'
Device that is subject to state change.
"""
ret = self._get_attr("device")
return IUSBDevice(ret)
@property
def attached(self):
"""Get bool value for 'attached'
@c true if the device was attached and @c false otherwise.
"""
ret = self._get_attr("attached")
return ret
@property
def error(self):
"""Get IVirtualBoxErrorInfo value for 'error'
@c null on success or an error message object on failure.
"""
ret = self._get_attr("error")
return IVirtualBoxErrorInfo(ret)
[docs]class ISharedFolderChangedEvent(IEvent):
"""
Notification when a shared folder is added or removed.
The @a scope argument defines one of three scopes:
:py:func:`IVirtualBox.shared_folders` global shared folders
(:py:attr:`Scope.global_p` Global),
:py:func:`IMachine.shared_folders` permanent shared folders of
the machine (:py:attr:`Scope.machine` Machine) or :py:func:`IConsole.shared_folders` transient shared folders of the
machine (:py:attr:`Scope.session` Session). Interested callees
should use query the corresponding collections to find out what has
changed.
"""
__uuid__ = 'B66349B5-3534-4239-B2DE-8E1535D94C0B'
__wsmap__ = 'managed'
id = VBoxEventType.on_shared_folder_changed
@property
def scope(self):
"""Get Scope value for 'scope'
Scope of the notification.
"""
ret = self._get_attr("scope")
return Scope(ret)
[docs]class IRuntimeErrorEvent(IEvent):
"""
Notification when an error happens during the virtual
machine execution.
There are three kinds of runtime errors:
*fatal*
*non-fatal with retry*
*non-fatal warnings*
**Fatal** errors are indicated by the @a fatal parameter set
to @c true. In case of fatal errors, the virtual machine
execution is always paused before calling this notification, and
the notification handler is supposed either to immediately save
the virtual machine state using :py:func:`IMachine.save_state`
or power it off using :py:func:`IConsole.power_down` .
Resuming the execution can lead to unpredictable results.
**Non-fatal** errors and warnings are indicated by the
@a fatal parameter set to @c false. If the virtual machine
is in the Paused state by the time the error notification is
received, it means that the user can *try to resume* the machine
execution after attempting to solve the problem that caused the
error. In this case, the notification handler is supposed
to show an appropriate message to the user (depending on the
value of the @a id parameter) that offers several actions such
as *Retry*, *Save* or *Power Off*. If the user
wants to retry, the notification handler should continue
the machine execution using the :py:func:`IConsole.resume`
call. If the machine execution is not Paused during this
notification, then it means this notification is a *warning*
(for example, about a fatal condition that can happen very soon);
no immediate action is required from the user, the machine
continues its normal execution.
Note that in either case the notification handler
**must not** perform any action directly on a thread
where this notification is called. Everything it is allowed to
do is to post a message to another thread that will then talk
to the user and take the corresponding action.
Currently, the following error identifiers are known:
"HostMemoryLow"
"HostAudioNotResponding"
"VDIStorageFull"
"3DSupportIncompatibleAdditions"
"""
__uuid__ = '883DD18B-0721-4CDE-867C-1A82ABAF914C'
__wsmap__ = 'managed'
id = VBoxEventType.on_runtime_error
@property
def fatal(self):
"""Get bool value for 'fatal'
Whether the error is fatal or not.
"""
ret = self._get_attr("fatal")
return ret
@property
def id_p(self):
"""Get str value for 'id'
Error identifier.
"""
ret = self._get_attr("id")
return ret
@property
def message(self):
"""Get str value for 'message'
Optional error message.
"""
ret = self._get_attr("message")
return ret
[docs]class IEventSourceChangedEvent(IEvent):
"""
Notification when an event source state changes (listener added or removed).
"""
__uuid__ = 'e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a'
__wsmap__ = 'managed'
id = VBoxEventType.on_event_source_changed
@property
def listener(self):
"""Get IEventListener value for 'listener'
Event listener which has changed.
"""
ret = self._get_attr("listener")
return IEventListener(ret)
@property
def add(self):
"""Get bool value for 'add'
Flag whether listener was added or removed.
"""
ret = self._get_attr("add")
return ret
[docs]class IVetoEvent(IEvent):
"""
Base abstract interface for veto events.
"""
__uuid__ = '7c5e945f-2354-4267-883f-2f417d216519'
__wsmap__ = 'managed'
[docs] def add_veto(self, reason):
"""Adds a veto on this event.
in reason of type str
Reason for veto, could be null or empty string.
"""
if not isinstance(reason, basestring):
raise TypeError("reason can only be an instance of type basestring")
self._call("addVeto",
in_p=[reason])
[docs] def is_vetoed(self):
"""If this event was vetoed.
return result of type bool
Reason for veto.
"""
result = self._call("isVetoed")
return result
[docs] def get_vetos(self):
"""Current veto reason list, if size is 0 - no veto.
return result of type str
Array of reasons for veto provided by different event handlers.
"""
result = self._call("getVetos")
return result
[docs] def add_approval(self, reason):
"""Adds an approval on this event.
in reason of type str
Reason for approval, could be null or empty string.
"""
if not isinstance(reason, basestring):
raise TypeError("reason can only be an instance of type basestring")
self._call("addApproval",
in_p=[reason])
[docs] def is_approved(self):
"""If this event was approved.
return result of type bool
"""
result = self._call("isApproved")
return result
[docs] def get_approvals(self):
"""Current approval reason list, if size is 0 - no approvals.
return result of type str
Array of reasons for approval provided by different event handlers.
"""
result = self._call("getApprovals")
return result
[docs]class ICanShowWindowEvent(IVetoEvent):
"""
Notification when a call to
:py:func:`IMachine.can_show_console_window` is made by a
front-end to check if a subsequent call to
:py:func:`IMachine.show_console_window` can succeed.
The callee should give an answer appropriate to the current
machine state using event veto. This answer must
remain valid at least until the next
:py:func:`IConsole.state` machine state change.
"""
__uuid__ = 'adf292b0-92c9-4a77-9d35-e058b39fe0b9'
__wsmap__ = 'managed'
id = VBoxEventType.on_can_show_window
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
[docs]class IShowWindowEvent(IEvent):
"""
Notification when a call to
:py:func:`IMachine.show_console_window`
requests the console window to be activated and brought to
foreground on the desktop of the host PC.
This notification should cause the VM console process to
perform the requested action as described above. If it is
impossible to do it at a time of this notification, this
method should return a failure.
Note that many modern window managers on many platforms
implement some sort of focus stealing prevention logic, so
that it may be impossible to activate a window without the
help of the currently active application (which is supposedly
an initiator of this notification). In this case, this method
must return a non-zero identifier that represents the
top-level window of the VM console process. The caller, if it
represents a currently active process, is responsible to use
this identifier (in a platform-dependent manner) to perform
actual window activation.
This method must set @a winId to zero if it has performed all
actions necessary to complete the request and the console
window is now active and in foreground, to indicate that no
further action is required on the caller's side.
"""
__uuid__ = 'B0A0904D-2F05-4D28-855F-488F96BAD2B2'
__wsmap__ = 'managed'
id = VBoxEventType.on_show_window
@property
def win_id(self):
"""Get or set int value for 'winId'
Platform-dependent identifier of the top-level VM console
window, or zero if this method has performed all actions
necessary to implement the *show window* semantics for
the given platform and/or this VirtualBox front-end.
"""
ret = self._get_attr("winId")
return ret
@win_id.setter
def win_id(self, value):
if not isinstance(value, baseinteger):
raise TypeError("value is not an instance of baseinteger")
return self._set_attr("winId", value)
[docs]class INATRedirectEvent(IMachineEvent):
"""
Notification when NAT redirect rule added or removed.
"""
__uuid__ = '24eef068-c380-4510-bc7c-19314a7352f1'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_redirect
@property
def slot(self):
"""Get int value for 'slot'
Adapter which NAT attached to.
"""
ret = self._get_attr("slot")
return ret
@property
def remove(self):
"""Get bool value for 'remove'
Whether rule remove or add.
"""
ret = self._get_attr("remove")
return ret
@property
def name(self):
"""Get str value for 'name'
Name of the rule.
"""
ret = self._get_attr("name")
return ret
@property
def proto(self):
"""Get NATProtocol value for 'proto'
Protocol (TCP or UDP) of the redirect rule.
"""
ret = self._get_attr("proto")
return NATProtocol(ret)
@property
def host_ip(self):
"""Get str value for 'hostIP'
Host ip address to bind socket on.
"""
ret = self._get_attr("hostIP")
return ret
@property
def host_port(self):
"""Get int value for 'hostPort'
Host port to bind socket on.
"""
ret = self._get_attr("hostPort")
return ret
@property
def guest_ip(self):
"""Get str value for 'guestIP'
Guest ip address to redirect to.
"""
ret = self._get_attr("guestIP")
return ret
@property
def guest_port(self):
"""Get int value for 'guestPort'
Guest port to redirect to.
"""
ret = self._get_attr("guestPort")
return ret
[docs]class IHostPCIDevicePlugEvent(IMachineEvent):
"""
Notification when host PCI device is plugged/unplugged. Plugging
usually takes place on VM startup, unplug - when
:py:func:`IMachine.detach_host_pci_device` is called.
:py:func:`IMachine.detach_host_pci_device`
"""
__uuid__ = 'a0bad6df-d612-47d3-89d4-db3992533948'
__wsmap__ = 'managed'
id = VBoxEventType.on_host_pci_device_plug
@property
def plugged(self):
"""Get bool value for 'plugged'
If device successfully plugged or unplugged.
"""
ret = self._get_attr("plugged")
return ret
@property
def success(self):
"""Get bool value for 'success'
If operation was successful, if false - 'message' attribute
may be of interest.
"""
ret = self._get_attr("success")
return ret
@property
def attachment(self):
"""Get IPCIDeviceAttachment value for 'attachment'
Attachment info for this device.
"""
ret = self._get_attr("attachment")
return IPCIDeviceAttachment(ret)
@property
def message(self):
"""Get str value for 'message'
Optional error message.
"""
ret = self._get_attr("message")
return ret
[docs]class IVBoxSVCAvailabilityChangedEvent(IEvent):
"""
Notification when VBoxSVC becomes unavailable (due to a crash or similar
unexpected circumstances) or available again.
"""
__uuid__ = '97c78fcd-d4fc-485f-8613-5af88bfcfcdc'
__wsmap__ = 'managed'
id = VBoxEventType.on_v_box_svc_availability_changed
@property
def available(self):
"""Get bool value for 'available'
Whether VBoxSVC is available now.
"""
ret = self._get_attr("available")
return ret
[docs]class IBandwidthGroupChangedEvent(IEvent):
"""
Notification when one of the bandwidth groups changed
"""
__uuid__ = '334df94a-7556-4cbc-8c04-043096b02d82'
__wsmap__ = 'managed'
id = VBoxEventType.on_bandwidth_group_changed
@property
def bandwidth_group(self):
"""Get IBandwidthGroup value for 'bandwidthGroup'
The changed bandwidth group.
"""
ret = self._get_attr("bandwidthGroup")
return IBandwidthGroup(ret)
[docs]class IGuestMonitorChangedEvent(IEvent):
"""
Notification when the guest enables one of its monitors.
"""
__uuid__ = '0f7b8a22-c71f-4a36-8e5f-a77d01d76090'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_monitor_changed
@property
def change_type(self):
"""Get GuestMonitorChangedEventType value for 'changeType'
What was changed for this guest monitor.
"""
ret = self._get_attr("changeType")
return GuestMonitorChangedEventType(ret)
@property
def screen_id(self):
"""Get int value for 'screenId'
The monitor which was changed.
"""
ret = self._get_attr("screenId")
return ret
@property
def origin_x(self):
"""Get int value for 'originX'
Physical X origin relative to the primary screen.
Valid for Enabled and NewOrigin.
"""
ret = self._get_attr("originX")
return ret
@property
def origin_y(self):
"""Get int value for 'originY'
Physical Y origin relative to the primary screen.
Valid for Enabled and NewOrigin.
"""
ret = self._get_attr("originY")
return ret
@property
def width(self):
"""Get int value for 'width'
Width of the screen.
Valid for Enabled.
"""
ret = self._get_attr("width")
return ret
@property
def height(self):
"""Get int value for 'height'
Height of the screen.
Valid for Enabled.
"""
ret = self._get_attr("height")
return ret
[docs]class IGuestUserStateChangedEvent(IEvent):
"""
Notification when a guest user changed its state.
"""
__uuid__ = '39b4e759-1ec0-4c0f-857f-fbe2a737a256'
__wsmap__ = 'managed'
id = VBoxEventType.on_guest_user_state_changed
@property
def name(self):
"""Get str value for 'name'
Name of the guest user whose state changed.
"""
ret = self._get_attr("name")
return ret
@property
def domain(self):
"""Get str value for 'domain'
Name of the FQDN (fully qualified domain name) this user is bound
to. Optional.
"""
ret = self._get_attr("domain")
return ret
@property
def state(self):
"""Get GuestUserState value for 'state'
What was changed for this guest user. See :py:class:`GuestUserState` for
more information.
"""
ret = self._get_attr("state")
return GuestUserState(ret)
@property
def state_details(self):
"""Get str value for 'stateDetails'
Optional state details, depending on the :py:func:`state` attribute.
"""
ret = self._get_attr("stateDetails")
return ret
[docs]class IStorageDeviceChangedEvent(IEvent):
"""
Notification when a
:py:func:`IMachine.medium_attachments` storage device
is attached or removed.
"""
__uuid__ = '232e9151-ae84-4b8e-b0f3-5c20c35caac9'
__wsmap__ = 'managed'
id = VBoxEventType.on_storage_device_changed
@property
def storage_device(self):
"""Get IMediumAttachment value for 'storageDevice'
Storage device that is subject to change.
"""
ret = self._get_attr("storageDevice")
return IMediumAttachment(ret)
@property
def removed(self):
"""Get bool value for 'removed'
Flag whether the device was removed or added to the VM.
"""
ret = self._get_attr("removed")
return ret
@property
def silent(self):
"""Get bool value for 'silent'
Flag whether the guest should be notified about the change.
"""
ret = self._get_attr("silent")
return ret
class INATNetworkChangedEvent(IEvent):
""""""
__uuid__ = '101ae042-1a29-4a19-92cf-02285773f3b5'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_changed
@property
def network_name(self):
"""Get str value for 'networkName'"""
ret = self._get_attr("networkName")
return ret
[docs]class INATNetworkStartStopEvent(INATNetworkChangedEvent):
"""
IsStartEvent is true when NAT network is started and false on stopping.
"""
__uuid__ = '269d8f6b-fa1e-4cee-91c7-6d8496bea3c1'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_start_stop
@property
def start_event(self):
"""Get bool value for 'startEvent'
IsStartEvent is true when NAT network is started and false on stopping.
"""
ret = self._get_attr("startEvent")
return ret
class INATNetworkAlterEvent(INATNetworkChangedEvent):
""""""
__uuid__ = 'd947adf5-4022-dc80-5535-6fb116815604'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_alter
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret
class INATNetworkCreationDeletionEvent(INATNetworkAlterEvent):
""""""
__uuid__ = '8d984a7e-b855-40b8-ab0c-44d3515b4528'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_creation_deletion
@property
def creation_event(self):
"""Get bool value for 'creationEvent'"""
ret = self._get_attr("creationEvent")
return ret
class INATNetworkSettingEvent(INATNetworkAlterEvent):
""""""
__uuid__ = '9db3a9e6-7f29-4aae-a627-5a282c83092c'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_setting
@property
def enabled(self):
"""Get bool value for 'enabled'"""
ret = self._get_attr("enabled")
return ret
@property
def network(self):
"""Get str value for 'network'"""
ret = self._get_attr("network")
return ret
@property
def gateway(self):
"""Get str value for 'gateway'"""
ret = self._get_attr("gateway")
return ret
@property
def advertise_default_i_pv6_route_enabled(self):
"""Get bool value for 'advertiseDefaultIPv6RouteEnabled'"""
ret = self._get_attr("advertiseDefaultIPv6RouteEnabled")
return ret
@property
def need_dhcp_server(self):
"""Get bool value for 'needDhcpServer'"""
ret = self._get_attr("needDhcpServer")
return ret
class INATNetworkPortForwardEvent(INATNetworkAlterEvent):
""""""
__uuid__ = '2514881b-23d0-430a-a7ff-7ed7f05534bc'
__wsmap__ = 'managed'
id = VBoxEventType.on_nat_network_port_forward
@property
def create(self):
"""Get bool value for 'create'"""
ret = self._get_attr("create")
return ret
@property
def ipv6(self):
"""Get bool value for 'ipv6'"""
ret = self._get_attr("ipv6")
return ret
@property
def name(self):
"""Get str value for 'name'"""
ret = self._get_attr("name")
return ret
@property
def proto(self):
"""Get NATProtocol value for 'proto'"""
ret = self._get_attr("proto")
return NATProtocol(ret)
@property
def host_ip(self):
"""Get str value for 'hostIp'"""
ret = self._get_attr("hostIp")
return ret
@property
def host_port(self):
"""Get int value for 'hostPort'"""
ret = self._get_attr("hostPort")
return ret
@property
def guest_ip(self):
"""Get str value for 'guestIp'"""
ret = self._get_attr("guestIp")
return ret
@property
def guest_port(self):
"""Get int value for 'guestPort'"""
ret = self._get_attr("guestPort")
return ret
class IHostNameResolutionConfigurationChangeEvent(IEvent):
""""""
__uuid__ = 'f9b9e1cf-cb63-47a1-84fb-02c4894b89a9'
__wsmap__ = 'managed'
id = VBoxEventType.on_host_name_resolution_configuration_change
@property
def midl_does_not_like_empty_interfaces(self):
"""Get bool value for 'midlDoesNotLikeEmptyInterfaces'"""
ret = self._get_attr("midlDoesNotLikeEmptyInterfaces")
return ret