Управление VirtualBox из командной строки | Информационный портал К2®

As briefly mentioned in Section 1.17, “Alternative Front-Ends”,
VBoxManage is the command-line interface to
Oracle VM VirtualBox. With it, you can completely control Oracle VM VirtualBox
from the command line of your host operating system.
VBoxManage supports all the features that the
graphical user interface gives you access to, but it supports a
lot more than that. It exposes all the features of the
virtualization engine, even those that cannot be accessed from the
GUI.

You will need to use the command line if you want to do the
following:

There are two main things to keep in mind when using
VBoxManage. First,
VBoxManage must always be used with a specific
subcommand, such as list or
createvm or startvm. All the
subcommands that VBoxManage supports are
described in detail in Chapter 8, VBoxManage.

Second, most of these subcommands require that you specify a
particular virtual machine after the subcommand. There are two
ways you can do this:

You can enter VBoxManage list vms to have all
currently registered VMs listed with all their settings, including
their respective names and UUIDs.

Some typical examples of how to control Oracle VM VirtualBox from the
command line are listed below:

When running VBoxManage without parameters or
when supplying an invalid command line, the following command
syntax list is shown. Note that the output will be slightly
different depending on the host platform. If in doubt, check the
output of VBoxManage for the commands available
on your particular host.

Usage: VBoxManage [<general option>] <command>
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)
Commands: list [--long|-l] [--sorted|-s] vms|runningvms|ostypes|hostdvds|hostfloppies| intnets|bridgedifs|hostonlyifs|natnets|dhcpservers| hostinfo|hostcpuids|hddbackends|hdds|dvds|floppies| usbhost|usbfilters|systemproperties|extpacks| groups|webcams|screenshotformats|cloudproviders| cloudprofiles|cloudnets showvminfo <uuid|vmname> [--details] [--machinereadable] showvminfo <uuid|vmname> --log <idx> registervm <filename> unregistervm <uuid|vmname> [--delete] createvm --name <name> [--groups <group>, ...] [--ostype <ostype>] [--register] [--basefolder <path>] [--uuid <uuid>] [--default] 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] [--ioapic on|off] [--hpet on|off] [--triplefaultreset on|off] [--apic on|off] [--x2apic on|off] [--paravirtprovider none|default|legacy|minimal| 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] [--mds-clear-on-sched on|off] [--mds-clear-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] [--system-uuid-le on|off] [--boot<1-4> none|floppy|dvd|disk|net>] [--nic<1-N> none|null|nat|bridged|intnet|hostonly| generic|natnetwork] [--nictype<1-N> Am79C970A|Am79C973|Am79C960| 82540EM|82543GC|82545EM| virtio] [--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>], [<sockrcv>],[<tcpsnd>], [<tcprcv>]] [--natpf<1-N> [<rulename>],tcp|udp,[<hostip>], <hostport>,[<guestip>],<guestport>] [--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], [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| server <pipe>| client <pipe>| tcpserver <port>| tcpclient <hostname:port>| file <file>| <devicename>] [--uarttype<1-N> 16450|16550A|16750] [--lpt<1-N> off|<I/O base> <IRQ>] [--lptmode<1-N> <devicename>] [--guestmemoryballoon <balloonsize in MB>] [--vm-process-priority default|flat|low|normal|high] [--audio none|null|dsound|oss|alsa|pulse| oss|pulse|coreaudio] [--audioin on|off] [--audioout on|off] [--audiocontroller ac97|hda|sb16] [--audiocodec stac9700|ad1980|stac9221|sb16] [--clipboard-mode disabled|hosttoguest|guesttohost| bidirectional] [--draganddrop disabled|hosttoguest|guesttohost| 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] [--recordingscreens all|<screen ID> [<screen ID> ...]] [--recordingfile <filename>] [--recordingvideores <width> <height>] [--recordingvideorate <rate>] [--recordingvideofps <fps>] [--recordingmaxtime <s>] [--recordingmaxsize <MB>] [--recordingopts <key=value> [,<key=value> ...]] [--defaultfrontend default|<name>] movevm <uuid|vmname> --type basic [--folder <path>] import <ovfname/ovaname> [--dry-run|-n] [--options keepallmacs|keepnatmacs|importtovdi] [--vmname <name>] [--cloud] [--cloudprofile <cloud profile name>] [--cloudinstanceid <instance id>] [--cloudbucket <bucket name>] [more options] (run with -n to have options displayed for a particular OVF. It doesn't work for the Cloud import.) export <machines> --output|-o <name>.<ovf/ova/tar.gz> [--legacy09|--ovf09|--ovf10|--ovf20|--opc10] [--manifest] [--iso] [--options manifest|iso|nomacs|nomacsbutnat] [--vsys <number of virtual system>] [--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>] [--cloud <number of virtual system>] [--vmname <name>] [--cloudprofile <cloud profile name>] [--cloudbucket <bucket name>] [--cloudkeepobject <true/false>] [--cloudlaunchmode EMULATED|PARAVIRTUALIZED] [--cloudlaunchinstance <true/false>] [--clouddomain <domain>] [--cloudshape <shape>] [--clouddisksize <disk size in GB>] [--cloudocivcn <OCI vcn id>] [--cloudocisubnet <OCI subnet id>] [--cloudpublicip <true/false>] [--cloudprivateip <ip>] startvm <uuid|vmname>... [--type gui|sdl|headless|separate] [-E|--putenv <NAME>[=<VALUE>]] 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| 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>], <hostport>,[<guestip>],<guestport> | natpf<1-N> delete <rulename> | guestmemoryballoon <balloonsize in MB> | usbattach <uuid>|<address> [--capturefile <filename>] | usbdetach <uuid>|<address> | audioin on|off | audioout on|off | clipboard mode disabled|hosttoguest|guesttohost| bidirectional | draganddrop disabled|hosttoguest|guesttohost| bidirectional | vrde on|off | vrdeport <port> | vrdeproperty <name=[value]> | vrdevideochannelquality <percent> | setvideomodehint <xres> <yres> <bpp> [[<display>] [<enabled:yes|no> | [<xorigin> <yorigin>]]] | 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> --passwordfile <file> | <password> <domain> [--allowlocallogon <yes|no>] | teleport --host <name> --port <port> [--maxdowntime <msec>] [--passwordfile <file> | --password <password>] | plugcpu <id> | unplugcpu <id> | cpuexecutioncap <1-100> webcam <attach [path [settings]]> | <detach [path]> | <list> addencpassword <id> <password file>|- [--removeonsuspend <yes|no>] removeencpassword <id> removeallencpasswords changeuartmode<1-N> disconnected| server <pipe>| client <pipe>| tcpserver <port>| tcpclient <hostname:port>| file <file>| <devicename> vm-process-priority default|flat|low|normal|high discardstate <uuid|vmname> adoptstate <uuid|vmname> <state_file> closemedium [disk|dvd|floppy] <uuid|filename> [--delete] storageattach <uuid|vmname> --storagectl <name> [--port <number>] [--device <number>] [--type dvddrive|hdd|fdd] [--medium none|emptydrive|additions| <uuid|filename>|host:<drive>|iscsi] [--mtype normal|writethrough|immutable|shareable| 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] storagectl <uuid|vmname> --name <name> [--add ide|sata|scsi|floppy|sas|usb|pcie|virtio] [--controller LSILogic|LSILogicSAS|BusLogic| IntelAHCI|PIIX3|PIIX4|ICH6|I82078| [ USB|NVMe|VirtIO] [--portcount <1-n>] [--hostiocache on|off] [--bootable on|off] [--rename <name>] [--remove] bandwidthctl <uuid|vmname> add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] | set <name> --limit <megabytes per second>[k|m|g|K|M|G] | remove <name> | list [--machinereadable] (limit units: k=kilobit, m=megabit, g=gigabit, K=kilobyte, M=megabyte, G=gigabyte) showmediuminfo [disk|dvd|floppy] <uuid|filename> createmedium [disk|dvd|floppy] --filename <filename> [--size <megabytes>|--sizebyte <bytes>] [--diffparent <uuid>|<filename>] [--format VDI|VMDK|VHD] (default: VDI)] [--variant Standard,Fixed,Split2G,Stream,ESX, Formatted] [[--property <name>=<value>] --property <name>=<value]... modifymedium [disk|dvd|floppy] <uuid|filename> [--type normal|writethrough|immutable|shareable| readonly|multiattach] [--autoreset on|off] [--property <name=[value]>] [--compact] [--resize <megabytes>|--resizebyte <bytes>] [--move <path>] [--setlocation <path>] [--description <description string>] clonemedium [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile> [--format VDI|VMDK|VHD|RAW|<other>] [--variant Standard,Fixed,Split2G,Stream,ESX] [--existing] mediumproperty [disk|dvd|floppy] set <uuid|filename> <property> <value> [disk|dvd|floppy] get <uuid|filename> <property> [disk|dvd|floppy] delete <uuid|filename> <property> encryptmedium <uuid|filename> [--newpassword <file>|-] [--oldpassword <file>|-] [--cipher <cipher identifier>] [--newpasswordid <password identifier>] checkmediumpwd <uuid|filename> <pwd file>|- convertfromraw <filename> <outputfile> [--format VDI|VMDK|VHD] [--variant Standard,Fixed,Split2G,Stream,ESX] [--uuid <uuid>] convertfromraw stdin <outputfile> <bytes> [--format VDI|VMDK|VHD] [--variant Standard,Fixed,Split2G,Stream,ESX] [--uuid <uuid>] getextradata global|<uuid|vmname> <key>|[enumerate] setextradata global|<uuid|vmname> <key> [<value>] (no value deletes key) 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> usbfilter add <index,0-N> --target <uuid|vmname>|global --name <string> --action 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>] usbfilter modify <index,0-N> --target <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>] usbfilter remove <index,0-N> --target <uuid|vmname>|global guestproperty get <uuid|vmname> <property> [--verbose] guestproperty set <uuid|vmname> <property> [<value> [--flags <flags>]] guestproperty delete|unset <uuid|vmname> <property> guestproperty enumerate <uuid|vmname> [--patterns <patterns>] guestproperty wait <uuid|vmname> <patterns> [--timeout <msec>] [--fail-on-timeout] guestcontrol <uuid|vmname> [--verbose|-v] [--quiet|-q] [--username <name>] [--domain <domain>] [--passwordfile <file> | --password <password>] 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] -- <program/arg0> [argument1] ... [argumentN]] start [common-options] [--exe <path to executable>] [--timeout <msec>] [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] [--ignore-operhaned-processes] [--profile] -- <program/arg0> [argument1] ... [argumentN]] copyfrom [common-options] [--follow] [-R|--recursive] <guest-src0> [guest-src1 [...]] <host-dst> copyfrom [common-options] [--follow] [-R|--recursive] [--target-directory <host-dst-dir>] <guest-src0> [guest-src1 [...]] copyto [common-options] [--follow] [-R|--recursive] <host-src0> [host-src1 [...]] <guest-dst> copyto [common-options] [--follow] [-R|--recursive] [--target-directory <guest-dst>] <host-src0> [host-src1 [...]] mkdir|createdir[ectory] [common-options] [--parents] [--mode <mode>] <guest directory> [...] rmdir|removedir[ectory] [common-options] [-R|--recursive] <guest directory> [...] removefile|rm [common-options] [-f|--force] <guest file> [...] mv|move|ren[ame] [common-options] <source> [source1 [...]] <dest> mktemp|createtemp[orary] [common-options] [--secure] [--mode <mode>] [--tmpdir <directory>] <template> stat [common-options] <file> [...] guestcontrol <uuid|vmname> [--verbose|-v] [--quiet|-q] list <all|sessions|processes|files> [common-opts] closeprocess [common-options] < --session-id <ID> | --session-name <name or pattern> <PID1> [PID1 [...]] closesession [common-options] < --all | --session-id <ID> | --session-name <name or pattern> > updatega|updateguestadditions|updateadditions [--source <guest additions .ISO>] [--wait-start] [common-options] [-- [<argument1>] ... [<argumentN>]] watch [common-options] metrics list [*|host|<vmname> [<metric_list>]] (comma-separated) metrics setup [--period <seconds>] (default: 1) [--samples <count>] (default: 1) [--list] [*|host|<vmname> [<metric_list>]] metrics query [*|host|<vmname> [<metric_list>]] metrics enable [--list] [*|host|<vmname> [<metric_list>]] metrics disable [--list] [*|host|<vmname> [<metric_list>]] metrics collect [--period <seconds>] (default: 1) [--samples <count>] (default: 1) [--list] [--detach] [*|host|<vmname> [<metric_list>]] natnetwork add --netname <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>] natnetwork remove --netname <name> natnetwork modify --netname <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>] natnetwork start --netname <name> natnetwork stop --netname <name> natnetwork list [<pattern>] hostonlyif ipconfig <name> [--dhcp | --ip<ipv4> [--netmask<ipv4> (def: 255.255.255.0)] | --ipv6<ipv6> [--netmasklengthv6<length> (def: 64)]] create | remove <name> usbdevsource add <source name> --backend <backend> --address <address> usbdevsource remove <source name>

Each time VBoxManage is invoked, only one
command can be executed. However, a command might support several
subcommands which then can be invoked in one single call. The
following sections provide detailed reference information on the
different commands.

The list command gives relevant information
about your system and information about Oracle VM VirtualBox’s current
settings.

The following subcommands are available with VBoxManage
list:

This command changes the properties of a registered virtual
machine which is not running. Most of the properties that this
command makes available correspond to the VM settings that the
VirtualBox Manager displays in each VM’s
Settings dialog. These are
described in Chapter 3, Configuring Virtual Machines. However, some of
the more advanced settings are only available through the
VBoxManage interface.

These commands require that the machine is powered off, neither
running nor in a Saved state. Some machine settings can also be
changed while a machine is running. Those settings will then have
a corresponding subcommand with the VBoxManage
controlvm subcommand. See
Section 8.13, “VBoxManage controlvm”.

This command imports one or more virtual machines into
Oracle VM VirtualBox. You can import from either of the following:

See Section 1.14, “Importing and Exporting Virtual Machines” for more details on importing VMs into
Oracle VM VirtualBox.

VBoxManage import WindowsXp.ovf --dry-run Interpreting WindowsXp.ovf... OK. Virtual system 0: 0: Suggested OS type: "WindowsXP" (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all) 1: Suggested VM name "Windows XP Professional_1" (change with "--vsys 0 --vmname <name>") 2: Suggested VM group "/" (change with "--vsys 0 --group <group>") 3: Suggested VM settings file name "/home/klaus/VirtualBox VMs/dummy2 2/dummy2 2.vbox" (change with "--vsys 0 --settingsfile <filename>") 4: Suggested VM base folder "/home/klaus/VirtualBox VMs" (change with "--vsys 0 --basefolder <path>") 5: End-user license agreement (display with "--vsys 0 --eula show"; accept with "--vsys 0 --eula accept") 6: Number of CPUs: 1 (change with "--vsys 0 --cpus <n>") 7: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>") 8: Sound card (appliance expects "ensoniq1371", can change on import) (disable with "--vsys 0 --unit 5 --ignore") 9: USB controller (disable with "--vsys 0 --unit 6 --ignore") 10: Network adapter: orig bridged, config 2, extra type=bridged 11: Floppy (disable with "--vsys 0 --unit 8 --ignore") 12: SCSI controller, type BusLogic (change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}"; disable with "--vsys 0 --unit 9 --ignore") 13: IDE controller, type PIIX4 (disable with "--vsys 0 --unit 10 --ignore") 14: Hard disk image: source image=WindowsXp.vmdk, target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0 (change controller with "--vsys 0 --unit 11 --controller <id>"; disable with "--vsys 0 --unit 11 --ignore")

