763 lines
26 KiB
HTML
763 lines
26 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of VBOXMANAGE</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>VBOXMANAGE</H1>
|
|
Section: User Commands (1)<BR>Updated: January 2019<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
VBoxManage - x86 virtualization solution
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
Oracle VM VirtualBox Command Line Management Interface
|
|
(C) 2005-2019 Oracle Corporation
|
|
All rights reserved.
|
|
<P>
|
|
|
|
Usage:
|
|
<DL COMPACT>
|
|
<DT id="1"><DD>
|
|
VBoxManage [<general option>] <command>
|
|
</DL>
|
|
<P>
|
|
|
|
General Options:
|
|
<DL COMPACT>
|
|
<DT id="2">[-v|--version]<DD>
|
|
print version number and exit
|
|
<DT id="3">[-q|--nologo]<DD>
|
|
suppress the logo
|
|
<DT id="4">[--settingspw <pw>]<DD>
|
|
provide the settings password
|
|
<DT id="5"><DD>
|
|
[--settingspwfile <file>] provide a file containing the settings password
|
|
[@<response-file>] load arguments from the given response file (bourne style)
|
|
</DL>
|
|
<P>
|
|
|
|
Commands:
|
|
<DL COMPACT>
|
|
<DT id="6">list [--long|-l] [--sorted|-s]<DD>
|
|
vms|runningvms|ostypes|hostdvds|hostfloppies|
|
|
<DT id="7">intnets|bridgedifs|hostonlyifs|natnets|dhcpservers|<DD>
|
|
hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies|
|
|
usbhost|usbfilters|systemproperties|extpacks|
|
|
groups|webcams|screenshotformats|cloudproviders|
|
|
cloudprofiles
|
|
<DT id="8">showvminfo<DD>
|
|
<uuid|vmname> [--details]
|
|
[--machinereadable]
|
|
<DT id="9">showvminfo<DD>
|
|
<uuid|vmname> <B>--log</B> <idx>
|
|
<DT id="10">registervm<DD>
|
|
<filename>
|
|
<DT id="11">unregistervm<DD>
|
|
<uuid|vmname> [--delete]
|
|
<DT id="12">createvm<DD>
|
|
<B>--name</B> <name>
|
|
[--groups <group>, ...]
|
|
[--ostype <ostype>]
|
|
[--register]
|
|
[--basefolder <path>]
|
|
[--uuid <uuid>]
|
|
[--default]
|
|
<DT id="13">modifyvm<DD>
|
|
<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|
|
|
<DT id="14">hyperv|kvm]<DD>
|
|
[--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|
|
|
<DT id="15">generic|natnetwork]<DD>
|
|
[--nictype<1-N> Am79C970A|Am79C973|
|
|
<DT id="16">82540EM|82543GC|82545EM|<DD>
|
|
virtio]
|
|
<DT id="17">[--cableconnected<1-N> on|off]<DD>
|
|
[--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>],
|
|
<DT id="18">[<sockrcv>],[<tcpsnd>],<DD>
|
|
[<tcprcv>]]
|
|
<DT id="19">[--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],<DD>
|
|
<hostport>,[<guestip>],<guestport>]
|
|
<DT id="20">[--natpf<1-N> delete <rulename>]<DD>
|
|
[--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],
|
|
<DT id="21">[sameports]]<DD>
|
|
[--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|
|
|
<DT id="22">server <pipe>|<DD>
|
|
client <pipe>|
|
|
tcpserver <port>|
|
|
tcpclient <hostname:port>|
|
|
file <file>|
|
|
<devicename>]
|
|
<DT id="23">[--uarttype<1-N> 16450|16550A|16750<DD>
|
|
[--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|
|
|
<DT id="24">bidirectional]<DD>
|
|
[--draganddrop disabled|hosttoguest|guesttohost|
|
|
<DT id="25">bidirectional]<DD>
|
|
[--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>]
|
|
<DT id="26">clonevm<DD>
|
|
<uuid|vmname>
|
|
[--snapshot <uuid>|<name>]
|
|
[--mode machine|machineandchildren|all]
|
|
[--options link|keepallmacs|keepnatmacs|
|
|
<DT id="27">keepdisknames|keephwuuids]<DD>
|
|
[--name <name>]
|
|
[--groups <group>, ...]
|
|
[--basefolder <basefolder>]
|
|
[--uuid <uuid>]
|
|
[--register]
|
|
<DT id="28">movevm<DD>
|
|
<uuid|vmname>
|
|
<B>--type</B> basic
|
|
[--folder <path>]
|
|
<DT id="29">import<DD>
|
|
<ovfname/ovaname>
|
|
[--dry-run|-n]
|
|
[--options keepallmacs|keepnatmacs|importtovdi]
|
|
[more options]
|
|
(run with <B>-n</B> to have options displayed
|
|
<DT id="30"><DD>
|
|
for a particular OVF)
|
|
<DT id="31">export<DD>
|
|
<machines> <B>--output</B>|-o <name>.<ovf/ova/tar.gz>
|
|
[--legacy09|--ovf09|--ovf10|--ovf20|--opc10]
|
|
[--manifest]
|
|
[--iso]
|
|
[--options manifest|iso|nomacs|nomacsbutnat]
|
|
[--vsys <number of virtual system>]
|
|
<DT id="32">[--vmname <name>]<DD>
|
|
[--product <product name>]
|
|
[--producturl <product url>]
|
|
[--vendor <vendor name>]
|
|
[--vendorurl <vendor url>]
|
|
[--version <version info>]
|
|
[--description <description info>]
|
|
[--eula <license text>]
|
|
[--eulafile <filename>]
|
|
<DT id="33">[--cloud <number of virtual system>]<DD>
|
|
[--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>]
|
|
<DT id="34">startvm<DD>
|
|
<uuid|vmname>...
|
|
[--type gui|sdl|headless|separate]
|
|
[-E|--putenv <NAME>[=<VALUE>]]
|
|
<DT id="35">controlvm<DD>
|
|
<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|
|
|
<DT id="36">natnetwork [<devicename>] |<DD>
|
|
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>],
|
|
<DT id="37"><hostport>,[<guestip>],<guestport> |<DD>
|
|
natpf<1-N> delete <rulename> |
|
|
guestmemoryballoon <balloonsize in MB> |
|
|
usbattach <uuid>|<address>
|
|
<DT id="38">[--capturefile <filename>] |<DD>
|
|
usbdetach <uuid>|<address> |
|
|
audioin on|off |
|
|
audioout on|off |
|
|
clipboard disabled|hosttoguest|guesttohost|
|
|
<DT id="39">bidirectional |<DD>
|
|
draganddrop disabled|hosttoguest|guesttohost|
|
|
<DT id="40">bidirectional |<DD>
|
|
vrde on|off |
|
|
vrdeport <port> |
|
|
vrdeproperty <name=[value]> |
|
|
vrdevideochannelquality <percent> |
|
|
setvideomodehint <xres> <yres> <bpp>
|
|
<DT id="41">[[<display>] [<enabled:yes|no> |<DD>
|
|
[<xorigin> <yorigin>]]] |
|
|
<DT id="42">setscreenlayout <display> on|primary <xorigin> <yorigin> <xres> <yres> <bpp> | off<DD>
|
|
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>
|
|
<DT id="43"><B>--passwordfile</B> <file> | <password><DD>
|
|
<domain>
|
|
[--allowlocallogon <yes|no>] |
|
|
<DT id="44">teleport <B>--host</B> <name> <B>--port</B> <port><DD>
|
|
[--maxdowntime <msec>]
|
|
[--passwordfile <file> |
|
|
<DT id="45"><B>--password</B> <password>] |<DD>
|
|
plugcpu <id> |
|
|
unplugcpu <id> |
|
|
cpuexecutioncap <1-100>
|
|
webcam <attach [path [settings]]> | <detach [path]> | <list>
|
|
addencpassword <id>
|
|
<DT id="46"><password file>|-<DD>
|
|
[--removeonsuspend <yes|no>]
|
|
<DT id="47">removeencpassword <id><DD>
|
|
removeallencpasswords
|
|
changeuartmode<1-N> disconnected|
|
|
<DT id="48">server <pipe>|<DD>
|
|
client <pipe>|
|
|
tcpserver <port>|
|
|
tcpclient <hostname:port>|
|
|
file <file>|
|
|
<devicename>]
|
|
<DT id="49">discardstate<DD>
|
|
<uuid|vmname>
|
|
<DT id="50">adoptstate<DD>
|
|
<uuid|vmname> <state_file>
|
|
<DT id="51">snapshot<DD>
|
|
<uuid|vmname>
|
|
take <name> [--description <desc>] [--live]
|
|
<DT id="52">[--uniquename Number,Timestamp,Space,Force] |<DD>
|
|
delete <uuid|snapname> |
|
|
restore <uuid|snapname> |
|
|
restorecurrent |
|
|
edit <uuid|snapname>|--current
|
|
<DT id="53">[--name <name>]<DD>
|
|
[--description <desc>] |
|
|
<DT id="54">list [--details|--machinereadable] |<DD>
|
|
showvminfo <uuid|snapname>
|
|
<DT id="55">closemedium<DD>
|
|
[disk|dvd|floppy] <uuid|filename>
|
|
[--delete]
|
|
<DT id="56">storageattach<DD>
|
|
<uuid|vmname>
|
|
<B>--storagectl</B> <name>
|
|
[--port <number>]
|
|
[--device <number>]
|
|
[--type dvddrive|hdd|fdd]
|
|
[--medium none|emptydrive|additions|
|
|
<DT id="57"><uuid|filename>|host:<drive>|iscsi]<DD>
|
|
[--mtype normal|writethrough|immutable|shareable|
|
|
<DT id="58">readonly|multiattach]<DD>
|
|
[--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]
|
|
<DT id="59">storagectl<DD>
|
|
<uuid|vmname>
|
|
<B>--name</B> <name>
|
|
[--add ide|sata|scsi|floppy|sas|usb|pcie]
|
|
[--controller LSILogic|LSILogicSAS|BusLogic|
|
|
<DT id="60">IntelAHCI|PIIX3|PIIX4|ICH6|I82078|<DD>
|
|
[ USB|NVMe]
|
|
[--portcount <1-n>]
|
|
[--hostiocache on|off]
|
|
[--bootable on|off]
|
|
[--rename <name>]
|
|
[--remove]
|
|
<DT id="61">bandwidthctl<DD>
|
|
<uuid|vmname>
|
|
add <name> <B>--type</B> disk|network
|
|
<DT id="62"><B>--limit</B> <megabytes per second>[k|m|g|K|M|G] |<DD>
|
|
set <name>
|
|
<DT id="63"><B>--limit</B> <megabytes per second>[k|m|g|K|M|G] |<DD>
|
|
remove <name> |
|
|
list [--machinereadable]
|
|
(limit units: k=kilobit, m=megabit, g=gigabit,
|
|
<DT id="64"><DD>
|
|
K=kilobyte, M=megabyte, G=gigabyte)
|
|
<DT id="65">showmediuminfo<DD>
|
|
[disk|dvd|floppy] <uuid|filename>
|
|
<DT id="66">createmedium<DD>
|
|
[disk|dvd|floppy] <B>--filename</B> <filename>
|
|
[--size <megabytes>|--sizebyte <bytes>]
|
|
[--diffparent <uuid>|<filename>
|
|
[--format VDI|VMDK|VHD] (default: VDI)
|
|
[--variant Standard,Fixed,Split2G,Stream,ESX,
|
|
<DT id="67"><DD>
|
|
Formatted]
|
|
<DT id="68">modifymedium<DD>
|
|
[disk|dvd|floppy] <uuid|filename>
|
|
[--type normal|writethrough|immutable|shareable|
|
|
<DT id="69">readonly|multiattach]<DD>
|
|
[--autoreset on|off]
|
|
[--property <name=[value]>]
|
|
[--compact]
|
|
[--resize <megabytes>|--resizebyte <bytes>]
|
|
[--move <path>]
|
|
[--setlocation <path>]
|
|
[--description <description string>]
|
|
<DT id="70">clonemedium<DD>
|
|
[disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile>
|
|
[--format VDI|VMDK|VHD|RAW|<other>]
|
|
[--variant Standard,Fixed,Split2G,Stream,ESX]
|
|
[--existing]
|
|
<DT id="71">mediumproperty<DD>
|
|
[disk|dvd|floppy] set <uuid|filename>
|
|
<property> <value>
|
|
<DT id="72">[disk|dvd|floppy] get <uuid|filename><DD>
|
|
<property>
|
|
<DT id="73">[disk|dvd|floppy] delete <uuid|filename><DD>
|
|
<property>
|
|
<DT id="74">encryptmedium<DD>
|
|
<uuid|filename>
|
|
[--newpassword <file>|-]
|
|
[--oldpassword <file>|-]
|
|
[--cipher <cipher identifier>]
|
|
[--newpasswordid <password identifier>]
|
|
<DT id="75">checkmediumpwd<DD>
|
|
<uuid|filename>
|
|
<pwd file>|-
|
|
<DT id="76">convertfromraw<DD>
|
|
<filename> <outputfile>
|
|
[--format VDI|VMDK|VHD]
|
|
[--variant Standard,Fixed,Split2G,Stream,ESX]
|
|
[--uuid <uuid>]
|
|
<DT id="77">convertfromraw<DD>
|
|
stdin <outputfile> <bytes>
|
|
[--format VDI|VMDK|VHD]
|
|
[--variant Standard,Fixed,Split2G,Stream,ESX]
|
|
[--uuid <uuid>]
|
|
<DT id="78">getextradata<DD>
|
|
global|<uuid|vmname>
|
|
<key>|[enumerate]
|
|
<DT id="79">setextradata<DD>
|
|
global|<uuid|vmname>
|
|
<key>
|
|
[<value>] (no value deletes key)
|
|
<DT id="80">setproperty<DD>
|
|
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>
|
|
<DT id="81">usbfilter<DD>
|
|
add <index,0-N>
|
|
<B>--target</B> <uuid|vmname>|global
|
|
<B>--name</B> <string>
|
|
<B>--action</B> 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>]
|
|
<DT id="82">usbfilter<DD>
|
|
modify <index,0-N>
|
|
<B>--target</B> <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>]
|
|
<DT id="83">usbfilter<DD>
|
|
remove <index,0-N>
|
|
<B>--target</B> <uuid|vmname>|global
|
|
<DT id="84">sharedfolder<DD>
|
|
add <uuid|vmname>
|
|
<B>--name</B> <name> <B>--hostpath</B> <hostpath>
|
|
[--transient] [--readonly] [--automount]
|
|
<DT id="85">sharedfolder<DD>
|
|
remove <uuid|vmname>
|
|
<B>--name</B> <name> [--transient]
|
|
<DT id="86">guestproperty<DD>
|
|
get <uuid|vmname>
|
|
<property> [--verbose]
|
|
<DT id="87">guestproperty<DD>
|
|
set <uuid|vmname>
|
|
<property> [<value> [--flags <flags>]]
|
|
<DT id="88">guestproperty<DD>
|
|
delete|unset <uuid|vmname>
|
|
<property>
|
|
<DT id="89">guestproperty<DD>
|
|
enumerate <uuid|vmname>
|
|
[--patterns <patterns>]
|
|
<DT id="90">guestproperty<DD>
|
|
wait <uuid|vmname> <patterns>
|
|
[--timeout <msec>] [--fail-on-timeout]
|
|
<DT id="91">guestcontrol<DD>
|
|
<uuid|vmname> [--verbose|-v] [--quiet|-q]
|
|
<DT id="92">[--username <name>] [--domain <domain>]<DD>
|
|
[--passwordfile <file> | <B>--password</B> <password>]
|
|
<DT id="93">run [common-options]<DD>
|
|
[--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]
|
|
<B>--</B> <program/arg0> [argument1] ... [argumentN]]
|
|
<DT id="94">start [common-options]<DD>
|
|
[--exe <path to executable>] [--timeout <msec>]
|
|
[-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
|
|
[--ignore-operhaned-processes] [--profile]
|
|
<B>--</B> <program/arg0> [argument1] ... [argumentN]]
|
|
<DT id="95">copyfrom [common-options]<DD>
|
|
[--follow] [-R|--recursive]
|
|
<guest-src0> [guest-src1 [...]] <host-dst>
|
|
<DT id="96">copyfrom [common-options]<DD>
|
|
[--follow] [-R|--recursive]
|
|
[--target-directory <host-dst-dir>]
|
|
<guest-src0> [guest-src1 [...]]
|
|
<DT id="97">copyto [common-options]<DD>
|
|
[--follow] [-R|--recursive]
|
|
<host-src0> [host-src1 [...]] <guest-dst>
|
|
<DT id="98">copyto [common-options]<DD>
|
|
[--follow] [-R|--recursive]
|
|
[--target-directory <guest-dst>]
|
|
<host-src0> [host-src1 [...]]
|
|
<DT id="99">mkdir|createdir[ectory] [common-options]<DD>
|
|
[--parents] [--mode <mode>]
|
|
<guest directory> [...]
|
|
<DT id="100">rmdir|removedir[ectory] [common-options]<DD>
|
|
[-R|--recursive]
|
|
<guest directory> [...]
|
|
<DT id="101">removefile|rm [common-options] [-f|--force]<DD>
|
|
<guest file> [...]
|
|
<DT id="102">mv|move|ren[ame] [common-options]<DD>
|
|
<source> [source1 [...]] <dest>
|
|
<DT id="103">mktemp|createtemp[orary] [common-options]<DD>
|
|
[--secure] [--mode <mode>] [--tmpdir <directory>]
|
|
<template>
|
|
<DT id="104">stat [common-options]<DD>
|
|
<file> [...]
|
|
<DT id="105">guestcontrol<DD>
|
|
<uuid|vmname> [--verbose|-v] [--quiet|-q]
|
|
<DT id="106"><DD>
|
|
list <all|sessions|processes|files> [common-opts]
|
|
<DT id="107">closeprocess [common-options]<DD>
|
|
< <B>--session-id</B> <ID>
|
|
<DT id="108">| <B>--session-name</B> <name or pattern><DD>
|
|
<PID1> [PID1 [...]]
|
|
<DT id="109">closesession [common-options]<DD>
|
|
< <B>--all</B> | <B>--session-id</B> <ID>
|
|
<DT id="110"><DD>
|
|
| <B>--session-name</B> <name or pattern> >
|
|
<DT id="111">updatega|updateguestadditions|updateadditions<DD>
|
|
[--source <guest additions .ISO>]
|
|
[--wait-start] [common-options]
|
|
[-- [<argument1>] ... [<argumentN>]]
|
|
<DT id="112"><DD>
|
|
watch [common-options]
|
|
<DT id="113">metrics<DD>
|
|
list [*|host|<vmname> [<metric_list>]]
|
|
<DT id="114"><DD>
|
|
(comma-separated)
|
|
<DT id="115">metrics<DD>
|
|
setup
|
|
[--period <seconds>] (default: 1)
|
|
[--samples <count>] (default: 1)
|
|
[--list]
|
|
[*|host|<vmname> [<metric_list>]]
|
|
<DT id="116">metrics<DD>
|
|
query [*|host|<vmname> [<metric_list>]]
|
|
<DT id="117">metrics<DD>
|
|
enable
|
|
[--list]
|
|
[*|host|<vmname> [<metric_list>]]
|
|
<DT id="118">metrics<DD>
|
|
disable
|
|
[--list]
|
|
[*|host|<vmname> [<metric_list>]]
|
|
<DT id="119">metrics<DD>
|
|
collect
|
|
[--period <seconds>] (default: 1)
|
|
[--samples <count>] (default: 1)
|
|
[--list]
|
|
[--detach]
|
|
[*|host|<vmname> [<metric_list>]]
|
|
<DT id="120">natnetwork<DD>
|
|
add <B>--netname</B> <name>
|
|
<B>--network</B> <network>
|
|
[--enable|--disable]
|
|
[--dhcp on|off]
|
|
[--port-forward-4 <rule>]
|
|
[--loopback-4 <rule>]
|
|
[--ipv6 on|off]
|
|
[--port-forward-6 <rule>]
|
|
[--loopback-6 <rule>]
|
|
<DT id="121">natnetwork<DD>
|
|
remove <B>--netname</B> <name>
|
|
<DT id="122">natnetwork<DD>
|
|
modify <B>--netname</B> <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>]
|
|
<DT id="123">natnetwork<DD>
|
|
start <B>--netname</B> <name>
|
|
<DT id="124">natnetwork<DD>
|
|
stop <B>--netname</B> <name>
|
|
<DT id="125">natnetwork<DD>
|
|
list [<pattern>]
|
|
<DT id="126">hostonlyif<DD>
|
|
ipconfig <name>
|
|
[--dhcp |
|
|
<B>--ip</B><ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |
|
|
<B>--ipv6</B><ipv6> [--netmasklengthv6<length> (def: 64)]]
|
|
create |
|
|
remove <name>
|
|
<DT id="127">dhcpserver<DD>
|
|
add|modify <B>--netname</B> <network_name> |
|
|
<DT id="128"><B>--ifname</B> <hostonly_if_name><DD>
|
|
[--ip <ip_address>
|
|
<B>--netmask</B> <network_mask>
|
|
<B>--lowerip</B> <lower_ip>
|
|
<B>--upperip</B> <upper_ip>]
|
|
[--enable | <B>--disable]</B>
|
|
[--options [--vm <name> <B>--nic</B> <1-N>]
|
|
<DT id="129"><B>--id</B> <number> [--value <string> | <B>--remove]]</B><DD>
|
|
(multiple options allowed after <B>--options</B>)
|
|
<DT id="130">dhcpserver<DD>
|
|
remove <B>--netname</B> <network_name> |
|
|
<DT id="131"><DD>
|
|
<B>--ifname</B> <hostonly_if_name>
|
|
<DT id="132">usbdevsource<DD>
|
|
add <source name>
|
|
<B>--backend</B> <backend>
|
|
<B>--address</B> <address>
|
|
<DT id="133">usbdevsource<DD>
|
|
remove <source name>
|
|
<DT id="134"><DD>
|
|
Medium content access:
|
|
<DT id="135"><DD>
|
|
VBoxManage mediumio <[--disk=uuid|filename] | [--dvd=uuid|filename] | [--floppy=uuid|filename]> [--password-file-|filename] formatfat [--quick]
|
|
<DT id="136"><DD>
|
|
VBoxManage mediumio <[--disk=uuid|filename] | [--dvd=uuid|filename] | [--floppy=uuid|filename]> [--password-file-|filename] cat [--hex] [--offset=byte-offset] [--size=bytes] [--output=-|filename]
|
|
<DT id="137"><DD>
|
|
VBoxManage mediumio <[--disk=uuid|filename] | [--dvd=uuid|filename] | [--floppy=uuid|filename]> [--password-file-|filename] stream [--format=image-format] [--variant=image-variant] [--output=-|filename]
|
|
<DT id="138"><DD>
|
|
Introspection and guest debugging:
|
|
<DT id="139"><DD>
|
|
VBoxManage debugvm <uuid|vmname> dumpvmcore [--filename=name]
|
|
<DT id="140"><DD>
|
|
VBoxManage debugvm <uuid|vmname> info <item> [args...]
|
|
<DT id="141"><DD>
|
|
VBoxManage debugvm <uuid|vmname> injectnmi
|
|
<DT id="142"><DD>
|
|
VBoxManage debugvm <uuid|vmname> log [[--release] | [--debug]] [group-settings...]
|
|
<DT id="143"><DD>
|
|
VBoxManage debugvm <uuid|vmname> logdest [[--release] | [--debug]] [destinations...]
|
|
<DT id="144"><DD>
|
|
VBoxManage debugvm <uuid|vmname> logflags [[--release] | [--debug]] [flags...]
|
|
<DT id="145"><DD>
|
|
VBoxManage debugvm <uuid|vmname> osdetect
|
|
<DT id="146"><DD>
|
|
VBoxManage debugvm <uuid|vmname> osinfo
|
|
<DT id="147"><DD>
|
|
VBoxManage debugvm <uuid|vmname> osdmesg [--lines=lines]
|
|
<DT id="148"><DD>
|
|
VBoxManage debugvm <uuid|vmname> getregisters [--cpu=id] [reg-set.reg-name...]
|
|
<DT id="149"><DD>
|
|
VBoxManage debugvm <uuid|vmname> setregisters [--cpu=id] [reg-set.reg-name=value...]
|
|
<DT id="150"><DD>
|
|
VBoxManage debugvm <uuid|vmname> show [[--human-readable] | [--sh-export] | [--sh-eval] | [--cmd-set]] [settings-item...]
|
|
<DT id="151"><DD>
|
|
VBoxManage debugvm <uuid|vmname> stack [--cpu=id]
|
|
<DT id="152"><DD>
|
|
VBoxManage debugvm <uuid|vmname> statistics [--reset] [--descriptions] [--pattern=pattern]
|
|
<DT id="153"><DD>
|
|
Extension package management:
|
|
<DT id="154"><DD>
|
|
VBoxManage extpack install [--replace] <tarball>
|
|
<DT id="155"><DD>
|
|
VBoxManage extpack uninstall [--force] <name>
|
|
<DT id="156"><DD>
|
|
VBoxManage extpack cleanup
|
|
<DT id="157"><DD>
|
|
Unattended guest OS installation:
|
|
<DT id="158"><DD>
|
|
VBoxManage unattended detect <--iso=install-iso> [--machine-readable]
|
|
<DT id="159"><DD>
|
|
VBoxManage unattended install <uuid|vmname> <--iso=install-iso> [--user=login] [--password=password] [--password-file=file] [--full-user-name=name] [--key=product-key] [--install-additions]
|
|
<DT id="160"><DD>
|
|
[--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]
|
|
<P>
|
|
</DL>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="161"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="162"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:29 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|