VBoxManage.exe

VBoxManage.exe is the VirtualBox command line tool to manage Oracle VM VirtualBox. It is the more powerful alternative to VirtualBoxVM.exe

VirtualBoxVM.exe must always be invoked with a command and optional «general» options.

Subcommands

`adoptstate`
`bandwidthctl`
`checkmediumpwd`
`clonemedium`
`clonevm`	Creates a clone of an existing virtual machine
`closemedium`	Removes a HD, DVD or floppy image from a VM's media registry.
`cloud`	Manage cloud entities
`cloudprofile`	Manage cloud profiles:
`controlvm`	Change the state of a running VM. Compare with `modifyvm`
`convertfromraw`
`createmedium`	Creates a medium. `createvdi` and `createhd` are internally mapped to `createmedium`. See also `showmediuminfo`
`createvm`	Creates a VM definition file (XML). Compare with `registervm`
`debugvm`	Introspection and guest debugging
`dhcpserver`	Management of DHCP server
`discardstate`	Discards the saved state of a virtual machine that is not running (which is equivalent of pulling out the power cable on a physical machine)
`encryptmedium`
`export`
`extpack`	Extension package management. (See also `VBoxManage list extpacks`)
`guestcontrol`	Control the guest from the host: start executables, perform file system operations.
`guestproperty`
`hostonlyif`
`import`
`internalcommands`	Should only be used to analyze problems - unsupported.
`list`	Gives information about the system and settings. Compare with `showvminfo`.
`mediumio`	Accesses medium content
`mediumproperty`
`metrics`	Retrieve metric data (which is collected by the VboxSDS process/service).
`modifymedium`
`modifyvm`	Change the properties of a virtual machine (which must not be running?). Compare with `controlvm`. The current settings of a virtual machine can be displayed with `VBoxManage showvminfo`.
`movevm`	Moves files that are associated with a VM (for example setting files or disk images) to a new location on the host.
`natnetwork`
`registervm`, `unregistervm`	Import a VM definition (XML file) into a VM - or unregisters such a VM definition. Compare with `createvm`
`setextradata`, `getextradata`	Attach and retrieve string data from/to a VM.
`setproperty`	Change global settings of an entire Virtual Box installation. (Some of these settings correspond to the Preferences dialog in the GUI). Compare with `modifyvm` and `setextradata` which allow to set configuration options for individual virtual machines.
`sharedfolder`	Add or remove shared folders
`showmediuminfo`
`showvminfo`	Gives information (such as the settings configured with VBoxManage modifyvm`) about a given virtual machine. Compare with` list`
`snapshot`	Manages snapshots
`startvm`	Starts a VM (whose state is either Powered Off or Saved). Compare with `VBoxManage controlvm $vm [pause\|resume\|reset\|poweroff\|savestate\|acpipowerbutton\|acpisleepbutton`]
`storageattach`	Attaches, modifies, and removes a storage medium connected to a storage controller that was previously added with the `storagectl`
`storagectl`	Attaches, modifies, and removes a storage controller (which is required to attache a storage medium with `storageattach`)
`unattended`	Unattended installation of an OS in the guest VM
`usbdevsource`
`usbfilter`

General Options:

`-v\|--version`	print version number and exit
`-q\|--nologo`	suppress the logo
`--settingspw <pw>`	provide the settings password
`--settingspwfile <file>`	provide a file containing the settings password
`@<response-file>`	load arguments from the given response file (bourne style)

List all registered virtual machines

Registered virtual machines, running or stopped, can be shown with

VBoxManage list vms

Starting a virtual machine

A virtual machines can be started on the command line by either their name or UUID.

Note: in PowerShell, the UUIDs (with its curly braces) need to be enclosed in quotes.

VBoxManage startvm nameOftheVM
VBoxManage startvm {0645bb95-a11f-4273-ba9a-eb32c6e3c400}

Show running virtual machines

Virtual machines that are currently running can be shown like so:

VBoxManage list runningvms

Each running machine is returned with its name and identifying UUID on a separate line.

Pausing, saving and resuming virtual machines

VBoxManage controlvm {0645bb95-a11f-4273-ba9a-eb32c6e3c400} pause
VBoxManage controlvm {0645bb95-a11f-4273-ba9a-eb32c6e3c400} savestate
VBoxManage controlvm {0645bb95-a11f-4273-ba9a-eb32c6e3c400} resume

Disable authentication for testing purposes

For testing purposes, authentication can be disabled with

C:\Program Files\Oracle\VirtualBox> VBoxManage setproperty websrvauthlibrary null

Of course, such a command should not be used in a productive environment as it causes all logons to succeed.

This setting can be reset with one of

C:\Program Files\Oracle\VirtualBox> VBoxManage setproperty websrvauthlibrary default
C:\Program Files\Oracle\VirtualBox> VBoxManage setproperty websrvauthlibrary someLibrary

TODO

VBoxManage.exe allows to modify the VirtualBox.xml file.