.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
.TH VBOXMANAGE "1" "September 2010" "VBoxManage" "User Commands"
.SH NAME
VBoxManage \- x86 virtualization solution
.SH DESCRIPTION
Oracle VM VirtualBox Command Line Management Interface
(C) 2005\-2010 Oracle Corporation
All rights reserved.
.PP
Usage:
.PP
VBoxManage [\-v|\-\-version]    print version number and exit
VBoxManage [\-q|\-\-nologo] ... suppress the logo
.PP
VBoxManage list [\-\-long|\-l] vms|runningvms|ostypes|hostdvds|hostfloppies|
.IP
bridgedifs|hostonlyifs|dhcpservers|hostinfo|
hostcpuids|hddbackends|hdds|dvds|floppies|
usbhost|usbfilters|systemproperties
.PP
VBoxManage showvminfo       <uuid>|<name> [\-\-details] [\-\-statistics]
.IP
[\-\-machinereadable]
.PP
VBoxManage showvminfo       <uuid>|<name> \fB\-\-log\fR <idx>
.PP
VBoxManage registervm       <filename>
.PP
VBoxManage unregistervm     <uuid>|<name> [\-\-delete]
.PP
VBoxManage createvm         \fB\-\-name\fR <name>
.IP
[\-\-ostype <ostype>]
[\-\-register]
[\-\-basefolder <path> | \fB\-\-settingsfile\fR <path>]
[\-\-uuid <uuid>]
.PP
VBoxManage modifyvm         <uuid|name>
.IP
[\-\-name <name>]
[\-\-ostype <ostype>]
[\-\-memory <memorysize in MB>]
[\-\-pagefusion on|off]
[\-\-vram <vramsize in MB>]
[\-\-acpi on|off]
[\-\-ioapic on|off]
[\-\-pae on|off]
[\-\-hpet on|off]
[\-\-hwvirtex 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>]
[\-\-rtcuseutc on|off]
[\-\-monitorcount <number>]
[\-\-accelerate3d on|off]
[\-\-accelerate2dvideo on|off]
[\-\-firmware bios|efi|efi32|efi64]
[\-\-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
vde]
.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>]
[\-\-nicspeed<1\-N> <kbps>]
[\-\-nicbootprio<1\-N> <priority>]
[\-\-bridgeadapter<1\-N> none|<devicename>]
[\-\-hostonlyadapter<1\-N> none|<devicename>]
[\-\-intnet<1\-N> <network name>]
[\-\-natnet<1\-N> <network>|default]
[\-\-vdenet<1\-N> <network>|default]
[\-\-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>]
[\-\-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
[\-\-guestmemoryballoon <balloonsize in MB>]
[\-\-gueststatisticsinterval <seconds>]
[\-\-audio none|null|oss|alsa|pulse]
[\-\-audiocontroller ac97|sb16]
[\-\-clipboard disabled|hosttoguest|guesttohost|
.IP
bidirectional]
.IP
[\-\-usb on|off]
[\-\-usbehci on|off]
[\-\-snapshotfolder default|<path>]
[\-\-teleporter on|off]
[\-\-teleporterport <port>]
[\-\-teleporteraddress <address|empty>
[\-\-teleporterpassword <password>]
.PP
VBoxManage import           <ovf> [\-\-dry\-run|\-n] [more options]
.IP
(run with \fB\-n\fR to have options displayed
.IP
for a particular OVF)
.PP
VBoxManage export           <machines> \fB\-\-output\fR|\-o <ovf>
.IP
[\-\-legacy09]
[\-\-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>]
.PP
VBoxManage startvm          <uuid>|<name>
.IP
[\-\-type gui|sdl|headless]
.PP
VBoxManage controlvm        <uuid>|<name>
.IP
pause|resume|reset|poweroff|savestate|
acpipowerbutton|acpisleepbutton|
keyboardputscancode <hex> [<hex> ...]|
injectnmi|
setlinkstate<1\-N> on|off |
nic<1\-N> null|nat|bridged|intnet|hostonly
.IP
[<devicename>] |
.IP
nictrace<1\-N> on|off
nictracefile<1\-N> <filename>
guestmemoryballoon <balloonsize in MB>]
gueststatisticsinterval <seconds>]
usbattach <uuid>|<address> |
usbdetach <uuid>|<address> |
setvideomodehint <xres> <yres> <bpp> [display] |
setcredentials <username> <password> <domain>
.IP
[\-\-allowlocallogon <yes|no>] |
.IP
teleport \fB\-\-host\fR <name> \fB\-\-port\fR <port>
.IP
[\-\-maxdowntime <msec>] [\-\-password password]
.IP
plugcpu <id>
unplugcpu <id>
.PP
VBoxManage discardstate     <uuid>|<name>
.PP
VBoxManage adoptstate       <uuid>|<name> <state_file>
.PP
VBoxManage snapshot         <uuid>|<name>
.IP
take <name> [\-\-description <desc>] [\-\-pause] |
delete <uuid>|<name> |
restore <uuid>|<name> |
restorecurrent |
edit <uuid>|<name>|\-\-current
.IP
[\-\-name <name>]
[\-\-description <desc>] |
.IP
showvminfo <uuid>|<name>
.PP
VBoxManage openmedium       disk|dvd|floppy <filename>
.IP
[\-\-type normal|immutable|writethrough|
.IP
shareable] (disk only)
.IP
[\-\-uuid <uuid>]
[\-\-parentuuid <uuid>] (disk only)
.PP
VBoxManage closemedium      disk|dvd|floppy <uuid>|<filename>
.IP
[\-\-delete]
.PP
VBoxManage storageattach    <uuid|vmname>
.IP
\fB\-\-storagectl\fR <name>
\fB\-\-port\fR <number>
\fB\-\-device\fR <number>
[\-\-type dvddrive|hdd|fdd]
[\-\-medium none|emptydrive|
.IP
<uuid>|<filename>|host:<drive>]
.IP
[\-\-passthrough on|off]
[\-\-forceunmount]
.PP
VBoxManage storagectl       <uuid|vmname>
.IP
\fB\-\-name\fR <name>
[\-\-add ide|sata|scsi|floppy|sas]
[\-\-controller LSILogic|LSILogicSAS|BusLogic|
.IP
IntelAHCI|PIIX3|PIIX4|ICH6|I82078]
.IP
[\-\-sataideemulation<1\-4> <1\-30>]
[\-\-sataportcount <1\-30>]
[\-\-hostiocache on|off]
[\-\-remove]
.PP
VBoxManage showhdinfo       <uuid>|<filename>
.PP
VBoxManage createhd         \fB\-\-filename\fR <filename>
.IP
\fB\-\-size\fR <megabytes>
[\-\-format VDI|VMDK|VHD] (default: VDI)
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-type normal|writethrough|
.IP
shareable] (default: normal)
.IP
[\-\-comment <comment>]
[\-\-remember]
.PP
VBoxManage modifyhd         <uuid>|<filename>
.IP
[\-\-type normal|writethrough|immutable|shareable]
[\-\-autoreset on|off]
[\-\-compact]
.PP
VBoxManage clonehd          <uuid>|<filename> <outputfile>
.IP
[\-\-format VDI|VMDK|VHD|RAW|<other>]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-type normal|writethrough|immutable|shareable]
[\-\-remember] [\-\-existing]
.PP
VBoxManage convertfromraw   <filename> <outputfile>
.IP
[\-\-format VDI|VMDK|VHD]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
.PP
VBoxManage convertfromraw   stdin <outputfile> <bytes>
.IP
[\-\-format VDI|VMDK|VHD]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
.PP
VBoxManage addiscsidisk     \fB\-\-server\fR <name>|<ip>
.IP
\fB\-\-target\fR <target>
[\-\-port <port>]
[\-\-lun <lun>]
[\-\-encodedlun <lun>]
[\-\-username <username>]
[\-\-password <password>]
[\-\-type normal|writethrough|immutable|shareable]
[\-\-intnet]
.PP
VBoxManage getextradata     global|<uuid>|<name>
.IP
<key>|enumerate
.PP
VBoxManage setextradata     global|<uuid>|<name>
.IP
<key>
[<value>] (no value deletes key)
.PP
VBoxManage setproperty      hdfolder default|<folder> |
.IP
machinefolder default|<folder> |
vrdpauthlibrary default|<library> |
websrvauthlibrary default|null|<library> |
loghistorycount <value>
.PP
VBoxManage usbfilter        add <index,0\-N>
.IP
\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>]
.PP
VBoxManage usbfilter        modify <index,0\-N>
.IP
\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>]
.PP
VBoxManage usbfilter        remove <index,0\-N>
.IP
\fB\-\-target\fR <uuid>|<name>|global
.PP
VBoxManage sharedfolder     add <vmname>|<uuid>
.IP
\fB\-\-name\fR <name> \fB\-\-hostpath\fR <hostpath>
[\-\-transient] [\-\-readonly]
.PP
VBoxManage sharedfolder     remove <vmname>|<uuid>
.IP
\fB\-\-name\fR <name> [\-\-transient]
.PP
VBoxManage vmstatistics     <vmname>|<uuid> [\-\-reset]
.IP
[\-\-pattern <pattern>] [\-\-descriptions]
.PP
VBoxManage guestproperty    get <vmname>|<uuid>
.IP
<property> [\-\-verbose]
.PP
VBoxManage guestproperty    set <vmname>|<uuid>
.IP
<property> [<value> [\-\-flags <flags>]]
.PP
VBoxManage guestproperty    enumerate <vmname>|<uuid>
.IP
[\-\-patterns <patterns>]
.PP
VBoxManage guestproperty    wait <vmname>|<uuid> <patterns>
.IP
[\-\-timeout <msec>] [\-\-fail\-on\-timeout]
.PP
VBoxManage guestcontrol     execute <vmname>|<uuid>
.IP
<path to program>
\fB\-\-username\fR <name> \fB\-\-password\fR <password>
[\-\-arguments "<arguments>"]
[\-\-environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
[\-\-flags <flags>] [\-\-timeout <msec>]
[\-\-verbose] [\-\-wait\-for exit,stdout,stderr||]
.PP
VBoxManage metrics          list [*|host|<vmname> [<metric_list>]]
.IP
(comma\-separated)
.PP
VBoxManage metrics          setup
.IP
[\-\-period <seconds>] (default: 1)
[\-\-samples <count>] (default: 1)
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.PP
VBoxManage metrics          query [*|host|<vmname> [<metric_list>]]
.PP
VBoxManage metrics          enable
.IP
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.PP
VBoxManage metrics          disable
.IP
[\-\-list]
[*|host|<vmname> [<metric_list>]]
.PP
VBoxManage metrics          collect
.IP
[\-\-period <seconds>] (default: 1)
[\-\-samples <count>] (default: 1)
[\-\-list]
[\-\-detach]
[*|host|<vmname> [<metric_list>]]
.PP
VBoxManage hostonlyif       ipconfig <name>
.IP
[\-\-dhcp |
\fB\-\-ip\fR<ipv4> [\-\-netmask<ipv4> (def: 255.255.255.0)] |
\fB\-\-ipv6\fR<ipv6> [\-\-netmasklengthv6<length> (def: 64)]]
.PP
VBoxManage dhcpserver       add|modify \fB\-\-netname\fR <network_name> |
.IP
\fB\-\-ifname\fR <hostonly_if_name>
.IP
[\-\-ip <ip_address>
.IP
\fB\-\-netmask\fR <network_mask>
\fB\-\-lowerip\fR <lower_ip>
\fB\-\-upperip\fR <upper_ip>]
.IP
[\-\-enable | \fB\-\-disable]\fR
.PP
VBoxManage dhcpserver       remove \fB\-\-netname\fR <network_name> |
.IP
\fB\-\-ifname\fR <hostonly_if_name>