diff options
Diffstat (limited to 'doc/manual/en_US/user_VBoxManage.xml')
| -rw-r--r-- | doc/manual/en_US/user_VBoxManage.xml | 1047 |
1 files changed, 871 insertions, 176 deletions
diff --git a/doc/manual/en_US/user_VBoxManage.xml b/doc/manual/en_US/user_VBoxManage.xml index bac32c6f..95d6c258 100644 --- a/doc/manual/en_US/user_VBoxManage.xml +++ b/doc/manual/en_US/user_VBoxManage.xml @@ -83,8 +83,7 @@ All rights reserved. Virtual machine 'SUSE 10.2' is created. UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5 -Settings file: '/home/username/.VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml' -</screen> +Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen> <para>As can be seen from the above output, a new virtual machine has been created with a new UUID and a new XML settings file.</para> @@ -310,7 +309,7 @@ All rights reserved. Name: Windows XP Guest OS: Other/Unknown UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7 -Config file: /home/username/.VirtualBox/Machines/Windows XP/Windows XP.xml +Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml Memory size: 512MB VRAM size: 12MB Number of CPUs: 2 @@ -325,7 +324,6 @@ IOAPIC: on PAE: on Time offset: 0 ms Hardw. virt.ext: on -Hardw. virt.ext exclusive: on Nested Paging: on VT-x VPID: off State: powered off (since 2009-10-20T14:52:19.000000000) @@ -364,8 +362,7 @@ USB Device Filters: Shared folders: <none> -Statistics update: disabled -</screen></para> +Statistics update: disabled</screen></para> </sect1> <sect1 id="vboxmanage-registervm"> @@ -413,8 +410,8 @@ Statistics update: disabled </orderedlist></para> </sect1> - <sect1> - <title id="vboxmanage-createvm">VBoxManage createvm</title> + <sect1 id="vboxmanage-createvm"> + <title>VBoxManage createvm</title> <para>This command creates a new XML virtual machine definition file.</para> @@ -423,7 +420,7 @@ Statistics update: disabled is required and must specify the name of the machine. Since this name is used by default as the file name of the settings file (with the extension <computeroutput>.xml</computeroutput>) and the machine folder (a subfolder - of the <computeroutput>.VirtualBox/Machines</computeroutput> folder), it + 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 must conform to your host operating system's requirements for file name specifications. If the VM is later renamed, the file and folder names will change automatically.</para> @@ -550,19 +547,25 @@ Statistics update: disabled </listitem> <listitem> - <para><computeroutput>--synthcpu on|off</computeroutput>: This - setting determines whether VirtualBox will expose a synthetic CPU - to the guest to allow live migration between host systems that - differ significantly.</para> + <para><computeroutput>--pae on|off</computeroutput>: This + enables/disables PAE (see <xref + linkend="settings-processor" />).</para> </listitem> <listitem> - <para><computeroutput>--pae on|off</computeroutput>: This - enables/disables PAE (see <xref + <para><computeroutput>--longmode on|off</computeroutput>: This + enables/disables long mode (see <xref linkend="settings-processor" />).</para> </listitem> <listitem> + <para><computeroutput>--synthcpu on|off</computeroutput>: This + setting determines whether VirtualBox will expose a synthetic CPU + to the guest to allow live migration between host systems that + differ significantly.</para> + </listitem> + + <listitem> <para><computeroutput>--hpet on|off</computeroutput>: This enables/disables a High Precision Event Timer (HPET) which can replace the legacy system timers. This is turned off by default. @@ -577,13 +580,11 @@ Statistics update: disabled </listitem> <listitem> - <para><computeroutput>--hwvirtexexcl on|off</computeroutput>: This - specifies whether VirtualBox will make exclusive use of the - hardware virtualization extensions (Intel VT-x or AMD-V) in the - processor of your host system; see <xref linkend="hwvirt" />. If - you wish to simultaneously share these extensions with other - hypervisors, then you must disable this setting. Doing so has - negative performance implications.</para> + <para><computeroutput>--triplefaultreset on|off</computeroutput>: + This setting allows to reset the guest instead of triggering a + Guru Meditation. Some guests raise a triple fault to reset the + CPU so sometimes this is desired behavior. Works only for non-SMP + guests.</para> </listitem> <listitem> @@ -612,6 +613,13 @@ Statistics update: disabled </listitem> <listitem> + <para><computeroutput>--vtxux on|off</computeroutput>: If + hardware virtualization is enabled, for Intel VT-x only, this + setting enables or disables the use of the unrestricted guest mode + feature for executing your guest.</para> + </listitem> + + <listitem> <para><computeroutput>--accelerate3d on|off</computeroutput>: This enables, if the Guest Additions are installed, whether hardware 3D acceleration should be available; see <xref @@ -635,7 +643,9 @@ Statistics update: disabled <para>With <computeroutput>--bioslogoimagepath <imagepath></computeroutput> you can, if you are so inclined, replace the image that is shown, with your own logo. The - image must be an uncompressed 256 color BMP file.</para> + image must be an uncompressed 256 color BMP file without color + space information (Windows 3.0 format). The image must not be + bigger than 640 x 480.</para> </listitem> <listitem> @@ -691,6 +701,32 @@ Statistics update: disabled be specified in megabytes. The default size is 0 megabytes. For details, see <xref linkend="guestadd-balloon" />.</para> </listitem> + + <listitem> + <para><computeroutput>--lptmode<1-N> + <Device></computeroutput> + Specifies the Device Name of the parallel port that + the Parallel Port feature will be using. Use this + <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>. + This feature is host operating system specific.</para> + </listitem> + + <listitem> + <para><computeroutput>--lpt<1-N> + <I/O base> <IRQ></computeroutput> + Specifies the I/O address of the parallel port and the IRQ + number that the Parallel Port feature will be using. Use this + <emphasis>after</emphasis> + <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are + the values that guest sees i.e. the values avalable under guest Device Manager.</para> + </listitem> + + <listitem> + <para><computeroutput>--defaultfrontend + default|<name></computeroutput>: This allows you to specify + the default frontend which will be used when starting this VM; see + <xref linkend="vboxmanage-startvm" /> for details.</para> + </listitem> </itemizedlist></para> </sect2> @@ -879,7 +915,7 @@ Statistics update: disabled </listitem> <listitem> - <para><computeroutput>--natnatsettings<1-N> + <para><computeroutput>--natsettings<1-N> [<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>], [<tcprcv>]</computeroutput>: This option controls several NAT settings (please see <xref linkend="nat-adv-settings" /> for @@ -901,8 +937,7 @@ Statistics update: disabled </sect2> <sect2 id="vboxmanage-modifyvm-other"> - <title>Serial port, audio, clipboard, remote desktop and USB - settings</title> + <title>Serial port, audio, clipboard and USB settings</title> <para>The following other hardware settings are available through <computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist> @@ -998,7 +1033,7 @@ Statistics update: disabled </itemizedlist></para> </sect2> - <sect2> + <sect2 id="vboxmanage-modifyvm-vrde"> <title>Remote machine settings</title> <para>The following settings that affect remote machine behavior are @@ -1033,6 +1068,22 @@ Statistics update: disabled interface the VRDE server will bind to. If specified, the server will accept connections only on the specified host network interface.</para> + <para>The setting can be used to specify whether the VRDP server + should accept either IPv4 or IPv6 or both connections: + <itemizedlist> + <listitem> + <para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0" + </computeroutput></para> + </listitem> + <listitem> + <para>only IPv6: <computeroutput>--vrdeaddress "::" + </computeroutput></para> + </listitem> + <listitem> + <para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress "" + </computeroutput></para> + </listitem> + </itemizedlist></para> </listitem> <listitem> @@ -1179,7 +1230,7 @@ Statistics update: disabled when the network type is NAT (<computeroutput>keepnatmacs</computeroutput>). If you add <computeroutput>keepdisknames</computeroutput> all new disk images - are called like the original once, otherwise they are + are called like the original ones, otherwise they are renamed.</para> </listitem> <listitem> @@ -1201,7 +1252,7 @@ Statistics update: disabled <listitem> <para><computeroutput>--register</computeroutput>: Automatically register the new clone in this VirtualBox - installation. If you manually want register the new VM later, see + installation. If you manually want to register the new VM later, see <xref linkend="vboxmanage-registervm" /> for instructions how to do so.</para> </listitem> @@ -1315,6 +1366,14 @@ Virtual system 0: <para>For virtualization products which aren't fully compatible with the OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the <computeroutput>--legacy09</computeroutput> option.</para> + + <para>To specify options controlling the exact content of the appliance + file, you can use <computeroutput>--option</computeroutput> to request the + creation of a manifest file (encouraged, allows detection of corrupted + appliances on import), the additional export of DVD images, and the + exclusion of MAC addresses. You can specify a list of options, e.g. + <computeroutput>--option manifest,nomacs</computeroutput>. For details, + check the help output of <computeroutput>VBoxManage export</computeroutput>.</para> </sect1> <sect1 id="vboxmanage-startvm"> @@ -1323,30 +1382,22 @@ Virtual system 0: <para>This command starts a virtual machine that is currently in the "Powered off" or "Saved" states.</para> - <note> - <para>This is provided for backwards compatibility only. We recommend to - start virtual machines directly by running the respective front-end, as - you might otherwise miss important error and state information that - VirtualBox may display on the console. This is especially important for - front-ends other than <computeroutput>VirtualBox</computeroutput>, our - graphical user interface, because those cannot display error messages in - a popup window. See <xref linkend="vboxheadless" /> for more - information.</para> - </note> - <para>The optional <computeroutput>--type</computeroutput> specifier - determines whether the machine will be started in a window (GUI mode, - which is the default) or whether the output should go through - <computeroutput>VBoxHeadless</computeroutput>, with VRDE enabled or not; - see <xref linkend="vboxheadless" /> for more information. The list of - types is subject to change, and it's not guaranteed that all types are - accepted by any product variant.</para> + determines whether the machine will be started in a window or whether the + output should go through <computeroutput>VBoxHeadless</computeroutput>, + with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more + information. The list of types is subject to change, and it's not + guaranteed that all types are accepted by any product variant.</para> + + <para>The global or per-VM default value for the VM frontend type will be + taken if the type is not explicitly specified. If none of these are set, + the GUI variant will be started.</para> <para>The following values are allowed:</para> <glosslist> <glossentry> - <glossterm>gui</glossterm> + <glossterm><computeroutput>gui</computeroutput></glossterm> <glossdef> <para>Starts a VM showing a GUI window. This is the default.</para> @@ -1354,13 +1405,28 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>headless</glossterm> + <glossterm><computeroutput>headless</computeroutput></glossterm> <glossdef> <para>Starts a VM without a window for remote display only.</para> </glossdef> </glossentry> + + <glossentry> + <glossterm><computeroutput>sdl</computeroutput></glossterm> + + <glossdef> + <para>Starts a VM with a minimal GUI and limited features.</para> + </glossdef> + </glossentry> </glosslist> + + <note> + <para>If you experience problems with starting virtual machines with + particular frontends and there is no conclusive error information, + consider starting virtual machines directly by running the respective + front-end, as this can give additional error information.</para> + </note> </sect1> <sect1 id="vboxmanage-controlvm"> @@ -1425,7 +1491,7 @@ Virtual system 0: </listitem> <listitem> - <para><computeroutput>VBoxManage controlvm <vm> teleport + <para><computeroutput>VBoxManage controlvm "VM name" teleport --hostname <name> --port <port> [--passwordfile <file> | --password <password>]</computeroutput> makes the machine the source of a teleporting operation and initiates a @@ -1540,7 +1606,7 @@ Virtual system 0: <title>VBoxManage adoptstate</title> <para>If you have a saved state file (<computeroutput>.sav</computeroutput>) - that is seperate from the VM configuration, you can use this command to + that is separate from the VM configuration, you can use this command to "adopt" the file. This will change the VM to saved state and when you start it, VirtualBox will attempt to restore it from the saved state file you indicated. This command should only be used in special setups.</para> @@ -1563,7 +1629,11 @@ Virtual system 0: of the current state of the virtual machine. You must supply a name for the snapshot and can optionally supply a description. The new snapshot is inserted into the snapshots tree as a child of the current snapshot and - then becomes the new current snapshot.</para> + then becomes the new current snapshot. The + <computeroutput>--description</computeroutput> parameter allows to + describe the snapshot. If <computeroutput>--live</computeroutput> + is specified, the VM will not be stopped during the snapshot creation + (live smapshotting).</para> <para>The <computeroutput>delete</computeroutput> operation deletes a snapshot (specified by name or by UUID). This can take a while to finish @@ -1610,8 +1680,8 @@ Virtual system 0: become unregistered in any case.</para> </sect1> - <sect1> - <title id="vboxmanage-storageattach">VBoxManage storageattach</title> + <sect1 id="vboxmanage-storageattach"> + <title>VBoxManage storageattach</title> <para>This command attaches/modifies/removes a storage medium connected to a storage controller that was previously added with the @@ -1643,15 +1713,14 @@ Virtual system 0: [--username <username>] [--password <password>] [--initiator <initiator>] - [--intnet] -</screen> + [--intnet]</screen> <para>A number of parameters are commonly required; the ones at the end of the list are required only for iSCSI targets (see below).</para> <para>The common parameters are:<glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM Name. Mandatory.</para> @@ -1659,7 +1728,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>storagectl</glossterm> + <glossterm><computeroutput>--storagectl</computeroutput></glossterm> <glossdef> <para>Name of the storage controller. Mandatory. The list of the @@ -1670,7 +1739,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>port</glossterm> + <glossterm><computeroutput>--port</computeroutput></glossterm> <glossdef> <para>The number of the storage controller's port which is to be @@ -1680,7 +1749,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>device</glossterm> + <glossterm><computeroutput>--device</computeroutput></glossterm> <glossdef> <para>The number of the port's device which is to be modified. @@ -1690,7 +1759,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>type</glossterm> + <glossterm><computeroutput>--type</computeroutput></glossterm> <glossdef> <para>Define the type of the drive to which the medium is being @@ -1702,7 +1771,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>medium</glossterm> + <glossterm><computeroutput>--medium</computeroutput></glossterm> <glossdef> <para>Specifies what is to be attached. The following values are @@ -1719,6 +1788,12 @@ Virtual system 0: </listitem> <listitem> + <para>"additions": For a virtual DVD drive only, this + attaches the <emphasis>VirtualBox Guest Additions</emphasis> + image to the given device slot.</para> + </listitem> + + <listitem> <para>If a UUID is specified, it must be the UUID of a storage medium that is already known to VirtualBox (e.g. because it has been attached to another virtual machine). @@ -1754,7 +1829,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>mtype</glossterm> + <glossterm><computeroutput>--mtype</computeroutput></glossterm> <glossdef> <para>Defines how this medium behaves with respect to snapshots @@ -1764,7 +1839,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>comment</glossterm> + <glossterm><computeroutput>--comment</computeroutput></glossterm> <glossdef> <para>Any description that you want to have stored with this @@ -1775,7 +1850,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>setuuid, setparentuuid</glossterm> + <glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm> <glossdef> <para>Modifies the UUID or parent UUID of a medium before @@ -1790,7 +1865,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>passthrough</glossterm> + <glossterm><computeroutput>--passthrough</computeroutput></glossterm> <glossdef> <para>For a virtual DVD drive only, you can enable DVD writing @@ -1800,7 +1875,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>tempeject</glossterm> + <glossterm><computeroutput>--tempeject</computeroutput></glossterm> <glossdef> <para>For a virtual DVD drive only, you can configure the behavior @@ -1811,7 +1886,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>nonrotational</glossterm> + <glossterm><computeroutput>--nonrotational</computeroutput></glossterm> <glossdef> <para>This switch allows to enable the non-rotational flag for virtual @@ -1822,7 +1897,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>bandwidthgroup</glossterm> + <glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm> <glossdef> <para>Sets the bandwidth group to use for the given device; see @@ -1831,7 +1906,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>forceunmount</glossterm> + <glossterm><computeroutput>--forceunmount</computeroutput></glossterm> <glossdef> <para>For a virtual DVD or floppy drive only, this forcibly @@ -1847,7 +1922,7 @@ Virtual system 0: see <xref linkend="storage-iscsi" /> --, additional parameters must or can be used:<glosslist> <glossentry> - <glossterm>server</glossterm> + <glossterm><computeroutput>--server</computeroutput></glossterm> <glossdef> <para>The host name or IP address of the iSCSI target; @@ -1856,7 +1931,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>target</glossterm> + <glossterm><computeroutput>--target</computeroutput></glossterm> <glossdef> <para>Target name string. This is determined by the iSCSI target @@ -1865,7 +1940,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>tport</glossterm> + <glossterm><computeroutput>--tport</computeroutput></glossterm> <glossdef> <para>TCP/IP port number of the iSCSI service on the target @@ -1874,7 +1949,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>lun</glossterm> + <glossterm><computeroutput>--lun</computeroutput></glossterm> <glossdef> <para>Logical Unit Number of the target resource (optional). @@ -1883,7 +1958,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>username, password</glossterm> + <glossterm><computeroutput>--username, --password</computeroutput></glossterm> <glossdef> <para>Username and password (initiator secret) for target @@ -1898,7 +1973,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>intnet</glossterm> + <glossterm><computeroutput>--intnet</computeroutput></glossterm> <glossdef> <para>If specified, connect to the iSCSI target via Internal @@ -1924,14 +1999,14 @@ Virtual system 0: [--add <ide/sata/scsi/floppy>] [--controller <LsiLogic|LSILogicSAS|BusLogic| IntelAhci|PIIX3|PIIX4|ICH6|I82078>] - [--sataportcount <1-30>] + [--portcount <1-30>] [--hostiocache on|off] [--bootable on|off] [--remove]</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM Name. Mandatory.</para> @@ -1939,7 +2014,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>name</glossterm> + <glossterm><computeroutput>--name</computeroutput></glossterm> <glossdef> <para>Name of the storage controller. Mandatory.</para> @@ -1947,7 +2022,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>add</glossterm> + <glossterm><computeroutput>--add</computeroutput></glossterm> <glossdef> <para>Define the type of the system bus to which the storage @@ -1956,7 +2031,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>controller</glossterm> + <glossterm><computeroutput>--controller</computeroutput></glossterm> <glossdef> <para>Allows to choose the type of chipset being emulated for the @@ -1965,7 +2040,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>sataportcount</glossterm> + <glossterm><computeroutput>--portcount</computeroutput></glossterm> <glossdef> <para>This determines how many ports the SATA controller should @@ -1974,7 +2049,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>hostiocache</glossterm> + <glossterm><computeroutput>--hostiocache</computeroutput></glossterm> <glossdef> <para>Configures the use of the host I/O cache for all disk images @@ -1984,7 +2059,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>bootable</glossterm> + <glossterm><computeroutput>--bootable</computeroutput></glossterm> <glossdef> <para>Selects whether this controller is bootable.</para> @@ -1992,7 +2067,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>remove</glossterm> + <glossterm><computeroutput>--remove</computeroutput></glossterm> <glossdef> <para>Removes the storage controller from the VM config.</para> @@ -2032,7 +2107,7 @@ Virtual system 0: </para> <para>The parameters mean:<glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM Name. Mandatory.</para> @@ -2040,7 +2115,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>name</glossterm> + <glossterm><computeroutput>--name</computeroutput></glossterm> <glossdef> <para>Name of the bandwidth group. Mandatory.</para> @@ -2048,7 +2123,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>type</glossterm> + <glossterm><computeroutput>--type</computeroutput></glossterm> <glossdef> <para>Type of the bandwidth group. Mandatory. Two types are @@ -2061,7 +2136,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>limit</glossterm> + <glossterm><computeroutput>--limit</computeroutput></glossterm> <glossdef> <para>Specifies the limit for the given group. Can be changed @@ -2113,7 +2188,7 @@ Virtual system 0: <para>where the parameters mean:<glosslist> <glossentry> - <glossterm>filename</glossterm> + <glossterm><computeroutput>--filename</computeroutput></glossterm> <glossdef> <para>Allows to choose a file name. Mandatory.</para> @@ -2121,7 +2196,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>size</glossterm> + <glossterm><computeroutput>--size</computeroutput></glossterm> <glossdef> <para>Allows to define the image capacity, in 1 MiB units. @@ -2130,7 +2205,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>format</glossterm> + <glossterm><computeroutput>--format</computeroutput></glossterm> <glossdef> <para>Allows to choose a file format for the output file different @@ -2139,7 +2214,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>variant</glossterm> + <glossterm><computeroutput>--variant</computeroutput></glossterm> <glossdef> <para>Allows to choose a file format variant for the output file. @@ -2160,7 +2235,7 @@ Virtual system 0: <para>With the <computeroutput>modifyhd</computeroutput> command, you can change the characteristics of a disk image after it has been - created:<screen>VBoxManage modifyhd <uuid>|<filename> + created:<screen>VBoxManage modifyhd <uuid|filename> [--type normal|writethrough|immutable|shareable| readonly|multiattach] [--autoreset on|off] @@ -2210,7 +2285,10 @@ Virtual system 0: Execute <computeroutput>sdelete -z</computeroutput> in the guest to zero the free disk space before compressing the virtual disk image. For Linux, use the <code>zerofree</code> utility which - supports ext2/ext3 filesystems.</para> + supports ext2/ext3 filesystems. For Mac OS X guests, use the + <emphasis>Erase Free Space</emphasis> feature of the built-in + <emphasis>Disk Utility</emphasis>. Use + <emphasis>Zero Out Data</emphasis> there.</para> <para>Please note that compacting is currently only available for VDI images. A similar effect can be achieved by zeroing out free @@ -2251,7 +2329,7 @@ Virtual system 0: the Virtual Media Manager; see <xref linkend="vdis" /> and <xref linkend="cloningvdis" />. The syntax is as follows:</para> - <screen>VBoxManage clonehd <uuid>|<filename> <outputfile> + <screen>VBoxManage clonehd <uuid|inutfile> <uuid|outputfile> [--format VDI|VMDK|VHD|RAW|<other>] [--variant Standard,Fixed,Split2G,Stream,ESX] [--existing]</screen> @@ -2264,7 +2342,7 @@ Virtual system 0: as a relative path starting from the current directory.</para> <para>The following options are available:<glosslist> <glossentry> - <glossterm>format</glossterm> + <glossterm><computeroutput>--format</computeroutput></glossterm> <glossdef> <para>Allow to choose a file format for the output file different @@ -2273,7 +2351,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>variant</glossterm> + <glossterm><computeroutput>--variant</computeroutput></glossterm> <glossdef> <para>Allow to choose a file format variant for the output file. @@ -2284,7 +2362,7 @@ Virtual system 0: </glossentry> <glossentry> - <glossterm>existing</glossterm> + <glossterm><computeroutput>--existing</computeroutput></glossterm> <glossdef> <para>Perform the clone operation to an already existing @@ -2319,7 +2397,7 @@ VBoxManage convertfromraw stdin <outputfile> <bytes> <para>where the parameters mean:<glosslist> <glossentry> - <glossterm>bytes</glossterm> + <glossterm><computeroutput>--bytes</computeroutput></glossterm> <glossdef> <para>The size of the image file, in bytes, provided through @@ -2328,7 +2406,7 @@ VBoxManage convertfromraw stdin <outputfile> <bytes> </glossentry> <glossentry> - <glossterm>format</glossterm> + <glossterm><computeroutput>--format</computeroutput></glossterm> <glossdef> <para>Select the disk image format to create. Default is @@ -2337,7 +2415,7 @@ VBoxManage convertfromraw stdin <outputfile> <bytes> </glossentry> <glossentry> - <glossterm>variant</glossterm> + <glossterm><computeroutput>--variant</computeroutput></glossterm> <glossdef> <para>Allow to choose a file format variant for the output file. @@ -2348,7 +2426,7 @@ VBoxManage convertfromraw stdin <outputfile> <bytes> </glossentry> <glossentry> - <glossterm>uuid</glossterm> + <glossterm><computeroutput>--uuid</computeroutput></glossterm> <glossdef> <para>Allow to specifiy the UUID of the output file.</para> @@ -2406,7 +2484,7 @@ Value: 2006.01.01</screen> in the "Global settings" dialog in the graphical user interface. The following properties are available:<glosslist> <glossentry> - <glossterm>machinefolder</glossterm> + <glossterm><computeroutput>machinefolder</computeroutput></glossterm> <glossdef> <para>This specifies the default folder in which virtual machine @@ -2416,7 +2494,18 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>vrdeauthlibrary</glossterm> + <glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm> + <para>This specifies whether VirtualBox will make exclusive use of + the hardware virtualization extensions (Intel VT-x or AMD-V) of the + host system's processor; see <xref linkend="hwvirt" />. If you wish to + share these extensions with other hypervisors running at the same time, + you must disable this setting. Doing so has negative performance implications. + </para> + </glossentry> + + + <glossentry> + <glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm> <glossdef> <para>This specifies which library to use when "external" @@ -2426,7 +2515,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>websrvauthlibrary</glossterm> + <glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm> <glossdef> <para>This specifies which library the web service uses to @@ -2437,7 +2526,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>vrdelibrary</glossterm> + <glossterm><computeroutput>vrdeextpack</computeroutput></glossterm> <glossdef> <para>This specifies which library implements the VirtualBox @@ -2446,11 +2535,28 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>hwvirtexenabled</glossterm> + <glossterm><computeroutput>loghistorycount</computeroutput></glossterm> + + <glossdef> + <para>This selects how many rotated (old) VM logs are kept.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>autostartdbpath</computeroutput></glossterm> + + <glossdef> + <para>This selects the path to the autostart database. See + <xref linkend="autostart" />.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>defaultfrontend</computeroutput></glossterm> <glossdef> - <para>This selects whether or not hardware virtualization support - is enabled by default.</para> + <para>This selects the global default VM frontend setting. See + <xref linkend="vboxmanage-startvm" />.</para> </glossdef> </glossentry> </glosslist></para> @@ -2615,6 +2721,11 @@ Value: 2006.01.01</screen> pattern rules are the same as for the "enumerate" subcommand above.</para> </listitem> + + <listitem> + <para><computeroutput>delete <vm> <property> + </computeroutput>: Deletes a formerly set guest property. + </para></listitem> </itemizedlist></para> </sect1> @@ -2627,18 +2738,19 @@ Value: 2006.01.01</screen> <para>Generally, the syntax is as follows:</para> - <screen>VBoxManage guestcontrol <command></screen> + <screen>VBoxManage guestcontrol <uuid|vmname> <command></screen> <para>The following subcommands are available (where - <computeroutput><vm></computeroutput>, in each case, can either be a + <computeroutput><uuid|vmname></computeroutput>, in each case, can either be a VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist> <listitem> - <para><computeroutput>execute</computeroutput>, which allows for + <para><emphasis role="bold"><computeroutput>execute</computeroutput></emphasis>, + which allows for executing a program/script (process) which already is installed and runnable on the guest. This command only works while a VM is up and running and has the following syntax:</para> - <screen>VBoxManage guestcontrol <vmname>|<uuid> exec[ute] + <screen>VBoxManage guestcontrol <uuid|vmname> exec[ute] --image <path to program> --username <name> [--passwordfile <file> | --password <password>] [--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"] @@ -2649,7 +2761,7 @@ Value: 2006.01.01</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM name. Mandatory.</para> @@ -2657,7 +2769,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--image "<path to program>"</glossterm> + <glossterm><computeroutput>--image "<path to program>"</computeroutput></glossterm> <glossdef> <para>Absolute path and process name of process to execute @@ -2667,7 +2779,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--username <name></glossterm> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> <glossdef> <para>Name of the user the process should run under. This @@ -2676,7 +2788,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--passwordfile <file></glossterm> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> <glossdef> <para>Password of the user account specified to be read from @@ -2686,7 +2798,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--password <password></glossterm> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> <glossdef> <para>Password of the user account specified with @@ -2696,7 +2808,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--dos2unix</glossterm> + <glossterm><computeroutput>--dos2unix</computeroutput></glossterm> <glossdef> Converts output from DOS/Windows guests to UNIX-compatible @@ -2705,8 +2817,8 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--environment - "<NAME>=<VALUE>"</glossterm> + <glossterm><computeroutput>--environment + "<NAME>=<VALUE>"</computeroutput></glossterm> <glossdef> <para>One or more environment variables to be set or @@ -2729,7 +2841,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--timeout <msec></glossterm> + <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> <glossdef> <para>Value (in milliseconds) that specifies the time how @@ -2741,7 +2853,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--unix2dos</glossterm> + <glossterm><computeroutput>--unix2dos</computeroutput></glossterm> <glossdef> Converts output from a UNIX/Linux guests to DOS-/Windows-compatible @@ -2750,7 +2862,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--verbose</glossterm> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to be more verbose.</para> @@ -2758,7 +2870,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--wait-exit</glossterm> + <glossterm><computeroutput>--wait-exit</computeroutput></glossterm> <glossdef> <para>Waits until the process ends and outputs its @@ -2767,7 +2879,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--wait-stdout</glossterm> + <glossterm><computeroutput>--wait-stdout</computeroutput></glossterm> <glossdef> <para>Waits until the process ends and outputs its @@ -2777,7 +2889,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--wait-stderr</glossterm> + <glossterm><computeroutput>--wait-stderr</computeroutput></glossterm> <glossdef> <para>Waits until the process ends and outputs its @@ -2787,7 +2899,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>[-- [<argument1s>] ... [<argumentNs>]]</glossterm> + <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm> <glossdef> <para>One or more arguments to pass to the process being @@ -2835,18 +2947,19 @@ Value: 2006.01.01</screen> </listitem> <listitem> - <para><computeroutput>copyto</computeroutput>, which allows copying + <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>, + which allows copying files from the host to the guest (only with installed Guest Additions 4.0 and later).</para> - <screen>VBoxManage guestcontrol <vmname>|<uuid> copyto|cp + <screen>VBoxManage guestcontrol <uuid|vmname> copyto|cp <guest source> <host dest> --username <name> [--passwordfile <file> | --password <password>] [--dryrun] [--follow] [--recursive] [--verbose]</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM name. Mandatory.</para> @@ -2854,7 +2967,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>source on host</glossterm> + <glossterm><computeroutput>source on host</computeroutput></glossterm> <glossdef> <para>Absolute path of source file(s) on host to copy over @@ -2866,7 +2979,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>destination on guest</glossterm> + <glossterm><computeroutput>destination on guest</computeroutput></glossterm> <glossdef> <para>Absolute destination path on the guest, e.g. @@ -2875,7 +2988,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--username <name></glossterm> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> <glossdef> <para>Name of the user the copy process should run under. @@ -2884,7 +2997,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--passwordfile <file></glossterm> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> <glossdef> <para>Password of the user account specified to be read from @@ -2894,7 +3007,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--password <password></glossterm> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> <glossdef> <para>Password of the user account specified with @@ -2904,7 +3017,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--dryrun</glossterm> + <glossterm><computeroutput>--dryrun</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to only perform a dry run instead of @@ -2913,7 +3026,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--follow</glossterm> + <glossterm><computeroutput>--follow</computeroutput></glossterm> <glossdef> <para>Enables following symlinks on the host's @@ -2922,7 +3035,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--recursive</glossterm> + <glossterm><computeroutput>--recursive</computeroutput></glossterm> <glossdef> <para>Recursively copies files/directories of the specified @@ -2931,7 +3044,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--verbose</glossterm> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to be more verbose.</para> @@ -2939,7 +3052,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--flags <flags></glossterm> + <glossterm><computeroutput>--flags <flags></computeroutput></glossterm> <glossdef> <para>Additional flags to set. This is not used at the @@ -2950,25 +3063,27 @@ Value: 2006.01.01</screen> </listitem> <listitem> - <para><computeroutput>copyfrom</computeroutput>, which allows copying + <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>, + which allows copying files from the guest to the host (only with installed Guest Additions 4.0 and later). It has the same parameters as <computeroutput>copyto</computeroutput> above.</para> </listitem> <listitem> - <para><computeroutput>createdirectory</computeroutput>, which allows + <para><emphasis role="bold"><computeroutput>createdirectory</computeroutput></emphasis>, + which allows copying files from the host to the guest (only with installed Guest Additions 4.0 and later).</para> - <screen>VBoxManage guestcontrol <vmname>|<uuid> createdir[ectory]|mkdir|md + <screen>VBoxManage guestcontrol <uuid|vmname> createdir[ectory]|mkdir|md <guest directory>... --username <name> [--passwordfile <file> | --password <password>] [--parents] [--mode <mode>] [--verbose]</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM name. Mandatory.</para> @@ -2976,7 +3091,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>directory to create on guest</glossterm> + <glossterm><computeroutput>directory to create on guest</computeroutput></glossterm> <glossdef> <para>Absolute path of directory/directories to create on @@ -2990,7 +3105,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--username <name></glossterm> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> <glossdef> <para>Name of the user the copy process should run under. @@ -2999,7 +3114,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--passwordfile <file></glossterm> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> <glossdef> <para>Password of the user account specified to be read from @@ -3009,7 +3124,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--password <password></glossterm> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> <glossdef> <para>Password of the user account specified with @@ -3019,7 +3134,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--parents</glossterm> + <glossterm><computeroutput>--parents</computeroutput></glossterm> <glossdef> <para>Also creates not yet existing parent directories of @@ -3033,7 +3148,347 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--mode <mode></glossterm> + <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> + + <glossdef> + <para>Sets the permission mode of the specified directory. + Only octal modes (e.g. + <computeroutput>0755</computeroutput>) are supported right + now.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>removedirectory</computeroutput></emphasis>, + which allows deletion of guest directories (only with installed Guest + Additions 4.3.2 and later).</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> removedir[ectory]|rmdir + <guest directory>... --username <name> + [--passwordfile <file> | --password <password>] + [--recursive|-R|-r] [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>directory to remove on guest</computeroutput></glossterm> + + <glossdef> + <para>Absolute path of directory/directories to remove on + guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>. The + specified user must have appropriate rights to delete the + specified guest directories.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> + + <glossdef> + <para>Name of the user the copy process should run under. + This user must exist on the guest OS.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified to be read from + the given file. If not given, an empty password is + assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified with + <computeroutput>--username</computeroutput>. If not given, + an empty password is assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--recursive</computeroutput></glossterm> + + <glossdef> + <para>Remove directories and their contents recursively.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>removefile</computeroutput></emphasis>, + which allows deletion of guest files (only with installed Guest + Additions 4.3.2 and later).</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> removefile|rm + <guest file>... --username <name> + [--passwordfile <file> | --password <password>] + [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>file to remove on guest</computeroutput></glossterm> + + <glossdef> + <para>Absolute path of a file/files to remove on + guest, e.g. <computeroutput>D:\Foo\Bar\text.txt</computeroutput>. The + specified user must have appropriate rights to delete the + specified guest files.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> + + <glossdef> + <para>Name of the user the copy process should run under. + This user must exist on the guest OS.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified to be read from + the given file. If not given, an empty password is + assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified with + <computeroutput>--username</computeroutput>. If not given, + an empty password is assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>ren[ame]|mv</computeroutput></emphasis>, + which allows renaming of guest files and/or directories (only with installed Guest + Additions 4.3.2 and later).</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> ren[ame]|mv + <source>... <dest> --username <name> + [--passwordfile <file> | --password <password>] + [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>source</computeroutput></glossterm> + + <glossdef> + <para>Absolute path of one or more source(s) to move to + destination. If more than one source is specified, destination + must be an existing directory on the guest. The specified user + must have appropriate rights to access source and destination + files and directories.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>dest</computeroutput></glossterm> + + <glossdef> + <para>Absolute path of the destination to move the source(s) + to. This can be a directory or a file, depending if one or more + sources have been specified. The specified user + must have appropriate rights to access the destination + file and directory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> + + <glossdef> + <para>Name of the user the copy process should run under. + This user must exist on the guest OS.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified to be read from + the given file. If not given, an empty password is + assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified with + <computeroutput>--username</computeroutput>. If not given, + an empty password is assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>createtemporary</computeroutput></emphasis>, + which allows + copying files from the host to the guest (only with installed Guest + Additions 4.2 and later).</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> createtemp[orary]|mktemp + <template> --username <name> + [--passwordfile <file> | --password <password>] + [--directory] [--secure] [--tmpdir <directory>] + [--domain <domain>] [--mode <mode>] [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>template</computeroutput></glossterm> + + <glossdef> + <para>A file name without a path and with at least three consecutive 'X' + characters or ending in 'X' + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> + + <glossdef> + <para>Name of the user the copy process should run under. + This user must exist on the guest OS.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified to be read from + the given file. If not given, an empty password is + assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> + + <glossdef> + <para>Password of the user account specified with + <computeroutput>--username</computeroutput>. If not given, + an empty password is assumed.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--directory</computeroutput></glossterm> + + <glossdef> + <para>Create a temporary directory instead of a file.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--secure</computeroutput></glossterm> + + <glossdef> + <para> + Secure creation. The file mode is fixed to + <computeroutput>0755</computeroutput>. And the operation + will fail if it cannot performed securely. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm> + + <glossdef> + <para> + Directory where the file / directory is created. If not + specified, the platform-specific temp directory is used. + </para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> <glossdef> <para>Sets the permission mode of the specified directory. @@ -3044,7 +3499,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--verbose</glossterm> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to be more verbose.</para> @@ -3054,17 +3509,219 @@ Value: 2006.01.01</screen> </listitem> <listitem> - <para><computeroutput>stat</computeroutput>, which displays file + <para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>, + which lists various guest control information such as open guest sessions, + guest processes and guest files.</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> list + <all|sessions|processes|files> [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>all|sessions|processes|files</computeroutput></glossterm> + + <glossdef> + <para>Whether to list guest sessions, guest processes, guest files + or all information available. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>process kill</computeroutput></emphasis>, + which terminates specific guest processes of a guest session, based on either the + session's ID or the session's name.</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> process kill + --session-id <ID> + | --session-name <name or pattern> + [--verbose] + <PID> ... <PID n></screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-id</computeroutput></glossterm> + + <glossdef> + <para>Specifies the guest session to use by its ID.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-name</computeroutput></glossterm> + + <glossdef> + <para>Specifies the guest session to use by its name. Multiple + sessions can be closed when specifying * or ? wildcards.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm> + + <glossdef> + <para>List of process identifiers (PIDs) to terminate.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>[p[s]]kill</computeroutput></emphasis>, + which terminates specific guest processes of a guest session, based on either the + session's ID or the session's name.</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> process kill + --session-id <ID> + | --session-name <name or pattern> + [--verbose] + <PID> ... <PID n></screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-id</computeroutput></glossterm> + + <glossdef> + <para>Specifies the guest session to use by its ID.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-name</computeroutput></glossterm> + + <glossdef> + <para>Specifies the guest session to use by its name. Multiple + sessions can be closed when specifying * or ? wildcards.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm> + + <glossdef> + <para>List of process identifiers (PIDs) to terminate.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>session close</computeroutput></emphasis>, + which closes specific guest sessions, based on either the session's ID or the + session's name.</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> session close + --session-id <ID> + | --session-name <name or pattern> + | --all + [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-id</computeroutput></glossterm> + + <glossdef> + <para>Close a guest session specified by its ID.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--session-name</computeroutput></glossterm> + + <glossdef> + <para>Close a guest session specified by its name. Multiple sessions + can be closed when specifying * or ? wildcards.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--all</computeroutput></glossterm> + + <glossdef> + <para>Close all guest sessions.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> + + <listitem> + <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>, + which displays file or file system status on the guest.</para> - <screen>VBoxManage guestcontrol <vmname>|<uuid> stat + <screen>VBoxManage guestcontrol <uuid|vmname> stat <file>... --username <name> [--passwordfile <file> | --password <password>] [--verbose]</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM name. Mandatory.</para> @@ -3072,7 +3729,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>file element(s) to check on guest</glossterm> + <glossterm><computeroutput>file element(s) to check on guest</computeroutput></glossterm> <glossdef> <para>Absolute path of directory/directories to check on @@ -3083,7 +3740,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--username <name></glossterm> + <glossterm><computeroutput>--username <name></computeroutput></glossterm> <glossdef> <para>Name of the user the copy process should run under. @@ -3092,7 +3749,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--passwordfile <file></glossterm> + <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> <glossdef> <para>Password of the user account specified to be read from @@ -3102,7 +3759,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--password <password></glossterm> + <glossterm><computeroutput>--password <password></computeroutput></glossterm> <glossdef> <para>Password of the user account specified with @@ -3112,7 +3769,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--verbose</glossterm> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to be more verbose.</para> @@ -3122,17 +3779,18 @@ Value: 2006.01.01</screen> </listitem> <listitem> - <para><computeroutput>updateadditions</computeroutput>, which allows + <para><emphasis role="bold"><computeroutput>updateadditions</computeroutput></emphasis>, + which allows for updating an already installed Guest Additions version on the guest (only already installed Guest Additions 4.0 and later).</para> - <screen>VBoxManage guestcontrol <vmname>|<uuid> updateadditions + <screen>VBoxManage guestcontrol <uuid|vmname> updateadditions [--source "<guest additions .ISO file to use>"] [--verbose] - [--wait-start]</screen> + [--wait-start] [-- [<argument1>] ... [<argumentN>]]</screen> <para>where the parameters mean: <glosslist> <glossentry> - <glossterm>uuid|vmname</glossterm> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> <glossdef> <para>The VM UUID or VM name. Mandatory.</para> @@ -3140,7 +3798,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--source "<guest additions .ISO file to + <glossterm><computeroutput>--source</computeroutput> "<guest additions .ISO file to use>"</glossterm> <glossdef> @@ -3150,7 +3808,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--verbose</glossterm> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> <glossdef> <para>Tells VBoxManage to be more verbose.</para> @@ -3158,7 +3816,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>--wait-start</glossterm> + <glossterm><computeroutput>--wait-start</computeroutput></glossterm> <glossdef> <para>Starts the regular updating process and waits until the actual Guest Additions update inside the guest was started. @@ -3168,8 +3826,45 @@ Value: 2006.01.01</screen> whole Guest Additions update to complete.</para> </glossdef> </glossentry> + + <glossentry> + <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm> + + <glossdef> + <para>Optional command line arguments to use for the Guest Additions + installer. Useful for retrofitting features which weren't installed + before on the guest.</para> + <para>Arguments containing spaces must be enclosed in + quotation marks.</para> + </glossdef> + </glossentry> </glosslist></para> </listitem> + <listitem> + <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>, + which prints current guest control activity.</para> + + <screen>VBoxManage guestcontrol <uuid|vmname> watch + [--verbose]</screen> + + <para>where the parameters mean: <glosslist> + <glossentry> + <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> + + <glossdef> + <para>The VM UUID or VM name. Mandatory.</para> + </glossdef> + </glossentry> + + <glossentry> + <glossterm><computeroutput>--verbose</computeroutput></glossterm> + + <glossdef> + <para>Tells VBoxManage to be more verbose.</para> + </glossdef> + </glossentry> + </glosslist></para> + </listitem> </itemizedlist></para> </sect1> @@ -3283,8 +3978,8 @@ Value: 2006.01.01</screen> </itemizedlist></para> </sect1> - <sect1> - <title id="metrics">VBoxManage metrics</title> + <sect1 id="metrics"> + <title>VBoxManage metrics</title> <para>This command supports monitoring the usage of system resources. Resources are represented by various metrics associated with the host @@ -3361,7 +4056,7 @@ Value: 2006.01.01</screen> <glosslist> <glossentry> - <glossterm>list</glossterm> + <glossterm><computeroutput>list</computeroutput></glossterm> <glossdef> <para>This subcommand shows the parameters of the currently existing @@ -3371,7 +4066,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>setup</glossterm> + <glossterm><computeroutput>setup</computeroutput></glossterm> <glossdef> <para>This subcommand sets the interval between taking two samples @@ -3384,7 +4079,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>enable</glossterm> + <glossterm><computeroutput>enable</computeroutput></glossterm> <glossdef> <para>This subcommand "resumes" data collection after it has been @@ -3396,7 +4091,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>disable</glossterm> + <glossterm><computeroutput>disable</computeroutput></glossterm> <glossdef> <para>This subcommand "suspends" data collection without affecting @@ -3408,7 +4103,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>query</glossterm> + <glossterm><computeroutput>query</computeroutput></glossterm> <glossdef> <para>This subcommand retrieves and displays the currently retained @@ -3422,7 +4117,7 @@ Value: 2006.01.01</screen> </glossentry> <glossentry> - <glossterm>collect</glossterm> + <glossterm><computeroutput>collect</computeroutput></glossterm> <glossdef> <para>This subcommand sets the interval between taking two samples @@ -3534,7 +4229,7 @@ Value: 2006.01.01</screen> linkend="intro-installing" />.<itemizedlist> <listitem> <para>To add a new extension pack, use <computeroutput>VBoxManage - extpack install <tarball></computeroutput>. This command + extpack install <.vbox-extpack></computeroutput>. This command will fail if an older version of the same extension pack is already installed. The optional <computeroutput>--replace</computeroutput> parameter can be used to uninstall the old package before the new |