user_VBoxManage.xml revision 5999df4de51c716ca922e268c4b0d60beeb51ac6
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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncSettings 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 512</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>
e7c4c205cb0af88b5ef0786be46da94847a9a37bvboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--version</computeroutput>: show the version of
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this tool and exit.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--nologo</computeroutput>: suppress the output
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync of the logo information (useful for scripts)</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--settingspw</computeroutput>: specifiy a settings
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync password</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--settingspwfile</computeroutput>: specify a file
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync containing the settings password.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync The settings password is used for certain settings which need to be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync stored encrypted for security reasons. At the moment, the only encrypted
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync setting is the iSCSI initiator secret (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="vboxmanage-storageattach" /> for details). As long as no
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync settings password is specified, this information is stored in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <emphasis role="bold">plain text</emphasis>. After using the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--settingspw|--settingspwfile</computeroutput> option
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync once, it must be always used, otherwise the encrypted setting cannot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be unencrypted.
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>The <computeroutput>list</computeroutput> command gives relevant
241adddf415cbdf66230864a215b24415f482e72vboxsync information about your system and information about VirtualBox's current
241adddf415cbdf66230864a215b24415f482e72vboxsync settings.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>The following subcommands are available with
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para><computeroutput>vms</computeroutput> lists all virtual
241adddf415cbdf66230864a215b24415f482e72vboxsync machines currently registered with VirtualBox. By default this
241adddf415cbdf66230864a215b24415f482e72vboxsync displays a compact list with each VM's name and UUID; if you also
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>-l</computeroutput>, this will be a detailed list as
241adddf415cbdf66230864a215b24415f482e72vboxsync with the <computeroutput>showvminfo</computeroutput> command (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync below).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <para><computeroutput>runningvms</computeroutput> lists all
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync currently running virtual machines by their unique identifiers
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (UUIDs) in the same format as with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>ostypes</computeroutput> lists all guest
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync operating systems presently known to VirtualBox, along with the
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync identifiers used to refer to them with the
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <computeroutput>modifyvm</computeroutput> command.</para>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>hostfloppies</computeroutput>, respectively, list
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync DVD, floppy, bridged networking and host-only networking interfaces
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync servers currently available on the host. Please see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="networkingdetails" /> for details on these.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync <para><computeroutput>hostinfo</computeroutput> displays information
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync about the host system, such as CPUs, memory size and operating
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync system version.</para>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para><computeroutput>hddbackends</computeroutput> lists all known
241adddf415cbdf66230864a215b24415f482e72vboxsync virtual disk back-ends of VirtualBox. For each such format (such as
241adddf415cbdf66230864a215b24415f482e72vboxsync VDI, VMDK or RAW), this lists the back-end's capabilities and
241adddf415cbdf66230864a215b24415f482e72vboxsync configuration.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync them by VirtualBox and all files associated with them. This is the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync command-line equivalent of the Virtual Media Manager; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>usbhost</computeroutput> supplies information
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync about USB devices attached to the host, notably information useful
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for constructing USB filters and whether they are currently in use
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync by the host.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>usbfilters</computeroutput> lists all global
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync USB filters registered with VirtualBox -- that is, filters for
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync devices which are accessible to all virtual machines -- and displays
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the filter parameters.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>systemproperties</computeroutput> displays
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync some global VirtualBox settings, such as minimum and maximum guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync RAM and virtual hard disk size, folder settings and the current
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync authentication library in use.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>extpacks</computeroutput> displays all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VirtualBox extension packs currently installed; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="vboxmanage-extpack" /> for more information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncConfig 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
4791a729647f035b6561d292c9f848dd1fc797a9vboxsyncTime 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsyncVRDE: 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>--groups <group>, ...</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This changes the group membership of a VM. Groups always start with
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync a <computeroutput>/</computeroutput> and can be nested. By default
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VMs are in group <computeroutput>/</computeroutput>.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--description <desc></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This changes the VM's description, which is a way to record details
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync about the VM in a way which is meaningful for the user. The GUI
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interprets HTML formatting, the command line allows arbitrary
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync strings potentially containing multiple lines.</para>
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,
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync respectively; see <xref linkend="settings-motherboard" /> for
223935479ac42db56b7b7a7d16548d590022996avboxsync details.</para>
223935479ac42db56b7b7a7d16548d590022996avboxsync </listitem>
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync <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>
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync <para><computeroutput>--cpuhotplug on|off</computeroutput>: This
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync enables CPU hot-plugging. When enabled, virtual CPUs can be added
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync to and removed from a virtual machine while it is running. See
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync <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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <1-100></computeroutput>: This setting controls how much cpu
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync time a virtual CPU can use. A value of 50 implies a single virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync CPU can use up to 50% of a single host CPU.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--pae on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--longmode on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--synthcpu on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync setting determines whether VirtualBox will expose a synthetic CPU
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to the guest to allow live migration between host systems that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync differ significantly.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--hwvirtex on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables or disables the use of hardware virtualization extensions
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (Intel VT-x or AMD-V) in the processor of your host system; see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--triplefaultreset on|off</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This setting allows to reset the guest instead of triggering a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Guru Meditation. Some guests raise a triple fault to reset the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync CPU so sometimes this is desired behavior. Works only for non-SMP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync guests.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync none|default|legacy|minimal|hyperv|kvm</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync setting specifies which paravirtualization interface to provide to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the guest operating system. Specifying
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>none</computeroutput> explicitly turns off exposing
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync any paravirtualization interface. The option
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>default</computeroutput>, will pick an appropriate
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface depending on the guest OS type while starting the VM.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This is the default option chosen while creating new VMs. The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>legacy</computeroutput> option is chosen for VMs
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which were created with older VirtualBox versions and will pick a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync paravirtualization interface while starting the VM with VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 5.0 and newer. The <computeroutput>minimal</computeroutput> provider
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is mandatory for Mac OS X guests, while
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>hyperv</computeroutput> are recommended for Linux
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and Windows guests respectively. These options are explained in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync detail under <xref linkend="gimproviders" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vtxux on|off</computeroutput>: If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hardware virtualization is enabled, for Intel VT-x only, this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync setting enables or disables the use of the unrestricted guest mode
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync feature for executing your guest.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--accelerate3d on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables, if the Guest Additions are installed, whether hardware 3D
447cbf113f44132911fc13dc33cb26603759b82evboxsync 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>
447cbf113f44132911fc13dc33cb26603759b82evboxsync on|off</computeroutput> and <computeroutput>--bioslogofadeout
447cbf113f44132911fc13dc33cb26603759b82evboxsync on|off</computeroutput>, you can determine whether the logo should
447cbf113f44132911fc13dc33cb26603759b82evboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync image must be an uncompressed 256 color BMP file without color
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync space information (Windows 3.0 format). The image must not be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <priority></computeroutput>: This specifies the order in which
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync NICs are tried for booting over the network (using PXE). The
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync priority is an integer in the 0 to 4 range. Priority 1 is the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync highest, priority 4 is low. Priority 0, which is the default unless
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync otherwise specified, is the lowest.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para> Note that this option only has effect when the Intel PXE boot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync ROM is used.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput><size></computeroutput> must be specified in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync megabytes. The default size is 0 megabytes. For details,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <Device></computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Specifies the Device Name of the parallel port that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the Parallel Port feature will be using. Use this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
447cbf113f44132911fc13dc33cb26603759b82evboxsync This feature is host operating system specific.</para>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </listitem>
447cbf113f44132911fc13dc33cb26603759b82evboxsync <I/O base> <IRQ></computeroutput>
447cbf113f44132911fc13dc33cb26603759b82evboxsync Specifies the I/O address of the parallel port and the IRQ
447cbf113f44132911fc13dc33cb26603759b82evboxsync number that the Parallel Port feature will be using. Use this
447cbf113f44132911fc13dc33cb26603759b82evboxsync <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
4fac78486305f1f002adbf23953382e5d832af94vboxsync the values that guest sees i.e. the values avalable under guest Device Manager.</para>
447cbf113f44132911fc13dc33cb26603759b82evboxsync </listitem>
4fac78486305f1f002adbf23953382e5d832af94vboxsync default|<name></computeroutput>: This allows you to specify
447cbf113f44132911fc13dc33cb26603759b82evboxsync the default frontend which will be used when starting this VM; see
447cbf113f44132911fc13dc33cb26603759b82evboxsync <xref linkend="vboxmanage-startvm" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync none|null|nat|bridged|intnet|hostonly|generic
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>hostonly</computeroutput>), or access rarely used
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync sub-modes (<computeroutput>generic</computeroutput>).
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <backend driver></computeroutput>: If generic networking has been
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enabled for a virtual network card (see the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--nic</computeroutput> option above; otherwise
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this setting has no effect), this mode allows you to access
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync rarely used networking sub-modes, such as VDE network or UDP Tunnel.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <paramname>="paramvalue"</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This option, in combination with "nicgenericdrv" allows you to
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync pass parameters to rarely-used network backends.</para><para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Those parameters are backend engine-specific, and are different
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync default|[log],[proxyonly],[sameports]</computeroutput>: This
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync option defines behaviour of NAT engine core: log - enables
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync logging, proxyonly - switches of aliasing mode makes NAT
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync 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
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync </listitem>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <para>The following other hardware settings, such as serial port, audio,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync clipboard, drag'n drop, monitor and USB 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
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync virtual serial ports for the VM; see <xref
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync linkend="serialports" /> for an introduction.</para>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <arg></computeroutput>: This setting controls how VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync connects a given virtual serial port (previously configured with
b8908d384db2324f04a2f68a13e67ea32ebf609avboxsync 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,
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync you can specify <computeroutput><arg></computeroutput> as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync one of the following options:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>disconnected</computeroutput>: Even
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync though the serial port is shown to the guest, it has no
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync "other end" -- like a real COM port without a cable.</para>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <pipename></computeroutput>: On a Windows host, this
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync tells VirtualBox to create a named pipe on the host named
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync <computeroutput><pipename></computeroutput> and
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync connect the virtual serial device to it. Note that Windows
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync requires that the name of a named pipe begin with
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <para>On a Linux host, instead of a named pipe, a local
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync domain socket is used.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <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>
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <port></computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync tells VirtualBox to create a TCP socket on the host with TCP
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync connect the virtual serial device to it. Note that UNIX-like
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync systems require ports over 1024 for normal users.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <hostname:port></computeroutput>: This operates just like
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>tcpserver ...</computeroutput>, except that the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync TCP 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 if and how the guest or host
ae56268ed43efa582cc3605ea0270106562a306dvboxsync operating system's clipboard should be shared with the host or guest;
ae56268ed43efa582cc3605ea0270106562a306dvboxsync see <xref linkend="generalsettings" />. This requires that the Guest
ae56268ed43efa582cc3605ea0270106562a306dvboxsync Additions be installed in the virtual machine.</para>
ae56268ed43efa582cc3605ea0270106562a306dvboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync With this setting, you can select the current drag'n drop mode
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync being used between the host and the virtual machine;
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="guestadd-dnd" />. 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 <!-- @todo r=andy Document tracing-* commands -->
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following settings that affect remote machine behavior are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync available through <computeroutput>VBoxManage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vrde on|off</computeroutput>: With the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VirtualBox graphical user interface, this enables or disables the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync VirtualBox remote desktop extension (VRDE) server. Note that if
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync you are using <computeroutput>VBoxHeadless</computeroutput> (see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="vboxheadless" />), VRDE is enabled by
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <!-- @todo r=andy Document vrdeproperty -->
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync default|<ports></computeroutput>: A port or a range of ports
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface the VRDE server will bind to. If specified, the server
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will accept connections only on the specified host network
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync interface.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The setting can be used to specify whether the VRDP server
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync should accept either IPv4 or IPv6 or both connections:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>only IPv6: <computeroutput>--vrdeaddress "::"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress ""
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vrdemulticon on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync enables multiple connections to the same VRDE server, if the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vrdereusecon on|off</computeroutput>: This
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync specifies the VRDE server behavior when multiple connections are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync disabled. When this option is enabled, the server will allow a new
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync client to connect and will drop the existing connection. When this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option is disabled (this is the default setting), a new connection
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will not be accepted if there is already a client connected to the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync server.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--vrdevideochannel on|off</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This enables video redirection, if it is supported by the VRDE
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync server; see <xref lang="" linkend="vrde-videochannel" />.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this command.</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 specified
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in the file give with this command. Use <computeroutput>stdin</computeroutput>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync 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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command creates a full or linked copy of an existing virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync machine.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The <computeroutput>clonevm</computeroutput> subcommand takes at
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync least the name of the virtual machine which should be cloned. The following
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync additional settings can be used to further configure the clone VM
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync operation:</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--snapshot <uuid>|<name></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Select a specific snapshot where the clone operation should refer
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to. Default is referring to the current state.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--mode machine|machineandchildren|all</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Selects the cloning mode of the operation. If
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>machine</computeroutput> is selected (the default),
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the current state of the VM without any snapshots is cloned. In the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>machineandchildren</computeroutput> mode the snapshot
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync provided by <computeroutput>--snapshot</computeroutput> and all
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync child snapshots are cloned. If <computeroutput>all</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is the selected mode all snapshots and the current state are cloned.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--options link|keepallmacs|keepnatmacs|keepdisknames</computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Allows additional fine tuning of the clone operation. The first
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync option defines that a linked clone should be created, which is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync only possible for a machine clone from a snapshot. The next two
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync options allow to define how the MAC addresses of every virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync network card should be handled. They can either be reinitialized
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (the default), left unchanged
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>keepallmacs</computeroutput>) or left unchanged
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync when the network type is NAT
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (<computeroutput>keepnatmacs</computeroutput>). If you add
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>keepdisknames</computeroutput> all new disk images
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync are called like the original ones, otherwise they are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync renamed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--name <name></computeroutput>: Select a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync new name for the new virtual machine. Default is "Original Name
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Clone".</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--basefolder <basefolder></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Select the folder where the new virtual machine configuration should
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be saved in.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>--uuid <uuid></computeroutput>:
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Select the UUID the new VM should have. This id has to be unique in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the VirtualBox instance this clone should be registered. Default is
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync creating a new UUID.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Automatically register the new clone in this VirtualBox
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync installation. If you manually want to register the new VM later, see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <xref linkend="vboxmanage-registervm" /> for instructions how to do
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
447cbf113f44132911fc13dc33cb26603759b82evboxsync <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
447cbf113f44132911fc13dc33cb26603759b82evboxsync imported and modify the import parameters, but the details depend on the
4fac78486305f1f002adbf23953382e5d832af94vboxsync 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>")
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync 3: Number of CPUs: 1
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync (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")
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync 6: USB controller
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync (disable with "--vsys 0 --unit 6 --ignore")
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 7: Network adapter: orig bridged, config 2, extra type=bridged
4791a729647f035b6561d292c9f848dd1fc797a9vboxsync (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>
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync <para>As you can see, the individual configuration items are numbered, and
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync depending on their type support different command-line options. The import
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync subcommand can be directed to ignore many such items with a
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync <computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
6c221e25dc2b60524e787167348abb062dd89f3fvboxsync 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
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
fd60bfdb327b9b1e7a6d084cf368fb7f07c566cfvboxsync --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
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync compressed VMDK format (regardless of the original format) and should have
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync enough disk space left for them.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>Beside a simple export of a given virtual machine, you can append
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync several product information to the appliance file. Use
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <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>To specify options controlling the exact content of the appliance
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync file, you can use <computeroutput>--option</computeroutput> to request the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync creation of a manifest file (encouraged, allows detection of corrupted
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync appliances on import), the additional export of DVD images, and the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync exclusion of MAC addresses. You can specify a list of options, e.g.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--option manifest,nomacs</computeroutput>. For details,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync check the help output of <computeroutput>VBoxManage export</computeroutput>.</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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync determines whether the machine will be started in a window or whether the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync output should go through <computeroutput>VBoxHeadless</computeroutput>,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information. The list of types is subject to change, and it's not
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync guaranteed that all types are accepted by any product variant.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The global or per-VM default value for the VM frontend type will be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync taken if the type is not explicitly specified. If none of these are set,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the GUI variant will be started.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glosslist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>gui</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Starts a VM showing a GUI window. This is the default.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>headless</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Starts a VM without a window for remote display only.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>sdl</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Starts a VM with a minimal GUI and limited features.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <glossterm><computeroutput>separate</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Starts a VM with detachable UI (technically it is a headless VM
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync with user interface in a separate process). This is an experimental
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync feature as it lacks certain functionality at the moment (e.g. 3D
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync acceleration will not work).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glosslist>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>If you experience problems with starting virtual machines with
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync particular frontends and there is no conclusive error information,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync consider starting virtual machines directly by running the respective
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync front-end, as this can give additional error information.</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <para>The <computeroutput>controlvm</computeroutput> subcommand allows you
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync to change the state of a virtual machine that is currently running. The
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync following can be specified:</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>VBoxManage controlvm <vm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync pause</computeroutput> temporarily puts a virtual machine on hold,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync without changing its state for good. The VM window will be painted
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync in gray to indicate that the VM is currently paused. (This is
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync equivalent to selecting the "Pause" item in the "Machine" menu of
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the GUI.)</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Use <computeroutput>VBoxManage controlvm <vm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync resume</computeroutput> to undo a previous
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>pause</computeroutput> command. (This is equivalent
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync to selecting the "Resume" item in the "Machine" menu of the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync GUI.)</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>VBoxManage controlvm <vm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync reset</computeroutput> has the same effect on a virtual machine as
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync pressing the "Reset" button on a real computer: a cold reboot of the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync virtual machine, which will restart and boot the guest operating
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync system again immediately. The state of the VM is not saved
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync beforehand, and data may be lost. (This is equivalent to selecting
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the "Reset" item in the "Machine" menu of the GUI.)</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>VBoxManage controlvm <vm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync poweroff</computeroutput> has the same effect on a virtual machine
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync as pulling the power cable on a real computer. Again, the state of
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the VM is not saved beforehand, and data may be lost. (This is
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync equivalent to selecting the "Close" item in the "Machine" menu of
223935479ac42db56b7b7a7d16548d590022996avboxsync the GUI or pressing the window's close button, and then selecting
223935479ac42db56b7b7a7d16548d590022996avboxsync "Power off the machine" in the dialog.)</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>After this, the VM's state will be "Powered off". From there,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync it can be started again; see <xref
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
223935479ac42db56b7b7a7d16548d590022996avboxsync <para><computeroutput>VBoxManage controlvm <vm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync savestate</computeroutput> will save the current state of the VM to
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync disk and then stop the VM. (This is equivalent to selecting the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync "Close" item in the "Machine" menu of the GUI or pressing the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync window's close button, and then selecting "Save the machine state"
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync in the dialog.)</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>After this, the VM's state will be "Saved". From there, it can
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync be started again; see <xref linkend="vboxmanage-startvm" />.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>VBoxManage controlvm "VM name" teleport
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync --hostname <name> --port <port> [--passwordfile
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <file> | --password <password>]</computeroutput> makes
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the machine the source of a teleporting operation and initiates a
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync teleport to the given target. See <xref linkend="teleporting" /> for
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync an introduction. If the optional password is specified, it must match
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the password that was given to the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>modifyvm</computeroutput> command for the target
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync machine; see <xref linkend="vboxmanage-modifyvm-teleport" /> for
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync details.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>A few extra options are available with
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>controlvm</computeroutput> that do not directly affect the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync VM's running state:</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <itemizedlist>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <!-- @todo r=andy Document keyboardputscancode -->
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>The <computeroutput>setlinkstate<1-N></computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync operation connects or disconnects virtual network cables from their
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync network interfaces.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync null|nat|bridged|intnet|hostonly|generic</computeroutput>: With this, you can
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync set, for each of the VM's virtual network cards, what type of
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync networking should be available. They can be not connected to the host
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (<computeroutput>null</computeroutput>), use network address
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync translation (<computeroutput>nat</computeroutput>), bridged networking
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (<computeroutput>bridged</computeroutput>) or communicate with other
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync virtual machines using internal networking
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (<computeroutput>intnet</computeroutput>) or host-only networking
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (<computeroutput>hostonly</computeroutput>) or access to rarely used
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync (<computeroutput>generic</computeroutput>). These options correspond
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync to the modes which are described in detail in <xref
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>With the "nictrace" options, you can optionally trace
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync network traffic by dumping it to a file, for debugging
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync purposes.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync on|off</computeroutput>, you can enable network tracing for a
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync particular virtual network card.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>If enabled, you must specify with
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>--nictracefile<1-N>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <filename></computeroutput> what file the trace should be
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync logged to.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <!-- @todo r=andy Document nicpromisc -->
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <paramname>="paramvalue"</computeroutput>:
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync This option, in combination with "nicgenericdrv" allows you to
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync pass parameters to rarely-used network backends.</para><para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync Those parameters are backend engine-specific, and are different
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync between UDP Tunnel and the VDE backend drivers. For example,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>The <computeroutput>guestmemoryballoon</computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync operation changes the size of the guest memory balloon, that is,
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync memory allocated by the VirtualBox Guest Additions from the guest
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync operating system and returned to the hypervisor for re-use by other
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync virtual machines. This must be specified in megabytes. For details,
80e46f984efd827517661c0e081a36014ca41af8vboxsync </listitem>
80e46f984efd827517661c0e081a36014ca41af8vboxsync <para><computeroutput>usbattach</computeroutput> and
80e46f984efd827517661c0e081a36014ca41af8vboxsync <computeroutput>usbdettach</computeroutput> make host USB devices
80e46f984efd827517661c0e081a36014ca41af8vboxsync visible to the virtual machine on the fly, without the need for
80e46f984efd827517661c0e081a36014ca41af8vboxsync creating filters first. The USB devices can be specified by UUID
80e46f984efd827517661c0e081a36014ca41af8vboxsync (unique identifier) or by address on the host system.</para>
80e46f984efd827517661c0e081a36014ca41af8vboxsync usbhost</computeroutput> to locate this information.</para>
80e46f984efd827517661c0e081a36014ca41af8vboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync With this setting, you can select if and how the guest or host
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync operating system's clipboard should be shared with the host or guest;
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync see <xref linkend="generalsettings" />. This requires that the Guest
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync Additions be installed in the virtual machine.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync disabled|hosttoguest|guesttohost|bidirectional</computeroutput>:
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync With this setting, you can select the current drag'n drop mode
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync being used between the host and the virtual machine;
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync see <xref linkend="guestadd-dnd" />. This requires that the Guest
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync Additions be installed in the virtual machine.</para>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync </listitem>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync <para><computeroutput>vrde on|off</computeroutput> lets you enable or
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync disable the VRDE server, if it is installed.</para>
1e9377d042fa2ea3e2cd78805678f23f64db55f6vboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>vrdeport default|<ports></computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync changes the port or a range of ports that the VRDE server can bind to;
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync "default" or "0" means port 3389, the standard port for RDP. For
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync details, see the description for the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <computeroutput>--vrdeport</computeroutput> option in <xref
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>setvideomodehint</computeroutput> requests that
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the guest system change to a particular video mode. This requires that
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the Guest Additions be installed, and will not work for all guest
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync systems.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>screenshotpng</computeroutput> takes a screenshot
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync of the guest display and saves it in PNG format.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <para><computeroutput>videocap on|off</computeroutput> enables or disables
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync recording a VM session into a WebM/VP8 file.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapscreens all|<screen ID> [<screen ID> ...]]</computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync allows to specify which screens of the VM are being recorded. This setting
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync cannot be changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapfile <file></computeroutput> sets the filename
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync VirtualBox uses to save the recorded content. This setting cannot be changed
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapres <width> <height></computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync sets the resolution (in pixels) of the recorded video. This setting cannot be
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocaprate <rate></computeroutput> sets the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync bitrate in kilobits (kb) per second. Increasing this value makes the video
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync look better for the cost of an increased file size. This setting cannot be
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapfps <fps></computeroutput> sets the
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync maximum number of frames per second (FPS) to be recorded. Frames with a
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync higher frequency will be skipped. Reducing this value increases the number
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync of skipped frames and reduces the file size. This setting cannot be changed
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <listitem> <!-- @todo r=andy Clarify time format. -->
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapmaxtime <time></computeroutput> sets
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the maximum time the video capturing will take place since activation.
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync The capturing stops when the defined time interval has elapsed. If this
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync value is zero the capturing is not limited by time. This setting cannot
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync be changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync <para><computeroutput>videocapmaxsize <MB></computeroutput> limits
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the maximum size of the captured video file (in MB). The capturing stops
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync when file size has reached the specified size. If this value is zero
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync the capturing will not be limited by file size. This setting cannot be
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para><computeroutput>videocapopts <key=value> [<key=value> ...]</computeroutput>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync can be used to specify additional video capturing options. These options
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync only are for advanced users and must be specified in a comma-separated
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync key=value format, e.g. <computeroutput>foo=bar,a=b</computeroutput>.
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync This setting cannot be changed while video capturing is enabled.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>setcredentials</computeroutput> operation is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync used for remote logons in Windows guests. For details, please refer to
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </listitem>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <!-- @todo r=andy Document teleport! -->
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <id></computeroutput>: If CPU hot-plugging is enabled, this adds
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync a virtual CPU to the virtual machines (or removes one).
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput><id></computeroutput> specifies the index of
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync the virtual CPU to be added or removed and must be a number from 0
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync to the maximum no. of CPUs configured. CPU 0 can never be removed.</para>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync </listitem>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <1-100></computeroutput>: This operation controls how much cpu
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync time a virtual CPU can use. A value of 50 implies a single virtual CPU
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync can use up to 50% of a single host CPU.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </listitem>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <!-- @todo r=andy Document webcam! -->
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </itemizedlist>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This command discards the saved state of a virtual machine which is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync not currently running, which will cause its operating system to restart
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync next time you start it. This is the equivalent of pulling out the power
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync cable on a physical machine, and should be avoided if possible.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync 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>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>This command is used to control snapshots from the command line. A
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync snapshot consists of a complete copy of the virtual machine settings,
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync copied at the time when the snapshot was taken, and optionally a virtual
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync machine saved state file if the snapshot was taken while the machine was
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync running. After a snapshot has been taken, VirtualBox creates differencing
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync hard disk for each normal hard disk associated with the machine so that
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync when a snapshot is restored, the contents of the virtual machine's virtual
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync hard disks can be quickly reset by simply dropping the pre-existing
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync differencing files.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The <computeroutput>take</computeroutput> operation takes a snapshot
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync of the current state of the virtual machine. You must supply a name for
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync the snapshot and can optionally supply a description. The new snapshot is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync inserted into the snapshots tree as a child of the current snapshot and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync then becomes the new current snapshot. The
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>--description</computeroutput> parameter allows to
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync describe the snapshot. If <computeroutput>--live</computeroutput>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync is specified, the VM will not be stopped during the snapshot creation
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync (live smapshotting).</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The <computeroutput>delete</computeroutput> operation deletes a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync snapshot (specified by name or by UUID). This can take a while to finish
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync since the differencing images associated with the snapshot might need to
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync be merged with their child differencing images.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The <computeroutput>restore</computeroutput> operation will restore
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync the given snapshot (specified by name or by UUID) by resetting the virtual
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync machine's settings and current state to that of the snapshot. The previous
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync current state of the machine will be lost. After this, the given snapshot
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync becomes the new "current" snapshot so that subsequent snapshots are
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync inserted under the snapshot from which was restored.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>The <computeroutput>restorecurrent</computeroutput> operation is a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync shortcut to restore the current snapshot (i.e. the snapshot from which the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync current state is derived). This subcommand is equivalent to using the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync "restore" subcommand with the name or UUID of the current snapshot, except
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync that it avoids the extra step of determining that name or UUID.</para>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync <para>With the <computeroutput>edit</computeroutput> operation, you can
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync change the name or description of an existing snapshot.</para>
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync <para>With the <computeroutput>showvminfo</computeroutput> operation, you
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync can view the virtual machine settings that were stored with an existing
0839fbd6b31c4c9a2ea76750df48a30dffd4ad77vboxsync 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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync added to media registries automatically. The "closemedium" call has
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync been retained, however, to allow for explicitly removing a medium from
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync a registry.</para>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Optionally, you can request that the image be deleted. You will get
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync appropriate diagnostics that the deletion failed, however the image will
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync become unregistered in any case.</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <para>This command attaches/modifies/removes a storage medium connected to
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync a storage controller that was previously added with the
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <computeroutput>storagectl</computeroutput> command (see the previous
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync section). The syntax is as follows:</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <screen>VBoxManage storageattach <uuid|vmname>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync --storagectl <name>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--port <number>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--device <number>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--type dvddrive|hdd|fdd]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--medium none|emptydrive|
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <uuid>|<filename>|host:<drive>|iscsi]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--mtype normal|writethrough|immutable|shareable]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--comment <text>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--setuuid <uuid>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--setparentuuid <uuid>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--passthrough on|off]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--tempeject on|off]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--nonrotational on|off]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--discard on|off]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--bandwidthgroup name|none]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--forceunmount]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--server <name>|<ip>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--target <target>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--tport <port>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--lun <lun>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--encodedlun <lun>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--username <username>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--password <password>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--initiator <initiator>]
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync [--intnet]</screen>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <para>A number of parameters are commonly required; the ones at the end of
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync the list are required only for iSCSI targets (see below).</para>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossentry>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossdef>
fa2d3f7a92b98db2c47964694f4b7e1aa67a3b10vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--storagectl</computeroutput></glossterm>
cf289c84a0ecd24e5808b46b70d545cdc2c8805cvboxsync <para>Name of the storage controller. Mandatory. The list of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync storage controllers currently attached to a VM can be obtained
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync with <computeroutput>VBoxManage showvminfo</computeroutput>; see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync </glossentry>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <glossentry>
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync <glossterm><computeroutput>--port</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The number of the storage controller's port which is to be
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync modified. Mandatory, unless the storage controller has only a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync single port.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--device</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The number of the port's device which is to be modified.
25e9e0a33eafedabbd0628909c4973b91283a8c7vboxsync Mandatory, unless the storage controller has only a single device
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync per port.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--type</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Define the type of the drive to which the medium is being
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync attached/detached/modified. This argument can only be omitted if
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the type of medium can be determined from either the medium given
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync with the <computeroutput>--medium</computeroutput> argument or
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync from a previous medium attachment.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--medium</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Specifies what is to be attached. The following values are
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync supported:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>"none": Any existing device should be removed from the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync given slot.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>"emptydrive": For a virtual DVD or floppy drive only,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this makes the device slot behaves like a removeable drive
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync into which no media has been inserted.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>"additions": For a virtual DVD drive only, this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync attaches the <emphasis>VirtualBox Guest Additions</emphasis>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync image to the given device slot.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If a UUID is specified, it must be the UUID of a
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync storage medium that is already known to VirtualBox (e.g.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync because it has been attached to another virtual machine).
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync See <xref linkend="vboxmanage-list" /> for how to list known
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync media. This medium is then attached to the given device
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync slot.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>If a filename is specified, it must be the full path
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync of an existing disk image (ISO, RAW, VDI, VMDK or other),
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync which is then attached to the given device slot.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>"host:<drive>": For a virtual DVD or floppy
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync drive only, this connects the given device slot to the
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync specified DVD or floppy drive on the host computer.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>"iscsi": For virtual hard disks only, this allows for
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync specifying an iSCSI target. In this case, more parameters
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync must be given; see below.</para>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync </listitem>
daacce0855b2731a7aefe21b6ee55af6546fcf38vboxsync <para>Some of the above changes, in particular for removeable
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync media (floppies and CDs/DVDs), can be effected while a VM is
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync running. Others (device changes or changes in hard disk device
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync slots) require the VM to be powered off.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossdef>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossterm><computeroutput>--mtype</computeroutput></glossterm>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>Defines how this medium behaves with respect to snapshots
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync and write operations. See <xref linkend="hdimagewrites" /> for
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync details.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossdef>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossterm><computeroutput>--comment</computeroutput></glossterm>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>Any description that you want to have stored with this
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync medium (optional; for example, for an iSCSI target, "Big storage
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync server downstairs"). This is purely descriptive and not needed for
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync the medium to function correctly.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossdef>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
fb59c22133d295bda67901bbe4bc799d4448a368vboxsync <para>Modifies the UUID or parent UUID of a medium before
fb59c22133d295bda67901bbe4bc799d4448a368vboxsync attaching it to a VM. This is an expert option. Inappropriate use
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync can make the medium unusable or lead to broken VM configurations
8f20906c81b61659ea4f978566d0e34223c451e1vboxsync if any other VM is referring to the same media already. The most
8f20906c81b61659ea4f978566d0e34223c451e1vboxsync frequently used variant is <code>--setuuid ""</code>, which assigns
8f20906c81b61659ea4f978566d0e34223c451e1vboxsync a new (random) UUID to an image. This is useful to resolve the
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync duplicate UUID errors if one duplicated an image using file copy
859c9a7cc74066a52cf7e76d54169859e7705c3dvboxsync utilities.</para>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossdef>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync </glossentry>
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync <glossentry>
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync <glossterm><computeroutput>--passthrough</computeroutput></glossterm>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <para>For a virtual DVD drive only, you can enable DVD writing
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync support (currently experimental; see <xref
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync </glossdef>
0ed1a93b0d1a04f19b1d7be9624fa1515b3235e6vboxsync </glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossentry>
c6fefcb9f75c3966a630265ee5d3f5344bec12b4vboxsync <glossterm><computeroutput>--tempeject</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For a virtual DVD drive only, you can configure the behavior
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for guest-triggered medium eject. If this is set to "on", the eject
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync has only temporary effects. If the VM is powered off and restarted
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the originally configured medium will be still in the drive.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This switch allows to enable the non-rotational flag for virtual
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and don't perform disk fragmentation on such media.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync </glossentry>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <glossentry>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
63d009675e883e8eb327cb02a6735d16f5f46d4dvboxsync <para>Sets the bandwidth group to use for the given device; see
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For a virtual DVD or floppy drive only, this forcibly
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the previous one is locked down by the guest for reading. Again,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="storage-cds" /> for details.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>When "iscsi" is used with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>--medium</computeroutput> parameter for iSCSI support --
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="storage-iscsi" /> --, additional parameters must or can
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync be used:<glosslist>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <glossentry>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <glossterm><computeroutput>--server</computeroutput></glossterm>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <para>The host name or IP address of the iSCSI target;
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync required.</para>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync </glossdef>
17014a9ecba37ba2cd8919ec9f040ceb9c2a5445vboxsync </glossentry>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <glossentry>
085a27f357b04458f6cdf3ba497eaa54ac5a128fvboxsync <glossterm><computeroutput>--target</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Target name string. This is determined by the iSCSI target
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync and used to identify the storage resource; required.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--tport</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>TCP/IP port number of the iSCSI service on the target
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync (optional).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--lun</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Logical Unit Number of the target resource (optional).
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Often, this value is zero.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--username, --password</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Username and password (initiator secret) for target
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync authentication, if required (optional).<note>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Username and password are stored without
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync encryption (i.e. in clear text) in the XML machine
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync configuration file if no settings password is provided.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync When a settings password was specified the first time,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the password is stored encrypted.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--intnet</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>If specified, connect to the iSCSI target via Internal
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Networking. This needs further configuration which is described in
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command attaches/modifies/removes a storage controller. After
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync this, virtual media can be attached to the controller with the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>storageattach</computeroutput> command (see the next
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync section).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage storagectl <uuid|vmname>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --name <name>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--controller <LsiLogic|LSILogicSAS|BusLogic|
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync IntelAhci|PIIX3|PIIX4|ICH6|I82078|usb>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--sataportcount <1-30>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--hostiocache on|off]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--bootable on|off]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--remove]</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--name</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Name of the storage controller. Mandatory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--add</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Define the type of the system bus to which the storage
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync controller must be connected.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--controller</computeroutput></glossterm>
9c0076729ec8138e89ce8a6af9a772b68f1f8dc7vboxsync <para>Allows to choose the type of chipset being emulated for the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync given storage controller.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--sataportcount</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This determines how many ports the SATA controller should
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync support.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync <glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync <para>Configures the use of the host I/O cache for all disk images
64863d3a0ffadf1ac248b295b78be5d55db6ee13vboxsync attached to this storage controller. For details, please see <xref
3933885bc0c2c93436d858a14564c6179ec72872vboxsync </glossdef>
3933885bc0c2c93436d858a14564c6179ec72872vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--bootable</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Selects whether this controller is bootable.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--remove</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Removes the storage controller from the VM config.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command creates/deletes/modifies/shows bandwidth groups of the given
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machine:<screen>VBoxManage bandwidthctl <uuid|vmname>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync add <name> --type disk|network --limit <megabytes per second>[k|m|g|K|M|G] |
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync set <name> --limit <megabytes per second>[k|m|g|K|M|G] |
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync remove <name> |
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The following subcommands are available:<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>add</computeroutput>, creates a new bandwidth
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync group of given type.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>set</computeroutput>, modifies the limit for an
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync existing bandwidth group.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>remove</computeroutput>, destroys a bandwidth
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync group.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>list</computeroutput>, shows all bandwidth groups
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync defined for the given VM.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
17014a9ecba37ba2cd8919ec9f040ceb9c2a5445vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--name</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Name of the bandwidth group. Mandatory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--type</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Type of the bandwidth group. Mandatory. Two types are
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync supported: <computeroutput>disk</computeroutput> and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <xref linkend="network_bandwidth_limit" /> for a description of a
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync particular type.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--limit</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Specifies the limit for the given group. Can be changed
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync while the VM is running. The default unit is megabytes per
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync second. The unit can be changed by specifying one of the
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>
a8ce9568e18b8c1a49833bf3b3ac2b2cc634b13cvboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glosslist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The network bandwidth limits apply only to the traffic being sent by
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync virtual machines. The traffic being received by VMs is unlimited.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To remove a bandwidth group it must not be referenced by any disks
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync or adapters in running VM.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command shows information about a virtual hard disk image,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync notably its size, its size on disk, its type and the virtual machines
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync 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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>The disk image must be specified either by its UUID (if the medium
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync is registered) or by its filename. Registered images can be listed by
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>VBoxManage list hdds</computeroutput> (see <xref linkend="vboxmanage-list" />
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync for more information). A filename must be specified as valid path, either
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync as an absolute path or as a relative path starting from the current
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync directory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>This command creates a new virtual hard disk image. The syntax is as
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync follows:</para>
2c38b10f3657b32c27c489ef9aede24003a64fa5vboxsync <screen>VBoxManage createhd --filename <filename>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --size <megabytes>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--format VDI|VMDK|VHD] (default: VDI)
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--filename</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Allows to choose a file name. Mandatory.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>--size</computeroutput></glossterm>
42d23b3e34a524ac2ceb195e960cdedfb591f5cavboxsync <para>Allows to define the image capacity, in 1 MiB units.
42d23b3e34a524ac2ceb195e960cdedfb591f5cavboxsync Mandatory.</para>
42d23b3e34a524ac2ceb195e960cdedfb591f5cavboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <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>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <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
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync change the characteristics of a disk image after it has been
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync created:<screen>VBoxManage modifyhd <uuid|filename>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--type normal|writethrough|immutable|shareable|
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync readonly|multiattach]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--autoreset on|off]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--compact]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--resize <megabytes>|--resizebyte <bytes>]</screen><note>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Despite the "hd" in the subcommand name, the command works with
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync all disk images, not only hard disks. For compatibility with earlier
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync versions of VirtualBox, the "modifyvdi" command is also supported and
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync mapped internally to the "modifyhd" command.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>The disk image to modify must be specified either by its UUID
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync (if the medium is registered) or by its filename. Registered images
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync (see <xref linkend="vboxmanage-list" /> for more information).
4fac78486305f1f002adbf23953382e5d832af94vboxsync A filename must be specified as valid path, either as an absolute path
4fac78486305f1f002adbf23953382e5d832af94vboxsync or as a relative path starting from the current directory.</para>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <para>The following options are available:<itemizedlist>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <para>With the <computeroutput>--type</computeroutput> argument, you
4fac78486305f1f002adbf23953382e5d832af94vboxsync can change the type of an existing image between the normal,
4fac78486305f1f002adbf23953382e5d832af94vboxsync immutable, write-through and other modes; see <xref
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync </listitem>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>For immutable (differencing) hard disks only, the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>--autoreset on|off</computeroutput> option
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync determines whether the disk is automatically reset on every VM
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync startup (again, see <xref linkend="hdimagewrites" />). The default
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync is "on".</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>With the <computeroutput>--compact</computeroutput> option,
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync can be used to compact disk images, i.e. remove blocks that only
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync contains zeroes. This will shrink a dynamically allocated image
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync again; it will reduce the <emphasis>physical</emphasis> size of the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync image without affecting the logical size of the virtual disk.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Compaction works both for base images and for diff images created as
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync part of a snapshot.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>For this operation to be effective, it is required that free
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync space in the guest system first be zeroed out using a suitable
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync software tool. For Windows guests, you can use the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>sdelete</computeroutput> tool provided by Microsoft.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Execute <computeroutput>sdelete -z</computeroutput> in the guest to
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync zero the free disk space before compressing the virtual disk
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync image. For Linux, use the <code>zerofree</code> utility which
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync supports ext2/ext3 filesystems. For Mac OS X guests, use the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <emphasis>Erase Free Space</emphasis> feature of the built-in
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Please note that compacting is currently only available for
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync VDI images. A similar effect can be achieved by zeroing out free
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync blocks and then cloning the disk to any other dynamically allocated
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync format. You can use this workaround until compacting is also
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync supported for disk formats other than VDI.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>The <computeroutput>--resize x</computeroutput> option (where x
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync is the desired new total space in <emphasis role="bold">megabytes</emphasis>)
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync allows you to change the capacity of an existing image; this adjusts the
223935479ac42db56b7b7a7d16548d590022996avboxsync <emphasis>logical</emphasis> size of a virtual disk without affecting
223935479ac42db56b7b7a7d16548d590022996avboxsync the physical size much.<footnote>
223935479ac42db56b7b7a7d16548d590022996avboxsync <para>Image resizing was added with VirtualBox 4.0.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </footnote> This currently works only for VDI and VHD formats, and only
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync for the dynamically allocated variants, and can only be used to expand
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync (not shrink) the capacity.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync For example, if you originally created a 10G disk which is now full,
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync you can use the <computeroutput>--resize 15360</computeroutput>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync command to change the capacity to 15G (15,360MB) without having to create a new
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync image and copy all data from within a virtual machine. Note however that
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync this only changes the drive capacity; you will typically next need to use
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync a partition management tool inside the guest to adjust the main partition
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync to fill the drive.</para><para>The <computeroutput>--resizebyte x</computeroutput>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync option does almost the same thing, except that x is expressed in bytes
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync instead of megabytes.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </listitem>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>This command duplicates a registered virtual hard disk image to a
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync new image file with a new unique identifier (UUID). The new image can be
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync transferred to another host system or imported into VirtualBox again using
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync linkend="cloningvdis" />. The syntax is as follows:</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <screen>VBoxManage clonehd <uuid|inutfile> <uuid|outputfile>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync [--format VDI|VMDK|VHD|RAW|<other>]
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync [--existing]</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>The disk image to clone as well as the target image must be described
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync either by its UUIDs (if the mediums are registered) or by its filename.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Registered images can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync (see <xref linkend="vboxmanage-list" /> for more information).
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync A filename must be specified as valid path, either as an absolute path or
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync as a relative path starting from the current directory.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>The following options are available:<glosslist>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>--format</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Allow to choose a file format for the output file different
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync from the file format of the input file.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>--variant</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Allow to choose a file format variant for the output file.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync It is a comma-separated list of variant flags. Not all
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync combinations are supported, and specifying inconsistent flags will
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync result in an error message.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>--existing</computeroutput></glossterm>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>Perform the clone operation to an already existing
4fac78486305f1f002adbf23953382e5d832af94vboxsync destination medium. Only the portion of the source medium which
4fac78486305f1f002adbf23953382e5d832af94vboxsync fits into the destination medium is copied. This means if the
4fac78486305f1f002adbf23953382e5d832af94vboxsync destination medium is smaller than the source only a part of it is
4fac78486305f1f002adbf23953382e5d832af94vboxsync copied, and if the destination medium is larger than the source
4fac78486305f1f002adbf23953382e5d832af94vboxsync the remaining part of the destination medium is unchanged.</para>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossdef>
4fac78486305f1f002adbf23953382e5d832af94vboxsync </glossentry>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>For compatibility with earlier versions of VirtualBox, the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync "clonevdi" command is also supported and mapped internally to the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync "clonehd" command.</para>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <para>This command converts a raw disk image to a VirtualBox Disk Image
4fac78486305f1f002adbf23953382e5d832af94vboxsync (VDI) file. The syntax is as follows:</para>
4fac78486305f1f002adbf23953382e5d832af94vboxsync <screen>VBoxManage convertfromraw <filename> <outputfile>
4fac78486305f1f002adbf23953382e5d832af94vboxsync [--format VDI|VMDK|VHD]
4fac78486305f1f002adbf23953382e5d832af94vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
4fac78486305f1f002adbf23953382e5d832af94vboxsync [--uuid <uuid>]
4fac78486305f1f002adbf23953382e5d832af94vboxsyncVBoxManage convertfromraw stdin <outputfile> <bytes>
4fac78486305f1f002adbf23953382e5d832af94vboxsync [--format VDI|VMDK|VHD]
4fac78486305f1f002adbf23953382e5d832af94vboxsync [--variant Standard,Fixed,Split2G,Stream,ESX]
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync [--uuid <uuid>]</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <glossterm><computeroutput>--bytes</computeroutput></glossterm>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <para>The size of the image file, in bytes, provided through
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync stdin.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>--format</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Select the disk image format to create. Default is
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync VDI.</para>
78ffe22b6ca5568165d4a9bd1692f21b5c906dabvboxsync </glossdef>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync </glossentry>
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync <glossentry>
be64e0028fd1621fde0e5973d11a104a85b7301dvboxsync <glossterm><computeroutput>--variant</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Allow to choose a file format variant for the output file.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync It is a comma-separated list of variant flags. Not all
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync combinations are supported, and specifying inconsistent flags will
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync result in an error message.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>--uuid</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>Allow to specifiy the UUID of the output file.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glosslist> The second form forces VBoxManage to read the content for
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync the disk image from standard input (useful for using that command in a
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync pipe).</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>For compatibility with earlier versions of VirtualBox, the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync "convertdd" command is also supported and mapped internally to the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync "convertfromraw" command.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <title>VBoxManage getextradata/setextradata</title>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>These commands let you attach and retrieve string data to a virtual
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync machine or to a VirtualBox configuration (by specifying
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput>global</computeroutput> instead of a virtual machine
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync name). You must specify a key (as a text string) to associate the data
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync with, which you can later use to retrieve it. For example:</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsyncVBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>would associate the string "2006.01.01" with the key installdate for
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync could retrieve the information as follows:</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <screen>VBoxManage getextradata Fedora5 installdate</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsyncAll rights reserved.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsyncValue: 2006.01.01</screen>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>To remove a key, the <computeroutput>setextradata</computeroutput>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync command must be run without specifying data (only the key), for example:
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <screen>VBoxManage setextradata Fedora5 installdate</screen>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>This command is used to change global settings which affect the
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync entire VirtualBox installation. Some of these correspond to the settings
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync in the "Global settings" dialog in the graphical user interface. The
c7c82344f2d7b1d7e2117d778e29e8c1c4e1049evboxsync following properties are available:<glosslist>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>machinefolder</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>This specifies the default folder in which virtual machine
241adddf415cbdf66230864a215b24415f482e72vboxsync definitions are kept; see <xref linkend="vboxconfigdata" /> for
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync details.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossdef>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>This specifies whether VirtualBox will make exclusive use of
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync the hardware virtualization extensions (Intel VT-x or AMD-V) of the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync host system's processor; see <xref linkend="hwvirt" />. If you wish to
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync share these extensions with other hypervisors running at the same time,
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync you must disable this setting. Doing so has negative performance implications.
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync </glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossentry>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>This specifies which library to use when "external"
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync authentication has been selected for a particular virtual machine;
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync see <xref linkend="vbox-auth" /> for details.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>This specifies which library the web service uses to
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync authenticate users. For details about the VirtualBox web service,
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync please refer to the separate VirtualBox SDK reference (see <xref
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>This specifies which library implements the VirtualBox
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync Remote Desktop Extension.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>This selects how many rotated (old) VM logs are kept.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossdef>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>This selects the path to the autostart database. See
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>This selects the global default VM frontend setting. See
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossdef>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync </glossentry>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <title>VBoxManage usbfilter add/modify/remove</title>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>The <computeroutput>usbfilter</computeroutput> commands are used for
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync working with USB filters in virtual machines, or global filters which
241adddf415cbdf66230864a215b24415f482e72vboxsync affect the whole VirtualBox setup. Global filters are applied before
241adddf415cbdf66230864a215b24415f482e72vboxsync machine-specific filters, and may be used to prevent devices from being
241adddf415cbdf66230864a215b24415f482e72vboxsync captured by any virtual machine. Global filters are always applied in a
241adddf415cbdf66230864a215b24415f482e72vboxsync particular order, and only the first filter which fits a device is
241adddf415cbdf66230864a215b24415f482e72vboxsync applied. So for example, if the first global filter says to hold (make
241adddf415cbdf66230864a215b24415f482e72vboxsync available) a particular Kingston memory stick device and the second to
241adddf415cbdf66230864a215b24415f482e72vboxsync ignore all Kingston devices, that memory stick will be available to any
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync machine with an appropriate filter, but no other Kingston device
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync will.</para>
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <para>When creating a USB filter using <computeroutput>usbfilter
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync add</computeroutput>, you must supply three or four mandatory parameters.
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync The index specifies the position in the list at which the filter should be
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync placed. If there is already a filter at that position, then it and the
241adddf415cbdf66230864a215b24415f482e72vboxsync following ones will be shifted back one place. Otherwise the new filter
241adddf415cbdf66230864a215b24415f482e72vboxsync will be added onto the end of the list. The
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>target</computeroutput> parameter selects the virtual
241adddf415cbdf66230864a215b24415f482e72vboxsync machine that the filter should be attached to or use "global" to apply it
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync to all virtual machines. <computeroutput>name</computeroutput> is a name
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync for the new filter and for global filters,
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync <computeroutput>action</computeroutput> says whether to allow machines
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync access to devices that fit the filter description ("hold") or not to give
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync them access ("ignore"). In addition, you should specify parameters to
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync filter by. You can find the parameters for devices attached to your system
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync you can specify whether the filter should be active, and for local
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync filters, whether they are for local devices, remote (over an RDP
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync connection) or either.</para>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <para>When you modify a USB filter using <computeroutput>usbfilter
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync modify</computeroutput>, you must specify the filter by index (see the
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync find global filter indexes and that of <computeroutput>VBoxManage
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync showvminfo</computeroutput> to find indexes for individual machines) and
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync by target, which is either a virtual machine or "global". The properties
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync which can be changed are the same as for <computeroutput>usbfilter
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync remove</computeroutput> and specify the index and the target.</para>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <para>This command allows you to share folders on the host computer with
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync guest operating systems. For this, the guest systems must have a version
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync of the VirtualBox Guest Additions installed which supports this
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync functionality.</para>
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <para>Shared folders are described in detail in <xref
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync <para>The "guestproperty" commands allow you to get or set properties of a
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync running virtual machine. Please see <xref linkend="guestadd-guestprops" />
7d4cc79a42576698766fa0ef3dc778a638bb8c5dvboxsync for an introduction. As explained there, guest properties are arbitrary
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync key/value string pairs which can be written to and read from by either the
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync guest or the host, so they can be used as a low-volume communication
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync channel for strings, provided that a guest is running and has the Guest
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Additions installed. In addition, a number of values whose keys begin with
600aa226ad717126f47ed8a0e0d5ed30deb83d89vboxsync "/VirtualBox/" are automatically set and maintained by the Guest
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync Additions.</para>
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <para>The following subcommands are available (where
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync <computeroutput><vm></computeroutput>, in each case, can either be a
1522fd0a1b3f8a389582eaf96f3980cfe141547cvboxsync VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><computeroutput>enumerate <vm> [--patterns
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <pattern>]</computeroutput>: This lists all the guest
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync properties that are available for the given VM, including the value.
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync This list will be very limited if the guest's service process cannot
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync be contacted, e.g. because the VM is not running or the Guest
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync Additions are not installed.</para>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>If <computeroutput>--patterns <pattern></computeroutput>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync is specified, it acts as a filter to only list properties that match
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync the given pattern. The pattern can contain the following wildcard
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync characters:<itemizedlist>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para><computeroutput>*</computeroutput> (asterisk):
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync represents any number of characters; for example,
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync "<computeroutput>/VirtualBox*</computeroutput>" would match
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync all properties beginning with "/VirtualBox".</para>
7b45e137929ef8ecfd0d3446c64a588509931e56vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>?</computeroutput> (question mark):
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync represents a single arbitrary character; for example,
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync "<computeroutput>fo?</computeroutput>" would match both "foo"
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync and "for".</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>|</computeroutput> (pipe symbol): can be
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync used to specify multiple alternative patterns; for example,
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync "<computeroutput>s*|t*</computeroutput>" would match anything
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync starting with either "s" or "t".</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>get <vm> <property>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync </computeroutput>: This
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync retrieves the value of a single property only. If the property
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync cannot be found (e.g. because the guest is not running), this will
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync </listitem>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para><computeroutput>set <vm> <property> [<value>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync [--flags <flags>]]</computeroutput>: This allows you to set a
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync guest property by specifying the key and value. If
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <computeroutput><value></computeroutput> is omitted, the
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync property is deleted. With <computeroutput>--flags</computeroutput>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync you can optionally specify additional behavior (you can combine
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync several by separating them with commas):<itemizedlist>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>TRANSIENT</computeroutput>: the value
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync will not be stored with the VM data when the VM exits;</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>TRANSRESET</computeroutput>: the value
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync will be deleted as soon as the VM restarts and/or exits;</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>RDONLYGUEST</computeroutput>: the value
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync can only be changed by the host, but the guest can only read
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>RDONLYHOST</computeroutput>: reversely,
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync the value can only be changed by the guest, but the host can
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync only read it;</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>READONLY</computeroutput>: a combination
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync of the two, the value cannot be changed at all.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>wait <vm> <pattern> --timeout
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <timeout></computeroutput>: This waits for a particular value
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync described by "pattern" to change or to be deleted or created. The
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync pattern rules are the same as for the "enumerate" subcommand
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync above.</para>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </listitem>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para><computeroutput>delete <vm> <property>
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync </computeroutput>: Deletes a formerly set guest property.
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync <para>The <computeroutput>guestcontrol</computeroutput> commands allow you
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync to control certain things inside a guest from the host. Please see <xref
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync linkend="guestadd-guestcontrol" /> for an introduction.</para>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <screen>VBoxManage guestcontrol <uuid|vmname> <command></screen>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para>The following subcommands are available (where
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <computeroutput><uuid|vmname></computeroutput>, in each case, can either be a
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
0baf641e1aa6493d1796a051e3f49c5f9e076dfcvboxsync <para><emphasis role="bold"><computeroutput>execute</computeroutput></emphasis>,
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync which allows for
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync executing a program/script (process) which already is installed and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync runnable on the guest. This command only works while a VM is up and
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync running and has the following syntax:</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <screen>VBoxManage guestcontrol <uuid|vmname> exec[ute]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync --image <path to program> --username <name>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--passwordfile <file> | --password <password>]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--verbose] [--timeout <msec>]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--wait-exit] [--wait-stdout] [--wait-stderr]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync [--dos2unix] [--unix2dos]
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync -- [[<argument1>] ... [<argumentN>]]</screen>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--image "<path to program>"</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Absolute path and process name of process to execute
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync in the guest, e.g.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Name of the user the process should run under. This
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync user must exist on the guest OS.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Password of the user account specified to be read from
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync the given file. If not given, an empty password is
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync assumed.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Password of the user account specified with
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>--username</computeroutput>. If not given,
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync an empty password is assumed.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Converts output from DOS/Windows guests to UNIX-compatible
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync line endings (CR + LF -> LF). Not implemented yet.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync "<NAME>=<VALUE>"</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>One or more environment variables to be set or
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync unset.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>By default, the new process in the guest will be
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync created with the standard environment of the guest OS. This
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync option allows for modifying that environment. To set/modify
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync a variable, a pair of
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>NAME=VALUE</computeroutput> must be
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync specified; to unset a certain variable, the name with no
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync value must set, e.g.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Arguments containing spaces must be enclosed in
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync quotation marks. More than one
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <computeroutput>--environment</computeroutput> at a time can
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync be specified to keep the command line tidy.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Value (in milliseconds) that specifies the time how
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync long the started process is allowed to run and how long
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync VBoxManage waits for getting output from that process. If no
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync timeout is specified, VBoxManage will wait forever until the
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync started process ends or an error occured.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync Converts output from a UNIX/Linux guests to DOS-/Windows-compatible
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync line endings (LF -> CR + LF). Not implemented yet.
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--verbose</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--wait-exit</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Waits until the process ends and outputs its
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--wait-stdout</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Waits until the process ends and outputs its
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync exit code along with the exit reason/flags. While waiting
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync VBoxManage retrieves the process output collected from stdout.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>--wait-stderr</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Waits until the process ends and outputs its
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync exit code along with the exit reason/flags. While waiting
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync VBoxManage retrieves the process output collected from stderr.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossentry>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>One or more arguments to pass to the process being
d36016c7e22c0a816c7eae1b6d53f46b7d180589vboxsync executed.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync <para>Arguments containing spaces must be enclosed in
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync quotation marks.</para>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossdef>
30a7a1ba4558de8e809ab4bdbd82a713d67e59abvboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>On Windows there are certain limitations for graphical
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync applications; please see <xref linkend="KnownIssues" /> for more
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync information.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --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"
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync the double backslashes in the second example are only required on
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Unix hosts.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>For certain commands a user name of an existing user account on the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync must be specified; anonymous executions are not supported for security reasons. A
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync user account password, however, is optional and depends on the guest's OS security
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync policy or rules. If no password is specified for a given user name, an empty password
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync will be used. On certain OSes like Windows the security policy may needs to be adjusted
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in order to allow user accounts with an empty password set. Also, global domain rules might
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync apply and therefore cannot be changed.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to serve up to 5 guest processes at a time. If a new guest process gets started
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which would exceed this limit, the oldest not running guest process will be discarded
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync in order to be able to run that new process. Also, retrieving output from this
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync old guest process will not be possible anymore then. If all 5 guest processes
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync are still active and running, starting a new guest process will result in an
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync appropriate error message.</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>To raise or lower the guest process execution limit, either the guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </listitem>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>,
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync which allows copying
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync files from the host to the guest (only with installed Guest
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync Additions 4.0 and later).</para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <screen>VBoxManage guestcontrol <uuid|vmname> copyto|cp
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <guest source> <host dest> --username <name>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--passwordfile <file> | --password <password>]
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync [--dryrun] [--follow] [--recursive] [--verbose]</screen>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>source on host</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <para>Absolute path of source file(s) on host to copy over
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync to the guest, e.g.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync This also can be a wildcard expression, e.g.
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <computeroutput>C:\Windows\System32\*.dll</computeroutput></para>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossterm><computeroutput>destination on guest</computeroutput></glossterm>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync <glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossterm><computeroutput>--username <name></computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Name of the user the copy process should run under.
241adddf415cbdf66230864a215b24415f482e72vboxsync This user must exist on the guest OS.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossdef>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossentry>
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync <para>Password of the user account specified to be read from
322b4bfe961aceaf0608ceb771318bd3a10525a4vboxsync the given file. If not given, an empty password is
241adddf415cbdf66230864a215b24415f482e72vboxsync assumed.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossdef>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossterm><computeroutput>--password <password></computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Password of the user account specified with
241adddf415cbdf66230864a215b24415f482e72vboxsync <computeroutput>--username</computeroutput>. If not given,
241adddf415cbdf66230864a215b24415f482e72vboxsync an empty password is assumed.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossdef>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossentry>
241adddf415cbdf66230864a215b24415f482e72vboxsync <glossterm><computeroutput>--dryrun</computeroutput></glossterm>
241adddf415cbdf66230864a215b24415f482e72vboxsync <para>Tells VBoxManage to only perform a dry run instead of
241adddf415cbdf66230864a215b24415f482e72vboxsync really copying files to the guest.</para>
241adddf415cbdf66230864a215b24415f482e72vboxsync </glossdef>
febf3f1de573e25fb134b8453a22b0732b4c52e2vboxsync </glossentry>
Parent directories need to exist (e.g. in this example
the specified directory, e.g. if the directory
Only octal modes (e.g.
Only octal modes (e.g.