path: root/debian/manpages/VBoxManage.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.6.
.TH VBOXMANAGE "1" "January 2019" "VBoxManage" "User Commands"
.SH NAME
VBoxManage \- x86 virtualization solution
.SH DESCRIPTION
Oracle VM VirtualBox Command Line Management Interface
(C) 2005\-2019 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
[@<response\-file>]        load arguments from the given response file (bourne style)
.PP
Commands:
.TP
list [\-\-long|\-l] [\-\-sorted|\-s]
vms|runningvms|ostypes|hostdvds|hostfloppies|
.TP
intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|
hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|
usbhost|usbfilters|systemproperties|extpacks|
groups|webcams|screenshotformats|cloudproviders|
cloudprofiles
.TP
showvminfo
<uuid|vmname> [\-\-details]
[\-\-machinereadable]
.TP
showvminfo
<uuid|vmname> \fB\-\-log\fR <idx>
.TP
registervm
<filename>
.TP
unregistervm
<uuid|vmname> [\-\-delete]
.TP
createvm
\fB\-\-name\fR <name>
[\-\-groups <group>, ...]
[\-\-ostype <ostype>]
[\-\-register]
[\-\-basefolder <path>]
[\-\-uuid <uuid>]
[\-\-default]
.TP
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]
[\-\-pciattach 03:04.0]
[\-\-pciattach 03:04.0@02:01.0]
[\-\-pcidetach 03:04.0]
[\-\-ioapic on|off]
[\-\-hpet on|off]
[\-\-triplefaultreset on|off]
[\-\-apic on|off]
[\-\-x2apic on|off]
[\-\-paravirtprovider none|default|legacy|minimal|
.TP
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]
[\-\-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]
[\-\-boot<1\-4> none|floppy|dvd|disk|net>]
[\-\-nic<1\-N> none|null|nat|bridged|intnet|hostonly|
.TP
generic|natnetwork]
[\-\-nictype<1\-N> Am79C970A|Am79C973|
.TP
82540EM|82543GC|82545EM|
virtio]
.TP
[\-\-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>],
.TP
[<sockrcv>],[<tcpsnd>],
[<tcprcv>]]
.TP
[\-\-natpf<1\-N> [<rulename>],tcp|udp,[<hostip>],
<hostport>,[<guestip>],<guestport>]
.TP
[\-\-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],
.TP
[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|
.TP
server <pipe>|
client <pipe>|
tcpserver <port>|
tcpclient <hostname:port>|
file <file>|
<devicename>]
.TP
[\-\-uarttype<1\-N> 16450|16550A|16750
[\-\-lpt<1\-N> off|<I/O base> <IRQ>]
[\-\-lptmode<1\-N> <devicename>]
[\-\-guestmemoryballoon <balloonsize in MB>]
[\-\-audio none|null|oss|alsa|pulse]
[\-\-audioin on|off]
[\-\-audioout on|off]
[\-\-audiocontroller ac97|hda|sb16]
[\-\-audiocodec stac9700|ad1980|stac9221|sb16]
[\-\-clipboard disabled|hosttoguest|guesttohost|
.TP
bidirectional]
[\-\-draganddrop disabled|hosttoguest|guesttohost|
.TP
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]
[\-\-recording screens all|<screen ID> [<screen ID> ...]]
[\-\-recording filename <filename>]
[\-\-recording videores <width> <height>]
[\-\-recording videorate <rate>]
[\-\-recording videofps <fps>]
[\-\-recording maxtime <s>]
[\-\-recording maxfilesize <MB>]
[\-\-recording opts <key=value> [,<key=value> ...]]
[\-\-defaultfrontend default|<name>]
.TP
clonevm
<uuid|vmname>
[\-\-snapshot <uuid>|<name>]
[\-\-mode machine|machineandchildren|all]
[\-\-options link|keepallmacs|keepnatmacs|
.TP
keepdisknames|keephwuuids]
[\-\-name <name>]
[\-\-groups <group>, ...]
[\-\-basefolder <basefolder>]
[\-\-uuid <uuid>]
[\-\-register]
.TP
movevm
<uuid|vmname>
\fB\-\-type\fR basic
[\-\-folder <path>]
.TP
import
<ovfname/ovaname>
[\-\-dry\-run|\-n]
[\-\-options keepallmacs|keepnatmacs|importtovdi]
[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/tar.gz>
[\-\-legacy09|\-\-ovf09|\-\-ovf10|\-\-ovf20|\-\-opc10]
[\-\-manifest]
[\-\-iso]
[\-\-options manifest|iso|nomacs|nomacsbutnat]
[\-\-vsys <number of virtual system>]
.TP
[\-\-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>]
.TP
[\-\-cloud <number of virtual system>]
[\-\-vmname <name>]
[\-\-cloudprofile <cloud profile name>]
[\-\-cloudshape <shape>]
[\-\-clouddomain <domain>]
[\-\-clouddisksize <disk size in GB>]
[\-\-cloudbucket <bucket name>]
[\-\-cloudocivcn <OCI vcn id>]
[\-\-cloudocisubnet <OCI subnet id>]
[\-\-cloudkeepobject <true/false>]
[\-\-cloudlaunchinstance <true/false>]
[\-\-cloudpublicip <true/false>]
.TP
startvm
<uuid|vmname>...
[\-\-type gui|sdl|headless|separate]
[\-E|\-\-putenv <NAME>[=<VALUE>]]
.TP
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|
.TP
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>],
.TP
<hostport>,[<guestip>],<guestport> |
natpf<1\-N> delete <rulename> |
guestmemoryballoon <balloonsize in MB> |
usbattach <uuid>|<address>
.TP
[\-\-capturefile <filename>] |
usbdetach <uuid>|<address> |
audioin on|off |
audioout on|off |
clipboard disabled|hosttoguest|guesttohost|
.TP
bidirectional |
draganddrop disabled|hosttoguest|guesttohost|
.TP
bidirectional |
vrde on|off |
vrdeport <port> |
vrdeproperty <name=[value]> |
vrdevideochannelquality <percent> |
setvideomodehint <xres> <yres> <bpp>
.TP
[[<display>] [<enabled:yes|no> |
[<xorigin> <yorigin>]]] |
.TP
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>
.TP
\fB\-\-passwordfile\fR <file> | <password>
<domain>
[\-\-allowlocallogon <yes|no>] |
.TP
teleport \fB\-\-host\fR <name> \fB\-\-port\fR <port>
[\-\-maxdowntime <msec>]
[\-\-passwordfile <file> |
.TP
\fB\-\-password\fR <password>] |
plugcpu <id> |
unplugcpu <id> |
cpuexecutioncap <1\-100>
webcam <attach [path [settings]]> | <detach [path]> | <list>
addencpassword <id>
.TP
<password file>|\-
[\-\-removeonsuspend <yes|no>]
.TP
removeencpassword <id>
removeallencpasswords
changeuartmode<1\-N> disconnected|
.TP
server <pipe>|
client <pipe>|
tcpserver <port>|
tcpclient <hostname:port>|
file <file>|
<devicename>]
.TP
discardstate
<uuid|vmname>
.TP
adoptstate
<uuid|vmname> <state_file>
.TP
snapshot
<uuid|vmname>
take <name> [\-\-description <desc>] [\-\-live]
.TP
[\-\-uniquename Number,Timestamp,Space,Force] |
delete <uuid|snapname> |
restore <uuid|snapname> |
restorecurrent |
edit <uuid|snapname>|\-\-current
.TP
[\-\-name <name>]
[\-\-description <desc>] |
.TP
list [\-\-details|\-\-machinereadable] |
showvminfo <uuid|snapname>
.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|
.TP
<uuid|filename>|host:<drive>|iscsi]
[\-\-mtype normal|writethrough|immutable|shareable|
.TP
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]
.TP
storagectl
<uuid|vmname>
\fB\-\-name\fR <name>
[\-\-add ide|sata|scsi|floppy|sas|usb|pcie]
[\-\-controller LSILogic|LSILogicSAS|BusLogic|
.TP
IntelAHCI|PIIX3|PIIX4|ICH6|I82078|
[             USB|NVMe]
[\-\-portcount <1\-n>]
[\-\-hostiocache on|off]
[\-\-bootable on|off]
[\-\-rename <name>]
[\-\-remove]
.TP
bandwidthctl
<uuid|vmname>
add <name> \fB\-\-type\fR disk|network
.TP
\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] |
set <name>
.TP
\fB\-\-limit\fR <megabytes per second>[k|m|g|K|M|G] |
remove <name> |
list [\-\-machinereadable]
(limit units: k=kilobit, m=megabit, g=gigabit,
.IP
K=kilobyte, M=megabyte, G=gigabyte)
.TP
showmediuminfo
[disk|dvd|floppy] <uuid|filename>
.TP
createmedium
[disk|dvd|floppy] \fB\-\-filename\fR <filename>
[\-\-size <megabytes>|\-\-sizebyte <bytes>]
[\-\-diffparent <uuid>|<filename>
[\-\-format VDI|VMDK|VHD] (default: VDI)
[\-\-variant Standard,Fixed,Split2G,Stream,ESX,
.IP
Formatted]
.TP
modifymedium
[disk|dvd|floppy] <uuid|filename>
[\-\-type normal|writethrough|immutable|shareable|
.TP
readonly|multiattach]
[\-\-autoreset on|off]
[\-\-property <name=[value]>]
[\-\-compact]
[\-\-resize <megabytes>|\-\-resizebyte <bytes>]
[\-\-move <path>]
[\-\-setlocation <path>]
[\-\-description <description string>]
.TP
clonemedium
[disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>
[\-\-format VDI|VMDK|VHD|RAW|<other>]
[\-\-variant Standard,Fixed,Split2G,Stream,ESX]
[\-\-existing]
.TP
mediumproperty
[disk|dvd|floppy] set <uuid|filename>
<property> <value>
.TP
[disk|dvd|floppy] get <uuid|filename>
<property>
.TP
[disk|dvd|floppy] delete <uuid|filename>
<property>
.TP
encryptmedium
<uuid|filename>
[\-\-newpassword <file>|\-]
[\-\-oldpassword <file>|\-]
[\-\-cipher <cipher identifier>]
[\-\-newpasswordid <password identifier>]
.TP
checkmediumpwd
<uuid|filename>
<pwd file>|\-
.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|vmname>
<key>|[enumerate]
.TP
setextradata
global|<uuid|vmname>
<key>
[<value>] (no value deletes key)
.TP
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>
.TP
usbfilter
add <index,0\-N>
\fB\-\-target\fR <uuid|vmname>|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|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>]
.TP
usbfilter
remove <index,0\-N>
\fB\-\-target\fR <uuid|vmname>|global
.TP
sharedfolder
add <uuid|vmname>
\fB\-\-name\fR <name> \fB\-\-hostpath\fR <hostpath>
[\-\-transient] [\-\-readonly] [\-\-automount]
.TP
sharedfolder
remove <uuid|vmname>
\fB\-\-name\fR <name> [\-\-transient]
.TP
guestproperty
get <uuid|vmname>
<property> [\-\-verbose]
.TP
guestproperty
set <uuid|vmname>
<property> [<value> [\-\-flags <flags>]]
.TP
guestproperty
delete|unset <uuid|vmname>
<property>
.TP
guestproperty
enumerate <uuid|vmname>
[\-\-patterns <patterns>]
.TP
guestproperty
wait <uuid|vmname> <patterns>
[\-\-timeout <msec>] [\-\-fail\-on\-timeout]
.TP
guestcontrol
<uuid|vmname> [\-\-verbose|\-v] [\-\-quiet|\-q]
.TP
[\-\-username <name>] [\-\-domain <domain>]
[\-\-passwordfile <file> | \fB\-\-password\fR <password>]
.TP
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]
\fB\-\-\fR <program/arg0> [argument1] ... [argumentN]]
.TP
start [common\-options]
[\-\-exe <path to executable>] [\-\-timeout <msec>]
[\-E|\-\-putenv <NAME>[=<VALUE>]] [\-\-unquoted\-args]
[\-\-ignore\-operhaned\-processes] [\-\-profile]
\fB\-\-\fR <program/arg0> [argument1] ... [argumentN]]
.TP
copyfrom [common\-options]
[\-\-follow] [\-R|\-\-recursive]
<guest\-src0> [guest\-src1 [...]] <host\-dst>
.TP
copyfrom [common\-options]
[\-\-follow] [\-R|\-\-recursive]
[\-\-target\-directory <host\-dst\-dir>]
<guest\-src0> [guest\-src1 [...]]
.TP
copyto [common\-options]
[\-\-follow] [\-R|\-\-recursive]
<host\-src0> [host\-src1 [...]] <guest\-dst>
.TP
copyto [common\-options]
[\-\-follow] [\-R|\-\-recursive]
[\-\-target\-directory <guest\-dst>]
<host\-src0> [host\-src1 [...]]
.TP
mkdir|createdir[ectory] [common\-options]
[\-\-parents] [\-\-mode <mode>]
<guest directory> [...]
.TP
rmdir|removedir[ectory] [common\-options]
[\-R|\-\-recursive]
<guest directory> [...]
.TP
removefile|rm [common\-options] [\-f|\-\-force]
<guest file> [...]
.TP
mv|move|ren[ame] [common\-options]
<source> [source1 [...]] <dest>
.TP
mktemp|createtemp[orary] [common\-options]
[\-\-secure] [\-\-mode <mode>] [\-\-tmpdir <directory>]
<template>
.TP
stat [common\-options]
<file> [...]
.TP
guestcontrol
<uuid|vmname> [\-\-verbose|\-v] [\-\-quiet|\-q]
.IP
list <all|sessions|processes|files> [common\-opts]
.TP
closeprocess [common\-options]
<   \fB\-\-session\-id\fR <ID>
.TP
| \fB\-\-session\-name\fR <name or pattern>
<PID1> [PID1 [...]]
.TP
closesession [common\-options]
<  \fB\-\-all\fR | \fB\-\-session\-id\fR <ID>
.IP
| \fB\-\-session\-name\fR <name or pattern> >
.TP
updatega|updateguestadditions|updateadditions
[\-\-source <guest additions .ISO>]
[\-\-wait\-start] [common\-options]
[\-\- [<argument1>] ... [<argumentN>]]
.IP
watch [common\-options]
.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
natnetwork
add \fB\-\-netname\fR <name>
\fB\-\-network\fR <network>
[\-\-enable|\-\-disable]
[\-\-dhcp on|off]
[\-\-port\-forward\-4 <rule>]
[\-\-loopback\-4 <rule>]
[\-\-ipv6 on|off]
[\-\-port\-forward\-6 <rule>]
[\-\-loopback\-6 <rule>]
.TP
natnetwork
remove \fB\-\-netname\fR <name>
.TP
natnetwork
modify \fB\-\-netname\fR <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>]
.TP
natnetwork
start \fB\-\-netname\fR <name>
.TP
natnetwork
stop \fB\-\-netname\fR <name>
.TP
natnetwork
list [<pattern>]
.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> |
.TP
\fB\-\-ifname\fR <hostonly_if_name>
[\-\-ip <ip_address>
\fB\-\-netmask\fR <network_mask>
\fB\-\-lowerip\fR <lower_ip>
\fB\-\-upperip\fR <upper_ip>]
[\-\-enable | \fB\-\-disable]\fR
[\-\-options [\-\-vm <name> \fB\-\-nic\fR <1\-N>]
.TP
\fB\-\-id\fR <number> [\-\-value <string> | \fB\-\-remove]]\fR
(multiple options allowed after \fB\-\-options\fR)
.TP
dhcpserver
remove \fB\-\-netname\fR <network_name> |
.IP
\fB\-\-ifname\fR <hostonly_if_name>
.TP
usbdevsource
add <source name>
\fB\-\-backend\fR <backend>
\fB\-\-address\fR <address>
.TP
usbdevsource
remove <source name>
.IP
Medium content access:
.IP
VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] formatfat [\-\-quick]
.IP
VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] cat [\-\-hex] [\-\-offset=byte\-offset] [\-\-size=bytes] [\-\-output=\-|filename]
.IP
VBoxManage mediumio <[\-\-disk=uuid|filename] | [\-\-dvd=uuid|filename] | [\-\-floppy=uuid|filename]> [\-\-password\-file\-|filename] stream [\-\-format=image\-format] [\-\-variant=image\-variant] [\-\-output=\-|filename]
.IP
Introspection and guest debugging:
.IP
VBoxManage debugvm <uuid|vmname> dumpvmcore [\-\-filename=name]
.IP
VBoxManage debugvm <uuid|vmname> info <item> [args...]
.IP
VBoxManage debugvm <uuid|vmname> injectnmi
.IP
VBoxManage debugvm <uuid|vmname> log [[\-\-release] | [\-\-debug]] [group\-settings...]
.IP
VBoxManage debugvm <uuid|vmname> logdest [[\-\-release] | [\-\-debug]] [destinations...]
.IP
VBoxManage debugvm <uuid|vmname> logflags [[\-\-release] | [\-\-debug]] [flags...]
.IP
VBoxManage debugvm <uuid|vmname> osdetect
.IP
VBoxManage debugvm <uuid|vmname> osinfo
.IP
VBoxManage debugvm <uuid|vmname> osdmesg [\-\-lines=lines]
.IP
VBoxManage debugvm <uuid|vmname> getregisters [\-\-cpu=id] [reg\-set.reg\-name...]
.IP
VBoxManage debugvm <uuid|vmname> setregisters [\-\-cpu=id] [reg\-set.reg\-name=value...]
.IP
VBoxManage debugvm <uuid|vmname> show [[\-\-human\-readable] | [\-\-sh\-export] | [\-\-sh\-eval] | [\-\-cmd\-set]] [settings\-item...]
.IP
VBoxManage debugvm <uuid|vmname> stack [\-\-cpu=id]
.IP
VBoxManage debugvm <uuid|vmname> statistics [\-\-reset] [\-\-descriptions] [\-\-pattern=pattern]
.IP
Extension package management:
.IP
VBoxManage extpack install [\-\-replace] <tarball>
.IP
VBoxManage extpack uninstall [\-\-force] <name>
.IP
VBoxManage extpack cleanup
.IP
Unattended guest OS installation:
.IP
VBoxManage unattended detect <\-\-iso=install\-iso> [\-\-machine\-readable]
.IP
VBoxManage unattended install <uuid|vmname> <\-\-iso=install\-iso> [\-\-user=login] [\-\-password=password] [\-\-password\-file=file] [\-\-full\-user\-name=name] [\-\-key=product\-key] [\-\-install\-additions]
.IP
[\-\-no\-install\-additions] [\-\-additions\-iso=add\-iso] [\-\-install\-txs] [\-\-no\-install\-txs] [\-\-validation\-kit\-iso=testing\-iso] [\-\-locale=ll_CC] [\-\-country=CC] [\-\-time\-zone=tz] [\-\-hostname=fqdn]
[\-\-package\-selection\-adjustment=keyword] [\-\-dry\-run] [\-\-auxiliary\-base\-path=path] [\-\-image\-index=number] [\-\-script\-template=file] [\-\-post\-install\-template=file] [\-\-post\-install\-command=command]
[\-\-extra\-install\-kernel\-parameters=params] [\-\-language=lang] [\-\-start\-vm=session\-type]