Want more features on Pastebin? Sign Up, it's FREE!
Guest

VBoxManage -h

By: a guest on Jul 21st, 2010  |  syntax: None  |  size: 17.60 KB  |  views: 484  |  expires: Never
download  |  raw  |  embed  |  report abuse  |  print
Text below is selected. Please press Ctrl+C to copy to your clipboard. (⌘+C on Mac)
  1. Oracle VM VirtualBox Command Line Management Interface Version 3.2.6
  2. (C) 2005-2010 Oracle Corporation
  3. All rights reserved.
  4.  
  5. Usage:
  6.  
  7. VBoxManage [-v|--version]    print version number and exit
  8. VBoxManage [-q|--nologo] ... suppress the logo
  9.  
  10. VBoxManage list [--long|-l] vms|runningvms|ostypes|hostdvds|hostfloppies|
  11.                             bridgedifs|hostonlyifs|dhcpservers|hostinfo|
  12.                             hostcpuids|hddbackends|hdds|dvds|floppies|
  13.                             usbhost|usbfilters|systemproperties
  14.  
  15. VBoxManage showvminfo       <uuid>|<name> [--details] [--statistics]
  16.                             [--machinereadable]
  17. VBoxManage showvminfo       <uuid>|<name> --log <idx>
  18.  
  19. VBoxManage registervm       <filename>
  20.  
  21. VBoxManage unregistervm     <uuid>|<name> [--delete]
  22.  
  23. VBoxManage createvm         --name <name>
  24.                             [--ostype <ostype>]
  25.                             [--register]
  26.                             [--basefolder <path> | --settingsfile <path>]
  27.                             [--uuid <uuid>]
  28.  
  29. VBoxManage modifyvm         <uuid|name>
  30.                             [--name <name>]
  31.                             [--ostype <ostype>]
  32.                             [--memory <memorysize in MB>]
  33.                             [--pagefusion on|off]
  34.                             [--vram <vramsize in MB>]
  35.                             [--acpi on|off]
  36.                             [--ioapic on|off]
  37.                             [--pae on|off]
  38.                             [--hpet on|off]
  39.                             [--hwvirtex on|off]
  40.                             [--nestedpaging on|off]
  41.                             [--largepages on|off]
  42.                             [--vtxvpid on|off]
  43.                             [--synthcpu on|off]
  44.                             [--cpuidset <leaf> <eax> <ebx> <ecx> <edx>]
  45.                             [--cpuidremove <leaf>]
  46.                             [--cpuidremoveall]
  47.                             [--hardwareuuid <uuid>]
  48.                             [--cpus <number>]
  49.                             [--cpuhotplug on|off]
  50.                             [--plugcpu <id>]
  51.                             [--unplugcpu <id>]
  52.                             [--rtcuseutc on|off]
  53.                             [--monitorcount <number>]
  54.                             [--accelerate3d on|off]
  55.                             [--accelerate2dvideo on|off]
  56.                             [--firmware bios|efi|efi32|efi64]
  57.                             [--bioslogofadein on|off]
  58.                             [--bioslogofadeout on|off]
  59.                             [--bioslogodisplaytime <msec>]
  60.                             [--bioslogoimagepath <imagepath>]
  61.                             [--biosbootmenu disabled|menuonly|messageandmenu]
  62.                             [--biossystemtimeoffset <msec>]
  63.                             [--biospxedebug on|off]
  64.                             [--boot<1-4> none|floppy|dvd|disk|net>]
  65.                             [--nic<1-N> none|null|nat|bridged|intnet|hostonly|
  66.                                         vde]
  67.                             [--nictype<1-N> Am79C970A|Am79C973|
  68.                                             82540EM|82543GC|82545EM|
  69.                                             virtio]
  70.                             [--cableconnected<1-N> on|off]
  71.                             [--nictrace<1-N> on|off]
  72.                             [--nictracefile<1-N> <filename>]
  73.                             [--nicspeed<1-N> <kbps>]
  74.                             [--nicbootprio<1-N> <priority>]
  75.                             [--bridgeadapter<1-N> none|<devicename>]
  76.                             [--hostonlyadapter<1-N> none|<devicename>]
  77.                             [--intnet<1-N> <network name>]
  78.                             [--natnet<1-N> <network>|default]
  79.                             [--vdenet<1-N> <network>|default]
  80.                             [--natsettings<1-N> [<mtu>],[<socksnd>],
  81.                                                 [<sockrcv>],[<tcpsnd>],
  82.                                                 [<tcprcv>]]
  83.                             [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>],
  84.                                           <hostport>,[<guestip>],<guestport>]
  85.                             [--natpf<1-N> delete <rulename>]
  86.                             [--nattftpprefix<1-N> <prefix>]
  87.                             [--nattftpfile<1-N> <file>]
  88.                             [--nattftpserver<1-N> <ip>]
  89.                             [--natdnspassdomain<1-N> on|off]
  90.                             [--natdnsproxy<1-N> on|off]
  91.                             [--natdnshostresolver<1-N> on|off]
  92.                             [--nataliasmode<1-N> default|[log],[proxyonly],
  93.                                                          [sameports]]
  94.                             [--macaddress<1-N> auto|<mac>]
  95.                             [--mouse ps2|usb|usbtablet
  96.                             [--keyboard ps2|usb
  97.                             [--uart<1-N> off|<I/O base> <IRQ>]
  98.                             [--uartmode<1-N> disconnected|
  99.                                              server <pipe>|
  100.                                              client <pipe>|
  101.                                              file <file>|
  102.                                              <devicename>]
  103.                             [--guestmemoryballoon <balloonsize in MB>]
  104.                             [--gueststatisticsinterval <seconds>]
  105.                             [--audio none|null|oss|alsa|pulse]
  106.                             [--audiocontroller ac97|sb16]
  107.                             [--clipboard disabled|hosttoguest|guesttohost|
  108.                                          bidirectional]
  109.                             [--vrdp on|off]
  110.                             [--vrdpport default|<ports>]
  111.                             [--vrdpaddress <host>]
  112.                             [--vrdpauthtype null|external|guest]
  113.                             [--vrdpmulticon on|off]
  114.                             [--vrdpreusecon on|off]
  115.                             [--vrdpvideochannel on|off]
  116.                             [--vrdpvideochannelquality <percent>]
  117.                             [--usb on|off]
  118.                             [--usbehci on|off]
  119.                             [--snapshotfolder default|<path>]
  120.                             [--teleporter on|off]
  121.                             [--teleporterport <port>]
  122.                             [--teleporteraddress <address|empty>
  123.                             [--teleporterpassword <password>]
  124.  
  125. VBoxManage import           <ovf> [--dry-run|-n] [more options]
  126.                             (run with -n to have options displayed
  127.                              for a particular OVF)
  128.  
  129. VBoxManage export           <machines> --output|-o <ovf>
  130.                             [--legacy09]
  131.                             [--vsys <number of virtual system>]
  132.                                     [--product <product name>]
  133.                                     [--producturl <product url>]
  134.                                     [--vendor <vendor name>]
  135.                                     [--vendorurl <vendor url>]
  136.                                     [--version <version info>]
  137.                                     [--eula <license text>]
  138.                                     [--eulafile <filename>]
  139.  
  140. VBoxManage startvm          <uuid>|<name>
  141.                             [--type gui|sdl|vrdp|headless]
  142.  
  143. VBoxManage controlvm        <uuid>|<name>
  144.                             pause|resume|reset|poweroff|savestate|
  145.                             acpipowerbutton|acpisleepbutton|
  146.                             keyboardputscancode <hex> [<hex> ...]|
  147.                             injectnmi|
  148.                             setlinkstate<1-N> on|off |
  149.                             nic<1-N> null|nat|bridged|intnet|hostonly
  150.                                      [<devicename>] |
  151.                             nictrace<1-N> on|off
  152.                             nictracefile<1-N> <filename>
  153.                             guestmemoryballoon <balloonsize in MB>]
  154.                             gueststatisticsinterval <seconds>]
  155.                             usbattach <uuid>|<address> |
  156.                             usbdetach <uuid>|<address> |
  157.                             vrdp on|off |
  158.                             vrdpport default|<ports> |
  159.                             vrdpvideochannelquality <percent>
  160.                             setvideomodehint <xres> <yres> <bpp> [display] |
  161.                             setcredentials <username> <password> <domain>
  162.                                            [--allowlocallogon <yes|no>] |
  163.                             teleport --host <name> --port <port>
  164.                                    [--maxdowntime <msec>] [--password password]
  165.                             plugcpu <id>
  166.                             unplugcpu <id>
  167.  
  168. VBoxManage discardstate     <uuid>|<name>
  169.  
  170. VBoxManage adoptstate       <uuid>|<name> <state_file>
  171.  
  172. VBoxManage snapshot         <uuid>|<name>
  173.                             take <name> [--description <desc>] [--pause] |
  174.                             delete <uuid>|<name> |
  175.                             restore <uuid>|<name> |
  176.                             restorecurrent |
  177.                             edit <uuid>|<name>|--current
  178.                                  [--name <name>]
  179.                                  [--description <desc>] |
  180.                             showvminfo <uuid>|<name>
  181.  
  182. VBoxManage openmedium       disk|dvd|floppy <filename>
  183.                             [--type normal|immutable|writethrough] (disk only)
  184.                             [--uuid <uuid>]
  185.                             [--parentuuid <uuid>] (disk only)
  186.  
  187. VBoxManage closemedium      disk|dvd|floppy <uuid>|<filename>
  188.                             [--delete]
  189.  
  190. VBoxManage storageattach    <uuid|vmname>
  191.                             --storagectl <name>
  192.                             --port <number>
  193.                             --device <number>
  194.                             [--type dvddrive|hdd|fdd]
  195.                             [--medium none|emptydrive|
  196.                                       <uuid>|<filename>|host:<drive>]
  197.                             [--passthrough on|off]
  198.                             [--forceunmount]
  199.  
  200. VBoxManage storagectl       <uuid|vmname>
  201.                             --name <name>
  202.                             [--add ide|sata|scsi|floppy|sas]
  203.                             [--controller LSILogic|LSILogicSAS|BusLogic|
  204.                                           IntelAHCI|PIIX3|PIIX4|ICH6|I82078]
  205.                             [--sataideemulation<1-4> <1-30>]
  206.                             [--sataportcount <1-30>]
  207.                             [--hostiocache on|off]
  208.                             [--remove]
  209.  
  210. VBoxManage showhdinfo       <uuid>|<filename>
  211.  
  212. VBoxManage createhd         --filename <filename>
  213.                             --size <megabytes>
  214.                             [--format VDI|VMDK|VHD] (default: VDI)
  215.                             [--variant Standard,Fixed,Split2G,Stream,ESX]
  216.                             [--type normal|writethrough] (default: normal)
  217.                             [--comment <comment>]
  218.                             [--remember]
  219.  
  220. VBoxManage modifyhd         <uuid>|<filename>
  221.                             [--type normal|writethrough|immutable]
  222.                             [--autoreset on|off]
  223.                             [--compact]
  224.  
  225. VBoxManage clonehd          <uuid>|<filename> <outputfile>
  226.                             [--format VDI|VMDK|VHD|RAW|<other>]
  227.                             [--variant Standard,Fixed,Split2G,Stream,ESX]
  228.                             [--type normal|writethrough|immutable]
  229.                             [--remember] [--existing]
  230.  
  231. VBoxManage convertfromraw   <filename> <outputfile>
  232.                             [--format VDI|VMDK|VHD]
  233.                             [--variant Standard,Fixed,Split2G,Stream,ESX]
  234. VBoxManage convertfromraw   stdin <outputfile> <bytes>
  235.                             [--format VDI|VMDK|VHD]
  236.                             [--variant Standard,Fixed,Split2G,Stream,ESX]
  237.  
  238. VBoxManage addiscsidisk     --server <name>|<ip>
  239.                             --target <target>
  240.                             [--port <port>]
  241.                             [--lun <lun>]
  242.                             [--encodedlun <lun>]
  243.                             [--username <username>]
  244.                             [--password <password>]
  245.                             [--type normal|writethrough|immutable]
  246.                             [--intnet]
  247.  
  248. VBoxManage getextradata     global|<uuid>|<name>
  249.                             <key>|enumerate
  250.  
  251. VBoxManage setextradata     global|<uuid>|<name>
  252.                             <key>
  253.                             [<value>] (no value deletes key)
  254.  
  255. VBoxManage setproperty      hdfolder default|<folder> |
  256.                             machinefolder default|<folder> |
  257.                             vrdpauthlibrary default|<library> |
  258.                             websrvauthlibrary default|null|<library> |
  259.                             loghistorycount <value>
  260.  
  261. VBoxManage usbfilter        add <index,0-N>
  262.                             --target <uuid>|<name>|global
  263.                             --name <string>
  264.                             --action ignore|hold (global filters only)
  265.                             [--active yes|no] (yes)
  266.                             [--vendorid <XXXX>] (null)
  267.                             [--productid <XXXX>] (null)
  268.                             [--revision <IIFF>] (null)
  269.                             [--manufacturer <string>] (null)
  270.                             [--product <string>] (null)
  271.                             [--remote yes|no] (null, VM filters only)
  272.                             [--serialnumber <string>] (null)
  273.                             [--maskedinterfaces <XXXXXXXX>]
  274.  
  275. VBoxManage usbfilter        modify <index,0-N>
  276.                             --target <uuid>|<name>|global
  277.                             [--name <string>]
  278.                             [--action ignore|hold] (global filters only)
  279.                             [--active yes|no]
  280.                             [--vendorid <XXXX>|""]
  281.                             [--productid <XXXX>|""]
  282.                             [--revision <IIFF>|""]
  283.                             [--manufacturer <string>|""]
  284.                             [--product <string>|""]
  285.                             [--remote yes|no] (null, VM filters only)
  286.                             [--serialnumber <string>|""]
  287.                             [--maskedinterfaces <XXXXXXXX>]
  288.  
  289. VBoxManage usbfilter        remove <index,0-N>
  290.                             --target <uuid>|<name>|global
  291.  
  292. VBoxManage sharedfolder     add <vmname>|<uuid>
  293.                             --name <name> --hostpath <hostpath>
  294.                             [--transient] [--readonly]
  295.  
  296. VBoxManage sharedfolder     remove <vmname>|<uuid>
  297.                             --name <name> [--transient]
  298.  
  299. VBoxManage vmstatistics     <vmname>|<uuid> [--reset]
  300.                             [--pattern <pattern>] [--descriptions]
  301.  
  302. VBoxManage guestproperty    get <vmname>|<uuid>
  303.                             <property> [--verbose]
  304.  
  305. VBoxManage guestproperty    set <vmname>|<uuid>
  306.                             <property> [<value> [--flags <flags>]]
  307.  
  308. VBoxManage guestproperty    enumerate <vmname>|<uuid>
  309.                             [--patterns <patterns>]
  310.  
  311. VBoxManage guestproperty    wait <vmname>|<uuid> <patterns>
  312.                             [--timeout <msec>] [--fail-on-timeout]
  313.  
  314. VBoxManage guestcontrol     execute <vmname>|<uuid>
  315.                             <path to program>
  316.                             --username <name> --password <password>
  317.                             [--arguments "<arguments>"]
  318.                             [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
  319.                             [--flags <flags>] [--timeout <msec>]
  320.                             [--verbose] [--wait-for exit,stdout,stderr||]
  321.  
  322. VBoxManage metrics          list [*|host|<vmname> [<metric_list>]]
  323.                                                  (comma-separated)
  324.  
  325. VBoxManage metrics          setup
  326.                             [--period <seconds>] (default: 1)
  327.                             [--samples <count>] (default: 1)
  328.                             [--list]
  329.                             [*|host|<vmname> [<metric_list>]]
  330.  
  331. VBoxManage metrics          query [*|host|<vmname> [<metric_list>]]
  332.  
  333. VBoxManage metrics          enable
  334.                             [--list]
  335.                             [*|host|<vmname> [<metric_list>]]
  336.  
  337. VBoxManage metrics          disable
  338.                             [--list]
  339.                             [*|host|<vmname> [<metric_list>]]
  340.  
  341. VBoxManage metrics          collect
  342.                             [--period <seconds>] (default: 1)
  343.                             [--samples <count>] (default: 1)
  344.                             [--list]
  345.                             [--detach]
  346.                             [*|host|<vmname> [<metric_list>]]
  347.  
  348. VBoxManage hostonlyif       ipconfig <name>
  349.                             [--dhcp |
  350.                             --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] |
  351.                             --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]]
  352.  
  353. VBoxManage dhcpserver       add|modify --netname <network_name> |
  354.                                        --ifname <hostonly_if_name>
  355.                                 [--ip <ip_address>
  356.                                  --netmask <network_mask>
  357.                                  --lowerip <lower_ip>
  358.                                  --upperip <upper_ip>]
  359.                                 [--enable | --disable]
  360.  
  361. VBoxManage dhcpserver       remove --netname <network_name> |
  362.                                    --ifname <hostonly_if_name>
clone this paste RAW Paste Data