.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.11.
.TH VBOXMANAGE "1" "March 2013" "VBoxManage" "User Commands"
.SH NAME
VBoxManage \- x86 virtualization solution
.SH DESCRIPTION
Oracle VM VirtualBox Command Line Management Interface
(C) 2005\-2013 Oracle Corporation
All rights reserved.
.PP
Usage:
.IP
VBoxManage [<general option>] <command>
.PP
General Options:
.TP
[\-v|\-\-version]
print version number and exit
.TP
[\-q|\-\-nologo]
suppress the logo
.TP
[\-\-settingspw <pw>]
provide the settings password
.IP
[\-\-settingspwfile <file>] provide a file containing the settings password
.PP
Commands:
.TP
list [\-\-long|\-l]
vms|runningvms|ostypes|hostdvds|hostfloppies|
bridgedifs|hostonlyifs|dhcpservers|hostinfo|
hostcpuids|hddbackends|hdds|dvds|floppies|
usbhost|usbfilters|systemproperties|extpacks|
groups
.TP
showvminfo
<uuid>|<name> [\-\-details]
[\-\-machinereadable]
.TP
showvminfo
<uuid>|<name> \fB\-\-log\fR <idx>
.TP
registervm
<filename>
.TP
unregistervm
<uuid>|<name> [\-\-delete]
.TP
createvm
\fB\-\-name\fR <name>
[\-\-groups <group>, ...]
[\-\-ostype <ostype>]
[\-\-register]
[\-\-basefolder <path>]
[\-\-uuid <uuid>]
.TP
modifyvm
<uuid|name>
[\-\-name <name>]
[\-\-groups <group>, ...]
[\-\-ostype <ostype>]
[\-\-memory <memorysize in MB>]
[\-\-pagefusion on|off]
[\-\-vram <vramsize in MB>]
[\-\-acpi on|off]
[\-\-pciattach 03:04.0]
[\-\-pciattach 03:04.0@02:01.0]
[\-\-pcidetach 03:04.0]
[\-\-ioapic on|off]
[\-\-pae on|off]
[\-\-hpet on|off]
[\-\-hwvirtex on|off]
[\-\-hwvirtexexcl on|off]
[\-\-nestedpaging on|off]
[\-\-largepages on|off]
[\-\-vtxvpid on|off]
[\-\-synthcpu on|off]
[\-\-cpuidset <leaf> <eax> <ebx> <ecx> <edx>]
[\-\-cpuidremove <leaf>]
[\-\-cpuidremoveall]
[\-\-hardwareuuid <uuid>]
[\-\-cpus <number>]
[\-\-cpuhotplug on|off]
[\-\-plugcpu <id>]
[\-\-unplugcpu <id>]
[\-\-cpuexecutioncap <1\-100>]
[\-\-rtcuseutc on|off]
[\-\-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]
[\-\-biossystemtimeoffset <msec>]
[\-\-biospxedebug on|off]
[\-\-boot<1\-4> none|floppy|dvd|disk|net>]
[\-\-nic<1\-N> none|null|nat|bridged|intnet|hostonly|
.IP
generic]
.IP
[\-\-nictype<1\-N> Am79C970A|Am79C973|
.IP
82540EM|82543GC|82545EM|
virtio]
.IP
[\-\-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>]
[\-\-natnet<1\-N> <network>|default]
[\-\-nicgenericdrv<1\-N> <driver>
[\-\-natsettings<1\-N> [<mtu>],[<socksnd>],
.IP
[<sockrcv>],[<tcpsnd>],
[<tcprcv>]]
.IP
[\-\-natpf<1\-N> [<rulename>],tcp|udp,[<hostip>],
.IP
<hostport>,[<guestip>],<guestport>]
.IP
[\-\-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],
.IP
[sameports]]
.IP
[\-\-macaddress<1\-N> auto|<mac>]
[\-\-mouse ps2|usb|usbtablet
[\-\-keyboard ps2|usb
[\-\-uart<1\-N> off|<I/O base> <IRQ>]
[\-\-uartmode<1\-N> disconnected|
.IP
server <pipe>|
client <pipe>|
file <file>|
<devicename>]
.IP
[\-\-lpt<1\-N> off|<I/O base> <IRQ>]
[\-\-lptmode<1\-N> <devicename>]
[\-\-guestmemoryballoon <balloonsize in MB>]
[\-\-gueststatisticsinterval <seconds>]
[\-\-audio none|null|oss|alsa|pulse]
[\-\-audiocontroller ac97|hda|sb16]
[\-\-clipboard disabled|hosttoguest|guesttohost|
.IP
bidirectional]
.IP
[\-\-draganddrop disabled|hosttoguest
[\-\-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>]
[\-\-usb on|off]
[\-\-usbehci on|off]
[\-\-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]
[\-\-usbwebcam on|off]
[\-\-usbcardreader on|off]
[\-\-autostart\-enabled on|off]
[\-\-autostart\-delay <seconds>]
.TP
clonevm
<uuid>|<name>
[\-\-snapshot <uuid>|<name>]
[\-\-mode machine|machineandchildren|all]
[\-\-options link|keepallmacs|keepnatmacs|
.IP
keepdisknames]
.IP
[\-\-name <name>]
[\-\-groups <group>, ...]
[\-\-basefolder <basefolder>]
[\-\-uuid <uuid>]
[\-\-register]
.TP
import
<ovf/ova>
[\-\-dry\-run|\-n]
[\-\-options keepallmacs|keepnatmacs]
[more options]
(run with \fB\-n\fR to have options displayed
.IP
for a particular OVF)
.TP
export
<machines> \fB\-\-output\fR|\-o <name>.<ovf/ova>
[\-\-legacy09|\-\-ovf09|\-\-ovf10|\-\-ovf20]
[\-\-manifest]
[\-\-vsys <number of virtual system>]
.IP
[\-\-product <product name>]
[\-\-producturl <product url>]
[\-\-vendor <vendor name>]
[\-\-vendorurl <vendor url>]
[\-\-version <version info>]
[\-\-eula <license text>]
[\-\-eulafile <filename>]
.TP
startvm
<uuid>|<name>...
[\-\-type gui|sdl|headless]
.TP
controlvm
<uuid>|<name>
pause|resume|reset|poweroff|savestate|
acpipowerbutton|acpisleepbutton|
keyboardputscancode <hex> [<hex> ...]|
setlinkstate<1\-N> on|off |
nic<1\-N> null|nat|bridged|intnet|hostonly|generic
.IP
[<devicename>] |
.IP
nictrace<1\-N> on|off
nictracefile<1\-N> <filename>
nicproperty<1\-N> name=[value]
natpf<1\-N> [<rulename>],tcp|udp,[<hostip>],
.IP
<hostport>,[<guestip>],<guestport>
.IP
natpf<1\-N> delete <rulename>
guestmemoryballoon <balloonsize in MB>]
gueststatisticsinterval <seconds>]
usbattach <uuid>|<address> |
usbdetach <uuid>|<address> |
clipboard disabled|hosttoguest|guesttohost|
.IP
bidirectional]
.IP
draganddrop disabled|hosttoguest]
vrde on|off |
vrdeport <port> |
vrdeproperty <name=[value]> |
vrdevideochannelquality <percent>
setvideomodehint <xres> <yres> <bpp>
.IP
[[<display>] [<enabled:yes|no>
.IP
[<xorigin> <yorigin>]]] |
.IP
screenshotpng <file> [display] |
setcredentials <username>
.IP
\fB\-\-passwordfile\fR <file> | <password>
<domain>
[\-\-allowlocallogon <yes|no>] |
.IP
teleport \fB\-\-host\fR <name> \fB\-\-port\fR <port>
.IP
[\-\-maxdowntime <msec>]
[\-\-passwordfile <file> |
.IP
\fB\-\-password\fR <password>]
.IP
plugcpu <id>
unplugcpu <id>
cpuexecutioncap <1\-100>
.TP
discardstate
<uuid>|<name>
.TP
adoptstate
<uuid>|<name> <state_file>
.TP
snapshot
<uuid>|<name>
take <name> [\-\-description <desc>] [\-\-pause] |
delete <uuid>|<name> |
restore <uuid>|<name> |
restorecurrent |
edit <uuid>|<name>|\-\-current
.IP
[\-\-name <name>]
[\-\-description <desc>] |
.IP
list [\-\-details|\-\-machinereadable]
showvminfo <uuid>|<name>
.TP
closemedium
disk|dvd|floppy <uuid>|<filename>
[\-\-delete]
.TP
storageattach
<uuid|vmname>
\fB\-\-storagectl\fR <name>
[\-\-port <number>]
[\-\-device <number>]
[\-\-type dvddrive|hdd|fdd]
[\-\-medium none|emptydrive|additions|
.IP
<uuid>|<filename>|host:<drive>|iscsi]
.IP
[\-\-mtype normal|writethrough|immutable|shareable|
.IP
readonly|multiattach]
.IP
[\-\-comment <text>]
[\-\-setuuid <uuid>]
[\-\-setparentuuid <uuid>]
[\-\-passthrough on|off]
[\-\-tempeject on|off]
[\-\-nonrotational on|off]
[\-\-discard on|off]
[\-\-bandwidthgroup <name>]
[\-\-forceunmount]
[\-\-server <name>|<ip>]
[\-\-target <target>]
[\-\-tport <port>]
[\-\-lun <lun>]
[\-\-encodedlun <lun>]
[\-\-username <username>]
[\-\-password <password>]
[\-\-initiator <initiator>]
[\-\-intnet]
.TP
storagectl
<uuid|vmname>
\fB\-\-name\fR <name>
[\-\-add ide|sata|scsi|floppy|sas]
[\-\-controller LSILogic|LSILogicSAS|BusLogic|
.IP
IntelAHCI|PIIX3|PIIX4|ICH6|I82078]
.IP
[\-\-sataportcount <1\-30>]
[\-\-hostiocache on|off]
[\-\-bootable on|off]
[\-\-remove]
.TP
bandwidthctl
<uuid|vmname>
add <name> \fB\-\-type\fR disk|network
.IP
\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] |
.IP
set <name>
.IP
\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] |
.IP
remove <name> |
list [\-\-machinereadable]
(limit units: k=kilobit, m=megabit, g=gigabit,
.IP
K=kilobyte, M=megabyte, G=gigabyte)
.TP
showhdinfo
<uuid>|<filename>
.TP
createhd
\fB\-\-filename\fR <filename>
[\-\-size <megabytes>|\-\-sizebyte <bytes>]
[\-\-diffparent <uuid>|<filename>
[\-\-format VDI|VMDK|VHD] (default: VDI)
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
.TP
modifyhd
<uuid>|<filename>
[\-\-type normal|writethrough|immutable|shareable|
.IP
readonly|multiattach]
.IP
[\-\-autoreset on|off]
[\-\-compact]
[\-\-resize <megabytes>|\-\-resizebyte <bytes>]
.TP
clonehd
<uuid>|<filename> <uuid>|<outputfile>
[\-\-format VDI|VMDK|VHD|RAW|<other>]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-existing]
.TP
convertfromraw
<filename> <outputfile>
[\-\-format VDI|VMDK|VHD]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-uuid <uuid>]
.TP
convertfromraw
stdin <outputfile> <bytes>
[\-\-format VDI|VMDK|VHD]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-uuid <uuid>]
.TP
getextradata
global|<uuid>|<name>
<key>|enumerate
.TP
setextradata
global|<uuid>|<name>
<key>
[<value>] (no value deletes key)
.TP
setproperty
machinefolder default|<folder> |
vrdeauthlibrary default|<library> |
websrvauthlibrary default|null|<library> |
vrdeextpack null|<library> |
autostartdbpath null|<folder> |
loghistorycount <value>
.TP
usbfilter
add <index,0\-N>
\fB\-\-target\fR <uuid>|<name>|global
\fB\-\-name\fR <string>
\fB\-\-action\fR 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>]
.TP
usbfilter
modify <index,0\-N>
\fB\-\-target\fR <uuid>|<name>|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>]
.TP
usbfilter
remove <index,0\-N>
\fB\-\-target\fR <uuid>|<name>|global
.TP
sharedfolder
add <vmname>|<uuid>
\fB\-\-name\fR <name> \fB\-\-hostpath\fR <hostpath>
[\-\-transient] [\-\-readonly] [\-\-automount]
.TP
sharedfolder
remove <vmname>|<uuid>
\fB\-\-name\fR <name> [\-\-transient]
.TP
guestproperty
get <vmname>|<uuid>
<property> [\-\-verbose]
.TP
guestproperty
set <vmname>|<uuid>
<property> [<value> [\-\-flags <flags>]]
.TP
guestproperty
enumerate <vmname>|<uuid>
[\-\-patterns <patterns>]
.TP
guestproperty
wait <vmname>|<uuid> <patterns>
[\-\-timeout <msec>] [\-\-fail\-on\-timeout]
.TP
guestcontrol
<vmname>|<uuid>
exec[ute]
\fB\-\-image\fR <path to program> \fB\-\-username\fR <name>
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
[\-\-domain <domain>] [\-\-verbose] [\-\-timeout <msec>]
[\-\-environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
[\-\-wait\-exit] [\-\-wait\-stdout] [\-\-wait\-stderr]
[\-\-dos2unix] [\-\-unix2dos]
[\-\- [<argument1>] ... [<argumentN>]]
.IP
copyfrom
<guest source> <host dest> \fB\-\-username\fR <name>
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
[\-\-domain <domain>] [\-\-verbose]
[\-\-dryrun] [\-\-follow] [\-\-recursive]
.IP
copyto|cp
<host source> <guest dest> \fB\-\-username\fR <name>
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
[\-\-domain <domain>] [\-\-verbose]
[\-\-dryrun] [\-\-follow] [\-\-recursive]
.IP
createdir[ectory]|mkdir|md
<guest directory>... \fB\-\-username\fR <name>
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
[\-\-domain <domain>] [\-\-verbose]
[\-\-parents] [\-\-mode <mode>]
.IP
stat
<file>... \fB\-\-username\fR <name>
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
[\-\-domain <domain>] [\-\-verbose]
.IP
updateadditions
[\-\-source <guest additions .ISO>] [\-\-verbose]
[\-\-wait\-start]
.TP
debugvm
<uuid>|<name>
dumpguestcore \fB\-\-filename\fR <name> |
info <item> [args] |
injectnmi |
log [\-\-release|\-\-debug] <settings> ...|
logdest [\-\-release|\-\-debug] <settings> ...|
logflags [\-\-release|\-\-debug] <settings> ...|
osdetect |
osinfo |
getregisters [\-\-cpu <id>] <reg>|all ... |
setregisters [\-\-cpu <id>] <reg>=<value> ... |
show [\-\-human\-readable|\-\-sh\-export|\-\-sh\-eval|
.IP
\fB\-\-cmd\-set]\fR
.IP
<logdbg\-settings|logrel\-settings>
[[opt] what ...] |
.IP
statistics [\-\-reset] [\-\-pattern <pattern>]
[\-\-descriptions]
.TP
metrics
list [*|host|<vmname> [<metric_list>]]
.IP
(comma\-separated)
.TP
metrics
setup
[\-\-period <seconds>] (default: 1)
[\-\-samples <count>] (default: 1)
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.TP
metrics
query [*|host|<vmname> [<metric_list>]]
.TP
metrics
enable
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.TP
metrics
disable
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.TP
metrics
collect
[\-\-period <seconds>] (default: 1)
[\-\-samples <count>] (default: 1)
[\-\-list]
[\-\-detach]
[*|host|<vmname> [<metric_list>]]
.TP
hostonlyif
ipconfig <name>
[\-\-dhcp |
\fB\-\-ip\fR<ipv4> [\-\-netmask<ipv4> (def: 255.255.255.0)] |
\fB\-\-ipv6\fR<ipv6> [\-\-netmasklengthv6<length> (def: 64)]]
create |
remove <name>
.TP
dhcpserver
add|modify \fB\-\-netname\fR <network_name> |
.IP
\fB\-\-ifname\fR <hostonly_if_name>
.IP
[\-\-ip <ip_address>
\fB\-\-netmask\fR <network_mask>
\fB\-\-lowerip\fR <lower_ip>
\fB\-\-upperip\fR <upper_ip>]
[\-\-enable | \fB\-\-disable]\fR
.TP
dhcpserver
remove \fB\-\-netname\fR <network_name> |
.IP
\fB\-\-ifname\fR <hostonly_if_name>
.TP
extpack
install [\-\-replace] <tarball> |
uninstall [\-\-force] <name> |
cleanup