VBoxManage import WindowsXp.ovf --vsys 0 --unit 8 --ignore --unit 9 --ignore --unit 14 --controller 13

This command exports one or more virtual machines from
Oracle VM VirtualBox. You can export to either of the following:

See Section 1.14, “Importing and Exporting Virtual Machines” for more details on exporting VMs from
Oracle VM VirtualBox.

This command starts a virtual machine that is currently in the
Powered Off or Saved states.

The optional --type specifier
determines whether the machine will be started in a window or
whether the output should go through
VBoxHeadless, with VRDE enabled or not. See
Section 7.1.2, “VBoxHeadless, the Remote Desktop Server”. The list of types is subject to
change, and it is not guaranteed that all types are accepted by
any product variant.

The global or per-VM default value for the VM frontend type will
be taken if the type is not explicitly specified. If none of these
are set, the GUI variant will be started.

The following values are allowed:

The controlvm subcommand enables you to change
the state of a virtual machine that is currently running. The
following can be specified:

The following extra options are available with
controlvm that do not directly affect the VM’s
running state:

This command attaches, modifies, and removes a storage medium
connected to a storage controller that was previously added with
the storagectl command. The syntax is as
follows:

VBoxManage storageattach <uuid|vmname> --storagectl <name> [--port <number>] [--device <number>] [--type dvddrive|hdd|fdd] [--medium none|emptydrive|additions| <uuid>|<filename>|host:<drive>|iscsi] [--mtype normal|writethrough|immutable|shareable 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|none] [--forceunmount] [--server <name>|<ip>] [--target <target>] [--tport <port>] [--lun <lun>] [--encodedlun <lun>] [--username <username>] [--password <password>] [--passwordfile <file>] [--initiator <initiator>] [--intnet]

