user_VBoxManage.xml@ 63375

Last change on this file since 63375 was 63375, checked in by vboxsync, 8 years ago
bugref:6417 Further checkins - VboxManage modifyvm completion (all commands documented) (comment 11, 35), comments 2,3,5,14,36,37 + general tidy up.
File size: 265.7 KB

Line
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	user_VBoxManage.xml:
4	VBoxManage documentation for the user manual.
5
6	This XML document is also be used for generating the help text
7	built into VBoxManage as well as manpages (hacking in progress).
8
9	Copyright (C) 2006-2015 Oracle Corporation
10
11	This file is part of VirtualBox Open Source Edition (OSE), as
12	available from http://www.virtualbox.org. This file is free software;
13	you can redistribute it and/or modify it under the terms of the GNU
14	General Public License (GPL) as published by the Free Software
15	Foundation, in version 2 as it comes in the "COPYING" file of the
16	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18	-->
19	<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
20	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
21	<chapter id="vboxmanage">
22	<title>VBoxManage</title>
23
24	<sect1>
25	<title>Introduction</title>
26
27	<para>As briefly mentioned in <xref linkend="frontends" />, VBoxManage is
28	the command-line interface to VirtualBox. With it, you can completely
29	control VirtualBox from the command line of your host operating system.
30	VBoxManage supports all the features that the graphical user interface
31	gives you access to, but it supports a lot more than that. It exposes
32	really all the features of the virtualization engine, even those that
33	cannot (yet) be accessed from the GUI.</para>
34
35	<para>You will need to use the command line if you want to</para>
36
37	<para><itemizedlist>
38	<listitem>
39	<para>use a different user interface than the main GUI (for example,
40	VBoxSDL or the VBoxHeadless server);</para>
41	</listitem>
42
43	<listitem>
44	<para>control some of the more advanced and experimental
45	configuration settings for a VM.</para>
46	</listitem>
47	</itemizedlist></para>
48
49	<para>There are two main things to keep in mind when using
50	<computeroutput>VBoxManage</computeroutput>: First,
51	<computeroutput>VBoxManage</computeroutput> must always be used with a
52	specific "subcommand", such as "list" or "createvm" or "startvm". All the
53	subcommands that <computeroutput>VBoxManage</computeroutput> supports are
54	described in detail in <xref linkend="vboxmanage" />.</para>
55
56	<para>Second, most of these subcommands require that you specify a
57	particular virtual machine after the subcommand. There are two ways you
58	can do this:</para>
59
60	<itemizedlist>
61	<listitem>
62	<para>You can specify the VM name, as it is shown in the VirtualBox
63	GUI. Note that if that name contains spaces, then you must enclose the
64	entire name in double quotes (as it is always required with command
65	line arguments that contain spaces).</para>
66
67	<para>For example:<screen>VBoxManage startvm "Windows XP"</screen></para>
68	</listitem>
69
70	<listitem>
71	<para>You can specify the UUID, which is the internal unique
72	identifier that VirtualBox uses to refer to the virtual machine.
73	Assuming that the aforementioned VM called "Windows XP" has the UUID
74	shown below, the following command has the same effect as the
75	previous:<screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen></para>
76	</listitem>
77	</itemizedlist>
78
79	<para>You can type <computeroutput>VBoxManage list vms</computeroutput> to
80	have all currently registered VMs listed with all their settings,
81	including their respective names and UUIDs.</para>
82
83	<para>Some typical examples of how to control VirtualBox from the command
84	line are listed below:</para>
85
86	<itemizedlist>
87	<listitem>
88	<para>To create a new virtual machine from the command line and
89	immediately register it with VirtualBox, use
90	<computeroutput>VBoxManage createvm</computeroutput> with the
91	<computeroutput>--register</computeroutput> option,<footnote>
92	<para>For details, see <xref
93	linkend="vboxmanage-createvm" />.</para>
94	</footnote> like this:</para>
95
96	<screen>$ VBoxManage createvm --name "SUSE 10.2" --register
97	VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
98	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
99	All rights reserved.
100
101	Virtual machine 'SUSE 10.2' is created.
102	UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
103	Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen>
104
105	<para>As can be seen from the above output, a new virtual machine has
106	been created with a new UUID and a new XML settings file.</para>
107	</listitem>
108
109	<listitem>
110	<para>To show the configuration of a particular VM, use
111	<computeroutput>VBoxManage showvminfo</computeroutput>; see <xref
112	linkend="vboxmanage-showvminfo" /> for details and an example.</para>
113	</listitem>
114
115	<listitem>
116	<para>To change settings while a VM is powered off, use
117	<computeroutput>VBoxManage modifyvm</computeroutput>, e.g. as
118	follows:<screen>VBoxManage modifyvm "Windows XP" --memory 512</screen></para>
119
120	<para>For details, see <xref linkend="vboxmanage-modifyvm" />.</para>
121	</listitem>
122
123	<listitem>
124	<para>To change the storage configuration (e.g. to add a storage
125	controller and then a virtual disk), use <computeroutput>VBoxManage
126	storagectl</computeroutput> and <computeroutput>VBoxManage
127	storageattach</computeroutput>; see <xref
128	linkend="vboxmanage-storagectl" /> and <xref
129	linkend="vboxmanage-storageattach" /> for details.</para>
130	</listitem>
131
132	<listitem>
133	<para>To control VM operation, use one of the following:<itemizedlist>
134	<listitem>
135	<para>To start a VM that is currently powered off, use
136	<computeroutput>VBoxManage startvm</computeroutput>; see <xref
137	linkend="vboxmanage-startvm" /> for details.</para>
138	</listitem>
139
140	<listitem>
141	<para>To pause or save a VM that is currently running or change
142	some of its settings, use <computeroutput>VBoxManage
143	controlvm</computeroutput>; see <xref
144	linkend="vboxmanage-controlvm" /> for details.</para>
145	</listitem>
146	</itemizedlist></para>
147	</listitem>
148	</itemizedlist>
149	</sect1>
150
151	<sect1>
152	<title>Commands overview</title>
153
154	<para>When running VBoxManage without parameters or when supplying an
155	invalid command line, the below syntax diagram will be shown. Note that
156	the output will be slightly different depending on the host platform; when
157	in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
158	for the commands available on your particular host.</para>
159
160	<xi:include href="../user_VBoxManage_CommandsOverview.xml" xpointer="xpointer(/sect1/*)"
161	xmlns:xi="http://www.w3.org/2001/XInclude" />
162
163	<para>Each time VBoxManage is invoked, only one command can be executed.
164	However, a command might support several subcommands which then can be
165	invoked in one single call. The following sections provide detailed
166	reference information on the different commands.</para>
167	</sect1>
168
169	<sect1 id="vboxmanage-general">
170	<title>General options</title>
171	<para>
172	<itemizedlist>
173	<listitem>
174	<para><computeroutput>-v\|--version</computeroutput>: show the version of
175	this tool and exit.</para>
176	</listitem>
177	<listitem>
178	<para><computeroutput>--nologo</computeroutput>: suppress the output
179	of the logo information (useful for scripts)</para>
180	</listitem>
181	<listitem>
182	<para><computeroutput>--settingspw</computeroutput>: specifiy a settings
183	password</para>
184	</listitem>
185	<listitem>
186	<para><computeroutput>--settingspwfile</computeroutput>: specify a file
187	containing the settings password.</para>
188	</listitem>
189	</itemizedlist>
190	The settings password is used for certain settings which need to be
191	stored encrypted for security reasons. At the moment, the only encrypted
192	setting is the iSCSI initiator secret (see
193	<xref linkend="vboxmanage-storageattach" /> for details). As long as no
194	settings password is specified, this information is stored in
195	<emphasis role="bold">plain text</emphasis>. After using the
196	<computeroutput>--settingspw\|--settingspwfile</computeroutput> option
197	once, it must be always used, otherwise the encrypted setting cannot
198	be unencrypted.
199	</para>
200	</sect1>
201
202	<sect1 id="vboxmanage-list">
203	<title>VBoxManage list</title>
204
205	<para>The <computeroutput>list</computeroutput> command gives relevant
206	information about your system and information about VirtualBox's current
207	settings.</para>
208
209	<para>The following subcommands are available with
210	<computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
211	<listitem>
212	<para><computeroutput>vms</computeroutput> lists all virtual
213	machines currently registered with VirtualBox. By default this
214	displays a compact list with each VM's name and UUID; if you also
215	specify <computeroutput>--long</computeroutput> or
216	<computeroutput>-l</computeroutput>, this will be a detailed list as
217	with the <computeroutput>showvminfo</computeroutput> command (see
218	below).</para>
219	</listitem>
220
221	<listitem>
222	<para><computeroutput>runningvms</computeroutput> lists all
223	currently running virtual machines by their unique identifiers
224	(UUIDs) in the same format as with
225	<computeroutput>vms</computeroutput>.</para>
226	</listitem>
227
228	<listitem>
229	<para><computeroutput>ostypes</computeroutput> lists all guest
230	operating systems presently known to VirtualBox, along with the
231	identifiers used to refer to them with the
232	<computeroutput>modifyvm</computeroutput> command.</para>
233	</listitem>
234
235	<listitem>
236	<para><computeroutput>hostdvds</computeroutput>,
237	<computeroutput>hostfloppies</computeroutput>, respectively, list
238	DVD, floppy, bridged networking and host-only networking interfaces
239	on the host, along with the name used to access them from within
240	VirtualBox.</para>
241	</listitem>
242
243	<listitem>
244	<para><computeroutput>intnets</computeroutput> displays information
245	about the internal networks.</para>
246	</listitem>
247
248	<listitem>
249	<para><computeroutput>bridgedifs</computeroutput>,
250	<computeroutput>hostonlyifs</computeroutput>,
251	<computeroutput>natnets</computeroutput> and
252	<computeroutput>dhcpservers</computeroutput>, respectively, list
253	bridged network interfaces, host-only network interfaces,
254	NAT network interfaces and DHCP servers currently available on the
255	host. Please see <xref
256	linkend="networkingdetails" /> for details on these.</para>
257	</listitem>
258
259	<listitem>
260	<para><computeroutput>hostinfo</computeroutput> displays information
261	about the host system, such as CPUs, memory size and operating
262	system version.</para>
263	</listitem>
264
265	<listitem>
266	<para><computeroutput>hostcpuids</computeroutput> dumps the CPUID
267	parameters for the host CPUs. This can be used for a more fine
268	grained analyis of the host's virtualization capabilities.</para>
269	</listitem>
270
271	<listitem>
272	<para><computeroutput>hddbackends</computeroutput> lists all known
273	virtual disk back-ends of VirtualBox. For each such format (such as
274	VDI, VMDK or RAW), this lists the back-end's capabilities and
275	configuration.</para>
276	</listitem>
277
278	<listitem>
279	<para><computeroutput>hdds</computeroutput>,
280	<computeroutput>dvds</computeroutput> and
281	<computeroutput>floppies</computeroutput> all give you information
282	about virtual disk images currently in use by VirtualBox, including
283	all their settings, the unique identifiers (UUIDs) associated with
284	them by VirtualBox and all files associated with them. This is the
285	command-line equivalent of the Virtual Media Manager; see <xref
286	linkend="vdis" />.</para>
287	</listitem>
288
289	<listitem>
290	<para><computeroutput>usbhost</computeroutput> supplies information
291	about USB devices attached to the host, notably information useful
292	for constructing USB filters and whether they are currently in use
293	by the host.</para>
294	</listitem>
295
296	<listitem>
297	<para><computeroutput>usbfilters</computeroutput> lists all global
298	USB filters registered with VirtualBox -- that is, filters for
299	devices which are accessible to all virtual machines -- and displays
300	the filter parameters.</para>
301	</listitem>
302
303	<listitem>
304	<para><computeroutput>systemproperties</computeroutput> displays
305	some global VirtualBox settings, such as minimum and maximum guest
306	RAM and virtual hard disk size, folder settings and the current
307	authentication library in use.</para>
308	</listitem>
309
310	<listitem>
311	<para><computeroutput>extpacks</computeroutput> displays all
312	VirtualBox extension packs currently installed; see <xref
313	linkend="intro-installing" /> and <xref
314	linkend="vboxmanage-extpack" /> for more information.</para>
315	</listitem>
316
317	<listitem>
318	<para><computeroutput>groups</computeroutput> displays
319	details of the VM Groups; see <xref linkend="gui-vmgroups" />
320	for more information.</para>
321	</listitem>
322
323	<listitem>
324	<para><computeroutput>webcams</computeroutput> displays a list of
325	webcams attached to the running VM. The output format is a list of
326	absolute paths or aliases that were used for attaching the webcams
327	to the VM using the 'webcam attach' command.</para>
328	</listitem>
329
330	<listitem>
331	<para><computeroutput>screenshotformats</computeroutput> displays a
332	list of available screenshot formats.</para>
333	</listitem>
334
335	</itemizedlist></para>
336	</sect1>
337
338	<sect1 id="vboxmanage-showvminfo">
339	<title>VBoxManage showvminfo</title>
340
341	<para>The <computeroutput>showvminfo</computeroutput> command shows
342	information about a particular virtual machine. This is the same
343	information as <computeroutput>VBoxManage list vms --long</computeroutput>
344	would show for all virtual machines.</para>
345
346	<para>You will get information that resembles the following example.</para>
347
348	<para><screen>$ VBoxManage showvminfo "Windows XP"
349	VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
350	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
351	All rights reserved.
352
353	Name: Windows XP
354	Guest OS: Other/Unknown
355	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
356	Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
357	Memory size: 512MB
358	VRAM size: 12MB
359	Number of CPUs: 2
360	Boot menu mode: message and menu
361	Boot Device (1): DVD
362	Boot Device (2): HardDisk
363	Boot Device (3): Not Assigned
364	Boot Device (4): Not Assigned
365	ACPI: on
366	IOAPIC: on
367	...
368	</screen></para>
369	<para>Use the <computeroutput>--machinereadable</computeroutput> option
370	to produce the same output, but in machine readable format: property="value" on a
371	line by line basis, e.g.:</para>
372	<para><screen>
373	name="VBoxSDL --startvm OL7.2"
374	groups="/"
375	ostype="Oracle (64-bit)"
376	UUID="457af700-bc0a-4258-aa3c-13b03da171f2"
377	...
378	</screen></para>
379	</sect1>
380
381	<sect1 id="vboxmanage-registervm">
382	<title>VBoxManage registervm / unregistervm</title>
383
384	<para>The <computeroutput>registervm</computeroutput> command allows you
385	to import a virtual machine definition in an XML file into VirtualBox. The
386	machine must not conflict with one already registered in VirtualBox and it
387	may not have any hard or removable disks attached. It is advisable to
388	place the definition file in the machines folder before registering
389	it.<note>
390	<para>When creating a new virtual machine with
391	<computeroutput>VBoxManage createvm</computeroutput> (see below), you
392	can directly specify the <computeroutput>--register</computeroutput>
393	option to avoid having to register it separately.</para>
394	</note></para>
395
396	<para>The <computeroutput>unregistervm</computeroutput> command
397	unregisters a virtual machine. If
398	<computeroutput>--delete</computeroutput> is also specified, the following
399	files will automatically be deleted as well:<orderedlist>
400	<listitem>
401	<para>all hard disk image files, including differencing files, which
402	are used by the machine and not shared with other machines;</para>
403	</listitem>
404
405	<listitem>
406	<para>saved state files that the machine created, if any (one if the
407	machine was in "saved" state and one for each online
408	snapshot);</para>
409	</listitem>
410
411	<listitem>
412	<para>the machine XML file and its backups;</para>
413	</listitem>
414
415	<listitem>
416	<para>the machine log files, if any;</para>
417	</listitem>
418
419	<listitem>
420	<para>the machine directory, if it is empty after having deleted all
421	the above.</para>
422	</listitem>
423	</orderedlist></para>
424	</sect1>
425
426	<sect1 id="vboxmanage-createvm">
427	<title>VBoxManage createvm</title>
428
429	<para>This command creates a new XML virtual machine definition
430	file.</para>
431
432	<para>The <computeroutput>--name <name></computeroutput> parameter
433	is required and must specify the name of the machine. Since this name is
434	used by default as the file name of the settings file (with the extension
435	<computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
436	of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder
437	- this folder name may vary depending on the operating system and the
438	version of VirtualBox which you are using), it must conform to your host
439	operating system's requirements for file name specifications. If the VM
440	is later renamed, the file and folder names will change automatically.</para>
441
442	<para>However, if the <computeroutput>--basefolder
443	<path></computeroutput> option is used, the machine folder will be
444	named <computeroutput><path></computeroutput>. In this case, the
445	names of the file and the folder will not change if the virtual machine is
446	renamed.</para>
447
448	<para>If the <computeroutput>--group <group>, ...</computeroutput>
449	option is used, the machine will be assigned membership of the specified
450	VM groups in the list. Note that group ids always start with a
451	<computeroutput>/</computeroutput> and can be nested. By default,
452	VMs are always assigned membership of the group
453	<computeroutput>/</computeroutput>.</para>
454
455	<para>If the <computeroutput>--ostype <ostype></computeroutput>:
456	option is used, <ostype> specifies the guest operating system
457	to run in the VM. To learn about the available OS options,
458	run <computeroutput>VBoxManage list ostypes</computeroutput> .</para>
459
460	<para>If the <computeroutput>--uuid <uuid></computeroutput>:
461	option is used, <uuid> specifies the VM uuid. This must be
462	unique within the namespace of the host, or that of the VM Group if
463	it is assigned to a VM group membership. By default, a unique uuid
464	within the appropriate namespace is automatically generated.
465	</para>
466
467	<para>By default, this command only creates the XML file without
468	automatically registering the VM with your VirtualBox installation. To
469	register the VM instantly, use the optional
470	<computeroutput>--register</computeroutput> option, or run
471	<computeroutput>VBoxManage registervm</computeroutput> separately
472	afterwards.</para>
473
474	</sect1>
475
476	<sect1 id="vboxmanage-modifyvm">
477	<title>VBoxManage modifyvm</title>
478
479	<para>This command changes the properties of a registered virtual machine
480	which is not running. Most of the properties that this command makes
481	available correspond to the VM settings that VirtualBox graphical user
482	interface displays in each VM's "Settings" dialog; these were described in
483	<xref linkend="BasicConcepts" />. Some of the more advanced settings,
484	however, are only available through the
485	<computeroutput>VBoxManage</computeroutput> interface.</para>
486
487	<para>These commands require that the machine is powered off (neither
488	running nor in "saved" state). Some machine settings can also be changed
489	while a machine is running; those settings will then have a corresponding
490	subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
491	subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
492
493	<sect2>
494	<title>General settings</title>
495
496	<para>The following general settings are available through
497	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
498	<listitem>
499	<para><computeroutput>--name <name></computeroutput>: This
500	changes the VM's name and possibly renames the internal virtual
501	machine files, as described with <computeroutput>VBoxManage
502	createvm</computeroutput> above.</para>
503	</listitem>
504
505	<listitem>
506	<para><computeroutput>--groups <group>, ...</computeroutput>:
507	This changes the group membership of a VM. Groups always start with
508	a <computeroutput>/</computeroutput> and can be nested. By default
509	VMs are in group <computeroutput>/</computeroutput>.</para>
510	</listitem>
511
512	<listitem>
513	<para><computeroutput>--description <desc></computeroutput>:
514	This changes the VM's description, which is a way to record details
515	about the VM in a way which is meaningful for the user. The GUI
516	interprets HTML formatting, the command line allows arbitrary
517	strings potentially containing multiple lines.</para>
518	</listitem>
519
520	<listitem>
521	<para><computeroutput>--ostype <ostype></computeroutput>:
522	This specifies what guest operating system is supposed to run in
523	the VM. To learn about the various identifiers that can be used
524	here, use <computeroutput>VBoxManage list
525	ostypes</computeroutput>.</para>
526	</listitem>
527
528	<listitem>
529	<para><computeroutput>--iconfile <filename></computeroutput>:
530	This specifies the absolute path on the host file system for the VirtualBox
531	icon to be displayed in the VM.</para>
532	</listitem>
533
534	<listitem>
535	<para><computeroutput>--memory <memorysize></computeroutput>: This sets the amount of RAM,
536	in MB, that the virtual machine should allocate for itself from
537	the host. See the remarks in <xref linkend="gui-createvm" /> for
538	more information.</para>
539	</listitem>
540
541	<listitem>
542	<para><computeroutput>--pagefusion on\|off</computeroutput>:
543	Enables/disables (default) the Page Fusion feature.
544	The Page Fusion feature minimises memory duplication between VMs with similar
545	configurations running on the same host.
546	See <xref linkend="guestadd-pagefusion" /> for details.</para>
547	</listitem>
548
549	<listitem>
550	<para><computeroutput>--vram <vramsize></computeroutput>:
551	This sets the amount of RAM that the virtual graphics card should
552	have. See <xref linkend="settings-display" /> for details.</para>
553	</listitem>
554
555	<listitem>
556	<para><computeroutput>--acpi on\|off</computeroutput>;
557	<computeroutput>--ioapic on\|off</computeroutput>: These two
558	determine whether the VM should have ACPI and I/O APIC support,
559	respectively; see <xref linkend="settings-motherboard" /> for
560	details.</para>
561	</listitem>
562
563	<listitem>
564	<para><computeroutput>--pciattach <host PCI address [@ guest PCI bus address]></computeroutput>:
565	Attaches a specified PCI network controller on the host to a PCI bus (can specify) on the guest.
566	See <xref linkend="pcipassthrough" /> for details. </para>
567	</listitem>
568
569	<listitem>
570	<para><computeroutput>--pcidetach <host PCI address></computeroutput>:
571	Detaches a specified PCI network controller on the host from the attached PCI bus on the guest.
572	See <xref linkend="pcipassthrough" /> for details. </para>
573	</listitem>
574
575	<listitem>
576	<para><computeroutput>--hardwareuuid
577	<uuid></computeroutput>: The UUID presented to the guest via
578	memory tables (DMI/SMBIOS), hardware and guest properties. By
579	default this is the same as the VM uuid. Useful when cloning a VM.
580	Teleporting takes care of this automatically.</para>
581	</listitem>
582
583	<listitem>
584	<para><computeroutput>--cpus <cpucount></computeroutput>:
585	This sets the number of virtual CPUs for the virtual machine (see
586	<xref linkend="settings-processor" />). If CPU hot-plugging is
587	enabled (see below), this then sets the
588	<emphasis>maximum</emphasis> number of virtual CPUs that can be
589	plugged into the virtual machines.</para>
590	</listitem>
591
592	<listitem>
593	<para><computeroutput>--cpuhotplug on\|off</computeroutput>: This
594	enables CPU hot-plugging. When enabled, virtual CPUs can be added
595	to and removed from a virtual machine while it is running. See
596	<xref linkend="cpuhotplug" /> for more information.</para>
597	</listitem>
598
599	<listitem>
600	<para><computeroutput>--plugcpu\|unplugcpu
601	<id></computeroutput>: If CPU hot-plugging is enabled (see
602	above), this adds a virtual CPU to the virtual machines (or
603	removes one). <computeroutput><id></computeroutput>
604	specifies the index of the virtual CPU to be added or removed and
605	must be a number from 0 to the maximum no. of CPUs configured with
606	the <computeroutput>--cpus</computeroutput> option. CPU 0 can
607	never be removed.</para>
608	</listitem>
609
610	<listitem>
611	<para><computeroutput>--cpuexecutioncap
612	<1-100></computeroutput>: This setting controls how much cpu
613	time a virtual CPU can use. A value of 50 implies a single virtual
614	CPU can use up to 50% of a single host CPU.</para>
615	</listitem>
616
617	<listitem>
618	<para><computeroutput>--pae on\|off</computeroutput>: This
619	enables/disables PAE (see <xref
620	linkend="settings-processor" />).</para>
621	</listitem>
622
623	<listitem>
624	<para><computeroutput>--longmode on\|off</computeroutput>: This
625	enables/disables long mode (see <xref
626	linkend="settings-processor" />).</para>
627	</listitem>
628
629	<listitem>
630	<para><computeroutput>--cpu-profile <host\|intel 80[86\|286\|386]></computeroutput>:
631	Indicate the use of a profile for guest cpu emulation. Specify either one based
632	on the host system CPU (host), or one from a number of older Intel
633	Micro-architectures - 8086, 80286, 80386.</para>
634	</listitem>
635
636	<listitem>
637	<para><computeroutput>--hpet on\|off</computeroutput>: This
638	enables/disables a High Precision Event Timer (HPET) which can
639	replace the legacy system timers. This is turned off by default.
640	Note that Windows supports a HPET only from Vista onwards.</para>
641	</listitem>
642
643	<listitem>
644	<para><computeroutput>--hwvirtex on\|off</computeroutput>: This
645	enables or disables the use of hardware virtualization extensions
646	(Intel VT-x or AMD-V) in the processor of your host system; see
647	<xref linkend="hwvirt" />.</para>
648	</listitem>
649
650	<listitem>
651	<para><computeroutput>--triplefaultreset on\|off</computeroutput>:
652	This setting allows to reset the guest instead of triggering a
653	Guru Meditation. Some guests raise a triple fault to reset the
654	CPU so sometimes this is desired behavior. Works only for non-SMP
655	guests.</para>
656	</listitem>
657
658	<listitem>
659	<para><computeroutput>--apic on\|off</computeroutput>:
660	This setting enables(default)/disables IO APIC. With
661	I/O APIC, operating systems can use more than 16 interrupt
662	requests (IRQs) thus avoiding IRQ sharing for improved
663	reliability. See <xref linkend="settings-motherboard" />.</para>
664	</listitem>
665
666	<listitem>
667	<para><computeroutput>--x2apic on\|off</computeroutput>:
668	This setting enables(default)/disables CPU x2APIC support.
669	CPU x2APIC support helps operating systems run more efficiently on high
670	core count configurations, and optimizes interrupt
671	distribution in virtualized environments. Disable when using host/guest
672	operating systems incompatible with x2APIC support.</para>
673	</listitem>
674
675	<listitem>
676	<para><computeroutput>--paravirtprovider
677	none\|default\|legacy\|minimal\|hyperv\|kvm</computeroutput>: This
678	setting specifies which paravirtualization interface to provide to
679	the guest operating system. Specifying
680	<computeroutput>none</computeroutput> explicitly turns off exposing
681	any paravirtualization interface. The option
682	<computeroutput>default</computeroutput>, will pick an appropriate
683	interface depending on the guest OS type while starting the VM.
684	This is the default option chosen while creating new VMs. The
685	<computeroutput>legacy</computeroutput> option is chosen for VMs
686	which were created with older VirtualBox versions and will pick a
687	paravirtualization interface while starting the VM with VirtualBox
688	5.0 and newer. The <computeroutput>minimal</computeroutput> provider
689	is mandatory for Mac OS X guests, while
690	<computeroutput>kvm</computeroutput> and
691	<computeroutput>hyperv</computeroutput> are recommended for Linux
692	and Windows guests respectively. These options are explained in
693	detail under <xref linkend="gimproviders" />.</para>
694	</listitem>
695
696	<listitem>
697	<para><computeroutput>--paravirtdebug <key=value>
698	[,<key=value> ...]</computeroutput>: This setting specifies debugging
699	options specific to the paravirtualization provider
700	configured for this VM. Please refer to the provider specific
701	options under <xref linkend="gimdebug" /> for a list of supported
702	key-value pairs for each provider.</para>
703	</listitem>
704
705	<listitem>
706	<para><computeroutput>--nestedpaging on\|off</computeroutput>: If
707	hardware virtualization is enabled, this additional setting
708	enables or disables the use of the nested paging feature in the
709	processor of your host system; see <xref
710	linkend="hwvirt" />.</para>
711	</listitem>
712
713	<listitem>
714	<para><computeroutput>--largepages on\|off</computeroutput>: If
715	hardware virtualization <emphasis>and</emphasis> nested paging are
716	enabled, for Intel VT-x only, an additional performance
717	improvement of up to 5% can be obtained by enabling this setting.
718	This causes the hypervisor to use large pages to reduce TLB use
719	and overhead.</para>
720	</listitem>
721
722	<listitem>
723	<para><computeroutput>--vtxvpid on\|off</computeroutput>: If
724	hardware virtualization is enabled, for Intel VT-x only, this
725	additional setting enables or disables the use of the tagged TLB
726	(VPID) feature in the processor of your host system; see <xref
727	linkend="hwvirt" />.</para>
728	</listitem>
729
730	<listitem>
731	<para><computeroutput>--vtxux on\|off</computeroutput>: If
732	hardware virtualization is enabled, for Intel VT-x only, this
733	setting enables or disables the use of the unrestricted guest mode
734	feature for executing your guest.</para>
735	</listitem>
736
737	<listitem>
738	<para><computeroutput>--accelerate3d on\|off</computeroutput>: This
739	enables, if the Guest Additions are installed, whether hardware 3D
740	acceleration should be available; see <xref
741	linkend="guestadd-3d" />.</para>
742	</listitem>
743
744	<listitem>
745	<para><computeroutput>--accelerate2dvideo on\|off</computeroutput>:
746	This enables, if the Guest Additions are installed, whether 2D video
747	acceleration should be available; see <xref
748	linkend="guestadd-2d" />.</para>
749	</listitem>
750
751	<listitem>
752	<para><computeroutput>--chipset piix3\|ich9</computeroutput>:
753	By default VirtualBox emulates an Intel PIIX3 chipset. Usually there
754	is no reason to change the default setting unless it is required to
755	relax some of its constraints; see <xref
756	linkend="settings-motherboard" />.</para>
757	</listitem>
758
759	<listitem>
760	<para>You can influence the BIOS logo that is displayed when a
761	virtual machine starts up with a number of settings. Per default,
762	a VirtualBox logo is displayed.</para>
763
764	<para>With <computeroutput>--bioslogofadein
765	on\|off</computeroutput> and <computeroutput>--bioslogofadeout
766	on\|off</computeroutput>, you can determine whether the logo should
767	fade in and out, respectively.</para>
768
769	<para>With <computeroutput>--bioslogodisplaytime
770	<msec></computeroutput> you can set how long the logo should
771	be visible, in milliseconds.</para>
772
773	<para>With <computeroutput>--bioslogoimagepath
774	<imagepath></computeroutput> you can, if you are so
775	inclined, replace the image that is shown, with your own logo. The
776	image must be an uncompressed 256 color BMP file without color
777	space information (Windows 3.0 format). The image must not be
778	bigger than 640 x 480.</para>
779	</listitem>
780
781	<listitem>
782	<para><computeroutput>--biosbootmenu
783	disabled\|menuonly\|messageandmenu</computeroutput>: This specifies
784	whether the BIOS allows the user to select a temporary boot
785	device. <computeroutput>menuonly</computeroutput> suppresses the
786	message, but the user can still press F12 to select a temporary
787	boot device.</para>
788	</listitem>
789
790	<listitem>
791	<para><computeroutput>--biosapic
792	x2apic\|apic\|disabled</computeroutput>: This specifies
793	the firmware APIC level to be used. Options are: x2apic, apic or
794	disabled (no apic or x2apic) respectively.</para>
795
796	<para>Note that if x2apic is specified and x2apic is unsupported by the
797	VCPU, biosapic downgrades to apic, if supported - otherwise to 'disabled'.
798	Similarly, if apic is specified, and apic is unsupported results in a
799	downgrade to 'disabled'.</para>
800	</listitem>
801
802	<listitem>
803	<para><computeroutput>--biossystemtimeoffset <ms></computeroutput>:
804	This specifies a fixed time offset (milliseconds) of the guest relative to
805	the host time. If the offset is positive, the guest time runs ahead of the
806	host time.</para>
807	</listitem>
808
809	<listitem>
810	<para><computeroutput>--biospxedebug on\|off</computeroutput>:
811	This option enables additional debugging output when using the
812	Intel PXE boot ROM. The output will be written to the release log
813	file (<xref linkend="collect-debug-info" />.</para>
814	</listitem>
815
816	<listitem>
817	<para><computeroutput>--boot<1-4>
818	none\|floppy\|dvd\|disk\|net</computeroutput>: This specifies the boot
819	order for the virtual machine. There are four "slots", which the
820	VM will try to access from 1 to 4, and for each of which you can
821	set a device that the VM should attempt to boot from.</para>
822	</listitem>
823
824	<listitem>
825	<para><computeroutput>--rtcuseutc on\|off</computeroutput>: This
826	option lets the real-time clock (RTC) operate in UTC time (see
827	<xref linkend="settings-motherboard" />).</para>
828	</listitem>
829
830	<listitem>
831	<para><computeroutput>--graphicscontroller none\|vboxvga\|vmsvga</computeroutput>: This
832	option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga.
833	<xref linkend="settings-motherboard" />).</para>
834	</listitem>
835
836	<listitem>
837	<para><computeroutput>--snapshotfolder
838	default\|<path></computeroutput>: This allows you to specify
839	the folder in which snapshots will be kept for a virtual
840	machine.</para>
841	</listitem>
842
843	<listitem>
844	<para><computeroutput>--firmware bios\|efi\|efi32\|efi64</computeroutput>:
845	Specifies which firmware to be used to boot the VM:
846	Available options are BIOS, or one of the EFI options: efi, efi32 or efi64.
847	Use EFI options with care.</para>
848	</listitem>
849
850	<listitem>
851	<para><computeroutput>--guestmemoryballoon
852	<size></computeroutput> sets the default size of the guest
853	memory balloon, that is, memory allocated by the VirtualBox Guest
854	Additions from the guest operating system and returned to the
855	hypervisor for re-use by other virtual machines.
856	<computeroutput><size></computeroutput> must be specified in
857	megabytes. The default size is 0 megabytes. For details,
858	see <xref linkend="guestadd-balloon" />.</para>
859	</listitem>
860
861	<listitem>
862	<para><computeroutput>--defaultfrontend
863	default\|<name></computeroutput>: This allows you to specify
864	the default frontend which will be used when starting this VM; see
865	<xref linkend="vboxmanage-startvm" /> for details.</para>
866	</listitem>
867	</itemizedlist></para>
868	</sect2>
869
870	<sect2>
871	<title>Networking settings</title>
872
873	<para>The following networking settings are available through
874	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
875	settings, the decimal number directly following the option name ("1-N"
876	in the list below) specifies the virtual network adapter whose settings
877	should be changed.<itemizedlist>
878	<listitem>
879	<para><computeroutput>--nic<1-N>
880	none\|null\|nat\|natnetwork\|bridged\|intnet\|hostonly\|generic</computeroutput>:
881	With this, you can set, for each of the VM's virtual network cards,
882	what type of networking should be available. They can be not
883	present (<computeroutput>none</computeroutput>), not connected to
884	the host (<computeroutput>null</computeroutput>), use network
885	address translation (<computeroutput>nat</computeroutput>),
886	use the new network address translation engine
887	(<computeroutput>natnetwork</computeroutput>),
888	bridged networking (<computeroutput>bridged</computeroutput>) or
889	communicate with other virtual machines using internal networking
890	(<computeroutput>intnet</computeroutput>), host-only networking
891	(<computeroutput>hostonly</computeroutput>), or access rarely used
892	sub-modes (<computeroutput>generic</computeroutput>).
893	These options correspond
894	to the modes which are described in detail in <xref
895	linkend="networkingmodes" />.</para>
896	</listitem>
897
898	<listitem>
899	<para><computeroutput>--nictype<1-N>
900	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
901	This allows you, for each of the VM's virtual network cards, to
902	specify which networking hardware VirtualBox presents to the
903	guest; see <xref linkend="nichardware" />.</para>
904	</listitem>
905
906	<listitem>
907	<para><computeroutput>--cableconnected<1-N>
908	on\|off</computeroutput>: This allows you to temporarily disconnect
909	a virtual network interface, as if a network cable had been pulled
910	from a real network card. This might be useful for resetting
911	certain software components in the VM.</para>
912	</listitem>
913
914	<listitem>
915	<para>With the "nictrace" options, you can optionally trace
916	network traffic by dumping it to a file, for debugging
917	purposes.</para>
918
919	<para>With <computeroutput>--nictrace<1-N>
920	on\|off</computeroutput>, you can enable network tracing for a
921	particular virtual network card.</para>
922
923	<para>If enabled, you must specify with
924	<computeroutput>--nictracefile<1-N>
925	<filename></computeroutput> what file the trace should be
926	logged to.</para>
927	</listitem>
928
929	<listitem>
930	<para><computeroutput>--nicproperty<1-N>
931	<paramname>="paramvalue"</computeroutput>:
932	This option, in combination with "nicgenericdrv" allows you to
933	pass parameters to rarely-used network backends.</para>
934
935	<para>Those parameters are backend engine-specific, and are different
936	between UDP Tunnel and the VDE backend drivers. For example,
937	please see <xref linkend="network_udp_tunnel" />.
938	</para>
939	</listitem>
940
941	<listitem>
942	<para><computeroutput>--nicspeed<1-N> <kbps></computeroutput>:
943	If generic networking has been enabled for a virtual network card (see the
944	<computeroutput>--nic</computeroutput> option above; otherwise
945	this setting has no effect), this mode enables access
946	to rarely used networking sub-modes, such as VDE network or UDP Tunnel.
947	This option specifies the throughput rate in KBytes/sec.
948	</para>
949	</listitem>
950
951	<listitem>
952	<para><computeroutput>--nicbootprio<1-N>
953	<priority></computeroutput>: This specifies the order in which
954	NICs are tried for booting over the network (using PXE). The
955	priority is an integer in the 0 to 4 range. Priority 1 is the
956	highest, priority 4 is low. Priority 0, which is the default unless
957	otherwise specified, is the lowest.</para>
958
959	<para>Note that this option only has effect when the Intel PXE boot
960	ROM is used.</para>
961	</listitem>
962
963	<listitem>
964	<para><computeroutput>--nicpromisc<1-N>
965	deny\|allow-vms\|allow-all</computeroutput>:
966	This allows you, for each of the VM's virtual network cards, to
967	specify how the promiscuous mode is handled. This setting is only
968	relevant for bridged networking.
969	<computeroutput>deny</computeroutput> (default setting) hides
970	any traffic not intended for this VM.
971	<computeroutput>allow-vms</computeroutput> hides all host
972	traffic from this VM but allows the VM to see traffic from/to other
973	VMs.
974	<computeroutput>allow-all</computeroutput> removes this
975	restriction completely.</para>
976	</listitem>
977
978	<listitem>
979	<para><computeroutput>--nicbandwidthgroup<1-N>
980	none\|<name></computeroutput>: This removes/adds an assignment
981	of a bandwidth group from/to the specified virtual network interface.
982	Specifying <computeroutput>none</computeroutput> removes any current
983	bandwidth group assignment from the specified virtual network interface.
984	Specifying <computeroutput><name></computeroutput> adds an
985	assignment of a bandwidth group to the specified virtual network
986	interface.</para>
987	<para>For details, please see <xref linkend="network_bandwidth_limit" />.</para>
988	</listitem>
989
990	<listitem>
991	<para><computeroutput>--bridgeadapter<1-N>
992	none\|<devicename></computeroutput>: If bridged networking
993	has been enabled for a virtual network card (see the
994	<computeroutput>--nic</computeroutput> option above; otherwise
995	this setting has no effect), use this option to specify which host
996	interface the given virtual network interface will use. For
997	details, please see <xref linkend="network_bridged" />.</para>
998	</listitem>
999
1000	<listitem>
1001	<para><computeroutput>--hostonlyadapter<1-N>
1002	none\|<devicename></computeroutput>: If host-only networking
1003	has been enabled for a virtual network card (see the
1004	<computeroutput>--nic</computeroutput> option
1005	above; otherwise this setting has no effect), use this option to
1006	specify which host-only networking interface the given virtual
1007	network interface will use. For details, please see <xref
1008	linkend="network_hostonly" />.</para>
1009	</listitem>
1010
1011	<listitem>
1012	<para><computeroutput>--intnet<1-N>
1013	network</computeroutput>: If internal networking has been enabled
1014	for a virtual network card (see the
1015	<computeroutput>--nic</computeroutput> option above; otherwise
1016	this setting has no effect), use this option to specify the name
1017	of the internal network (see <xref
1018	linkend="network_internal" />).</para>
1019	</listitem>
1020
1021
1022	<listitem>
1023	<para><computeroutput>--nat-network<1-N> <network
1024	name></computeroutput>: If the networking type is set to
1025	<computeroutput>natnetwork</computeroutput> (not
1026	<computeroutput>nat</computeroutput>) then this setting specifies
1027	the name of the NAT network this adapter is connected to.</para>
1028	</listitem>
1029
1030	<listitem>
1031	<para><computeroutput>--nicgenericdrv<1-N>
1032	<backend driver></computeroutput>: If generic networking has been
1033	enabled for a virtual network card (see the
1034	<computeroutput>--nic</computeroutput> option above; otherwise
1035	this setting has no effect), this mode allows you to access
1036	rarely used networking sub-modes, such as VDE network or UDP Tunnel.
1037	</para>
1038	</listitem>
1039
1040	<listitem>
1041	<para><computeroutput>--macaddress<1-N>
1042	auto\|<mac></computeroutput>: With this option you can set
1043	the MAC address of a particular network adapter on the VM. Normally, each
1044	network adapter is assigned a random address by VirtualBox at
1045	VM creation.</para>
1046	</listitem>
1047	</itemizedlist></para>
1048
1049	<sect3>
1050	<title>NAT Networking settings.</title>
1051
1052	<para>The following NAT networking settings are available through
1053	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
1054	settings, the decimal number directly following the option name ("1-N"
1055	in the list below) specifies the virtual network adapter whose
1056	settings should be changed.<itemizedlist>
1057
1058	<listitem>
1059	<para><computeroutput>--natnet<1-N>
1060	<network>\|default</computeroutput>:
1061	If the networking type is set to <computeroutput>nat</computeroutput>
1062	(not <computeroutput>natnetwork</computeroutput>) then this
1063	setting specifies the IP address range to be used for
1064	this network. See <xref linkend="changenat" /> for an
1065	example.</para>
1066	</listitem>
1067
1068	<listitem>
1069	<para><computeroutput>--natpf<1-N>
1070	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
1071	<guestport></computeroutput>: This option defines a NAT
1072	port-forwarding rule (please see <xref linkend="natforward" />
1073	for details).</para>
1074	</listitem>
1075
1076	<listitem>
1077	<para><computeroutput>--natpf<1-N> delete
1078	<name></computeroutput>: This option deletes a NAT
1079	port-forwarding rule (please see <xref linkend="natforward" />
1080	for details).</para>
1081	</listitem>
1082
1083	<listitem>
1084	<para><computeroutput>--nattftpprefix<1-N>
1085	<prefix></computeroutput>: This option defines a prefix
1086	for the built-in TFTP server, i.e. where the boot file is
1087	located (please see <xref linkend="nat-tftp" /> and <xref
1088	linkend="nat-adv-tftp" /> for details).</para>
1089	</listitem>
1090
1091	<listitem>
1092	<para><computeroutput>--nattftpfile<1-N>
1093	<bootfile></computeroutput>: This option defines the TFT
1094	boot file (please see <xref linkend="nat-adv-tftp" /> for
1095	details).</para>
1096	</listitem>
1097
1098	<listitem>
1099	<para><computeroutput>--nattftpserver<1-N>
1100	<tftpserver></computeroutput>: This option defines the
1101	TFTP server address to boot from (please see <xref
1102	linkend="nat-adv-tftp" /> for details).</para>
1103	</listitem>
1104
1105	<listitem>
1106	<para><computeroutput>--nattbindip<1-N>
1107	<ip;></computeroutput>: VirtualBox's NAT engine normally routes
1108	TCP/IP packets through the default interface assigned by the host's
1109	TCP/IP stack. Use this option to instruct the NAT engine to bind
1110	to a specified IP address instead. (Please see <xref
1111	linkend="nat-adv-settings" /> for details).</para>
1112	</listitem>
1113
1114	<listitem>
1115	<para><computeroutput>--natdnspassdomain<1-N>
1116	on\|off</computeroutput>: This option specifies whether the
1117	built-in DHCP server passes the domain name for network name
1118	resolution.</para>
1119	</listitem>
1120
1121	<listitem>
1122	<para><computeroutput>--natdnsproxy<1-N>
1123	on\|off</computeroutput>: This option makes the NAT engine proxy
1124	all guest DNS requests to the host's DNS servers (please see
1125	<xref linkend="nat-adv-dns" /> for details).</para>
1126	</listitem>
1127
1128	<listitem>
1129	<para><computeroutput>--natdnshostresolver<1-N>
1130	on\|off</computeroutput>: This option makes the NAT engine use
1131	the host's resolver mechanisms to handle DNS requests (please
1132	see <xref linkend="nat-adv-dns" /> for details).</para>
1133	</listitem>
1134
1135	<listitem>
1136	<para><computeroutput>--natsettings<1-N>
1137	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
1138	[<tcprcv>]</computeroutput>: This option controls several
1139	NAT settings (please see <xref linkend="nat-adv-settings" /> for
1140	details).</para>
1141	</listitem>
1142
1143	<listitem>
1144	<para><computeroutput>--nataliasmode<1-N>
1145	default\|[log],[proxyonly],[sameports]</computeroutput>: This
1146	option defines behaviour of NAT engine core: log - enables
1147	logging, proxyonly - switches of aliasing mode makes NAT
1148	transparent, sameports enforces NAT engine to send packets via
1149	the same port as they originated on, default - disable all
1150	mentioned modes above . (please see <xref
1151	linkend="nat-adv-alias" /> for details).</para>
1152	</listitem>
1153	</itemizedlist></para>
1154	</sect3>
1155	</sect2>
1156
1157	<sect2 id="vboxmanage-modifyvm-other">
1158	<title>Miscellaneous settings</title>
1159
1160	<para>The following other hardware settings, such as serial port, audio,
1161	clipboard, drag and drop, monitor and USB settings are available through
1162	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
1163	<listitem>
1164	<para><computeroutput>--mouse <ps2\|usb\|usbtablet\|usbmultitouch></computeroutput>:
1165	Specifies the mode of the mouse to be used in the VM. Available options are: ps2, usb,
1166	usbtablet, usbmultitouch.
1167	</para>
1168	</listitem>
1169
1170	<listitem>
1171	<para><computeroutput>--keyboard <ps2\|usb></computeroutput>:
1172	Specifies the mode of the keyboard to be used in the VM. Available options are: ps2, usb.
1173	</para>
1174	</listitem>
1175	<listitem>
1176	<para><computeroutput>--uart<1-N> off\|<I/O base>
1177	<IRQ></computeroutput>: With this option you can configure
1178	virtual serial ports for the VM; see <xref
1179	linkend="serialports" /> for an introduction.</para>
1180	</listitem>
1181
1182	<listitem>
1183	<para><computeroutput>--uartmode<1-N>
1184	<arg></computeroutput>: This setting controls how VirtualBox
1185	connects a given virtual serial port (previously configured with
1186	the <computeroutput>--uartX</computeroutput> setting, see above)
1187	to the host on which the virtual machine is running. As described
1188	in detail in <xref linkend="serialports" />, for each such port,
1189	you can specify <computeroutput><arg></computeroutput> as
1190	one of the following options:<itemizedlist>
1191	<listitem>
1192	<para><computeroutput>disconnected</computeroutput>: Even
1193	though the serial port is shown to the guest, it has no
1194	"other end" -- like a real COM port without a cable.</para>
1195	</listitem>
1196
1197	<listitem>
1198	<para><computeroutput>server
1199	<pipename></computeroutput>: On a Windows host, this
1200	tells VirtualBox to create a named pipe on the host named
1201	<computeroutput><pipename></computeroutput> and
1202	connect the virtual serial device to it. Note that Windows
1203	requires that the name of a named pipe begin with
1204	<computeroutput>\\.\pipe\</computeroutput>.</para>
1205
1206	<para>On a Linux host, instead of a named pipe, a local
1207	domain socket is used.</para>
1208	</listitem>
1209
1210	<listitem>
1211	<para><computeroutput>client
1212	<pipename></computeroutput>: This operates just like
1213	<computeroutput>server ...</computeroutput>, except that the
1214	pipe (or local domain socket) is not created by VirtualBox,
1215	but assumed to exist already.</para>
1216	</listitem>
1217
1218	<listitem>
1219	<para><computeroutput>tcpserver
1220	<port></computeroutput>: This
1221	tells VirtualBox to create a TCP socket on the host with TCP
1222	<computeroutput><port></computeroutput> and
1223	connect the virtual serial device to it. Note that UNIX-like
1224	systems require ports over 1024 for normal users.</para>
1225	</listitem>
1226
1227	<listitem>
1228	<para><computeroutput>tcpclient
1229	<hostname:port></computeroutput>: This operates just like
1230	<computeroutput>tcpserver ...</computeroutput>, except that the
1231	TCP socket is not created by VirtualBox,
1232	but assumed to exist already.</para>
1233	</listitem>
1234
1235	<listitem>
1236	<para><computeroutput>file <file></computeroutput>:
1237	This redirects the serial port output to a raw file <file>
1238	specified by its absolute path on the host file system.</para>
1239	</listitem>
1240
1241	<listitem>
1242	<para><computeroutput><devicename></computeroutput>:
1243	If, instead of the above, the device name of a physical
1244	hardware serial port of the host is specified, the virtual
1245	serial port is connected to that hardware port. On a Windows
1246	host, the device name will be a COM port such as
1247	<computeroutput>COM1</computeroutput>; on a Linux host, the
1248	device name will look like
1249	<computeroutput>/dev/ttyS0</computeroutput>. This allows you
1250	to "wire" a real serial port to a virtual machine.</para>
1251	</listitem>
1252	</itemizedlist></para>
1253	</listitem>
1254
1255	<listitem>
1256	<para><computeroutput>--lptmode<1-N>
1257	<Device></computeroutput>:
1258	Specifies the Device Name of the parallel port that
1259	the Parallel Port feature will be using. Use this
1260	<emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
1261	This feature is host operating system specific.</para>
1262	</listitem>
1263
1264	<listitem>
1265	<para><computeroutput>--lpt<1-N>
1266	<I/O base> <IRQ></computeroutput>:
1267	Specifies the I/O address of the parallel port and the IRQ
1268	number that the Parallel Port feature will be using. Use this <emphasis>after</emphasis>
1269	<computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
1270	the values that guest sees i.e. the values avalable under guest Device Manager.</para>
1271	</listitem>
1272
1273	<listitem>
1274	<para><computeroutput>--audio none\|null\|oss\|alsa\|pulse</computeroutput>: With
1275	this option, you can set whether the VM should have audio
1276	support, and if so - which type.</para>
1277	</listitem>
1278
1279	<listitem>
1280	<para><computeroutput>--audiocontroller ac97\|hda\|sb16</computeroutput>: With
1281	this option, you can specify the audio controller to be used with this VM.
1282	</para>
1283	</listitem>
1284
1285	<listitem>
1286	<para><computeroutput>--audiocodec stac9700\|ad1980\|stac9221\|sb16</computeroutput>: With
1287	this option, you can specify the audio codec to be used with this VM.
1288	</para>
1289	</listitem>
1290
1291	<listitem>
1292	<para><computeroutput>--clipboard
1293	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1294	With this setting, you can select if and how the guest or host
1295	operating system's clipboard should be shared with the host or guest;
1296	see <xref linkend="generalsettings" />. This requires that the Guest
1297	Additions be installed in the virtual machine.</para>
1298	</listitem>
1299
1300	<listitem>
1301	<para><computeroutput>--draganddrop
1302	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1303	With this setting, you can select the current drag and drop mode
1304	being used between the host and the virtual machine;
1305	see <xref linkend="guestadd-dnd" />. This requires that the Guest
1306	Additions be installed in the virtual machine.</para>
1307	</listitem>
1308
1309	<listitem>
1310	<para><computeroutput>--monitorcount
1311	<count></computeroutput>: This enables multi-monitor
1312	support; see <xref linkend="settings-display" />.</para>
1313	</listitem>
1314
1315	<listitem>
1316	<para><computeroutput>--usb on\|off</computeroutput>: This option
1317	enables or disables the VM's virtual USB controller; see <xref
1318	linkend="settings-usb" /> for details.</para>
1319	</listitem>
1320
1321	<listitem>
1322	<para><computeroutput>--usbehci on\|off</computeroutput>: This
1323	option enables or disables the VM's virtual USB 2.0 controller;
1324	see <xref linkend="settings-usb" /> for details.</para>
1325	</listitem>
1326
1327	<listitem>
1328	<para><computeroutput>--usbxhci on\|off</computeroutput>: This
1329	option enables or disables the VM's virtual USB 3.0 controller;
1330	see <xref linkend="settings-usb" /> for details.</para>
1331	</listitem>
1332
1333	<listitem>
1334	<para><computeroutput>--usbrename
1335	<oldname> <newname></computeroutput>: This
1336	option enables renaming of the VM's virtual USB controller from <oldname>
1337	to <newname>.</para>
1338	</listitem>
1339	</itemizedlist></para>
1340
1341	</sect2>
1342
1343	<sect2 id="vboxmanage-modifyvm-videocap">
1344	<title>Video Capture settings</title>
1345
1346	<para>The following settings for changing video recording parameters are
1347	available through <computeroutput>VBoxManage modifyvm</computeroutput>.
1348	<itemizedlist>
1349	<listitem>
1350	<para><computeroutput>--videocap on\|off</computeroutput>:
1351	This option enables or disables recording a VM session into a WebM/VP8
1352	file. If this option is enabled, recording will start when the VM
1353	session is started.</para>
1354	</listitem>
1355	<listitem>
1356	<para><computeroutput>--videocapscreens all\|<screen ID>
1357	[<screen ID> ...]</computeroutput>: This option allows to specify which screens of
1358	the VM are being recorded. Each screen is recorded into a separate file.</para>
1359	</listitem>
1360	<listitem>
1361	<para><computeroutput>--videocapfile <filename></computeroutput>:
1362	This option sets the filename VirtualBox uses to save the recorded content.
1363	</para>
1364	</listitem>
1365	<listitem>
1366	<para><computeroutput>--videocapres <width>x<height></computeroutput>:
1367	This option sets the resolution (in pixels) of the recorded video.</para>
1368	</listitem>
1369	<listitem>
1370	<para><computeroutput>--videocaprate <rate></computeroutput>:
1371	This option sets the bitrate in kilobits (kb) per second. Increasing this
1372	value makes the video look better for the cost of an increased file size.</para>
1373	</listitem>
1374	<listitem>
1375	<para><computeroutput>--videocapfps <fps></computeroutput>:
1376	This option sets the maximum number of frames per second (FPS) to be
1377	recorded. Frames with a higher frequency will be skipped. Reducing this
1378	value increases the number of skipped frames and reduces the file size.</para>
1379	</listitem>
1380	<listitem>
1381	<para><computeroutput>--videocapmaxtime <ms></computeroutput>:
1382	This option sets the maximum time in milliseconds the video capturing
1383	will be enabled since activation. The capturing stops when the defined
1384	time interval has elapsed. If this value is zero the capturing is not
1385	limited by time.</para>
1386	</listitem>
1387	<listitem>
1388	<para><computeroutput>--videocapmaxsize <MB></computeroutput>:
1389	This option limits the maximum size of the captured video file (in MB).
1390	The capturing stops when the file size has reached the specified size. If
1391	this value is zero the capturing will not be limited by file size.</para>
1392	</listitem>
1393	<listitem>
1394	<para><computeroutput>--videocapopts <key=value>
1395	[,<key=value> ...]</computeroutput>:
1396	This format can be used to specify additional video capturing options.
1397	These options only are for advanced users and must be specified in a
1398	comma-separated key=value format, e.g.
1399	<computeroutput>foo=bar,a=b</computeroutput>.
1400	</para>
1401	</listitem>
1402	</itemizedlist></para>
1403
1404	</sect2>
1405
1406	<sect2 id="vboxmanage-modifyvm-vrde">
1407	<title>Remote machine settings</title>
1408
1409	<para>The following settings that affect remote machine behavior are
1410	available through <computeroutput>VBoxManage
1411	modifyvm</computeroutput>:<itemizedlist>
1412	<listitem>
1413	<para><computeroutput>--vrde on\|off</computeroutput>:
1414	This enables or disables the VirtualBox remote desktop extension
1415	(VRDE) server.</para>
1416	</listitem>
1417
1418	<listitem>
1419	<para><computeroutput>--vrdeproperty "TCP/Ports\|Address=<value>"</computeroutput>
1420	sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para>
1421
1422	<itemizedlist>
1423	<listitem>
1424	<para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE
1425	server can bind to; "default" or "0" means port 3389, the standard port for RDP.
1426	For details, see the description for the
1427	<computeroutput>--vrdeport</computeroutput> option in <xref
1428	linkend="vboxmanage-modifyvm-vrde" />.</para>
1429	</listitem>
1430
1431	<listitem>
1432	<para>For TCP/Address, <value> should be the IP address of the host network
1433	interface that the VRDE server will bind to. If specified, the server
1434	will accept connections only on the specified host network interface.
1435	For details, see the description for the
1436	<computeroutput>--vrdeaddress</computeroutput> option in <xref
1437	linkend="vboxmanage-modifyvm-vrde" />.</para>
1438	</listitem>
1439	</itemizedlist>
1440	</listitem>
1441
1442	<listitem>
1443	<para><computeroutput>--vrdeproperty "VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>
1444	sets the VRDP video redirection properties.</para>
1445	<itemizedlist>
1446	<listitem>
1447	<para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on.
1448	For details, see <xref linkend="vrde-videochannel" />.</para>
1449	</listitem>
1450
1451	<listitem>
1452	<para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive,
1453	representing a JPEG compression level on the VRDE server video channel. Lower values mean lower
1454	quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para>
1455	</listitem>
1456
1457	<listitem>
1458	<para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to
1459	enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer
1460	size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale
1461	threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled.
1462	When the downscale protection feature is disabled, an attempt is always made to display videos.</para>
1463	</listitem>
1464	</itemizedlist>
1465	</listitem>
1466
1467	<listitem>
1468	<para><computeroutput>--vrdeproperty "Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput></para>
1469	<para>disables one of the VRDE server features: Display, Input, Audio or USB respectively.
1470	To re-enable a feature, use e.g. "Client/DisableDisplay=".
1471	For details, see <xref linkend="vrde-customization" />.</para>
1472	</listitem>
1473
1474	<listitem>
1475	<para><computeroutput>--vrdeproperty "Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput></para>
1476	<para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively.
1477	To re-enable a feature, use e.g. "Client/DisableClipboard=".
1478	For details, see <xref linkend="vrde-customization" />.</para>
1479	</listitem>
1480
1481	<listitem>
1482	<para><computeroutput>--vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para>
1483	<para>disables the VRDE server feature: RDP device redirection for smart cards.
1484	To re-enable this feature, use "Client/DisableRDPR=".</para>
1485	</listitem>
1486
1487	<listitem>
1488	<para><computeroutput>--vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para>
1489	<para>enables the VRDE server feature: 3D redirection.
1490	To re-disable this feature, use "H3DRedirect/Enabled=".</para>
1491	</listitem>
1492
1493	<listitem>
1494	<para><computeroutput>--vrdeproperty "Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>
1495	sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection.
1496
1497	<itemizedlist>
1498	<listitem>
1499	<para><computeroutput>--vrdeproperty "Security/Method=<value>"</computeroutput>
1500	sets the desired security method, which is used for a connection. Valid values are:
1501	<itemizedlist>
1502	<listitem>
1503	<para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS)
1504	and Standard RDP Security connections are allowed. The security
1505	method is negotiated with the client. This is the default setting.</para>
1506	</listitem>
1507	<listitem>
1508	<para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para>
1509	</listitem>
1510	<listitem>
1511	<para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted.
1512	The client must support TLS.</para>
1513	</listitem>
1514	</itemizedlist>
1515	For details, see <xref linkend="vrde-crypt" />.</para>
1516	</listitem>
1517
1518	<listitem>
1519	<para><computeroutput>--vrdeproperty "Security/ServerCertificate=<value>"</computeroutput>
1520	where <value> is the absolute path of the server certificate.
1521	For details, see <xref linkend="vrde-crypt" />.</para>
1522	</listitem>
1523
1524	<listitem>
1525	<para><computeroutput>--vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput>
1526	where <value> is the absolute path of the server private key.
1527	For details, see <xref linkend="vrde-crypt" />.</para>
1528	</listitem>
1529
1530	<listitem>
1531	<para><computeroutput>--vrdeproperty "Security/CACertificate=<value>"</computeroutput>
1532	where <value> is the absolute path of the CA self signed certificate.
1533	For details, see <xref linkend="vrde-crypt" />.</para>
1534	</listitem>
1535	</itemizedlist></para>
1536	</listitem>
1537
1538	<listitem>
1539	<para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>
1540	sets the Audio connection mode, or Path of the audio logfile.
1541
1542	<itemizedlist>
1543	<listitem>
1544	<para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput>
1545	where <value> is the desired rate correction mode, allowed values are:
1546	<itemizedlist>
1547	<listitem>
1548	<para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para>
1549	</listitem>
1550	<listitem>
1551	<para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para>
1552	</listitem>
1553	<listitem>
1554	<para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para>
1555	</listitem>
1556	<listitem>
1557	<para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para>
1558	</listitem>
1559	</itemizedlist></para>
1560	</listitem>
1561	<listitem>
1562	<para><computeroutput>--vrdeproperty "Audio/LogPath=<value>"</computeroutput>
1563	where <value> is the absolute path of the Audio log file.</para>
1564	</listitem>
1565	</itemizedlist></para>
1566	</listitem>
1567
1568	<listitem>
1569	<para><computeroutput>--vrdeextpack default\|<name></computeroutput>:
1570	Allows to specify the library to use for to access the VM
1571	remotely. The default is to use the RDP code which is part of the
1572	Oracle VM VirtualBox Extension Pack.</para>
1573	</listitem>
1574
1575	<listitem>
1576	<para><computeroutput>--vrdeport
1577	default\|<ports></computeroutput>: A port or a range of ports
1578	the VRDE server can bind to; "default" or "0" means port 3389, the
1579	standard port for RDP. You can specify a comma-separated list of
1580	ports or ranges of ports. Use a dash between two port numbers to
1581	specify a range. The VRDE server will bind to <emphasis
1582	role="bold">one</emphasis> of available ports from the specified
1583	list. Only one machine can use a given port at a time. For
1584	example, the option <computeroutput> --vrdeport
1585	5000,5010-5012</computeroutput> will tell the server to bind to
1586	one of following ports: 5000, 5010, 5011 or 5012.</para>
1587	</listitem>
1588
1589	<listitem>
1590	<para><computeroutput>--vrdeaddress <IP
1591	address></computeroutput>: The IP address of the host network
1592	interface the VRDE server will bind to. If specified, the server
1593	will accept connections only on the specified host network
1594	interface.</para>
1595	<para>The setting can be used to specify whether the VRDP server
1596	should accept either IPv4 or IPv6 or both connections:
1597	<itemizedlist>
1598	<listitem>
1599	<para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"
1600	</computeroutput></para>
1601	</listitem>
1602	<listitem>
1603	<para>only IPv6: <computeroutput>--vrdeaddress "::"
1604	</computeroutput></para>
1605	</listitem>
1606	<listitem>
1607	<para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress ""
1608	</computeroutput></para>
1609	</listitem>
1610	</itemizedlist></para>
1611	</listitem>
1612
1613	<listitem>
1614	<para><computeroutput>--vrdeauthtype
1615	null\|external\|guest</computeroutput>: This allows you to choose
1616	whether and how authorization will be performed; see <xref
1617	linkend="vbox-auth" /> for details.</para>
1618	</listitem>
1619
1620	<listitem>
1621	<para><computeroutput>--vrdeauthlibrary
1622	default\|<name></computeroutput>: This allos to set the
1623	library used for RDP authentication, see <xref lang=""
1624	linkend="vbox-auth" /> for details.</para>
1625	</listitem>
1626
1627	<listitem>
1628	<para><computeroutput>--vrdemulticon on\|off</computeroutput>: This
1629	enables multiple connections to the same VRDE server, if the
1630	server supports this feature; see <xref lang=""
1631	linkend="vrde-multiconnection" />.</para>
1632	</listitem>
1633
1634	<listitem>
1635	<para><computeroutput>--vrdereusecon on\|off</computeroutput>: This
1636	specifies the VRDE server behavior when multiple connections are
1637	disabled. When this option is enabled, the server will allow a new
1638	client to connect and will drop the existing connection. When this
1639	option is disabled (this is the default setting), a new connection
1640	will not be accepted if there is already a client connected to the
1641	server.</para>
1642	</listitem>
1643
1644	<listitem>
1645	<para><computeroutput>--vrdevideochannel on\|off</computeroutput>:
1646	This enables video redirection, if it is supported by the VRDE
1647	server; see <xref lang="" linkend="vrde-videochannel" />.</para>
1648	</listitem>
1649
1650	<listitem>
1651	<para><computeroutput>--vrdevideochannelquality
1652	<percent></computeroutput>: Sets the image quality for video
1653	redirection; see <xref lang=""
1654	linkend="vrde-videochannel" />.</para>
1655	</listitem>
1656	</itemizedlist></para>
1657	</sect2>
1658
1659	<sect2 id="vboxmanage-modifyvm-teleport">
1660	<title>Teleporting settings</title>
1661
1662	<para>With the following commands for <computeroutput>VBoxManage
1663	modifyvm</computeroutput> you can configure a machine to be a target for
1664	teleporting. See <xref linkend="teleporting" /> for an
1665	introduction.<itemizedlist>
1666	<listitem>
1667	<para><computeroutput>--teleporter on\|off</computeroutput>: With
1668	this setting you turn on or off whether a machine waits for a
1669	teleporting request to come in on the network when it is started.
1670	If "on", when the machine is started, it does not boot the virtual
1671	machine as it would normally; instead, it then waits for a
1672	teleporting request to come in on the port and address listed with
1673	the next two parameters.</para>
1674	</listitem>
1675
1676	<listitem>
1677	<para><computeroutput>--teleporterport
1678	<port></computeroutput>, <computeroutput>--teleporteraddress
1679	<address></computeroutput>: these must be used with
1680	--teleporter and tell the virtual machine on which port and
1681	address it should listen for a teleporting request from another
1682	virtual machine. <computeroutput><port></computeroutput> can
1683	be any free TCP/IP port number (e.g. 6000);
1684	<computeroutput><address></computeroutput> can be any IP
1685	address or hostname and specifies the TCP/IP socket to bind to.
1686	The default is "0.0.0.0", which means any address.</para>
1687	</listitem>
1688
1689	<listitem>
1690	<para><computeroutput>--teleporterpassword
1691	<password></computeroutput>: if this optional argument is
1692	given, then the teleporting request will only succeed if the
1693	source machine specifies the same password as the one given with
1694	this command.</para>
1695	</listitem>
1696
1697	<listitem>
1698	<para><computeroutput>--teleporterpasswordfile
1699	<password></computeroutput>: if this optional argument is
1700	given, then the teleporting request will only succeed if the
1701	source machine specifies the same password as the one specified
1702	in the file give with this command. Use <computeroutput>stdin</computeroutput>
1703	to read the password from stdin.</para>
1704	</listitem>
1705
1706	<listitem>
1707	<para><computeroutput>--cpuid <leaf> <eax> <ebx>
1708	<ecx> <edx></computeroutput>: Advanced users can use
1709	this command before a teleporting operation to restrict the
1710	virtual CPU capabilities that VirtualBox presents to the guest
1711	operating system. This must be run on both the source and the
1712	target machines involved in the teleporting and will then modify
1713	what the guest sees when it executes the
1714	<computeroutput>CPUID</computeroutput> machine instruction. This
1715	might help with misbehaving applications that wrongly assume that
1716	certain CPU capabilities are present. The meaning of the
1717	parameters is hardware dependent; please refer to the AMD or Intel
1718	processor manuals.</para>
1719	</listitem>
1720	</itemizedlist></para>
1721	</sect2>
1722
1723	<sect2 id="vboxmanage-modifyvm-debugging">
1724	<title>Debugging settings</title>
1725
1726	<para>The following settings are only relevant for low-level VM
1727	debugging. Regular users will never need these settings.<itemizedlist>
1728	<listitem>
1729	<para><computeroutput>--tracing-enabled on\|off</computeroutput>:
1730	Enable the tracebuffer. This consumes some memory for the tracebuffer
1731	and adds extra overhead.</para>
1732	</listitem>
1733	<listitem>
1734	<para><computeroutput>--tracing-config <config-string></computeroutput>:
1735	Allows to configure tracing. In particular this defines which group of
1736	tracepoints are enabled.</para>
1737	</listitem>
1738	<listitem>
1739	<para><computeroutput>--tracing-allow-vm-access on\|off</computeroutput>:
1740	Enables/disables(default) VM access to the tracebuffer.</para>
1741	</listitem>
1742	</itemizedlist>
1743	</para>
1744	</sect2>
1745
1746	<sect2 id="vboxmanage-usbcardreader">
1747	<title>USB card reader settings</title>
1748
1749	<para>The following setting defines access to a USB Card Reader by the guest environment.
1750	USB card readers are typically used for accessing data on memory cards such as
1751	CompactFlash (CF), Secure Digital (SD) or MultiMediaCard (MMC).</para>
1752	<itemizedlist>
1753	<listitem>
1754	<para><computeroutput>--usbcardreader on\|off</computeroutput>:
1755	Enables/disables the USB card reader interface.</para>
1756	</listitem>
1757	</itemizedlist>
1758	</sect2>
1759
1760	<sect2 id="vboxmanage-autostart">
1761	<title>Auto starting VMs during host system boot</title>
1762
1763	<para>These settings configure the VM autostart feature,
1764	which automatically starts the VM at host system boot-up.
1765	Note that there are pre-requisites that need to be addressed before using this feature.
1766	See <xref lang="" linkend="autostart" /> for more details.</para>
1767	<itemizedlist>
1768	<listitem>
1769	<para><computeroutput>--autostart on\|off</computeroutput>:
1770	Enables/disables VM autostart at host system boot-up, using specified user name.</para>
1771	</listitem>
1772	<listitem>
1773	<para><computeroutput>--autostart-delay <seconds></computeroutput>:
1774	Specifies a delay (seconds) following host system boot-up, before VM autostarts.</para>
1775	</listitem>
1776	</itemizedlist>
1777	</sect2>
1778	</sect1>
1779
1780	<sect1 id="vboxmanage-clonevm">
1781	<title>VBoxManage clonevm</title>
1782
1783	<para>This command creates a full or linked copy of an existing virtual
1784	machine.</para>
1785
1786	<para>The <computeroutput>clonevm</computeroutput> subcommand takes at
1787	least the name of the virtual machine which should be cloned. The following
1788	additional settings can be used to further configure the clone VM
1789	operation:</para>
1790
1791	<itemizedlist>
1792	<listitem>
1793	<para><computeroutput>--snapshot <uuid>\|<name></computeroutput>:
1794	Select a specific snapshot where the clone operation should refer
1795	to. Default is referring to the current state.</para>
1796	</listitem>
1797	<listitem>
1798	<para><computeroutput>--mode machine\|machineandchildren\|all</computeroutput>:
1799	Selects the cloning mode of the operation. If
1800	<computeroutput>machine</computeroutput> is selected (the default),
1801	the current state of the VM without any snapshots is cloned. In the
1802	<computeroutput>machineandchildren</computeroutput> mode the snapshot
1803	provided by <computeroutput>--snapshot</computeroutput> and all
1804	child snapshots are cloned. If <computeroutput>all</computeroutput>
1805	is the selected mode all snapshots and the current state are cloned.
1806	</para>
1807	</listitem>
1808	<listitem>
1809	<para><computeroutput>--options link\|keepallmacs\|keepnatmacs\|keepdisknames</computeroutput>:
1810	Allows additional fine tuning of the clone operation. The first
1811	option defines that a linked clone should be created, which is
1812	only possible for a machine clone from a snapshot. The next two
1813	options allow to define how the MAC addresses of every virtual
1814	network card should be handled. They can either be reinitialized
1815	(the default), left unchanged
1816	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
1817	when the network type is NAT
1818	(<computeroutput>keepnatmacs</computeroutput>). If you add
1819	<computeroutput>keepdisknames</computeroutput> all new disk images
1820	are called like the original ones, otherwise they are
1821	renamed.</para>
1822	</listitem>
1823	<listitem>
1824	<para><computeroutput>--name <name></computeroutput>: Select a
1825	new name for the new virtual machine. Default is "Original Name
1826	Clone".</para>
1827	</listitem>
1828	<listitem>
1829	<para><computeroutput>--groups <group>, ...</computeroutput>
1830	Enables the clone to be assigned membership of the specified
1831	VM groups in the list. Note that group ids always start with a
1832	<computeroutput>/</computeroutput> and can be nested. By default,
1833	clones are always assigned membership of the group
1834	<computeroutput>/</computeroutput>.</para>
1835	</listitem>
1836	<listitem>
1837	<para><computeroutput>--basefolder <basefolder></computeroutput>:
1838	Select the folder where the new virtual machine configuration should
1839	be saved in.</para>
1840	</listitem>
1841	<listitem>
1842	<para><computeroutput>--uuid <uuid></computeroutput>:
1843	Select the UUID the new VM should have. This id has to be unique in
1844	the VirtualBox instance this clone should be registered. Default is
1845	creating a new UUID.</para>
1846	</listitem>
1847	<listitem>
1848	<para><computeroutput>--register</computeroutput>:
1849	Automatically register the new clone in this VirtualBox
1850	installation. If you manually want to register the new VM later, see
1851	<xref linkend="vboxmanage-registervm" /> for instructions how to do
1852	so.</para>
1853	</listitem>
1854	</itemizedlist>
1855	</sect1>
1856
1857	<sect1 id="vboxmanage-import">
1858	<title>VBoxManage import</title>
1859
1860	<para>This command imports a virtual appliance in OVF format by copying
1861	the virtual disk images and creating virtual machines in VirtualBox. See
1862	<xref linkend="ovf" /> for an introduction to appliances.</para>
1863
1864	<para>The <computeroutput>import</computeroutput> subcommand takes at
1865	least the path name of an OVF file as input and expects the disk images,
1866	if needed, in the same directory as the OVF file. A lot of additional
1867	command-line options are supported to control in detail what is being
1868	imported and modify the import parameters, but the details depend on the
1869	content of the OVF file.</para>
1870
1871	<para>It is therefore recommended to first run the import subcommand with
1872	the <computeroutput>--dry-run</computeroutput> or
1873	<computeroutput>-n</computeroutput> option. This will then print a
1874	description of the appliance's contents to the screen how it would be
1875	imported into VirtualBox, together with the optional command-line options
1876	to influence the import behavior.</para>
1877
1878	<para>Use of the <computeroutput>--options link\|keepallmacs\|keepnatmacs\|keepdisknames</computeroutput>:
1879	option enables additional fine tuning of the clone operation. The first
1880	option defines that a linked clone should be created, which is
1881	only possible for a machine clone from a snapshot. The next two
1882	options enable specification of how the MAC addresses of every virtual
1883	network card should be handled. They can either be reinitialized
1884	(the default), left unchanged
1885	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
1886	when the network type is NAT
1887	(<computeroutput>keepnatmacs</computeroutput>). If you add
1888	<computeroutput>keepdisknames</computeroutput> all new disk images
1889	are assigned the same names as the originals, otherwise they are
1890	renamed.</para>
1891
1892	<para>As an example, here is the screen output with a sample appliance
1893	containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
1894	Interpreting WindowsXp.ovf...
1895	OK.
1896	Virtual system 0:
1897	0: Suggested OS type: "WindowsXP"
1898	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1899	1: Suggested VM name "Windows XP Professional_1"
1900	(change with "--vsys 0 --vmname <name>")
1901	3: Number of CPUs: 1
1902	(change with "--vsys 0 --cpus <n>")
1903	4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
1904	5: Sound card (appliance expects "ensoniq1371", can change on import)
1905	(disable with "--vsys 0 --unit 5 --ignore")
1906	6: USB controller
1907	(disable with "--vsys 0 --unit 6 --ignore")
1908	7: Network adapter: orig bridged, config 2, extra type=bridged
1909	8: Floppy
1910	(disable with "--vsys 0 --unit 8 --ignore")
1911	9: SCSI controller, type BusLogic
1912	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
1913	disable with "--vsys 0 --unit 9 --ignore")
1914	10: IDE controller, type PIIX4
1915	(disable with "--vsys 0 --unit 10 --ignore")
1916	11: Hard disk image: source image=WindowsXp.vmdk,
1917	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
1918	(change controller with "--vsys 0 --unit 11 --controller <id>";
1919	disable with "--vsys 0 --unit 11 --ignore")</screen></para>
1920
1921	<para>As you can see, the individual configuration items are numbered, and
1922	depending on their type support different command-line options. The import
1923	subcommand can be directed to ignore many such items with a
1924	<computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
1925	X is the number of the virtual system (zero unless there are several
1926	virtual system descriptions in the appliance) and Y the item number, as
1927	printed on the screen.</para>
1928
1929	<para>In the above example, Item #1 specifies the name of the target
1930	machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
1931	respectively. Item #11 describes a hard disk image; in this case, the
1932	additional <computeroutput>--controller</computeroutput> option indicates
1933	which item the disk image should be connected to, with the default coming
1934	from the OVF file.</para>
1935
1936	<para>You can combine several items for the same virtual system behind the
1937	same <computeroutput>--vsys</computeroutput> option. For example, to
1938	import a machine as described in the OVF, but without the sound card and
1939	without the USB controller, and with the disk image connected to the IDE
1940	controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
1941	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
1942	</sect1>
1943
1944	<sect1 id="vboxmanage-export">
1945	<title>VBoxManage export</title>
1946
1947	<para>This command exports one or more virtual machines from VirtualBox
1948	into a virtual appliance in OVF format, including copying their virtual
1949	disk images to compressed VMDK. See <xref linkend="ovf" /> for an
1950	introduction to appliances.</para>
1951
1952	<para>The <computeroutput>export</computeroutput> command is simple to
1953	use: list the machine (or the machines) that you would like to export to
1954	the same OVF file and specify the target OVF file after an additional
1955	<computeroutput>--output</computeroutput> or
1956	<computeroutput>-o</computeroutput> option. Note that the directory of the
1957	target OVF file will also receive the exported disk images in the
1958	compressed VMDK format (regardless of the original format) and should have
1959	enough disk space left for them.</para>
1960
1961	<para>Beside a simple export of a given virtual machine, you can append
1962	several product information to the appliance file. Use
1963	<computeroutput>--product</computeroutput>,
1964	<computeroutput>--producturl</computeroutput>,
1965	<computeroutput>--vendor</computeroutput>,
1966	<computeroutput>--vendorurl</computeroutput>,
1967	<computeroutput>--version</computeroutput> and
1968	<computeroutput>--description</computeroutput> to specify this additional
1969	information. For legal reasons you may add a license text or the content
1970	of a license file by using the <computeroutput>--eula</computeroutput> and
1971	<computeroutput>--eulafile</computeroutput> option respectively. As with
1972	OVF import, you must use the <computeroutput>--vsys X</computeroutput>
1973	option to direct the previously mentioned options to the correct virtual
1974	machine.</para>
1975
1976	<para>For virtualization products which aren't fully compatible with the
1977	OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
1978	<computeroutput>--legacy09</computeroutput> option. Other options are
1979	--ovf09, --ovf10, --ovf20.</para>
1980
1981	<para>To specify options controlling the exact content of the appliance
1982	file, you can use <computeroutput>--options</computeroutput> to request the
1983	creation of a manifest file (encouraged, allows detection of corrupted
1984	appliances on import), the additional export of DVD images, and the
1985	exclusion of MAC addresses. You can specify a list of options, e.g.
1986	<computeroutput>--options manifest,nomacs</computeroutput>. For details,
1987	check the help output of <computeroutput>VBoxManage export</computeroutput>.</para>
1988	</sect1>
1989
1990	<sect1 id="vboxmanage-startvm">
1991	<title>VBoxManage startvm</title>
1992
1993	<para>This command starts a virtual machine that is currently in the
1994	"Powered off" or "Saved" states.</para>
1995
1996	<para>The optional <computeroutput>--type</computeroutput> specifier
1997	determines whether the machine will be started in a window or whether the
1998	output should go through <computeroutput>VBoxHeadless</computeroutput>,
1999	with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more
2000	information. The list of types is subject to change, and it's not
2001	guaranteed that all types are accepted by any product variant.</para>
2002
2003	<para>The global or per-VM default value for the VM frontend type will be
2004	taken if the type is not explicitly specified. If none of these are set,
2005	the GUI variant will be started.</para>
2006
2007	<para>The following values are allowed:</para>
2008
2009	<glosslist>
2010	<glossentry>
2011	<glossterm><computeroutput>gui</computeroutput></glossterm>
2012
2013	<glossdef>
2014	<para>Starts a VM showing a GUI window. This is the default.</para>
2015	</glossdef>
2016	</glossentry>
2017
2018	<glossentry>
2019	<glossterm><computeroutput>headless</computeroutput></glossterm>
2020
2021	<glossdef>
2022	<para>Starts a VM without a window for remote display only.</para>
2023	</glossdef>
2024	</glossentry>
2025
2026	<glossentry>
2027	<glossterm><computeroutput>sdl</computeroutput></glossterm>
2028
2029	<glossdef>
2030	<para>Starts a VM with a minimal GUI and limited features.</para>
2031	</glossdef>
2032	</glossentry>
2033
2034	<glossentry>
2035	<glossterm><computeroutput>separate</computeroutput></glossterm>
2036
2037	<glossdef>
2038	<para>Starts a VM with detachable UI (technically it is a headless VM
2039	with user interface in a separate process). This is an experimental
2040	feature as it lacks certain functionality at the moment (e.g. 3D
2041	acceleration will not work).</para>
2042	</glossdef>
2043	</glossentry>
2044	</glosslist>
2045
2046	<note>
2047	<para>If you experience problems with starting virtual machines with
2048	particular frontends and there is no conclusive error information,
2049	consider starting virtual machines directly by running the respective
2050	front-end, as this can give additional error information.</para>
2051	</note>
2052	</sect1>
2053
2054	<sect1 id="vboxmanage-controlvm">
2055	<title>VBoxManage controlvm</title>
2056
2057	<para>The <computeroutput>controlvm</computeroutput> subcommand allows you
2058	to change the state of a virtual machine that is currently running. The
2059	following can be specified:</para>
2060
2061	<para><itemizedlist>
2062	<listitem>
2063	<para><computeroutput>VBoxManage controlvm <vm>
2064	pause</computeroutput> temporarily puts a virtual machine on hold,
2065	without changing its state for good. The VM window will be painted
2066	in gray to indicate that the VM is currently paused. (This is
2067	equivalent to selecting the "Pause" item in the "Machine" menu of
2068	the GUI).</para>
2069	</listitem>
2070
2071	<listitem>
2072	<para>Use <computeroutput>VBoxManage controlvm <vm>
2073	resume</computeroutput> to undo a previous
2074	<computeroutput>pause</computeroutput> command. (This is equivalent
2075	to selecting the "Resume" item in the "Machine" menu of the
2076	GUI.)</para>
2077	</listitem>
2078
2079	<listitem>
2080	<para><computeroutput>VBoxManage controlvm <vm>
2081	reset</computeroutput> has the same effect on a virtual machine as
2082	pressing the "Reset" button on a real computer: a cold reboot of the
2083	virtual machine, which will restart and boot the guest operating
2084	system again immediately. The state of the VM is not saved
2085	beforehand, and data may be lost. (This is equivalent to selecting
2086	the "Reset" item in the "Machine" menu of the GUI).</para>
2087	</listitem>
2088
2089	<listitem>
2090	<para><computeroutput>VBoxManage controlvm <vm>
2091	poweroff</computeroutput> has the same effect on a virtual machine
2092	as pulling the power cable on a real computer. Again, the state of
2093	the VM is not saved beforehand, and data may be lost. (This is
2094	equivalent to selecting the "Close" item in the "Machine" menu of
2095	the GUI or pressing the window's close button, and then selecting
2096	"Power off the machine" in the dialog).</para>
2097
2098	<para>After this, the VM's state will be "Powered off". From there,
2099	it can be started again; see <xref
2100	linkend="vboxmanage-startvm" />.</para>
2101	</listitem>
2102
2103	<listitem>
2104	<para><computeroutput>VBoxManage controlvm <vm>
2105	savestate</computeroutput> will save the current state of the VM to
2106	disk and then stop the VM. (This is equivalent to selecting the
2107	"Close" item in the "Machine" menu of the GUI or pressing the
2108	window's close button, and then selecting "Save the machine state"
2109	in the dialog.)</para>
2110
2111	<para>After this, the VM's state will be "Saved". From there, it can
2112	be started again; see <xref linkend="vboxmanage-startvm" />.</para>
2113	</listitem>
2114
2115	<listitem>
2116	<para><computeroutput>VBoxManage controlvm <vm>
2117	acpipowerbutton</computeroutput> will send an ACPI shutdown signal to
2118	the VM, as if the power button on a real computer had been pressed.
2119	So long as the VM is running a fairly modern guest operating system
2120	providing ACPI support, this should trigger a proper shutdown mechanism
2121	from within the VM.</para>
2122	</listitem>
2123
2124	<listitem>
2125	<para><computeroutput>VBoxManage controlvm <vm>
2126	keyboardputscancode <hex> [<hex>...]</computeroutput>
2127	Sends commands using keycodes to the VM. Keycodes are documented in the
2128	public domain, e.g. http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.</para>
2129	</listitem>
2130
2131	<listitem>
2132	<para><computeroutput>VBoxManage controlvm "VM name" teleport
2133	--hostname <name> --port <port> [--passwordfile
2134	<file> \| --password <password>]</computeroutput> makes
2135	the machine the source of a teleporting operation and initiates a
2136	teleport to the given target. See <xref linkend="teleporting" /> for
2137	an introduction. If the optional password is specified, it must match
2138	the password that was given to the
2139	<computeroutput>modifyvm</computeroutput> command for the target
2140	machine; see <xref linkend="vboxmanage-modifyvm-teleport" /> for
2141	details.</para>
2142	</listitem>
2143	</itemizedlist></para>
2144
2145	<para>A few extra options are available with
2146	<computeroutput>controlvm</computeroutput> that do not directly affect the
2147	VM's running state:</para>
2148
2149	<itemizedlist>
2150	<listitem>
2151	<para>The <computeroutput>setlinkstate<1-N></computeroutput>
2152	operation connects or disconnects virtual network cables from their
2153	network interfaces.</para>
2154	</listitem>
2155
2156	<listitem>
2157	<para><computeroutput>nic<1-N>
2158	null\|nat\|bridged\|intnet\|hostonly\|generic\|natnetwork[<devicename>]</computeroutput>: With this, you can
2159	set, for each of the VM's virtual network cards, what type of
2160	networking should be available. They can be not connected to the host
2161	(<computeroutput>null</computeroutput>), use network address
2162	translation (<computeroutput>nat</computeroutput>), bridged networking
2163	(<computeroutput>bridged</computeroutput>) or communicate with other
2164	virtual machines using internal networking
2165	(<computeroutput>intnet</computeroutput>) or host-only networking
2166	(<computeroutput>hostonly</computeroutput>) or natnetwork networking
2167	(<computeroutput>natnetwork</computeroutput>) or access to rarely used
2168	sub-modes
2169	(<computeroutput>generic</computeroutput>).
2170	These options correspond to the modes which are described in detail in <xref
2171	linkend="networkingmodes" />.</para>
2172	</listitem>
2173
2174	<listitem>
2175	<para>With the "nictrace" options, you can optionally trace
2176	network traffic by dumping it to a file, for debugging
2177	purposes.</para>
2178
2179	<para>With <computeroutput>nictrace<1-N>
2180	on\|off</computeroutput>, you can enable network tracing for a
2181	particular virtual network card.</para>
2182
2183	<para>If enabled, you must specify with
2184	<computeroutput>--nictracefile<1-N>
2185	<filename></computeroutput> what file the trace should be
2186	logged to.</para>
2187	</listitem>
2188
2189	<listitem>
2190	<para><computeroutput>nicpromisc<1-N>
2191	deny\|allow-vms\|allow-all</computeroutput>:
2192	This allows you, for each of the VM's virtual network cards, to
2193	specify how the promiscious mode is handled. This setting is only
2194	relevant for bridged networking.
2195	<computeroutput>deny</computeroutput> (default setting) hides
2196	any traffic not intended for this VM.
2197	<computeroutput>allow-vms</computeroutput> hides all host
2198	traffic from this VM but allows the VM to see traffic from/to other
2199	VMs.
2200	<computeroutput>allow-all</computeroutput> removes this
2201	restriction completely.</para>
2202	</listitem>
2203
2204	<listitem>
2205	<para><computeroutput>nicproperty<1-N>
2206	<paramname>="paramvalue"</computeroutput>:
2207	This option, in combination with "nicgenericdrv" allows you to
2208	pass parameters to rarely-used network backends.</para><para>
2209	Those parameters are backend engine-specific, and are different
2210	between UDP Tunnel and the VDE backend drivers. For example,
2211	please see <xref linkend="network_udp_tunnel" />.
2212	</para>
2213	</listitem>
2214
2215	<listitem>
2216	<para><computeroutput>natpf<1-N>
2217	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
2218	<guestport></computeroutput>: This option defines a NAT
2219	port-forwarding rule (please see <xref linkend="natforward"/>
2220	for details).
2221	</para>
2222	</listitem>
2223
2224	<listitem>
2225	<para><computeroutput>natpf<1-N> delete
2226	<name></computeroutput>: This option deletes a NAT
2227	port-forwarding rule (please see <xref linkend="natforward"/>
2228	for details).</para>
2229	</listitem>
2230
2231	<listitem>
2232	<para>The <computeroutput>guestmemoryballoon<balloon size in MB></computeroutput>
2233	operation changes the size of the guest memory balloon, that is,
2234	memory allocated by the VirtualBox Guest Additions from the guest
2235	operating system and returned to the hypervisor for re-use by other
2236	virtual machines. This must be specified in megabytes. For details,
2237	see <xref linkend="guestadd-balloon" />.</para>
2238	</listitem>
2239
2240	<listitem>
2241	<para><computeroutput>usbattach<uuid\|address> [--capturefile <filename>]</computeroutput></para>
2242	<para>and <computeroutput>usbdetach <uuid\|address> [--capturefile <filename>]</computeroutput>
2243	make host USB devices visible/invisible to the virtual machine on the fly, without the need for
2244	creating filters first. The USB devices can be specified by UUID
2245	(unique identifier) or by address on the host system. Use the --capturefile
2246	option to specify the absolute path of a file for writing activity logging data.</para>
2247
2248	<para>You can use <computeroutput>VBoxManage list
2249	usbhost</computeroutput> to locate this information.</para>
2250	</listitem>
2251
2252	<listitem>
2253	<para><computeroutput>clipboard
2254	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
2255	With this setting, you can select if and how the guest or host
2256	operating system's clipboard should be shared with the host or guest;
2257	see <xref linkend="generalsettings" />. This requires that the Guest
2258	Additions be installed in the virtual machine.</para>
2259	</listitem>
2260
2261	<listitem>
2262	<para><computeroutput>draganddrop
2263	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
2264	With this setting, you can select the current drag and drop mode
2265	being used between the host and the virtual machine;
2266	see <xref linkend="guestadd-dnd" />. This requires that the Guest
2267	Additions be installed in the virtual machine.</para>
2268	</listitem>
2269
2270	<listitem>
2271	<para><computeroutput>vrde on\|off</computeroutput> lets you enable or
2272	disable the VRDE server, if it is installed.</para>
2273	</listitem>
2274
2275	<listitem>
2276	<para><computeroutput>vrdeport default\|<ports></computeroutput>
2277	changes the port or a range of ports that the VRDE server can bind to;
2278	"default" or "0" means port 3389, the standard port for RDP. For
2279	details, see the description for the
2280	<computeroutput>--vrdeport</computeroutput> option in <xref
2281	linkend="vboxmanage-modifyvm-vrde" />.</para>
2282	</listitem>
2283
2284	<listitem>
2285	<para><computeroutput>vrdeproperty "TCP/Ports\|Address=<value>"</computeroutput>
2286	sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para>
2287
2288	<itemizedlist>
2289	<listitem>
2290	<para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE
2291	server can bind to; "default" or "0" means port 3389, the standard port for RDP.
2292	For details, see the description for the
2293	<computeroutput>--vrdeport</computeroutput> option in <xref
2294	linkend="vboxmanage-modifyvm-vrde" />.</para>
2295	</listitem>
2296
2297	<listitem>
2298	<para>For TCP/Address, <value> should be the IP address of the host network
2299	interface that the VRDE server will bind to. If specified, the server
2300	will accept connections only on the specified host network interface.
2301	For details, see the description for the
2302	<computeroutput>--vrdeaddress</computeroutput> option in <xref
2303	linkend="vboxmanage-modifyvm-vrde" />.</para>
2304	</listitem>
2305	</itemizedlist>
2306	</listitem>
2307
2308	<listitem>
2309	<para><computeroutput>vrdeproperty "VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>
2310	sets the VRDP video redirection properties.</para>
2311	<itemizedlist>
2312	<listitem>
2313	<para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on.
2314	For details, see <xref linkend="vrde-videochannel" />.</para>
2315	</listitem>
2316
2317	<listitem>
2318	<para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive,
2319	representing a JPEG compression level on the VRDE server video channel. Lower values mean lower
2320	quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para>
2321	</listitem>
2322
2323	<listitem>
2324	<para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to
2325	enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer
2326	size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale
2327	threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled.
2328	When the downscale protection feature is disabled, an attempt is always made to display videos.</para>
2329	</listitem>
2330	</itemizedlist>
2331	</listitem>
2332
2333	<listitem>
2334	<para><computeroutput>vrdeproperty "Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput></para>
2335	<para>disables one of the VRDE server features: Display, Input, Audio or USB respectively.
2336	To re-enable a feature, use e.g. "Client/DisableDisplay=".
2337	For details, see <xref linkend="vrde-customization" />.</para>
2338	</listitem>
2339
2340	<listitem>
2341	<para><computeroutput>vrdeproperty "Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput></para>
2342	<para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively.
2343	To re-enable a feature, use e.g. "Client/DisableClipboard=".
2344	For details, see <xref linkend="vrde-customization" />.</para>
2345	</listitem>
2346
2347	<listitem>
2348	<para><computeroutput>vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para>
2349	<para>disables the VRDE server feature: RDP device redirection for smart cards.
2350	To re-enable this feature, use "Client/DisableRDPR=".</para>
2351	</listitem>
2352
2353	<listitem>
2354	<para><computeroutput>vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para>
2355	<para>enables the VRDE server feature: 3D redirection.
2356	To re-disable this feature, use "H3DRedirect/Enabled=".</para>
2357	</listitem>
2358
2359	<listitem>
2360	<para><computeroutput>vrdeproperty "Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>
2361	sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection.
2362
2363	<itemizedlist>
2364	<listitem>
2365	<para><computeroutput>vrdeproperty "Security/Method=<value>"</computeroutput>
2366	sets the desired security method, which is used for a connection. Valid values are:
2367	<itemizedlist>
2368	<listitem>
2369	<para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS)
2370	and Standard RDP Security connections are allowed. The security
2371	method is negotiated with the client. This is the default setting.</para>
2372	</listitem>
2373	<listitem>
2374	<para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para>
2375	</listitem>
2376	<listitem>
2377	<para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted.
2378	The client must support TLS.</para>
2379	</listitem>
2380	</itemizedlist>
2381	For details, see <xref linkend="vrde-crypt" />.</para>
2382	</listitem>
2383
2384	<listitem>
2385	<para><computeroutput>vrdeproperty "Security/ServerCertificate=<value>"</computeroutput>
2386	where <value> is the absolute path of the server certificate.
2387	For details, see <xref linkend="vrde-crypt" />.</para>
2388	</listitem>
2389
2390	<listitem>
2391	<para><computeroutput>vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput>
2392	where <value> is the absolute path of the server private key.
2393	For details, see <xref linkend="vrde-crypt" />.</para>
2394	</listitem>
2395
2396	<listitem>
2397	<para><computeroutput>vrdeproperty "Security/CACertificate=<value>"</computeroutput>
2398	where <value> is the absolute path of the CA self signed certificate.
2399	For details, see <xref linkend="vrde-crypt" />.</para>
2400	</listitem>
2401	</itemizedlist></para>
2402	</listitem>
2403
2404	<listitem>
2405	<para><computeroutput>vrdeproperty "Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>
2406	sets the Audio connection mode, or Path of the audio logfile.
2407
2408	<itemizedlist>
2409	<listitem>
2410	<para><computeroutput>vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput>
2411	where <value> is the desired rate correction mode, allowed values are:
2412	<itemizedlist>
2413	<listitem>
2414	<para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para>
2415	</listitem>
2416	<listitem>
2417	<para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para>
2418	</listitem>
2419	<listitem>
2420	<para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para>
2421	</listitem>
2422	<listitem>
2423	<para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para>
2424	</listitem>
2425	</itemizedlist></para>
2426	</listitem>
2427	<listitem>
2428	<para><computeroutput>vrdeproperty "Audio/LogPath=<value>"</computeroutput>
2429	where <value> is the absolute path of the Audio log file.</para>
2430	</listitem>
2431	</itemizedlist></para>
2432	</listitem>
2433
2434	<listitem>
2435	<para><computeroutput>vrdevideochannelquality
2436	<percent></computeroutput>: Sets the image quality for video
2437	redirection; see <xref lang=""
2438	linkend="vrde-videochannel" />.</para>
2439	</listitem>
2440
2441	<listitem>
2442	<para><computeroutput>setvideomodehint</computeroutput> requests that
2443	the guest system change to a particular video mode. This requires that
2444	the Guest Additions be installed, and will not work for all guest
2445	systems.</para>
2446	</listitem>
2447
2448	<listitem>
2449	<para><computeroutput>screenshotpng</computeroutput> takes a screenshot
2450	of the guest display and saves it in PNG format.</para>
2451	</listitem>
2452
2453	<listitem>
2454	<para><computeroutput>videocap on\|off</computeroutput> enables or disables
2455	recording a VM session into a WebM/VP8 file.</para>
2456	</listitem>
2457
2458	<listitem>
2459	<para><computeroutput>videocapscreens all\|<screen ID>
2460	[<screen ID> ...]]</computeroutput> allows to specify which screens of
2461	the VM are being recorded. This setting
2462	cannot be changed while video capturing is enabled. Each screen is recorded
2463	into a separate file.</para>
2464	</listitem>
2465
2466	<listitem>
2467	<para><computeroutput>videocapfile <file></computeroutput> sets the filename
2468	VirtualBox uses to save the recorded content. This setting cannot be changed
2469	while video capturing is enabled.</para>
2470	</listitem>
2471
2472	<listitem>
2473	<para><computeroutput>videocapres <width> <height></computeroutput>
2474	sets the resolution (in pixels) of the recorded video. This setting cannot be
2475	changed while video capturing is enabled.</para>
2476	</listitem>
2477
2478	<listitem> <!-- @todo r=andy Clarify rate. -->
2479	<para><computeroutput>videocaprate <rate></computeroutput> sets the
2480	bitrate in kilobits (kb) per second. Increasing this value makes the video
2481	look better for the cost of an increased file size. This setting cannot be
2482	changed while video capturing is enabled.</para>
2483	</listitem>
2484
2485	<listitem>
2486	<para><computeroutput>videocapfps <fps></computeroutput> sets the
2487	maximum number of frames per second (FPS) to be recorded. Frames with a
2488	higher frequency will be skipped. Reducing this value increases the number
2489	of skipped frames and reduces the file size. This setting cannot be changed
2490	while video capturing is enabled.</para>
2491	</listitem>
2492
2493	<listitem> <!-- @todo r=andy Clarify time format. -->
2494	<para><computeroutput>videocapmaxtime <ms></computeroutput> sets
2495	the maximum time in milliseconds the video capturing will be enabled
2496	since activation.
2497	The capturing stops when the defined time interval has elapsed. If this
2498	value is zero the capturing is not limited by time. This setting cannot
2499	be changed while video capturing is enabled.</para>
2500	</listitem>
2501
2502	<listitem>
2503	<para><computeroutput>videocapmaxsize <MB></computeroutput> limits
2504	the maximum size of the captured video file (in MB). The capturing stops
2505	when the file size has reached the specified size. If this value is zero
2506	the capturing will not be limited by file size. This setting cannot be
2507	changed while video capturing is enabled.</para>
2508	</listitem>
2509
2510	<listitem>
2511	<para><computeroutput>videocapopts <key=value>[,<key=value> ...]</computeroutput>
2512	can be used to specify additional video capturing options. These options
2513	only are for advanced users and must be specified in a comma-separated
2514	key=value format, e.g. <computeroutput>foo=bar,a=b</computeroutput>.
2515	This setting cannot be changed while video capturing is enabled.</para>
2516	</listitem>
2517
2518	<listitem>
2519	<para>The <computeroutput>setcredentials</computeroutput> operation is
2520	used for remote logons in Windows guests. For details, please refer to
2521	<xref linkend="autologon" />.</para>
2522	</listitem>
2523
2524	<listitem>
2525	<para><computeroutput>teleport --host <name> --port <port></computeroutput>
2526	can be used to configure a VM as a target for teleporting.
2527	<name> specifies the virtual machine name. <port> specifies the port on the
2528	virtual machine which should listen for a teleporting request from another
2529	virtual machine. It can be any free TCP/IP port number (e.g. 6000);
2530	See <xref linkend="teleporting" /> for an introduction.</para>
2531	<itemizedlist>
2532	<listitem>
2533	<para><computeroutput>--maxdowntime <msec></computeroutput>:
2534	Optional - specifies the maximum downtime (milliseconds) for the
2535	teleporting target VM.</para>
2536	</listitem>
2537
2538	<listitem>
2539	<para><computeroutput>--password
2540	<password></computeroutput>:
2541	Optional - indicates that the teleporting request will only succeed if the
2542	source machine specifies the same password as the one given with
2543	this command.</para>
2544	</listitem>
2545
2546	<listitem>
2547	<para><computeroutput>--passwordfile
2548	<password file></computeroutput>:
2549	Optional - indicates that the teleporting request will only succeed if the
2550	source machine specifies the same password as the one specified
2551	in the file given with this command. Use <computeroutput>stdin</computeroutput>
2552	to read the password from stdin.</para>
2553	</listitem>
2554	</itemizedlist>
2555	</listitem>
2556
2557	<listitem>
2558	<para><computeroutput>plugcpu\|unplugcpu
2559	<id></computeroutput>: If CPU hot-plugging is enabled, this adds
2560	a virtual CPU to the virtual machines (or removes one).
2561	<computeroutput><id></computeroutput> specifies the index of
2562	the virtual CPU to be added or removed and must be a number from 0
2563	to the maximum no. of CPUs configured. CPU 0 can never be removed.</para>
2564	</listitem>
2565
2566	<listitem>
2567	<para>The <computeroutput>cpuexecutioncap
2568	<1-100></computeroutput>: This operation controls how much cpu
2569	time a virtual CPU can use. A value of 50 implies a single virtual CPU
2570	can use up to 50% of a single host CPU.</para>
2571	</listitem>
2572
2573	<listitem>
2574	<para><computeroutput>webcam
2575	attach <path\|alias> [<key=value>[;<key=value>...]]</computeroutput>: This operation
2576	attaches a webcam to a running VM. Specify the absolute path of the
2577	webcam on the host operating system, or use its alias (obtained by using the command: VBoxManage
2578	list webcams).</para>
2579
2580	<para>Note that alias '.0' means default video input device on the host operating system, '.1', '.2',
2581	etc. mean first, second, etc. video input device. The device order is host-specific.</para>
2582
2583	<para>The optional settings parameter is a ';' delimited list of name/value pairs, enabling configuration
2584	of the emulated webcam device.</para>
2585
2586	<para>The following settings are supported:</para>
2587
2588	<para>MaxFramerate (default no maximum limit) - this specifies the highest rate (frames/sec) at which
2589	video frames are sent to the guest. Higher frame rates increase CPU load, so this setting can be useful
2590	when there is a need to reduce CPU load. Its default 'value' is 'no maximum limit', thus enabling the
2591	guest to use all frame rates supported by the host webcam.</para>
2592
2593	<para>MaxPayloadTransferSize (default 3060 bytes) - this specifies the maximum number of bytes the emulated
2594	webcam can send to the guest in one buffer. The default is used by some webcams. Higher values can
2595	slightly reduce CPU load, if the guest is able to use larger buffers.
2596	Note that higher MaxPayloadTransferSize values may be not supported by some guest operating systems.</para>
2597	</listitem>
2598
2599	<listitem>
2600	<para><computeroutput>webcam
2601	detach <path\|alias></computeroutput>: This operation
2602	detaches a webcam from a running VM. Specify the absolute path of the
2603	webcam on the host, or use its alias (obtained from webcam list below).</para>
2604	<para>Note the points below relating to specific Host Operating Systems:</para>
2605
2606	<para>Windows hosts</para>
2607
2608	<para>When the webcam device is detached from the host, the emulated webcam device
2609	is automatically detached from the guest.</para>
2610
2611	<para>Mac OS X hosts</para>
2612
2613	<para>OS X version 10.7 or newer is required.</para>
2614
2615	<para>When the webcam device is detached from the host, the emulated webcam device remains
2616	attached to the guest and must be manually detached using the
2617	VBoxManage controlvm "VM name" webcam detach command.</para>
2618
2619	<para>Linux hosts</para>
2620
2621	<para>When the webcam is detached from the host, the emulated webcam device is automatically detached
2622	from the guest only if the webcam is streaming video. If the emulated webcam is inactive, it
2623	should be manually detached using the VBoxManage controlvm "VM name" webcam detach command.</para>
2624	</listitem>
2625
2626	<listitem>
2627	<para><computeroutput>webcam list</computeroutput>: This operation
2628	lists webcams attached to the running VM.
2629	The output is a list of absolute paths or aliases that were used for attaching the webcams
2630	to the VM using the 'webcam attach' command above.
2631	</para>
2632	</listitem>
2633
2634	<listitem>
2635	<para><computeroutput>addencpassword
2636	<id> <password file>\|- [--removeonsuspend <yes\|no>]</computeroutput>: This operation
2637	supplies an encrypted VM specified by <id> with the encryption password to enable a headless start.
2638	Either specify the absolute path of a password file on the host file system: <password file>, or
2639	use a '-' to instruct VBoxManage to prompt the user for the encryption password. </para>
2640
2641	<para><computeroutput>--removeonsuspend <yes\|no></computeroutput> specifies whether to remove/keep
2642	the password from/in VM memory when the VM is suspended. If the VM has been suspended and the password has
2643	been removed, the user needs to resupply the password before the VM can be resumed. This feature is useful
2644	in cases where the user doesn't want the password to be stored in VM memory, and the VM is suspended by a
2645	host suspend event.</para>
2646
2647	<para>Note: On VirtualBox versions 5.0 and later, data stored on hard disk images can be transparently
2648	encrypted for the guest. VirtualBox uses the AES algorithm in XTS mode and supports 128 or 256
2649	bit data encryption keys (DEK). The DEK is stored encrypted in the medium properties, and is
2650	decrypted during VM startup by supplying the encryption password.</para>
2651
2652	<para>The "VBoxManage encryptmedium" operation is used to create a DEK encrypted medium.
2653	See <xref linkend="diskencryption-encryption" />" for details.
2654	When starting an encrypted VM from a VirtualBox GUI app, the user will be prompted for the
2655	encryption password.</para>
2656
2657	<para>For a headless encrypted VM start, use:</para>
2658
2659	<para>VBoxManage startvm "vmname" --type headless</para>
2660
2661	<para>followed by:</para>
2662
2663	<para>VBoxManage "vmname" controlvm "vmname" addencpassword ...</para>
2664
2665	<para>to supply the encryption password required.</para>
2666	</listitem>
2667
2668	<listitem>
2669	<para><computeroutput>removeencpassword <id></computeroutput>: This operation
2670	removes encryption password authorization for password <id> for all encrypted media
2671	attached to the VM.</para>
2672	</listitem>
2673
2674	<listitem>
2675	<para><computeroutput>removeallencpasswords</computeroutput>: This operation
2676	removes encryption password authorization for all passwords for all
2677	encrypted media attached to the VM.</para>
2678	</listitem>
2679
2680	</itemizedlist>
2681	</sect1>
2682
2683	<sect1>
2684	<title>VBoxManage discardstate</title>
2685
2686	<para>This command discards the saved state of a virtual machine which is
2687	not currently running, which will cause its operating system to restart
2688	next time you start it. This is the equivalent of pulling out the power
2689	cable on a physical machine, and should be avoided if possible.</para>
2690	</sect1>
2691
2692	<sect1>
2693	<title>VBoxManage adoptstate</title>
2694
2695	<para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
2696	that is separate from the VM configuration, you can use this command to
2697	"adopt" the file. This will change the VM to saved state and when you
2698	start it, VirtualBox will attempt to restore it from the saved state file
2699	you indicated. This command should only be used in special setups.</para>
2700	</sect1>
2701
2702	<sect1>
2703	<title>VBoxManage snapshot</title>
2704
2705	<para>This command is used to control snapshots from the command line. A
2706	snapshot consists of a complete copy of the virtual machine settings,
2707	copied at the time when the snapshot was taken, and optionally a virtual
2708	machine saved state file if the snapshot was taken while the machine was
2709	running. After a snapshot has been taken, VirtualBox creates differencing
2710	hard disk for each normal hard disk associated with the machine so that
2711	when a snapshot is restored, the contents of the virtual machine's virtual
2712	hard disks can be quickly reset by simply dropping the pre-existing
2713	differencing files.</para>
2714
2715	<screen>VBoxManage snapshot <uuid\|vmname>
2716	take <name> [--description <desc>] [--live]
2717	[--uniquename Number,Timestamp,Space,Force] \|
2718	delete <uuid\|snapname> \|
2719	restore <uuid\|snapname> \|
2720	restorecurrent \|
2721	edit <uuid\|snapname>\|--current
2722	[--name <name>]
2723	[--description <desc>] \|
2724	list [--details\|--machinereadable]
2725	showvminfo <uuid\|snapname></screen>
2726
2727	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
2728	of the current state of the virtual machine. You must supply a name for
2729	the snapshot and can optionally supply a description. The new snapshot is
2730	inserted into the snapshots tree as a child of the current snapshot and
2731	then becomes the new current snapshot. The
2732	<computeroutput>--description</computeroutput> parameter allows to
2733	describe the snapshot. If <computeroutput>--live</computeroutput>
2734	is specified, the VM will not be stopped during the snapshot creation
2735	(live snapshotting).</para>
2736
2737	<para>The <computeroutput>delete</computeroutput> operation deletes a
2738	snapshot (specified by name or by UUID). This can take a while to finish
2739	since the differencing images associated with the snapshot might need to
2740	be merged with their child differencing images.</para>
2741
2742	<para>The <computeroutput>restore</computeroutput> operation will restore
2743	the given snapshot (specified by name or by UUID) by resetting the virtual
2744	machine's settings and current state to that of the snapshot. The previous
2745	current state of the machine will be lost. After this, the given snapshot
2746	becomes the new "current" snapshot so that subsequent snapshots are
2747	inserted under the snapshot from which was restored.</para>
2748
2749	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
2750	shortcut to restore the current snapshot (i.e. the snapshot from which the
2751	current state is derived). This subcommand is equivalent to using the
2752	"restore" subcommand with the name or UUID of the current snapshot, except
2753	that it avoids the extra step of determining that name or UUID.</para>
2754
2755	<para>With the <computeroutput>edit</computeroutput> operation, you can
2756	change the name or description of an existing snapshot.</para>
2757
2758	<para>The <computeroutput>list</computeroutput> operation shows all
2759	snapshots of a virtual machine.</para>
2760
2761	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
2762	can view the virtual machine settings that were stored with an existing
2763	snapshot.</para>
2764	</sect1>
2765
2766	<sect1 id="vboxmanage-closemedium">
2767	<title>VBoxManage closemedium</title>
2768
2769	<para>This commands removes a hard disk, DVD or floppy image from a
2770	VirtualBox media registry.<footnote>
2771	<para>Before VirtualBox 4.0, it was necessary to call VBoxManage
2772	openmedium before a medium could be attached to a virtual machine;
2773	that call "registered" the medium with the global VirtualBox media
2774	registry. With VirtualBox 4.0 this is no longer necessary; media are
2775	added to media registries automatically. The "closemedium" call has
2776	been retained, however, to allow for explicitly removing a medium from
2777	a registry.</para>
2778	</footnote></para>
2779
2780	<screen>VBoxManage closemedium [disk\|dvd\|floppy] <uuid\|filename>
2781	[--delete]</screen>
2782
2783	<para>Optionally, you can request that the image be deleted. You will get
2784	appropriate diagnostics that the deletion failed, however the image will
2785	become unregistered in any case.</para>
2786	</sect1>
2787
2788	<sect1 id="vboxmanage-storageattach">
2789	<title>VBoxManage storageattach</title>
2790
2791	<para>This command attaches/modifies/removes a storage medium connected to
2792	a storage controller that was previously added with the
2793	<computeroutput>storagectl</computeroutput> command (see the previous
2794	section). The syntax is as follows:</para>
2795
2796	<screen>VBoxManage storageattach <uuid\|vmname>
2797	--storagectl <name>
2798	[--port <number>]
2799	[--device <number>]
2800	[--type dvddrive\|hdd\|fdd]
2801	[--medium none\|emptydrive\|additions\|
2802	<uuid>\|<filename>\|host:<drive>\|iscsi]
2803	[--mtype normal\|writethrough\|immutable\|shareable
2804	readonly\|multiattach]
2805	[--comment <text>]
2806	[--setuuid <uuid>]
2807	[--setparentuuid <uuid>]
2808	[--passthrough on\|off]
2809	[--tempeject on\|off]
2810	[--nonrotational on\|off]
2811	[--discard on\|off]
2812	[--hotpluggable on\|off]
2813	[--bandwidthgroup name\|none]
2814	[--forceunmount]
2815	[--server <name>\|<ip>]
2816	[--target <target>]
2817	[--tport <port>]
2818	[--lun <lun>]
2819	[--encodedlun <lun>]
2820	[--username <username>]
2821	[--password <password>]
2822	[--initiator <initiator>]
2823	[--intnet]</screen>
2824
2825	<para>A number of parameters are commonly required; the ones at the end of
2826	the list are required only for iSCSI targets (see below).</para>
2827
2828	<para>The common parameters are:<glosslist>
2829	<glossentry>
2830	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
2831
2832	<glossdef>
2833	<para>The VM UUID or VM Name. Mandatory.</para>
2834	</glossdef>
2835	</glossentry>
2836
2837	<glossentry>
2838	<glossterm><computeroutput>--storagectl</computeroutput></glossterm>
2839
2840	<glossdef>
2841	<para>Name of the storage controller. Mandatory. The list of the
2842	storage controllers currently attached to a VM can be obtained
2843	with <computeroutput>VBoxManage showvminfo</computeroutput>; see
2844	<xref linkend="vboxmanage-showvminfo" />.</para>
2845	</glossdef>
2846	</glossentry>
2847
2848	<glossentry>
2849	<glossterm><computeroutput>--port</computeroutput></glossterm>
2850
2851	<glossdef>
2852	<para>The number of the storage controller's port which is to be
2853	modified. Mandatory, unless the storage controller has only a
2854	single port.</para>
2855	</glossdef>
2856	</glossentry>
2857
2858	<glossentry>
2859	<glossterm><computeroutput>--device</computeroutput></glossterm>
2860
2861	<glossdef>
2862	<para>The number of the port's device which is to be modified.
2863	Mandatory, unless the storage controller has only a single device
2864	per port.</para>
2865	</glossdef>
2866	</glossentry>
2867
2868	<glossentry>
2869	<glossterm><computeroutput>--type</computeroutput></glossterm>
2870
2871	<glossdef>
2872	<para>Define the type of the drive to which the medium is being
2873	attached/detached/modified. This argument can only be omitted if
2874	the type of medium can be determined from either the medium given
2875	with the <computeroutput>--medium</computeroutput> argument or
2876	from a previous medium attachment.</para>
2877	</glossdef>
2878	</glossentry>
2879
2880	<glossentry>
2881	<glossterm><computeroutput>--medium</computeroutput></glossterm>
2882
2883	<glossdef>
2884	<para>Specifies what is to be attached. The following values are
2885	supported:<itemizedlist>
2886	<listitem>
2887	<para>"none": Any existing device should be removed from the
2888	given slot.</para>
2889	</listitem>
2890
2891	<listitem>
2892	<para>"emptydrive": For a virtual DVD or floppy drive only,
2893	this makes the device slot behaves like a removeable drive
2894	into which no media has been inserted.</para>
2895	</listitem>
2896
2897	<listitem>
2898	<para>"additions": For a virtual DVD drive only, this
2899	attaches the <emphasis>VirtualBox Guest Additions</emphasis>
2900	image to the given device slot.</para>
2901	</listitem>
2902
2903	<listitem>
2904	<para>If a UUID is specified, it must be the UUID of a
2905	storage medium that is already known to VirtualBox (e.g.
2906	because it has been attached to another virtual machine).
2907	See <xref linkend="vboxmanage-list" /> for how to list known
2908	media. This medium is then attached to the given device
2909	slot.</para>
2910	</listitem>
2911
2912	<listitem>
2913	<para>If a filename is specified, it must be the full path
2914	of an existing disk image (ISO, RAW, VDI, VMDK or other),
2915	which is then attached to the given device slot.</para>
2916	</listitem>
2917
2918	<listitem>
2919	<para>"host:<drive>": For a virtual DVD or floppy
2920	drive only, this connects the given device slot to the
2921	specified DVD or floppy drive on the host computer.</para>
2922	</listitem>
2923
2924	<listitem>
2925	<para>"iscsi": For virtual hard disks only, this allows for
2926	specifying an iSCSI target. In this case, more parameters
2927	must be given; see below.</para>
2928	</listitem>
2929	</itemizedlist></para>
2930
2931	<para>Some of the above changes, in particular for removeable
2932	media (floppies and CDs/DVDs), can be effected while a VM is
2933	running. Others (device changes or changes in hard disk device
2934	slots) require the VM to be powered off.</para>
2935	</glossdef>
2936	</glossentry>
2937
2938	<glossentry>
2939	<glossterm><computeroutput>--mtype</computeroutput></glossterm>
2940
2941	<glossdef>
2942	<para>Defines how this medium behaves with respect to snapshots
2943	and write operations. See <xref linkend="hdimagewrites" /> for
2944	details.</para>
2945	</glossdef>
2946	</glossentry>
2947
2948	<glossentry>
2949	<glossterm><computeroutput>--comment</computeroutput></glossterm>
2950
2951	<glossdef>
2952	<para>Any description that you want to have stored with this
2953	medium (optional; for example, for an iSCSI target, "Big storage
2954	server downstairs"). This is purely descriptive and not needed for
2955	the medium to function correctly.</para>
2956	</glossdef>
2957	</glossentry>
2958
2959	<glossentry>
2960	<glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
2961
2962	<glossdef>
2963	<para>Modifies the UUID or parent UUID of a medium before
2964	attaching it to a VM. This is an expert option. Inappropriate use
2965	can make the medium unusable or lead to broken VM configurations
2966	if any other VM is referring to the same media already. The most
2967	frequently used variant is <code>--setuuid ""</code>, which assigns
2968	a new (random) UUID to an image. This is useful to resolve the
2969	duplicate UUID errors if one duplicated an image using file copy
2970	utilities.</para>
2971	</glossdef>
2972	</glossentry>
2973
2974	<glossentry>
2975	<glossterm><computeroutput>--passthrough</computeroutput></glossterm>
2976
2977	<glossdef>
2978	<para>For a virtual DVD drive only, you can enable DVD writing
2979	support (currently experimental; see <xref
2980	linkend="storage-cds" />).</para>
2981	</glossdef>
2982	</glossentry>
2983
2984	<glossentry>
2985	<glossterm><computeroutput>--tempeject</computeroutput></glossterm>
2986
2987	<glossdef>
2988	<para>For a virtual DVD drive only, you can configure the behavior
2989	for guest-triggered medium eject. If this is set to "on", the eject
2990	has only temporary effects. If the VM is powered off and restarted
2991	the originally configured medium will be still in the drive.</para>
2992	</glossdef>
2993	</glossentry>
2994
2995	<glossentry>
2996	<glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
2997
2998	<glossdef>
2999	<para>This switch allows to enable the non-rotational flag for virtual
3000	hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs
3001	and don't perform disk fragmentation on such media.</para>
3002	</glossdef>
3003	</glossentry>
3004
3005	<glossentry>
3006	<glossterm><computeroutput>--discard</computeroutput></glossterm>
3007	<glossdef>
3008	<para>This switch enables the auto-discard feature for the virtual
3009	hard disks. This specifies that a VDI image will be shrunk in response
3010	to the trim command from the guest OS. The following requirements
3011	must be met:
3012
3013	<itemizedlist>
3014	<listitem>
3015	<para>The disk format must be VDI.</para>
3016	</listitem>
3017	<listitem>
3018	<para>The size of the cleared area must be at least 1MB.</para>
3019	</listitem>
3020	<listitem>
3021	<para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized
3022	into 1MB blocks, so this will only work if the space being TRIM-med is at least
3023	a 1MB contiguous block at a 1MB boundary. On Windows, occasional defrag (with "defrag.exe /D"),
3024	or under Linux running "btrfs filesystem defrag" as a background cron job may be
3025	beneficial.</para>
3026	</listitem>
3027	</itemizedlist></para>
3028
3029	<para>Notes: the Guest OS must be configured to issue trim command, and typically this
3030	means that the guest OS is made to 'see' the disk as an SSD. Ext4 supports -o discard mount flag;
3031	OSX probably requires additional settings. Windows ought to automatically detect and
3032	support SSDs - at least in versions 7, 8 and 10. Linux exFAT driver (courtesy of Samsung)
3033	supports the trim command.</para>
3034	<para>It is unclear whether Microsoft's implementation of exFAT supports this feature, even
3035	though that file system was originally designed for flash.</para>
3036	<para>Alternatively, there are ad hoc methods to issue trim, e.g. Linux fstrim command,
3037	part of util-linux package. Earlier solutions required a user to zero out unused areas,
3038	e.g. using zerofree, and explicitly compact the disk - only possible when the VM is
3039	offline.</para>
3040	</glossdef>
3041	</glossentry>
3042
3043	<glossentry>
3044	<glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
3045
3046	<glossdef>
3047	<para>Sets the bandwidth group to use for the given device; see
3048	<xref linkend="storage-bandwidth-limit" />.</para>
3049	</glossdef>
3050	</glossentry>
3051
3052	<glossentry>
3053	<glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
3054
3055	<glossdef>
3056	<para>For a virtual DVD or floppy drive only, this forcibly
3057	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
3058	the previous one is locked down by the guest for reading. Again,
3059	see <xref linkend="storage-cds" /> for details.</para>
3060	</glossdef>
3061	</glossentry>
3062	</glosslist></para>
3063
3064	<para>When "iscsi" is used with the
3065	<computeroutput>--medium</computeroutput> parameter for iSCSI support --
3066	see <xref linkend="storage-iscsi" /> --, additional parameters must or can
3067	be used:<glosslist>
3068	<glossentry>
3069	<glossterm><computeroutput>--server</computeroutput></glossterm>
3070
3071	<glossdef>
3072	<para>The host name or IP address of the iSCSI target;
3073	required.</para>
3074	</glossdef>
3075	</glossentry>
3076
3077	<glossentry>
3078	<glossterm><computeroutput>--target</computeroutput></glossterm>
3079
3080	<glossdef>
3081	<para>Target name string. This is determined by the iSCSI target
3082	and used to identify the storage resource; required.</para>
3083	</glossdef>
3084	</glossentry>
3085
3086	<glossentry>
3087	<glossterm><computeroutput>--tport</computeroutput></glossterm>
3088
3089	<glossdef>
3090	<para>TCP/IP port number of the iSCSI service on the target
3091	(optional).</para>
3092	</glossdef>
3093	</glossentry>
3094
3095	<glossentry>
3096	<glossterm><computeroutput>--lun</computeroutput></glossterm>
3097
3098	<glossdef>
3099	<para>Logical Unit Number of the target resource (optional).
3100	Often, this value is zero.</para>
3101	</glossdef>
3102	</glossentry>
3103
3104	<glossentry>
3105	<glossterm><computeroutput>--encodedlun</computeroutput></glossterm>
3106
3107	<glossdef>
3108	<para>Hex encoded Logical Unit Number of the target resource (optional).
3109	Often, this value is zero.</para>
3110	</glossdef>
3111	</glossentry>
3112
3113	<glossentry>
3114	<glossterm><computeroutput>--username, --password</computeroutput></glossterm>
3115
3116	<glossdef>
3117	<para>Username and password (initiator secret) for target
3118	authentication, if required (optional).<note>
3119	<para>Username and password are stored without
3120	encryption (i.e. in clear text) in the XML machine
3121	configuration file if no settings password is provided.
3122	When a settings password was specified the first time,
3123	the password is stored encrypted.</para>
3124	</note></para>
3125	</glossdef>
3126	</glossentry>
3127
3128	<glossentry>
3129	<glossterm><computeroutput>--initiator</computeroutput></glossterm>
3130
3131	<glossdef>
3132	<para>iSCSI Initiator (optional). Note:</para>
3133
3134	<para>Microsoft iSCSI Initiator is a system, such as a server that attaches to an IP network and initiates requests and receives responses
3135	from an iSCSI target. The SAN components in Microsoft iSCSI Initiator are largely analogous to Fibre Channel SAN components, and
3136	they include the following:/</para>
3137
3138	<para>To transport blocks of iSCSI commands over the IP network, an iSCSI driver must be installed on the iSCSI host.
3139	An iSCSI driver is included with Microsoft iSCSI Initiator.</para>
3140
3141	<para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like
3142	standard 10/100 adapters, most gigabit adapters use a preexisting Category 5 or Category 6E cable that. Each port on the adapter is
3143	identified by a unique IP address.</para>
3144
3145	<para>An iSCSI target is any device that receives iSCSI commands. The device can be an end node, such as a storage device, or it can be an
3146	intermediate device, such as a network bridge between IP and Fibre Channel devices. Each port on the storage array controller or network
3147	bridge is identified by one or more IP addresses</para>
3148	</glossdef>
3149	</glossentry>
3150
3151	<glossentry>
3152	<glossterm><computeroutput>--intnet</computeroutput></glossterm>
3153
3154	<glossdef>
3155	<para>If specified, connect to the iSCSI target via Internal
3156	Networking. This needs further configuration which is described in
3157	<xref linkend="iscsi-intnet" />.</para>
3158	</glossdef>
3159	</glossentry>
3160	</glosslist></para>
3161	</sect1>
3162
3163	<sect1 id="vboxmanage-storagectl">
3164	<title>VBoxManage storagectl</title>
3165
3166	<para>This command attaches/modifies/removes a storage controller. After
3167	this, virtual media can be attached to the controller with the
3168	<computeroutput>storageattach</computeroutput> command (see the next
3169	section).</para>
3170
3171	<para>The syntax is as follows:</para>
3172
3173	<screen>VBoxManage storagectl <uuid\|vmname>
3174	--name <name>
3175	[--add <ide/sata/scsi/floppy>]
3176	[--controller <LsiLogic\|LSILogicSAS\|BusLogic\|
3177	IntelAhci\|PIIX3\|PIIX4\|ICH6\|I82078\|usb>]
3178	[--portcount <1-30>]
3179	[--hostiocache on\|off]
3180	[--bootable on\|off]
3181	[--rename <name>]
3182	[--remove]</screen>
3183
3184	<para>where the parameters mean: <glosslist>
3185	<glossentry>
3186	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3187
3188	<glossdef>
3189	<para>The VM UUID or VM Name. Mandatory.</para>
3190	</glossdef>
3191	</glossentry>
3192
3193	<glossentry>
3194	<glossterm><computeroutput>--name</computeroutput></glossterm>
3195
3196	<glossdef>
3197	<para>Name of the storage controller. Mandatory.</para>
3198	</glossdef>
3199	</glossentry>
3200
3201	<glossentry>
3202	<glossterm><computeroutput>--add</computeroutput></glossterm>
3203
3204	<glossdef>
3205	<para>Define the type of the system bus to which the storage
3206	controller must be connected.</para>
3207	</glossdef>
3208	</glossentry>
3209
3210	<glossentry>
3211	<glossterm><computeroutput>--controller</computeroutput></glossterm>
3212
3213	<glossdef>
3214	<para>Allows to choose the type of chipset being emulated for the
3215	given storage controller.</para>
3216	</glossdef>
3217	</glossentry>
3218
3219	<glossentry>
3220	<glossterm><computeroutput>--portcount</computeroutput></glossterm>
3221
3222	<glossdef>
3223	<para>This determines how many ports the storage controller should
3224	support.</para>
3225	</glossdef>
3226	</glossentry>
3227
3228	<glossentry>
3229	<glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
3230
3231	<glossdef>
3232	<para>Configures the use of the host I/O cache for all disk images
3233	attached to this storage controller. For details, please see <xref
3234	linkend="iocaching" />.</para>
3235	</glossdef>
3236	</glossentry>
3237
3238	<glossentry>
3239	<glossterm><computeroutput>--bootable</computeroutput></glossterm>
3240
3241	<glossdef>
3242	<para>Selects whether this controller is bootable.</para>
3243	</glossdef>
3244	</glossentry>
3245
3246	<glossentry>
3247	<glossterm><computeroutput>--rename</computeroutput></glossterm>
3248
3249	<glossdef>
3250	<para>Sets the name of the storage controller.</para>
3251	</glossdef>
3252	</glossentry>
3253
3254	<glossentry>
3255	<glossterm><computeroutput>--remove</computeroutput></glossterm>
3256
3257	<glossdef>
3258	<para>Removes the storage controller from the VM config.</para>
3259	</glossdef>
3260	</glossentry>
3261	</glosslist></para>
3262	</sect1>
3263
3264	<sect1>
3265	<title>VBoxManage bandwidthctl</title>
3266
3267	<para>This command creates/deletes/modifies/shows bandwidth groups of the given
3268	virtual machine:
3269	<screen>VBoxManage bandwidthctl <uuid\|vmname>
3270	add <name> --type disk\|network --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
3271	set <name> --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
3272	remove <name> \|
3273	list [--machinereadable]</screen></para>
3274
3275	<para>The following subcommands are available:<itemizedlist>
3276	<listitem>
3277	<para><computeroutput>add</computeroutput>, creates a new bandwidth
3278	group of given type.</para>
3279	</listitem>
3280	<listitem>
3281	<para><computeroutput>set</computeroutput>, modifies the limit for an
3282	existing bandwidth group.</para>
3283	</listitem>
3284	<listitem>
3285	<para><computeroutput>remove</computeroutput>, destroys a bandwidth
3286	group.</para>
3287	</listitem>
3288	<listitem>
3289	<para><computeroutput>list</computeroutput>, shows all bandwidth groups
3290	defined for the given VM. Use <computeroutput>--machinereadable</computeroutput>
3291	option to produce the same output, but in machine readable format. This is of the
3292	form: name="value" on a line by line basis.</para>
3293	</listitem>
3294	</itemizedlist>
3295	</para>
3296	<para>The parameters mean:<glosslist>
3297	<glossentry>
3298	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3299
3300	<glossdef>
3301	<para>The VM UUID or VM Name. Mandatory.</para>
3302	</glossdef>
3303	</glossentry>
3304
3305	<glossentry>
3306	<glossterm><computeroutput>--name</computeroutput></glossterm>
3307
3308	<glossdef>
3309	<para>Name of the bandwidth group. Mandatory.</para>
3310	</glossdef>
3311	</glossentry>
3312
3313	<glossentry>
3314	<glossterm><computeroutput>--type</computeroutput></glossterm>
3315
3316	<glossdef>
3317	<para>Type of the bandwidth group. Mandatory. Two types are
3318	supported: <computeroutput>disk</computeroutput> and
3319	<computeroutput>network</computeroutput>. See
3320	<xref linkend="storage-bandwidth-limit" /> or
3321	<xref linkend="network_bandwidth_limit" /> for a description of a
3322	particular type.</para>
3323	</glossdef>
3324	</glossentry>
3325
3326	<glossentry>
3327	<glossterm><computeroutput>--limit</computeroutput></glossterm>
3328
3329	<glossdef>
3330	<para>Specifies the limit for the given group. Can be changed
3331	while the VM is running. The default unit is megabytes per
3332	second. The unit can be changed by specifying one of the
3333	following suffixes: <computeroutput>k</computeroutput> for kilobits/s,
3334	<computeroutput>m</computeroutput> for megabits/s,
3335	<computeroutput>g</computeroutput> for gigabits/s,
3336	<computeroutput>K</computeroutput> for kilobytes/s,
3337	<computeroutput>M</computeroutput> for megabytes/s,
3338	<computeroutput>G</computeroutput> for gigabytes/s.</para>
3339	</glossdef>
3340	</glossentry>
3341	</glosslist>
3342	<note>
3343	<para>The network bandwidth limits apply only to the traffic being sent by
3344	virtual machines. The traffic being received by VMs is unlimited.</para>
3345	</note>
3346	<note>
3347	<para>To remove a bandwidth group it must not be referenced by any disks
3348	or adapters in running VM.</para>
3349	</note>
3350	</para>
3351	</sect1>
3352
3353	<sect1>
3354	<title>VBoxManage showmediuminfo</title>
3355
3356	<para>This command shows information about a medium,
3357	notably its size, its size on disk, its type and the virtual machines
3358	which use it.<note>
3359	<para>For compatibility with earlier versions of VirtualBox, the
3360	"showvdiinfo" command is also supported and mapped internally to the
3361	"showmediuminfo" command.</para>
3362	</note></para>
3363
3364	<screen>VBoxManage showmediuminfo [disk\|dvd\|floppy] <uuid\|filename></screen>
3365
3366	<para>The medium must be specified either by its UUID (if the medium
3367	is registered) or by its filename. Registered images can be listed by
3368	<computeroutput>VBoxManage list hdds</computeroutput>,
3369	<computeroutput>VBoxManage list dvds</computeroutput>,
3370	or <computeroutput>VBoxManage list floppies</computeroutput>, as appropriate.
3371	(see <xref linkend="vboxmanage-list" />
3372	for more information).</para>
3373	</sect1>
3374
3375	<sect1 id="vboxmanage-createvdi">
3376	<title>VBoxManage createhd</title>
3377
3378	<para>This command creates a new medium. The syntax is as follows:</para>
3379
3380	<screen>VBoxManage createmedium [disk\|dvd\|floppy] --filename <filename>
3381	[--size <megabytes>\|--sizebyte <bytes>]
3382	[--diffparent <uuid>\|<filename>
3383	[--format VDI\|VMDK\|VHD] (default: VDI)
3384	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
3385
3386	<para>where the parameters mean:<glosslist>
3387	<glossentry>
3388	<glossterm><computeroutput>--filename <filename></computeroutput></glossterm>
3389
3390	<glossdef>
3391	<para>Specifies a file name <filename> as an absolute path on the host file
3392	system.. Mandatory.</para>
3393	</glossdef>
3394	</glossentry>
3395
3396	<glossentry>
3397	<glossterm><computeroutput>--size <megabytes></computeroutput></glossterm>
3398
3399	<glossdef>
3400	<para><megabytes> Specifies the image capacity, in 1 MB units.
3401	Optional.</para>
3402	</glossdef>
3403	</glossentry>
3404
3405	<glossentry>
3406	<glossterm><computeroutput>--diffparent <uuid>\|<filename></computeroutput></glossterm>
3407
3408	<glossdef>
3409	<para>Specifies the differencing image parent, either as a UUID or
3410	by the absolute pathname of the file on the host file system.
3411	Useful for sharing a base box disk image among several VMs.</para>
3412	</glossdef>
3413	</glossentry>
3414
3415	<glossentry>
3416	<glossterm><computeroutput>--format VDI\|VMDK\|VHD</computeroutput></glossterm>
3417
3418	<glossdef>
3419	<para>Specifies the file format for the output file. Available
3420	options are VDI, VMDK, VHD. Default is VDI. Optional. </para>
3421	</glossdef>
3422	</glossentry>
3423
3424	<glossentry>
3425	<glossterm><computeroutput>--variant Standard,Fixed,Split2G,Stream,ESX</computeroutput></glossterm>
3426
3427	<glossdef>
3428	<para>Specifies any required file format variant(s) for the output file.
3429	It is a comma-separated list of variant flags. Not all
3430	combinations are supported, and specifying mutually incompatible
3431	flags results in an error message. Optional.</para>
3432	</glossdef>
3433	</glossentry>
3434	</glosslist> <note>
3435	<para>For compatibility with earlier versions of VirtualBox, the
3436	"createvdi" command is also supported and mapped internally to the
3437	"createmedium" command.</para>
3438	</note></para>
3439	</sect1>
3440
3441	<sect1 id="vboxmanage-modifyvdi">
3442	<title>VBoxManage modifymedium</title>
3443
3444	<para>With the <computeroutput>modifymedium</computeroutput> command, you can
3445	change the characteristics of a disk image after it has been
3446	created:<screen>VBoxManage modifymedium [disk\|dvd\|floppy] <uuid\|filename>
3447	[--type normal\|writethrough\|immutable\|shareable\|
3448	readonly\|multiattach]
3449	[--autoreset on\|off]
3450	[--property <name=[value]>]
3451	[--compact]
3452	[--resize <megabytes>\|--resizebyte <bytes>]
3453	[--move <full path to a new location></screen><note>
3454	<para>For compatibility with earlier versions of VirtualBox, the "modifyvdi" and "modifyhd"
3455	commands are also supported and mapped internally to the "modifymedium" command.</para>
3456	</note></para>
3457
3458	<para>The disk image to modify must be specified either by its UUID
3459	(if the medium is registered) or by its filename. Registered images
3460	can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
3461	(see <xref linkend="vboxmanage-list" /> for more information).
3462	A filename must be specified as valid path, either as an absolute path
3463	or as a relative path starting from the current directory.</para>
3464	<para>The following options are available:<itemizedlist>
3465	<listitem>
3466	<para>With the <computeroutput>--type</computeroutput> argument, you
3467	can change the type of an existing image between the normal,
3468	immutable, write-through and other modes; see <xref
3469	linkend="hdimagewrites" /> for details.</para>
3470	</listitem>
3471
3472	<listitem>
3473	<para>For immutable (differencing) hard disks only, the
3474	<computeroutput>--autoreset on\|off</computeroutput> option
3475	determines whether the disk is automatically reset on every VM
3476	startup (again, see <xref linkend="hdimagewrites" />). The default
3477	is "on".</para>
3478	</listitem>
3479
3480	<listitem>
3481	<para>The <computeroutput>--compact</computeroutput> option,
3482	can be used to compact disk images, i.e. remove blocks that only
3483	contains zeroes. This will shrink a dynamically allocated image
3484	again; it will reduce the <emphasis>physical</emphasis> size of the
3485	image without affecting the logical size of the virtual disk.
3486	Compaction works both for base images and for diff images created as
3487	part of a snapshot.</para>
3488
3489	<para>For this operation to be effective, it is required that free
3490	space in the guest system first be zeroed out using a suitable
3491	software tool. For Windows guests, you can use the
3492	<computeroutput>sdelete</computeroutput> tool provided by Microsoft.
3493	Execute <computeroutput>sdelete -z</computeroutput> in the guest to
3494	zero the free disk space before compressing the virtual disk
3495	image. For Linux, use the <code>zerofree</code> utility which
3496	supports ext2/ext3 filesystems. For Mac OS X guests, use the
3497	<code>diskutil secureErase freespace 0 /</code> command line
3498	from an elevated Terminal.</para>
3499
3500	<para>Please note that compacting is currently only available for
3501	VDI images. A similar effect can be achieved by zeroing out free
3502	blocks and then cloning the disk to any other dynamically allocated
3503	format. You can use this workaround until compacting is also
3504	supported for disk formats other than VDI.</para>
3505	</listitem>
3506
3507	<listitem>
3508	<para>The <computeroutput>--resize x</computeroutput> option (where x
3509	is the desired new total space in <emphasis role="bold">megabytes</emphasis>)
3510	allows you to change the capacity of an existing image; this adjusts the
3511	<emphasis>logical</emphasis> size of a virtual disk without affecting
3512	the physical size much.<footnote>
3513	<para>Image resizing was added with VirtualBox 4.0.</para>
3514	</footnote> This currently works only for VDI and VHD formats, and only
3515	for the dynamically allocated variants, and can only be used to expand
3516	(not shrink) the capacity.
3517	For example, if you originally created a 10G disk which is now full,
3518	you can use the <computeroutput>--resize 15360</computeroutput>
3519	command to change the capacity to 15G (15,360MB) without having to create a new
3520	image and copy all data from within a virtual machine. Note however that
3521	this only changes the drive capacity; you will typically next need to use
3522	a partition management tool inside the guest to adjust the main partition
3523	to fill the drive.</para><para>The <computeroutput>--resizebyte x</computeroutput>
3524	option does almost the same thing, except that x is expressed in bytes
3525	instead of megabytes.</para>
3526	</listitem>
3527
3528	<listitem>
3529	<para>The <computeroutput>--move <dest></computeroutput> option
3530	can be used to move an image to a different location <dest> on the host file system,
3531	specified by either the relative path to the current directory or absolute path.</para>
3532	</listitem>
3533	</itemizedlist></para>
3534	</sect1>
3535
3536	<sect1 id="vboxmanage-clonevdi">
3537	<title>VBoxManage clonemedium</title>
3538
3539	<para>This command duplicates a virtual disk/DVD/floppy medium to a
3540	new medium (usually an image file) with a new unique identifier (UUID).
3541	The new image can be transferred to another host system or imported into
3542	VirtualBox again using the Virtual Media Manager; see <xref linkend="vdis" />
3543	and <xref linkend="cloningvdis" />. The syntax is as follows:</para>
3544
3545	<screen>VBoxManage clonemedium [disk\|dvd\|floppy] <uuid\|inputfile> <uuid\|outputfile>
3546
3547	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
3548	[--variant Standard,Fixed,Split2G,Stream,ESX]
3549	[--existing]</screen>
3550
3551
3552	<para>The medium to clone as well as the target image must be described
3553	either by its UUIDs (if the mediums are registered) or by its filename.
3554	Registered images can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
3555	(see <xref linkend="vboxmanage-list" /> for more information).
3556	A filename must be specified as valid path, either as an absolute path or
3557	as a relative path starting from the current directory.</para>
3558	<para>The following options are available:<glosslist>
3559	<glossentry>
3560	<glossterm><computeroutput>--format</computeroutput></glossterm>
3561
3562	<glossdef>
3563	<para>Allow to choose a file format for the output file different
3564	from the file format of the input file.</para>
3565	</glossdef>
3566	</glossentry>
3567
3568	<glossentry>
3569	<glossterm><computeroutput>--variant</computeroutput></glossterm>
3570
3571	<glossdef>
3572	<para>Allow to choose a file format variant for the output file.
3573	It is a comma-separated list of variant flags. Not all
3574	combinations are supported, and specifying inconsistent flags will
3575	result in an error message.</para>
3576	</glossdef>
3577	</glossentry>
3578
3579	<glossentry>
3580	<glossterm><computeroutput>--existing</computeroutput></glossterm>
3581
3582	<glossdef>
3583	<para>Perform the clone operation to an already existing
3584	destination medium. Only the portion of the source medium which
3585	fits into the destination medium is copied. This means if the
3586	destination medium is smaller than the source only a part of it is
3587	copied, and if the destination medium is larger than the source
3588	the remaining part of the destination medium is unchanged.</para>
3589	</glossdef>
3590	</glossentry>
3591	</glosslist> <note>
3592	<para>For compatibility with earlier versions of VirtualBox, the
3593	"clonevdi" and "clonehd" commands are still supported and mapped
3594	internally to the "clonehd disk" command.</para>
3595	</note></para>
3596	</sect1>
3597
3598	<sect1 id="vboxmanage-mediumproperty">
3599	<title>VBoxManage mediumproperty</title>
3600
3601	<para>This command sets up, gets or deletes a medium property.
3602	The syntax is as follows:</para>
3603
3604	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] set <uuid\|filename>
3605	<property> <value></screen>
3606
3607
3608	<para><itemizedlist>
3609	<listitem>
3610	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3611	the type of medium: disk (hard drive), dvd or floppy.</para>
3612	</listitem>
3613
3614	<listitem>
3615	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3616	or absolute path of the medium/image to be encrypted.</para>
3617	</listitem>
3618
3619	<listitem>
3620	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3621	property.</para>
3622	</listitem>
3623
3624	<listitem>
3625	<para>Use <computeroutput><value></computeroutput> to supply the property value.</para>
3626	</listitem>
3627	</itemizedlist></para>
3628
3629	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] get <uuid\|filename>
3630	<property></screen>
3631	<para><itemizedlist>
3632	<listitem>
3633	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3634	the type of medium: disk (hard drive), dvd or floppy.</para>
3635	</listitem>
3636
3637	<listitem>
3638	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3639	or absolute path of the medium/image to be encrypted.</para>
3640	</listitem>
3641
3642	<listitem>
3643	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3644	property.</para>
3645	</listitem>
3646	</itemizedlist></para>
3647
3648	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] delete <uuid\|filename>
3649	<property></screen>
3650
3651
3652	<para><itemizedlist>
3653	<listitem>
3654	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3655	the type of medium: disk (hard drive), dvd or floppy.</para>
3656	</listitem>
3657
3658	<listitem>
3659	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3660	or absolute path of the medium/image.</para>
3661	</listitem>
3662
3663	<listitem>
3664	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3665	property.</para>
3666	</listitem>
3667	</itemizedlist></para>
3668	</sect1>
3669
3670	<sect1 id="vboxmanage-encryptmedium">
3671	<title>VBoxManage encryptmedium</title>
3672
3673	<para>This command is used to create a DEK encrypted medium/image.
3674	See <xref linkend="diskencryption-encryption" />" for details.</para>
3675
3676	<para>The syntax is as follows:</para>
3677
3678	<screen>VBoxManage encryptmedium <uuid\|filename>
3679	[--newpassword <file\|->]
3680	[--oldpassword <file\|->]
3681	[--cipher <cipher id>]
3682	[--newpasswordid <password id>]</screen>
3683
3684	<para><itemizedlist>
3685	<listitem>
3686	<para>use <computeroutput><uuid\|filename></computeroutput> to supply the
3687	uuid or absolute path of the medium/image to be encrypted.</para>
3688	</listitem>
3689
3690	<listitem>
3691	<para>Use <computeroutput>--newpassword <file\|-></computeroutput> to supply a new
3692	encryption password; either specify the absolute pathname of a password file on the host operating system,
3693	or <computeroutput>-</computeroutput> to prompt you for the password on the command line.
3694	Always use the <computeroutput>--newpasswordid</computeroutput> option with this option.</para>
3695	</listitem>
3696
3697	<listitem>
3698	<para>use <computeroutput>--oldpassword <file\|-></computeroutput> to supply any old
3699	encryption password; either specify the absolute pathname of a password file on the host operating system,
3700	or <computeroutput>-</computeroutput> to prompt you for the old password on the command line.</para>
3701
3702	<para>Use this option to gain access to an encrypted medium/image to change its password using
3703	<computeroutput>--newpassword</computeroutput> and/or change its encryption using
3704	<computeroutput>--cipher</computeroutput>.</para>
3705	</listitem>
3706
3707	<listitem>
3708	<para>Use <computeroutput>--cipher <cipher></computeroutput> to specify the cipher to use for
3709	encryption; this can be either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or
3710	<computeroutput>AES-AXTS256-PLAIN64</computeroutput>.</para>
3711
3712	<para>Use this option to change any existing encryption on the medium/image, or setup new encryption on
3713	it for the 1st time.</para>
3714	</listitem>
3715
3716	<listitem>
3717	<para>Use <computeroutput>--newpasswordid <password id></computeroutput> to supply the new password identifier.
3718	This can be freely chosen by the user, and is used for correct identification when supplying multiple
3719	passwords during VM startup.</para>
3720
3721	<para>If the user uses the same password when encrypting multiple images and also the same password identifier, the
3722	user needs to supply the password only once during VM startup.</para>
3723	</listitem>
3724	</itemizedlist></para>
3725
3726	</sect1>
3727
3728	<sect1 id="vboxmanage-checkmediumpwd">
3729
3730	<title>VBoxManage checkmediumpwd</title>
3731
3732	<para>This command is used to check the current encryption password on a DEK encrypted medium/image.
3733	See <xref linkend="diskencryption-encryption" />" for details.</para>
3734
3735	<para>The syntax is as follows:</para>
3736
3737	<screen>VBoxManage checkmediumpwd <uuid\|filename>
3738	<pwd file\|-></screen>
3739	<para><itemizedlist>
3740	<listitem>
3741	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply the uuid or absolute path of the
3742	medium/image to be checked.</para>
3743	</listitem>
3744
3745	<listitem>
3746	<para>Use <computeroutput><pwd file\|-></computeroutput> to supply the password identifier to be checked. Either
3747	specify the absolute pathname of a password file on the host operating system, or <computeroutput>-</computeroutput> to
3748	prompt you for the password on the command line.</para>
3749	</listitem>
3750	</itemizedlist></para>
3751
3752	</sect1>
3753
3754	<sect1>
3755	<title>VBoxManage convertfromraw</title>
3756
3757	<para>This command converts a raw disk image to a VirtualBox Disk Image
3758	(VDI) file. The syntax is as follows:</para>
3759
3760	<screen>VBoxManage convertfromraw <filename> <outputfile>
3761	[--format VDI\|VMDK\|VHD]
3762	[--variant Standard,Fixed,Split2G,Stream,ESX]
3763	[--uuid <uuid>]
3764	VBoxManage convertfromraw stdin <outputfile> <bytes>
3765	[--format VDI\|VMDK\|VHD]
3766	[--variant Standard,Fixed,Split2G,Stream,ESX]
3767	[--uuid <uuid>]</screen>
3768
3769	<para>where the parameters mean:<glosslist>
3770	<glossentry>
3771	<glossterm><computeroutput>--bytes</computeroutput></glossterm>
3772
3773	<glossdef>
3774	<para>The size of the image file, in bytes, provided through
3775	stdin.</para>
3776	</glossdef>
3777	</glossentry>
3778
3779	<glossentry>
3780	<glossterm><computeroutput>--format</computeroutput></glossterm>
3781
3782	<glossdef>
3783	<para>Select the disk image format to create. Default is
3784	VDI. Other options are VMDK and VHD.</para>
3785	</glossdef>
3786	</glossentry>
3787
3788	<glossentry>
3789	<glossterm><computeroutput>--variant</computeroutput></glossterm>
3790
3791	<glossdef>
3792	<para>Allow to choose a file format variant for the output file.
3793	It is a comma-separated list of variant flags. Not all
3794	combinations are supported, and specifying inconsistent flags will
3795	result in an error message.</para>
3796	</glossdef>
3797	</glossentry>
3798
3799	<glossentry>
3800	<glossterm><computeroutput>--uuid</computeroutput></glossterm>
3801
3802	<glossdef>
3803	<para>Allow to specifiy the UUID of the output file.</para>
3804	</glossdef>
3805	</glossentry>
3806	</glosslist> The second form forces VBoxManage to read the content for
3807	the disk image from standard input (useful for using that command in a
3808	pipe).</para>
3809
3810	<para><note>
3811	<para>For compatibility with earlier versions of VirtualBox, the
3812	"convertdd" command is also supported and mapped internally to the
3813	"convertfromraw" command.</para>
3814	</note></para>
3815	</sect1>
3816
3817	<sect1>
3818	<title>VBoxManage getextradata/setextradata</title>
3819
3820	<para>These commands let you attach and retrieve string data to a virtual
3821	machine or to a VirtualBox configuration (by specifying
3822	<computeroutput>global</computeroutput> instead of a virtual machine
3823	name). You must specify a key (as a text string) to associate the data
3824	with, which you can later use to retrieve it. For example:</para>
3825
3826	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
3827	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
3828
3829	<para>would associate the string "2006.01.01" with the key installdate for
3830	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
3831	could retrieve the information as follows:</para>
3832
3833	<screen>VBoxManage getextradata Fedora5 installdate</screen>
3834
3835	<para>which would return</para>
3836
3837	<screen>VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
3838	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
3839	All rights reserved.
3840
3841	Value: 2006.01.01</screen>
3842
3843	<para>You could retrieve the information for all keys as follows:</para>
3844
3845	<screen>VBoxManage getextradata Fedora5 enum</screen>
3846
3847	<para>To remove a key, the <computeroutput>setextradata</computeroutput>
3848	command must be run without specifying data (only the key), for example:
3849	</para>
3850
3851	<screen>VBoxManage setextradata Fedora5 installdate</screen>
3852
3853	</sect1>
3854
3855	<sect1 id="vboxmanage-setproperty">
3856	<title>VBoxManage setproperty</title>
3857
3858	<para>This command is used to change global settings which affect the
3859	entire VirtualBox installation. Some of these correspond to the settings
3860	in the "Global settings" dialog in the graphical user interface. The
3861	following properties are available:<glosslist>
3862	<glossentry>
3863	<glossterm><computeroutput>machinefolder</computeroutput></glossterm>
3864	<glossdef>
3865	<para>This specifies the default folder in which virtual machine
3866	definitions are kept; see <xref linkend="vboxconfigdata" /> for
3867	details.</para>
3868	</glossdef>
3869	</glossentry>
3870
3871	<glossentry>
3872	<glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm>
3873	<glossdef><para>This specifies whether VirtualBox will make exclusive use of
3874	the hardware virtualization extensions (Intel VT-x or AMD-V) of the
3875	host system's processor; see <xref linkend="hwvirt" />. If you wish to
3876	share these extensions with other hypervisors running at the same time,
3877	you must disable this setting. Doing so has negative performance implications.
3878	</para></glossdef>
3879	</glossentry>
3880
3881	<glossentry>
3882	<glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
3883
3884	<glossdef>
3885	<para>This specifies which library to use when "external"
3886	authentication has been selected for a particular virtual machine;
3887	see <xref linkend="vbox-auth" /> for details.</para>
3888	</glossdef>
3889	</glossentry>
3890
3891	<glossentry>
3892	<glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
3893
3894	<glossdef>
3895	<para>This specifies which library the web service uses to
3896	authenticate users. For details about the VirtualBox web service,
3897	please refer to the separate VirtualBox SDK reference (see <xref
3898	linkend="VirtualBoxAPI" />).</para>
3899	</glossdef>
3900	</glossentry>
3901
3902	<glossentry>
3903	<glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
3904
3905	<glossdef>
3906	<para>This specifies which library implements the VirtualBox
3907	Remote Desktop Extension.</para>
3908	</glossdef>
3909	</glossentry>
3910
3911	<glossentry>
3912	<glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
3913
3914	<glossdef>
3915	<para>This selects how many rotated (old) VM logs are kept.</para>
3916	</glossdef>
3917	</glossentry>
3918
3919	<glossentry>
3920	<glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
3921
3922	<glossdef>
3923	<para>This selects the path to the autostart database. See
3924	<xref linkend="autostart" />.</para>
3925	</glossdef>
3926	</glossentry>
3927
3928	<glossentry>
3929	<glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
3930
3931	<glossdef>
3932	<para>This selects the global default VM frontend setting. See
3933	<xref linkend="vboxmanage-startvm" />.</para>
3934	</glossdef>
3935	</glossentry>
3936
3937	<glossentry>
3938	<glossterm><computeroutput>logginglevel</computeroutput></glossterm>
3939
3940	<glossdef>
3941	<para>This configures the VBoxSVC release logging details.<footnote>
3942	<para><ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>.</para>
3943	</footnote>
3944	</para>
3945	</glossdef>
3946	</glossentry>
3947	</glosslist></para>
3948	</sect1>
3949
3950	<sect1>
3951	<title>VBoxManage usbfilter add/modify/remove</title>
3952
3953	<screen>VBoxManage usbfilter add <index,0-N>
3954	--target <uuid\|vmname>global
3955	--name <string>
3956	--action ignore\|hold (global filters only)
3957	[--active yes\|no (yes)]
3958	[--vendorid <XXXX> (null)]
3959	[--productid <XXXX> (null)]
3960	[--revision <IIFF> (null)]
3961	[--manufacturer <string> (null)]
3962	[--product <string> (null)]
3963	[--remote yes\|no (null, VM filters only)]
3964	[--serialnumber <string> (null)]
3965	[--maskedinterfaces <XXXXXXXX>]
3966	</screen>
3967
3968	<screen>VBoxManage usbfilter modify <index,0-N>
3969	--target <uuid\|vmname>global
3970	[--name <string>]
3971	[--action ignore\|hold (global filters only)]
3972	[--active yes\|no]
3973	[--vendorid <XXXX>]
3974	[--productid <XXXX>]
3975	[--revision <IIFF>]
3976	[--manufacturer <string>]
3977	[--product <string>]
3978	[--remote yes\|no (null, VM filters only)]
3979	[--serialnumber <string>]
3980	[--maskedinterfaces <XXXXXXXX>]
3981	</screen>
3982
3983	<screen>VBoxManage usbfilter remove <index,0-N>
3984	--target <uuid\|vmname>global
3985	</screen>
3986
3987	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
3988	working with USB filters in virtual machines, or global filters which
3989	affect the whole VirtualBox setup. Global filters are applied before
3990	machine-specific filters, and may be used to prevent devices from being
3991	captured by any virtual machine. Global filters are always applied in a
3992	particular order, and only the first filter which fits a device is
3993	applied. So for example, if the first global filter says to hold (make
3994	available) a particular Kingston memory stick device and the second to
3995	ignore all Kingston devices, that memory stick will be available to any
3996	machine with an appropriate filter, but no other Kingston device
3997	will.</para>
3998
3999	<para>When creating a USB filter using <computeroutput>usbfilter
4000	add</computeroutput>, you must supply three or four mandatory parameters.
4001	The index specifies the position in the list at which the filter should be
4002	placed. If there is already a filter at that position, then it and the
4003	following ones will be shifted back one place. Otherwise the new filter
4004	will be added onto the end of the list. The
4005	<computeroutput>target</computeroutput> parameter selects the virtual
4006	machine that the filter should be attached to or use "global" to apply it
4007	to all virtual machines. <computeroutput>name</computeroutput> is a name
4008	for the new filter and for global filters,
4009	<computeroutput>action</computeroutput> says whether to allow VMs
4010	access to devices that fit the filter description ("hold") or not to give
4011	them access ("ignore"). In addition, you should specify parameters to
4012	filter by. You can find the parameters for devices attached to your system
4013	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
4014	you can specify whether the filter should be active, and for local
4015	filters, whether they are for local devices, remote (over an RDP
4016	connection) or either.</para>
4017
4018	<para>When you modify a USB filter using <computeroutput>usbfilter
4019	modify</computeroutput>, you must specify the filter by index (see the
4020	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
4021	find global filter indexes and that of <computeroutput>VBoxManage
4022	showvminfo</computeroutput> to find indexes for individual machines) and
4023	by target, which is either a virtual machine or "global". The properties
4024	which can be changed are the same as for <computeroutput>usbfilter
4025	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
4026	remove</computeroutput> and specify the index and the target.</para>
4027
4028	<para>The following is a list of the additional
4029	<computeroutput>usbfilter add</computeroutput> and
4030	<computeroutput>usbfilter modify</computeroutput> options, with detailed
4031	explanations on how to use them.</para>
4032
4033	<para><itemizedlist>
4034	<listitem>
4035	<para><computeroutput>--action ignore\|hold</computeroutput>Specifies
4036	whether devices that fit the filter description are allowed access by
4037	machines ("hold"), or have access denied ("ignore"). Applies to
4038	global filters only.</para>
4039	</listitem>
4040
4041	<listitem>
4042	<para><computeroutput>--active yes\|no</computeroutput>Specifies whether
4043	the USB Filter is active or temporarily disabled. For
4044	<computeroutput>usbfilter create</computeroutput> the default is
4045	active.</para>
4046	</listitem>
4047
4048	<listitem>
4049	<para><computeroutput>--vendorid <XXXX>\|""</computeroutput>Specifies
4050	a vendor ID filter - the string representation for the exact matching
4051	has the form XXXX, where X is the hex digit (including leading zeroes).</para>
4052	</listitem>
4053
4054	<listitem>
4055	<para><computeroutput>--productid <XXXX>\|""</computeroutput>Specifies
4056	a product ID filter - The string representation for the exact matching has
4057	the form XXXX, where X is the hex digit (including leading zeroes).</para>
4058	</listitem>
4059
4060	<listitem>
4061	<para><computeroutput>--revision <IIFF>\|""</computeroutput>Specifies
4062	a revision ID filter - the string representation for the exact matching has
4063	the form IIFF, where I is the decimal digit of the integer part of the revision,
4064	and F is the decimal digit of its fractional part (including leading and trailing zeros).
4065	Note that for interval filters, it's best to use the hex form, because the revision is
4066	stored as a 16 bit packed BCD value; so the expression int:0x0100-0x0199 will match
4067	any revision from 1.0 to 1.99 inclusive.</para>
4068	</listitem>
4069
4070	<listitem>
4071	<para><computeroutput>--manufacturer <string>\|""</computeroutput>Specifies
4072	a manufacturer ID filter, as a string.</para>
4073	</listitem>
4074
4075	<listitem>
4076	<para><computeroutput>--product <string>\|""</computeroutput>Specifies
4077	a product ID filter, as a string.</para>
4078	</listitem>
4079
4080	<listitem>
4081	<para><computeroutput>--remote yes\|no""</computeroutput>Specifies
4082	a remote filter - indicating whether the device is physically connected to a
4083	remote VRDE client or to a local host machine. Applies to VM filters only.</para>
4084	</listitem>
4085
4086	<listitem>
4087	<para><computeroutput>--serialnumber <string>\|""</computeroutput>Specifies
4088	a serial number filter, as a string.</para>
4089	</listitem>
4090
4091	<listitem>
4092	<para><computeroutput>--maskedinterfaces <XXXXXXXX></computeroutput>Specifies
4093	a masked interface filter, for hiding one or more USB interfaces from the guest.
4094	The value is a bit mask where the set bits correspond to the USB interfaces that
4095	should be hidden, or masked off. This feature only works on Linux hosts.</para>
4096	</listitem>
4097	</itemizedlist></para>
4098	</sect1>
4099
4100	<sect1 id="vboxmanage-sharedfolder">
4101	<title>VBoxManage sharedfolder add/remove</title>
4102
4103	<screen>
4104	VBoxManage sharedfolder add <uuid\|vmname>
4105	--name <name> --hostpath <hostpath>
4106	[--transient] [--readonly] [--automount]
4107	</screen>
4108
4109
4110	<para>This command allows you to share folders on the host computer with
4111	guest operating systems. For this, the guest systems must have a version
4112	of the VirtualBox Guest Additions installed which supports this
4113	functionality.</para>
4114
4115	<para>Parameters are:</para>
4116
4117	<para><itemizedlist>
4118	<listitem>
4119	<para><computeroutput><uuid\|vmname></computeroutput>
4120	Specifies the UUID or name of the VM whose guest operating system will be
4121	sharing folders with the host computer. Mandatory.</para>
4122	</listitem>
4123
4124	<listitem>
4125	<para><computeroutput>--name <name></computeroutput>
4126	Specifies the name of the share. Each share has a unique name within the
4127	namespace of the host operating system. Mandatory.</para>
4128	</listitem>
4129
4130	<listitem>
4131	<para><computeroutput>-hostpath <hostpath></computeroutput>
4132	Specifies the absolute path on the host operating system of the
4133	folder/directory to be shared with the guest operating system.
4134	Mandatory.</para>
4135	</listitem>
4136
4137	<listitem>
4138	<para><computeroutput>-transient</computeroutput>
4139	Specifies that the share is 'transient', meaning that it can be added
4140	and removed at runtime and does not persist after the VM has stopped.
4141	Optional.</para>
4142	</listitem>
4143
4144	<listitem>
4145	<para><computeroutput>-readonly</computeroutput>
4146	Specifies that the share has only read-only access to files at the host path.</para>
4147
4148	<para>By default, shared folders have read/write access to the files at the host
4149	path. More specifically, on Linux distros - shared folders are mounted with
4150	770 io permissions with root user and vboxsf as the group, and using this option
4151	the io permissions change to 700. Optional.</para>
4152	</listitem>
4153
4154	<listitem>
4155	<para><computeroutput>-automount</computeroutput>
4156	Specifies that the share will be automatically mounted. On Linux distros, this will
4157	be to either /media/USER/sf_<name> or /media/sf_<name> - depending on
4158	your guest OS. Where <name> is the share name. Optional.</para>
4159	</listitem>
4160	</itemizedlist></para>
4161
4162	<screen>
4163	VBoxManage sharedfolder remove <uuid\|vmname>
4164	--name <name> [--transient]
4165
4166	</screen>
4167
4168	<para>This command allows you to delete shared folders on the host computer shares with
4169	the guest operating systems. For this, the guest systems must have a version
4170	of the VirtualBox Guest Additions installed which supports this
4171	functionality.</para>
4172
4173	<para>Parameters are:</para>
4174
4175	<para><itemizedlist>
4176	<listitem>
4177	<para><computeroutput><uuid\|vmname></computeroutput>
4178	Specifies the UUID or name of the VM whose guest operating system is
4179	sharing folders with the host computer. Mandatory.</para>
4180	</listitem>
4181
4182	<listitem>
4183	<para><computeroutput>--name <name></computeroutput>
4184	Specifies the name of the share to be removed. Each share has a unique name within the
4185	namespace of the host operating system. Mandatory.</para>
4186	</listitem>
4187
4188	<listitem>
4189	<para><computeroutput>-transient</computeroutput>
4190	Specifies that the share is 'transient', meaning that it can be added
4191	and removed at runtime and does not persist after the VM has stopped.
4192	Optional.</para>
4193	</listitem>
4194	</itemizedlist></para>
4195
4196
4197	<para>Shared folders are described in detail in <xref
4198	linkend="sharedfolders" />.</para>
4199	</sect1>
4200
4201	<sect1 id="vboxmanage-guestproperty">
4202	<title>VBoxManage guestproperty</title>
4203
4204	<para>The "guestproperty" commands allow you to get or set properties of a
4205	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
4206	for an introduction. As explained there, guest properties are arbitrary
4207	key/value string pairs which can be written to and read from by either the
4208	guest or the host, so they can be used as a low-volume communication
4209	channel for strings, provided that a guest is running and has the Guest
4210	Additions installed. In addition, a number of values whose keys begin with
4211	"/VirtualBox/" are automatically set and maintained by the Guest
4212	Additions.</para>
4213
4214	<para>The following subcommands are available (where
4215	<computeroutput><vm></computeroutput>, in each case, can either be a
4216	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
4217	<listitem>
4218	<para><computeroutput>enumerate <vm> [--patterns
4219	<pattern>]</computeroutput>: This lists all the guest
4220	properties that are available for the given VM, including the value.
4221	This list will be very limited if the guest's service process cannot
4222	be contacted, e.g. because the VM is not running or the Guest
4223	Additions are not installed.</para>
4224
4225	<para>If <computeroutput>--patterns <pattern></computeroutput>
4226	is specified, it acts as a filter to only list properties that match
4227	the given pattern. The pattern can contain the following wildcard
4228	characters:<itemizedlist>
4229	<listitem>
4230	<para><computeroutput>*</computeroutput> (asterisk):
4231	represents any number of characters; for example,
4232	"<computeroutput>/VirtualBox*</computeroutput>" would match
4233	all properties beginning with "/VirtualBox".</para>
4234	</listitem>
4235
4236	<listitem>
4237	<para><computeroutput>?</computeroutput> (question mark):
4238	represents a single arbitrary character; for example,
4239	"<computeroutput>fo?</computeroutput>" would match both "foo"
4240	and "for".</para>
4241	</listitem>
4242
4243	<listitem>
4244	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
4245	used to specify multiple alternative patterns; for example,
4246	"<computeroutput>s\|t</computeroutput>" would match anything
4247	starting with either "s" or "t".</para>
4248	</listitem>
4249	</itemizedlist></para>
4250	</listitem>
4251
4252	<listitem>
4253	<para><computeroutput>get <vm> <property>
4254	</computeroutput>: This
4255	retrieves the value of a single property only. If the property
4256	cannot be found (e.g. because the guest is not running), this will
4257	print <screen>No value set!</screen></para>
4258	</listitem>
4259
4260	<listitem>
4261	<para><computeroutput>set <vm> <property> [<value>
4262	[--flags <flags>]]</computeroutput>: This allows you to set a
4263	guest property by specifying the key and value. If
4264	<computeroutput><value></computeroutput> is omitted, the
4265	property is deleted. With <computeroutput>--flags</computeroutput>
4266	you can optionally specify additional behavior (you can combine
4267	several by separating them with commas):<itemizedlist>
4268	<listitem>
4269	<para><computeroutput>TRANSIENT</computeroutput>: the value
4270	will not be stored with the VM data when the VM exits;</para>
4271	</listitem>
4272
4273	<listitem>
4274	<para><computeroutput>TRANSRESET</computeroutput>: the value
4275	will be deleted as soon as the VM restarts and/or exits;</para>
4276	</listitem>
4277
4278	<listitem>
4279	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
4280	can only be changed by the host, but the guest can only read
4281	it;</para>
4282	</listitem>
4283
4284	<listitem>
4285	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
4286	the value can only be changed by the guest, but the host can
4287	only read it;</para>
4288	</listitem>
4289
4290	<listitem>
4291	<para><computeroutput>READONLY</computeroutput>: a combination
4292	of the two, the value cannot be changed at all.</para>
4293	</listitem>
4294	</itemizedlist></para>
4295	</listitem>
4296
4297	<listitem>
4298	<para><computeroutput>wait <vm> <pattern> --timeout
4299	<timeout></computeroutput>: This waits for a particular value
4300	described by "pattern" to change or to be deleted or created. The
4301	pattern rules are the same as for the "enumerate" subcommand
4302	above.</para>
4303	</listitem>
4304
4305	<listitem>
4306	<para><computeroutput>delete <vm> <property>
4307	</computeroutput>: Deletes a formerly set guest property.
4308	</para></listitem>
4309	</itemizedlist></para>
4310	</sect1>
4311
4312	<sect1 id="vboxmanage-guestcontrol">
4313	<title>VBoxManage guestcontrol</title>
4314
4315	<para>The <computeroutput>guestcontrol</computeroutput> commands enable
4316	control of the guest from the host. Please see <xref
4317	linkend="guestadd-guestcontrol" /> for an introduction.</para>
4318
4319	<para>guestcontrol has two sets of subcommands. The first set requires guest
4320	credentials to be specified, the second does not.</para>
4321
4322	<para>The first set of subcommands is of the form:</para>
4323	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
4324	[--username <name> ]
4325	[--passwordfile <file> \| --password <password>]
4326	[--domain <domain> ]
4327	[-v\|--verbose] [-q\|quiet] ...
4328	</screen>
4329
4330	<para>The "common-options" are:</para>
4331	<screen>
4332	[--username <name> ]
4333	[--passwordfile <file> \| --password <password>]
4334	[--domain <domain> ]
4335	[-v\|--verbose] [-q\|quiet]
4336	</screen>
4337
4338	<para>Where details of the common options for the first set of subcommands are:
4339	<glosslist>
4340
4341	<glossentry>
4342	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4343	<glossdef>
4344	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4345	</glossdef>
4346	</glossentry>
4347
4348	<glossentry>
4349	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
4350	<glossdef><para>Specifies the user name on guest OS under which the process should run. This
4351	user name must already exist on the guest OS. If unspecified, the host user name is used. Optional</para>
4352	</glossdef>
4353	</glossentry>
4354
4355	<glossentry>
4356	<glossterm><computeroutput>--passwordfile <file>\|--password</computeroutput></glossterm>
4357	<glossdef><para>Specifies the absolute path on guest file system of password file containing the
4358	password for the specified user account or password for the specified user account. Optional.
4359	If both are omitted, empty password is assumed.</para></glossdef>
4360	</glossentry>
4361
4362	<glossentry>
4363	<glossterm><computeroutput>--domain <domain></computeroutput></glossterm>
4364	<glossdef><para>User domain for Windows guests. Optional.</para></glossdef>
4365	</glossentry>
4366
4367	<glossentry>
4368	<glossterm><computeroutput>-v\|--verbose</computeroutput></glossterm>
4369	<glossdef><para>Makes the subcommand execution more verbose. Optional</para></glossdef>
4370	</glossentry>
4371
4372	<glossentry>
4373	<glossterm><computeroutput>-q\|--quiet</computeroutput></glossterm>
4374	<glossdef><para>Makes the subcommand execution quieter. Optional.</para></glossdef>
4375	</glossentry>
4376	</glosslist>
4377	</para>
4378
4379	<para>The first set of subcommands: <itemizedlist>
4380	<listitem>
4381	<para><emphasis role="bold"><computeroutput>run</computeroutput></emphasis>
4382	Executes a guest program - forwarding stdout, stderr and stdin to/from the host
4383	until it completes.</para>
4384	<screen>VBoxManage guestcontrol <uuid\|vmname> run [common-options]
4385	--exe <path to executable> [--timeout <msec>]
4386	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
4387	[--ignore-operhaned-processes] [--profile]
4388	[--no-wait-stdout\|--wait-stdout]
4389	[--no-wait-stderr\|--wait-stderr]
4390	[--dos2unix] [--unix2dos]
4391	-- <program/arg0> [argument1] ... [argumentN]]
4392	</screen>
4393	<glosslist>
4394	<glossentry>
4395	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4396	<glossdef>
4397	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4398	</glossdef>
4399	</glossentry>
4400
4401	<glossentry>
4402	<glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm>
4403	<glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
4404	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.</para>
4405	</glossdef>
4406	</glossentry>
4407
4408	<glossentry>
4409	<glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
4410	<glossdef>
4411	<para>Specifies the maximum time (microseconds) that the executable can run,
4412	during which VBoxManage receives its output. Optional.
4413	If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para>
4414	</glossdef>
4415	</glossentry>
4416
4417	<glossentry>
4418	<glossterm><computeroutput>-E\|--putenv <NAME>=<VALUE>
4419	</computeroutput></glossterm>
4420	<glossdef>
4421	<para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para>
4422	<para>The guest process is created with the standard default guest OS environment.
4423	Use this option to modify that default environment. To set/modify a variable use:
4424	<computeroutput><NAME>=<VALUE></computeroutput>.
4425	To unset a variable use:
4426	<computeroutput><NAME>=</computeroutput></para>
4427	<para>Any spaces in names/values should be enclosed by quotes. </para>
4428	<para>To set/modify/unset multiple variables, use multiple instances of the
4429	<computeroutput>--E\|--putenv</computeroutput> option. </para>
4430	</glossdef>
4431	</glossentry>
4432
4433	<glossentry>
4434	<glossterm><computeroutput>--unquoted-args</computeroutput></glossterm>
4435	<glossdef>
4436	<para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para>
4437	</glossdef>
4438	</glossentry>
4439
4440	<glossentry>
4441	<glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm>
4442	<glossdef>
4443	<para>Ignore orphaned processes. Not yet implemented. Optional.</para>
4444	</glossdef>
4445	</glossentry>
4446
4447	<glossentry>
4448	<glossterm><computeroutput>--profile</computeroutput></glossterm>
4449	<glossdef>
4450	<para>Use Profile. Not yet implemented. Optional.</para>
4451	</glossdef>
4452	</glossentry>
4453
4454	<glossentry>
4455	<glossterm><computeroutput>--no-wait-stdout\|--wait-stdout</computeroutput></glossterm>
4456	<glossdef>
4457	<para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags.
4458	In the case of --wait-stdout - while the process runs, VBoxManage receives its stdout. Optional.</para>
4459	</glossdef>
4460	</glossentry>
4461
4462	<glossentry>
4463	<glossterm><computeroutput>--no-wait-stderr\|--wait-stderr</computeroutput></glossterm>
4464	<glossdef>
4465	<para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags.
4466	In case of --wait-stderr - while the process runs, VBoxManage receives its stderr. Optional.</para>
4467	</glossdef>
4468	</glossentry>
4469
4470	<glossentry>
4471	<glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
4472	<glossdef><para>
4473	Converts output from DOS/Windows guests to UNIX/Linux-compatible line endings
4474	(CR + LF → LF). Not yet implemented. Optional.</para>
4475	</glossdef>
4476	</glossentry>
4477
4478	<glossentry>
4479	<glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
4480	<glossdef><para>
4481	Converts output from a UNIX/Linux guests to DOS/Windows-compatible
4482	line endings (LF → CR + LF). Not yet implemented. Optional.</para>
4483	</glossdef>
4484	</glossentry>
4485
4486	<glossentry>
4487	<glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm>
4488	<glossdef>
4489	<para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para>
4490	<para>Note: Any spaces in arguments should be enclosed by quotes.</para>
4491	</glossdef>
4492	</glossentry>
4493	</glosslist>
4494
4495	<para><note>
4496	<para>On Windows there are certain limitations for graphical
4497	applications; please see <xref linkend="KnownIssues" /> for more
4498	information.</para>
4499	</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
4500	--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"
4501	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
4502	the double backslashes in the second example are only required on
4503	Unix hosts.</para>
4504
4505	<para><note>
4506	<para>For certain commands a user name of an existing user account on the guest
4507	must be specified; anonymous executions are not supported for security reasons. A
4508	user account password, however, is optional and depends on the guest's OS security
4509	policy or rules. If no password is specified for a given user name, an empty password
4510	will be used. On certain OSes like Windows the security policy may needs to be adjusted
4511	in order to allow user accounts with an empty password set. Also, global domain rules might
4512	apply and therefore cannot be changed.</para>
4513	</note></para>
4514
4515	<para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
4516	to serve up to 5 guest processes at a time. If a new guest process gets started
4517	which would exceed this limit, the oldest not running guest process will be discarded
4518	in order to be able to run that new process. Also, retrieving output from this
4519	old guest process will not be possible anymore then. If all 5 guest processes
4520	are still active and running, starting a new guest process will result in an
4521	appropriate error message.</para>
4522
4523	<para>To raise or lower the guest process execution limit, either the guest
4524	property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
4525	or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
4526	needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
4527	guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
4528	</listitem>
4529
4530	<listitem>
4531	<para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis>
4532	Executes a guest program until it completes.</para>
4533	<screen>VBoxManage guestcontrol <uuid\|vmname> start [common-options]
4534	[--exe <path to executable>] [--timeout <msec>]
4535	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
4536	[--ignore-operhaned-processes] [--profile]
4537	-- <program/arg0> [argument1] ... [argumentN]]
4538	</screen>
4539
4540	<para>Where the options are: <glosslist>
4541	<glossentry>
4542	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4543	<glossdef>
4544	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4545	</glossdef>
4546	</glossentry>
4547
4548	<glossentry>
4549	<glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm>
4550	<glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
4551	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
4552	</glossdef>
4553	</glossentry>
4554
4555	<glossentry>
4556	<glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
4557	<glossdef>
4558	<para>Specifies the maximum time (microseconds) that the executable can run. Optional.
4559	If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para>
4560	</glossdef>
4561	</glossentry>
4562
4563	<glossentry>
4564	<glossterm><computeroutput>-E\|--putenv <NAME>=<VALUE>
4565	</computeroutput></glossterm>
4566	<glossdef>
4567	<para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para>
4568	<para>The guest process is created with the standard default guest OS environment.
4569	Use this option to modify that default environment. To set/modify a variable use:
4570	<computeroutput><NAME>=<VALUE></computeroutput>.
4571	To unset a variable use:
4572	<computeroutput><NAME>=</computeroutput></para>
4573	<para>Any spaces in names/values should be enclosed by quotes. </para>
4574	<para>To set/modify/unset multiple variables, use multiple instances of the
4575	<computeroutput>--E\|--putenv</computeroutput> option. </para>
4576	</glossdef>
4577	</glossentry>
4578
4579	<glossentry>
4580	<glossterm><computeroutput>--unquoted-args</computeroutput></glossterm>
4581	<glossdef>
4582	<para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para>
4583	</glossdef>
4584	</glossentry>
4585
4586	<glossentry>
4587	<glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm>
4588	<glossdef>
4589	<para>Ignores orphaned processes. Not yet implemented. Optional.</para>
4590	</glossdef>
4591	</glossentry>
4592
4593	<glossentry>
4594	<glossterm><computeroutput>--profile</computeroutput></glossterm>
4595	<glossdef>
4596	<para>Use a profile. Not yet implemented. Optional.</para>
4597	</glossdef>
4598	</glossentry>
4599
4600	<glossentry>
4601	<glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm>
4602	<glossdef>
4603	<para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para>
4604	<para>Note: Any spaces in arguments should be enclosed by quotes.</para>
4605	</glossdef>
4606	</glossentry>
4607	</glosslist></para>
4608
4609	<para><note>
4610	<para>On Windows there are certain limitations for graphical
4611	applications; please see <xref linkend="KnownIssues" /> for more
4612	information.</para>
4613	</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
4614	--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"
4615	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
4616	the double backslashes in the second example are only required on
4617	Unix hosts.</para>
4618
4619	<para><note>
4620	<para>For certain commands a user name of an existing user account on the guest
4621	must be specified; anonymous executions are not supported for security reasons. A
4622	user account password, however, is optional and depends on the guest's OS security
4623	policy or rules. If no password is specified for a given user name, an empty password
4624	will be used. On certain OSes like Windows the security policy may needs to be adjusted
4625	in order to allow user accounts with an empty password set. Also, global domain rules might
4626	apply and therefore cannot be changed.</para>
4627	</note></para>
4628
4629	<para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
4630	to serve up to 5 guest processes at a time. If a new guest process gets started
4631	which would exceed this limit, the oldest not running guest process will be discarded
4632	in order to be able to run that new process. Also, retrieving output from this
4633	old guest process will not be possible anymore then. If all 5 guest processes
4634	are still active and running, starting a new guest process will result in an
4635	appropriate error message.</para>
4636
4637	<para>To raise or lower the guest process execution limit, either the guest
4638	property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
4639	or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
4640	needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
4641	guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
4642	</listitem>
4643
4644	<listitem>
4645	<para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>
4646	Copies files from the guest to the host file system.
4647	(Note - only with Guest Additions 4.0 or later installed).</para>
4648
4649	<screen>VBoxManage guestcontrol <uuid\|vmname> copyfrom [common-options]
4650	[--dryrun] [--follow] [--R\|recursive]
4651	--target-directory <host-dst-dir>
4652	<guest-src0> [<guest-src1> [...]] </screen>
4653
4654	<para>Where the parameters are:<glosslist>
4655	<glossentry>
4656	<glossterm><computeroutput><uid\|vmname></computeroutput></glossterm>
4657	<glossdef>
4658	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4659	</glossdef>
4660	</glossentry>
4661
4662	<glossentry>
4663	<glossterm><computeroutput>--dryrun</computeroutput></glossterm>
4664	<glossdef>
4665	<para>Instructs VBoxManage to perform a dry run instead of an actual file copying
4666	operation. Optional. </para>
4667	</glossdef>
4668	</glossentry>
4669
4670	<glossentry>
4671	<glossterm><computeroutput>--follow</computeroutput></glossterm>
4672	<glossdef>
4673	<para>Enables symlink following on the guest file system. Optional.</para>
4674	</glossdef>
4675	</glossentry>
4676
4677	<glossentry>
4678	<glossterm><computeroutput>-R\|--recursive</computeroutput></glossterm>
4679	<glossdef>
4680	<para>Enables recursive copying of files/directories from the specified guest file system
4681	directory. Optional.</para>
4682	</glossdef>
4683	</glossentry>
4684
4685	<glossentry>
4686	<glossterm><computeroutput>--target-directory <host-dst-dir></computeroutput></glossterm>
4687	<glossdef>
4688	<para>Specifies the absolute path of the host file system destination directory. Mandatory. e.g.
4689	<computeroutput>C:\Temp</computeroutput>.</para>
4690	</glossdef>
4691	</glossentry>
4692
4693	<glossentry>
4694	<glossterm><computeroutput><guest-src0> [<guest-src1> [...]]</computeroutput></glossterm>
4695	<glossdef>
4696	<para>Specifies the absolute path(s) of guest file system file(s) to be copied. Mandatory. e.g.
4697	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
4698	Wildcards can be used in the expression(s), e.g.
4699	<computeroutput>C:\Windows\System\.dll</computeroutput>.</para>
4700	</glossdef>
4701	</glossentry>
4702	</glosslist>
4703	</para>
4704	</listitem>
4705
4706	<listitem>
4707	<para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>
4708	Copies files from the host to the guest file system.
4709	(Note - only with Guest Additions 4.0 or later installed).</para>
4710
4711	<screen>VBoxManage guestcontrol <uuid\|vmname> copyto [common-options]
4712	[--dryrun] [--follow] [--R\|recursive]
4713	--target-directory <guest-dst>
4714	<host-src0> [<host-src1> [...]] </screen>
4715
4716	<para>Where the parameters are:<glosslist>
4717	<glossentry>
4718	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4719	<glossdef>
4720	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4721	</glossdef>
4722	</glossentry>
4723
4724	<glossentry>
4725	<glossterm><computeroutput>--dryrun</computeroutput></glossterm>
4726	<glossdef>
4727	<para>Instructs VBoxManage to perform a dry run instead of an actual file copying
4728	operation. Optional. </para>
4729	</glossdef>
4730	</glossentry>
4731
4732	<glossentry>
4733	<glossterm><computeroutput>--follow</computeroutput></glossterm>
4734	<glossdef>
4735	<para>Enables symlink following on the host file system. Optional.</para>
4736	</glossdef>
4737	</glossentry>
4738
4739	<glossentry>
4740	<glossterm><computeroutput>-R\|--recursive</computeroutput></glossterm>
4741	<glossdef>
4742	<para>Enables recursive copying of files/directories from the specified host file system
4743	directory(ies). Optional.</para>
4744	</glossdef>
4745	</glossentry>
4746
4747	<glossentry>
4748	<glossterm><computeroutput>--target-directory <guest-dst></computeroutput></glossterm>
4749	<glossdef>
4750	<para>Specifies the absolute path of the guest file system destination directory. Mandatory. e.g.
4751	<computeroutput>C:\Temp</computeroutput>.</para>
4752	</glossdef>
4753	</glossentry>
4754
4755	<glossentry>
4756	<glossterm><computeroutput><host-src0> [<host-src1> [...]]</computeroutput></glossterm>
4757	<glossdef>
4758	<para>Specifies the absolute path(s) of host file system file(s) to be copied. Mandatory. e.g.
4759	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
4760	Wildcards can be used in the expression(s), e.g.
4761	<computeroutput>C:\Windows\System\.dll</computeroutput>.</para>
4762	</glossdef>
4763	</glossentry>
4764	</glosslist>
4765	</para>
4766	</listitem>
4767
4768	<listitem>
4769	<para><emphasis role="bold"><computeroutput>md\|mkdir\|createdir\|createdirectory</computeroutput></emphasis>
4770	Creates one or more directory(ies) on the guest file system.
4771	(Note - only with Guest Additions 4.0 or later installed).</para>
4772
4773	<screen>VBoxManage guestcontrol <uuid\|vmname> md\|mkdir\|createdir\|createdirectory [common-options]
4774	[--parents] [--mode <mode>]
4775	<guest-dir0> [<guest-dir1> [...]] </screen>
4776
4777	<para>Where the parameters are: <glosslist>
4778	<glossentry>
4779	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4780	<glossdef>
4781	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4782	</glossdef>
4783	</glossentry>
4784	<glossentry>
4785	<glossterm><computeroutput>--parents</computeroutput></glossterm>
4786	<glossdef>
4787	<para>Creates any absent parent directory(ies) of the specified directory. Optional.</para>
4788	<para>e.g. If specified directory is <computeroutput>D:\Foo\Bar</computeroutput>
4789	and <computeroutput>D:\Foo</computeroutput> is absent, it will
4790	be created. In such a case, had the <computeroutput>--parents</computeroutput>
4791	option not been used, this command would have failed.</para>
4792	</glossdef>
4793	</glossentry>
4794
4795	<glossentry>
4796	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
4797	<glossdef>
4798	<para>Specifies the permission mode on the specified directory(ies) (and any parents,
4799	where <computeroutput>--parents</computeroutput> option used).
4800	Currently octal modes (e.g. <computeroutput>0755</computeroutput>) only are
4801	supported.</para>
4802	</glossdef>
4803	</glossentry>
4804
4805	<glossentry>
4806	<glossterm><computeroutput><guest-dir0> [<guest-dir1> [...]]</computeroutput></glossterm>
4807	<glossdef>
4808	<para>Specifies list of absolute path(s) of directory(ies) to be created on
4809	guest file system. Mandatory.
4810	e.g. <computeroutput>D:\Foo\Bar</computeroutput>.</para>
4811	<para>All parent directories must already exist
4812	unless switch <computeroutput>--parents</computeroutput> used.
4813	(e.g. in the above example <computeroutput>D:\Foo</computeroutput>).
4814	The specified user must have sufficient rights to create the
4815	specified directory(ies), and any parents that need
4816	to be created.</para>
4817	</glossdef>
4818	</glossentry>
4819	</glosslist>
4820	</para>
4821	</listitem>
4822
4823	<listitem>
4824	<para><emphasis role="bold"><computeroutput>rmdir\|removedir\|removedirectory</computeroutput></emphasis>
4825	Deletes specified guest file system directories. (Only with installed Guest Additions 4.3.2 and later).</para>
4826
4827	<screen>VBoxManage guestcontrol <uuid\|vmname> rmdir\|removedir\|removedirectory [common-options]
4828	[--recursive\|-R]
4829	<guest-dir0> [<guest-dir1> [...]]
4830	</screen>
4831
4832	<para>Where the parameters are: <glosslist>
4833	<glossentry>
4834	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4835	<glossdef>
4836	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4837	</glossdef>
4838	</glossentry>
4839
4840	<glossentry>
4841	<glossterm><computeroutput>--recursive</computeroutput></glossterm>
4842	<glossdef>
4843	<para>Recursively removes directories and contents. Optional.</para>
4844	</glossdef>
4845	</glossentry>
4846
4847	<glossentry>
4848	<glossterm><computeroutput><guest-dir0> [<guest-dir1> [...]]</computeroutput></glossterm>
4849	<glossdef>
4850	<para>Specifies list of the absolute path(s) of directory(ies) to be deleted on
4851	guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\*Bar</computeroutput>.
4852	The specified user must have sufficient rights to delete the
4853	specified directory(ies).</para>
4854	</glossdef>
4855	</glossentry>
4856	</glosslist></para>
4857	</listitem>
4858
4859	<listitem>
4860	<para><emphasis role="bold"><computeroutput>rm\|removefile</computeroutput></emphasis>
4861	Deletes specified files on the guest file system. (Only with installed Guest
4862	Additions 4.3.2 and later).</para>
4863
4864	<screen>VBoxManage guestcontrol <uuid\|vmname> rm\|removefile [common-options]
4865	[-f\|--force]
4866	<guest-file0> [<guest-file1> [...]] </screen>
4867
4868	<para>Where the parameters are: <glosslist>
4869	<glossentry>
4870	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4871	<glossdef>
4872	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4873	</glossdef>
4874	</glossentry>
4875
4876	<glossentry>
4877	<glossterm><computeroutput>-f\|--force</computeroutput></glossterm>
4878	<glossdef>
4879	<para>Enforce operation (override any requests for confirmations). Optional.</para>
4880	</glossdef>
4881	</glossentry>
4882
4883	<glossentry>
4884	<glossterm><computeroutput><guest-file0> [<guest-file1> [...]]</computeroutput></glossterm>
4885	<glossdef>
4886	<para>Specifies list of absolute path(s) of file(s) to be deleted on guest file system. Mandatory.
4887	Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>.
4888	The specified user should have sufficient rights to delete the specified file(s).</para>
4889	</glossdef>
4890	</glossentry>
4891	</glosslist>
4892	</para>
4893	</listitem>
4894
4895	<listitem>
4896	<para><emphasis role="bold"><computeroutput>mv\|move\|ren\|rename</computeroutput></emphasis>
4897	This subcommand renames file(s) and/or directory(ies) on the guest file system. (Only with installed Guest
4898	Additions 4.3.2 and later).</para>
4899
4900	<screen>VBoxManage guestcontrol <uuid\|vmname> mv\|move\|ren\|rename [common-options]
4901	<guest-source0> [<guest-source1> [...]] <guest-dest></screen>
4902
4903	<para>Where the parameters are: <glosslist>
4904	<glossentry>
4905	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4906	<glossdef>
4907	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4908	</glossdef>
4909	</glossentry>
4910
4911	<glossentry>
4912	<glossterm><computeroutput><guest-source0> [<guest-source1> [...]]</computeroutput></glossterm>
4913	<glossdef>
4914	<para>Specifies absolute path(s) of file(s) and/or single directory to be moved/renamed on guest
4915	file system. Mandatory.
4916	Wildcards are allowed in file names(s). The specified user should have sufficient rights to
4917	access the specified file(s).</para>
4918	</glossdef>
4919	</glossentry>
4920
4921	<glossentry>
4922	<glossterm><computeroutput><dest></computeroutput></glossterm>
4923	<glossdef>
4924	<para>Specifies the absolute path of the destination file/directory to which the file(s)
4925	are to be moved. Mandatory. If only one file to be moved, <dest> can be file or directory,
4926	else it must be a directory.
4927	The specified user must have sufficient rights to access the destination file/directory.</para>
4928	</glossdef>
4929	</glossentry>
4930	</glosslist></para>
4931	</listitem>
4932
4933	<listitem>
4934	<para><emphasis role="bold"><computeroutput>mktemp\|createtemp\|createtemporary</computeroutput></emphasis>
4935	Creates a temporary file/directory on the guest file system, to assist subsequent
4936	copying of files from the host to the guest file systems. By default, the file/directory
4937	is created in the guest's platform specific temp directory. Not currently supported.
4938	(Only with installed Guest Additions 4.2 and later).</para>
4939
4940	<screen>VBoxManage guestcontrol <uuid\|vmname> mktemp\|createtemp\|createtemporary [common-options]
4941	[--directory] [--secure] [--mode <mode>] [--tmpdir <directory>]
4942	<template>
4943	</screen>
4944
4945	<para>The parameters are: <glosslist>
4946	<glossentry>
4947	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4948	<glossdef>
4949	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4950	</glossdef>
4951	</glossentry>
4952
4953	<glossentry>
4954	<glossterm><computeroutput>--directory</computeroutput></glossterm>
4955	<glossdef>
4956	<para>Creates a temporary directory instead of a file, specified by the <template> parameter. Optional.</para>
4957	</glossdef>
4958	</glossentry>
4959
4960	<glossentry>
4961	<glossterm><computeroutput>--secure</computeroutput></glossterm>
4962	<glossdef>
4963	<para>
4964	Enforces secure file/directory creation. Optional. The permission mode is set to
4965	<computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely.
4966	</para>
4967	</glossdef>
4968	</glossentry>
4969
4970	<glossentry>
4971	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
4972	<glossdef>
4973	<para>Specifies the permission mode of the specified directory. Optional.
4974	Currently only octal modes (e.g. <computeroutput>0755</computeroutput>)
4975	are supported.</para>
4976	</glossdef>
4977	</glossentry>
4978
4979	<glossentry>
4980	<glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm>
4981	<glossdef>
4982	<para>
4983	Specifies the absolute path of the directory on the guest file system into which the
4984	file/directory specified in will be created. Optional.
4985	If unspecified, the platform-specific temp directory is used.
4986	</para>
4987	</glossdef>
4988	</glossentry>
4989
4990	<glossentry>
4991	<glossterm><computeroutput><template></computeroutput></glossterm>
4992	<glossdef>
4993	<para>Specifies a file name without a directory path, containing at least one sequence comprising
4994	three consecutive 'X' characters, or ending in 'X'. Mandatory.
4995	</para>
4996	</glossdef>
4997	</glossentry>
4998	</glosslist></para>
4999	</listitem>
5000
5001	<listitem>
5002	<para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>
5003	Displays file or file system status(es) on the guest.</para>
5004
5005	<screen>VBoxManage guestcontrol <uuid\|vmname> stat [common-options]
5006	<file0> [<file1> [...]]</screen>
5007
5008	<para>Where the parameters are: <glosslist>
5009	<glossentry>
5010	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5011	<glossdef>
5012	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5013	</glossdef>
5014	</glossentry>
5015
5016	<glossentry>
5017	<glossterm><computeroutput><file0> [<file1> [...]]</computeroutput></glossterm>
5018	<glossdef>
5019	<para>Specifies absolute path(s) of file(s) and/or file system(s) on guest file system. Mandatory.
5020	e.g. <computeroutput>/home/foo/a.out</computeroutput>.
5021	The specified user should have sufficient rights to access
5022	the specified file(s)/file system(s).</para>
5023	</glossdef>
5024	</glossentry>
5025	</glosslist></para>
5026	</listitem>
5027	</itemizedlist>
5028	</para>
5029
5030	<para>The second set of subcommands is of the form:</para>
5031	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
5032	[-v\|--verbose] [-q\|quiet] ...
5033	</screen>
5034
5035	<para>The "common-options" are:</para>
5036	<screen>
5037	[-v\|--verbose] [-q\|--quiet]
5038	</screen>
5039
5040	<para>Where details of the common options for the second set of subcommands are:
5041	<glosslist>
5042
5043	<glossentry>
5044	<glossterm><computeroutput>-v\|--verbose</computeroutput></glossterm>
5045	<glossdef><para>Makes the sub-command execution more verbose. Optional.</para></glossdef>
5046	</glossentry>
5047
5048	<glossentry>
5049	<glossterm><computeroutput>-q\|--quiet</computeroutput></glossterm>
5050	<glossdef><para>Makes the sub-command execution quieter. Optional.</para></glossdef>
5051	</glossentry>
5052	</glosslist>
5053	</para>
5054
5055	<para>The second set of subcommands: <itemizedlist>
5056	<listitem>
5057	<para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>
5058	Lists guest control configuration and status data, e.g. open guest sessions,
5059	guest processes and files.</para>
5060
5061	<screen>VBoxManage guestcontrol <uuid\|vmname> list [common-opts]
5062	<all\|sessions\|processes\|files> </screen>
5063
5064	<para>Where the parameters are: <glosslist>
5065	<glossentry>
5066	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5067	<glossdef>
5068	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5069	</glossdef>
5070	</glossentry>
5071
5072	<glossentry>
5073	<glossterm><computeroutput>all\|sessions\|processes\|files</computeroutput></glossterm>
5074	<glossdef>
5075	<para>Indicates whether to list all available data or guest sessions, processes or files.
5076	Mandatory.</para>
5077	</glossdef>
5078	</glossentry>
5079
5080	</glosslist></para>
5081	</listitem>
5082
5083	<listitem>
5084	<para><emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>
5085	Terminates guest processes specified by PID(s))running in guest session(s),
5086	specified by the session ID or name(s).</para>
5087
5088	<screen>VBoxManage guestcontrol <uuid\|vmname> closeprocess [common-options]
5089	--session-id <ID> \| --session-name <name or pattern>
5090	<PID0> [<PID1> [...]] </screen>
5091
5092	<para>Where the parameters are: <glosslist>
5093	<glossentry>
5094	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5095	<glossdef>
5096	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5097	</glossdef>
5098	</glossentry>
5099
5100	<glossentry>
5101	<glossterm><computeroutput>--session-id <ID></computeroutput></glossterm>
5102	<glossdef>
5103	<para>Specifies the guest session by its ID. Optional.</para>
5104	</glossdef>
5105	</glossentry>
5106
5107	<glossentry>
5108	<glossterm><computeroutput>--session-name <name or pattern></computeroutput></glossterm>
5109	<glossdef>
5110	<para>Specifies the guest session by its name, or multiple sessions
5111	using a pattern containing wildcards. Optional.</para>
5112	</glossdef>
5113	</glossentry>
5114
5115	<glossentry>
5116	<glossterm><computeroutput><PID0> [<PID1> [...]]</computeroutput></glossterm>
5117	<glossdef>
5118	<para>Specifies a list of process identifiers (PIDs) of guest processes to be terminated. Mandatory.</para>
5119	</glossdef>
5120	</glossentry>
5121	</glosslist></para>
5122	</listitem>
5123
5124	<listitem>
5125	<para><emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>
5126	Closes specified guest sessions, specified either by session ID or name.</para>
5127
5128	<screen>VBoxManage guestcontrol <uuid\|vmname> closesession [common-options]
5129	--session-id <ID> \| --session-name <name or pattern> \| --all </screen>
5130
5131	<para>Where the parameters are: <glosslist>
5132	<glossentry>
5133	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5134	<glossdef>
5135	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5136	</glossdef>
5137	</glossentry>
5138
5139	<glossentry>
5140	<glossterm><computeroutput>--session-id <ID></computeroutput></glossterm>
5141	<glossdef>
5142	<para>Specifies the guest session to be closed by ID. Optional.</para>
5143	</glossdef>
5144	</glossentry>
5145
5146	<glossentry>
5147	<glossterm><computeroutput>--session-name <name or pattern></computeroutput></glossterm>
5148	<glossdef>
5149	<para>Specifies the guest session to be closed by name. Optional.
5150	Multiple sessions can be specified by using a pattern
5151	containing wildcards. </para>
5152	</glossdef>
5153	</glossentry>
5154
5155	<glossentry>
5156	<glossterm><computeroutput>--all</computeroutput></glossterm>
5157	<glossdef>
5158	<para>Close all guest sessions. Optional.</para>
5159	</glossdef>
5160	</glossentry>
5161	</glosslist></para>
5162	</listitem>
5163
5164	<listitem>
5165	<para><emphasis role="bold"><computeroutput>updatega\|updateadditions\|updateguestadditions</computeroutput></emphasis>
5166	Ugrades Guest Additions already installed on the guest.
5167	(Only already installed Guest Additions 4.0 and later).</para>
5168
5169	<screen>VBoxManage guestcontrol <uuid\|vmname> updatega\|updateadditions\|updateguestadditions [common-options]
5170	[--source <New .ISO path>]
5171	[--wait-start]
5172	[-- <argument0> [<argument1> [...]]]</screen>
5173
5174	<para>Where the parameters are: <glosslist>
5175	<glossentry>
5176	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5177	<glossdef>
5178	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5179	</glossdef>
5180	</glossentry>
5181
5182	<glossentry>
5183	<glossterm><computeroutput>--source</computeroutput> <New .ISO path></glossterm>
5184	<glossdef>
5185	<para>Specifies the absolute path on guest file system of the .ISO file for Guest Additions update. Mandatory.</para>
5186	</glossdef>
5187	</glossentry>
5188
5189	<glossentry>
5190	<glossterm><computeroutput>--wait-start</computeroutput></glossterm>
5191	<glossdef>
5192	<para>Indicates that VBoxManage starts the usual updating process on the guest and then waits
5193	until the actual Guest Additions updating begins, at which point VBoxManage self-terminates. Optional.</para>
5194	<para>Default behavior is that VBoxManage waits for completion of the Guest Additions update before
5195	terminating. Use of this option is sometimes necessary, as a running VBoxManage
5196	can affect the interaction between the installer and the guest OS.</para>
5197	</glossdef>
5198	</glossentry>
5199
5200	<glossentry>
5201	<glossterm><computeroutput>[-- <argument0> [<argument1> [...]]]</computeroutput></glossterm>
5202	<glossdef>
5203	<para>Specifies optional command line arguments to be supplied to the Guest Additions
5204	updater. Useful for retrofitting features which are not currently installed.</para>
5205	<para>Arguments containing spaces should be enclosed by quotes.</para>
5206	</glossdef>
5207	</glossentry>
5208	</glosslist></para>
5209	</listitem>
5210
5211	<listitem>
5212	<para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>
5213	This subcommand prints current guest control activity.</para>
5214
5215	<screen>VBoxManage guestcontrol <uuid\|vmname> watch [common-options]
5216	</screen>
5217	<para>Where the parameters are: <glosslist>
5218	<glossentry>
5219	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5220	<glossdef>
5221	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5222	</glossdef>
5223	</glossentry>
5224	</glosslist></para>
5225	</listitem>
5226	</itemizedlist></para>
5227	</sect1>
5228
5229	<sect1 id="metrics">
5230	<title>VBoxManage metrics</title>
5231
5232	<para>This command supports monitoring the usage of system resources.
5233	Resources are represented by various metrics associated with the host
5234	system or a particular VM. For example, the host system has a
5235	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
5236	percentage of time CPUs spend executing in user mode over a specific
5237	sampling period.</para>
5238
5239	<para>Metric data is collected and retained internally; it may be
5240	retrieved at any time with the <computeroutput>VBoxManage metrics
5241	query</computeroutput> subcommand. The data is available as long as the
5242	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
5243	process terminates shortly after all VMs and frontends have been
5244	closed.</para>
5245
5246	<para>By default no metrics are collected at all. Metrics collection does
5247	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
5248	is invoked with a proper sampling interval and the number of metrics to be
5249	retained. The interval is measured in seconds. For example, to enable
5250	collecting the host processor and memory usage metrics every second and
5251	keeping the 5 most current samples, the following command can be
5252	used:</para>
5253
5254	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
5255
5256	<para>Metric collection can only be enabled for started VMs. Collected
5257	data and collection settings for a particular VM will disappear as soon as
5258	it shuts down. Use <computeroutput>VBoxManage metrics list
5259	</computeroutput> subcommand to see which metrics are currently available.
5260	You can also use <computeroutput>--list</computeroutput> option with any
5261	subcommand that modifies metric settings to find out which metrics were
5262	affected.</para>
5263
5264	<para>Note that the <computeroutput>VBoxManage metrics
5265	setup</computeroutput> subcommand discards all samples that may have been
5266	previously collected for the specified set of objects and metrics.</para>
5267
5268	<para>To enable or disable metrics collection without discarding the data
5269	<computeroutput>VBoxManage metrics enable</computeroutput> and
5270	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
5271	can be used. Note that these subcommands expect metrics, not submetrics,
5272	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
5273	other words enabling <code>CPU/Load/User</code> while disabling
5274	<code>CPU/Load/Kernel</code> is not supported.</para>
5275
5276	<para>The host and VMs have different sets of associated metrics.
5277	Available metrics can be listed with <computeroutput>VBoxManage metrics
5278	list</computeroutput> subcommand.</para>
5279
5280	<para>A complete metric name may include an aggregate function. The name
5281	has the following form:
5282	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
5283	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
5284	for the minimum amount of available memory over all retained data if
5285	applied to the host object.</para>
5286
5287	<para>Subcommands may apply to all objects and metrics or can be limited
5288	to one object or/and a list of metrics. If no objects or metrics are given
5289	in the parameters, the subcommands will apply to all available metrics of
5290	all objects. You may use an asterisk
5291	("<computeroutput>*</computeroutput>") to explicitly specify that the
5292	command should be applied to all objects or metrics. Use "host" as the
5293	object name to limit the scope of the command to host-related metrics. To
5294	limit the scope to a subset of metrics, use a metric list with names
5295	separated by commas.</para>
5296
5297	<para>For example, to query metric data on the CPU time spent in user and
5298	kernel modes by the virtual machine named "test", you can use the
5299	following command:</para>
5300
5301	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
5302
5303	<para>The following list summarizes the available subcommands:</para>
5304
5305	<glosslist>
5306	<glossentry>
5307	<glossterm><computeroutput>list</computeroutput></glossterm>
5308
5309	<glossdef>
5310	<para>This subcommand shows the parameters of the currently existing
5311	metrics. Note that VM-specific metrics are only available when a
5312	particular VM is running.</para>
5313	</glossdef>
5314	</glossentry>
5315
5316	<glossentry>
5317	<glossterm><computeroutput>setup</computeroutput></glossterm>
5318
5319	<glossdef>
5320	<para>This subcommand sets the interval between taking two samples
5321	of metric data and the number of samples retained internally. The
5322	retained data is available for displaying with the
5323	<code>query</code> subcommand. The <computeroutput>--list
5324	</computeroutput> option shows which metrics have been modified as
5325	the result of the command execution.</para>
5326	</glossdef>
5327	</glossentry>
5328
5329	<glossentry>
5330	<glossterm><computeroutput>enable</computeroutput></glossterm>
5331
5332	<glossdef>
5333	<para>This subcommand "resumes" data collection after it has been
5334	stopped with <code>disable</code> subcommand. Note that specifying
5335	submetrics as parameters will not enable underlying metrics. Use
5336	<computeroutput>--list</computeroutput> to find out if the command
5337	did what was expected.</para>
5338	</glossdef>
5339	</glossentry>
5340
5341	<glossentry>
5342	<glossterm><computeroutput>disable</computeroutput></glossterm>
5343
5344	<glossdef>
5345	<para>This subcommand "suspends" data collection without affecting
5346	collection parameters or collected data. Note that specifying
5347	submetrics as parameters will not disable underlying metrics. Use
5348	<computeroutput>--list</computeroutput> to find out if the command
5349	did what was expected.</para>
5350	</glossdef>
5351	</glossentry>
5352
5353	<glossentry>
5354	<glossterm><computeroutput>query</computeroutput></glossterm>
5355
5356	<glossdef>
5357	<para>This subcommand retrieves and displays the currently retained
5358	metric data.<note>
5359	<para>The <code>query</code> subcommand does not remove or
5360	"flush" retained data. If you query often enough you will see
5361	how old samples are gradually being "phased out" by new
5362	samples.</para>
5363	</note></para>
5364	</glossdef>
5365	</glossentry>
5366
5367	<glossentry>
5368	<glossterm><computeroutput>collect</computeroutput></glossterm>
5369
5370	<glossdef>
5371	<para>This subcommand sets the interval between taking two samples
5372	of metric data and the number of samples retained internally. The
5373	collected data is displayed periodically until Ctrl-C is pressed
5374	unless the <computeroutput>--detach</computeroutput> option is
5375	specified. With the <computeroutput>--detach</computeroutput>
5376	option, this subcommand operates the same way as <code>setup</code>
5377	does. The <computeroutput>--list</computeroutput> option shows which
5378	metrics match the specified filter.</para>
5379	</glossdef>
5380	</glossentry>
5381	</glosslist>
5382	</sect1>
5383
5384	<sect1 id="vboxmanage-natnetwork">
5385	<title>VBoxManage natnetwork</title>
5386
5387	<para>NAT networks use the Network Address Translation (NAT) service - which works in a
5388	similar way to a home router. It groups systems using it into a network and prevents
5389	outside systems from directly accessing those inside, while letting systems inside communicate
5390	with each other and outside systems using TCP and UDP over IPv4 and IPv6.</para>
5391
5392	<para>A NAT service is attached to an internal network. Virtual machines to make use of one
5393	should be attached to it. The name of an internal network is chosen when the NAT service is
5394	created, and the internal network will be created if it does not already exist.
5395	An example command to create a NAT network:</para>
5396
5397	<screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen>
5398
5399	<para>Here, "natnet1" is the name of the internal network to be used and "192.168.15.0/24" is the
5400	network address and mask of the NAT service interface. By default, in this static configuration
5401	- the gateway will be assigned the address 192.168.15.1 (the address after the interface address),
5402	though this is subject to change.</para>
5403
5404	<para>To add a DHCP server to the NAT network after creation:</para>
5405
5406	<screen>VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen>
5407
5408	<para>Below are the subcommands for <emphasis role="bold"><computeroutput>VBoxManage natnetwork </computeroutput></emphasis></para>
5409
5410	<screen>VBoxManage natnetwork add --netname <name>
5411	[--network <network>]
5412	[--enable\|--disable]
5413	[--dhcp on\|off]
5414	[--port-forward-4 <rule>]
5415	[--loopback-4 <rule>]
5416	[--ipv6 on\|off]
5417	[--port-forward-6 <rule>]
5418	[--loopback-6 <rule>]
5419	</screen>
5420
5421
5422	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork add</computeroutput></emphasis>
5423	Creates a new internal network interface, and adds a NAT network service. This command is a
5424	prerequisite for enabling attachment of VMs to the NAT network. Parameters:</para>
5425
5426	<para>
5427	<glosslist>
5428	<glossentry>
5429	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5430	<glossdef>
5431	<para>Where <name> is the name of the new internal network interface on the host OS. </para>
5432	</glossdef>
5433	</glossentry>
5434	<glossentry>
5435	<glossterm><computeroutput>--network <network></computeroutput></glossterm>
5436	<glossdef>
5437	<para>Where <network> specifies the static(default)/DHCP network address and mask of
5438	the NAT service interface.</para>
5439	</glossdef>
5440	</glossentry>
5441	<glossentry>
5442	<glossterm><computeroutput>--enable\|--disable</computeroutput></glossterm>
5443	<glossdef>
5444	<para>Enables/disables the NAT network service.</para>
5445	</glossdef>
5446	</glossentry>
5447	<glossentry>
5448	<glossterm><computeroutput>--dhcp on\|off</computeroutput></glossterm>
5449	<glossdef>
5450	<para>Enables/disables DHCP server specified by --netname; its use also indicates that it
5451	is a DHCP server.</para>
5452	</glossdef>
5453	</glossentry>
5454	<glossentry>
5455	<glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm>
5456	<glossdef>
5457	<para>Enables IPv4 port forwarding, rule specified by <rule>.</para>
5458	</glossdef>
5459	</glossentry>
5460	<glossentry>
5461	<glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm>
5462	<glossdef>
5463	<para>Enables IPv4 loopback interface, rule specified by <rule>.</para>
5464	</glossdef>
5465	</glossentry>
5466	<glossentry>
5467	<glossterm><computeroutput>--ipv6 on\|off</computeroutput></glossterm>
5468	<glossdef>
5469	<para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para>
5470	</glossdef>
5471	</glossentry>
5472	<glossentry>
5473	<glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm>
5474	<glossdef>
5475	<para>Enables IPv6 port forwarding, rule specified by <rule>.</para>
5476	</glossdef>
5477	</glossentry>
5478	<glossentry>
5479	<glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm>
5480	<glossdef>
5481	<para>Enables IPv6 loopback interface, rule specified by <rule>.</para>
5482	</glossdef>
5483	</glossentry>
5484	</glosslist>
5485	</para>
5486
5487	<screen>VBoxManage natnetwork remove --netname <name> </screen>
5488
5489	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork remove</computeroutput></emphasis>
5490	Removes a NAT network service, parameters:</para>
5491
5492	<para>
5493	<glosslist>
5494	<glossentry>
5495	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5496	<glossdef>
5497	<para>Where <name> specifies an existing NAT network service.
5498	Does not remove any DHCP server enabled on the network.</para>
5499	</glossdef>
5500	</glossentry>
5501	</glosslist>
5502	</para>
5503
5504	<screen>VBoxManage natnetwork modify --netname <name>
5505	[--network <network>]
5506	[--enable\|--disable]
5507	[--dhcp on\|off]
5508	[--port-forward-4 <rule>]
5509	[--loopback-4 <rule>]
5510	[--ipv6 on\|off]
5511	[--port-forward-6 <rule>]
5512	[--loopback-6 <rule>]
5513	</screen>
5514
5515	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork modify</computeroutput></emphasis>
5516	Modifies an existing NAT network service, parameters:</para>
5517
5518	<para>
5519	<glosslist>
5520	<glossentry>
5521	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5522	<glossdef>
5523	<para>Where <name> specifies an existing NAT network service.</para>
5524	</glossdef>
5525	</glossentry>
5526	<glossentry>
5527	<glossterm><computeroutput>--network <network></computeroutput></glossterm>
5528	<glossdef>
5529	<para>Where <network> specifies the new static(default)/DHCP network address and mask
5530	of the NAT service interface.</para>
5531	</glossdef>
5532	</glossentry>
5533	<glossentry>
5534	<glossterm><computeroutput>--enable\|--disable</computeroutput></glossterm>
5535	<glossdef>
5536	<para>Enables/disables the NAT network service.</para>
5537	</glossdef>
5538	</glossentry>
5539	<glossentry>
5540	<glossterm><computeroutput>--dhcp on\|off</computeroutput></glossterm>
5541	<glossdef>
5542	<para>Enables (and if absent, adds)/disables (if any) DHCP server.</para>
5543	</glossdef>
5544	</glossentry>
5545	<glossentry>
5546	<glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm>
5547	<glossdef>
5548	<para>Enables IPv4 port forwarding, rule specified by <rule>.</para>
5549	</glossdef>
5550	</glossentry>
5551	<glossentry>
5552	<glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm>
5553	<glossdef>
5554	<para>Enables IPv4 loopback interface, rule specified by <rule>.</para>
5555	</glossdef>
5556	</glossentry>
5557	<glossentry>
5558	<glossterm><computeroutput>--ipv6 on\|off</computeroutput></glossterm>
5559	<glossdef>
5560	<para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para>
5561	</glossdef>
5562	</glossentry>
5563	<glossentry>
5564	<glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm>
5565	<glossdef>
5566	<para>Enables IPv6 port forwarding, rule specified by <rule>.</para>
5567	</glossdef>
5568	</glossentry>
5569	<glossentry>
5570	<glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm>
5571	<glossdef>
5572	<para>Enables IPv6 loopback interface, rule specified by <rule>.</para>
5573	</glossdef>
5574	</glossentry>
5575	</glosslist>
5576	</para>
5577
5578	<screen>VBoxManage natnetwork start --netname <name>
5579	</screen>
5580
5581	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork start</computeroutput></emphasis>
5582	Starts specified NAT network service and any associated DHCP server, parameters:</para>
5583
5584	<para>
5585	<glosslist>
5586	<glossentry>
5587	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5588	<glossdef>
5589	<para>Where <name> specifies an existing NAT network service.</para>
5590	</glossdef>
5591	</glossentry>
5592	</glosslist>
5593	</para>
5594
5595	<screen>VBoxManage natnetwork stop --netname <name>
5596	</screen>
5597
5598	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork stop</computeroutput></emphasis>
5599	Stops specified NAT network service and any DHCP server, parameters:</para>
5600
5601	<para>
5602	<glosslist>
5603	<glossentry>
5604	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5605	<glossdef>
5606	<para>Where <name> specifies an existing NAT network service.</para>
5607	</glossdef>
5608	</glossentry>
5609	</glosslist>
5610	</para>
5611
5612	<screen>VBoxManage natnetwork list [<pattern>] </screen>
5613
5614	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork list</computeroutput></emphasis>
5615	Lists all NAT network services with optional filtering, parameters:</para>
5616
5617	<para>
5618	<glosslist>
5619	<glossentry>
5620	<glossterm><computeroutput>[<pattern>]</computeroutput></glossterm>
5621	<glossdef>
5622	<para>Where <pattern> is optional filtering pattern.</para>
5623	</glossdef>
5624	</glossentry>
5625	</glosslist>
5626	</para>
5627	</sect1>
5628
5629	<sect1 id="vboxmanage-hostonlyif">
5630	<title>VBoxManage hostonlyif</title>
5631
5632	<para>With "hostonlyif" you can change the IP configuration of a host-only
5633	network interface. For a description of host-only networking, please
5634	refer to <xref linkend="network_hostonly" />. Each host-only interface is
5635	identified by a name and can either use the internal DHCP server or a
5636	manual IP configuration (both IP4 and IP6).</para>
5637
5638	<para>The following list summarizes the available subcommands:</para>
5639
5640	<glosslist>
5641	<glossentry>
5642	<glossterm><computeroutput>ipconfig "<name>"</computeroutput></glossterm>
5643	<glossdef>
5644	<para>Configure a hostonly interface</para>
5645	</glossdef>
5646	</glossentry>
5647	<glossentry>
5648	<glossterm><computeroutput>create</computeroutput></glossterm>
5649	<glossdef>
5650	<para>Creates a new vboxnet<N> interface on the host OS.
5651	This command is essential before you can attach VMs to host-only network.</para>
5652	</glossdef>
5653	</glossentry>
5654	<glossentry>
5655	<glossterm><computeroutput>remove vboxnet<N></computeroutput></glossterm>
5656	<glossdef>
5657	<para>Removes a vboxnet<N> interface from the host OS.</para>
5658	</glossdef>
5659	</glossentry>
5660	</glosslist>
5661
5662	</sect1>
5663
5664	<sect1 id="vboxmanage-dhcpserver">
5665	<title>VBoxManage dhcpserver</title>
5666
5667	<para>The "dhcpserver" commands allow you to control the DHCP server that
5668	is built into VirtualBox. You may find this useful when using internal or
5669	host-only networking. (Theoretically, you can enable it for a bridged
5670	network as well, but that will likely cause conflicts with other DHCP
5671	servers in your physical network.)</para>
5672
5673	<para>Use the following command line options:<itemizedlist>
5674	<listitem>
5675	<para>If you use internal networking for a virtual network adapter
5676	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
5677	--netname <network_name></computeroutput>, where
5678	<computeroutput><network_name></computeroutput> is the same
5679	network name you used with <computeroutput>VBoxManage modifyvm
5680	<vmname> --intnet<X>
5681	<network_name></computeroutput>.</para>
5682	</listitem>
5683
5684	<listitem>
5685	<para>If you use host-only networking for a virtual network adapter
5686	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
5687	--ifname <hostonly_if_name></computeroutput> instead, where
5688	<computeroutput><hostonly_if_name></computeroutput> is the
5689	same host-only interface name you used with
5690	<computeroutput>VBoxManage modifyvm <vmname>
5691	--hostonlyadapter<X>
5692	<hostonly_if_name></computeroutput>.</para>
5693
5694	<para>Alternatively, you can also use the
5695	<computeroutput>--netname</computeroutput> option as with
5696	internal networks if you know the host-only network's name; you can
5697	see the names with <computeroutput>VBoxManage list
5698	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
5699	above).</para>
5700	</listitem>
5701	</itemizedlist></para>
5702
5703	<para>The following additional parameters are required when first adding a
5704	DHCP server:<itemizedlist>
5705	<listitem>
5706	<para>With <computeroutput>--ip</computeroutput>, specify the IP
5707	address of the DHCP server itself.</para>
5708	</listitem>
5709
5710	<listitem>
5711	<para>With <computeroutput>--netmask</computeroutput>, specify the
5712	netmask of the network.</para>
5713	</listitem>
5714
5715	<listitem>
5716	<para>With <computeroutput>--lowerip</computeroutput> and
5717	<computeroutput>--upperip</computeroutput>, you can specify the
5718	lowest and highest IP address, respectively, that the DHCP server
5719	will hand out to clients.</para>
5720	</listitem>
5721	</itemizedlist></para>
5722
5723	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
5724	or the DHCP server will be created in the disabled state, doing
5725	nothing.</para>
5726
5727	<para>After this, VirtualBox will automatically start the DHCP server for
5728	given internal or host-only network as soon as the first virtual machine
5729	which uses that network is started.</para>
5730
5731	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
5732	remove</computeroutput> with the given <computeroutput>--netname
5733	<network_name></computeroutput> or <computeroutput>--ifname
5734	<hostonly_if_name></computeroutput> to remove the DHCP server again
5735	for the given internal or host-only network.</para>
5736
5737	<para>To modify the settings of a DHCP server created earlier with
5738	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
5739	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
5740	network or host-only interface name. This has the same parameters as
5741	<computeroutput>VBoxManage dhcpserver add</computeroutput>.</para>
5742	</sect1>
5743
5744	<sect1 id="vboxmanage-usbdevsource">
5745	<title>VBoxManage usbdevsource</title>
5746
5747	<para>The "usbdevsource" commands enables you to add and remove USB devices
5748	globally.</para>
5749
5750	<para>The following command adds a USB device.</para>
5751
5752	<screen>VBoxManage usbdevsource add <source name>
5753	--backend <backend>
5754	--address <address>
5755	</screen>
5756
5757	<para>Where the command line options are:<itemizedlist>
5758	<listitem>
5759	<para><source name> specifies the ID of the 'source' USB
5760	device to be added. Mandatory.</para>
5761	</listitem>
5762	<listitem>
5763	<para>--backend <backend> specifies the USB proxy service
5764	backend to use. Mandatory.</para>
5765	</listitem>
5766	<listitem>
5767	<para>--address <address> specifies the backend specific
5768	address. Mandatory.</para>
5769	</listitem>
5770	</itemizedlist></para>
5771
5772	<para>The following command removes a USB device.</para>
5773
5774	<screen>VBoxManage usbdevsource remove <source name>
5775	</screen>
5776
5777	<para>Where the command line options are:<itemizedlist>
5778	<listitem>
5779	<para><source name> specifies the ID of the 'source' USB
5780	device to be removed. Mandatory.</para>
5781	</listitem>
5782	</itemizedlist></para>
5783	</sect1>
5784
5785
5786	<xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)"
5787	xmlns:xi="http://www.w3.org/2001/XInclude" />
5788
5789	<xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)"
5790	xmlns:xi="http://www.w3.org/2001/XInclude" />
5791	</chapter>

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/doc/manual/en_US/user_VBoxManage.xml@ 63375

Download in other formats: