.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.3. .TH VBOXMANAGE "1" "June 2016" "VBoxManage" "User Commands" .SH NAME VBoxManage \- x86 virtualization solution .SH DESCRIPTION Oracle VM VirtualBox Command Line Management Interface3 (C) 2005\-2016 Oracle Corporation All rights reserved. .PP Usage: .IP VBoxManage [] .PP General Options: .TP [\-v|\-\-version] print version number and exit .TP [\-q|\-\-nologo] suppress the logo .TP [\-\-settingspw ] provide the settings password .IP [\-\-settingspwfile ] provide a file containing the settings password .PP Commands: .TP list [\-\-long|\-l] vms|runningvms|ostypes|hostdvds|hostfloppies| intnets|bridgedifs|hostonlyifs|natnets|dhcpservers| hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies| usbhost|usbfilters|systemproperties|extpacks| groups|webcams|screenshotformats .TP showvminfo [\-\-details] [\-\-machinereadable] .TP showvminfo \fB\-\-log\fR .TP registervm .TP unregistervm [\-\-delete] .TP createvm \fB\-\-name\fR [\-\-groups , ...] [\-\-ostype ] [\-\-register] [\-\-basefolder ] [\-\-uuid ] .TP modifyvm [\-\-name ] [\-\-groups , ...] [\-\-description ] [\-\-ostype ] [\-\-iconfile ] [\-\-memory ] [\-\-pagefusion on|off] [\-\-vram ] [\-\-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 [, ...]] [\-\-hwvirtex on|off] [\-\-nestedpaging on|off] [\-\-largepages on|off] [\-\-vtxvpid on|off] [\-\-vtxux on|off] [\-\-pae on|off] [\-\-longmode on|off] [\-\-cpu\-profile "host|Intel 80[86|286|386]"] [\-\-cpuid\-portability\-level <0..3> [\-\-cpuidset ] [\-\-cpuidremove ] [\-\-cpuidremoveall] [\-\-hardwareuuid ] [\-\-cpus ] [\-\-cpuhotplug on|off] [\-\-plugcpu ] [\-\-unplugcpu ] [\-\-cpuexecutioncap <1\-100>] [\-\-rtcuseutc on|off] [\-\-graphicscontroller none|vboxvga|vmsvga] [\-\-monitorcount ] [\-\-accelerate3d on|off] [\-\-accelerate2dvideo on|off] [\-\-firmware bios|efi|efi32|efi64] [\-\-chipset ich9|piix3] [\-\-bioslogofadein on|off] [\-\-bioslogofadeout on|off] [\-\-bioslogodisplaytime ] [\-\-bioslogoimagepath ] [\-\-biosbootmenu disabled|menuonly|messageandmenu] [\-\-biosapic disabled|apic|x2apic] [\-\-biossystemtimeoffset ] [\-\-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> ] [\-\-nicproperty<1\-N> name=[value]] [\-\-nicspeed<1\-N> ] [\-\-nicbootprio<1\-N> ] [\-\-nicpromisc<1\-N> deny|allow\-vms|allow\-all] [\-\-nicbandwidthgroup<1\-N> none|] [\-\-bridgeadapter<1\-N> none|] [\-\-hostonlyadapter<1\-N> none|] [\-\-intnet<1\-N> ] [\-\-nat\-network<1\-N> ] [\-\-nicgenericdrv<1\-N> [\-\-natnet<1\-N> |default] [\-\-natsettings<1\-N> [],[], .TP [],[], []] .TP [\-\-natpf<1\-N> [],tcp|udp,[], ,[],] .TP [\-\-natpf<1\-N> delete ] [\-\-nattftpprefix<1\-N> ] [\-\-nattftpfile<1\-N> ] [\-\-nattftpserver<1\-N> ] [\-\-natbindip<1\-N> [\-\-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|] [\-\-mouse ps2|usb|usbtablet|usbmultitouch] [\-\-keyboard ps2|usb [\-\-uart<1\-N> off| ] [\-\-uartmode<1\-N> disconnected| .TP server | client | tcpserver | tcpclient | file | ] .TP [\-\-lpt<1\-N> off| ] [\-\-lptmode<1\-N> ] [\-\-guestmemoryballoon ] [\-\-audio none|null|oss|alsa|pulse] [\-\-audiocontroller ac97|hda|sb16] [\-\-audiocodec stac9700|ad1980|stac9221|sb16] [\-\-clipboard disabled|hosttoguest|guesttohost| .TP bidirectional] [\-\-draganddrop disabled|hosttoguest] [\-\-vrde on|off] [\-\-vrdeextpack default| [\-\-vrdeproperty ] [\-\-vrdeport ] [\-\-vrdeaddress ] [\-\-vrdeauthtype null|external|guest] [\-\-vrdeauthlibrary default| [\-\-vrdemulticon on|off] [\-\-vrdereusecon on|off] [\-\-vrdevideochannel on|off] [\-\-vrdevideochannelquality ] [\-\-usb on|off] [\-\-usbehci on|off] [\-\-usbxhci on|off] [\-\-usbrename ] [\-\-snapshotfolder default|] [\-\-teleporter on|off] [\-\-teleporterport ] [\-\-teleporteraddress [\-\-teleporterpassword ] [\-\-teleporterpasswordfile |stdin] [\-\-tracing\-enabled on|off] [\-\-tracing\-config ] [\-\-tracing\-allow\-vm\-access on|off] [\-\-usbcardreader on|off] [\-\-autostart\-enabled on|off] [\-\-autostart\-delay ] [\-\-videocap on|off] [\-\-videocapscreens all| [ ...]] [\-\-videocapfile ] [\-\-videocapres ] [\-\-videocaprate ] [\-\-videocapfps ] [\-\-videocapmaxtime ] [\-\-videocapmaxsize ] [\-\-videocapopts [, ...]] [\-\-defaultfrontend default|] .TP clonevm [\-\-snapshot |] [\-\-mode machine|machineandchildren|all] [\-\-options link|keepallmacs|keepnatmacs| .TP keepdisknames] [\-\-name ] [\-\-groups , ...] [\-\-basefolder ] [\-\-uuid ] [\-\-register] .TP import [\-\-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 \fB\-\-output\fR|\-o . [\-\-legacy09|\-\-ovf09|\-\-ovf10|\-\-ovf20] [\-\-manifest] [\-\-iso] [\-\-options manifest|iso|nomacs|nomacsbutnat] [\-\-vsys ] .TP [\-\-product ] [\-\-producturl ] [\-\-vendor ] [\-\-vendorurl ] [\-\-version ] [\-\-description ] [\-\-eula ] [\-\-eulafile ] .TP startvm ... [\-\-type gui|sdl|headless|separate] .TP controlvm pause|resume|reset|poweroff|savestate| acpipowerbutton|acpisleepbutton| keyboardputscancode [ ...]| setlinkstate<1\-N> on|off | nic<1\-N> null|nat|bridged|intnet|hostonly|generic| .TP natnetwork [] | nictrace<1\-N> on|off | nictracefile<1\-N> | nicproperty<1\-N> name=[value] | nicpromisc<1\-N> deny|allow\-vms|allow\-all | natpf<1\-N> [],tcp|udp,[], .TP ,[], | natpf<1\-N> delete | guestmemoryballoon | usbattach |
.TP [\-\-capturefile ] | usbdetach |
| clipboard disabled|hosttoguest|guesttohost| .TP bidirectional | draganddrop disabled|hosttoguest | vrde on|off | vrdeport | vrdeproperty | vrdevideochannelquality | setvideomodehint .TP [[] [ | [ ]]] | .TP screenshotpng [display] | videocap on|off | videocapscreens all|none|,[...] | videocapfile videocapres x videocaprate videocapfps videocapmaxtime videocapmaxsize setcredentials .TP \fB\-\-passwordfile\fR | [\-\-allowlocallogon ] | .TP teleport \fB\-\-host\fR \fB\-\-port\fR [\-\-maxdowntime ] [\-\-passwordfile | .TP \fB\-\-password\fR ] | plugcpu | unplugcpu | cpuexecutioncap <1\-100> webcam | | addencpassword .TP |\- [\-\-removeonsuspend ] .TP removeencpassword removeallencpasswords .TP discardstate .TP adoptstate .TP snapshot take [\-\-description ] [\-\-live] .TP [\-\-uniquename Number,Timestamp,Space,Force] | delete | restore | restorecurrent | edit |\-\-current .TP [\-\-name ] [\-\-description ] | .TP list [\-\-details|\-\-machinereadable] showvminfo .TP closemedium [disk|dvd|floppy] [\-\-delete] .TP storageattach \fB\-\-storagectl\fR [\-\-port ] [\-\-device ] [\-\-type dvddrive|hdd|fdd] [\-\-medium none|emptydrive|additions| .TP |host:|iscsi] [\-\-mtype normal|writethrough|immutable|shareable| .TP readonly|multiattach] [\-\-comment ] [\-\-setuuid ] [\-\-setparentuuid ] [\-\-passthrough on|off] [\-\-tempeject on|off] [\-\-nonrotational on|off] [\-\-discard on|off] [\-\-hotpluggable on|off] [\-\-bandwidthgroup ] [\-\-forceunmount] [\-\-server |] [\-\-target ] [\-\-tport ] [\-\-lun ] [\-\-encodedlun ] [\-\-username ] [\-\-password ] [\-\-initiator ] [\-\-intnet] .TP storagectl \fB\-\-name\fR [\-\-add ide|sata|scsi|floppy|sas|pcie] [\-\-controller LSILogic|LSILogicSAS|BusLogic| .TP IntelAHCI|PIIX3|PIIX4|ICH6|I82078|NVMe] [\-\-portcount <1\-n>] [\-\-hostiocache on|off] [\-\-bootable on|off] [\-\-rename ] [\-\-remove] .TP bandwidthctl add \fB\-\-type\fR disk|network .TP \fB\-\-limit\fR [k|m|g|K|M|G] | set .TP \fB\-\-limit\fR [k|m|g|K|M|G] | remove | list [\-\-machinereadable] (limit units: k=kilobit, m=megabit, g=gigabit, .IP K=kilobyte, M=megabyte, G=gigabyte) .TP showmediuminfo [disk|dvd|floppy] .TP createmedium [disk|dvd|floppy] \fB\-\-filename\fR [\-\-size |\-\-sizebyte ] [\-\-diffparent | [\-\-format VDI|VMDK|VHD] (default: VDI) [\-\-variant Standard,Fixed,Split2G,Stream,ESX] .TP modifymedium [disk|dvd|floppy] [\-\-type normal|writethrough|immutable|shareable| .TP readonly|multiattach] [\-\-autoreset on|off] [\-\-property ] [\-\-compact] [\-\-resize |\-\-resizebyte ] [\-\-move ] .TP clonemedium [disk|dvd|floppy] [\-\-format VDI|VMDK|VHD|RAW|] [\-\-variant Standard,Fixed,Split2G,Stream,ESX] [\-\-existing] .TP mediumproperty [disk|dvd|floppy] set .TP [disk|dvd|floppy] get .TP [disk|dvd|floppy] delete .TP encryptmedium [\-\-newpassword |\-] [\-\-oldpassword |\-] [\-\-cipher ] [\-\-newpasswordid ] .TP checkmediumpwd |\- .TP convertfromraw [\-\-format VDI|VMDK|VHD] [\-\-variant Standard,Fixed,Split2G,Stream,ESX] [\-\-uuid ] .TP convertfromraw stdin [\-\-format VDI|VMDK|VHD] [\-\-variant Standard,Fixed,Split2G,Stream,ESX] [\-\-uuid ] .TP getextradata global| |enumerate .TP setextradata global| [] (no value deletes key) .TP setproperty machinefolder default| | hwvirtexclusive on|off | vrdeauthlibrary default| | websrvauthlibrary default|null| | vrdeextpack null| | autostartdbpath null| | loghistorycount defaultfrontend default| logginglevel .TP usbfilter add \fB\-\-target\fR |global \fB\-\-name\fR \fB\-\-action\fR ignore|hold (global filters only) [\-\-active yes|no] (yes) [\-\-vendorid ] (null) [\-\-productid ] (null) [\-\-revision ] (null) [\-\-manufacturer ] (null) [\-\-product ] (null) [\-\-remote yes|no] (null, VM filters only) [\-\-serialnumber ] (null) [\-\-maskedinterfaces ] .TP usbfilter modify \fB\-\-target\fR |global [\-\-name ] [\-\-action ignore|hold] (global filters only) [\-\-active yes|no] [\-\-vendorid |""] [\-\-productid |""] [\-\-revision |""] [\-\-manufacturer |""] [\-\-product |""] [\-\-remote yes|no] (null, VM filters only) [\-\-serialnumber |""] [\-\-maskedinterfaces ] .TP usbfilter remove \fB\-\-target\fR |global .TP sharedfolder add \fB\-\-name\fR \fB\-\-hostpath\fR [\-\-transient] [\-\-readonly] [\-\-automount] .TP sharedfolder remove \fB\-\-name\fR [\-\-transient] .TP guestproperty get [\-\-verbose] .TP guestproperty set [ [\-\-flags ]] .TP guestproperty delete|unset .TP guestproperty enumerate [\-\-patterns ] .TP guestproperty wait [\-\-timeout ] [\-\-fail\-on\-timeout] .TP guestcontrol [\-\-verbose|\-v] [\-\-quiet|\-q] .TP [\-\-username ] [\-\-domain ] [\-\-passwordfile | \fB\-\-password\fR ] .TP run [common\-options] [\-\-exe ] [\-\-timeout ] [\-E|\-\-putenv [=]] [\-\-unquoted\-args] [\-\-ignore\-operhaned\-processes] [\-\-no\-profile] [\-\-no\-wait\-stdout|\-\-wait\-stdout] [\-\-no\-wait\-stderr|\-\-wait\-stderr] [\-\-dos2unix] [\-\-unix2dos] \fB\-\-\fR [argument1] ... [argumentN]] .TP start [common\-options] [\-\-exe ] [\-\-timeout ] [\-E|\-\-putenv [=]] [\-\-unquoted\-args] [\-\-ignore\-operhaned\-processes] [\-\-no\-profile] \fB\-\-\fR [argument1] ... [argumentN]] .TP copyfrom [common\-options] [\-\-dryrun] [\-\-follow] [\-R|\-\-recursive] [guest\-src1 [...]] .TP copyfrom [common\-options] [\-\-dryrun] [\-\-follow] [\-R|\-\-recursive] [\-\-target\-directory ] [guest\-src1 [...]] .TP copyto [common\-options] [\-\-dryrun] [\-\-follow] [\-R|\-\-recursive] [host\-src1 [...]] .TP copyto [common\-options] [\-\-dryrun] [\-\-follow] [\-R|\-\-recursive] [\-\-target\-directory ] [host\-src1 [...]] .TP mkdir|createdir[ectory] [common\-options] [\-\-parents] [\-\-mode ] [...] .TP rmdir|removedir[ectory] [common\-options] [\-R|\-\-recursive] [...] .TP removefile|rm [common\-options] [\-f|\-\-force] [...] .TP mv|move|ren[ame] [common\-options] [source1 [...]] .TP mktemp|createtemp[orary] [common\-options] [\-\-secure] [\-\-mode ] [\-\-tmpdir ]