A number of parameters are commonly required. Some parameters are
required only for iSCSI targets.

The common parameters are as follows:

When iscsi is used with the
--medium parameter for iSCSI
support, additional parameters must or can be used. See also
Section 5.10, “iSCSI Servers”.

This command creates, deletes, modifies, and shows bandwidth
groups of the given virtual machine.

VBoxManage bandwidthctl <uuid|vmname> add <name> --type disk|network --limit <MBps>[k|m|g|K|M|G] | set <name> --limit <MBps>[k|m|g|K|M|G] | remove <name> | list [--machinereadable]

The following subcommands are available:

The parameters are as follows:

This command shows information about a medium, notably its size,
its size on disk, its type, and the virtual machines which use it.

VBoxManage showmediuminfo [disk|dvd|floppy] <uuid|filename>

The medium must be specified either by its UUID, if the medium is
registered, or by its filename. Registered images can be listed
using VBoxManage list hdds, VBoxManage
list dvds, or VBoxManage list
floppies, as appropriate. See
Section 8.4, “VBoxManage list”.

This command creates a new medium. The syntax is as follows:

VBoxManage createmedium [disk|dvd|floppy] --filename <filename> [--size <megabytes>|--sizebyte <bytes>] [--diffparent <uuid>|<filename> [--format VDI|VMDK|VHD] (default: VDI) [--variant Standard,Fixed,Split2G,Stream,ESX]

The parameters are as follows:

With the modifymedium command, you can change
the characteristics of a disk image after it has been created.

VBoxManage modifymedium [disk|dvd|floppy] <uuid|filename> [--type normal|writethrough|immutable|shareable| readonly|multiattach] [--autoreset on|off] [--property <name=[value]>] [--compact] [--resize <megabytes>|--resizebyte <bytes>] [--move <path>] [--setlocation <path>]

The disk image to modify must be specified either by its UUID, if
the medium is registered, or by its filename. Registered images
can be listed using VBoxManage list hdds, see
Section 8.4, “VBoxManage list”. A filename must be specified
as a valid path, either as an absolute path or as a relative path
starting from the current directory.

The following options are available:

This command duplicates a virtual disk, DVD, or floppy medium to a
new medium, usually an image file, with a new unique identifier
(UUID). The new image can be transferred to another host system or
reimported into Oracle VM VirtualBox using the Virtual Media Manager.
See Section 5.3, “The Virtual Media Manager” and Section 5.6, “Cloning Disk Images”.
The syntax is as follows:

VBoxManage clonemedium [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile> [--format VDI|VMDK|VHD|RAW|<other>] [--variant Standard,Fixed,Split2G,Stream,ESX] [--existing]

The medium to clone as well as the target image must be described
either by its UUIDs, if the mediums are registered, or by its
filename. Registered images can be listed by VBoxManage
list hdds. See Section 8.4, “VBoxManage list”. A
filename must be specified as valid path, either as an absolute
path or as a relative path starting from the current directory.

The following options are available:

This command converts a raw disk image to an Oracle VM VirtualBox Disk
Image (VDI) file. The syntax is as follows:

VBoxManage convertfromraw <filename> <outputfile> [--format VDI|VMDK|VHD] [--variant Standard,Fixed,Split2G,Stream,ESX] [--uuid <uuid>]
VBoxManage convertfromraw stdin <outputfile> <bytes> [--format VDI|VMDK|VHD] [--variant Standard,Fixed,Split2G,Stream,ESX] [--uuid <uuid>]

The parameters are as follows:

The stdin form of the command forces
VBoxManage to read the content of the disk
image from standard input. This useful when using the command in a
pipe.

This command is used to change global settings which affect the
entire Oracle VM VirtualBox installation. Some of these correspond to
the settings in the Preferences
dialog in the VirtualBox Manager. The following properties are
available:

VBoxManage usbfilter add <index,0-N> --target <uuid|vmname>global --name <string> --action 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>] 

VBoxManage usbfilter modify <index,0-N> --target <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>] 

VBoxManage usbfilter remove <index,0-N> --target <uuid|vmname>global 

The usbfilter commands are used for working
with USB filters in virtual machines, or global filters which
affect the whole Oracle VM VirtualBox setup. Global filters are applied
before machine-specific filters, and may be used to prevent
devices from being captured by any virtual machine. Global filters
are always applied in a particular order, and only the first
filter which fits a device is applied. For example, if the first
global filter says to hold, or make available, a particular
Kingston memory stick device and the second filter says to ignore
all Kingston devices. That particular Kingston memory stick will
be available to any machine with the appropriate filter, but no
other Kingston device will.

When creating a USB filter using usbfilter add,
you must supply three or four mandatory parameters. The index
specifies the position in the list at which the filter should be
placed. If there is already a filter at that position, then it and
the following ones will be shifted back one place. Otherwise, the
new filter will be added onto the end of the list. The
target parameter selects the
virtual machine that the filter should be attached to or use
global to apply it to all virtual
machines. name is a name for the
new filter. For global filters,
action says whether to allow VMs
access to devices that fit the filter description (hold) or not to
give them access (ignore). In addition, you should specify
parameters to filter by. You can find the parameters for devices
attached to your system using VBoxManage list
usbhost. Finally, you can specify whether the filter
should be active. For local filters, whether they are for local
devices, remote devices over an RDP connection, or either.

When you modify a USB filter using usbfilter
modify, you must specify the filter by index and by
target, which is either a virtual machine or
global. See the output of
VBoxManage list usbfilters to find global
filter indexes and VBoxManage showvminfo to
find indexes for individual machines. The properties which can be
changed are the same as for usbfilter add. To
remove a filter, use usbfilter remove and
specify the index and the target.

The following is a list of the additional usbfilter
add and usbfilter modify options,
with details of how to use them.

The guestproperty commands enable you to get or
set properties of a running virtual machine. See
Section 4.7, “Guest Properties”. Guest properties are
arbitrary keyword-value string pairs which can be written to and
read from by either the guest or the host, so they can be used as
a low-volume communication channel for strings, provided that a
guest is running and has the Guest Additions installed. In
addition, a number of values whose keywords begin with
/VirtualBox/are automatically set
and maintained by the Guest Additions.

The following subcommands are available, where
<vm> can either be a VM
name or a VM UUID, as with the other VBoxManage
commands:

The guestcontrol commands enable control of the
guest from the host. See
Section 4.9, “Guest Control of Applications” for an introduction.

The guestcontrol command has two sets of
subcommands. The first set requires guest credentials to be
specified, the second does not.

The first set of subcommands is of the following form:

VBoxManage guestcontrol <uuid|vmname> <sub-command> [--username <name> ] [--passwordfile <file> | --password <password>] [--domain <domain> ] [-v|--verbose] [-q|quiet] ... 

The common options are as follows:

 [--username <name> ] [--passwordfile <file> | --password <password>] [--domain <domain> ] [-v|--verbose] [-q|quiet] 

The common options for the first set of subcommands are explained
in the following list.

The first set of subcommands are as follows:

The second set of subcommands is of the form:

VBoxManage guestcontrol <uuid|vmname> <sub-command> [-v|--verbose] [-q|quiet] ... 

The common options are as follows:

 [-v|--verbose] [-q|--quiet] 

Details of the common options for the second set of subcommands
are as follows:

The second set of subcommands are as follows:

This command supports monitoring the usage of system resources.
Resources are represented by various metrics associated with the
host system or a particular VM. For example, the host system has a
CPU/Load/User metric that shows
the percentage of time CPUs spend executing in user mode over a
specific sampling period.

Metric data is collected and retained internally. It may be
retrieved at any time with the VBoxManage metrics
query subcommand. The data is available as long as the
background VBoxSVC process is
alive. That process terminates shortly after all VMs and frontends
have been closed.

By default no metrics are collected at all. Metrics collection
does not start until VBoxManage metrics setup
is invoked with a proper sampling interval and the number of
metrics to be retained. The interval is measured in seconds. For
example, to enable collecting the host processor and memory usage
metrics every second and keeping the five most current samples,
the following command can be used:

VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage

Metric collection can only be enabled for started VMs. Collected
data and collection settings for a particular VM will disappear as
soon as it shuts down. Use the VBoxManage metrics
list subcommand to see which metrics are currently
available. You can also use the --list option
with any subcommand that modifies metric settings to find out
which metrics were affected.

Note that the VBoxManage metrics setup
subcommand discards all samples that may have been previously
collected for the specified set of objects and metrics.

To enable or disable metrics collection without discarding the
data, VBoxManage metrics enable and
VBoxManage metrics disable subcommands can be
used. Note that these subcommands expect metrics as parameters,
not submetrics such as CPU/Load
or RAM/Usage. In other words
enabling CPU/Load/User while
disabling CPU/Load/Kernel is not
supported.

The host and VMs have different sets of associated metrics.
Available metrics can be listed with VBoxManage metrics
list subcommand.

A complete metric name may include an aggregate function. The name
has the following form:
Category/Metric[/SubMetric][:aggregate].
For example, RAM/Usage/Free:min
stands for the minimum amount of available memory over all
retained data if applied to the host object.

Subcommands may apply to all objects and metrics or can be limited
to one object and a list of metrics. If no objects or metrics are
given in the parameters, the subcommands will apply to all
available metrics of all objects. You may use an asterisk
“*” to explicitly specify that
the command should be applied to all objects or metrics. Use
host as the object name to limit
the scope of the command to host-related metrics. To limit the
scope to a subset of metrics, use a metric list with names
separated by commas.

For example, to query metric data on the CPU time spent in user
and kernel modes by the virtual machine named
test, use the following command:

VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel

The following list summarizes the available subcommands:

NAT networks use the Network Address Translation (NAT) service,
which works in a similar way to a home router. It groups systems
using it into a network and prevents outside systems from directly
accessing those inside, while letting systems inside communicate
with each other and outside systems using TCP and UDP over IPv4
and IPv6.

A NAT service is attached to an internal network. Virtual machines
to make use of one should be attached to it. The name of an
internal network is chosen when the NAT service is created, and
the internal network will be created if it does not already exist.
The following is an example command to create a NAT network:

VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable

Here, natnet1 is the name of the
internal network to be used and
192.168.15.0/24 is the network
address and mask of the NAT service interface. By default, in this
static configuration the gateway will be assigned the address
192.168.15.1, the address after the interface address, though this
is subject to change.

To add a DHCP server to the NAT network after creation, run the
following command:

VBoxManage natnetwork modify --netname natnet1 --dhcp on

The subcommands for VBoxManage natnetwork are
as follows:

VBoxManage natnetwork add --netname <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>] 

VBoxManage natnetwork add: Creates a new
internal network interface, and adds a NAT network service. This
command is a prerequisite for enabling attachment of VMs to the
NAT network. Parameters are as follows:

VBoxManage natnetwork remove --netname <name> 

VBoxManage natnetwork remove: Removes a NAT
network service. Parameters are as follows:

VBoxManage natnetwork modify --netname <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>] 

VBoxManage natnetwork modify: Modifies an
existing NAT network service. Parameters are as follows:

VBoxManage natnetwork start --netname <name> 

VBoxManage natnetwork start: Starts the
specified NAT network service and any associated DHCP server.
Parameters are as follows:

VBoxManage natnetwork stop --netname <name> 

VBoxManage natnetwork stop: Stops the specified
NAT network service and any DHCP server. Parameters are as
follows:

VBoxManage natnetwork list [<pattern>] 

VBoxManage natnetwork list: Lists all NAT
network services, with optional filtering. Parameters are as
follows: