user_VBoxManage.xml revision f34e466484d9727a000bac50c2e198c0173168d4
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>As briefly mentioned in <xref linkend="frontends" />, VBoxManage is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the command-line interface to VirtualBox. With it, you can completely
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync control VirtualBox from the command line of your host operating system.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VBoxManage supports all the features that the graphical user interface
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync gives you access to, but it supports a lot more than that. It exposes
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync really all the features of the virtualization engine, even those that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cannot (yet) be accessed from the GUI.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You will need to use the command line if you want to</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>use a different user interface than the main GUI (for example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VBoxSDL or the VBoxHeadless server);</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>control some of the more advanced and experimental
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync configuration settings for a VM.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>There are two main things to keep in mind when using
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage</computeroutput>: First,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage</computeroutput> must always be used with a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specific "subcommand", such as "list" or "createvm" or "startvm". All the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync subcommands that <computeroutput>VBoxManage</computeroutput> supports are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync described in detail in <xref linkend="vboxmanage" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Second, most of these subcommands require that you specify a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync particular virtual machine after the subcommand. There are two ways you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync can do this:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You can specify the VM name, as it is shown in the VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync GUI. Note that if that name contains spaces, then you must enclose the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync entire name in double quotes (as it is always required with command
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync line arguments that contain spaces).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For example:<screen>VBoxManage startvm "Windows XP"</screen></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You can specify the UUID, which is the internal unique
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync identifier that VirtualBox uses to refer to the virtual machine.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Assuming that the aforementioned VM called "Windows XP" has the UUID
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync shown below, the following command has the same effect as the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync previous:<screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You can type <computeroutput>VBoxManage list vms</computeroutput> to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync have all currently registered VMs listed with all their settings,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync including their respective names and UUIDs.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Some typical examples of how to control VirtualBox from the command
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync line are listed below:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To create a new virtual machine from the command line and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync immediately register it with VirtualBox, use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage createvm</computeroutput> with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--register</computeroutput> option,<footnote>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>$ VBoxManage createvm --name "SUSE 10.2" --register
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncAll rights reserved.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVirtual machine 'SUSE 10.2' is created.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
f34e466484d9727a000bac50c2e198c0173168d4vboxsyncSettings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>As can be seen from the above output, a new virtual machine has
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync been created with a new UUID and a new XML settings file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To show the configuration of a particular VM, use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage showvminfo</computeroutput>; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="vboxmanage-showvminfo" /> for details and an example.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To change settings while a VM is powered off, use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm</computeroutput>, e.g. as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync follows:<screen>VBoxManage modifyvm "Windows XP" --memory "512MB"</screen></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For details, see <xref linkend="vboxmanage-modifyvm" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync <para>To change the storage configuration (e.g. to add a storage
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync controller and then a virtual disk), use <computeroutput>VBoxManage
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync storagectl</computeroutput> and <computeroutput>VBoxManage
e7c4c205cb0af88b5ef0786be46da94847a9a37bvboxsync linkend="vboxmanage-storageattach" /> for details.</para>
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To control VM operation, use one of the following:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To start a VM that is currently powered off, use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage startvm</computeroutput>; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="vboxmanage-startvm" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To pause or save a VM that is currently running or change
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync some of its settings, use <computeroutput>VBoxManage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="vboxmanage-controlvm" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>When running VBoxManage without parameters or when supplying an
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync invalid command line, the below syntax diagram will be shown. Note that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the output will be slightly different depending on the host platform; when
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for the commands available on your particular host.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Each time VBoxManage is invoked, only one command can be executed.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync However, a command might support several subcommands which then can be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync invoked in one single call. The following sections provide detailed
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync reference information on the different commands.</para>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <itemizedlist>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para><computeroutput>--version</computeroutput>: show the version of
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync this tool and exit.</para>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync </listitem>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para><computeroutput>--nologo</computeroutput>: suppress the output
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync of the logo information (useful for scripts)</para>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync </listitem>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para><computeroutput>--settingspw</computeroutput>: specifiy a settings
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync password</para>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync </listitem>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para><computeroutput>--settingspwfile</computeroutput>: specify a file
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync containing the settings password.</para>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync </listitem>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync </itemizedlist>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync The settings password is used for certain settings which need to be
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync stored encrypted for security reasons. At the moment, the only encrypted
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync setting is the iSCSI initiator secret (see
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <xref linkend="vboxmanage-storageattach" /> for details). As long as no
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync settings password is specified, this information is stored in
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <emphasis role="bold">plain text</emphasis>. After using the
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <computeroutput>--settingspw|--settingspwfile</computeroutput> option
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync once, it must be always used, otherwise the encrypted setting cannot
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync be unencrypted.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>list</computeroutput> command gives relevant
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information about your system and information about VirtualBox's current
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync settings.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following subcommands are available with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>vms</computeroutput> lists all virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machines currently registered with VirtualBox. By default this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync displays a compact list with each VM's name and UUID; if you also
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>-l</computeroutput>, this will be a detailed list as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync with the <computeroutput>showvminfo</computeroutput> command (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync below).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>runningvms</computeroutput> lists all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync currently running virtual machines by their unique identifiers
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (UUIDs) in the same format as with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>ostypes</computeroutput> lists all guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operating systems presently known to VirtualBox, along with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync identifiers used to refer to them with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>modifyvm</computeroutput> command.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>hostfloppies</computeroutput>, respectively, list
241adddf415cbdf66230864a215b24415f482e72vboxsync DVD, floppy, bridged networking and host-only networking interfaces
241adddf415cbdf66230864a215b24415f482e72vboxsync on the host, along with the name used to access them from within
241adddf415cbdf66230864a215b24415f482e72vboxsync VirtualBox.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>dhcpservers</computeroutput>, respectively, list
241adddf415cbdf66230864a215b24415f482e72vboxsync bridged network interfaces, host-only network interfaces and DHCP
241adddf415cbdf66230864a215b24415f482e72vboxsync servers currently available on the host. Please see <xref
241adddf415cbdf66230864a215b24415f482e72vboxsync linkend="networkingdetails" /> for details on these.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>hostinfo</computeroutput> displays information
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync about the host system, such as CPUs, memory size and operating
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync system version.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>hostcpuids</computeroutput> dumps the CPUID
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync parameters for the host CPUs. This can be used for a more fine
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync grained analyis of the host's virtualization capabilities.</para>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>hddbackends</computeroutput> lists all known
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync virtual disk back-ends of VirtualBox. For each such format (such as
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync VDI, VMDK or RAW), this lists the back-end's capabilities and
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync configuration.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>floppies</computeroutput> all give you information
241adddf415cbdf66230864a215b24415f482e72vboxsync about virtual disk images currently in use by VirtualBox, including
241adddf415cbdf66230864a215b24415f482e72vboxsync all their settings, the unique identifiers (UUIDs) associated with
241adddf415cbdf66230864a215b24415f482e72vboxsync them by VirtualBox and all files associated with them. This is the
241adddf415cbdf66230864a215b24415f482e72vboxsync command-line equivalent of the Virtual Media Manager; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>usbhost</computeroutput> supplies information
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync about USB devices attached to the host, notably information useful
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync for constructing USB filters and whether they are currently in use
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync by the host.</para>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>usbfilters</computeroutput> lists all global
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync USB filters registered with VirtualBox -- that is, filters for
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync devices which are accessible to all virtual machines -- and displays
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync the filter parameters.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para><computeroutput>systemproperties</computeroutput> displays
241adddf415cbdf66230864a215b24415f482e72vboxsync some global VirtualBox settings, such as minimum and maximum guest
241adddf415cbdf66230864a215b24415f482e72vboxsync RAM and virtual hard disk size, folder settings and the current
241adddf415cbdf66230864a215b24415f482e72vboxsync authentication library in use.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para><computeroutput>extpacks</computeroutput> displays all
241adddf415cbdf66230864a215b24415f482e72vboxsync VirtualBox extension packs currently installed; see <xref
241adddf415cbdf66230864a215b24415f482e72vboxsync linkend="vboxmanage-extpack" /> for more information.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>showvminfo</computeroutput> command shows
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information about a particular virtual machine. This is the same
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information as <computeroutput>VBoxManage list vms --long</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync would show for all virtual machines.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You will get information similar to the following:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncAll rights reserved.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncName: Windows XP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
44385c60e28857348aa65ea1a9fc58a41cb0754evboxsyncConfig file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncMemory size: 512MB
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVRAM size: 12MB
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNumber of CPUs: 2
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncSynthetic Cpu: off
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncBoot menu mode: message and menu
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncBoot Device (1): DVD
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncBoot Device (2): HardDisk
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncBoot Device (3): Not Assigned
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncBoot Device (4): Not Assigned
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncTime offset: 0 ms
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNested Paging: on
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVT-x VPID: off
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncState: powered off (since 2009-10-20T14:52:19.000000000)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncMonitor count: 1
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync3D Acceleration: off
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync2D Video Acceleration: off
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncTeleporter Enabled: off
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncTeleporter Port: 0
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncTeleporter Address:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncTeleporter Password:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncStorage Controller (0): IDE Controller
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncStorage Controller Type (0): PIIX4
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncStorage Controller (1): Floppy Controller 1
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncStorage Controller Type (1): I82078
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncIDE Controller (0, 0): /home/user/windows.vdi (UUID: 46f6e53a-4557-460a-9b95-68b0f17d744b)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncIDE Controller (0, 1): /home/user/openbsd-cd46.iso (UUID: 4335e162-59d3-4512-91d5-b63e94eebe0b)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncFloppy Controller 1 (0, 0): /home/user/floppy.img (UUID: 62ac6ccb-df36-42f2-972e-22f836368137)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 1: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 2: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 3: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 4: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 5: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 6: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 7: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncNIC 8: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUART 1: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUART 2: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncAudio: disabled (Driver: Unknown)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncClipboard Mode: Bidirectional
4791a729647f035b6561d292c9f848dd1fc797a9vboxsyncVRDE: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUSB: disabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncUSB Device Filters:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync<none>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncShared folders:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync<none>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <title>VBoxManage registervm / unregistervm</title>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>registervm</computeroutput> command allows you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to import a virtual machine definition in an XML file into VirtualBox. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine must not conflict with one already registered in VirtualBox and it
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync may not have any hard or removable disks attached. It is advisable to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync place the definition file in the machines folder before registering
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>When creating a new virtual machine with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage createvm</computeroutput> (see below), you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync can directly specify the <computeroutput>--register</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option to avoid having to register it separately.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>unregistervm</computeroutput> command
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync unregisters a virtual machine. If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--delete</computeroutput> is also specified, the following
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync files will automatically be deleted as well:<orderedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>all hard disk image files, including differencing files, which
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync are used by the machine and not shared with other machines;</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>saved state files that the machine created, if any (one if the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine was in "saved" state and one for each online
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync snapshot);</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>the machine directory, if it is empty after having deleted all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the above.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command creates a new XML virtual machine definition
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>--name <name></computeroutput> parameter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is required and must specify the name of the machine. Since this name is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync used by default as the file name of the settings file (with the extension
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
44385c60e28857348aa65ea1a9fc58a41cb0754evboxsync of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder - this folder name may vary depending on the operating system and the version of VirtualBox which you are using), it
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync must conform to your host operating system's requirements for file name
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specifications. If the VM is later renamed, the file and folder names will
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync change automatically.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <path></computeroutput> option is used, the machine folder will be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync named <computeroutput><path></computeroutput>. In this case, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync names of the file and the folder will not change if the virtual machine is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync renamed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>By default, this command only creates the XML file without
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync automatically registering the VM with your VirtualBox installation. To
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync register the VM instantly, use the optional
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--register</computeroutput> option, or run
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage registervm</computeroutput> separately
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync afterwards.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command changes the properties of a registered virtual machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which is not running. Most of the properties that this command makes
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync available correspond to the VM settings that VirtualBox graphical user
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface displays in each VM's "Settings" dialog; these were described in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="BasicConcepts" />. Some of the more advanced settings,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync however, are only available through the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage</computeroutput> interface.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>These commands require that the machine is powered off (neither
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync running nor in "saved" state). Some machine settings can also be changed
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync while a machine is running; those settings will then have a corresponding
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following general settings are available through
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--name <name></computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync changes the VM's name and possibly renames the internal virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine files, as described with <computeroutput>VBoxManage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--ostype <ostype></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This specifies what guest operating system is supposed to run in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the VM. To learn about the various identifiers that can be used
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync here, use <computeroutput>VBoxManage list
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <memorysize></computeroutput>: This sets the amount of RAM,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in MB, that the virtual machine should allocate for itself from
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the host. See the remarks in <xref linkend="gui-createvm" /> for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync more information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vram <vramsize></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This sets the amount of RAM that the virtual graphics card should
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync have. See <xref linkend="settings-display" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--acpi on|off</computeroutput>;
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--ioapic on|off</computeroutput>: These two
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync determine whether the VM should have ACPI and I/O APIC support,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync respectively; see <xref linkend="settings-motherboard" /> for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <uuid></computeroutput>: The UUID presented to the guest via
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync memory tables (DMI/SMBIOS), hardware and guest properties. By
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default this is the same as the VM uuid. Useful when cloning a VM.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Teleporting takes care of this automatically.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--cpus <cpucount></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This sets the number of virtual CPUs for the virtual machine (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="settings-processor" />). If CPU hot-plugging is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enabled (see below), this then sets the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <emphasis>maximum</emphasis> number of virtual CPUs that can be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync plugged into the virtual machines.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--rtcuseutc on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option lets the real-time clock (RTC) operate in UTC time (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--cpuhotplug on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables CPU hot-plugging. When enabled, virtual CPUs can be added
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to and removed from a virtual machine while it is running. See
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="cpuhotplug" /> for more information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <id></computeroutput>: If CPU hot-plugging is enabled (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync above), this adds a virtual CPU to the virtual machines (or
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync removes one). <computeroutput><id></computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specifies the index of the virtual CPU to be added or removed and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync must be a number from 0 to the maximum no. of CPUs configured with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the <computeroutput>--cpus</computeroutput> option. CPU 0 can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync never be removed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
223935479ac42db56b7b7a7d16548d590022996avboxsync <1-100></computeroutput>: This setting controls how much cpu
223935479ac42db56b7b7a7d16548d590022996avboxsync time a virtual CPU can use. A value of 50 implies a single virtual
223935479ac42db56b7b7a7d16548d590022996avboxsync CPU can use up to 50% of a single host CPU.</para>
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync </listitem>
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync <para><computeroutput>--pae on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync <para><computeroutput>--longmode on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync <para><computeroutput>--synthcpu on|off</computeroutput>: This
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync setting determines whether VirtualBox will expose a synthetic CPU
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync to the guest to allow live migration between host systems that
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync differ significantly.</para>
8fdb854581fe3cb394d84835dc09b02e6e18d4edvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--hpet on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables/disables a High Precision Event Timer (HPET) which can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync replace the legacy system timers. This is turned off by default.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Note that Windows supports a HPET only from Vista onwards.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync <para><computeroutput>--hwvirtex on|off</computeroutput>: This
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync enables or disables the use of hardware virtualization extensions
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync (Intel VT-x or AMD-V) in the processor of your host system; see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync <para><computeroutput>--triplefaultreset on|off</computeroutput>:
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync This setting allows to reset the guest instead of triggering a
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync Guru Meditation. Some guests raise a triple fault to reset the
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync CPU so sometimes this is desired behavior. Works only for non-SMP
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync guests.</para>
be25dc687bf6545229bd498c72ff1ef047ff0f27vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--nestedpaging on|off</computeroutput>: If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hardware virtualization is enabled, this additional setting
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables or disables the use of the nested paging feature in the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync processor of your host system; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--largepages on|off</computeroutput>: If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hardware virtualization <emphasis>and</emphasis> nested paging are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enabled, for Intel VT-x only, an additional performance
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync improvement of up to 5% can be obtained by enabling this setting.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This causes the hypervisor to use large pages to reduce TLB use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and overhead.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vtxvpid on|off</computeroutput>: If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hardware virtualization is enabled, for Intel VT-x only, this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync additional setting enables or disables the use of the tagged TLB
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (VPID) feature in the processor of your host system; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
ee1d93e48caef47c819586e7d765befa196be79cvboxsync <para><computeroutput>--vtxux on|off</computeroutput>: If
ee1d93e48caef47c819586e7d765befa196be79cvboxsync hardware virtualization is enabled, for Intel VT-x only, this
ee1d93e48caef47c819586e7d765befa196be79cvboxsync setting enables or disables the use of the unrestricted guest mode
ee1d93e48caef47c819586e7d765befa196be79cvboxsync feature for executing your guest.</para>
ee1d93e48caef47c819586e7d765befa196be79cvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--accelerate3d on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables, if the Guest Additions are installed, whether hardware 3D
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync acceleration should be available; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You can influence the BIOS logo that is displayed when a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machine starts up with a number of settings. Per default,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync a VirtualBox logo is displayed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput> and <computeroutput>--bioslogofadeout
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>, you can determine whether the logo should
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync fade in and out, respectively.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <msec></computeroutput> you can set how long the logo should
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be visible, in milliseconds.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <imagepath></computeroutput> you can, if you are so
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync inclined, replace the image that is shown, with your own logo. The
abc527412b0fdb03c7626721ee67f8ab133b588avboxsync image must be an uncompressed 256 color BMP file without color
abc527412b0fdb03c7626721ee67f8ab133b588avboxsync space information (Windows 3.0 format). The image must not be
abc527412b0fdb03c7626721ee67f8ab133b588avboxsync bigger than 640 x 480.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disabled|menuonly|messageandmenu</computeroutput>: This specifies
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync whether the BIOS allows the user to select a temporary boot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync device. <computeroutput>menuonly</computeroutput> suppresses the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync message, but the user can still press F12 to select a temporary
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync boot device.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync <priority></computeroutput>: This specifies the order in which
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync NICs are tried for booting over the network (using PXE). The
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync priority is an integer in the 0 to 4 range. Priority 1 is the
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync highest, priority 4 is low. Priority 0, which is the default unless
574d36adfdd4d9e62af3640ecde108bdefb1c663vboxsync otherwise specified, is the lowest.
574d36adfdd4d9e62af3640ecde108bdefb1c663vboxsync <para> Note that this option only has effect when the Intel PXE boot
574d36adfdd4d9e62af3640ecde108bdefb1c663vboxsync ROM is used.
574d36adfdd4d9e62af3640ecde108bdefb1c663vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync none|floppy|dvd|disk|net</computeroutput>: This specifies the boot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync order for the virtual machine. There are four "slots", which the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VM will try to access from 1 to 4, and for each of which you can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync set a device that the VM should attempt to boot from.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default|<path></computeroutput>: This allows you to specify
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the folder in which snapshots will be kept for a virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--firmware efi|bios</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Specifies which firmware is used to boot particular virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine: EFI or BIOS. Use EFI only if your fully understand what
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync you're doing.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <size></computeroutput> sets the default size of the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync memory balloon, that is, memory allocated by the VirtualBox Guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Additions from the guest operating system and returned to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hypervisor for re-use by other virtual machines. <size> must
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be specified in megabytes. The default size is 0 megabytes. For
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details, see <xref linkend="guestadd-balloon" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync <Device></computeroutput>
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync Specifies the Device Name of the parallel port that
d2f75d9ba9861d2f77e46d06b818eff7dc680982vboxsync the Parallel Port feature will be using. Use this
d2f75d9ba9861d2f77e46d06b818eff7dc680982vboxsync <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
d2f75d9ba9861d2f77e46d06b818eff7dc680982vboxsync This feature is host operating system specific.</para>
3e0090e25f336e84cefbe2697bec04151abfc44dvboxsync </listitem>
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync <I/O base> <IRQ></computeroutput>
d2f75d9ba9861d2f77e46d06b818eff7dc680982vboxsync Specifies the I/O address of the parallel port and the IRQ
d2f75d9ba9861d2f77e46d06b818eff7dc680982vboxsync number that the Parallel Port feature will be using. Use this
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
5f33a06f645ac83b9e28a1b792fd80df96676e11vboxsync the values that guest sees i.e. the values avalable under guest Device Manager.</para>
3e0090e25f336e84cefbe2697bec04151abfc44dvboxsync </listitem>
904810c4c6668233349b025cc58013cb7c11c701vboxsync default|<name></computeroutput>: This allows you to specify
904810c4c6668233349b025cc58013cb7c11c701vboxsync the default frontend which will be used when starting this VM; see
904810c4c6668233349b025cc58013cb7c11c701vboxsync <xref linkend="vboxmanage-startvm" /> for details.</para>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following networking settings are available through
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm</computeroutput>. With all these
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync settings, the decimal number directly following the option name ("1-N"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in the list below) specifies the virtual network adapter whose settings
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync should be changed.<itemizedlist>
447cbf113f44132911fc13dc33cb26603759b82evboxsync none|null|nat|bridged|intnet|hostonly|generic
447cbf113f44132911fc13dc33cb26603759b82evboxsync </computeroutput>: With
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this, you can set, for each of the VM's virtual network cards,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync what type of networking should be available. They can be not
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync present (<computeroutput>none</computeroutput>), not connected to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the host (<computeroutput>null</computeroutput>), use network
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync address translation (<computeroutput>nat</computeroutput>),
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync bridged networking (<computeroutput>bridged</computeroutput>) or
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync communicate with other virtual machines using internal networking
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>intnet</computeroutput>), host-only networking
447cbf113f44132911fc13dc33cb26603759b82evboxsync (<computeroutput>hostonly</computeroutput>), or access rarely used
447cbf113f44132911fc13dc33cb26603759b82evboxsync sub-modes (<computeroutput>generic</computeroutput>).
447cbf113f44132911fc13dc33cb26603759b82evboxsync These options correspond
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to the modes which are described in detail in <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Am79C970A|Am79C973|82540EM|82543GC|82545EM|virtio</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This allows you, for each of the VM's virtual network cards, to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specify which networking hardware VirtualBox presents to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>: This allows you to temporarily disconnect
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync a virtual network interface, as if a network cable had been pulled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync from a real network card. This might be useful for resetting
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync certain software components in the VM.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With the "nictrace" options, you can optionally trace
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network traffic by dumping it to a file, for debugging
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync purposes.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>, you can enable network tracing for a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync particular virtual network card.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If enabled, you must specify with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--nictracefile<1-N>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <filename></computeroutput> what file the trace should be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync logged to.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync none|<devicename></computeroutput>: If bridged networking
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync has been enabled for a virtual network card (see the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--nic</computeroutput> option above; otherwise
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this setting has no effect), use this option to specify which host
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface the given virtual network interface will use. For
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details, please see <xref linkend="network_bridged" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync none|<devicename></computeroutput>: If host-only networking
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync has been enabled for a virtual network card (see the --nic option
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync above; otherwise this setting has no effect), use this option to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specify which host-only networking interface the given virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network interface will use. For details, please see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network</computeroutput>: If internal networking has been enabled
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for a virtual network card (see the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--nic</computeroutput> option above; otherwise
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this setting has no effect), use this option to specify the name
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of the internal network (see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync auto|<mac></computeroutput>: With this option you can set
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the MAC address of the virtual network card. Normally, each
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual network card is assigned a random address by VirtualBox at
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VM creation.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <backend driver></computeroutput>: If generic networking has been
447cbf113f44132911fc13dc33cb26603759b82evboxsync enabled for a virtual network card (see the
447cbf113f44132911fc13dc33cb26603759b82evboxsync <computeroutput>--nic</computeroutput> option above; otherwise
447cbf113f44132911fc13dc33cb26603759b82evboxsync this setting has no effect), this mode allows you to access
447cbf113f44132911fc13dc33cb26603759b82evboxsync rarely used networking sub-modes, such as VDE network or UDP Tunnel.
447cbf113f44132911fc13dc33cb26603759b82evboxsync </listitem>
447cbf113f44132911fc13dc33cb26603759b82evboxsync <paramname>="paramvalue"</computeroutput>:
447cbf113f44132911fc13dc33cb26603759b82evboxsync This option, in combination with "nicgenericdrv" allows you to
447cbf113f44132911fc13dc33cb26603759b82evboxsync pass parameters to rarely-used network backends.</para><para>
447cbf113f44132911fc13dc33cb26603759b82evboxsync Those parameters are backend engine-specific, and are different
4fac78486305f1f002adbf23953382e5d832af94vboxsync between UDP Tunnel and the VDE backend drivers. For example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following NAT networking settings are available through
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm</computeroutput>. With all these
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync settings, the decimal number directly following the option name ("1-N"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in the list below) specifies the virtual network adapter whose
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync settings should be changed.<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>],
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <guestport></computeroutput>: This option defines a NAT
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync port-forwarding rule (please see <xref linkend="natforward" />
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <name></computeroutput>: This option deletes a NAT
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync port-forwarding rule (please see <xref linkend="natforward" />
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <prefix></computeroutput>: This option defines a prefix
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for the built-in TFTP server, i.e. where the boot file is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync located (please see <xref linkend="nat-tftp" /> and <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <bootfile></computeroutput>: This option defines the TFT
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync boot file (please see <xref linkend="nat-adv-tftp" /> for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <tftpserver></computeroutput>: This option defines the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync TFTP server address to boot from (please see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--natdnspassdomain<1-N>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>: This option specifies whether the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync built-in DHCP server passes the domain name for network name
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync resolution.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>: This option makes the NAT engine proxy
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync all guest DNS requests to the host's DNS servers (please see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="nat-adv-dns" /> for details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--natdnshostresolver<1-N>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync on|off</computeroutput>: This option makes the NAT engine use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the host's resolver mechanisms to handle DNS requests (please
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="nat-adv-dns" /> for details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [<tcprcv>]</computeroutput>: This option controls several
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync NAT settings (please see <xref linkend="nat-adv-settings" /> for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default|[log],[proxyonly],[sameports]</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option defines behaviour of NAT engine core: log - enables
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync logging, proxyonly - switches of aliasing mode makes NAT
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync transparent, sameports enforces NAT engine to send packets via
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the same port as they originated on, default - disable all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync mentioned modes above . (please see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <title>Serial port, audio, clipboard and USB settings</title>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following other hardware settings are available through
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--uart<1-N> off|<I/O base>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <IRQ></computeroutput>: With this option you can configure
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual serial ports for the VM; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="serialports" /> for an introduction.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <arg></computeroutput>: This setting controls how VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync connects a given virtual serial port (previously configured with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the <computeroutput>--uartX</computeroutput> setting, see above)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to the host on which the virtual machine is running. As described
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in detail in <xref linkend="serialports" />, for each such port,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync you can specify <computeroutput><arg></computeroutput> as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync one of the following options:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>disconnected</computeroutput>: Even
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync though the serial port is shown to the guest, it has no
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "other end" -- like a real COM port without a cable.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <pipename></computeroutput>: On a Windows host, this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync tells VirtualBox to create a named pipe on the host named
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><pipename></computeroutput> and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync connect the virtual serial device to it. Note that Windows
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync requires that the name of a named pipe begin with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>On a Linux host, instead of a named pipe, a local
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync domain socket is used.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <pipename></computeroutput>: This operates just like
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>server ...</computeroutput>, except that the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pipe (or local domain socket) is not created by VirtualBox,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync but assumed to exist already.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput><devicename></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync If, instead of the above, the device name of a physical
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hardware serial port of the host is specified, the virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync serial port is connected to that hardware port. On a Windows
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync host, the device name will be a COM port such as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>COM1</computeroutput>; on a Linux host, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync device name will look like
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>/dev/ttyS0</computeroutput>. This allows you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to "wire" a real serial port to a virtual machine.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--audio none|null|oss</computeroutput>: With
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this option, you can set whether the VM should have audio
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync support.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync With this setting, you can select whether the guest operating
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync system's clipboard should be shared with the host; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="generalsettings" />. This requires that the Guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Additions be installed in the virtual machine.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <count></computeroutput>: This enables multi-monitor
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync support; see <xref linkend="settings-display" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--usb on|off</computeroutput>: This option
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables or disables the VM's virtual USB controller; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--usbehci on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option enables or disables the VM's virtual USB 2.0 controller;
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="settings-usb" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following settings that affect remote machine behavior are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync available through <computeroutput>VBoxManage
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>--vrde on|off</computeroutput>: With the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VirtualBox graphical user interface, this enables or disables the
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync VirtualBox remote desktop extension (VRDE) server. Note that if
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync you are using <computeroutput>VBoxHeadless</computeroutput> (see
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <xref linkend="vboxheadless" />), VRDE is enabled by
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync default.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default|<ports></computeroutput>: A port or a range of ports
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync the VRDE server can bind to; "default" or "0" means port 3389, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync standard port for RDP. You can specify a comma-separated list of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ports or ranges of ports. Use a dash between two port numbers to
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync specify a range. The VRDE server will bind to <emphasis
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync role="bold">one</emphasis> of available ports from the specified
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync list. Only one machine can use a given port at a time. For
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync example, the option <computeroutput> --vrdeport
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 5000,5010-5012</computeroutput> will tell the server to bind to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync one of following ports: 5000, 5010, 5011 or 5012.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync address></computeroutput>: The IP address of the host network
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync interface the VRDE server will bind to. If specified, the server
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync will accept connections only on the specified host network
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface.</para>
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync <para>The setting can be used to specify whether the VRDP server
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync should accept either IPv4 or IPv6 or both connections:
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync <itemizedlist>
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync <para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync </listitem>
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync <para>only IPv6: <computeroutput>--vrdeaddress "::"
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync </listitem>
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync <para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress ""
b8681035754610e0700a2d9bd9859b2f2a981bd4vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync null|external|guest</computeroutput>: This allows you to choose
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync whether and how authorization will be performed; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>--vrdemulticon on|off</computeroutput>: This
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync enables multiple connections to the same VRDE server, if the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>--vrdereusecon on|off</computeroutput>: This
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync specifies the VRDE server behavior when multiple connections are
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync disabled. When this option is enabled, the server will allow a new
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync client to connect and will drop the existing connection. When this
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync option is disabled (this is the default setting), a new connection
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync will not be accepted if there is already a client connected to the
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync server.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>--vrdevideochannel on|off</computeroutput>:
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync This enables video redirection, if it is supported by the VRDE
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync server; see <xref lang="" linkend="vrde-videochannel" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <percent></computeroutput>: Sets the image quality for video
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With the following commands for <computeroutput>VBoxManage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync modifyvm</computeroutput> you can configure a machine to be a target for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync teleporting. See <xref linkend="teleporting" /> for an
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync introduction.<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--teleporter on|off</computeroutput>: With
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this setting you turn on or off whether a machine waits for a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync teleporting request to come in on the network when it is started.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync If "on", when the machine is started, it does not boot the virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine as it would normally; instead, it then waits for a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync teleporting request to come in on the port and address listed with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the next two parameters.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <port></computeroutput>, <computeroutput>--teleporteraddress
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <address></computeroutput>: these must be used with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --teleporter and tell the virtual machine on which port and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync address it should listen for a teleporting request from another
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machine. <computeroutput><port></computeroutput> can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><address></computeroutput> can be any IP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync address or hostname and specifies the TCP/IP socket to bind to.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync The default is "0.0.0.0", which means any address.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <password></computeroutput>: if this optional argument is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync given, then the teleporting request will only succeed if the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync source machine specifies the same password as the one given with
edefdc20eedaf9ef5b1293e56ba9b8cca7b5c740vboxsync this command.</para>
edefdc20eedaf9ef5b1293e56ba9b8cca7b5c740vboxsync </listitem>
edefdc20eedaf9ef5b1293e56ba9b8cca7b5c740vboxsync <password></computeroutput>: if this optional argument is
edefdc20eedaf9ef5b1293e56ba9b8cca7b5c740vboxsync given, then the teleporting request will only succeed if the
edefdc20eedaf9ef5b1293e56ba9b8cca7b5c740vboxsync source machine specifies the same password as the one specified
fe9a95f96e622c50bd6463335687b799f8e3915dvboxsync in the file give with this command. Use <computeroutput>stdin</computeroutput>
fe9a95f96e622c50bd6463335687b799f8e3915dvboxsync to read the password from stdin.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--cpuid <leaf> <eax> <ebx>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <ecx> <edx></computeroutput>: Advanced users can use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this command before a teleporting operation to restrict the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual CPU capabilities that VirtualBox presents to the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operating system. This must be run on both the source and the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync target machines involved in the teleporting and will then modify
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync what the guest sees when it executes the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>CPUID</computeroutput> machine instruction. This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync might help with misbehaving applications that wrongly assume that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync certain CPU capabilities are present. The meaning of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync parameters is hardware dependent; please refer to the AMD or Intel
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync processor manuals.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync <para>This command creates a full or linked copy of an existing virtual
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync machine.</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync <para>The <computeroutput>clonevm</computeroutput> subcommand takes at
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync least the name of the virtual machine which should be cloned. The following
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync additional settings can be used to further configure the clone VM
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync operation:</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync <itemizedlist>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para><computeroutput>--snapshot <uuid>|<name></computeroutput>:
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Select a specific snapshot where the clone operation should refer
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync to. Default is referring to the current state.</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para><computeroutput>--mode machine|machineandchildren|all</computeroutput>:
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Selects the cloning mode of the operation. If
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync <computeroutput>machine</computeroutput> is selected (the default),
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync the current state of the VM without any snapshots is cloned. In the
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync <computeroutput>machineandchildren</computeroutput> mode the snapshot
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync provided by <computeroutput>--snapshot</computeroutput> and all
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync child snapshots are cloned. If <computeroutput>all</computeroutput>
b7fc0ed6c80bf49e581b983ee0039b67f001d849vboxsync is the selected mode all snapshots and the current state are cloned.
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para><computeroutput>--options link|keepallmacs|keepnatmacs|keepdisknames</computeroutput>:
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync Allows additional fine tuning of the clone operation. The first
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync option defines that a linked clone should be created, which is
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync only possible for a machine clone from a snapshot. The next two
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync options allow to define how the MAC addresses of every virtual
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync network card should be handled. They can either be reinitialized
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync (the default), left unchanged
bd5c7d04b57ea9dfea041aad6a07cd8823b4e7c0vboxsync (<computeroutput>keepallmacs</computeroutput>) or left unchanged
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync when the network type is NAT
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync (<computeroutput>keepnatmacs</computeroutput>). If you add
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync <computeroutput>keepdisknames</computeroutput> all new disk images
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync are called like the original once, otherwise they are
b59225a084dd225b72dd3c2238045ef19f60aa61vboxsync renamed.</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync <para><computeroutput>--name <name></computeroutput>: Select a
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync new name for the new virtual machine. Default is "Original Name
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Clone".</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para><computeroutput>--basefolder <basefolder></computeroutput>:
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Select the folder where the new virtual machine configuration should
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync be saved in.</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para><computeroutput>--uuid <uuid></computeroutput>:
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Select the UUID the new VM should have. This id has to be unique in
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync the VirtualBox instance this clone should be registered. Default is
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync creating a new UUID.</para>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync Automatically register the new clone in this VirtualBox
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync installation. If you manually want register the new VM later, see
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync <xref linkend="vboxmanage-registervm" /> for instructions how to do
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </listitem>
3dd1d8fdf12303b292d9ee378edbc5f5fb6d6cb5vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command imports a virtual appliance in OVF format by copying
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the virtual disk images and creating virtual machines in VirtualBox. See
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="ovf" /> for an introduction to appliances.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>import</computeroutput> subcommand takes at
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync least the path name of an OVF file as input and expects the disk images,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync if needed, in the same directory as the OVF file. A lot of additional
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync command-line options are supported to control in detail what is being
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync imported and modify the import parameters, but the details depend on the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync content of the OVF file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>It is therefore recommended to first run the import subcommand with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>-n</computeroutput> option. This will then print a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync description of the appliance's contents to the screen how it would be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync imported into VirtualBox, together with the optional command-line options
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to influence the import behavior.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>As an example, here is the screen output with a sample appliance
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVirtual system 0:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 0: Suggested OS type: "WindowsXP"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 1: Suggested VM name "Windows XP Professional_1"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (change with "--vsys 0 --vmname <name>")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 3: Number of CPUs: 1
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (change with "--vsys 0 --cpus <n>")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 5: Sound card (appliance expects "ensoniq1371", can change on import)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (disable with "--vsys 0 --unit 5 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 6: USB controller
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (disable with "--vsys 0 --unit 6 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 7: Network adapter: orig bridged, config 2, extra type=bridged
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (disable with "--vsys 0 --unit 8 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 9: SCSI controller, type BusLogic
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}";
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disable with "--vsys 0 --unit 9 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync10: IDE controller, type PIIX4
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (disable with "--vsys 0 --unit 10 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync11: Hard disk image: source image=WindowsXp.vmdk,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (change controller with "--vsys 0 --unit 11 --controller <id>";
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disable with "--vsys 0 --unit 11 --ignore")</screen></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>As you can see, the individual configuration items are numbered, and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync depending on their type support different command-line options. The import
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync subcommand can be directed to ignore many such items with a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync X is the number of the virtual system (zero unless there are several
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual system descriptions in the appliance) and Y the item number, as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync printed on the screen.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>In the above example, Item #1 specifies the name of the target
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync respectively. Item #11 describes a hard disk image; in this case, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync additional <computeroutput>--controller</computeroutput> option indicates
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which item the disk image should be connected to, with the default coming
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync from the OVF file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>You can combine several items for the same virtual system behind the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync same <computeroutput>--vsys</computeroutput> option. For example, to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync import a machine as described in the OVF, but without the sound card and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync without the USB controller, and with the disk image connected to the IDE
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command exports one or more virtual machines from VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync into a virtual appliance in OVF format, including copying their virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disk images to compressed VMDK. See <xref linkend="ovf" /> for an
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync introduction to appliances.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>export</computeroutput> command is simple to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync use: list the machine (or the machines) that you would like to export to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the same OVF file and specify the target OVF file after an additional
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>-o</computeroutput> option. Note that the directory of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync target OVF file will also receive the exported disk images in the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync compressed VMDK format (regardless of the original format) and should have
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enough disk space left for them.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Beside a simple export of a given virtual machine, you can append
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync several product information to the appliance file. Use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--version</computeroutput> to specify this additional
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information. For legal reasons you may add a license text or the content
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of a license file by using the <computeroutput>--eula</computeroutput> and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--eulafile</computeroutput> option respectively. As with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync OVF import, you must use the <computeroutput>--vsys X</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option to direct the previously mentioned options to the correct virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For virtualization products which aren't fully compatible with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--legacy09</computeroutput> option.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command starts a virtual machine that is currently in the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "Powered off" or "Saved" states.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The optional <computeroutput>--type</computeroutput> specifier
904810c4c6668233349b025cc58013cb7c11c701vboxsync determines whether the machine will be started in a window or whether the
904810c4c6668233349b025cc58013cb7c11c701vboxsync output should go through <computeroutput>VBoxHeadless</computeroutput>,
904810c4c6668233349b025cc58013cb7c11c701vboxsync with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more
904810c4c6668233349b025cc58013cb7c11c701vboxsync information. The list of types is subject to change, and it's not
904810c4c6668233349b025cc58013cb7c11c701vboxsync guaranteed that all types are accepted by any product variant.</para>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>The global or per-VM default value for the VM frontend type will be
904810c4c6668233349b025cc58013cb7c11c701vboxsync taken if the type is not explicitly specified. If none of these are set,
904810c4c6668233349b025cc58013cb7c11c701vboxsync the GUI variant will be started.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glosslist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>gui</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Starts a VM showing a GUI window. This is the default.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>headless</computeroutput></glossterm>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <para>Starts a VM without a window for remote display only.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>sdl</computeroutput></glossterm>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>Starts a VM with a minimal GUI and limited features.</para>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossdef>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glosslist>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>If you experience problems with starting virtual machines with
904810c4c6668233349b025cc58013cb7c11c701vboxsync particular frontends and there is no conclusive error information,
904810c4c6668233349b025cc58013cb7c11c701vboxsync consider starting virtual machines directly by running the respective
904810c4c6668233349b025cc58013cb7c11c701vboxsync front-end, as this can give additional error information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>controlvm</computeroutput> subcommand allows you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to change the state of a virtual machine that is currently running. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync following can be specified:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>VBoxManage controlvm <vm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pause</computeroutput> temporarily puts a virtual machine on hold,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync without changing its state for good. The VM window will be painted
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in gray to indicate that the VM is currently paused. (This is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync equivalent to selecting the "Pause" item in the "Machine" menu of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the GUI.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Use <computeroutput>VBoxManage controlvm <vm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync resume</computeroutput> to undo a previous
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>pause</computeroutput> command. (This is equivalent
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to selecting the "Resume" item in the "Machine" menu of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync GUI.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>VBoxManage controlvm <vm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync reset</computeroutput> has the same effect on a virtual machine as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pressing the "Reset" button on a real computer: a cold reboot of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machine, which will restart and boot the guest operating
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync system again immediately. The state of the VM is not saved
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync beforehand, and data may be lost. (This is equivalent to selecting
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the "Reset" item in the "Machine" menu of the GUI.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>VBoxManage controlvm <vm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync poweroff</computeroutput> has the same effect on a virtual machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync as pulling the power cable on a real computer. Again, the state of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the VM is not saved beforehand, and data may be lost. (This is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync equivalent to selecting the "Close" item in the "Machine" menu of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the GUI or pressing the window's close button, and then selecting
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "Power off the machine" in the dialog.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>After this, the VM's state will be "Powered off". From there,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync it can be started again; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>VBoxManage controlvm <vm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync savestate</computeroutput> will save the current state of the VM to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disk and then stop the VM. (This is equivalent to selecting the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "Close" item in the "Machine" menu of the GUI or pressing the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync window's close button, and then selecting "Save the machine state"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in the dialog.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>After this, the VM's state will be "Saved". From there, it can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be started again; see <xref linkend="vboxmanage-startvm" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><computeroutput>VBoxManage controlvm "VM name" teleport
94c4b844625733fedcd2b473c207981b31316bd9vboxsync --hostname <name> --port <port> [--passwordfile
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <file> | --password <password>]</computeroutput> makes
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the machine the source of a teleporting operation and initiates a
94c4b844625733fedcd2b473c207981b31316bd9vboxsync teleport to the given target. See <xref linkend="teleporting" /> for
94c4b844625733fedcd2b473c207981b31316bd9vboxsync an introduction. If the optional password is specified, it must match
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the password that was given to the
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <computeroutput>modifyvm</computeroutput> command for the target
94c4b844625733fedcd2b473c207981b31316bd9vboxsync machine; see <xref linkend="vboxmanage-modifyvm-teleport" /> for
94c4b844625733fedcd2b473c207981b31316bd9vboxsync details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>A few extra options are available with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>controlvm</computeroutput> that do not directly affect the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VM's running state:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>setlinkstate<1-N></computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operation connects or disconnects virtual network cables from their
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network interfaces.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
447cbf113f44132911fc13dc33cb26603759b82evboxsync null|nat|bridged|intnet|hostonly|generic</computeroutput>: With this, you can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync set, for each of the VM's virtual network cards, what type of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync networking should be available. They can be not connected to the host
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>null</computeroutput>), use network address
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync translation (<computeroutput>nat</computeroutput>), bridged networking
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>bridged</computeroutput>) or communicate with other
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machines using internal networking
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>intnet</computeroutput>) or host-only networking
447cbf113f44132911fc13dc33cb26603759b82evboxsync (<computeroutput>hostonly</computeroutput>) or access to rarely used
447cbf113f44132911fc13dc33cb26603759b82evboxsync (<computeroutput>generic</computeroutput>). These options correspond
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to the modes which are described in detail in <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>usbattach</computeroutput> and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>usbdettach</computeroutput> make host USB devices
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync visible to the virtual machine on the fly, without the need for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync creating filters first. The USB devices can be specified by UUID
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (unique identifier) or by address on the host system.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync usbhost</computeroutput> to locate this information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>vrde on|off</computeroutput> lets you enable or
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync disable the VRDE server, if it is installed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para><computeroutput>vrdeport default|<ports></computeroutput>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync changes the port or a range of ports that the VRDE server can bind to;
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "default" or "0" means port 3389, the standard port for RDP. For
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details, see the description for the
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <computeroutput>--vrdeport</computeroutput> option in <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>setvideomodehint</computeroutput> requests that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the guest system change to a particular video mode. This requires that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the Guest Additions be installed, and will not work for all guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync systems.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync <para><computeroutput>screenshotpng</computeroutput> takes a screenshot
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync of the guest display and saves it in PNG format.</para>
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>setcredentials</computeroutput> operation is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync used for remote logons in Windows guests. For details, please refer to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>guestmemoryballoon</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operation changes the size of the guest memory balloon, that is,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync memory allocated by the VirtualBox Guest Additions from the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operating system and returned to the hypervisor for re-use by other
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machines. This must be specified in megabytes. For details,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
223935479ac42db56b7b7a7d16548d590022996avboxsync <1-100></computeroutput>: This operation controls how much cpu
223935479ac42db56b7b7a7d16548d590022996avboxsync time a virtual CPU can use. A value of 50 implies a single virtual CPU
223935479ac42db56b7b7a7d16548d590022996avboxsync can use up to 50% of a single host CPU.</para>
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command discards the saved state of a virtual machine which is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync not currently running, which will cause its operating system to restart
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync next time you start it. This is the equivalent of pulling out the power
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cable on a physical machine, and should be avoided if possible.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
91b3ad12b6cac90efc3b65eeffba7241cdb15edavboxsync that is separate from the VM configuration, you can use this command to
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync "adopt" the file. This will change the VM to saved state and when you
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync start it, VirtualBox will attempt to restore it from the saved state file
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync you indicated. This command should only be used in special setups.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command is used to control snapshots from the command line. A
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync snapshot consists of a complete copy of the virtual machine settings,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync copied at the time when the snapshot was taken, and optionally a virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine saved state file if the snapshot was taken while the machine was
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync running. After a snapshot has been taken, VirtualBox creates differencing
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hard disk for each normal hard disk associated with the machine so that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync when a snapshot is restored, the contents of the virtual machine's virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hard disks can be quickly reset by simply dropping the pre-existing
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync differencing files.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>take</computeroutput> operation takes a snapshot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of the current state of the virtual machine. You must supply a name for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the snapshot and can optionally supply a description. The new snapshot is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync inserted into the snapshots tree as a child of the current snapshot and
f906aa7f33207974c4bad1bc441a63b139958499vboxsync then becomes the new current snapshot. The
f906aa7f33207974c4bad1bc441a63b139958499vboxsync <computeroutput>--description</computeroutput> parameter allows to
f906aa7f33207974c4bad1bc441a63b139958499vboxsync describe the snapshot. If <computeroutput>--live</computeroutput>
f906aa7f33207974c4bad1bc441a63b139958499vboxsync is specified, the VM will not be stopped during the snapshot creation
f906aa7f33207974c4bad1bc441a63b139958499vboxsync (live smapshotting).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>delete</computeroutput> operation deletes a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync snapshot (specified by name or by UUID). This can take a while to finish
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync since the differencing images associated with the snapshot might need to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be merged with their child differencing images.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>restore</computeroutput> operation will restore
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the given snapshot (specified by name or by UUID) by resetting the virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine's settings and current state to that of the snapshot. The previous
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync current state of the machine will be lost. After this, the given snapshot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync becomes the new "current" snapshot so that subsequent snapshots are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync inserted under the snapshot from which was restored.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>restorecurrent</computeroutput> operation is a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync shortcut to restore the current snapshot (i.e. the snapshot from which the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync current state is derived). This subcommand is equivalent to using the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "restore" subcommand with the name or UUID of the current snapshot, except
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync that it avoids the extra step of determining that name or UUID.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With the <computeroutput>edit</computeroutput> operation, you can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync change the name or description of an existing snapshot.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With the <computeroutput>showvminfo</computeroutput> operation, you
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync can view the virtual machine settings that were stored with an existing
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync snapshot.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This commands removes a hard disk, DVD or floppy image from a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync VirtualBox media registry.<footnote>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Before VirtualBox 4.0, it was necessary to call VBoxManage
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync openmedium before a medium could be attached to a virtual machine;
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync that call "registered" the medium with the global VirtualBox media
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync registry. With VirtualBox 4.0 this is no longer necessary; media are
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync added to media registries automatically. The "closemedium" call has
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync been retained, however, to allow for explicitly removing a medium from
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync a registry.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Optionally, you can request that the image be deleted. You will get
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync appropriate diagnostics that the deletion failed, however the image will
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync become unregistered in any case.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>This command attaches/modifies/removes a storage medium connected to
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync a storage controller that was previously added with the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>storagectl</computeroutput> command (see the previous
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync section). The syntax is as follows:</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <screen>VBoxManage storageattach <uuid|vmname>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --storagectl <name>
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync [--port <number>]
1568d715e75b8d2484ea3dc87f0483d4cf377838vboxsync [--device <number>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--type dvddrive|hdd|fdd]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--medium none|emptydrive|
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <uuid>|<filename>|host:<drive>|iscsi]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--mtype normal|writethrough|immutable|shareable]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--comment <text>]
80e46f984efd827517661c0e081a36014ca41af8vboxsync [--setuuid <uuid>]
80e46f984efd827517661c0e081a36014ca41af8vboxsync [--setparentuuid <uuid>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--passthrough on|off]
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync [--tempeject on|off]
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync [--nonrotational on|off]
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync [--discard on|off]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--bandwidthgroup name|none]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--forceunmount]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--server <name>|<ip>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--target <target>]
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync [--tport <port>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--lun <lun>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--encodedlun <lun>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--username <username>]
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync [--password <password>]
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync [--initiator <initiator>]
f34e466484d9727a000bac50c2e198c0173168d4vboxsync [--intnet]</screen>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>A number of parameters are commonly required; the ones at the end of
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the list are required only for iSCSI targets (see below).</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--storagectl</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Name of the storage controller. Mandatory. The list of the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync storage controllers currently attached to a VM can be obtained
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync with <computeroutput>VBoxManage showvminfo</computeroutput>; see
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--port</computeroutput></glossterm>
223935479ac42db56b7b7a7d16548d590022996avboxsync <para>The number of the storage controller's port which is to be
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync modified. Mandatory, unless the storage controller has only a
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync single port.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--device</computeroutput></glossterm>
223935479ac42db56b7b7a7d16548d590022996avboxsync <para>The number of the port's device which is to be modified.
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync Mandatory, unless the storage controller has only a single device
174f11bbd5c277153742aa5e6c3bd640bf379547vboxsync per port.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--type</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Define the type of the drive to which the medium is being
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync attached/detached/modified. This argument can only be omitted if
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the type of medium can be determined from either the medium given
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync with the <computeroutput>--medium</computeroutput> argument or
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync from a previous medium attachment.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--medium</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Specifies what is to be attached. The following values are
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync supported:<itemizedlist>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>"none": Any existing device should be removed from the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync given slot.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>"emptydrive": For a virtual DVD or floppy drive only,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync this makes the device slot behaves like a removeable drive
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync into which no media has been inserted.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
89c9e3a0edbc4692f2e3278af5c4beadbe335620vboxsync <para>"additions": For a virtual DVD drive only, this
89c9e3a0edbc4692f2e3278af5c4beadbe335620vboxsync attaches the <emphasis>VirtualBox Guest Additions</emphasis>
89c9e3a0edbc4692f2e3278af5c4beadbe335620vboxsync image to the given device slot.</para>
89c9e3a0edbc4692f2e3278af5c4beadbe335620vboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>If a UUID is specified, it must be the UUID of a
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync storage medium that is already known to VirtualBox (e.g.
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync because it has been attached to another virtual machine).
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync See <xref linkend="vboxmanage-list" /> for how to list known
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync media. This medium is then attached to the given device
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync slot.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>If a filename is specified, it must be the full path
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync of an existing disk image (ISO, RAW, VDI, VMDK or other),
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync which is then attached to the given device slot.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>"host:<drive>": For a virtual DVD or floppy
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync drive only, this connects the given device slot to the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync specified DVD or floppy drive on the host computer.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>"iscsi": For virtual hard disks only, this allows for
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync specifying an iSCSI target. In this case, more parameters
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync must be given; see below.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Some of the above changes, in particular for removeable
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync media (floppies and CDs/DVDs), can be effected while a VM is
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync running. Others (device changes or changes in hard disk device
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync slots) require the VM to be powered off.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--mtype</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Defines how this medium behaves with respect to snapshots
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync and write operations. See <xref linkend="hdimagewrites" /> for
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync details.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--comment</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Any description that you want to have stored with this
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync medium (optional; for example, for an iSCSI target, "Big storage
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync server downstairs"). This is purely descriptive and not needed for
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the medium to function correctly.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
80e46f984efd827517661c0e081a36014ca41af8vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
80e46f984efd827517661c0e081a36014ca41af8vboxsync <para>Modifies the UUID or parent UUID of a medium before
80e46f984efd827517661c0e081a36014ca41af8vboxsync attaching it to a VM. This is an expert option. Inappropriate use
80e46f984efd827517661c0e081a36014ca41af8vboxsync can make the medium unusable or lead to broken VM configurations
80e46f984efd827517661c0e081a36014ca41af8vboxsync if any other VM is referring to the same media already. The most
80e46f984efd827517661c0e081a36014ca41af8vboxsync frequently used variant is <code>--setuuid ""</code>, which assigns
80e46f984efd827517661c0e081a36014ca41af8vboxsync a new (random) UUID to an image. This is useful to resolve the
80e46f984efd827517661c0e081a36014ca41af8vboxsync duplicate UUID errors if one duplicated an image using file copy
80e46f984efd827517661c0e081a36014ca41af8vboxsync utilities.</para>
80e46f984efd827517661c0e081a36014ca41af8vboxsync </glossdef>
80e46f984efd827517661c0e081a36014ca41af8vboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passthrough</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>For a virtual DVD drive only, you can enable DVD writing
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync support (currently experimental; see <xref
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--tempeject</computeroutput></glossterm>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync <para>For a virtual DVD drive only, you can configure the behavior
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync for guest-triggered medium eject. If this is set to "on", the eject
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync has only temporary effects. If the VM is powered off and restarted
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync the originally configured medium will be still in the drive.</para>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync </glossdef>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync </glossentry>
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync <para>This switch allows to enable the non-rotational flag for virtual
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync and don't perform disk fragmentation on such media.
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync </glossdef>
515d43bd83e097dbf72b54267e8288b53f13b3a0vboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Sets the bandwidth group to use for the given device; see
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>For a virtual DVD or floppy drive only, this forcibly
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the previous one is locked down by the guest for reading. Again,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync see <xref linkend="storage-cds" /> for details.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>When "iscsi" is used with the
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <computeroutput>--medium</computeroutput> parameter for iSCSI support --
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync see <xref linkend="storage-iscsi" /> --, additional parameters must or can
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync be used:<glosslist>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--server</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>The host name or IP address of the iSCSI target;
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync required.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--target</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Target name string. This is determined by the iSCSI target
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync and used to identify the storage resource; required.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--tport</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>TCP/IP port number of the iSCSI service on the target
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (optional).</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--lun</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Logical Unit Number of the target resource (optional).
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync Often, this value is zero.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username, --password</computeroutput></glossterm>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para>Username and password (initiator secret) for target
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync authentication, if required (optional).<note>
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync <para>Username and password are stored without
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync encryption (i.e. in clear text) in the XML machine
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync configuration file if no settings password is provided.
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync When a settings password was specified the first time,
4aebc69aadd38c5c13ed4211d60635ad49538275vboxsync the password is stored encrypted.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--intnet</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>If specified, connect to the iSCSI target via Internal
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync Networking. This needs further configuration which is described in
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This command attaches/modifies/removes a storage controller. After
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync this, virtual media can be attached to the controller with the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>storageattach</computeroutput> command (see the next
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync section).</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <screen>VBoxManage storagectl <uuid|vmname>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync --name <name>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync [--controller <LsiLogic|LSILogicSAS|BusLogic|
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync IntelAhci|PIIX3|PIIX4|ICH6|I82078>]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--sataportcount <1-30>]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--hostiocache on|off]
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync [--bootable on|off]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--remove]</screen>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--name</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Name of the storage controller. Mandatory.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--add</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Define the type of the system bus to which the storage
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync controller must be connected.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--controller</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Allows to choose the type of chipset being emulated for the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync given storage controller.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--sataportcount</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This determines how many ports the SATA controller should
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync support.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Configures the use of the host I/O cache for all disk images
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync attached to this storage controller. For details, please see <xref
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--bootable</computeroutput></glossterm>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync <para>Selects whether this controller is bootable.</para>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync </glossdef>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--remove</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Removes the storage controller from the VM config.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para>This command creates/deletes/modifies/shows bandwidth groups of the given
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync virtual machine:<screen>VBoxManage bandwidthctl <uuid|vmname>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] |
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync set <name> --limit <megabytes per second>[k|m|g|K|M|G] |
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync remove <name> |
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para>The following subcommands are available:<itemizedlist>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para><computeroutput>add</computeroutput>, creates a new bandwidth
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync group of given type.</para>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </listitem>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para><computeroutput>set</computeroutput>, modifies the limit for an
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync existing bandwidth group.</para>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </listitem>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para><computeroutput>remove</computeroutput>, destroys a bandwidth
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync group.</para>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </listitem>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para><computeroutput>list</computeroutput>, shows all bandwidth groups
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync defined for the given VM.</para>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </listitem>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </itemizedlist>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossdef>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossentry>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--name</computeroutput></glossterm>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <para>Name of the bandwidth group. Mandatory.</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossdef>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossentry>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--type</computeroutput></glossterm>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para>Type of the bandwidth group. Mandatory. Two types are
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync supported: <computeroutput>disk</computeroutput> and
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <xref linkend="network_bandwidth_limit" /> for a description of a
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync particular type.</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossdef>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossentry>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--limit</computeroutput></glossterm>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para>Specifies the limit for the given group. Can be changed
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync while the VM is running. The default unit is megabytes per
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync second. The unit can be changed by specifying one of the
01ce32a050c5349de591c1cd961be7f565b0a7f2vboxsync following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s.</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossdef>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossentry>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync </glosslist>
01ce32a050c5349de591c1cd961be7f565b0a7f2vboxsync <para>The network bandwidth limits apply only to the traffic being sent by
01ce32a050c5349de591c1cd961be7f565b0a7f2vboxsync virtual machines. The traffic being received by VMs is unlimited.</para>
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync <para>To remove a bandwidth group it must not be referenced by any disks
2b971f42c675fe0c8ecd3d94e7fbe0997b52b3c8vboxsync or adapters in running VM.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command shows information about a virtual hard disk image,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync notably its size, its size on disk, its type and the virtual machines
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync which use it.<note>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For compatibility with earlier versions of VirtualBox, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "showvdiinfo" command is also supported and mapped internally to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "showhdinfo" command.</para>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <para>The disk image must be specified either by its UUID (if the medium
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync is registered) or by its filename. Registered images can be listed by
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <computeroutput>VBoxManage list hdds</computeroutput> (see <xref linkend="vboxmanage-list" />
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync for more information). A filename must be specified as valid path, either
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync as an absolute path or as a relative path starting from the current
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync directory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command creates a new virtual hard disk image. The syntax is as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync follows:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage createhd --filename <filename>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --size <megabytes>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--format VDI|VMDK|VHD] (default: VDI)
25e9e0a33eafedabbd0628909c4973b91283a8c7vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--filename</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allows to choose a file name. Mandatory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--size</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allows to define the image capacity, in 1 MiB units.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Mandatory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--format</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allows to choose a file format for the output file different
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync from the file format of the input file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--variant</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allows to choose a file format variant for the output file.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync It is a comma-separated list of variant flags. Not all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync combinations are supported, and specifying inconsistent flags will
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync result in an error message.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For compatibility with earlier versions of VirtualBox, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "createvdi" command is also supported and mapped internally to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "createhd" command.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With the <computeroutput>modifyhd</computeroutput> command, you can
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync change the characteristics of a disk image after it has been
25a7ceab67b83045d3329572124454609b26fc81vboxsync created:<screen>VBoxManage modifyhd <uuid|filename>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync [--type normal|writethrough|immutable|shareable|
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync readonly|multiattach]
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync [--autoreset on|off]
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync [--compact]
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync [--resize <megabytes>|--resizebyte <bytes>]</screen><note>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>Despite the "hd" in the subcommand name, the command works with
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync all disk images, not only hard disks. For compatibility with earlier
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync versions of VirtualBox, the "modifyvdi" command is also supported and
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync mapped internally to the "modifyhd" command.</para>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <para>The disk image to modify must be specified either by its UUID
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync (if the medium is registered) or by its filename. Registered images
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync (see <xref linkend="vboxmanage-list" /> for more information).
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync A filename must be specified as valid path, either as an absolute path
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync or as a relative path starting from the current directory.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>The following options are available:<itemizedlist>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>With the <computeroutput>--type</computeroutput> argument, you
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync can change the type of an existing image between the normal,
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync immutable, write-through and other modes; see <xref
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>For immutable (differencing) hard disks only, the
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <computeroutput>--autoreset on|off</computeroutput> option
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync determines whether the disk is automatically reset on every VM
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync startup (again, see <xref linkend="hdimagewrites" />). The default
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync is "on".</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>With the <computeroutput>--compact</computeroutput> option,
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync can be used to compact disk images, i.e. remove blocks that only
59646d8d07562768e775ed80bff000aa76e217a6vboxsync contains zeroes. This will shrink a dynamically allocated image
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync again; it will reduce the <emphasis>physical</emphasis> size of the
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync image without affecting the logical size of the virtual disk.
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync Compaction works both for base images and for diff images created as
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync part of a snapshot.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>For this operation to be effective, it is required that free
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync space in the guest system first be zeroed out using a suitable
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync software tool. For Windows guests, you can use the
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <computeroutput>sdelete</computeroutput> tool provided by Microsoft.
9c526fe1e2bf0cb90336f3f4fb961ad489051f6fvboxsync Execute <computeroutput>sdelete -z</computeroutput> in the guest to
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync zero the free disk space before compressing the virtual disk
fb59c22133d295bda67901bbe4bc799d4448a368vboxsync image. For Linux, use the <code>zerofree</code> utility which
a4c7d3e6c315cecdb72d34bc0653379c1c6bd709vboxsync supports ext2/ext3 filesystems. For Mac OS X guests, use the
a4c7d3e6c315cecdb72d34bc0653379c1c6bd709vboxsync <emphasis>Erase Free Space</emphasis> feature of the built-in
8f20906c81b61659ea4f978566d0e34223c451e1vboxsync <para>Please note that compacting is currently only available for
8f20906c81b61659ea4f978566d0e34223c451e1vboxsync VDI images. A similar effect can be achieved by zeroing out free
59646d8d07562768e775ed80bff000aa76e217a6vboxsync blocks and then cloning the disk to any other dynamically allocated
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync format. You can use this workaround until compacting is also
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync supported for disk formats other than VDI.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync <para>The <computeroutput>--resize x</computeroutput> option (where x
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync is the desired new total space in <emphasis role="bold">megabytes</emphasis>)
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync allows you to change the capacity of an existing image; this adjusts the
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync <emphasis>logical</emphasis> size of a virtual disk without affecting
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync the physical size much.<footnote>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>Image resizing was added with VirtualBox 4.0.</para>
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync </footnote> This currently works only for VDI and VHD formats, and only
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync for the dynamically allocated variants, and can only be used to expand
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync (not shrink) the capacity.
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync For example, if you originally created a 10G disk which is now full,
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync you can use the <computeroutput>--resize 15360</computeroutput>
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync command to change the capacity to 15G (15,360MB) without having to create a new
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync image and copy all data from within a virtual machine. Note however that
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync this only changes the drive capacity; you will typically next need to use
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync a partition management tool inside the guest to adjust the main partition
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync to fill the drive.</para><para>The <computeroutput>--resizebyte x</computeroutput>
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync option does almost the same thing, except that x is expressed in bytes
266b1fa6dfa3bd7628bddfd2ef07cbe877aa0059vboxsync instead of megabytes.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command duplicates a registered virtual hard disk image to a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync new image file with a new unique identifier (UUID). The new image can be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync transferred to another host system or imported into VirtualBox again using
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="cloningvdis" />. The syntax is as follows:</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage clonehd <uuid|inutfile> <uuid|outputfile>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--format VDI|VMDK|VHD|RAW|<other>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
25e9e0a33eafedabbd0628909c4973b91283a8c7vboxsync [--existing]</screen>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <para>The disk image to clone as well as the target image must be described
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync either by its UUIDs (if the mediums are registered) or by its filename.
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync Registered images can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync (see <xref linkend="vboxmanage-list" /> for more information).
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync A filename must be specified as valid path, either as an absolute path or
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync as a relative path starting from the current directory.</para>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <para>The following options are available:<glosslist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--format</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allow to choose a file format for the output file different
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync from the file format of the input file.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--variant</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allow to choose a file format variant for the output file.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync It is a comma-separated list of variant flags. Not all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync combinations are supported, and specifying inconsistent flags will
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync result in an error message.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--existing</computeroutput></glossterm>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <para>Perform the clone operation to an already existing
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync destination medium. Only the portion of the source medium which
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync fits into the destination medium is copied. This means if the
17014a9ecba37ba2cd8919ec9f040ceb9c2a5445vboxsync destination medium is smaller than the source only a part of it is
17014a9ecba37ba2cd8919ec9f040ceb9c2a5445vboxsync copied, and if the destination medium is larger than the source
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync the remaining part of the destination medium is unchanged.</para>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync </glossdef>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For compatibility with earlier versions of VirtualBox, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "clonevdi" command is also supported and mapped internally to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "clonehd" command.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command converts a raw disk image to a VirtualBox Disk Image
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (VDI) file. The syntax is as follows:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage convertfromraw <filename> <outputfile>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--format VDI|VMDK|VHD]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync [--uuid <uuid>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVBoxManage convertfromraw stdin <outputfile> <bytes>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--format VDI|VMDK|VHD]
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync [--uuid <uuid>]</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--bytes</computeroutput></glossterm>
daddbb5e85f120545b63dc235209bd43a3a1736avboxsync <para>The size of the image file, in bytes, provided through
daddbb5e85f120545b63dc235209bd43a3a1736avboxsync stdin.</para>
daddbb5e85f120545b63dc235209bd43a3a1736avboxsync </glossdef>
daddbb5e85f120545b63dc235209bd43a3a1736avboxsync </glossentry>
daddbb5e85f120545b63dc235209bd43a3a1736avboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--format</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Select the disk image format to create. Default is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VDI.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--variant</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allow to choose a file format variant for the output file.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync It is a comma-separated list of variant flags. Not all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync combinations are supported, and specifying inconsistent flags will
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync result in an error message.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--uuid</computeroutput></glossterm>
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync <para>Allow to specifiy the UUID of the output file.</para>
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync </glossdef>
36159dd2122bfe6f3cc172b6c6c4323a02cee365vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glosslist> The second form forces VBoxManage to read the content for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the disk image from standard input (useful for using that command in a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pipe).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For compatibility with earlier versions of VirtualBox, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "convertdd" command is also supported and mapped internally to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "convertfromraw" command.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <title>VBoxManage getextradata/setextradata</title>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>These commands let you attach and retrieve string data to a virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine or to a VirtualBox configuration (by specifying
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>global</computeroutput> instead of a virtual machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync name). You must specify a key (as a text string) to associate the data
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync with, which you can later use to retrieve it. For example:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>would associate the string "2006.01.01" with the key installdate for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync could retrieve the information as follows:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage getextradata Fedora5 installdate</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncAll rights reserved.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncValue: 2006.01.01</screen>
438dd62b5c796170381bedd039e4d946b1625630vboxsync <para>To remove a key, the <computeroutput>setextradata</computeroutput>
438dd62b5c796170381bedd039e4d946b1625630vboxsync command must be run without specifying data (only the key), for example:
91df5a9e634997e09e1a2d952a1a0325735d627fvboxsync <screen>VBoxManage setextradata Fedora5 installdate</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command is used to change global settings which affect the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync entire VirtualBox installation. Some of these correspond to the settings
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in the "Global settings" dialog in the graphical user interface. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync following properties are available:<glosslist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>machinefolder</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This specifies the default folder in which virtual machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync definitions are kept; see <xref linkend="vboxconfigdata" /> for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync <glossentry>
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync <glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm>
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync <para>This specifies whether VirtualBox will make exclusive use of
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync the hardware virtualization extensions (Intel VT-x or AMD-V) of the
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync host system's processor; see <xref linkend="hwvirt" />. If you wish to
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync share these extensions with other hypervisors running at the same time,
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync you must disable this setting. Doing so has negative performance implications.
9cc9fd4046b0e8dca741e26455a2a6e79a92ac20vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync <para>This specifies which library to use when "external"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync authentication has been selected for a particular virtual machine;
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync see <xref linkend="vbox-auth" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This specifies which library the web service uses to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync authenticate users. For details about the VirtualBox web service,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync please refer to the separate VirtualBox SDK reference (see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync <para>This specifies which library implements the VirtualBox
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync Remote Desktop Extension.</para>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync </glossdef>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>This selects how many rotated (old) VM logs are kept.</para>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossdef>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossentry>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>This selects the path to the autostart database. See
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossdef>
904810c4c6668233349b025cc58013cb7c11c701vboxsync </glossentry>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
904810c4c6668233349b025cc58013cb7c11c701vboxsync <para>This selects the global default VM frontend setting. See
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <title>VBoxManage usbfilter add/modify/remove</title>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>usbfilter</computeroutput> commands are used for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync working with USB filters in virtual machines, or global filters which
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync affect the whole VirtualBox setup. Global filters are applied before
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine-specific filters, and may be used to prevent devices from being
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync captured by any virtual machine. Global filters are always applied in a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync particular order, and only the first filter which fits a device is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync applied. So for example, if the first global filter says to hold (make
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync available) a particular Kingston memory stick device and the second to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ignore all Kingston devices, that memory stick will be available to any
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine with an appropriate filter, but no other Kingston device
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>When creating a USB filter using <computeroutput>usbfilter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync add</computeroutput>, you must supply three or four mandatory parameters.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync The index specifies the position in the list at which the filter should be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync placed. If there is already a filter at that position, then it and the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync following ones will be shifted back one place. Otherwise the new filter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will be added onto the end of the list. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>target</computeroutput> parameter selects the virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine that the filter should be attached to or use "global" to apply it
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to all virtual machines. <computeroutput>name</computeroutput> is a name
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for the new filter and for global filters,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>action</computeroutput> says whether to allow machines
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync access to devices that fit the filter description ("hold") or not to give
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync them access ("ignore"). In addition, you should specify parameters to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync filter by. You can find the parameters for devices attached to your system
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync you can specify whether the filter should be active, and for local
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync filters, whether they are for local devices, remote (over an RDP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync connection) or either.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>When you modify a USB filter using <computeroutput>usbfilter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync modify</computeroutput>, you must specify the filter by index (see the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync find global filter indexes and that of <computeroutput>VBoxManage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync showvminfo</computeroutput> to find indexes for individual machines) and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync by target, which is either a virtual machine or "global". The properties
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which can be changed are the same as for <computeroutput>usbfilter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync remove</computeroutput> and specify the index and the target.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command allows you to share folders on the host computer with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync guest operating systems. For this, the guest systems must have a version
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of the VirtualBox Guest Additions installed which supports this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync functionality.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Shared folders are described in detail in <xref
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The "guestproperty" commands allow you to get or set properties of a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync running virtual machine. Please see <xref linkend="guestadd-guestprops" />
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync for an introduction. As explained there, guest properties are arbitrary
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync key/value string pairs which can be written to and read from by either the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync guest or the host, so they can be used as a low-volume communication
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync channel for strings, provided that a guest is running and has the Guest
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Additions installed. In addition, a number of values whose keys begin with
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync "/VirtualBox/" are automatically set and maintained by the Guest
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Additions.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following subcommands are available (where
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><vm></computeroutput>, in each case, can either be a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>enumerate <vm> [--patterns
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <pattern>]</computeroutput>: This lists all the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync properties that are available for the given VM, including the value.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This list will be very limited if the guest's service process cannot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be contacted, e.g. because the VM is not running or the Guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Additions are not installed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If <computeroutput>--patterns <pattern></computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is specified, it acts as a filter to only list properties that match
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the given pattern. The pattern can contain the following wildcard
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync characters:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>*</computeroutput> (asterisk):
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync represents any number of characters; for example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "<computeroutput>/VirtualBox*</computeroutput>" would match
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync all properties beginning with "/VirtualBox".</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>?</computeroutput> (question mark):
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync represents a single arbitrary character; for example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "<computeroutput>fo?</computeroutput>" would match both "foo"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and "for".</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>|</computeroutput> (pipe symbol): can be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync used to specify multiple alternative patterns; for example,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync "<computeroutput>s*|t*</computeroutput>" would match anything
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync starting with either "s" or "t".</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>get <vm></computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync retrieves the value of a single property only. If the property
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync cannot be found (e.g. because the guest is not running), this will
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>set <vm> <property> [<value>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync [--flags <flags>]]</computeroutput>: This allows you to set a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync guest property by specifying the key and value. If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><value></computeroutput> is omitted, the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync property is deleted. With <computeroutput>--flags</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync you can optionally specify additional behavior (you can combine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync several by separating them with commas):<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>TRANSIENT</computeroutput>: the value
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will not be stored with the VM data when the VM exits;</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
dae86d7bd26c4030c4cfa21231757d1a12f50bf8vboxsync <para><computeroutput>TRANSRESET</computeroutput>: the value
42d23b3e34a524ac2ceb195e960cdedfb591f5cavboxsync will be deleted as soon as the VM restarts and/or exits;</para>
42d23b3e34a524ac2ceb195e960cdedfb591f5cavboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>RDONLYGUEST</computeroutput>: the value
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync can only be changed by the host, but the guest can only read
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>RDONLYHOST</computeroutput>: reversely,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the value can only be changed by the guest, but the host can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync only read it;</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>READONLY</computeroutput>: a combination
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of the two, the value cannot be changed at all.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>wait <vm> <pattern> --timeout
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <timeout></computeroutput>: This waits for a particular value
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync described by "pattern" to change or to be deleted or created. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pattern rules are the same as for the "enumerate" subcommand
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync above.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync <para><computeroutput>delete <vm> <property>
478d0d0163d814d30c2696f2636349e6aff788e1vboxsync </computeroutput>: Deletes a formerly set guest property.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The "guestcontrol" commands allow you to control certain things
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync inside a guest from the host. Please see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="guestadd-guestcontrol" /> for an introduction.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> <command></screen>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <para>The following subcommands are available (where
25a7ceab67b83045d3329572124454609b26fc81vboxsync <computeroutput><uuid|vmname></computeroutput>, in each case, can either be a
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>execute</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows for
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync executing a program/script (process) which already is installed and
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync runnable on the guest. This command only works while a VM is up and
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync running and has the following syntax:</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> exec[ute]
94c4b844625733fedcd2b473c207981b31316bd9vboxsync --image <path to program> --username <name>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--passwordfile <file> | --password <password>]
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--verbose] [--timeout <msec>]
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync [--wait-exit] [--wait-stdout] [--wait-stderr]
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--dos2unix] [--unix2dos]
4fac78486305f1f002adbf23953382e5d832af94vboxsync -- [[<argument1>] ... [<argumentN>]]</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--image "<path to program>"</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Absolute path and process name of process to execute
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync in the guest, e.g.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <para>Name of the user the process should run under. This
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync user must exist on the guest OS.</para>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossdef>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossentry>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <para>Password of the user account specified to be read from
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the given file. If not given, an empty password is
94c4b844625733fedcd2b473c207981b31316bd9vboxsync assumed.</para>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossdef>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossentry>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <para>Password of the user account specified with
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <computeroutput>--username</computeroutput>. If not given,
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync an empty password is assumed.</para>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossdef>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossentry>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync Converts output from DOS/Windows guests to UNIX-compatible
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync line endings (CR + LF -> LF). Not implemented yet.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync "<NAME>=<VALUE>"</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>One or more environment variables to be set or
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync unset.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>By default, the new process in the guest will be
223935479ac42db56b7b7a7d16548d590022996avboxsync created with the standard environment of the guest OS. This
223935479ac42db56b7b7a7d16548d590022996avboxsync option allows for modifying that environment. To set/modify
223935479ac42db56b7b7a7d16548d590022996avboxsync a variable, a pair of
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>NAME=VALUE</computeroutput> must be
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync specified; to unset a certain variable, the name with no
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync value must set, e.g.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Arguments containing spaces must be enclosed in
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync quotation marks. More than one
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>--environment</computeroutput> at a time can
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync be specified to keep the command line tidy.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Value (in milliseconds) that specifies the time how
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync long the started process is allowed to run and how long
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync VBoxManage waits for getting output from that process. If no
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync timeout is specified, VBoxManage will wait forever until the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync started process ends or an error occured.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync Converts output from a UNIX/Linux guests to DOS-/Windows-compatible
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync line endings (LF -> CR + LF). Not implemented yet.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--wait-exit</computeroutput></glossterm>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>Waits until the process ends and outputs its
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossdef>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossentry>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--wait-stdout</computeroutput></glossterm>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>Waits until the process ends and outputs its
4fac78486305f1f002adbf23953382e5d832af94vboxsync exit code along with the exit reason/flags. While waiting
4fac78486305f1f002adbf23953382e5d832af94vboxsync VBoxManage retrieves the process output collected from stdout.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--wait-stderr</computeroutput></glossterm>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>Waits until the process ends and outputs its
4fac78486305f1f002adbf23953382e5d832af94vboxsync exit code along with the exit reason/flags. While waiting
4fac78486305f1f002adbf23953382e5d832af94vboxsync VBoxManage retrieves the process output collected from stderr.</para>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossdef>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossentry>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <para>One or more arguments to pass to the process being
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync executed.</para>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync <para>Arguments containing spaces must be enclosed in
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync quotation marks.</para>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossdef>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>On Windows there are certain limitations for graphical
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync applications; please see <xref linkend="KnownIssues" /> for more
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync information.</para>
b2caf87457abb2a237a2e5c0e5ad26154c7954b9vboxsync </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe"
94c4b844625733fedcd2b473c207981b31316bd9vboxsync --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync the double backslashes in the second example are only required on
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Unix hosts.</para>
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync <para>For certain commands a user name of an existing user account on the guest
ce951a49b91e2bcee3a8ee55353285423966e10dvboxsync must be specified; anonymous executions are not supported for security reasons. A
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync user account password, however, is optional and depends on the guest's OS security
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync policy or rules. If no password is specified for a given user name, an empty password
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync will be used. On certain OSes like Windows the security policy may needs to be adjusted
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync in order to allow user accounts with an empty password set. Also, global domain rules might
a09f9bd6f269c00ac1249f85f4d45aa978a8bc2evboxsync apply and therefore cannot be changed.</para>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync to serve up to 5 guest processes at a time. If a new guest process gets started
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync which would exceed this limit, the oldest not running guest process will be discarded
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync in order to be able to run that new process. Also, retrieving output from this
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync old guest process will not be possible anymore then. If all 5 guest processes
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync are still active and running, starting a new guest process will result in an
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync appropriate error message.</para>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync <para>To raise or lower the guest process execution limit, either the guest
438dd62b5c796170381bedd039e4d946b1625630vboxsync property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
9ce778d861807ac39e2be5be9e458e4f5dff0c76vboxsync guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows copying
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync files from the host to the guest (only with installed Guest
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Additions 4.0 and later).</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> copyto|cp
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <guest source> <host dest> --username <name>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--passwordfile <file> | --password <password>]
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync [--dryrun] [--follow] [--recursive] [--verbose]</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>source on host</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Absolute path of source file(s) on host to copy over
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync to the guest, e.g.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync This also can be a wildcard expression, e.g.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>C:\Windows\System32\*.dll</computeroutput></para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>destination on guest</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Name of the user the copy process should run under.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync This user must exist on the guest OS.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <para>Password of the user account specified to be read from
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the given file. If not given, an empty password is
94c4b844625733fedcd2b473c207981b31316bd9vboxsync assumed.</para>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossdef>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Password of the user account specified with
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>--username</computeroutput>. If not given,
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync an empty password is assumed.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Tells VBoxManage to only perform a dry run instead of
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync really copying files to the guest.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--follow</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Enables following symlinks on the host's
241adddf415cbdf66230864a215b24415f482e72vboxsync source.</para>
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync </glossdef>
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--recursive</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Recursively copies files/directories of the specified
241adddf415cbdf66230864a215b24415f482e72vboxsync source.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--flags <flags></computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Additional flags to set. This is not used at the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync moment.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows copying
94c4b844625733fedcd2b473c207981b31316bd9vboxsync files from the guest to the host (only with installed Guest
94c4b844625733fedcd2b473c207981b31316bd9vboxsync Additions 4.0 and later). It has the same parameters as
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <computeroutput>copyto</computeroutput> above.</para>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>createdirectory</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows
241adddf415cbdf66230864a215b24415f482e72vboxsync copying files from the host to the guest (only with installed Guest
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync Additions 4.0 and later).</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> createdir[ectory]|mkdir|md
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <guest directory>... --username <name>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--passwordfile <file> | --password <password>]
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync [--parents] [--mode <mode>] [--verbose]</screen>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>directory to create on guest</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Absolute path of directory/directories to create on
241adddf415cbdf66230864a215b24415f482e72vboxsync guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>.
241adddf415cbdf66230864a215b24415f482e72vboxsync Parent directories need to exist (e.g. in this example
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>D:\Foo</computeroutput>) when switch
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>--parents</computeroutput> is omitted. The
241adddf415cbdf66230864a215b24415f482e72vboxsync specified user must have appropriate rights to create the
241adddf415cbdf66230864a215b24415f482e72vboxsync specified directory.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>Name of the user the copy process should run under.
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync This user must exist on the guest OS.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <para>Password of the user account specified to be read from
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the given file. If not given, an empty password is
94c4b844625733fedcd2b473c207981b31316bd9vboxsync assumed.</para>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossdef>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>Password of the user account specified with
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <computeroutput>--username</computeroutput>. If not given,
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync an empty password is assumed.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--parents</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Also creates not yet existing parent directories of
241adddf415cbdf66230864a215b24415f482e72vboxsync the specified directory, e.g. if the directory
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>D:\Foo\Bar</computeroutput> does not exist
241adddf415cbdf66230864a215b24415f482e72vboxsync yet it will be created. Without specifying
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>--parent</computeroutput> the action would
241adddf415cbdf66230864a215b24415f482e72vboxsync have failed.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>Sets the permission mode of the specified directory.
25a7ceab67b83045d3329572124454609b26fc81vboxsync Only octal modes (e.g.
25a7ceab67b83045d3329572124454609b26fc81vboxsync <computeroutput>0755</computeroutput>) are supported right
25a7ceab67b83045d3329572124454609b26fc81vboxsync now.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>createtemporary</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows
25a7ceab67b83045d3329572124454609b26fc81vboxsync copying files from the host to the guest (only with installed Guest
25a7ceab67b83045d3329572124454609b26fc81vboxsync Additions 4.2 and later).</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> createtemp[orary]|mktemp
25a7ceab67b83045d3329572124454609b26fc81vboxsync <template> --username <name>
25a7ceab67b83045d3329572124454609b26fc81vboxsync [--passwordfile <file> | --password <password>]
25a7ceab67b83045d3329572124454609b26fc81vboxsync [--directory] [--secure] [--tmpdir <directory>]
25a7ceab67b83045d3329572124454609b26fc81vboxsync [--domain <domain>] [--mode <mode>] [--verbose]</screen>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>template</computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>A file name without a path and with at least three consecutive 'X'
25a7ceab67b83045d3329572124454609b26fc81vboxsync characters or ending in 'X'
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>Name of the user the copy process should run under.
25a7ceab67b83045d3329572124454609b26fc81vboxsync This user must exist on the guest OS.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>Password of the user account specified to be read from
25a7ceab67b83045d3329572124454609b26fc81vboxsync the given file. If not given, an empty password is
25a7ceab67b83045d3329572124454609b26fc81vboxsync assumed.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>Password of the user account specified with
25a7ceab67b83045d3329572124454609b26fc81vboxsync <computeroutput>--username</computeroutput>. If not given,
25a7ceab67b83045d3329572124454609b26fc81vboxsync an empty password is assumed.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--directory</computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para>Create a temporary directory instead of a file.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--secure</computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync Secure creation. The file mode is fixed to
25a7ceab67b83045d3329572124454609b26fc81vboxsync <computeroutput>0755</computeroutput>. And the operation
25a7ceab67b83045d3329572124454609b26fc81vboxsync will fail if it cannot performed securely.
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm>
25a7ceab67b83045d3329572124454609b26fc81vboxsync Directory where the file / directory is created. If not
25a7ceab67b83045d3329572124454609b26fc81vboxsync specified, the platform-specific temp directory is used.
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossdef>
25a7ceab67b83045d3329572124454609b26fc81vboxsync </glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Sets the permission mode of the specified directory.
241adddf415cbdf66230864a215b24415f482e72vboxsync Only octal modes (e.g.
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>0755</computeroutput>) are supported right
241adddf415cbdf66230864a215b24415f482e72vboxsync now.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossdef>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossentry>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </listitem>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>,
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync which lists various guest control information such as open guest sessions,
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync guest processes and guest files.</para>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> list
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync <all|sessions|processes|files> [--verbose]</screen>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <glossentry>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossdef>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossentry>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <glossentry>
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync <glossterm><computeroutput>all|sessions|processes|files</computeroutput></glossterm>
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync <para>Whether to list guest sessions, guest processes, guest files
a4e9685663a7fc24d8fd1036f97c317efef72d16vboxsync or all information available. Mandatory.</para>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossdef>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossentry>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <glossentry>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossdef>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </glossentry>
33bbb0b39b504ed44fba55d5240efbd003899337vboxsync </listitem>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para><emphasis role="bold"><computeroutput>process kill</computeroutput></emphasis>,
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync which terminates specific guest processes of a guest session, based on either the
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync session's ID or the session's name.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <screen>VBoxManage guestcontrol <uuid|vmname> process kill
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync --session-id <ID>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync | --session-name <name or pattern>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync [--verbose]
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <PID> ... <PID n></screen>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--session-id</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>Specifies the guest session to use by its ID.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--session-name</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>Specifies the guest session to use by its name. Multiple
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync sessions can be closed when specifying * or ? wildcards.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>List of process identifiers (PIDs) to terminate.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </listitem>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para><emphasis role="bold"><computeroutput>[p[s]]kill</computeroutput></emphasis>,
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync which terminates specific guest processes of a guest session, based on either the
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync session's ID or the session's name.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <screen>VBoxManage guestcontrol <uuid|vmname> process kill
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync --session-id <ID>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync | --session-name <name or pattern>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync [--verbose]
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <PID> ... <PID n></screen>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--session-id</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>Specifies the guest session to use by its ID.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--session-name</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>Specifies the guest session to use by its name. Multiple
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync sessions can be closed when specifying * or ? wildcards.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync <para>List of process identifiers (PIDs) to terminate.</para>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossdef>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </glossentry>
6c16302f0e6c0440eb48e80c799814c22759616bvboxsync </listitem>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <para><emphasis role="bold"><computeroutput>session close</computeroutput></emphasis>,
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync which closes specific guest sessions, based on either the session's ID or the
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync session's name.</para>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> session close
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync --session-id <ID>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync | --session-name <name or pattern>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync [--verbose]</screen>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossdef>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossterm><computeroutput>--session-id</computeroutput></glossterm>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <para>Close a guest session specified by its ID.</para>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossdef>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossterm><computeroutput>--session-name</computeroutput></glossterm>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <para>Close a guest session specified by its name. Multiple sessions
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync can be closed when specifying * or ? wildcards.</para>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossdef>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossterm><computeroutput>--all</computeroutput></glossterm>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossdef>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossdef>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </glossentry>
dffef6e9475855654bf500dc63b510a987e8afa1vboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which displays file
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync or file system status on the guest.</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> stat
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <file>... --username <name>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync [--passwordfile <file> | --password <password>]
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync [--verbose]</screen>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossdef>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossentry>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>file element(s) to check on guest</computeroutput></glossterm>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <para>Absolute path of directory/directories to check on
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync guest, e.g. <computeroutput>/home/foo/a.out</computeroutput>.
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync The specified user must have appropriate rights to access
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync the given file element(s).</para>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossdef>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossentry>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <para>Name of the user the copy process should run under.
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync This user must exist on the guest OS.</para>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossdef>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossentry>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync <para>Password of the user account specified to be read from
94c4b844625733fedcd2b473c207981b31316bd9vboxsync the given file. If not given, an empty password is
94c4b844625733fedcd2b473c207981b31316bd9vboxsync assumed.</para>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossdef>
94c4b844625733fedcd2b473c207981b31316bd9vboxsync </glossentry>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <para>Password of the user account specified with
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <computeroutput>--username</computeroutput>. If not given,
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync an empty password is assumed.</para>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossdef>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossentry>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossdef>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </glossentry>
8782e654b5a355600d165b6e0bb761b8f4e769fdvboxsync </listitem>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <para><emphasis role="bold"><computeroutput>updateadditions</computeroutput></emphasis>,
25a7ceab67b83045d3329572124454609b26fc81vboxsync which allows
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync for updating an already installed Guest Additions version on the
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync guest (only already installed Guest Additions 4.0 and later).</para>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> updateadditions
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync [--source "<guest additions .ISO file to use>"] [--verbose]
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync [--wait-start] [-- [<argument1>] ... [<argumentN>]]</screen>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossdef>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossentry>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <glossentry>
825550b7cd73a853206d1369414f347e6244e7c7vboxsync <glossterm><computeroutput>--source</computeroutput> "<guest additions .ISO file to
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync use>"</glossterm>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <para>Full path to an alternative VirtualBox Guest Additions
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync .ISO file to use for the Guest Additions update.</para>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossdef>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>--wait-start</computeroutput></glossterm>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync <para>Starts the regular updating process and waits until the
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync actual Guest Additions update inside the guest was started.
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync This can be necessary due to needed interaction with the
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync guest OS during the installation phase.</para>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync <para>When omitting this flag VBoxManage will wait for the
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync whole Guest Additions update to complete.</para>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync </glossdef>
2927a95ee3fe77d319ee5959368c7dfc119a96fbvboxsync </glossentry>
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm>
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync <para>Optional command line arguments to use for the Guest Additions
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync installer. Useful for retrofitting features which weren't installed
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync before on the guest.</para>
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync <para>Arguments containing spaces must be enclosed in
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync quotation marks.</para>
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync </glossdef>
2e4df4fd9eace3c61be68bb5eb12a93f9a79334dvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
5a5fc1252f176bdf835aabede085b34a39ca2550vboxsync <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>,
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync which prints current guest control activity.</para>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> watch
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync [--verbose]</screen>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync <glossentry>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync </glossdef>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync </glossentry>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync <glossentry>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync </glossdef>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync </glossentry>
5c3f761157f42a9a05e8d1f0556f00305e56e8f0vboxsync </listitem>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>The "debugvm" commands are for experts who want to tinker with the
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync exact details of virtual machine execution. Like the VM debugger described
438dd62b5c796170381bedd039e4d946b1625630vboxsync in <xref linkend="ts_debugger" />, these commands are only useful if you are
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync very familiar with the details of the PC architecture and how to debug
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync software.</para>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>The subcommands of "debugvm" all operate on a running virtual
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync machine. The following are available:<itemizedlist>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>With <computeroutput>dumpguestcore --filename
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <name></computeroutput>, you can create a system dump of the
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync running VM, which will be written into the given file. This file
7b45e137929ef8ecfd0d3446c64a588509931e56vboxsync will have the standard ELF core format (with custom sections); see
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>This corresponds to the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <computeroutput>writecore</computeroutput> command in the debugger.
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>info</computeroutput> command is used to
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync display info items relating to the VMM, device emulations and
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync associated drivers. This command takes one or two arguments: the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync name of the info item, optionally followed by a string containing
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync arguments specific to the info item.
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync The <computeroutput>help</computeroutput> info item provides a
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync listning of the available items and hints about any optional
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync arguments.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>This corresponds to the <computeroutput>info</computeroutput>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync command in the debugger.</para>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync </listitem>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>The <computeroutput>injectnmi</computeroutput> command causes
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync a non-maskable interrupt (NMI) in the guest, which might be useful
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync for certain debugging scenarios. What happens exactly is dependent
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync on the guest operating system, but an NMI can crash the whole guest
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync operating system. Do not use unless you know what you're
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync doing.</para>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>osdetect</computeroutput> command makes the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync VMM's debugger facility (re-)detection the guest operation
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync system.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>This corresponds to the <computeroutput>detect</computeroutput>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync command in the debugger.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>osinfo</computeroutput> command is used to
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync display info about the operating system (OS) detected by the VMM's
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync debugger facility.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>getregisters</computeroutput> command is
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync used to display CPU and device registers. The command takes a list
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync of registers, each having one of the following forms:
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <itemizedlist>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>register-set.register-name.sub-field</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>register-set.register-name</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>cpu-register-name.sub-field</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>cpu-register-name</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>all</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </itemizedlist>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync The <computeroutput>all</computeroutput> form will cause all
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync registers to be shown (no sub-fields). The registers names are
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync case-insensitive. When requesting a CPU register the register set
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync can be omitted, it will be selected using the value of the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <computeroutput>--cpu</computeroutput> option (defaulting to 0).
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>setregisters</computeroutput> command is
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync used to change CPU and device registers. The command takes a list
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync of register assignments, each having one of the following forms:
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <itemizedlist>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>register-set.register-name.sub-field=value</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>register-set.register-name=value</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>cpu-register-name.sub-field=value</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <listitem><computeroutput>cpu-register-name=value</computeroutput></listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </itemizedlist>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync The value format should be in the same style as what
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <computeroutput>getregisters</computeroutput> displays, with the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync exception that both octal and decimal can be used instead of
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync hexadecimal. The register naming and the default CPU register set
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync are handled the same way as with the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <computeroutput>getregisters</computeroutput> command.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>The <computeroutput>statistics</computeroutput> command can be
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync used to display VMM statistics on the command line. The
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <computeroutput>--reset</computeroutput> option will reset
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync statistics. The affected statistics can be filtered with the
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <computeroutput>--pattern</computeroutput> option, which accepts
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync DOS/NT-style wildcards (<computeroutput>?</computeroutput> and
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync </listitem>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This command supports monitoring the usage of system resources.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Resources are represented by various metrics associated with the host
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync system or a particular VM. For example, the host system has a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>CPU/Load/User</computeroutput> metric that shows the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync percentage of time CPUs spend executing in user mode over a specific
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync sampling period.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Metric data is collected and retained internally; it may be
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync retrieved at any time with the <computeroutput>VBoxManage metrics
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync query</computeroutput> subcommand. The data is available as long as the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync background <computeroutput>VBoxSVC</computeroutput> process is alive. That
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync process terminates shortly after all VMs and frontends have been
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync closed.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>By default no metrics are collected at all. Metrics collection does
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync not start until <computeroutput>VBoxManage metrics setup</computeroutput>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync is invoked with a proper sampling interval and the number of metrics to be
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync retained. The interval is measured in seconds. For example, to enable
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync collecting the host processor and memory usage metrics every second and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync keeping the 5 most current samples, the following command can be
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync used:</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Metric collection can only be enabled for started VMs. Collected
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync data and collection settings for a particular VM will disappear as soon as
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync it shuts down. Use <computeroutput>VBoxManage metrics list
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </computeroutput> subcommand to see which metrics are currently available.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync You can also use <computeroutput>--list</computeroutput> option with any
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync subcommand that modifies metric settings to find out which metrics were
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync affected.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Note that the <computeroutput>VBoxManage metrics
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync setup</computeroutput> subcommand discards all samples that may have been
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync previously collected for the specified set of objects and metrics.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>To enable or disable metrics collection without discarding the data
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>VBoxManage metrics enable</computeroutput> and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>VBoxManage metrics disable</computeroutput> subcommands
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync can be used. Note that these subcommands expect metrics, not submetrics,
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync other words enabling <code>CPU/Load/User</code> while disabling
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <code>CPU/Load/Kernel</code> is not supported.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The host and VMs have different sets of associated metrics.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Available metrics can be listed with <computeroutput>VBoxManage metrics
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>A complete metric name may include an aggregate function. The name
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync has the following form:
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync for the minimum amount of available memory over all retained data if
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync applied to the host object.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Subcommands may apply to all objects and metrics or can be limited
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync to one object or/and a list of metrics. If no objects or metrics are given
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync in the parameters, the subcommands will apply to all available metrics of
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync all objects. You may use an asterisk
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync ("<computeroutput>*</computeroutput>") to explicitly specify that the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync command should be applied to all objects or metrics. Use "host" as the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync object name to limit the scope of the command to host-related metrics. To
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync limit the scope to a subset of metrics, use a metric list with names
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync separated by commas.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>For example, to query metric data on the CPU time spent in user and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync kernel modes by the virtual machine named "test", you can use the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync following command:</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The following list summarizes the available subcommands:</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glosslist>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>list</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand shows the parameters of the currently existing
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync metrics. Note that VM-specific metrics are only available when a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync particular VM is running.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>setup</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand sets the interval between taking two samples
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync of metric data and the number of samples retained internally. The
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync retained data is available for displaying with the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <code>query</code> subcommand. The <computeroutput>--list
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </computeroutput> option shows which metrics have been modified as
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync the result of the command execution.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>enable</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand "resumes" data collection after it has been
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync stopped with <code>disable</code> subcommand. Note that specifying
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync submetrics as parameters will not enable underlying metrics. Use
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>--list</computeroutput> to find out if the command
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync did what was expected.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>disable</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand "suspends" data collection without affecting
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync collection parameters or collected data. Note that specifying
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync submetrics as parameters will not disable underlying metrics. Use
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>--list</computeroutput> to find out if the command
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync did what was expected.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>query</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand retrieves and displays the currently retained
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync metric data.<note>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The <code>query</code> subcommand does not remove or
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync "flush" retained data. If you query often enough you will see
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync how old samples are gradually being "phased out" by new
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync samples.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
25a7ceab67b83045d3329572124454609b26fc81vboxsync <glossterm><computeroutput>collect</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This subcommand sets the interval between taking two samples
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync of metric data and the number of samples retained internally. The
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync collected data is displayed periodically until Ctrl-C is pressed
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync unless the <computeroutput>--detach</computeroutput> option is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync specified. With the <computeroutput>--detach</computeroutput>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync option, this subcommand operates the same way as <code>setup</code>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync does. The <computeroutput>--list</computeroutput> option shows which
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync metrics match the specified filter.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glosslist>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>With "hostonlyif" you can change the IP configuration of a host-only
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync network interface. For a description of host-only networking, please
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync refer to <xref linkend="network_hostonly" />. Each host-only interface is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync identified by a name and can either use the internal DHCP server or a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync manual IP configuration (both IP4 and IP6).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The "dhcpserver" commands allow you to control the DHCP server that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is built into VirtualBox. You may find this useful when using internal or
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync host-only networking. (Theoretically, you can enable it for a bridged
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network as well, but that will likely cause conflicts with other DHCP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync servers in your physical network.)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Use the following command line options:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If you use internal networking for a virtual network adapter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --netname <network_name></computeroutput>, where
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><network_name></computeroutput> is the same
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network name you used with <computeroutput>VBoxManage modifyvm
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <vmname> --intnet<X>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If you use host-only networking for a virtual network adapter
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --ifname <hostonly_if_name></computeroutput> instead, where
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><hostonly_if_name></computeroutput> is the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync same host-only interface name you used with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage modifyvm <vmname>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --hostonlyadapter<X>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Alternatively, you can also use the --netname option as with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync internal networks if you know the host-only network's name; you can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see the names with <computeroutput>VBoxManage list
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync above).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following additional parameters are required when first adding a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync DHCP server:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With <computeroutput>--ip</computeroutput>, specify the IP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync address of the DHCP server itself.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With <computeroutput>--netmask</computeroutput>, specify the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync netmask of the network.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>With <computeroutput>--lowerip</computeroutput> and
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--upperip</computeroutput>, you can specify the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync lowest and highest IP address, respectively, that the DHCP server
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will hand out to clients.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Finally, you must specify <computeroutput>--enable</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync or the DHCP server will be created in the disabled state, doing
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync nothing.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>After this, VirtualBox will automatically start the DHCP server for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync given internal or host-only network as soon as the first virtual machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which uses that network is started.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Reversely, use <computeroutput>VBoxManage dhcpserver
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync remove</computeroutput> with the given <computeroutput>--netname
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <network_name></computeroutput> or <computeroutput>--ifname
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <hostonly_if_name></computeroutput> to remove the DHCP server again
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for the given internal or host-only network.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To modify the settings of a DHCP server created earlier with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network or host-only interface name.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>The "extpack" command allows you to add or remove VirtualBox
241adddf415cbdf66230864a215b24415f482e72vboxsync extension packs, as described in <xref
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>To add a new extension pack, use <computeroutput>VBoxManage
3c86d18f6de81487b85fbaca74ba704a84ee6213vboxsync extpack install <.vbox-extpack></computeroutput>. This command
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync will fail if an older version of the same extension pack is already
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync installed. The optional <computeroutput>--replace</computeroutput>
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync parameter can be used to uninstall the old package before the new
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync package is installed.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>To remove a previously installed extension pack, use
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>VBoxManage extpack uninstall
241adddf415cbdf66230864a215b24415f482e72vboxsync <name></computeroutput>. You can use
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>VBoxManage list extpacks</computeroutput> to show
241adddf415cbdf66230864a215b24415f482e72vboxsync the names of the extension packs which are currently installed;
241adddf415cbdf66230864a215b24415f482e72vboxsync please see <xref linkend="vboxmanage-list" /> also. The optional
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>--force</computeroutput> parameter can be used to
241adddf415cbdf66230864a215b24415f482e72vboxsync override the refusal of an extension pack to be uninstalled.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync cleanup</computeroutput> command can be used to remove temporary
241adddf415cbdf66230864a215b24415f482e72vboxsync files and directories that may have been left behind if a previous
241adddf415cbdf66230864a215b24415f482e72vboxsync install or uninstall command failed.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </listitem>
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsync <para>The following commands show examples how to list extension packs and
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsync remove one:<screen>
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsync$ VBoxManage list extpacks
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncExtension Packs: 1
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncPack no. 0: Oracle VM VirtualBox Extension Pack
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncVersion: 4.1.12
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncRevision: 77218
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncDescription: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support.
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncVRDE Module: VBoxVRDP
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncUsable: true
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncWhy unusable:
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsync$ VBoxManage extpack uninstall "Oracle VM VirtualBox Extension Pack"
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsync0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
94dea3912601416e2eaca10cdae999fc4a7fff0fvboxsyncSuccessfully uninstalled "Oracle VM VirtualBox Extension Pack".</screen></para>