Введение
Oracle VM VirtualBox представляет собой бесплатное приложение для виртуализации, предназначенное для запуска на различных операционных системах. Виртуализация в данном контексте означает, что программа позволяет устанавливать, запускать и использовать различные операционные системы на одном физическом устройстве.
Так, например, с помощью Oracle VM VirtualBox вы можете запустить Linux и Mac на Windows. Все виртуальные машины изолированы друг от друга, что открывает широкие возможности для применения VirtualBox: знакомство с операционными системами, тестирование ПО, использование ПО, которое по тем или иным причинам не работает в основной операционной системе и многое другое.
В данном пользовательском руководстве приводится процесс установки программного обеспечения Oracle VM VirtualBox, а также рассматривается пример развертывания виртуальной машины с операционной системой Windows 7.
1.1. Термины
Для понимания содержания следующих глав рекомендуется сначала ознакомиться с основными терминами:
Хостовая операционная система (хостовая ОС) – это операционная система физического компьютера, на который был установлен VirtualBox. Существуют версии VirtualBox для хостовых систем Windows, Mac OS X, Linux и Solaris. См.Раздел 1.3.
Все, что описывается в данном руководстве пользователя, в большинстве случаев применимо ко всем операционным системам; отличия, обусловленные использованием той или иной платформы, будут указываться отдельно.
Гостевая операционная система (гостевая ОС) – это операционная система, работающая на виртуальной машине. Теоретически на VirtualBox можно запустить любую операционную систему с архитектурой x86 (DOS, Windows, OS/2, FreeBSD, OpenBSD), однако для того, чтобы добиться показателей производительности, наиболее приближенных к оригинальным, необходимо выбрать оптимальные параметры, присущие определенной ОС. См. Раздел 1.3.
Виртуальная машина (ВМ) – это специальная среда, которую создает VirtualBox для гостевой ОС во время ее работы. Иными словами, вы можете запустить гостевую ОС в ВМ. Как правило, ВМ принимает вид диалогового окна на рабочем столе вашего компьютера, но может также отображаться в полноэкранном режиме или удаленно на другом компьютере в зависимости от того, какой пользовательский интерфейс VirtualBox используется.
ВМ представляет собой набор параметров, которые определяют ее работу и которые можно увидеть в диалоге настроек. В данный набор входят настройки аппаратной части (сколько памяти должно быть у ВМ, какие жесткие диски и через какие файл-контейнеры VirtualBox должен виртуализировать, образы каких CD-дисков должны быть записаны и т.д.), а также информация о состоянии (запущена ли ВМ в настоящий момент, сохранена ли, сделан ли снимок ее состояния и т.д.). Эти настройки дублируются в окне VirtualBox Manager и в интерфейсе VBoxManage для командной строки.
1.2. Требования к аппаратному обеспечению
Запуск и корректная работа Oracle VM Virtual Box возможна на компьютере, удовлетворяющем следующим условиям:
Процессор: любой процессор Intel или AMD, совместимый с архитектурой x86, с функцией поддержки аппаратной виртуализации VT-x/AMD-V или без нее. См. Раздел 3.1.
Свободная оперативная память: минимум 1 Гб RAM, требуемая для запуска и работы соответствующих гостевых ОС. Например, для Windows 7 рекомендуемый объем памяти составляет 1024-2048 Мб.
Место на жестком диске: 200 Мб для установки VirtualBox 20 Гб для установки ВМ.
Данные требования являются приблизительными и зависят от системных требований устанавливаемых гостевых ОС.
1.3. Поддерживаемые хостовые операционные системы
VirtualBox работает на следующих хостовых операционных системах:
- Windows:
- Windows Vista SP1 и более поздние (32-разрядные и 64-разрядные)
- Windows Server 2008 (64-разрядная)
- Windows Server 2008 R2 (64-разрядная)
- Windows 7 (32-разрядная и 64-разрядная)
- Windows 8 (32-разрядная и 64-разрядная)
- Windows 8.1 (32-разрядная и 64-разрядная)
- Windows 10 RTM версия build 10240 (32-разрядная и 64-разрядная)
- Windows Server 2021 (64-разрядная)
- Windows Server 2021 R2 (64-разрядная)
- Mac OS X (64-разрядная):
- 9 (Mavericks)
- 10 (Yosemite)
- 11 (El Capitan)
Требуется аппаратное обеспечение Intel. См. Оригинальное руководство пользователя дляOracleVMVirtualBox, Глава 14 (на англ.яз.).
- Linux(32-разрядная и 64-разрядная). Сюда также относятся:
- Ubuntu, версии с 12.04 по 16.10
- Debian GNU/Linux 7 («Wheezy») и 8 («Jessie»)
- Oracle Enterprise Linux 5, Oracle Linux 6 и 7
- Redhat Enterprise Linux 5, 6 и 7
- Fedora Core / Fedora, версии с 6 по 25
- Gentoo Linux
- openSUSE, версии с 11.4 по 13.2
VirtualBox также можно запустить на большинстве систем, основанных на ядре Linux версии 2.6 или 3.x, воспользовавшись мастером установки VirtualBox или выполнив установку вручную. См. Оригинальное руководство пользователя дляOracleVMVirtualBox, Раздел 2.3 (на англ. яз.).
Обратите внимание, что, начиная с VirtualBox 2.1, хостовые системы, основанные на Linux 2.4 больше не поддерживаются.
- Solaris(64-разрядная) поддерживается с ограничениями, перечисленными в Оригинальном руководство пользователя дляOracleVMVirtualBox, Глава 14 (на англ.яз.).
- Solaris 11
- Solaris 10 (U10 и выше)
Обратите внимание, что приведенный выше перечень является неофициальным. Поддержка Oracle для клиентов с соответствующим контрактом ограничивается перечисленными хостовыми системами. Любой компонент, помеченный как экспериментальный, не поддерживается. Отзывы и предложения по данным компонентам приветствуются.
Chapter 8. vboxmanage
As briefly mentioned in Section 1.17, “Alternative Front-Ends”,
VBoxManage is the command-line interface to
Oracle VM VirtualBox. With it, you can completely control Oracle VM VirtualBox
from the command line of your host operating system.
VBoxManage supports all the features that the
graphical user interface gives you access to, but it supports a
lot more than that. It exposes all the features of the
virtualization engine, even those that cannot be accessed from the
GUI.
You will need to use the command line if you want to do the
following:
There are two main things to keep in mind when using
VBoxManage. First,
VBoxManage must always be used with a specific
subcommand, such as list or
createvm or startvm. All the
subcommands that VBoxManage supports are
described in detail in Chapter 8, VBoxManage.
Second, most of these subcommands require that you specify a
particular virtual machine after the subcommand. There are two
ways you can do this:
You can enter VBoxManage list vms to have all
currently registered VMs listed with all their settings, including
their respective names and UUIDs.
Some typical examples of how to control Oracle VM VirtualBox from the
command line are listed below:
To create a new virtual machine from the command line and
immediately register it with Oracle VM VirtualBox, use
VBoxManage createvm with the
--registeroption, as follows:$ VBoxManage createvm --name "SUSE 10.2" --register VirtualBox Command Line Management Interface Versionversion-number(C) 2005-2021 Oracle Corporation All rights reserved. Virtual machine 'SUSE 10.2' is created. UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5 Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'As can be seen from the above output, a new virtual machine
has been created with a new UUID and a new XML settings file.For more details, see
Section 8.7, “VBoxManage createvm”.To show the configuration of a particular VM, use
VBoxManage showvminfo. See
Section 8.5, “VBoxManage showvminfo” for details
and an example.To change settings while a VM is powered off, use
VBoxManage modifyvm. For example:VBoxManage modifyvm "Windows XP" --memory 512
See also Section 8.8, “VBoxManage modifyvm”.
To change the storage configuration, such as to add a storage
controller and then a virtual disk, use VBoxManage
storagectl and VBoxManage
storageattach. See
Section 8.18, “VBoxManage storagectl” and
Section 8.17, “VBoxManage storageattach”.To control VM operation, use one of the following:
When running VBoxManage without parameters or
when supplying an invalid command line, the following command
syntax list is shown. Note that the output will be slightly
different depending on the host platform. If in doubt, check the
output of VBoxManage for the commands available
on your particular host.
Usage:
VBoxManage [<general option>] <command>
General Options:
[-v|--version] print version number and exit
[-q|--nologo] suppress the logo
[--settingspw <pw>] provide the settings password
[--settingspwfile <file>] provide a file containing the settings password
[@<response-file>] load arguments from the given response file (bourne style)
Commands:
list [--long|-l] [--sorted|-s] vms|runningvms|ostypes|hostdvds|hostfloppies|
intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|
hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|
usbhost|usbfilters|systemproperties|extpacks|
groups|webcams|screenshotformats|cloudproviders|
cloudprofiles|cloudnets
showvminfo <uuid|vmname> [--details]
[--machinereadable]
showvminfo <uuid|vmname> --log <idx>
registervm <filename>
unregistervm <uuid|vmname> [--delete]
createvm --name <name>
[--groups <group>, ...]
[--ostype <ostype>]
[--register]
[--basefolder <path>]
[--uuid <uuid>]
[--default]
modifyvm <uuid|vmname>
[--name <name>]
[--groups <group>, ...]
[--description <desc>]
[--ostype <ostype>]
[--iconfile <filename>]
[--memory <memorysize in MB>]
[--pagefusion on|off]
[--vram <vramsize in MB>]
[--acpi on|off]
[--ioapic on|off]
[--hpet on|off]
[--triplefaultreset on|off]
[--apic on|off]
[--x2apic on|off]
[--paravirtprovider none|default|legacy|minimal|
hyperv|kvm]
[--paravirtdebug <key=value> [,<key=value> ...]]
[--hwvirtex on|off]
[--nestedpaging on|off]
[--largepages on|off]
[--vtxvpid on|off]
[--vtxux on|off]
[--pae on|off]
[--longmode on|off]
[--ibpb-on-vm-exit on|off]
[--ibpb-on-vm-entry on|off]
[--spec-ctrl on|off]
[--l1d-flush-on-sched on|off]
[--l1d-flush-on-vm-entry on|off]
[--mds-clear-on-sched on|off]
[--mds-clear-on-vm-entry on|off]
[--nested-hw-virt on|off]
[--cpu-profile "host|Intel 80[86|286|386]"]
[--cpuid-portability-level <0..3>]
[--cpuid-set <leaf[:subleaf]> <eax> <ebx> <ecx> <edx>]
[--cpuid-remove <leaf[:subleaf]>]
[--cpuidremoveall]
[--hardwareuuid <uuid>]
[--cpus <number>]
[--cpuhotplug on|off]
[--plugcpu <id>]
[--unplugcpu <id>]
[--cpuexecutioncap <1-100>]
[--rtcuseutc on|off]
[--graphicscontroller none|vboxvga|vmsvga|vboxsvga]
[--monitorcount <number>]
[--accelerate3d on|off]
[--accelerate2dvideo on|off]
[--firmware bios|efi|efi32|efi64]
[--chipset ich9|piix3]
[--bioslogofadein on|off]
[--bioslogofadeout on|off]
[--bioslogodisplaytime <msec>]
[--bioslogoimagepath <imagepath>]
[--biosbootmenu disabled|menuonly|messageandmenu]
[--biosapic disabled|apic|x2apic]
[--biossystemtimeoffset <msec>]
[--biospxedebug on|off]
[--system-uuid-le on|off]
[--boot<1-4> none|floppy|dvd|disk|net>]
[--nic<1-N> none|null|nat|bridged|intnet|hostonly|
generic|natnetwork]
[--nictype<1-N> Am79C970A|Am79C973|Am79C960|
82540EM|82543GC|82545EM|
virtio]
[--cableconnected<1-N> on|off]
[--nictrace<1-N> on|off]
[--nictracefile<1-N> <filename>]
[--nicproperty<1-N> name=[value]]
[--nicspeed<1-N> <kbps>]
[--nicbootprio<1-N> <priority>]
[--nicpromisc<1-N> deny|allow-vms|allow-all]
[--nicbandwidthgroup<1-N> none|<name>]
[--bridgeadapter<1-N> none|<devicename>]
[--hostonlyadapter<1-N> none|<devicename>]
[--intnet<1-N> <network name>]
[--nat-network<1-N> <network name>]
[--nicgenericdrv<1-N> <driver>]
[--natnet<1-N> <network>|default]
[--natsettings<1-N> [<mtu>],[<socksnd>],
[<sockrcv>],[<tcpsnd>],
[<tcprcv>]]
[--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],
<hostport>,[<guestip>],<guestport>]
[--natpf<1-N> delete <rulename>]
[--nattftpprefix<1-N> <prefix>]
[--nattftpfile<1-N> <file>]
[--nattftpserver<1-N> <ip>]
[--natbindip<1-N> <ip>]
[--natdnspassdomain<1-N> on|off]
[--natdnsproxy<1-N> on|off]
[--natdnshostresolver<1-N> on|off]
[--nataliasmode<1-N> default|[log],[proxyonly],
[sameports]]
[--macaddress<1-N> auto|<mac>]
[--mouse ps2|usb|usbtablet|usbmultitouch]
[--keyboard ps2|usb]
[--uart<1-N> off|<I/O base> <IRQ>]
[--uartmode<1-N> disconnected|
server <pipe>|
client <pipe>|
tcpserver <port>|
tcpclient <hostname:port>|
file <file>|
<devicename>]
[--uarttype<1-N> 16450|16550A|16750]
[--lpt<1-N> off|<I/O base> <IRQ>]
[--lptmode<1-N> <devicename>]
[--guestmemoryballoon <balloonsize in MB>]
[--vm-process-priority default|flat|low|normal|high]
[--audio none|null|dsound|oss|alsa|pulse|
oss|pulse|coreaudio]
[--audioin on|off]
[--audioout on|off]
[--audiocontroller ac97|hda|sb16]
[--audiocodec stac9700|ad1980|stac9221|sb16]
[--clipboard-mode disabled|hosttoguest|guesttohost|
bidirectional]
[--draganddrop disabled|hosttoguest|guesttohost|
bidirectional]
[--vrde on|off]
[--vrdeextpack default|<name>]
[--vrdeproperty <name=[value]>]
[--vrdeport <hostport>]
[--vrdeaddress <hostip>]
[--vrdeauthtype null|external|guest]
[--vrdeauthlibrary default|<name>]
[--vrdemulticon on|off]
[--vrdereusecon on|off]
[--vrdevideochannel on|off]
[--vrdevideochannelquality <percent>]
[--usbohci on|off]
[--usbehci on|off]
[--usbxhci on|off]
[--usbrename <oldname> <newname>]
[--snapshotfolder default|<path>]
[--teleporter on|off]
[--teleporterport <port>]
[--teleporteraddress <address|empty>]
[--teleporterpassword <password>]
[--teleporterpasswordfile <file>|stdin]
[--tracing-enabled on|off]
[--tracing-config <config-string>]
[--tracing-allow-vm-access on|off]
[--usbcardreader on|off]
[--autostart-enabled on|off]
[--autostart-delay <seconds>]
[--recording on|off]
[--recordingscreens all|<screen ID> [<screen ID> ...]]
[--recordingfile <filename>]
[--recordingvideores <width> <height>]
[--recordingvideorate <rate>]
[--recordingvideofps <fps>]
[--recordingmaxtime <s>]
[--recordingmaxsize <MB>]
[--recordingopts <key=value> [,<key=value> ...]]
[--defaultfrontend default|<name>]
movevm <uuid|vmname>
--type basic
[--folder <path>]
import <ovfname/ovaname>
[--dry-run|-n]
[--options keepallmacs|keepnatmacs|importtovdi]
[--vmname <name>]
[--cloud]
[--cloudprofile <cloud profile name>]
[--cloudinstanceid <instance id>]
[--cloudbucket <bucket name>]
[more options]
(run with -n to have options displayed
for a particular OVF. It doesn't work for the Cloud import.)
export <machines> --output|-o <name>.<ovf/ova/tar.gz>
[--legacy09|--ovf09|--ovf10|--ovf20|--opc10]
[--manifest]
[--iso]
[--options manifest|iso|nomacs|nomacsbutnat]
[--vsys <number of virtual system>]
[--vmname <name>]
[--product <product name>]
[--producturl <product url>]
[--vendor <vendor name>]
[--vendorurl <vendor url>]
[--version <version info>]
[--description <description info>]
[--eula <license text>]
[--eulafile <filename>]
[--cloud <number of virtual system>]
[--vmname <name>]
[--cloudprofile <cloud profile name>]
[--cloudbucket <bucket name>]
[--cloudkeepobject <true/false>]
[--cloudlaunchmode EMULATED|PARAVIRTUALIZED]
[--cloudlaunchinstance <true/false>]
[--clouddomain <domain>]
[--cloudshape <shape>]
[--clouddisksize <disk size in GB>]
[--cloudocivcn <OCI vcn id>]
[--cloudocisubnet <OCI subnet id>]
[--cloudpublicip <true/false>]
[--cloudprivateip <ip>]
startvm <uuid|vmname>...
[--type gui|sdl|headless|separate]
[-E|--putenv <NAME>[=<VALUE>]]
controlvm <uuid|vmname>
pause|resume|reset|poweroff|savestate|
acpipowerbutton|acpisleepbutton|
keyboardputscancode <hex> [<hex> ...]|
keyboardputstring <string1> [<string2> ...]|
keyboardputfile <filename>|
setlinkstate<1-N> on|off |
nic<1-N> null|nat|bridged|intnet|hostonly|generic|
natnetwork [<devicename>] |
nictrace<1-N> on|off |
nictracefile<1-N> <filename> |
nicproperty<1-N> name=[value] |
nicpromisc<1-N> deny|allow-vms|allow-all |
natpf<1-N> [<rulename>],tcp|udp,[<hostip>],
<hostport>,[<guestip>],<guestport> |
natpf<1-N> delete <rulename> |
guestmemoryballoon <balloonsize in MB> |
usbattach <uuid>|<address>
[--capturefile <filename>] |
usbdetach <uuid>|<address> |
audioin on|off |
audioout on|off |
clipboard mode disabled|hosttoguest|guesttohost|
bidirectional |
draganddrop disabled|hosttoguest|guesttohost|
bidirectional |
vrde on|off |
vrdeport <port> |
vrdeproperty <name=[value]> |
vrdevideochannelquality <percent> |
setvideomodehint <xres> <yres> <bpp>
[[<display>] [<enabled:yes|no> |
[<xorigin> <yorigin>]]] |
setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off
screenshotpng <file> [display] |
recording on|off |
recording screens all|none|<screen>,[<screen>...] |
recording filename <file> |
recording videores <width>x<height> |
recording videorate <rate> |
recording videofps <fps> |
recording maxtime <s> |
recording maxfilesize <MB> |
setcredentials <username>
--passwordfile <file> | <password>
<domain>
[--allowlocallogon <yes|no>] |
teleport --host <name> --port <port>
[--maxdowntime <msec>]
[--passwordfile <file> |
--password <password>] |
plugcpu <id> |
unplugcpu <id> |
cpuexecutioncap <1-100>
webcam <attach [path [settings]]> | <detach [path]> | <list>
addencpassword <id>
<password file>|-
[--removeonsuspend <yes|no>]
removeencpassword <id>
removeallencpasswords
changeuartmode<1-N> disconnected|
server <pipe>|
client <pipe>|
tcpserver <port>|
tcpclient <hostname:port>|
file <file>|
<devicename>
vm-process-priority default|flat|low|normal|high
discardstate <uuid|vmname>
adoptstate <uuid|vmname> <state_file>
closemedium [disk|dvd|floppy] <uuid|filename>
[--delete]
storageattach <uuid|vmname>
--storagectl <name>
[--port <number>]
[--device <number>]
[--type dvddrive|hdd|fdd]
[--medium none|emptydrive|additions|
<uuid|filename>|host:<drive>|iscsi]
[--mtype normal|writethrough|immutable|shareable|
readonly|multiattach]
[--comment <text>]
[--setuuid <uuid>]
[--setparentuuid <uuid>]
[--passthrough on|off]
[--tempeject on|off]
[--nonrotational on|off]
[--discard on|off]
[--hotpluggable on|off]
[--bandwidthgroup <name>]
[--forceunmount]
[--server <name>|<ip>]
[--target <target>]
[--tport <port>]
[--lun <lun>]
[--encodedlun <lun>]
[--username <username>]
[--password <password>]
[--passwordfile <file>]
[--initiator <initiator>]
[--intnet]
storagectl <uuid|vmname>
--name <name>
[--add ide|sata|scsi|floppy|sas|usb|pcie|virtio]
[--controller LSILogic|LSILogicSAS|BusLogic|
IntelAHCI|PIIX3|PIIX4|ICH6|I82078|
[ USB|NVMe|VirtIO]
[--portcount <1-n>]
[--hostiocache on|off]
[--bootable on|off]
[--rename <name>]
[--remove]
bandwidthctl <uuid|vmname>
add <name> --type disk|network
--limit <megabytes per second>[k|m|g|K|M|G] |
set <name>
--limit <megabytes per second>[k|m|g|K|M|G] |
remove <name> |
list [--machinereadable]
(limit units: k=kilobit, m=megabit, g=gigabit,
K=kilobyte, M=megabyte, G=gigabyte)
showmediuminfo [disk|dvd|floppy] <uuid|filename>
createmedium [disk|dvd|floppy] --filename <filename>
[--size <megabytes>|--sizebyte <bytes>]
[--diffparent <uuid>|<filename>]
[--format VDI|VMDK|VHD] (default: VDI)]
[--variant Standard,Fixed,Split2G,Stream,ESX,
Formatted]
[[--property <name>=<value>] --property <name>=<value]...
modifymedium [disk|dvd|floppy] <uuid|filename>
[--type normal|writethrough|immutable|shareable|
readonly|multiattach]
[--autoreset on|off]
[--property <name=[value]>]
[--compact]
[--resize <megabytes>|--resizebyte <bytes>]
[--move <path>]
[--setlocation <path>]
[--description <description string>]
clonemedium [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>
[--format VDI|VMDK|VHD|RAW|<other>]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--existing]
mediumproperty [disk|dvd|floppy] set <uuid|filename>
<property> <value>
[disk|dvd|floppy] get <uuid|filename>
<property>
[disk|dvd|floppy] delete <uuid|filename>
<property>
encryptmedium <uuid|filename>
[--newpassword <file>|-]
[--oldpassword <file>|-]
[--cipher <cipher identifier>]
[--newpasswordid <password identifier>]
checkmediumpwd <uuid|filename>
<pwd file>|-
convertfromraw <filename> <outputfile>
[--format VDI|VMDK|VHD]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--uuid <uuid>]
convertfromraw stdin <outputfile> <bytes>
[--format VDI|VMDK|VHD]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--uuid <uuid>]
getextradata global|<uuid|vmname>
<key>|[enumerate]
setextradata global|<uuid|vmname>
<key>
[<value>] (no value deletes key)
setproperty machinefolder default|<folder> |
hwvirtexclusive on|off |
vrdeauthlibrary default|<library> |
websrvauthlibrary default|null|<library> |
vrdeextpack null|<library> |
autostartdbpath null|<folder> |
loghistorycount <value>
defaultfrontend default|<name>
logginglevel <log setting>
proxymode system|noproxy|manual
proxyurl <url>
usbfilter add <index,0-N>
--target <uuid|vmname>|global
--name <string>
--action ignore|hold (global filters only)
[--active yes|no] (yes)
[--vendorid <XXXX>] (null)
[--productid <XXXX>] (null)
[--revision <IIFF>] (null)
[--manufacturer <string>] (null)
[--product <string>] (null)
[--remote yes|no] (null, VM filters only)
[--serialnumber <string>] (null)
[--maskedinterfaces <XXXXXXXX>]
usbfilter modify <index,0-N>
--target <uuid|vmname>|global
[--name <string>]
[--action ignore|hold] (global filters only)
[--active yes|no]
[--vendorid <XXXX>|""]
[--productid <XXXX>|""]
[--revision <IIFF>|""]
[--manufacturer <string>|""]
[--product <string>|""]
[--remote yes|no] (null, VM filters only)
[--serialnumber <string>|""]
[--maskedinterfaces <XXXXXXXX>]
usbfilter remove <index,0-N>
--target <uuid|vmname>|global
guestproperty get <uuid|vmname>
<property> [--verbose]
guestproperty set <uuid|vmname>
<property> [<value> [--flags <flags>]]
guestproperty delete|unset <uuid|vmname>
<property>
guestproperty enumerate <uuid|vmname>
[--patterns <patterns>]
guestproperty wait <uuid|vmname> <patterns>
[--timeout <msec>] [--fail-on-timeout]
guestcontrol <uuid|vmname> [--verbose|-v] [--quiet|-q]
[--username <name>] [--domain <domain>]
[--passwordfile <file> | --password <password>]
run [common-options]
[--exe <path to executable>] [--timeout <msec>]
[-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
[--ignore-operhaned-processes] [--profile]
[--no-wait-stdout|--wait-stdout]
[--no-wait-stderr|--wait-stderr]
[--dos2unix] [--unix2dos]
-- <program/arg0> [argument1] ... [argumentN]]
start [common-options]
[--exe <path to executable>] [--timeout <msec>]
[-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
[--ignore-operhaned-processes] [--profile]
-- <program/arg0> [argument1] ... [argumentN]]
copyfrom [common-options]
[--follow] [-R|--recursive]
<guest-src0> [guest-src1 [...]] <host-dst>
copyfrom [common-options]
[--follow] [-R|--recursive]
[--target-directory <host-dst-dir>]
<guest-src0> [guest-src1 [...]]
copyto [common-options]
[--follow] [-R|--recursive]
<host-src0> [host-src1 [...]] <guest-dst>
copyto [common-options]
[--follow] [-R|--recursive]
[--target-directory <guest-dst>]
<host-src0> [host-src1 [...]]
mkdir|createdir[ectory] [common-options]
[--parents] [--mode <mode>]
<guest directory> [...]
rmdir|removedir[ectory] [common-options]
[-R|--recursive]
<guest directory> [...]
removefile|rm [common-options] [-f|--force]
<guest file> [...]
mv|move|ren[ame] [common-options]
<source> [source1 [...]] <dest>
mktemp|createtemp[orary] [common-options]
[--secure] [--mode <mode>] [--tmpdir <directory>]
<template>
stat [common-options]
<file> [...]
guestcontrol <uuid|vmname> [--verbose|-v] [--quiet|-q]
list <all|sessions|processes|files> [common-opts]
closeprocess [common-options]
< --session-id <ID>
| --session-name <name or pattern>
<PID1> [PID1 [...]]
closesession [common-options]
< --all | --session-id <ID>
| --session-name <name or pattern> >
updatega|updateguestadditions|updateadditions
[--source <guest additions .ISO>]
[--wait-start] [common-options]
[-- [<argument1>] ... [<argumentN>]]
watch [common-options]
metrics list [*|host|<vmname> [<metric_list>]]
(comma-separated)
metrics setup
[--period <seconds>] (default: 1)
[--samples <count>] (default: 1)
[--list]
[*|host|<vmname> [<metric_list>]]
metrics query [*|host|<vmname> [<metric_list>]]
metrics enable
[--list]
[*|host|<vmname> [<metric_list>]]
metrics disable
[--list]
[*|host|<vmname> [<metric_list>]]
metrics collect
[--period <seconds>] (default: 1)
[--samples <count>] (default: 1)
[--list]
[--detach]
[*|host|<vmname> [<metric_list>]]
natnetwork add --netname <name>
--network <network>
[--enable|--disable]
[--dhcp on|off]
[--port-forward-4 <rule>]
[--loopback-4 <rule>]
[--ipv6 on|off]
[--port-forward-6 <rule>]
[--loopback-6 <rule>]
natnetwork remove --netname <name>
natnetwork modify --netname <name>
[--network <network>]
[--enable|--disable]
[--dhcp on|off]
[--port-forward-4 <rule>]
[--loopback-4 <rule>]
[--ipv6 on|off]
[--port-forward-6 <rule>]
[--loopback-6 <rule>]
natnetwork start --netname <name>
natnetwork stop --netname <name>
natnetwork list [<pattern>]
hostonlyif ipconfig <name>
[--dhcp |
--ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |
--ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]
create |
remove <name>
usbdevsource add <source name>
--backend <backend>
--address <address>
usbdevsource remove <source name> Each time VBoxManage is invoked, only one
command can be executed. However, a command might support several
subcommands which then can be invoked in one single call. The
following sections provide detailed reference information on the
different commands.
The list command gives relevant information
about your system and information about Oracle VM VirtualBox’s current
settings.
The following subcommands are available with VBoxManage
list:
vms: Lists all virtual machines currently
registered with Oracle VM VirtualBox. By default this displays a
compact list with each VM’s name and UUID. If you also specify
--longor-l, this will be a
detailed list as with the showvminfo
command, see Section 8.5, “VBoxManage showvminfo”.runningvms: Lists all currently running
virtual machines by their unique identifiers (UUIDs) in the
same format as with vms.ostypes: Lists all guest operating systems
presently known to Oracle VM VirtualBox, along with the identifiers
used to refer to them with the modifyvm
command.hostdvds, hostfloppies:
Lists the DVD, floppy, bridged networking, and host-only
networking interfaces on the host, along with the name used to
access them from within Oracle VM VirtualBox.intnets: Displays information about the
internal networks.bridgedifs, hostonlyifs,
natnets, dhcpservers:
Lists the bridged network interfaces, host-only network
interfaces, NAT network interfaces, and DHCP servers currently
available on the host. See
Chapter 6, Virtual Networking.hostinfo: Displays information about the
host system, such as CPUs, memory size, and operating system
version.hostcpuids: Lists the CPUID parameters for
the host CPUs. This can be used for a more fine grained
analyis of the host’s virtualization capabilities.hddbackends: Lists all known virtual disk
back-ends of Oracle VM VirtualBox. For each such format, such as
VDI, VMDK, or RAW, this subcommand lists the back-end’s
capabilities and configuration.hdds, dvds,
floppies: Shows information about virtual
disk images currently in use by Oracle VM VirtualBox, including all
their settings, the unique identifiers (UUIDs) associated with
them by Oracle VM VirtualBox and all files associated with them.
This is the command-line equivalent of the Virtual Media
Manager. See Section 5.3, “The Virtual Media Manager”.usbhost: Shows information about USB
devices attached to the host, including information useful for
constructing USB filters and whether they are currently in use
by the host.usbfilters: Lists all global USB filters
registered with Oracle VM VirtualBox and displays the filter
parameters. Global USB filters are for devices which are
accessible to all virtual machines.systemproperties: Displays some global
Oracle VM VirtualBox settings, such as minimum and maximum guest RAM
and virtual hard disk size, folder settings and the current
authentication library in use.extpacks: Displays all Oracle VM VirtualBox
extension packs that are currently installed. See
Section 1.5, “Installing Oracle VM VirtualBox and Extension Packs” and
Section 8.41, “VBoxManage extpack”.groups: Displays details of the VM Groups.
See Section 1.9, “Using VM Groups”.webcams: Displays a list of webcams
attached to the running VM. The output format is a list of
absolute paths or aliases that were used for attaching the
webcams to the VM using the webcam attach command.screenshotformats: Displays a list of
available screenshot formats.cloudproviders: Displays a list of cloud
providers that are supported by Oracle VM VirtualBox. Oracle Cloud Infrastructure is an
example of a cloud provider.cloudprofiles: Displays a list of cloud
profiles that have been configured.Cloud profiles are used when exporting VMs to a cloud service.
See Section 1.15.7, “Exporting an Appliance to Oracle Cloud Infrastructure”.
This command changes the properties of a registered virtual
machine which is not running. Most of the properties that this
command makes available correspond to the VM settings that the
VirtualBox Manager displays in each VM’s
Settings dialog. These are
described in Chapter 3, Configuring Virtual Machines. However, some of
the more advanced settings are only available through the
VBoxManage interface.
These commands require that the machine is powered off, neither
running nor in a Saved state. Some machine settings can also be
changed while a machine is running. Those settings will then have
a corresponding subcommand with the VBoxManage
controlvm subcommand. See
Section 8.13, “VBoxManage controlvm”.
The following general settings are available through
VBoxManage modifyvm:
--name <name>:
Changes the VM’s name and can be used to rename the internal
virtual machine files, as described in
Section 8.7, “VBoxManage createvm”.--groups <group>,: Changes the group membership of a VM.
...
Groups always start with a
/and can be nested. By
default VMs are in group/.--description <desc>:
Changes the VM’s description, which is a way to record
details about the VM in a way which is meaningful for the
user. The GUI interprets HTML formatting, the command line
allows arbitrary strings potentially containing multiple
lines.--ostype <ostype>:
Specifies what guest operating system is supposed to run in
the VM. To learn about the various identifiers that can be
used here, use VBoxManage list ostypes.--iconfile: Specifies the absolute
<filename>
path on the host file system for the Oracle VM VirtualBox icon to
be displayed in the VM.--memory: Sets the amount of RAM,
<memorysize>
in MB, that the virtual machine should allocate for itself
from the host. See Section 1.7, “Creating Your First Virtual Machine”.--pagefusion on|off:
Enables and disables the Page Fusion feature. Page Fusion is
disabled by default. The Page Fusion feature minimises
memory duplication between VMs with similar configurations
running on the same host. See
Section 4.10.2, “Page Fusion”.--vram <vramsize>:
Sets the amount of RAM that the virtual graphics card should
have. See Section 3.6, “Display Settings”.--acpi on|offand
--ioapic on|off: Determines
whether the VM has ACPI and I/O APIC support. See
Section 3.5.1, “Motherboard Tab”.--pciattach <host PCI address [@ guest: Attaches a specified
PCI bus address]>
PCI network controller on the host to a specified PCI bus on
the guest.--pcidetach <host PCI: Detaches a specified PCI
address>
network controller on the host from the attached PCI bus on
the guest.--hardwareuuid: The UUID presented to the
<uuid>
guest through memory tables (DMI/SMBIOS), hardware, and
guest properties. By default this is the same as the VM
UUID. This setting is useful when cloning a VM. Teleporting
takes care of this automatically.--cpus <cpucount>:
Sets the number of virtual CPUs for the virtual machine, see
Section 3.5.2, “Processor Tab”. If CPU hot-plugging
is enabled, this then sets the maximum
number of virtual CPUs that can be plugged into the virtual
machines.--cpuhotplug on|off:
Enables CPU hot-plugging. When enabled, virtual CPUs can be
added to and removed from a virtual machine while it is
running. See Section 9.4, “CPU Hot-Plugging”.--plugcpu|unplugcpu: If CPU hot-plugging is enabled,
<id>
this setting adds or removes a virtual CPU on the virtual
machine.<id>
specifies the index of the virtual CPU to be added or
removed and must be a number from 0 to the maximum number of
CPUs configured with the
--cpusoption. CPU 0 can
never be removed.--cpuexecutioncap: Controls how much CPU time a
<1-100>
virtual CPU can use. A value of 50 implies a single virtual
CPU can use up to 50% of a single host CPU.--pae on|off: Enables and
disables PAE. See Section 3.5.2, “Processor Tab”.--longmode on|off: Enables
and disables long mode. See
Section 3.5.2, “Processor Tab”.--spec-ctrl on|off: Enables
and disables the exposure of speculation control interfaces
to the guest, provided they are available on the host.
Depending on the host CPU and workload, enabling speculation
control may significantly reduce performance.--cpu-profile <host|intel: Enables specification
80[86|286|386]>
of a profile for guest CPU emulation. Specify either one
based on the host system CPU (host), or one from a number of
older Intel Micro-architectures: 8086, 80286, 80386.--hpet on|off: Enables and
disables a High Precision Event Timer (HPET) which can
replace the legacy system timers. This is turned off by
default. Note that Windows supports a HPET only from Vista
onwards.--hwvirtex on|off: Enables
and disables the use of hardware virtualization extensions,
such as Intel VT-x or AMD-V, in the processor of your host
system. See Section 10.3, “Hardware Virtualization”.--triplefaultreset on|off:
Enables resetting of the guest instead of triggering a Guru
Meditation. Some guests raise a triple fault to reset the
CPU so sometimes this is desired behavior. Works only for
non-SMP guests.--apic on|off: Enables and
disables I/O APIC. With I/O APIC, operating systems can use
more than 16 interrupt requests (IRQs) thus avoiding IRQ
sharing for improved reliability. This setting is enabled by
default. See Section 3.5.1, “Motherboard Tab”.--x2apic on|off: Enables
and disables CPU x2APIC support. CPU x2APIC support helps
operating systems run more efficiently on high core count
configurations, and optimizes interrupt distribution in
virtualized environments. This setting is enabled by
default. Disable this setting when using host or guest
operating systems that are incompatible with x2APIC support.--paravirtprovider:
none|default|legacy|minimal|hyperv|kvm
Specifies which paravirtualization interface to provide to
the guest operating system. Specifying
noneexplicitly turns off
exposing any paravirtualization interface. The option
defaultselects an
appropriate interface when starting the VM, depending on the
guest OS type. This is the default option chosen when
creating new VMs. The
legacyoption is used for
VMs which were created with older Oracle VM VirtualBox versions
and will pick a paravirtualization interface when starting
the VM with Oracle VM VirtualBox 5.0 and newer. The
minimalprovider is
mandatory for Mac OS X guests.
kvmand
hypervare recommended for
Linux and Windows guests respectively. These options are
explained in Section 10.5, “Paravirtualization Providers”.--paravirtdebug <keyword=value>: Specifies
[,<keyword=value> ...]
debugging options specific to the paravirtualization
provider configured for this VM. See the provider specific
options in Section 9.29, “Paravirtualized Debugging” for a list of
supported keyword-value pairs for each provider.--nestedpaging on|off: If
hardware virtualization is enabled, this additional setting
enables or disables the use of the nested paging feature in
the processor of your host system. See
Section 10.3, “Hardware Virtualization” and
Section 13.4.1, “CVE-2021-3646”.--largepages on|off: If
hardware virtualization and nested
paging are enabled, for Intel VT-x only, an additional
performance improvement of up to 5% can be obtained by
enabling this setting. This causes the hypervisor to use
large pages to reduce TLB use and overhead.--vtxvpid on|off: If
hardware virtualization is enabled, for Intel VT-x only,
this additional setting enables or disables the use of the
tagged TLB (VPID) feature in the processor of your host
system. See Section 10.3, “Hardware Virtualization”.--vtxux on|off: If hardware
virtualization is enabled, for Intel VT-x only, this setting
enables or disables the use of the unrestricted guest mode
feature for executing your guest.--nested-hw-virt on|off: If
hardware virtualization is enabled, this setting enables or
disables passthrough of hardware virtualization features to
the guest. See Section 9.33, “Nested Virtualization”.--accelerate3d on|off: If
the Guest Additions are installed, this setting enables or
disables hardware 3D acceleration. See
Section 4.5.1, “Hardware 3D Acceleration (OpenGL and Direct3D 8/9)”.--accelerate2dvideo on|off:
If the Guest Additions are installed, this setting enables
or disables 2D video acceleration. See
Section 4.5.2, “Hardware 2D Video Acceleration for Windows Guests”.--chipset piix3|ich9: By
default, Oracle VM VirtualBox emulates an Intel PIIX3 chipset.
Usually there is no reason to change the default setting
unless this is required to relax some of its constraints.
See Section 3.5.1, “Motherboard Tab”.You can influence the BIOS logo that is displayed when a
virtual machine starts up with a number of settings. By
default, an Oracle VM VirtualBox logo is displayed.With
--bioslogofadeinand
on|off
--bioslogofadeout on|off,
you can determine whether the logo should fade in and out,
respectively.With
--bioslogodisplaytimeyou can set how long the logo
<msec>
should be visible, in milliseconds.With
--bioslogoimagepathyou can replace the image
<imagepath>
that is shown with your own logo. The image must be an
uncompressed 256 color BMP file without color space
information (Windows 3.0 format). The image must not be
bigger than 640 x 480.--biosbootmenu: Specifies
disabled|menuonly|messageandmenu
whether the BIOS enables the user to select a temporary boot
device. Themenuonlyoption
suppresses the message, but the user can still press F12 to
select a temporary boot device.--biosapic: Specifies the
x2apic|apic|disabled
firmware APIC level to be used. Options are: x2apic, apic or
disabled (no apic or x2apic) respectively.Note that if x2apic is specified and x2APIC is unsupported
by the VCPU, biosapic downgrades to apic, if supported.
Otherwise biosapic downgrades to disabled. Similarly, if
apic is specified, and APIC is unsupported, a downgrade to
disabled results.--biossystemtimeoffset: Specifies a fixed time offset,
<ms>
in milliseconds, of the guest relative to the host time. If
the offset is positive, the guest time runs ahead of the
host time.--biospxedebug on|off:
Enables or disables additional debugging output when using
the Intel PXE boot ROM. The output is written to the release
log file. See Section 12.1.2, “Collecting Debugging Information”.--system-uuid-le on|off:
Enables or disables representing the system UUID in little
endian form. The default value isonfor
new VMs. For old VMs the setting isoff
to keep the content of the DMI/SMBIOS table unchanged, which
can be important for Windows license activation.--boot<1-4>: Specifies the
none|floppy|dvd|disk|net
boot order for the virtual machine. There are four
slots, which the VM will try to access
from 1 to 4, and for each of which you can set a device that
the VM should attempt to boot from.--rtcuseutc on|off: Sets
the real-time clock (RTC) to operate in UTC time. See
Section 3.5.1, “Motherboard Tab”.--graphicscontroller: Specifies the
none|vboxvga|vmsvga|vboxsvga
use of a graphics controller, with an option to choose a
specific type. See Section 3.6.1, “Screen Tab”.--snapshotfolder: Specifies the folder
default|<path>
where snapshots are kept for a virtual machine.--firmware: Specifies the
bios|efi|efi32|efi64
firmware to be used to boot the VM: Available options are:
BIOS, or one of the EFI options: efi, efi32, or efi64. Use
EFI options with care.--guestmemoryballoonSets the default size of the
<size>
guest memory balloon. This is the memory allocated by the
Oracle VM VirtualBox Guest Additions from the guest operating
system and returned to the hypervisor for reuse by other
virtual machines.
<size>must be
specified in megabytes. The default size is 0 megabytes. See
Section 4.10.1, “Memory Ballooning”.--defaultfrontend: Specifies the default
default|<name>
frontend to be used when starting this VM. See
Section 8.12, “VBoxManage startvm”.--vm-process-priority: Specifies the
default|flat|low|normal|high
priority scheme of the VM process to be used when starting
this VM and during VM execution. See
Section 8.12, “VBoxManage startvm”.
The following networking settings are available through
VBoxManage modifyvm. With all these settings,
the decimal number directly following the option name, 1-N in
the list below, specifies the virtual network adapter whose
settings should be changed.
--nic<1-N>:
none|null|nat|natnetwork|bridged|intnet|hostonly|generic
Configures the type of networking for each of the VM’s
virtual network cards. Options are: not present
(none), not connected to
the host (null), use
network address translation
(nat), use the new network
address translation engine
(natnetwork), bridged
networking (bridged), or
use internal networking
(intnet), host-only
networking (hostonly), or
access rarely used sub-modes
(generic). These options
correspond to the modes described in
Section 6.2, “Introduction to Networking Modes”.--nictype<1-N>:
Am79C970A|Am79C973|Am79C970|82540EM|82543GC|82545EM|virtio
Enables you to specify the networking hardware that
Oracle VM VirtualBox presents to the guest for a specified VM
virtual network card. See Section 6.1, “Virtual Networking Hardware”.--cableconnected<1-N>: Enables you to temporarily
on|off
disconnect a virtual network interface, as if a network
cable had been pulled from a real network card. This might
be useful, for example for resetting certain software
components in the VM.With the
nictraceoptions,
you can optionally trace network traffic by dumping it to a
file, for debugging purposes.With
--nictrace<1-N>, you can enable network tracing for
on|off
a particular virtual network card.If enabled, you must specify with
--nictracefile<1-N>the absolute path of the
<filename>
file the trace should be logged to.--nicproperty<1-N>: This
<paramname>="paramvalue"
option, in combination with
nicgenericdrvenables you
to pass parameters to rarely-used network backends.These parameters are backend engine-specific, and are
different between UDP Tunnel and the VDE backend drivers.
For examples, see Section 6.8, “UDP Tunnel Networking”.--nicspeed<1-N>: Only has an effect if generic
<kbps>
networking has been enabled for a particular virtual network
card. See the--nicoption.
This mode enables access to rarely used networking
sub-modes, such as VDE network or UDP Tunnel. This option
specifies the throughput rate in KBps.--nicbootprio<1-N>: Specifies the order in
<priority>
which NICs are tried for booting over the network, using
PXE. The priority is an integer in the 0 to 4 range.
Priority 1 is the highest, priority 4 is low. Priority 0,
which is the default unless otherwise specified, is the
lowest.Note that this option only has an effect when the Intel PXE
boot ROM is used.--nicpromisc<1-N>: Enables you to
deny|allow-vms|allow-all
specify how promiscuous mode is handled for the specified VM
virtual network card. This setting is only relevant for
bridged networking.deny,
the default setting, hides any traffic not intended for the
VM.allow-vmshides all
host traffic from the VM, but allows the VM to see traffic
to and from other VMs.
allow-allremoves this
restriction completely.--nicbandwidthgroup<1-N>: Adds and removes an
none|<name>
assignment of a bandwidth group for the specified virtual
network interface. Specifying
noneremoves any current
bandwidth group assignment from the specified virtual
network interface. Specifying
<name>adds an
assignment of a bandwidth group to the specified virtual
network interface.See Section 6.10, “Limiting Bandwidth for Network Input/Output”.
--bridgeadapter<1-N>: Only has an effect
none|<devicename>
if bridged networking has been enabled for a virtual network
card. See the--nicoption.
Use this option to specify which host interface the given
virtual network interface will use. See
Section 6.5, “Bridged Networking”.--hostonlyadapter<1-N>: Only has an effect
none|<devicename>
if host-only networking has been enabled for a virtual
network card. See the--nic
option. Use this option to specify which host-only
networking interface the given virtual network interface
will use. See Section 6.7, “Host-Only Networking”.--intnet<1-N>: Only has an effect if internal
network
networking has been enabled for a virtual network card. See
the--nicoption. Use this
option to specify the name of the internal network. See
Section 6.6, “Internal Networking”.--nat-network<1-N> <network: If the networking type is set to
name>
natnetwork, not
nat, then this setting
specifies the name of the NAT network this adapter is
connected to. Optional.--nicgenericdrv<1-N> <backend: Only has an effect if generic
driver>
networking has been enabled for a virtual network card. See
the--nicoption. This mode
enables you to access rarely used networking sub-modes, such
as VDE network or UDP Tunnel.--macaddress<1-N>: With this option you can
auto|<mac>
set the MAC address of a particular network adapter on the
VM. Normally, each network adapter is assigned a random
address by Oracle VM VirtualBox at VM creation.
The following NAT networking settings are available through
VBoxManage modifyvm. With all these
settings, the decimal number directly following the option
name, 1-N in the list below, specifies the virtual network
adapter whose settings should be changed.
--natnet<1-N>: If the
<network>|default
networking type is set to
nat, not
natnetwork, then this
setting specifies the IP address range to be used for this
network. See Section 9.8, “Fine Tuning the Oracle VM VirtualBox NAT Engine”.--natpf<1-N>: Defines a NAT
[<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>],
<guestport>
port-forwarding rule. See Section 6.3.1, “Configuring Port Forwarding with NAT”.--natpf<1-N> delete: Deletes a NAT
<name>
port-forwarding rule. See Section 6.3.1, “Configuring Port Forwarding with NAT”.--nattftpprefix<1-N>: Defines a prefix for the
<prefix>
built-in TFTP server. For example, where the boot file is
located. See Section 6.3.2, “PXE Booting with NAT” and
Section 9.8.2, “Configuring the Boot Server (Next Server) of a NAT Network Interface”.--nattftpfile<1-N>: Defines the TFT boot
<bootfile>
file. See Section 9.8.2, “Configuring the Boot Server (Next Server) of a NAT Network Interface”.--nattftpserver<1-N>: Defines the TFTP
<tftpserver>
server address to boot from. See
Section 9.8.2, “Configuring the Boot Server (Next Server) of a NAT Network Interface”.--nattbindip<1-N>: Oracle VM VirtualBox’s NAT engine
<ip;>
normally routes TCP/IP packets through the default
interface assigned by the host’s TCP/IP stack. Use this
setting to instruct the NAT engine to bind to a specified
IP address instead. See
Section 9.8.3, “Tuning TCP/IP Buffers for NAT”.--natdnspassdomain<1-N>: Specifies whether the built-in
on|off
DHCP server passes the domain name for network name
resolution.--natdnsproxy<1-N>: Makes the NAT engine proxy all
on|off
guest DNS requests to the host’s DNS servers. See
Section 9.8.5, “Enabling DNS Proxy in NAT Mode”.--natdnshostresolver<1-N>: Makes the NAT engine use the
on|off
host’s resolver mechanisms to handle DNS requests. See
Section 9.8.5, “Enabling DNS Proxy in NAT Mode”.--natsettings<1-N>: Controls several NAT
[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
[<tcprcv>]
settings. See Section 9.8.3, “Tuning TCP/IP Buffers for NAT”.--nataliasmode<1-N>:
default|[log],[proxyonly],[sameports]
Defines behaviour of the NAT engine core: log – enables
logging, proxyonly – switches off aliasing mode and makes
NAT transparent, sameports – enforces the NAT engine to
send packets through the same port as they originated on,
default – disable all aliasing modes. See
Section 9.8.7, “Configuring Aliasing of the NAT Engine”.
The following hardware settings, such as serial port, audio,
clipboard, drag and drop, monitor, and USB settings are
available through VBoxManage modifyvm:
--mouse:
<ps2|usb|usbtablet|usbmultitouch>
Specifies the mode of the mouse to be used in the VM.
Available options are: ps2, usb, usbtablet, usbmultitouch.--keyboard <ps2|usb>:
Specifies the mode of the keyboard to be used in the VM.
Available options are: ps2, usb.--uart<1-N> off|<I/O base>: Configures virtual serial
<IRQ>
ports for the VM. See Section 3.10, “Serial Ports”.--uartmode<1-N>: Controls how Oracle VM VirtualBox
<arg>
connects a given virtual serial port, configured with the
--uartXsetting, to the
host on which the virtual machine is running. As described
in Section 3.10, “Serial Ports”, for each such port, you
can specify<arg>as
one of the following options:disconnected: Even
though the serial port is shown to the guest, it has no
“other end”. This is like a real COM port without a
cable.server: On a Windows host,
<pipename>
this tells Oracle VM VirtualBox to create a named pipe on the
host named
<pipename>and
connect the virtual serial device to it. Note that
Windows requires that the name of a named pipe begins
with\.pipe.On a Linux host, instead of a named pipe, a local domain
socket is used.client: Operates as for
<pipename>
server, except that the
pipe, or local domain socket, is not created by
Oracle VM VirtualBox but is assumed to exist already.tcpserver <port>:
Configures Oracle VM VirtualBox to create a TCP socket on the
host with TCP
<port>and
connect the virtual serial device to it. Note that
UNIX-like systems require ports over 1024 for normal
users.tcpclient: Operates as for
<hostname:port>
tcpserver, except that
the TCP socket is not created by Oracle VM VirtualBox, but is
assumed to exist already.file <file>:
Redirects the serial port output to a raw file
<file> specified by its absolute path on the host
file system.<devicename>: If,
instead of the above options, the device name of a
physical hardware serial port of the host is specified,
the virtual serial port is connected to that hardware
port. On a Windows host, the device name will be a COM
port such asCOM1. On a
Linux host, the device name will be
/dev/ttyS0or similar. This enables
you to wire up a real serial port to a virtual machine.
uarttype <1-N>: Configures the UART
16450|16550A|16750
type for a virtual serial port. The default UART type is
16550A.--lptmode<1-N>: Specifies the Device Name
<Device>
of the parallel port that the Parallel Port feature will be
using. Use this before--lpt. This feature depends
on the host operating system. For Windows hosts, use a
device name such as lpt1. On Linux hosts, use a device name
such as /dev/lp0.--lpt<1-N> <I/O base>: Specifies the I/O address of
<IRQ>
the parallel port and the IRQ number that the Parallel Port
feature will be using. Optional. Use this
after--lptmod. I/O base address
and IRQ are the values that guest sees. For example, the
values avalable under guest Device Manager.--audio:
none|null|dsound|oss|alsa|pulse|coreaudio
Specifies whether the VM should have audio support, and if
so, which type. The list of supported audio types depends on
the host and can be determined with VBoxManage
modifyvm.--audiocontroller: Specifies the audio
ac97|hda|sb16
controller to be used with the VM.--audiocodec: Specifies
stac9700|ad1980|stac9221|sb16
the audio codec to be used with the VM.--audioin on: Specifies
whether capturing audio from the host is enabled or
disabled.--audioout on: Specifies
whether audio playback from the guest is enabled or
disabled.--clipboard-mode:
disabled|hosttoguest|guesttohost|bidirectional
Configues how the guest or host operating system’s clipboard
should be shared with the host or guest. See
Section 3.4, “General Settings”. This setting requires
that the Guest Additions be installed in the virtual
machine.--clipboard-file-transfers: Specifies if clipboard
enabled|disabled
file transfers are allowed between host and guest OSes or
not.--draganddrop:
disabled|hosttoguest|guesttohost|bidirectional
Specifies the drag and drop mode to use between the host and
the virtual machine. See Section 4.4, “Drag and Drop”.
This requires that the Guest Additions be installed in the
virtual machine.--monitorcount: Enables multi-monitor
<count>
support. See Section 3.6, “Display Settings”.--usb on|off: Enables and
disables the VM’s virtual USB controller. See
Section 3.11.1, “USB Settings”.--usbehci on|off: Enables
and disables the VM’s virtual USB 2.0 controller. See
Section 3.11.1, “USB Settings”.--usbxhci on|off: Enables
and disables the VM’s virtual USB 3.0 controller. See
Section 3.11.1, “USB Settings”.--usbrename <oldname>: Enables renaming of the
<newname>
VM’s virtual USB controller from <oldname> to
<newname>.
The following settings that affect remote machine behavior are
available through VBoxManage modifyvm:
--vrde on|off: Enables and
disables the VirtualBox Remote Desktop Extension (VRDE)
server.--vrdeproperty: Sets the
"TCP/Ports|Address=<value>"
port numbers and IP address on the VM that the VRDE server
can bind to.--vrdeproperty:
"VideoChannel/Enabled|Quality|DownscaleProtection=<value>"
Sets the VRDP video redirection properties.For VideoChannel/Enabled, <value> can be set to
“1”, switching the VRDP video channel on. See
Section 7.1.9, “VRDP Video Redirection”.For VideoChannel/Quality, <value> should be set
between 10 and 100% inclusive, representing a JPEG
compression level on the VRDE server video channel.
Lower values mean lower quality but higher compression.
See Section 7.1.9, “VRDP Video Redirection”.For VideoChannel/DownscaleProtection, <value> can
be set to “1” to enable the videochannel downscale
protection feature. When enabled, if a video’s size
equals the shadow buffer size, then it is regarded as a
full screen video, and is displayed. But if its size is
between fullscreen and the downscale threshold then it
is not displayed, as it could be an
application window, which would be unreadable when
downscaled. When the downscale protection feature is
disabled, an attempt is always made to display videos.
--vrdeproperty:
"Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"
Disables one of the VRDE server features: Display, Input,
Audio or USB respectively. To reenable a feature, use
“Client/DisableDisplay=” for example. See
Section 7.1.10, “VRDP Customization”.--vrdeproperty:
"Client/DisableClipboard|DisableUpstreamAudio=1"
Disables one of the VRDE server features: Clipboard or
UpstreamAudio respectively. To reenable a feature, use
“Client/DisableClipboard=” for example. See
Section 7.1.10, “VRDP Customization”.--vrdeproperty: Disables the VRDE
"Client/DisableRDPDR=1"
server feature: RDP device redirection for smart cards. To
reenable this feature, use “Client/DisableRDPR=”.--vrdeproperty: Enables the VRDE
"H3DRedirect/Enabled=1"
server feature: 3D redirection. To disable this feature, use
“H3DRedirect/Enabled=”.--vrdeproperty:
"Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"
Sets the desired security method and path of server
certificate, path of server private key, path of CA
certificate, that are used for a connection.--vrdeproperty
"Audio/RateCorrectionMode|LogPath=<value>"
sets the audio connection mode, or path of the audio
logfile.--vrdeextpack: Specifies the library
default|<name>
to use for accessing the VM remotely. The default is to use
the RDP code which is part of the Oracle VM VirtualBox Extension
Pack.--vrdeport: A port or a range of
default|<ports>
ports the VRDE server can bind to.
defaultor
0means port 3389, the
standard port for RDP. You can specify a comma-separated
list of ports or ranges of ports. Use a dash between two
port numbers to specify a range. The VRDE server will bind
to one of the available ports from the
specified list. Only one machine can use a given port at a
time. For example, the option--vrdeportwill tell the server to bind
5000,5010-5012
to one of following ports: 5000, 5010, 5011, or 5012.--vrdeaddress <IP: The IP address of the host
address>
network interface the VRDE server will bind to. If
specified, the server will accept connections only on the
specified host network interface.The setting can be used to specify whether the VRDP server
should accept either IPv4, IPv6, or both connections:--vrdeauthtype: Enables you to
null|external|guest
indicate use of authorization, and specify how authorization
will be performed. See Section 7.1.5, “RDP Authentication”.--vrdeauthlibrary: Specifies the library
default|<name>
used for RDP authentication. See
Section 7.1.5, “RDP Authentication”.--vrdemulticon on|off:
Enables multiple connections to be made to the same VRDE
server, if the server supports this feature. See
Section 7.1.7, “Multiple Connections to the VRDP Server”.--vrdereusecon on|off: This
specifies the VRDE server behavior when multiple connections
are disabled. When this option is enabled, the server will
allow a new client to connect and will drop the existing
connection. When this option is disabled, the default
setting, a new connection will not be accepted if there is
already a client connected to the server.--vrdevideochannel on|off:
Enables video redirection, if it is supported by the VRDE
server. See Section 7.1.9, “VRDP Video Redirection”.--vrdevideochannelquality: Specifies the image
<percent>
quality for video redirection. See
Section 7.1.9, “VRDP Video Redirection”.
This command imports one or more virtual machines into
Oracle VM VirtualBox. You can import from either of the following:
A virtual appliance in OVF format.
A cloud service, such as Oracle Cloud Infrastructure. Only a single cloud instance
can be imported.
See Section 1.14, “Importing and Exporting Virtual Machines” for more details on importing VMs into
Oracle VM VirtualBox.
The import subcommand takes at least the path
name of an OVF file as input and expects the disk images, if
needed, to be in the same directory as the OVF file. Many
additional command-line options are supported. These enable you
to control in detail what is being imported and to modify the
import parameters, depending on the content of the OVF file.
It is therefore recommended to first run the
import subcommand with the
--dry-run or
-n option. This will then print
a description of the appliance’s contents to the screen how it
would be imported into Oracle VM VirtualBox, together with the
optional command-line options to influence the import behavior.
Use of the --options option
keepallmacs|keepnatmacs|keepdisknames
enables additional fine tuning of the import operation. The
first two options enable you to specify how the MAC addresses of
every virtual network card should be handled. They can either be
reinitialized, which is the default setting, left unchanged
(keepallmacs) or left unchanged
when the network type is NAT
(keepnatmacs). If you add
keepdisknames all new disk
images are assigned the same names as the originals, otherwise
they are renamed.
As an example, the following is a screen output for a sample
appliance containing a Windows XP guest:
VBoxManage import WindowsXp.ovf --dry-run
Interpreting WindowsXp.ovf...
OK.
Virtual system 0:
0: Suggested OS type: "WindowsXP"
(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1: Suggested VM name "Windows XP Professional_1"
(change with "--vsys 0 --vmname <name>")
2: Suggested VM group "/"
(change with "--vsys 0 --group <group>")
3: Suggested VM settings file name "/home/klaus/VirtualBox VMs/dummy2 2/dummy2 2.vbox"
(change with "--vsys 0 --settingsfile <filename>")
4: Suggested VM base folder "/home/klaus/VirtualBox VMs"
(change with "--vsys 0 --basefolder <path>")
5: End-user license agreement
(display with "--vsys 0 --eula show";
accept with "--vsys 0 --eula accept")
6: Number of CPUs: 1
(change with "--vsys 0 --cpus <n>")
7: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
8: Sound card (appliance expects "ensoniq1371", can change on import)
(disable with "--vsys 0 --unit 5 --ignore")
9: USB controller
(disable with "--vsys 0 --unit 6 --ignore")
10: Network adapter: orig bridged, config 2, extra type=bridged
11: Floppy
(disable with "--vsys 0 --unit 8 --ignore")
12: SCSI controller, type BusLogic
(change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}";
disable with "--vsys 0 --unit 9 --ignore")
13: IDE controller, type PIIX4
(disable with "--vsys 0 --unit 10 --ignore")
14: Hard disk image: source image=WindowsXp.vmdk,
target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
(change controller with "--vsys 0 --unit 11 --controller <id>";
disable with "--vsys 0 --unit 11 --ignore") The individual configuration items are numbered, and depending
on their type support different command-line options. The import
subcommand can be directed to ignore many such items with a
--vsys X --unit Y --ignore
option, where X is the number of the virtual system and Y the
item number, as printed on the screen. X is zero, unless there
are several virtual system descriptions in the appliance.
In the above example, Item #1 specifies the name of the target
machine in Oracle VM VirtualBox. Items #12 and #13 specify hard disk
controllers, respectively. Item #14 describes a hard disk image.
In this case, the additional
--controller option indicates
which item the disk image should be connected to, with the
default coming from the OVF file.
You can combine several items for the same virtual system using
the --vsys option. For example,
to import a machine as described in the OVF, but without the
sound card and without the USB controller, and with the disk
image connected to the IDE controller instead of the SCSI
controller, use the following command:
VBoxManage import WindowsXp.ovf --vsys 0 --unit 8 --ignore --unit 9 --ignore --unit 14 --controller 13
This command exports one or more virtual machines from
Oracle VM VirtualBox. You can export to either of the following:
A virtual appliance in OVF format, including copying their
virtual disk images to compressed VMDK.A cloud service, such as Oracle Cloud Infrastructure. A single VM can be exported in
VMDK format.
See Section 1.14, “Importing and Exporting Virtual Machines” for more details on exporting VMs from
Oracle VM VirtualBox.
List the machine, or the machines, that you would like to export
to the same OVF file and specify the target OVF file after an
additional --output or
-o option. Note that the
directory of the target OVF file will also receive the exported
disk images in the compressed VMDK format, regardless of the
original format, and should have enough disk space left for
them.
Beside a simple export of a given virtual machine, you can
append several product information to the appliance file. Use
--product,
--producturl,
--vendor,
--vendorurl,
--version and
--description to specify this
additional information. For legal reasons you may add a license
text or the content of a license file by using the
--eula and
--eulafile option respectively.
As with OVF import, you use the --vsys option to apply these options to the correct
X
virtual machine.
For virtualization products which are not fully compatible with
the OVF standard 1.0 you can enable an OVF 0.9 legacy mode with
the --legacy09 option. Other
options are --ovf09,
--ovf10,
--ovf20.
To specify options controlling the exact content of the
appliance file, you can use --options to
request the creation of a manifest file, which enables detection
of corrupted appliances on import, the additional export of DVD
images, and the exclusion of MAC addresses. You can specify a
list of options, such as --options. For details, check the help output of
manifest,nomacs
VBoxManage export.
This command starts a virtual machine that is currently in the
Powered Off or Saved states.
The optional --type specifier
determines whether the machine will be started in a window or
whether the output should go through
VBoxHeadless, with VRDE enabled or not. See
Section 7.1.2, “VBoxHeadless, the Remote Desktop Server”. The list of types is subject to
change, and it is not guaranteed that all types are accepted by
any product variant.
The global or per-VM default value for the VM frontend type will
be taken if the type is not explicitly specified. If none of these
are set, the GUI variant will be started.
The following values are allowed:
The controlvm subcommand enables you to change
the state of a virtual machine that is currently running. The
following can be specified:
VBoxManage controlvm <vm> pause:
Temporarily puts a virtual machine on hold, without
permanently changing its state. The VM window is gray, to
indicate that the VM is currently paused. This is equivalent
to selecting the Pause item
in the Machine menu of the
GUI.Use VBoxManage controlvm <vm> resume:
Undoes a previous pause command. This is
equivalent to selecting the
Resume item in the
Machine menu of the GUI.VBoxManage controlvm <vm> reset: Has
the same effect on a virtual machine as pressing the Reset
button on a real computer. A cold reboot of the virtual
machine is done, which immediately restarts and reboots the
guest operating system. The state of the VM is not saved
beforehand, and data may be lost. This is equivalent to
selecting the Reset item in
the Machine menu of the GUI.VBoxManage controlvm <vm> poweroff:
Has the same effect on a virtual machine as pulling the power
cable on a real computer. The state of the VM is not saved
beforehand, and data may be lost. This is equivalent to
selecting the Close item in
the Machine menu of the GUI,
or clicking the VM window’s close button, and then selecting
Power Off the Machine in the
displayed dialog.After this, the VM’s state will be Powered Off. From that
state, it can be started again. See
Section 8.12, “VBoxManage startvm”.VBoxManage controlvm <vm> savestate:
Saves the current state of the VM to disk and then stops the
VM. This is equivalent to selecting the
Close item in the
Machine menu of the GUI or
clicking the VM window’s close button, and then selecting
Save the Machine State in the
displayed dialog.After this, the VM’s state will be Saved. From this state, it
can be started again. See
Section 8.12, “VBoxManage startvm”.VBoxManage controlvm <vm>
acpipowerbutton: Sends an ACPI shutdown signal to
the VM, as if the power button on a real computer had been
pressed. So long as the VM is running a fairly modern guest
operating system providing ACPI support, this should trigger a
proper shutdown mechanism from within the VM.VBoxManage controlvm <vm> keyboardputscancode
<hex> [<hex>…]: Sends commands using
keycodes to the VM. Keycodes are documented in the public
domain. For example:
http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.VBoxManage controlvm “VM name” teleport –hostname
<name> –port <port> [–passwordfile <file>
| –password <password>]: Makes the machine
the source of a teleporting operation and initiates a teleport
to the given target. See Section 7.2, “Teleporting”. If
the optional password is specified, it must match the password
that was given to the modifyvm command for
the target machine. See
Section 8.8.6, “Teleporting Settings”.
The following extra options are available with
controlvm that do not directly affect the VM’s
running state:
setlinkstate<1-N>: Connects or disconnects virtual
on|off
network cables from their network interfaces.nic<1-N>:
null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>]
Specifies the type of networking that should be made available
on the specified VM virtual network card. They available types
are: not connected to the host
(null), use network address
translation (nat), bridged
networking (bridged),
communicate with other virtual machines using internal
networking (intnet),
host-only networking
(hostonly), natnetwork
networking (natnetwork), or
access to rarely used submodes
(generic). These options
correspond to the modes which are described in detail in
Section 6.2, “Introduction to Networking Modes”.With the
nictraceoptions,
you can optionally trace network traffic by dumping it to a
file, for debugging purposes.nictrace<1-N> on|off:
Enables network tracing for a particular virtual network card.Before enabling you should specify a file name to which the
trace should be logged. This can be done with the
nictracefile<1-N>option to
<filename>
VBoxManage controlvm at runtime or with the
<filename>option to
VBoxManage modifyvm otherwise.nicpromisc<1-N>: Specifies how the
deny|allow-vms|allow-all
promiscious mode is handled for the specified VM virtual
network card. This setting is only relevant for bridged
networking. The default setting of
denyhides any traffic not
intended for this VM.
allow-vmshides all host
traffic from this VM but enables the VM to see traffic to and
from other VMs.allow-all
removes this restriction completely.nicproperty<1-N>: This option,
<paramname>="paramvalue"
in combination with
nicgenericdrvenables you to
pass parameters to rarely-used network backends.Those parameters are backend engine-specific, and are
different between UDP Tunnel and the VDE backend drivers. See
Section 6.8, “UDP Tunnel Networking”.natpf<1-N>: Specifies a NAT
[<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>],
<guestport>
port-forwarding rule. See Section 6.3.1, “Configuring Port Forwarding with NAT”.natpf<1-N> delete: Deletes a NAT port-forwarding
<name>
rule. See Section 6.3.1, “Configuring Port Forwarding with NAT”.The
guestmemoryballoon<balloon size in: Changes the size of the guest memory
MB>
balloon. This is the memory allocated by the Oracle VM VirtualBox
Guest Additions from the guest operating system and returned
to the hypervisor for reuse by other virtual machines. This
must be specified in megabytes. See
Section 4.10.1, “Memory Ballooning”.usbattach<uuid|address> [--capturefile
<filename>]and
usbdetach <uuid|address>: Makes host
[--capturefile <filename>]
USB devices visible or invisible to the virtual machine on the
fly, without the need for creating filters first. The USB
devices can be specified by UUID (unique identifier) or by
address on the host system. Use the
--capturefileoption to
specify the absolute path of a file for writing activity
logging data.You can use VBoxManage list usbhost to
locate this information.audioin on: Selects whether
capturing audio from the host is enabled or disabled.audioout on: Selects whether
audio playback from the guest is enabled or disabled.clipboard mode:
disabled|hosttoguest|guesttohost|bidirectional
Selects how the guest or host operating system’s clipboard
should be shared with the host or guest. See
Section 3.4, “General Settings”. This requires that the
Guest Additions be installed in the virtual machine.clipboard filetransfers: Specifies if clipboard file
enabled|disabled
transfers are allowed between host and guest OSes or not.draganddrop:
disabled|hosttoguest|guesttohost|bidirectional
Selects the current drag and drop mode being used between the
host and the virtual machine. See
Section 4.4, “Drag and Drop”. This requires that the Guest
Additions be installed in the virtual machine.vrde on|off: Enables and
disables the VRDE server, if it is installed.vrdeport: Changes the port or a
default|<ports>
range of ports that the VRDE server can bind to.
defaultor
0means port 3389, the
standard port for RDP. See the description for the
--vrdeportoption in
Section 8.8.5, “Remote Machine Settings”.vrdeproperty: Sets the
"TCP/Ports|Address=<value>"
port numbers and IP address on the VM to which the VRDE server
can bind.vrdeproperty:
"VideoChannel/Enabled|Quality|DownscaleProtection=<value>"
Sets the VRDP video redirection properties.For VideoChannel/Enabled, <value> can be set to “1”
switching the VRDP video channel on. See
Section 7.1.9, “VRDP Video Redirection”.For VideoChannel/Quality, <value> should be set
between 10 and 100% inclusive, representing a JPEG
compression level on the VRDE server video channel. Lower
values mean lower quality but higher compression. See
Section 7.1.9, “VRDP Video Redirection”.For VideoChannel/DownscaleProtection, <value> can be
set to “1” to enable the videochannel downscale protection
feature. When enabled, if a video’s size equals the shadow
buffer size, then it is regarded as a full screen video,
and is displayed. If its size is between fullscreen and
the downscale threshold it is not displayed, as it could
be an application window, which would be unreadable when
downscaled. When the downscale protection feature is
disabled, an attempt is always made to display videos.
vrdeproperty:
"Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1"
Disables one of the VRDE server features: Display, Input,
Audio, or USB. To reenable a feature, use
“Client/DisableDisplay=” for example. See
Section 7.1.10, “VRDP Customization”.vrdeproperty.
"Client/DisableClipboard|DisableUpstreamAudio=1"
Disables one of the VRDE server features: Clipboard or
UpstreamAudio. To reenable a feature, use
“Client/DisableClipboard=” for example. See
Section 7.1.10, “VRDP Customization”.vrdeproperty: Disables the VRDE
"Client/DisableRDPDR=1"
server feature: RDP device redirection for smart cards. To
reenable this feature, use “Client/DisableRDPR=”.vrdeproperty: Enables the VRDE
"H3DRedirect/Enabled=1"
server feature: 3D redirection. To disable this feature, use
“H3DRedirect/Enabled=”.vrdeproperty:
"Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>"
Sets the desired security method, path of the server
certificate, path of the server private key, and path of CA
certificate, used for a connection.vrdeproperty:
"Audio/RateCorrectionMode|LogPath=<value>"
Sets the audio connection mode, or path of the audio logfile.vrdevideochannelquality: Sets the image quality for
<percent>
video redirection. See Section 7.1.9, “VRDP Video Redirection”.setvideomodehint: Requests
that the guest system change to a particular video mode. This
requires that the Guest Additions be installed, and will not
work for all guest systems.screenshotpng: Takes a
screenshot of the guest display and saves it in PNG format.recording on|offenables or
disables the recording of a VM session into a WebM/VP8 file.
When this option value ison,
recording begins when the VM session starts.recordingscreens
all|screen-ID
[screen-ID...]
enables you to specify which VM screens to record. The
recording for each screen that you specify is saved to its own
file. You cannot modify this setting while recording is
enabled.recordingfilespecifies
filename
the file in which to save the recording. You cannot modify
this setting while recording is enabled.recordingvideores
widthxheight
specifies the resolution of the recorded video in pixels. You
cannot modify this setting while recording is enabled.recordingvideoratespecifies
bit-rate
the bit rate of the video in kilobits per second. Increasing
this value improves the appearance of the video at the cost of
an increased file size. You cannot modify this setting while
recording is enabled.recordingvideofpsspecifies the
fps
maximum number of video frames per second (FPS) to record.
Frames that have a higher frequency are skipped. Increasing
this value reduces the number of skipped frames and increases
the file size. You cannot modify this setting while recording
is enabled.recordingmaxtimespecifies
seconds
the maximum amount time to record in seconds. The recording
stops after the specified number of seconds elapses. If this
value is zero, the recording continues until you stop the
recording.recordingmaxsizespecifies the
MB
maximum size of the recorded video file in megabytes. The
recording stops when the file reaches the specified size. If
this value is zero, the recording continues until you stop the
recording. You cannot modify this setting while recording is
enabled.recordingoptsspecifies additional recording options
keyword=value[,keyword=value
...]
in a comma-separated keyword-value format. For example,
foo=bar,a=b. You cannot
modify this setting while recording is enabled.Only use this option only if you are an advanced user. For
information about keywords, see Oracle VM VirtualBox
Programming Guide and Reference.setcredentials: Used for
remote logins on Windows guests. See
Section 9.1, “Automated Guest Logins”.teleport --host <name> --port: Configures a VM as a target for
<port>
teleporting. <name> specifies the virtual machine name.
<port> specifies the port on the virtual machine which
should listen for teleporting requests from other virtual
machines. It can be any free TCP/IP port number, such as 6000.
See Section 7.2, “Teleporting”.plugcpu|unplugcpu <id>:
If CPU hot-plugging is enabled, this setting adds and removes
a virtual CPU to the virtual machine.
<id>specifies the
index of the virtual CPU to be added or removed and must be a
number from 0 to the maximum number of CPUs configured. CPU 0
can never be removed.The
cpuexecutioncap: Controls how much CPU time a
<1-100>
virtual CPU can use. A value of 50 implies a single virtual
CPU can use up to 50% of a single host CPU.vm-process-priority: Changes the
default|flat|low|normal|high
priority scheme of the VM process. See
Section 8.12, “VBoxManage startvm”.webcam attach <path|alias>:
[<keyword=value>[;<keyword=value>...]]
Attaches a webcam to a running VM. Specify the absolute path
of the webcam on the host operating system, or use its alias,
obtained by using the command: VBoxManage list
webcams.Note that alias ‘.0’ means the default video input device on
the host operating system, ‘.1’, ‘.2’, etc. mean first,
second, etc. video input device. The device order is
host-specific.The optional settings parameter is a
;delimited list of
name-value pairs, enabling configuration of the emulated
webcam device.The following settings are supported:
MaxFramerate: Specifies the highest rate in frames per second,
at which video frames are sent to the guest. Higher frame
rates increase CPU load, so this setting can be useful when
there is a need to reduce CPU load. The default setting is
no maximum limit, thus
enabling the guest to use all frame rates supported by the
host webcam.MaxPayloadTransferSize: Specifies the maximum number of bytes
the emulated webcam can send to the guest in one buffer. The
default setting is 3060 bytes, which is used by some webcams.
Higher values can slightly reduce CPU load, if the guest is
able to use larger buffers. Note that higher
MaxPayloadTransferSize values may be not supported by some
guest operating systems.webcam detach: Detaches a webcam from a
<path|alias>
running VM. Specify the absolute path of the webcam on the
host, or use its alias obtained from the webcam
list command.Please note the following points, relating to specific host
operating systems:webcam list: Lists webcams
attached to the running VM. The output is a list of absolute
paths or aliases that were used for attaching the webcams to
the VM using the webcam attach command.addencpassword <id> <password: Supplies an encrypted VM
file>|- [--removeonsuspend
<yes|no>]
specified by <id> with the encryption password to enable
a headless start. Either specify the absolute path of a
password file on the host file system: <password file>,
or use-to instruct
VBoxManage to prompt the user for the
encryption password.--removeonsuspend: Specifies whether to remove
<yes|no>
the passsword or keep the password in VM memory when the VM is
suspended. If the VM has been suspended and the password has
been removed, the user needs to resupply the password before
the VM can be resumed. This feature is useful in cases where
the user does not want the password to be stored in VM memory,
and the VM is suspended by a host suspend event.The VBoxManage encryptmedium command is
used to create a DEK encrypted medium. See
Section 9.28.2, “Encrypting Disk Images”. When starting an
encrypted VM from the Oracle VM VirtualBox GUI, the user will be
prompted for the encryption password.For a headless encrypted VM start, use the following command:
VBoxManage startvm "vmname" --type headlessThen supply the required encryption password as follows:
VBoxManage "vmname" controlvm "vmname" addencpassword ...removeencpassword <id>:
Removes encryption password authorization for password
<id> for all encrypted media attached to the VM.removeallencpasswords:
Removes encryption password authorization for all passwords
for all encrypted media attached to the VM.changeuartmode <1-N>:
Changes the connection mode for a given virtual serial port.
This command attaches, modifies, and removes a storage medium
connected to a storage controller that was previously added with
the storagectl command. The syntax is as
follows:
VBoxManage storageattach <uuid|vmname>
--storagectl <name>
[--port <number>]
[--device <number>]
[--type dvddrive|hdd|fdd]
[--medium none|emptydrive|additions|
<uuid>|<filename>|host:<drive>|iscsi]
[--mtype normal|writethrough|immutable|shareable
readonly|multiattach]
[--comment <text>]
[--setuuid <uuid>]
[--setparentuuid <uuid>]
[--passthrough on|off]
[--tempeject on|off]
[--nonrotational on|off]
[--discard on|off]
[--hotpluggable on|off]
[--bandwidthgroup name|none]
[--forceunmount]
[--server <name>|<ip>]
[--target <target>]
[--tport <port>]
[--lun <lun>]
[--encodedlun <lun>]
[--username <username>]
[--password <password>]
[--passwordfile <file>]
[--initiator <initiator>]
[--intnet] A number of parameters are commonly required. Some parameters are
required only for iSCSI targets.
The common parameters are as follows:
uuid|vmnameThe VM UUID or VM Name. Mandatory.
--storagectlName of the storage controller. Mandatory. The list of the
storage controllers currently attached to a VM can be
obtained with VBoxManage showvminfo. See
Section 8.5, “VBoxManage showvminfo”.--portThe number of the storage controller’s port which is to be
modified. Mandatory, unless the storage controller has only
a single port.--deviceThe number of the port’s device which is to be modified.
Mandatory, unless the storage controller has only a single
device per port.--typeDefine the type of the drive to which the medium is being
attached, detached, or modified. This argument can only be
omitted if the type of medium can be determined from either
the medium given with the
--mediumargument or from a
previous medium attachment.--mediumSpecifies what is to be attached. The following values are
supported:none: Any existing
device should be removed from the given slot.emptydrive: For a
virtual DVD or floppy drive only, this makes the device
slot behave like a removeable drive into which no media
has been inserted.additions: For a
virtual DVD drive only, this attaches the
VirtualBox Guest Additions image to
the given device slot.If a UUID is specified, it must be the UUID of a storage
medium that is already known to Oracle VM VirtualBox. For
example, because it has been attached to another virtual
machine. See Section 8.4, “VBoxManage list” for
details of how to list known media. This medium is then
attached to the given device slot.If a filename is specified, it must be the full path of
an existing disk image in ISO, RAW, VDI, VMDK, or other
format. The disk image is then attached to the given
device slot.host:<drive>: For
a virtual DVD or floppy drive only, this connects the
given device slot to the specified DVD or floppy drive
on the host computer.iscsi: For virtual hard
disks only, this is used for specifying an iSCSI target.
In this case, additional parameters must be given. These
are described below.
Some of the above changes, in particular for removeable
media such as floppies and CDs/DVDs, can be effected while a
VM is running. Others, such as device changes or changes in
hard disk device slots, require the VM to be powered off.--mtypeDefines how this medium behaves with respect to snapshots
and write operations. See Section 5.4, “Special Image Write Modes”.--commentAn optional description that you want to have stored with
this medium. For example, for an iSCSI target, “Big storage
server downstairs”. This is purely descriptive and not
needed for the medium to function correctly.--setuuid, --setparentuuidModifies the UUID or parent UUID of a medium before
attaching it to a VM. This is an expert option.
Inappropriate use can make the medium unusable or lead to
broken VM configurations if any other VM is referring to the
same media already. The most frequently used variant is
--setuuid "", which assigns
a new random UUID to an image. This option is useful for
resolving duplicate UUID errors if you duplicated an image
using a file copy utility.--passthroughFor a virtual DVD drive only, you can enable DVD writing
support. This feature is currently experimental, see
Section 5.9, “CD/DVD Support”.--tempejectFor a virtual DVD drive only, you can configure the behavior
for guest-triggered medium eject. If this is set to on, the
eject has only a temporary effect. If the VM is powered off
and restarted the originally configured medium will be still
in the drive.--nonrotationalEnables you to enable the non-rotational flag for virtual
hard disks. Some guests, such as Windows 7 or later, treat
such disks like SSDs and do not perform disk fragmentation
on such media.--discardEnables the auto-discard feature for a virtual hard disks.
This specifies that a VDI image will be shrunk in response
to the trim command from the guest OS. The following
requirements must be met:It is unclear whether Microsoft’s implementation of exFAT
supports this feature, even though that file system was
originally designed for flash.Alternatively, there are other methods to issue trim. For
example, the Linux fstrim command, part
of the util-linux package. Earlier solutions required a user
to zero out unused areas, using zerofree or similar, and to
compact the disk. This is only possible when the VM is
offline.--bandwidthgroupSets the bandwidth group to use for the given device. See
Section 5.8, “Limiting Bandwidth for Disk Images”.--forceunmountFor a virtual DVD or floppy drive only, this forcibly
unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy
even if the previous one is locked down by the guest for
reading. See Section 5.9, “CD/DVD Support”.
When iscsi is used with the
--medium parameter for iSCSI
support, additional parameters must or can be used. See also
Section 5.10, “iSCSI Servers”.
--serverThe host name or IP address of the iSCSI target. Required.
--targetTarget name string. This is determined by the iSCSI target
and used to identify the storage resource. Required.--tportTCP/IP port number of the iSCSI service on the target.
Optional.--lunLogical Unit Number of the target resource. Optional. Often,
this value is zero.--encodedlunHex-encoded Logical Unit Number of the target resource.
Optional. Often, this value is zero.--username, --password,
--passwordfileUsername and password, called the initiator secret, for
target authentication, if required. Optional.--initiatoriSCSI Initiator. Optional.
Microsoft iSCSI Initiator is a system, such as a server that
attaches to an IP network and initiates requests and
receives responses from an iSCSI target. The SAN components
in Microsoft iSCSI Initiator are largely analogous to Fibre
Channel SAN components, and they include the following:--intnetIf specified, connect to the iSCSI target using Internal
Networking. This needs further configuration, see
Section 9.7.3, “Access iSCSI Targets Using Internal Networking”.
This command creates, deletes, modifies, and shows bandwidth
groups of the given virtual machine.
VBoxManage bandwidthctl <uuid|vmname>
add <name> --type disk|network --limit <MBps>[k|m|g|K|M|G] |
set <name> --limit <MBps>[k|m|g|K|M|G] |
remove <name> |
list [--machinereadable]The following subcommands are available:
The parameters are as follows:
This command shows information about a medium, notably its size,
its size on disk, its type, and the virtual machines which use it.
VBoxManage showmediuminfo [disk|dvd|floppy] <uuid|filename>
The medium must be specified either by its UUID, if the medium is
registered, or by its filename. Registered images can be listed
using VBoxManage list hdds, VBoxManage
list dvds, or VBoxManage list
floppies, as appropriate. See
Section 8.4, “VBoxManage list”.
This command creates a new medium. The syntax is as follows:
VBoxManage createmedium [disk|dvd|floppy] --filename <filename>
[--size <megabytes>|--sizebyte <bytes>]
[--diffparent <uuid>|<filename>
[--format VDI|VMDK|VHD] (default: VDI)
[--variant Standard,Fixed,Split2G,Stream,ESX]The parameters are as follows:
--filename <filename>Specifies a file name <filename> as an absolute path
on the host file system. Mandatory.--size <megabytes>Specifies the image capacity, in 1 MB units. Optional.
--diffparent
<uuid>|<filename>Specifies the differencing image parent, either as a UUID or
by the absolute pathname of the file on the host file
system. Useful for sharing a base box disk image among
several VMs.--format VDI|VMDK|VHDSpecifies the file format for the output file. Available
options are VDI, VMDK, VHD. The default format is VDI.
Optional.--variantSpecifies any required file format variants for the output
file. This is a comma-separated list of variant flags.
Options are Standard,Fixed,Split2G,Stream,ESX. Not all
combinations are supported, and specifying mutually
incompatible flags results in an error message. Optional.
With the modifymedium command, you can change
the characteristics of a disk image after it has been created.
VBoxManage modifymedium [disk|dvd|floppy] <uuid|filename>
[--type normal|writethrough|immutable|shareable|
readonly|multiattach]
[--autoreset on|off]
[--property <name=[value]>]
[--compact]
[--resize <megabytes>|--resizebyte <bytes>]
[--move <path>]
[--setlocation <path>] The disk image to modify must be specified either by its UUID, if
the medium is registered, or by its filename. Registered images
can be listed using VBoxManage list hdds, see
Section 8.4, “VBoxManage list”. A filename must be specified
as a valid path, either as an absolute path or as a relative path
starting from the current directory.
The following options are available:
With the
--typeargument, you
can change the type of an existing image between the normal,
immutable, write-through and other modes. See
Section 5.4, “Special Image Write Modes”.For immutable hard disks only, the
--autoresetoption determines whether the disk is
on|off
automatically reset on every VM startup. See
Section 5.4, “Special Image Write Modes”. By default, autoreset is on.The
--compactoption can be
used to compact disk images. Compacting removes blocks that
only contains zeroes. Using this option will shrink a
dynamically allocated image. It will reduce the
physical size of the image without
affecting the logical size of the virtual disk. Compaction
works both for base images and for differencing images created
as part of a snapshot.For this operation to be effective, it is required that free
space in the guest system first be zeroed out using a suitable
software tool. For Windows guests, you can use the
sdelete tool provided by Microsoft. Run
sdelete -z in the guest to zero the free
disk space, before compressing the virtual disk image. For
Linux, use the zerofree utility which
supports ext2/ext3 filesystems. For Mac OS X guests, use the
diskutil secureErase freespace 0command from an elevated Terminal.
/Please note that compacting is currently only available for
VDI images. A similar effect can be achieved by zeroing out
free blocks and then cloning the disk to any other dynamically
allocated format. You can use this workaround until compacting
is also supported for disk formats other than VDI.The
--resize xoption, where
x is the desired new total space in megabytes enables you to
change the capacity of an existing image. This adjusts the
logical size of a virtual disk without
affecting the physical size much.This option currently works only for VDI and VHD formats, and
only for the dynamically allocated variants. It can only be
used to expand, but not shrink, the capacity. For example, if
you originally created a 10 GB disk which is now full, you can
use the--resize 15360
command to change the capacity to 15 GB (15,360 MB) without
having to create a new image and copy all data from within a
virtual machine. Note however that this only changes the drive
capacity. You will typically next need to use a partition
management tool inside the guest to adjust the main partition
to fill the drive.The
--resizebyte xoption
does almost the same thing, except that x is expressed in
bytes instead of megabytes.The
--move <path>
option can be used to relocate a medium to a different
location <path> on the host file system. The path can be
either relative to the current directory or absolute.The
--setlocationoption can be used to set the
<path>
new location <path> of the medium on the host file
system if the medium has been moved for any reasons. The path
can be either relative to the current directory or absolute.
This command duplicates a virtual disk, DVD, or floppy medium to a
new medium, usually an image file, with a new unique identifier
(UUID). The new image can be transferred to another host system or
reimported into Oracle VM VirtualBox using the Virtual Media Manager.
See Section 5.3, “The Virtual Media Manager” and Section 5.6, “Cloning Disk Images”.
The syntax is as follows:
VBoxManage clonemedium [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>
[--format VDI|VMDK|VHD|RAW|<other>]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--existing] The medium to clone as well as the target image must be described
either by its UUIDs, if the mediums are registered, or by its
filename. Registered images can be listed by VBoxManage
list hdds. See Section 8.4, “VBoxManage list”. A
filename must be specified as valid path, either as an absolute
path or as a relative path starting from the current directory.
The following options are available:
This command converts a raw disk image to an Oracle VM VirtualBox Disk
Image (VDI) file. The syntax is as follows:
VBoxManage convertfromraw <filename> <outputfile>
[--format VDI|VMDK|VHD]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--uuid <uuid>]
VBoxManage convertfromraw stdin <outputfile> <bytes>
[--format VDI|VMDK|VHD]
[--variant Standard,Fixed,Split2G,Stream,ESX]
[--uuid <uuid>]The parameters are as follows:
The stdin form of the command forces
VBoxManage to read the content of the disk
image from standard input. This useful when using the command in a
pipe.
This command is used to change global settings which affect the
entire Oracle VM VirtualBox installation. Some of these correspond to
the settings in the Preferences
dialog in the VirtualBox Manager. The following properties are
available:
machinefolderSpecifies the default folder in which virtual machine
definitions are kept. See Section 10.1, “Where Oracle VM VirtualBox Stores its Files”.hwvirtexclusiveSpecifies whether Oracle VM VirtualBox will make exclusive use of
the hardware virtualization extensions (Intel VT-x or AMD-V)
of the host system’s processor. See
Section 10.3, “Hardware Virtualization”. If you wish to share these
extensions with other hypervisors running at the same time,
you must disable this setting. Doing so has negative
performance implications.vrdeauthlibrarySpecifies which library to use when external authentication
has been selected for a particular virtual machine. See
Section 7.1.5, “RDP Authentication”.websrvauthlibrarySpecifies which library the web service uses to authenticate
users. For details about the Oracle VM VirtualBox web service, see
the Oracle VM VirtualBox SDK reference,
Chapter 11, Oracle VM VirtualBox Programming Interfaces.vrdeextpackSpecifies which library implements the VirtualBox Remote
Desktop Extension.loghistorycountSelects how many rotated VM logs are retained.
autostartdbpathSelects the path to the autostart database. See
Section 9.21, “Starting Virtual Machines During System Boot”.defaultfrontendSelects the global default VM frontend setting. See
Section 8.12, “VBoxManage startvm”.logginglevelConfigures the VBoxSVC release logging details. See
http://www.msconfig.ru/wiki/VBoxLogging.proxymodeConfigures the mode for an HTTP proxy server.
proxyurlConfigures the URL for an HTTP proxy server. Used when a
manual proxy is configured using the
manualsetting of the
proxymodeproperty.
VBoxManage usbfilter add <index,0-N>
--target <uuid|vmname>global
--name <string>
--action ignore|hold (global filters only)
[--active yes|no (yes)]
[--vendorid <XXXX> (null)]
[--productid <XXXX> (null)]
[--revision <IIFF> (null)]
[--manufacturer <string> (null)]
[--product <string> (null)]
[--remote yes|no (null, VM filters only)]
[--serialnumber <string> (null)]
[--maskedinterfaces <XXXXXXXX>]
VBoxManage usbfilter modify <index,0-N>
--target <uuid|vmname>global
[--name <string>]
[--action ignore|hold (global filters only)]
[--active yes|no]
[--vendorid <XXXX>]
[--productid <XXXX>]
[--revision <IIFF>]
[--manufacturer <string>]
[--product <string>]
[--remote yes|no (null, VM filters only)]
[--serialnumber <string>]
[--maskedinterfaces <XXXXXXXX>]
VBoxManage usbfilter remove <index,0-N>
--target <uuid|vmname>global
The usbfilter commands are used for working
with USB filters in virtual machines, or global filters which
affect the whole Oracle VM VirtualBox setup. Global filters are applied
before machine-specific filters, and may be used to prevent
devices from being captured by any virtual machine. Global filters
are always applied in a particular order, and only the first
filter which fits a device is applied. For example, if the first
global filter says to hold, or make available, a particular
Kingston memory stick device and the second filter says to ignore
all Kingston devices. That particular Kingston memory stick will
be available to any machine with the appropriate filter, but no
other Kingston device will.
When creating a USB filter using usbfilter add,
you must supply three or four mandatory parameters. The index
specifies the position in the list at which the filter should be
placed. If there is already a filter at that position, then it and
the following ones will be shifted back one place. Otherwise, the
new filter will be added onto the end of the list. The
target parameter selects the
virtual machine that the filter should be attached to or use
global to apply it to all virtual
machines. name is a name for the
new filter. For global filters,
action says whether to allow VMs
access to devices that fit the filter description (hold) or not to
give them access (ignore). In addition, you should specify
parameters to filter by. You can find the parameters for devices
attached to your system using VBoxManage list
usbhost. Finally, you can specify whether the filter
should be active. For local filters, whether they are for local
devices, remote devices over an RDP connection, or either.
When you modify a USB filter using usbfilter
modify, you must specify the filter by index and by
target, which is either a virtual machine or
global. See the output of
VBoxManage list usbfilters to find global
filter indexes and VBoxManage showvminfo to
find indexes for individual machines. The properties which can be
changed are the same as for usbfilter add. To
remove a filter, use usbfilter remove and
specify the index and the target.
The following is a list of the additional usbfilter
add and usbfilter modify options,
with details of how to use them.
--action ignore|hold:
Specifies whether devices that fit the filter description are
allowed access by machines (hold), or have access denied
(ignore). Applies to global filters only.--active yes|no: Specifies
whether the USB Filter is active or temporarily disabled. For
usbfilter createthe default
is active.--vendorid <XXXX>|"":
Specifies a vendor ID filter. The string representation for an
exact match has the form XXXX, where X is the hexadecimal
digit, including leading zeroes.--productid <XXXX>|"":
Specifies a product ID filter. The string representation for
an exact match has the form XXXX, where X is the hexadecimal
digit, including leading zeroes.--revision <IIFF>|"":
Specifies a revision ID filter. The string representation for
an exact match 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 is best to use the
hexadecimal form, because the revision is stored as a 16-bit
packed BCD value. Therefore, the expression int:0x0100-0x0199
will match any revision from 1.0 to 1.99 inclusive.--manufacturer: Specifies a manufacturer
<string>|""
ID filter, as a string.--product <string>|"":
Specifies a product ID filter, as a string.--remote yes|no"": Specifies
a remote filter, indicating whether the device is physically
connected to a remote VRDE client or to a local host machine.
Applies to VM filters only.--serialnumber: Specifies a serial number
<string>|""
filter, as a string.--maskedinterfaces: Specifies a masked
<XXXXXXXX>
interface filter, for hiding one or more USB interfaces from
the guest. The value is a bit mask where the set bits
correspond to the USB interfaces that should be hidden, or
masked off. This feature only works on Linux hosts.
The guestproperty commands enable you to get or
set properties of a running virtual machine. See
Section 4.7, “Guest Properties”. Guest properties are
arbitrary keyword-value string pairs which can be written to and
read from by either the guest or the host, so they can be used as
a low-volume communication channel for strings, provided that a
guest is running and has the Guest Additions installed. In
addition, a number of values whose keywords begin with
/VirtualBox/are automatically set
and maintained by the Guest Additions.
The following subcommands are available, where
<vm> can either be a VM
name or a VM UUID, as with the other VBoxManage
commands:
The guestcontrol commands enable control of the
guest from the host. See
Section 4.9, “Guest Control of Applications” for an introduction.
The guestcontrol command has two sets of
subcommands. The first set requires guest credentials to be
specified, the second does not.
The first set of subcommands is of the following form:
VBoxManage guestcontrol <uuid|vmname> <sub-command>
[--username <name> ]
[--passwordfile <file> | --password <password>]
[--domain <domain> ]
[-v|--verbose] [-q|quiet] ...
The common options are as follows:
[--username <name> ]
[--passwordfile <file> | --password <password>]
[--domain <domain> ]
[-v|--verbose] [-q|quiet]
The common options for the first set of subcommands are explained
in the following list.
The first set of subcommands are as follows:
run: Executes a guest
program, forwarding stdout, stderr, and stdin to and from the
host until it completes.VBoxManage guestcontrol <uuid|vmname> run [common-options] --exe <path to executable> [--timeout <msec>] [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] [--ignore-operhaned-processes] [--profile] [--no-wait-stdout|--wait-stdout] [--no-wait-stderr|--wait-stderr] [--dos2unix] [--unix2dos] -- <program/arg0> [argument1] ... [argumentN]]<uuid|vmname>Specifies the VM UUID or VM name. Mandatory.
--exe <path to
executable>Specifies the absolute path of the executable on the
guest OS file system. Mandatory. For example:
C:WindowsSystem32calc.exe.--timeout <msec>Specifies the maximum time, in microseconds, that the
executable can run, during which
VBoxManage receives its output.
Optional. If unspecified, VBoxManage
waits indefinitely for the process to end, or an error
occurs.-E|--putenv
<NAME>=<VALUE>Sets, modifies, and unsets environment variables in the
environment in which the program will run. Optional.The guest process is created with the standard default
guest OS environment. Use this option to modify that
default environment. To set or modify a variable use:
<NAME>=<VALUE>.
To unset a variable use:
<NAME>=Any spaces in names and values should be enclosed by
quotes.To set, modify, and unset multiple variables, use
multiple instances of the
--E|--putenvoption.--unquoted-argsDisables escaped double quoting, such as “fred”, on
arguments passed to the executed program. Optional.--ignore-operhaned-processesIgnore orphaned processes. Not yet implemented.
Optional.--profileUse Profile. Not yet implemented. Optional.
--no-wait-stdout|--wait-stdoutDoes not wait or waits until the guest process ends and
receives its exit code and reason/flags. In the case of
--wait-stdout,
VBoxManage receives its stdout while
the process runs. Optional.--no-wait-stderr|--wait-stderrDoes not wait or waits until the guest process ends and
receives its exit code, error messages, and flags. In
the case of
--wait-stderr,
VBoxManage receives its stderr while
the process runs. Optional.--dos2unixConverts output from DOS/Windows guests to
UNIX/Linux-compatible line endings, CR LF to LF. Not
yet implemented. Optional.--unix2dosConverts output from a UNIX/Linux guests to
DOS/Windows-compatible line endings, LF to CR LF. Not
yet implemented. Optional.[-- <program/arg0>
[<argument1>] ...
[<argumentN>]]Specifies the program name, followed by one or more
arguments to pass to the program. Optional.Any spaces in arguments should be enclosed by quotes.
Examples of using the guestcontrol run
command are as follows:VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls" --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usrVBoxManage --nologo guestcontrol "My VM" run --exe "c:\windows\system32\ipconfig.exe" --username foo --passwordfile bar.txt --wait-exit --wait-stdoutNote that the double backslashes in the second example are
only required on UNIX hosts.Starting at Oracle VM VirtualBox 4.1.2 guest process execution by
default is limited to serve up to five guest processes at a
time. If a new guest process gets started which would exceed
this limit, the oldest not running guest process will be
discarded in order to be able to run that new process. Also,
retrieving output from this old guest process will not be
possible anymore then. If all five guest processes are still
active and running, starting a new guest process will result
in an appropriate error message.To raise or lower the guest process execution limit, either
use the guest property
/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept
or VBoxService command line by specifying
--control-procs-max-kept
needs to be modified. A restart of the guest OS is required
afterwards. To serve unlimited guest processes, a value of
0needs to be set, but this
is not recommended.start: Executes a guest
program until it completes.VBoxManage guestcontrol <uuid|vmname> start [common-options] [--exe <path to executable>] [--timeout <msec>] [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] [--ignore-operhaned-processes] [--profile] -- <program/arg0> [argument1] ... [argumentN]]Where the options are as follows:
<uuid|vmname>Specifies the VM UUID or VM name. Mandatory.
--exe <path to
executable>Specifies the absolute path of the executable on the
guest OS file system. Mandatory. For example:
C:WindowsSystem32calc.exe--timeout <msec>Specifies the maximum time, in microseconds, that the
executable can run. Optional. If unspecified,
VBoxManage waits indefinitely for the
process to end, or an error occurs.-E|--putenv
<NAME>=<VALUE>Sets, modifies, and unsets environment variables in the
environment in which the program will run. Optional.The guest process is created with the standard default
guest OS environment. Use this option to modify that
default environment. To set or modify a variable use:
<NAME>=<VALUE>.
To unset a variable use:
<NAME>=Any spaces in names and values should be enclosed by
quotes.To set, modify, or unset multiple variables, use
multiple instances of the
--E|--putenvoption.--unquoted-argsDisables escaped double quoting, such as “fred”, on
arguments passed to the executed program. Optional.--ignore-operhaned-processesIgnores orphaned processes. Not yet implemented.
Optional.--profileUse a profile. Not yet implemented. Optional.
[-- <program/arg0>
[<argument1>] ...
[<argumentN>]]Specifies the program name, followed by one or more
arguments to pass to the program. Optional.Any spaces in arguments should be enclosed by quotes.
Examples of using the guestcontrol start
command are as follows:VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls" --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usrVBoxManage --nologo guestcontrol "My VM" start --exe "c:\windows\system32\ipconfig.exe" --username foo --passwordfile bar.txt --wait-exit --wait-stdoutNote that the double backslashes in the second example are
only required on UNIX hosts.Starting at Oracle VM VirtualBox 4.1.2 guest process execution by
default is limited to serve up to five guest processes at a
time. If a new guest process gets started which would exceed
this limit, the oldest not running guest process will be
discarded in order to be able to run that new process. Also,
retrieving output from this old guest process will not be
possible anymore then. If all five guest processes are still
active and running, starting a new guest process will result
in an appropriate error message.To raise or lower the guest process execution limit, either
use the guest property
/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept
or VBoxService command line by specifying
--control-procs-max-kept
needs to be modified. A restart of the guest OS is required
afterwards. To serve unlimited guest processes, a value of
0needs to be set, but this
is not recommended.copyfrom: Copies files from
the guest to the host file system. Only available with Guest
Additions 4.0 or later installed.VBoxManage guestcontrol <uuid|vmname> copyfrom [common-options] [--follow] [--R|recursive] --target-directory <host-dst-dir> <guest-src0> [<guest-src1> [...]]Where the parameters are as follows:
copyto: Copies files from the
host to the guest file system. Only available with Guest
Additions 4.0 or later installed.VBoxManage guestcontrol <uuid|vmname> copyto [common-options] [--follow] [--R|recursive] --target-directory <guest-dst> <host-src0> [<host-src1> [...]]Where the parameters are as follows:
md|mkdir|createdir|createdirectory:
Creates one or more directories on the guest file system. Only
available with Guest Additions 4.0 or later installed.VBoxManage guestcontrol <uuid|vmname> md|mkdir|createdir|createdirectory [common-options] [--parents] [--mode <mode>] <guest-dir0> [<guest-dir1> [...]]Where the parameters are as follows:
<uuid|vmname>Specifies the VM UUID or VM name. Mandatory.
--parentsCreates any absent parent directories of the specified
directory. Optional.For example: If specified directory is
D:FooBarand
D:Foois absent, it will be
created. In such a case, had the
--parentsoption not
been used, this command would have failed.--mode <mode>Specifies the permission mode on the specified
directories, and any parents, if the
--parentsoption is
used. Currently octal modes only, such as.
0755, are supported.<guest-dir0> [<guest-dir1>
[...]]Specifies a list of absolute paths of directories to be
created on guest file system. Mandatory. For example:
D:FooBar.All parent directories must already exist unless the
switch--parentsis
used. For example, in the above example
D:Foo. The specified user must
have sufficient rights to create the specified
directories, and any parents that need to be created.
rmdir|removedir|removedirectory:
Deletes specified guest file system directories. Only
available with installed Guest Additions 4.3.2 and later.VBoxManage guestcontrol <uuid|vmname> rmdir|removedir|removedirectory [common-options] [--recursive|-R] <guest-dir0> [<guest-dir1> [...]]Where the parameters are as follows:
rm|removefile: Deletes
specified files on the guest file system. Only available with
installed Guest Additions 4.3.2 and later.VBoxManage guestcontrol <uuid|vmname> rm|removefile [common-options] [-f|--force] <guest-file0> [<guest-file1> [...]]Where the parameters are as follows:
mv|move|ren|rename: Renames
files and/or directories on the guest file system. Only
available with installed Guest Additions 4.3.2 and later.VBoxManage guestcontrol <uuid|vmname> mv|move|ren|rename [common-options] <guest-source0> [<guest-source1> [...]] <guest-dest>Where the parameters are as follows:
mktemp|createtemp|createtemporary:
Creates a temporary file or directory on the guest file
system, to assist subsequent copying of files from the host to
the guest file systems. By default, the file or directory is
created in the guest’s platform specific temp directory. Not
currently supported. Only available with installed Guest
Additions 4.2 and later.VBoxManage guestcontrol <uuid|vmname> mktemp|createtemp|createtemporary [common-options] [--directory] [--secure] [--mode <mode>] [--tmpdir <directory>] <template>The parameters are as follows:
stat: Displays file or file
system statuses on the guest.VBoxManage guestcontrol <uuid|vmname> stat [common-options] <file0> [<file1> [...]]Where the parameters are as follows:
The second set of subcommands is of the form:
VBoxManage guestcontrol <uuid|vmname> <sub-command>
[-v|--verbose] [-q|quiet] ...
The common options are as follows:
[-v|--verbose] [-q|--quiet]
Details of the common options for the second set of subcommands
are as follows:
The second set of subcommands are as follows:
This command supports monitoring the usage of system resources.
Resources are represented by various metrics associated with the
host system or a particular VM. For example, the host system has a
CPU/Load/User metric that shows
the percentage of time CPUs spend executing in user mode over a
specific sampling period.
Metric data is collected and retained internally. It may be
retrieved at any time with the VBoxManage metrics
query subcommand. The data is available as long as the
background VBoxSVC process is
alive. That process terminates shortly after all VMs and frontends
have been closed.
By default no metrics are collected at all. Metrics collection
does not start until VBoxManage metrics setup
is invoked with a proper sampling interval and the number of
metrics to be retained. The interval is measured in seconds. For
example, to enable collecting the host processor and memory usage
metrics every second and keeping the five most current samples,
the following command can be used:
VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage
Metric collection can only be enabled for started VMs. Collected
data and collection settings for a particular VM will disappear as
soon as it shuts down. Use the VBoxManage metrics
list subcommand to see which metrics are currently
available. You can also use the --list option
with any subcommand that modifies metric settings to find out
which metrics were affected.
Note that the VBoxManage metrics setup
subcommand discards all samples that may have been previously
collected for the specified set of objects and metrics.
To enable or disable metrics collection without discarding the
data, VBoxManage metrics enable and
VBoxManage metrics disable subcommands can be
used. Note that these subcommands expect metrics as parameters,
not submetrics such as CPU/Load
or RAM/Usage. In other words
enabling CPU/Load/User while
disabling CPU/Load/Kernel is not
supported.
The host and VMs have different sets of associated metrics.
Available metrics can be listed with VBoxManage metrics
list subcommand.
A complete metric name may include an aggregate function. The name
has the following form:
Category/Metric[/SubMetric][:aggregate].
For example, RAM/Usage/Free:min
stands for the minimum amount of available memory over all
retained data if applied to the host object.
Subcommands may apply to all objects and metrics or can be limited
to one object and a list of metrics. If no objects or metrics are
given in the parameters, the subcommands will apply to all
available metrics of all objects. You may use an asterisk
“*” to explicitly specify that
the command should be applied to all objects or metrics. Use
host as the object name to limit
the scope of the command to host-related metrics. To limit the
scope to a subset of metrics, use a metric list with names
separated by commas.
For example, to query metric data on the CPU time spent in user
and kernel modes by the virtual machine named
test, use the following command:
VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel
The following list summarizes the available subcommands:
NAT networks use the Network Address Translation (NAT) service,
which works in a similar way to a home router. It groups systems
using it into a network and prevents outside systems from directly
accessing those inside, while letting systems inside communicate
with each other and outside systems using TCP and UDP over IPv4
and IPv6.
A NAT service is attached to an internal network. Virtual machines
to make use of one should be attached to it. The name of an
internal network is chosen when the NAT service is created, and
the internal network will be created if it does not already exist.
The following is an example command to create a NAT network:
VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable
Here, natnet1 is the name of the
internal network to be used and
192.168.15.0/24 is the network
address and mask of the NAT service interface. By default, in this
static configuration the gateway will be assigned the address
192.168.15.1, the address after the interface address, though this
is subject to change.
To add a DHCP server to the NAT network after creation, run the
following command:
VBoxManage natnetwork modify --netname natnet1 --dhcp on
The subcommands for VBoxManage natnetwork are
as follows:
VBoxManage natnetwork add --netname <name>
[--network <network>]
[--enable|--disable]
[--dhcp on|off]
[--port-forward-4 <rule>]
[--loopback-4 <rule>]
[--ipv6 on|off]
[--port-forward-6 <rule>]
[--loopback-6 <rule>]
VBoxManage natnetwork add: Creates a new
internal network interface, and adds a NAT network service. This
command is a prerequisite for enabling attachment of VMs to the
NAT network. Parameters are as follows:
VBoxManage natnetwork remove --netname <name>
VBoxManage natnetwork remove: Removes a NAT
network service. Parameters are as follows:
VBoxManage natnetwork modify --netname <name>
[--network <network>]
[--enable|--disable]
[--dhcp on|off]
[--port-forward-4 <rule>]
[--loopback-4 <rule>]
[--ipv6 on|off]
[--port-forward-6 <rule>]
[--loopback-6 <rule>]
VBoxManage natnetwork modify: Modifies an
existing NAT network service. Parameters are as follows:
VBoxManage natnetwork start --netname <name>
VBoxManage natnetwork start: Starts the
specified NAT network service and any associated DHCP server.
Parameters are as follows:
VBoxManage natnetwork stop --netname <name>
VBoxManage natnetwork stop: Stops the specified
NAT network service and any DHCP server. Parameters are as
follows:
VBoxManage natnetwork list [<pattern>]
VBoxManage natnetwork list: Lists all NAT
network services, with optional filtering. Parameters are as
follows:
Manage Oracle VM VirtualBox virtual machine snapshots.
The VBoxManage snapshot command manages
snapshots.
Oracle VM VirtualBox uses the snapshot to capture the state of a virtual
machine (VM). You can later use the snapshot to revert to the
state described by the snapshot.
A snapshot is a complete copy of a VM’s settings. If you take the
snapshot while the VM is running, the snapshot also includes the
VM’s state file.
After you take a snapshot, Oracle VM VirtualBox creates a
differencing hard disk for each normal hard
disk that is associated with the host machine. When you restore a
snapshot, Oracle VM VirtualBox uses these differencing files to quickly
reset the contents of the VM’s virtual hard disks.
For each VBoxManage snapshot command, you must
specify the name or the universal unique identifier (UUID) of the
VM for which you want to take a snapshot.
Create a clone of an existing Oracle VM VirtualBox virtual machine.
The following list describes the operand and the options that you
can use with the VBoxManage clonevm command:
vmname|uuidSpecifies the name or UUID of the VM to clone.
--basefolder=basefolderSpecifies the name of the folder in which to save the
configuration for the new VM.--groups=group,...Assigns the clone to the specified group or groups. If you
specify more than one group, separate each group name with a
comma.Note that each group is identified by a group ID that starts
with a slash character (/)
so that groups can be nested. By default, a clone is always
assigned membership to the
/group.--mode=machine|machineandchildren|allSpecifies which of the following cloning modes to use:
--name=nameSpecifies a new name for the new VM. The default value is
original-name
Clone
original-nameis the original
name of the VM.--options=option,...Specifies how to create the new clone.
The
--optionsargument can be used multiple
times to enable multiple options, or the options can be given as a
comma separated list. The options are case insensitive.The following options (case-insensitive) are recognized:
--registerAutomatically registers the new clone in this Oracle VM VirtualBox
installation. You can manually register the new VM later by
using the VBoxManage registervm command.
See Section 8.6, “VBoxManage registervm/unregistervm”.--snapshot=snapshot-nameSpecifies the snapshot on which to base the new VM. By
default, the clone is created from the current state of the
specified VM.--uuid=uuidSpecifies the UUID for the new VM. Ensure that this ID is
unique for the Oracle VM VirtualBox instance if you decide to
register this new VM. By default, Oracle VM VirtualBox provides a
new UUID.
Add and remove shared folders.
Shared folders enable you to share data between the host system
and guests. To use shared folders, you must first install the
Oracle VM VirtualBox Guest Additions software on the guest OS.
The shared folder is associated with a share name and the full
path name of the folder or directory on the host system. The share
name is a unique name within the namespace of the host OS.
The VBoxManage sharedfolder add command
creates a shared folder. The folder you specify is on the host
computer. When configured, the contents of the folder on the
host system can be shared with the guest OS.
DHCP server management.
The dhcpserver commands enable you to control the DHCP
server that is built into VirtualBox. You may find this useful when
using internal or host-only networking. Theoretically, you can also
enable it for a bridged network, but that may cause conflicts with other
DHCP servers in your physical network.
- 1 – SubnetMask
IPv4 netmask. Set to the value of the –netmask option by default.
- 2 – TimeOffset
UTC offset in seconds (32-bit decimal value).
- 3 – Routers
Space separated list of IPv4 router addresses.
- 4 – TimeServers
Space separated list of IPv4 time server (RFC 868) addresses.
- 5 – NameServers
Space separated list of IPv4 name server (IEN 116) addresses.
- 6 – DomainNameServers
Space separated list of IPv4 DNS addresses.
- 7 – LogServers
Space separated list of IPv4 log server addresses.
- 8 – CookieServers
Space separated list of IPv4 cookie server (RFC 865) addresses.
- 9 – LPRServers
Space separated list of IPv4 line printer server (RFC 1179) addresses.
- 10 – ImpressServers
Space separated list of IPv4 imagen impress server addresses.
- 11 – ResourseLocationServers
Space separated list of IPv4 resource location (RFC 887) addresses.
- 12 – HostName
The client name. See RFC 1035 for character limits.
- 13 – BootFileSize
Number of 512 byte blocks making up the boot file (16-bit decimal value).
- 14 – MeritDumpFile
Client core file.
- 15 – DomainName
Domain name for the client.
- 16 – SwapServer
IPv4 address of the swap server that the client should use.
- 17 – RootPath
The path to the root disk the client should use.
- 18 – ExtensionPath
Path to a file containing additional DHCP options (RFC2123).
- 19 – IPForwarding
Whether IP forwarding should be enabled by the client (boolean).
- 20 – OptNonLocalSourceRouting
Whether non-local datagrams should be forwarded by the client (boolean)
- 21 – PolicyFilter
List of IPv4 addresses and masks paris controlling non-local source routing.
- 22 – MaxDgramReassemblySize
The maximum datagram size the client should reassemble (16-bit decimal value).
- 23 – DefaultIPTTL
The default time-to-leave on outgoing (IP) datagrams (8-bit decimal value).
- 24 – PathMTUAgingTimeout
RFC1191 path MTU discovery timeout value in seconds (32-bit decimal value).
- 25 – PathMTUPlateauTable
RFC1191 path MTU discovery size table, sorted in ascending order (list of 16-bit decimal values).
- 26 – InterfaceMTU
The MTU size for the interface (16-bit decimal value).
- 27 – AllSubnetsAreLocal
Indicates whether the MTU size is the same for all subnets (boolean).
- 28 – BroadcastAddress
Broadcast address (RFC1122) for the client to use (IPv4 address).
- 29 – PerformMaskDiscovery
Whether to perform subnet mask discovery via ICMP (boolean).
- 30 – MaskSupplier
Whether to respond to subnet mask requests via ICMP (boolean).
- 31 – PerformRouterDiscovery
Whether to perform router discovery (RFC1256) (boolean).
- 32 – RouterSolicitationAddress
Where to send router solicitation requests (RFC1256) (IPv4 address).
- 33 – StaticRoute
List of network and router address pairs addresses.
- 34 – TrailerEncapsulation
Whether to negotiate the use of trailers for ARP (RTF893) (boolean).
- 35 – ARPCacheTimeout
The timeout in seconds for ARP cache entries (32-bit decimal value).
- 36 – EthernetEncapsulation
Whether to use IEEE 802.3 (RTF1042) rather than of v2 (RFC894) ethernet encapsulation (boolean).
- 37 – TCPDefaultTTL
Default time-to-live for TCP sends (non-zero 8-bit decimal value).
- 38 – TCPKeepaliveInterval
The interface in seconds between TCP keepalive messages (32-bit decimal value).
- 39 – TCPKeepaliveGarbage
Whether to include a byte of garbage in TCP keepalive messages for backward compatibility (boolean).
- 40 – NISDomain
The NIS (Sun Network Information Services) domain name (string).
- 41 – NISServers
Space separated list of IPv4 NIS server addresses.
- 42 – NTPServers
Space separated list of IPv4 NTP (RFC1035) server addresses.
- 43 – VendorSpecificInfo
Vendor specific information. Only accessible using –set-opt-hex.
- 44 – NetBIOSNameServers
Space separated list of IPv4 NetBIOS name server (NBNS) addresses (RFC1001,RFC1002).
- 45 – NetBIOSDatagramServers
Space separated list of IPv4 NetBIOS datagram distribution server (NBDD) addresses (RFC1001,RFC1002).
- 46 – NetBIOSNodeType
NetBIOS node type (RFC1001,RFC1002): 1=B-node, 2=P-node, 4=M-node, and 8=H-node (8-bit decimal value).
- 47 – NetBIOSScope
NetBIOS scope (RFC1001,RFC1002). Only accessible using –set-opt-hex.
- 48 – XWindowsFontServers
Space separated list of IPv4 X windows font server addresses.
- 49 – XWindowsDisplayManager
Space separated list of IPv4 X windows display manager addresses.
- 62 – NetWareIPDomainName
Netware IP domain name (RFC2242) (string).
- 63 – NetWareIPInformation
Netware IP information (RFC2242). Only accessible using –set-opt-hex.
- 64 – NISPlusDomain
The NIS domain name (string).
- 65 – NISPlusServers
Space separated list of IPv4 NIS server addresses.
- 66 – TFTPServerName
TFTP server name (string).
- 67 – BootfileName
Bootfile name (string).
- 68 – MobileIPHomeAgents
Space separated list of IPv4 mobile IP agent addresses.
- 69 – SMTPServers
Space separated list of IPv4 simple mail transport protocol (SMPT) server addresses.
- 70 – POP3Servers
Space separated list of IPv4 post office protocol 3 (POP3) server addresses.
- 71 – NNTPServers
Space separated list of IPv4 network news transport protocol (NTTP) server addresses.
- 72 – WWWServers
Space separated list of default IPv4 world wide web (WWW) server addresses.
- 73 – FingerServers
Space separated list of default IPv4 finger server addresses.
- 74 – IRCServers
Space separated list of default IPv4 internet relay chat (IRC) server addresses.
- 75 – StreetTalkServers
Space separated list of IPv4 StreetTalk server addresses.
- 76 – STDAServers
Space separated list of IPv4 StreetTalk directory assistance (STDA) server addresses.
- 78 – SLPDirectoryAgent
Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using –set-opt-hex.
- 79 – SLPServiceScope
List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using –set-opt-hex.
- 119 – DomainSearch
Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding. Only accessible using –set-opt-hex.
Introspection and guest debugging.
The “debugvm” commands are for experts who want to tinker with the
exact details of virtual machine execution. Like the VM debugger
described in Section 12.1.4, “The Built-In VM Debugger”, these commands are only useful if you are
very familiar with the details of the PC architecture and how to debug
software.
Changes the destination settings for either debug (--debug)
or release (--release) logger of the VM process. For details
on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp.
The destinations is one or more mnemonics, optionally
prefixed by “no” to disable them. Some of them take values after a “:” or “=”
separator. Multiple mnemonics can be separated by space or given as separate
arguments on the command line.
List of available destination:
file[=file], nofileSpecifies a log file. It no filname is given, one will be
generated based on the current UTC time and VM process name and placed in
the current directory of the VM process. Note that this will currently not
have any effect if the log file has already been opened.dir=directory, nodirSpecifies the output directory for log files. Note that this
will currently not have any effect if the log file has already been opened.history=count, nohistoryA non-zero value enables log historization, with the value
specifying how many old log files to keep.histsize=bytesThe max size of a log file before it is historized. Default is infinite.
histtime=secondsThe max age (in seconds) of a log file before it is historized. Default is infinite.
ringbuffer, noringbufferOnly log to the log buffer until an explicit flush (e.g. via an assertion)
occurs. This is fast and saves diskspace.stdout, nostdoutWrite the log content to standard output.
stdout, nostdoutWrite the log content to standard error.
debugger, nodebuggerWrite the log content to the debugger, if supported by the host OS.
com, nocomWrites logging to the COM port. This is only applicable for raw-mode and ring-0 logging.
user, nouserCustom destination which has no meaning to VM processes..
This corresponds to the logdest command in the debugger.
Changes the flags on either debug (--debug) or release
(--release) logger of the VM process. Please note that the
modifications are applied onto the existing changes, they are not replacing them.
The flags are a list of flag mnemonics, optionally
prefixed by a “no”, “!”, “~” or “-” to negate their meaning. The ” ” prefix
can be used to undo previous negation or use as a separator, though better use
whitespace or separate arguments for that.
List of log flag mnemonics, with their counter form where applicable
(asterisk indicates defaults):
This corresponds to the logflags command in the debugger.
Manage the cloud entities.
Creates new instance in the Cloud.
There are two standard ways to create an instance in the Cloud:
1. Create an instance from an existing custom image.
2. Create an instance from an existing bootable volume. This bootable volume shouldn’t be attached to any instance.
For the 1st approach next parameters are required: image-id and boot-disk-size.
For the 2nd approach next parameters are required: boot-volume-id;
The rest parameters are common for both cases:
display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain.
FUSE mount a virtual disk image for Mac OS and Linux hosts.
The vboximg-mount command enables you to make
Oracle VM VirtualBox disk images available to a Mac OS or Linux host
operating system (OS) for privileged or non-priviliged access. You
can mount any version of the disk from its available history of
snapshots. Use this command to mount, view, and optionally modify
the contents of an Oracle VM VirtualBox virtual disk image, and you can
also use this command to view information about registered virtual
machines (VMs).
This command uses the Filesystem in Userspace (FUSE) technology to
provide raw access to an Oracle VM VirtualBox virtual disk image.
When you use the --image option to specify a base
image identifier, only the base image is mounted. Any related
snapshots are disregarded. Alternatively, if you use the
--image option to specify a snapshot, the state
of the FUSE-mounted virtual disk is synthesized from the implied
chain of snapshots, including the base image.
The vboximg-mount command includes experimental
read-only access to file systems inside a VM disk image. This
feature enables you to extract some files from the VM disk image
without starting the VM and without requiring third-party file
system drivers on the host system. Oracle VM VirtualBox supports the
FAT, NTFS, ext2, ext3,
and ext4 file systems.
The virtual disk is exposed as a device node within a FUSE-based
file system that overlays the specified mount point.
The FUSE file system includes a directory that contains a number
of files. The file system can also contain a directory that
includes a symbolic link that has the same base name (see the
basename(1) man page) as the virtual disk base
image and points to the location of the virtual disk base image.
The directory can be of the following types:
