user_VBoxManage.xml@ 36040

Last change on this file since 36040 was 35508, checked in by vboxsync, 14 years ago
VBoxManage: Added the getregisters and setregisters subcommands to debugvm. Document them and other recent debugvm additions.
File size: 134.5 KB

Line
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
4	<chapter id="vboxmanage">
5	<title>VBoxManage</title>
6
7	<sect1>
8	<title>Introduction</title>
9
10	<para>As briefly mentioned in <xref linkend="frontends" />, VBoxManage is
11	the command-line interface to VirtualBox. With it, you can completely
12	control VirtualBox from the command line of your host operating system.
13	VBoxManage supports all the features that the graphical user interface
14	gives you access to, but it supports a lot more than that. It exposes
15	really all the features of the virtualization engine, even those that
16	cannot (yet) be accessed from the GUI.</para>
17
18	<para>You will need to use the command line if you want to</para>
19
20	<para><itemizedlist>
21	<listitem>
22	<para>use a different user interface than the main GUI (for example,
23	VBoxSDL or the VBoxHeadless server);</para>
24	</listitem>
25
26	<listitem>
27	<para>control some of the more advanced and experimental
28	configuration settings for a VM.</para>
29	</listitem>
30	</itemizedlist></para>
31
32	<para>There are two main things to keep in mind when using
33	<computeroutput>VBoxManage</computeroutput>: First,
34	<computeroutput>VBoxManage</computeroutput> must always be used with a
35	specific "subcommand", such as "list" or "createvm" or "startvm". All the
36	subcommands that <computeroutput>VBoxManage</computeroutput> supports are
37	described in detail in <xref linkend="vboxmanage" />.</para>
38
39	<para>Second, most of these subcommands require that you specify a
40	particular virtual machine after the subcommand. There are two ways you
41	can do this:</para>
42
43	<itemizedlist>
44	<listitem>
45	<para>You can specify the VM name, as it is shown in the VirtualBox
46	GUI. Note that if that name contains spaces, then you must enclose the
47	entire name in double quotes (as it is always required with command
48	line arguments that contain spaces).</para>
49
50	<para>For example:<screen>VBoxManage startvm "Windows XP"</screen></para>
51	</listitem>
52
53	<listitem>
54	<para>You can specify the UUID, which is the internal unique
55	identifier that VirtualBox uses to refer to the virtual machine.
56	Assuming that the aforementioned VM called "Windows XP" has the UUID
57	shown below, the following command has the same effect as the
58	previous:<screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen></para>
59	</listitem>
60	</itemizedlist>
61
62	<para>You can type <computeroutput>VBoxManage list vms</computeroutput> to
63	have all currently registered VMs listed with all their settings,
64	including their respective names and UUIDs.</para>
65
66	<para>Some typical examples of how to control VirtualBox from the command
67	line are listed below:</para>
68
69	<itemizedlist>
70	<listitem>
71	<para>To create a new virtual machine from the command line and
72	immediately register it with VirtualBox, use
73	<computeroutput>VBoxManage createvm</computeroutput> with the
74	<computeroutput>--register</computeroutput> option,<footnote>
75	<para>For details, see <xref
76	linkend="vboxmanage-createvm" />.</para>
77	</footnote> like this:</para>
78
79	<screen>$ VBoxManage createvm --name "SUSE 10.2" --register
80	VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
81	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
82	All rights reserved.
83
84	Virtual machine 'SUSE 10.2' is created.
85	UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
86	Settings file: '/home/username/.VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'
87	</screen>
88
89	<para>As can be seen from the above output, a new virtual machine has
90	been created with a new UUID and a new XML settings file.</para>
91	</listitem>
92
93	<listitem>
94	<para>To show the configuration of a particular VM, use
95	<computeroutput>VBoxManage showvminfo</computeroutput>; see <xref
96	linkend="vboxmanage-showvminfo" /> for details and an example.</para>
97	</listitem>
98
99	<listitem>
100	<para>To change settings while a VM is powered off, use
101	<computeroutput>VBoxManage modifyvm</computeroutput>, e.g. as
102	follows:<screen>VBoxManage modifyvm "Windows XP" --memory "512MB"</screen></para>
103
104	<para>For details, see <xref linkend="vboxmanage-modifyvm" />.</para>
105	</listitem>
106
107	<listitem>
108	<para>To change the storage configuration (e.g. to add a storage
109	controller and then a virtual disk), use <computeroutput>VBoxManage
110	storagectl</computeroutput> and <computeroutput>VBoxManage
111	storageattach</computeroutput>; see <xref
112	linkend="vboxmanage-storagectl" /> and <xref
113	linkend="vboxmanage-storageattach" /> for details.</para>
114	</listitem>
115
116	<listitem>
117	<para>To control VM operation, use one of the following:<itemizedlist>
118	<listitem>
119	<para>To start a VM that is currently powered off, use
120	<computeroutput>VBoxManage startvm</computeroutput>; see <xref
121	linkend="vboxmanage-startvm" /> for details.</para>
122	</listitem>
123
124	<listitem>
125	<para>To pause or save a VM that is currently running or change
126	some of its settings, use <computeroutput>VBoxManage
127	controlvm</computeroutput>; see <xref
128	linkend="vboxmanage-controlvm" /> for details.</para>
129	</listitem>
130	</itemizedlist></para>
131	</listitem>
132	</itemizedlist>
133	</sect1>
134
135	<sect1>
136	<title>Commands overview</title>
137
138	<para>When running VBoxManage without parameters or when supplying an
139	invalid command line, the below syntax diagram will be shown. Note that
140	the output will be slightly different depending on the host platform; when
141	in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
142	for the commands available on your particular host.</para>
143
144	<screen>$VBOX_MANAGE_OUTPUT</screen>
145
146	<para>Each time VBoxManage is invoked, only one command can be executed.
147	However, a command might support several subcommands which then can be
148	invoked in one single call. The following sections provide detailed
149	reference information on the different commands.</para>
150	</sect1>
151
152	<sect1 id="vboxmanage-list">
153	<title>VBoxManage list</title>
154
155	<para>The <computeroutput>list</computeroutput> command gives relevant
156	information about your system and information about VirtualBox's current
157	settings.</para>
158
159	<para>The following subcommands are available with
160	<computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
161	<listitem>
162	<para><computeroutput>vms</computeroutput> lists all virtual
163	machines currently registered with VirtualBox. By default this
164	displays a compact list with each VM's name and UUID; if you also
165	specify <computeroutput>--long</computeroutput> or
166	<computeroutput>-l</computeroutput>, this will be a detailed list as
167	with the <computeroutput>showvminfo</computeroutput> command (see
168	below).</para>
169	</listitem>
170
171	<listitem>
172	<para><computeroutput>runningvms</computeroutput> lists all
173	currently running virtual machines by their unique identifiers
174	(UUIDs) in the same format as with
175	<computeroutput>vms</computeroutput>.</para>
176	</listitem>
177
178	<listitem>
179	<para><computeroutput>ostypes</computeroutput> lists all guest
180	operating systems presently known to VirtualBox, along with the
181	identifiers used to refer to them with the
182	<computeroutput>modifyvm</computeroutput> command.</para>
183	</listitem>
184
185	<listitem>
186	<para><computeroutput>hostdvds</computeroutput>,
187	<computeroutput>hostfloppies</computeroutput>, respectively, list
188	DVD, floppy, bridged networking and host-only networking interfaces
189	on the host, along with the name used to access them from within
190	VirtualBox.</para>
191	</listitem>
192
193	<listitem>
194	<para><computeroutput>bridgedifs</computeroutput>,
195	<computeroutput>hostonlyifs</computeroutput> and
196	<computeroutput>dhcpservers</computeroutput>, respectively, list
197	bridged network interfaces, host-only network interfaces and DHCP
198	servers currently available on the host. Please see <xref
199	linkend="networkingdetails" /> for details on these.</para>
200	</listitem>
201
202	<listitem>
203	<para><computeroutput>hostinfo</computeroutput> displays information
204	about the host system, such as CPUs, memory size and operating
205	system version.</para>
206	</listitem>
207
208	<listitem>
209	<para><computeroutput>hostcpuids</computeroutput> dumps the CPUID
210	parameters for the host CPUs. This can be used for a more fine
211	grained analyis of the host's virtualization capabilities.</para>
212	</listitem>
213
214	<listitem>
215	<para><computeroutput>hddbackends</computeroutput> lists all known
216	virtual disk back-ends of VirtualBox. For each such format (such as
217	VDI, VMDK or RAW), this lists the back-end's capabilities and
218	configuration.</para>
219	</listitem>
220
221	<listitem>
222	<para><computeroutput>hdds</computeroutput>,
223	<computeroutput>dvds</computeroutput> and
224	<computeroutput>floppies</computeroutput> all give you information
225	about virtual disk images currently in use by VirtualBox, including
226	all their settings, the unique identifiers (UUIDs) associated with
227	them by VirtualBox and all files associated with them. This is the
228	command-line equivalent of the Virtual Media Manager; see <xref
229	linkend="vdis" />.</para>
230	</listitem>
231
232	<listitem>
233	<para><computeroutput>usbhost</computeroutput> supplies information
234	about USB devices attached to the host, notably information useful
235	for constructing USB filters and whether they are currently in use
236	by the host.</para>
237	</listitem>
238
239	<listitem>
240	<para><computeroutput>usbfilters</computeroutput> lists all global
241	USB filters registered with VirtualBox -- that is, filters for
242	devices which are accessible to all virtual machines -- and displays
243	the filter parameters.</para>
244	</listitem>
245
246	<listitem>
247	<para><computeroutput>systemproperties</computeroutput> displays
248	some global VirtualBox settings, such as minimum and maximum guest
249	RAM and virtual hard disk size, folder settings and the current
250	authentication library in use.</para>
251	</listitem>
252
253	<listitem>
254	<para><computeroutput>extpacks</computeroutput> displays all
255	VirtualBox extension packs currently installed; see <xref
256	linkend="intro-installing" /> and <xref
257	linkend="vboxmanage-extpack" /> for more information.</para>
258	</listitem>
259	</itemizedlist></para>
260	</sect1>
261
262	<sect1 id="vboxmanage-showvminfo">
263	<title>VBoxManage showvminfo</title>
264
265	<para>The <computeroutput>showvminfo</computeroutput> command shows
266	information about a particular virtual machine. This is the same
267	information as <computeroutput>VBoxManage list vms --long</computeroutput>
268	would show for all virtual machines.</para>
269
270	<para>You will get information similar to the following:</para>
271
272	<para><screen>$ VBoxManage showvminfo "Windows XP"
273	VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
274	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
275	All rights reserved.
276
277	Name: Windows XP
278	Guest OS: Other/Unknown
279	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
280	Config file: /home/username/.VirtualBox/Machines/Windows XP/Windows XP.xml
281	Memory size: 512MB
282	VRAM size: 12MB
283	Number of CPUs: 2
284	Synthetic Cpu: off
285	Boot menu mode: message and menu
286	Boot Device (1): DVD
287	Boot Device (2): HardDisk
288	Boot Device (3): Not Assigned
289	Boot Device (4): Not Assigned
290	ACPI: on
291	IOAPIC: on
292	PAE: on
293	Time offset: 0 ms
294	Hardw. virt.ext: on
295	Hardw. virt.ext exclusive: on
296	Nested Paging: on
297	VT-x VPID: off
298	State: powered off (since 2009-10-20T14:52:19.000000000)
299	Monitor count: 1
300	3D Acceleration: off
301	2D Video Acceleration: off
302	Teleporter Enabled: off
303	Teleporter Port: 0
304	Teleporter Address:
305	Teleporter Password:
306	Storage Controller (0): IDE Controller
307	Storage Controller Type (0): PIIX4
308	Storage Controller (1): Floppy Controller 1
309	Storage Controller Type (1): I82078
310	IDE Controller (0, 0): /home/user/windows.vdi (UUID: 46f6e53a-4557-460a-9b95-68b0f17d744b)
311	IDE Controller (0, 1): /home/user/openbsd-cd46.iso (UUID: 4335e162-59d3-4512-91d5-b63e94eebe0b)
312	Floppy Controller 1 (0, 0): /home/user/floppy.img (UUID: 62ac6ccb-df36-42f2-972e-22f836368137)
313	NIC 1: disabled
314	NIC 2: disabled
315	NIC 3: disabled
316	NIC 4: disabled
317	NIC 5: disabled
318	NIC 6: disabled
319	NIC 7: disabled
320	NIC 8: disabled
321	UART 1: disabled
322	UART 2: disabled
323	Audio: disabled (Driver: Unknown)
324	Clipboard Mode: Bidirectional
325	VRDE: disabled
326	USB: disabled
327
328	USB Device Filters:
329	<none>
330
331	Shared folders:
332	<none>
333
334	Statistics update: disabled
335	</screen></para>
336	</sect1>
337
338	<sect1>
339	<title>VBoxManage registervm / unregistervm</title>
340
341	<para>The <computeroutput>registervm</computeroutput> command allows you
342	to import a virtual machine definition in an XML file into VirtualBox. The
343	machine must not conflict with one already registered in VirtualBox and it
344	may not have any hard or removable disks attached. It is advisable to
345	place the definition file in the machines folder before registering
346	it.<note>
347	<para>When creating a new virtual machine with
348	<computeroutput>VBoxManage createvm</computeroutput> (see below), you
349	can directly specify the <computeroutput>--register</computeroutput>
350	option to avoid having to register it separately.</para>
351	</note></para>
352
353	<para>The <computeroutput>unregistervm</computeroutput> command
354	unregisters a virtual machine. If
355	<computeroutput>--delete</computeroutput> is also specified, the following
356	files will automatically be deleted as well:<orderedlist>
357	<listitem>
358	<para>all hard disk image files, including differencing files, which
359	are used by the machine and not shared with other machines;</para>
360	</listitem>
361
362	<listitem>
363	<para>saved state files that the machine created, if any (one if the
364	machine was in "saved" state and one for each online
365	snapshot);</para>
366	</listitem>
367
368	<listitem>
369	<para>the machine XML file and its backups;</para>
370	</listitem>
371
372	<listitem>
373	<para>the machine log files, if any;</para>
374	</listitem>
375
376	<listitem>
377	<para>the machine directory, if it is empty after having deleted all
378	the above.</para>
379	</listitem>
380	</orderedlist></para>
381	</sect1>
382
383	<sect1>
384	<title id="vboxmanage-createvm">VBoxManage createvm</title>
385
386	<para>This command creates a new XML virtual machine definition
387	file.</para>
388
389	<para>The <computeroutput>--name <name></computeroutput> parameter
390	is required and must specify the name of the machine. Since this name is
391	used by default as the file name of the settings file (with the extension
392	<computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
393	of the <computeroutput>.VirtualBox/Machines</computeroutput> folder), it
394	must conform to your host operating system's requirements for file name
395	specifications. If the VM is later renamed, the file and folder names will
396	change automatically.</para>
397
398	<para>However, if the <computeroutput>--basefolder
399	<path></computeroutput> option is used, the machine folder will be
400	named <computeroutput><path></computeroutput>. In this case, the
401	names of the file and the folder will not change if the virtual machine is
402	renamed.</para>
403
404	<para>By default, this command only creates the XML file without
405	automatically registering the VM with your VirtualBox installation. To
406	register the VM instantly, use the optional
407	<computeroutput>--register</computeroutput> option, or run
408	<computeroutput>VBoxManage registervm</computeroutput> separately
409	afterwards.</para>
410	</sect1>
411
412	<sect1 id="vboxmanage-modifyvm">
413	<title>VBoxManage modifyvm</title>
414
415	<para>This command changes the properties of a registered virtual machine
416	which is not running. Most of the properties that this command makes
417	available correspond to the VM settings that VirtualBox graphical user
418	interface displays in each VM's "Settings" dialog; these were described in
419	<xref linkend="BasicConcepts" />. Some of the more advanced settings,
420	however, are only available through the
421	<computeroutput>VBoxManage</computeroutput> interface.</para>
422
423	<para>These commands require that the machine is powered off (neither
424	running nor in "saved" state). Some machine settings can also be changed
425	while a machine is running; those settings will then have a corresponding
426	subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
427	subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
428
429	<sect2>
430	<title>General settings</title>
431
432	<para>The following general settings are available through
433	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
434	<listitem>
435	<para><computeroutput>--name <name></computeroutput>: This
436	changes the VM's name and possibly renames the internal virtual
437	machine files, as described with <computeroutput>VBoxManage
438	createvm</computeroutput> above.</para>
439	</listitem>
440
441	<listitem>
442	<para><computeroutput>--ostype <ostype></computeroutput>:
443	This specifies what guest operating system is supposed to run in
444	the VM. To learn about the various identifiers that can be used
445	here, use <computeroutput>VBoxManage list
446	ostypes</computeroutput>.</para>
447	</listitem>
448
449	<listitem>
450	<para><computeroutput>--memory
451	<memorysize></computeroutput>: This sets the amount of RAM,
452	in MB, that the virtual machine should allocate for itself from
453	the host. See the remarks in <xref linkend="gui-createvm" /> for
454	more information.</para>
455	</listitem>
456
457	<listitem>
458	<para><computeroutput>--vram <vramsize></computeroutput>:
459	This sets the amount of RAM that the virtual graphics card should
460	have. See <xref linkend="settings-display" /> for details.</para>
461	</listitem>
462
463	<listitem>
464	<para><computeroutput>--acpi on\|off</computeroutput>;
465	<computeroutput>--ioapic on\|off</computeroutput>: These two
466	determine whether the VM should have ACPI and I/O APIC support,
467	respectively; see <xref linkend="settings-motherboard" /> for
468	details.</para>
469	</listitem>
470
471	<listitem>
472	<para><computeroutput>--hardwareuuid
473	<uuid></computeroutput>: The UUID presented to the guest via
474	memory tables (DMI/SMBIOS), hardware and guest properties. By
475	default this is the same as the VM uuid. Useful when cloning a VM.
476	Teleporting takes care of this automatically.</para>
477	</listitem>
478
479	<listitem>
480	<para><computeroutput>--cpus <cpucount></computeroutput>:
481	This sets the number of virtual CPUs for the virtual machine (see
482	<xref linkend="settings-processor" />). If CPU hot-plugging is
483	enabled (see below), this then sets the
484	<emphasis>maximum</emphasis> number of virtual CPUs that can be
485	plugged into the virtual machines.</para>
486	</listitem>
487
488	<listitem>
489	<para><computeroutput>--rtcuseutc on\|off</computeroutput>: This
490	option lets the real-time clock (RTC) operate in UTC time (see
491	<xref linkend="settings-motherboard" />).</para>
492	</listitem>
493
494	<listitem>
495	<para><computeroutput>--cpuhotplug on\|off</computeroutput>: This
496	enables CPU hot-plugging. When enabled, virtual CPUs can be added
497	to and removed from a virtual machine while it is running. See
498	<xref linkend="cpuhotplug" /> for more information.</para>
499	</listitem>
500
501	<listitem>
502	<para><computeroutput>--plugcpu\|unplugcpu
503	<id></computeroutput>: If CPU hot-plugging is enabled (see
504	above), this adds a virtual CPU to the virtual machines (or
505	removes one). <computeroutput><id></computeroutput>
506	specifies the index of the virtual CPU to be added or removed and
507	must be a number from 0 to the maximum no. of CPUs configured with
508	the <computeroutput>--cpus</computeroutput> option. CPU 0 can
509	never be removed.</para>
510	</listitem>
511
512	<listitem>
513	<para><computeroutput>--cpuexecutioncap
514	<1-100></computeroutput>: This setting controls how much cpu
515	time a virtual CPU can use. A value of 50 implies a single virtual
516	CPU can use up to 50% of a single host CPU.</para>
517	</listitem>
518
519	<listitem>
520	<para><computeroutput>--synthcpu on\|off</computeroutput>: This
521	setting determines whether VirtualBox will expose a synthetic CPU
522	to the guest to allow live migration between host systems that
523	differ significantly.</para>
524	</listitem>
525
526	<listitem>
527	<para><computeroutput>--pae on\|off</computeroutput>: This
528	enables/disables PAE (see <xref
529	linkend="settings-processor" />).</para>
530	</listitem>
531
532	<listitem>
533	<para><computeroutput>--hpet on\|off</computeroutput>: This
534	enables/disables a High Precision Event Timer (HPET) which can
535	replace the legacy system timers. This is turned off by default.
536	Note that Windows supports a HPET only from Vista onwards.</para>
537	</listitem>
538
539	<listitem>
540	<para><computeroutput>--hwvirtex on\|off</computeroutput>: This
541	enables or disables the use of hardware virtualization extensions
542	(Intel VT-x or AMD-V) in the processor of your host system; see
543	<xref linkend="hwvirt" />.</para>
544	</listitem>
545
546	<listitem>
547	<para><computeroutput>--hwvirtexexcl on\|off</computeroutput>: This
548	specifies whether VirtualBox will make exclusive use of the
549	hardware virtualization extensions (Intel VT-x or AMD-V) in the
550	processor of your host system; see <xref linkend="hwvirt" />. If
551	you wish to simultaneously share these extensions with other
552	hypervisors, then you must disable this setting. Doing so has
553	negative performance implications.</para>
554	</listitem>
555
556	<listitem>
557	<para><computeroutput>--nestedpaging on\|off</computeroutput>: If
558	hardware virtualization is enabled, this additional setting
559	enables or disables the use of the nested paging feature in the
560	processor of your host system; see <xref
561	linkend="hwvirt" />.</para>
562	</listitem>
563
564	<listitem>
565	<para><computeroutput>--largepages on\|off</computeroutput>: If
566	hardware virtualization <emphasis>and</emphasis> nested paging are
567	enabled, for Intel VT-x only, an additional performance
568	improvement of up to 5% can be obtained by enabling this setting.
569	This causes the hypervisor to use large pages to reduce TLB use
570	and overhead.</para>
571	</listitem>
572
573	<listitem>
574	<para><computeroutput>--vtxvpid on\|off</computeroutput>: If
575	hardware virtualization is enabled, for Intel VT-x only, this
576	additional setting enables or disables the use of the tagged TLB
577	(VPID) feature in the processor of your host system; see <xref
578	linkend="hwvirt" />.</para>
579	</listitem>
580
581	<listitem>
582	<para><computeroutput>--accelerate3d on\|off</computeroutput>: This
583	enables, if the Guest Additions are installed, whether hardware 3D
584	acceleration should be available; see <xref
585	linkend="guestadd-3d" />.</para>
586	</listitem>
587
588	<listitem>
589	<para>You can influence the BIOS logo that is displayed when a
590	virtual machine starts up with a number of settings. Per default,
591	a VirtualBox logo is displayed.</para>
592
593	<para>With <computeroutput>--bioslogofadein
594	on\|off</computeroutput> and <computeroutput>--bioslogofadeout
595	on\|off</computeroutput>, you can determine whether the logo should
596	fade in and out, respectively.</para>
597
598	<para>With <computeroutput>--bioslogodisplaytime
599	<msec></computeroutput> you can set how long the logo should
600	be visible, in milliseconds.</para>
601
602	<para>With <computeroutput>--bioslogoimagepath
603	<imagepath></computeroutput> you can, if you are so
604	inclined, replace the image that is shown, with your own logo. The
605	image must be an uncompressed 256 color BMP file.</para>
606	</listitem>
607
608	<listitem>
609	<para><computeroutput>--biosbootmenu
610	disabled\|menuonly\|messageandmenu</computeroutput>: This specifies
611	whether the BIOS allows the user to select a temporary boot
612	device. <computeroutput>menuonly</computeroutput> suppresses the
613	message, but the user can still press F12 to select a temporary
614	boot device.</para>
615	</listitem>
616
617	<listitem>
618	<para><computeroutput>--boot<1-4>
619	none\|floppy\|dvd\|disk\|net</computeroutput>: This specifies the boot
620	order for the virtual machine. There are four "slots", which the
621	VM will try to access from 1 to 4, and for each of which you can
622	set a device that the VM should attempt to boot from.</para>
623	</listitem>
624
625	<listitem>
626	<para><computeroutput>--snapshotfolder
627	default\|<path></computeroutput>: This allows you to specify
628	the folder in which snapshots will be kept for a virtual
629	machine.</para>
630	</listitem>
631
632	<listitem>
633	<para><computeroutput>--firmware efi\|bios</computeroutput>:
634	Specifies which firmware is used to boot particular virtual
635	machine: EFI or BIOS. Use EFI only if your fully understand what
636	you're doing.</para>
637	</listitem>
638
639	<listitem>
640	<para><computeroutput>--guestmemoryballoon
641	<size></computeroutput> sets the default size of the guest
642	memory balloon, that is, memory allocated by the VirtualBox Guest
643	Additions from the guest operating system and returned to the
644	hypervisor for re-use by other virtual machines. <size> must
645	be specified in megabytes. The default size is 0 megabytes. For
646	details, see <xref linkend="guestadd-balloon" />.</para>
647	</listitem>
648	</itemizedlist></para>
649	</sect2>
650
651	<sect2>
652	<title>Networking settings</title>
653
654	<para>The following networking settings are available through
655	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
656	settings, the decimal number directly following the option name ("1-N"
657	in the list below) specifies the virtual network adapter whose settings
658	should be changed.<itemizedlist>
659	<listitem>
660	<para><computeroutput>--nic<1-N>
661	none\|null\|nat\|bridged\|intnet\|hostonly\|vde</computeroutput>: With
662	this, you can set, for each of the VM's virtual network cards,
663	what type of networking should be available. They can be not
664	present (<computeroutput>none</computeroutput>), not connected to
665	the host (<computeroutput>null</computeroutput>), use network
666	address translation (<computeroutput>nat</computeroutput>),
667	bridged networking (<computeroutput>bridged</computeroutput>) or
668	communicate with other virtual machines using internal networking
669	(<computeroutput>intnet</computeroutput>), host-only networking
670	(<computeroutput>hostonly</computeroutput>) or on Linux and
671	FreeBSD hosts a Virtual Distributed Ethernet switch
672	(<computeroutput>vde</computeroutput>). These options correspond
673	to the modes which are described in detail in <xref
674	linkend="networkingmodes" />.</para>
675	</listitem>
676
677	<listitem>
678	<para><computeroutput>--nictype<1-N>
679	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
680	This allows you, for each of the VM's virtual network cards, to
681	specify which networking hardware VirtualBox presents to the
682	guest; see <xref linkend="nichardware" />.</para>
683	</listitem>
684
685	<listitem>
686	<para><computeroutput>--cableconnected<1-N>
687	on\|off</computeroutput>: This allows you to temporarily disconnect
688	a virtual network interface, as if a network cable had been pulled
689	from a real network card. This might be useful for resetting
690	certain software components in the VM.</para>
691	</listitem>
692
693	<listitem>
694	<para>With the "nictrace" options, you can optionally trace
695	network traffic by dumping it to a file, for debugging
696	purposes.</para>
697
698	<para>With <computeroutput>--nictrace<1-N>
699	on\|off</computeroutput>, you can enable network tracing for a
700	particular virtual network card.</para>
701
702	<para>If enabled, you must specify with
703	<computeroutput>--nictracefile<1-N>
704	<filename></computeroutput> what file the trace should be
705	logged to.</para>
706	</listitem>
707
708	<listitem>
709	<para><computeroutput>--bridgeadapter<1-N>
710	none\|<devicename></computeroutput>: If bridged networking
711	has been enabled for a virtual network card (see the
712	<computeroutput>--nic</computeroutput> option above; otherwise
713	this setting has no effect), use this option to specify which host
714	interface the given virtual network interface will use. For
715	details, please see <xref linkend="network_bridged" />.</para>
716	</listitem>
717
718	<listitem>
719	<para><computeroutput>--hostonlyadapter<1-N>
720	none\|<devicename></computeroutput>: If host-only networking
721	has been enabled for a virtual network card (see the --nic option
722	above; otherwise this setting has no effect), use this option to
723	specify which host-only networking interface the given virtual
724	network interface will use. For details, please see <xref
725	linkend="network_hostonly" />.</para>
726	</listitem>
727
728	<listitem>
729	<para><computeroutput>--intnet<1-N>
730	network</computeroutput>: If internal networking has been enabled
731	for a virtual network card (see the
732	<computeroutput>--nic</computeroutput> option above; otherwise
733	this setting has no effect), use this option to specify the name
734	of the internal network (see <xref
735	linkend="network_internal" />).</para>
736	</listitem>
737
738	<listitem>
739	<para><computeroutput>--macaddress<1-N>
740	auto\|<mac></computeroutput>: With this option you can set
741	the MAC address of the virtual network card. Normally, each
742	virtual network card is assigned a random address by VirtualBox at
743	VM creation.</para>
744	</listitem>
745
746	<listitem>
747	<para><computeroutput>--vdenet<1-N>
748	network</computeroutput>: If Virtual Distributed Ethernet is
749	available on the host and has been enabled for a virtual network
750	card (see the <computeroutput>--nic</computeroutput> option above;
751	otherwise this setting has no effect). Use this option to specify
752	the name of a VDE network for the interface to connect to (see
753	<xref linkend="networkingmodes" /> and the VDE
754	documentation).</para>
755	</listitem>
756	</itemizedlist></para>
757
758	<sect3>
759	<title>NAT Networking settings.</title>
760
761	<para>The following NAT networking settings are available through
762	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
763	settings, the decimal number directly following the option name ("1-N"
764	in the list below) specifies the virtual network adapter whose
765	settings should be changed.<itemizedlist>
766	<listitem>
767	<para><computeroutput>--natpf<1-N>
768	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
769	<guestport></computeroutput>: This option defines a NAT
770	port-forwarding rule (please see <xref linkend="natforward" />
771	for details).</para>
772	</listitem>
773
774	<listitem>
775	<para><computeroutput>--natpf<1-N> delete
776	<name></computeroutput>: This option deletes a NAT
777	port-forwarding rule (please see <xref linkend="natforward" />
778	for details).</para>
779	</listitem>
780
781	<listitem>
782	<para><computeroutput>--nattftpprefix<1-N>
783	<prefix></computeroutput>: This option defines a prefix
784	for the built-in TFTP server, i.e. where the boot file is
785	located (please see <xref linkend="nat-tftp" /> and <xref
786	linkend="nat-adv-tftp" /> for details).</para>
787	</listitem>
788
789	<listitem>
790	<para><computeroutput>--nattftpfile<1-N>
791	<bootfile></computeroutput>: This option defines the TFT
792	boot file (please see <xref linkend="nat-adv-tftp" /> for
793	details).</para>
794	</listitem>
795
796	<listitem>
797	<para><computeroutput>--nattftpserver<1-N>
798	<tftpserver></computeroutput>: This option defines the
799	TFTP server address to boot from (please see <xref
800	linkend="nat-adv-tftp" /> for details).</para>
801	</listitem>
802
803	<listitem>
804	<para><computeroutput>--natdnspassdomain<1-N>
805	on\|off</computeroutput>: This option specifies whether the
806	built-in DHCP server passes the domain name for network name
807	resolution.</para>
808	</listitem>
809
810	<listitem>
811	<para><computeroutput>--natdnsproxy<1-N>
812	on\|off</computeroutput>: This option makes the NAT engine proxy
813	all guest DNS requests to the host's DNS servers (please see
814	<xref linkend="nat-adv-dns" /> for details).</para>
815	</listitem>
816
817	<listitem>
818	<para><computeroutput>--natdnshostresolver<1-N>
819	on\|off</computeroutput>: This option makes the NAT engine use
820	the host's resolver mechanisms to handle DNS requests (please
821	see <xref linkend="nat-adv-dns" /> for details).</para>
822	</listitem>
823
824	<listitem>
825	<para><computeroutput>--natnatsettings<1-N>
826	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
827	[<tcprcv>]</computeroutput>: This option controls several
828	NAT settings (please see <xref linkend="nat-adv-settings" /> for
829	details).</para>
830	</listitem>
831
832	<listitem>
833	<para><computeroutput>--nataliasmode<1-N>
834	default\|[log],[proxyonly],[sameports]</computeroutput>: This
835	option defines behaviour of NAT engine core: log - enables
836	logging, proxyonly - switches of aliasing mode makes NAT
837	transparent, sameports enforces NAT engine to send packets via
838	the same port as they originated on, default - disable all
839	mentioned modes above . (please see <xref
840	linkend="nat-adv-alias" /> for details).</para>
841	</listitem>
842	</itemizedlist></para>
843	</sect3>
844	</sect2>
845
846	<sect2 id="vboxmanage-modifyvm-other">
847	<title>Serial port, audio, clipboard, remote desktop and USB
848	settings</title>
849
850	<para>The following other hardware settings are available through
851	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
852	<listitem>
853	<para><computeroutput>--uart<1-N> off\|<I/O base>
854	<IRQ></computeroutput>: With this option you can configure
855	virtual serial ports for the VM; see <xref
856	linkend="serialports" /> for an introduction.</para>
857	</listitem>
858
859	<listitem>
860	<para><computeroutput>--uartmode<1-N>
861	<arg></computeroutput>: This setting controls how VirtualBox
862	connects a given virtual serial port (previously configured with
863	the <computeroutput>--uartX</computeroutput> setting, see above)
864	to the host on which the virtual machine is running. As described
865	in detail in <xref linkend="serialports" />, for each such port,
866	you can specify <computeroutput><arg></computeroutput> as
867	one of the following options:<itemizedlist>
868	<listitem>
869	<para><computeroutput>disconnected</computeroutput>: Even
870	though the serial port is shown to the guest, it has no
871	"other end" -- like a real COM port without a cable.</para>
872	</listitem>
873
874	<listitem>
875	<para><computeroutput>server
876	<pipename></computeroutput>: On a Windows host, this
877	tells VirtualBox to create a named pipe on the host named
878	<computeroutput><pipename></computeroutput> and
879	connect the virtual serial device to it. Note that Windows
880	requires that the name of a named pipe begin with
881	<computeroutput>\\.\pipe\</computeroutput>.</para>
882
883	<para>On a Linux host, instead of a named pipe, a local
884	domain socket is used.</para>
885	</listitem>
886
887	<listitem>
888	<para><computeroutput>client
889	<pipename></computeroutput>: This operates just like
890	<computeroutput>server ...</computeroutput>, except that the
891	pipe (or local domain socket) is not created by VirtualBox,
892	but assumed to exist already.</para>
893	</listitem>
894
895	<listitem>
896	<para><computeroutput><devicename></computeroutput>:
897	If, instead of the above, the device name of a physical
898	hardware serial port of the host is specified, the virtual
899	serial port is connected to that hardware port. On a Windows
900	host, the device name will be a COM port such as
901	<computeroutput>COM1</computeroutput>; on a Linux host, the
902	device name will look like
903	<computeroutput>/dev/ttyS0</computeroutput>. This allows you
904	to "wire" a real serial port to a virtual machine.</para>
905	</listitem>
906	</itemizedlist></para>
907	</listitem>
908
909	<listitem>
910	<para><computeroutput>--audio none\|null\|oss</computeroutput>: With
911	this option, you can set whether the VM should have audio
912	support.</para>
913	</listitem>
914
915	<listitem>
916	<para><computeroutput>--clipboard
917	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
918	With this setting, you can select whether the guest operating
919	system's clipboard should be shared with the host; see <xref
920	linkend="generalsettings" />. This requires that the Guest
921	Additions be installed in the virtual machine.</para>
922	</listitem>
923
924	<listitem>
925	<para><computeroutput>--monitorcount
926	<count></computeroutput>: This enables multi-monitor
927	support; see <xref linkend="settings-display" />.</para>
928	</listitem>
929
930	<listitem>
931	<para><computeroutput>--usb on\|off</computeroutput>: This option
932	enables or disables the VM's virtual USB controller; see <xref
933	linkend="settings-usb" /> for details.</para>
934	</listitem>
935
936	<listitem>
937	<para><computeroutput>--usbehci on\|off</computeroutput>: This
938	option enables or disables the VM's virtual USB 2.0 controller;
939	see <xref linkend="settings-usb" /> for details.</para>
940	</listitem>
941	</itemizedlist></para>
942	</sect2>
943
944	<sect2>
945	<title>Remote machine settings</title>
946
947	<para>The following settings that affect remote machine behavior are
948	available through <computeroutput>VBoxManage
949	modifyvm</computeroutput>:<itemizedlist>
950	<listitem>
951	<para><computeroutput>--vrde on\|off</computeroutput>: With the
952	VirtualBox graphical user interface, this enables or disables the
953	VirtualBox remote desktop extension (VRDE) server. Note that if
954	you are using <computeroutput>VBoxHeadless</computeroutput> (see
955	<xref linkend="vboxheadless" />), VRDE is enabled by
956	default.</para>
957	</listitem>
958
959	<listitem>
960	<para><computeroutput>--vrdeport
961	default\|<ports></computeroutput>: A port or a range of ports
962	the VRDE server can bind to; "default" or "0" means port 3389, the
963	standard port for RDP. You can specify a comma-separated list of
964	ports or ranges of ports. Use a dash between two port numbers to
965	specify a range. The VRDE server will bind to <emphasis
966	role="bold">one</emphasis> of available ports from the specified
967	list. Only one machine can use a given port at a time. For
968	example, the option <computeroutput> --vrdeport
969	5000,5010-5012</computeroutput> will tell the server to bind to
970	one of following ports: 5000, 5010, 5011 or 5012.</para>
971	</listitem>
972
973	<listitem>
974	<para><computeroutput>--vrdeaddress <IP
975	address></computeroutput>: The IP address of the host network
976	interface the VRDE server will bind to. If specified, the server
977	will accept connections only on the specified host network
978	interface.</para>
979	</listitem>
980
981	<listitem>
982	<para><computeroutput>--vrdeauthtype
983	null\|external\|guest</computeroutput>: This allows you to choose
984	whether and how authorization will be performed; see <xref
985	linkend="vbox-auth" /> for details.</para>
986	</listitem>
987
988	<listitem>
989	<para><computeroutput>--vrdemulticon on\|off</computeroutput>: This
990	enables multiple connections to the same VRDE server, if the
991	server supports this feature; see <xref lang=""
992	linkend="vrde-multiconnection" />.</para>
993	</listitem>
994
995	<listitem>
996	<para><computeroutput>--vrdereusecon on\|off</computeroutput>: This
997	specifies the VRDE server behavior when multiple connections are
998	disabled. When this option is enabled, the server will allow a new
999	client to connect and will drop the existing connection. When this
1000	option is disabled (this is the default setting), a new connection
1001	will not be accepted if there is already a client connected to the
1002	server.</para>
1003	</listitem>
1004
1005	<listitem>
1006	<para><computeroutput>--vrdevideochannel on\|off</computeroutput>:
1007	This enables video redirection, if it is supported by the VRDE
1008	server; see <xref lang="" linkend="vrde-videochannel" />.</para>
1009	</listitem>
1010
1011	<listitem>
1012	<para><computeroutput>--vrdevideochannelquality
1013	<percent></computeroutput>: Sets the image quality for video
1014	redirection; see <xref lang=""
1015	linkend="vrde-videochannel" />.</para>
1016	</listitem>
1017	</itemizedlist></para>
1018	</sect2>
1019
1020	<sect2 id="vboxmanage-modifyvm-teleport">
1021	<title>Teleporting settings</title>
1022
1023	<para>With the following commands for <computeroutput>VBoxManage
1024	modifyvm</computeroutput> you can configure a machine to be a target for
1025	teleporting. See <xref linkend="teleporting" /> for an
1026	introduction.<itemizedlist>
1027	<listitem>
1028	<para><computeroutput>--teleporter on\|off</computeroutput>: With
1029	this setting you turn on or off whether a machine waits for a
1030	teleporting request to come in on the network when it is started.
1031	If "on", when the machine is started, it does not boot the virtual
1032	machine as it would normally; instead, it then waits for a
1033	teleporting request to come in on the port and address listed with
1034	the next two parameters.</para>
1035	</listitem>
1036
1037	<listitem>
1038	<para><computeroutput>--teleporterport
1039	<port></computeroutput>, <computeroutput>--teleporteraddress
1040	<address></computeroutput>: these must be used with
1041	--teleporter and tell the virtual machine on which port and
1042	address it should listen for a teleporting request from another
1043	virtual machine. <computeroutput><port></computeroutput> can
1044	be any free TCP/IP port number (e.g. 6000);
1045	<computeroutput><address></computeroutput> can be any IP
1046	address or hostname and specifies the TCP/IP socket to bind to.
1047	The default is "0.0.0.0", which means any address.</para>
1048	</listitem>
1049
1050	<listitem>
1051	<para><computeroutput>--teleporterpassword
1052	<password></computeroutput>: if this optional argument is
1053	given, then the teleporting request will only succeed if the
1054	source machine specifies the same password as the one given with
1055	this command.<note>
1056	<para>Currently, the password is stored without encryption
1057	(i.e. in clear text) in the XML machine configuration
1058	file.</para>
1059	</note></para>
1060	</listitem>
1061
1062	<listitem>
1063	<para><computeroutput>--cpuid <leaf> <eax> <ebx>
1064	<ecx> <edx></computeroutput>: Advanced users can use
1065	this command before a teleporting operation to restrict the
1066	virtual CPU capabilities that VirtualBox presents to the guest
1067	operating system. This must be run on both the source and the
1068	target machines involved in the teleporting and will then modify
1069	what the guest sees when it executes the
1070	<computeroutput>CPUID</computeroutput> machine instruction. This
1071	might help with misbehaving applications that wrongly assume that
1072	certain CPU capabilities are present. The meaning of the
1073	parameters is hardware dependent; please refer to the AMD or Intel
1074	processor manuals.</para>
1075	</listitem>
1076	</itemizedlist></para>
1077	</sect2>
1078	</sect1>
1079
1080	<sect1 id="vboxmanage-import">
1081	<title>VBoxManage import</title>
1082
1083	<para>This command imports a virtual appliance in OVF format by copying
1084	the virtual disk images and creating virtual machines in VirtualBox. See
1085	<xref linkend="ovf" /> for an introduction to appliances.</para>
1086
1087	<para>The <computeroutput>import</computeroutput> subcommand takes at
1088	least the path name of an OVF file as input and expects the disk images,
1089	if needed, in the same directory as the OVF file. A lot of additional
1090	command-line options are supported to control in detail what is being
1091	imported and modify the import parameters, but the details depend on the
1092	content of the OVF file.</para>
1093
1094	<para>It is therefore recommended to first run the import subcommand with
1095	the <computeroutput>--dry-run</computeroutput> or
1096	<computeroutput>-n</computeroutput> option. This will then print a
1097	description of the appliance's contents to the screen how it would be
1098	imported into VirtualBox, together with the optional command-line options
1099	to influence the import behavior.</para>
1100
1101	<para>As an example, here is the screen output with a sample appliance
1102	containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
1103	Interpreting WindowsXp.ovf...
1104	OK.
1105	Virtual system 0:
1106	0: Suggested OS type: "WindowsXP"
1107	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1108	1: Suggested VM name "Windows XP Professional_1"
1109	(change with "--vsys 0 --vmname <name>")
1110	3: Number of CPUs: 1
1111	(change with "--vsys 0 --cpus <n>")
1112	4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
1113	5: Sound card (appliance expects "ensoniq1371", can change on import)
1114	(disable with "--vsys 0 --unit 5 --ignore")
1115	6: USB controller
1116	(disable with "--vsys 0 --unit 6 --ignore")
1117	7: Network adapter: orig bridged, config 2, extra type=bridged
1118	8: Floppy
1119	(disable with "--vsys 0 --unit 8 --ignore")
1120	9: SCSI controller, type BusLogic
1121	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
1122	disable with "--vsys 0 --unit 9 --ignore")
1123	10: IDE controller, type PIIX4
1124	(disable with "--vsys 0 --unit 10 --ignore")
1125	11: Hard disk image: source image=WindowsXp.vmdk,
1126	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
1127	(change controller with "--vsys 0 --unit 11 --controller <id>";
1128	disable with "--vsys 0 --unit 11 --ignore")</screen></para>
1129
1130	<para>As you can see, the individual configuration items are numbered, and
1131	depending on their type support different command-line options. The import
1132	subcommand can be directed to ignore many such items with a
1133	<computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
1134	X is the number of the virtual system (zero unless there are several
1135	virtual system descriptions in the appliance) and Y the item number, as
1136	printed on the screen.</para>
1137
1138	<para>In the above example, Item #1 specifies the name of the target
1139	machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
1140	respectively. Item #11 describes a hard disk image; in this case, the
1141	additional <computeroutput>--controller</computeroutput> option indicates
1142	which item the disk image should be connected to, with the default coming
1143	from the OVF file.</para>
1144
1145	<para>You can combine several items for the same virtual system behind the
1146	same <computeroutput>--vsys</computeroutput> option. For example, to
1147	import a machine as described in the OVF, but without the sound card and
1148	without the USB controller, and with the disk image connected to the IDE
1149	controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
1150	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
1151	</sect1>
1152
1153	<sect1 id="vboxmanage-export">
1154	<title>VBoxManage export</title>
1155
1156	<para>This command exports one or more virtual machines from VirtualBox
1157	into a virtual appliance in OVF format, including copying their virtual
1158	disk images to compressed VMDK. See <xref linkend="ovf" /> for an
1159	introduction to appliances.</para>
1160
1161	<para>The <computeroutput>export</computeroutput> command is simple to
1162	use: list the machine (or the machines) that you would like to export to
1163	the same OVF file and specify the target OVF file after an additional
1164	<computeroutput>--output</computeroutput> or
1165	<computeroutput>-o</computeroutput> option. Note that the directory of the
1166	target OVF file will also receive the exported disk images in the
1167	compressed VMDK format (regardless of the original format) and should have
1168	enough disk space left for them.</para>
1169
1170	<para>Beside a simple export of a given virtual machine, you can append
1171	several product information to the appliance file. Use
1172	<computeroutput>--product</computeroutput>,
1173	<computeroutput>--producturl</computeroutput>,
1174	<computeroutput>--vendor</computeroutput>,
1175	<computeroutput>--vendorurl</computeroutput> and
1176	<computeroutput>--version</computeroutput> to specify this additional
1177	information. For legal reasons you may add a license text or the content
1178	of a license file by using the <computeroutput>--eula</computeroutput> and
1179	<computeroutput>--eulafile</computeroutput> option respectively. As with
1180	OVF import, you must use the <computeroutput>--vsys X</computeroutput>
1181	option to direct the previously mentioned options to the correct virtual
1182	machine.</para>
1183
1184	<para>For virtualization products which aren't fully compatible with the
1185	OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
1186	<computeroutput>--legacy09</computeroutput> option.</para>
1187	</sect1>
1188
1189	<sect1 id="vboxmanage-startvm">
1190	<title>VBoxManage startvm</title>
1191
1192	<para>This command starts a virtual machine that is currently in the
1193	"Powered off" or "Saved" states.</para>
1194
1195	<note>
1196	<para>This is provided for backwards compatibility only. We recommend to
1197	start virtual machines directly by running the respective front-end, as
1198	you might otherwise miss important error and state information that
1199	VirtualBox may display on the console. This is especially important for
1200	front-ends other than <computeroutput>VirtualBox</computeroutput>, our
1201	graphical user interface, because those cannot display error messages in
1202	a popup window. See <xref linkend="vboxheadless" /> for more
1203	information.</para>
1204	</note>
1205
1206	<para>The optional <computeroutput>--type</computeroutput> specifier
1207	determines whether the machine will be started in a window (GUI mode,
1208	which is the default) or whether the output should go through
1209	<computeroutput>VBoxHeadless</computeroutput>, with VRDE enabled or not;
1210	see <xref linkend="vboxheadless" /> for more information. The list of
1211	types is subject to change, and it's not guaranteed that all types are
1212	accepted by any product variant.</para>
1213
1214	<para>The following values are allowed:</para>
1215
1216	<glosslist>
1217	<glossentry>
1218	<glossterm>gui</glossterm>
1219
1220	<glossdef>
1221	<para>Starts a VM showing a GUI window. This is the default.</para>
1222	</glossdef>
1223	</glossentry>
1224
1225	<glossentry>
1226	<glossterm>headless</glossterm>
1227
1228	<glossdef>
1229	<para>Starts a VM without a window for remote display only.</para>
1230	</glossdef>
1231	</glossentry>
1232	</glosslist>
1233	</sect1>
1234
1235	<sect1 id="vboxmanage-controlvm">
1236	<title>VBoxManage controlvm</title>
1237
1238	<para>The <computeroutput>controlvm</computeroutput> subcommand allows you
1239	to change the state of a virtual machine that is currently running. The
1240	following can be specified:</para>
1241
1242	<para><itemizedlist>
1243	<listitem>
1244	<para><computeroutput>VBoxManage controlvm <vm>
1245	pause</computeroutput> temporarily puts a virtual machine on hold,
1246	without changing its state for good. The VM window will be painted
1247	in gray to indicate that the VM is currently paused. (This is
1248	equivalent to selecting the "Pause" item in the "Machine" menu of
1249	the GUI.)</para>
1250	</listitem>
1251
1252	<listitem>
1253	<para>Use <computeroutput>VBoxManage controlvm <vm>
1254	resume</computeroutput> to undo a previous
1255	<computeroutput>pause</computeroutput> command. (This is equivalent
1256	to selecting the "Resume" item in the "Machine" menu of the
1257	GUI.)</para>
1258	</listitem>
1259
1260	<listitem>
1261	<para><computeroutput>VBoxManage controlvm <vm>
1262	reset</computeroutput> has the same effect on a virtual machine as
1263	pressing the "Reset" button on a real computer: a cold reboot of the
1264	virtual machine, which will restart and boot the guest operating
1265	system again immediately. The state of the VM is not saved
1266	beforehand, and data may be lost. (This is equivalent to selecting
1267	the "Reset" item in the "Machine" menu of the GUI.)</para>
1268	</listitem>
1269
1270	<listitem>
1271	<para><computeroutput>VBoxManage controlvm <vm>
1272	poweroff</computeroutput> has the same effect on a virtual machine
1273	as pulling the power cable on a real computer. Again, the state of
1274	the VM is not saved beforehand, and data may be lost. (This is
1275	equivalent to selecting the "Close" item in the "Machine" menu of
1276	the GUI or pressing the window's close button, and then selecting
1277	"Power off the machine" in the dialog.)</para>
1278
1279	<para>After this, the VM's state will be "Powered off". From there,
1280	it can be started again; see <xref
1281	linkend="vboxmanage-startvm" />.</para>
1282	</listitem>
1283
1284	<listitem>
1285	<para><computeroutput>VBoxManage controlvm <vm>
1286	savestate</computeroutput> will save the current state of the VM to
1287	disk and then stop the VM. (This is equivalent to selecting the
1288	"Close" item in the "Machine" menu of the GUI or pressing the
1289	window's close button, and then selecting "Save the machine state"
1290	in the dialog.)</para>
1291
1292	<para>After this, the VM's state will be "Saved". From there, it can
1293	be started again; see <xref linkend="vboxmanage-startvm" />.</para>
1294	</listitem>
1295
1296	<listitem>
1297	<para><computeroutput>VBoxManage controlvm <vm> teleport
1298	--hostname <name> --port <port> [--password
1299	<password>]</computeroutput> makes the machine the source of a
1300	teleporting operation and initiates a teleport to the given target.
1301	See <xref linkend="teleporting" /> for an introduction. If the
1302	optional password is specified, it must match the password that was
1303	given to the <computeroutput>modifyvm</computeroutput> command for
1304	the target machine; see <xref
1305	linkend="vboxmanage-modifyvm-teleport" /> for details.</para>
1306	</listitem>
1307	</itemizedlist></para>
1308
1309	<para>A few extra options are available with
1310	<computeroutput>controlvm</computeroutput> that do not directly affect the
1311	VM's running state:</para>
1312
1313	<itemizedlist>
1314	<listitem>
1315	<para>The <computeroutput>setlinkstate<1-N></computeroutput>
1316	operation connects or disconnects virtual network cables from their
1317	network interfaces.</para>
1318	</listitem>
1319
1320	<listitem>
1321	<para><computeroutput>nic<1-N>
1322	null\|nat\|bridged\|intnet\|hostonly</computeroutput>: With this, you can
1323	set, for each of the VM's virtual network cards, what type of
1324	networking should be available. They can be not connected to the host
1325	(<computeroutput>null</computeroutput>), use network address
1326	translation (<computeroutput>nat</computeroutput>), bridged networking
1327	(<computeroutput>bridged</computeroutput>) or communicate with other
1328	virtual machines using internal networking
1329	(<computeroutput>intnet</computeroutput>) or host-only networking
1330	(<computeroutput>hostonly</computeroutput>). These options correspond
1331	to the modes which are described in detail in <xref
1332	linkend="networkingmodes" />.</para>
1333	</listitem>
1334
1335	<listitem>
1336	<para><computeroutput>usbattach</computeroutput> and
1337	<computeroutput>usbdettach</computeroutput> make host USB devices
1338	visible to the virtual machine on the fly, without the need for
1339	creating filters first. The USB devices can be specified by UUID
1340	(unique identifier) or by address on the host system.</para>
1341
1342	<para>You can use <computeroutput>VBoxManage list
1343	usbhost</computeroutput> to locate this information.</para>
1344	</listitem>
1345
1346	<listitem>
1347	<para><computeroutput>vrde on\|off</computeroutput> lets you enable or
1348	disable the VRDE server, if it is installed.</para>
1349	</listitem>
1350
1351	<listitem>
1352	<para><computeroutput>vrdeport default\|<ports></computeroutput>
1353	changes the port or a range of ports that the VRDE server can bind to;
1354	"default" or "0" means port 3389, the standard port for RDP. For
1355	details, see the description for the
1356	<computeroutput>--vrdeport</computeroutput> option in <xref
1357	linkend="vboxmanage-modifyvm-other" />.</para>
1358	</listitem>
1359
1360	<listitem>
1361	<para><computeroutput>setvideomodehint</computeroutput> requests that
1362	the guest system change to a particular video mode. This requires that
1363	the Guest Additions be installed, and will not work for all guest
1364	systems.</para>
1365	</listitem>
1366
1367	<listitem>
1368	<para>The <computeroutput>setcredentials</computeroutput> operation is
1369	used for remote logons in Windows guests. For details, please refer to
1370	<xref linkend="autologon" />.</para>
1371	</listitem>
1372
1373	<listitem>
1374	<para>The <computeroutput>guestmemoryballoon</computeroutput>
1375	operation changes the size of the guest memory balloon, that is,
1376	memory allocated by the VirtualBox Guest Additions from the guest
1377	operating system and returned to the hypervisor for re-use by other
1378	virtual machines. This must be specified in megabytes. For details,
1379	see <xref linkend="guestadd-balloon" />.</para>
1380	</listitem>
1381
1382	<listitem>
1383	<para>The <computeroutput>cpuexecutioncap
1384	<1-100></computeroutput>: This operation controls how much cpu
1385	time a virtual CPU can use. A value of 50 implies a single virtual CPU
1386	can use up to 50% of a single host CPU.</para>
1387	</listitem>
1388	</itemizedlist>
1389	</sect1>
1390
1391	<sect1>
1392	<title>VBoxManage discardstate</title>
1393
1394	<para>This command discards the saved state of a virtual machine which is
1395	not currently running, which will cause its operating system to restart
1396	next time you start it. This is the equivalent of pulling out the power
1397	cable on a physical machine, and should be avoided if possible.</para>
1398	</sect1>
1399
1400	<sect1>
1401	<title>VBoxManage adoptstate</title>
1402
1403	<para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
1404	that is seperate from the VM configuration, you can use this command to
1405	"adopt" the file. This will change the VM to saved state and when you
1406	start it, VirtualBox will attempt to restore it from the saved state file
1407	you indicated. This command should only be used in special setups.</para>
1408	</sect1>
1409
1410	<sect1>
1411	<title>VBoxManage snapshot</title>
1412
1413	<para>This command is used to control snapshots from the command line. A
1414	snapshot consists of a complete copy of the virtual machine settings,
1415	copied at the time when the snapshot was taken, and optionally a virtual
1416	machine saved state file if the snapshot was taken while the machine was
1417	running. After a snapshot has been taken, VirtualBox creates differencing
1418	hard disk for each normal hard disk associated with the machine so that
1419	when a snapshot is restored, the contents of the virtual machine's virtual
1420	hard disks can be quickly reset by simply dropping the pre-existing
1421	differencing files.</para>
1422
1423	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
1424	of the current state of the virtual machine. You must supply a name for
1425	the snapshot and can optionally supply a description. The new snapshot is
1426	inserted into the snapshots tree as a child of the current snapshot and
1427	then becomes the new current snapshot.</para>
1428
1429	<para>The <computeroutput>delete</computeroutput> operation deletes a
1430	snapshot (specified by name or by UUID). This can take a while to finish
1431	since the differencing images associated with the snapshot might need to
1432	be merged with their child differencing images.</para>
1433
1434	<para>The <computeroutput>restore</computeroutput> operation will restore
1435	the given snapshot (specified by name or by UUID) by resetting the virtual
1436	machine's settings and current state to that of the snapshot. The previous
1437	current state of the machine will be lost. After this, the given snapshot
1438	becomes the new "current" snapshot so that subsequent snapshots are
1439	inserted under the snapshot from which was restored.</para>
1440
1441	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
1442	shortcut to restore the current snapshot (i.e. the snapshot from which the
1443	current state is derived). This subcommand is equivalent to using the
1444	"restore" subcommand with the name or UUID of the current snapshot, except
1445	that it avoids the extra step of determining that name or UUID.</para>
1446
1447	<para>With the <computeroutput>edit</computeroutput> operation, you can
1448	change the name or description of an existing snapshot.</para>
1449
1450	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
1451	can view the virtual machine settings that were stored with an existing
1452	snapshot.</para>
1453	</sect1>
1454
1455	<sect1 id="vboxmanage-closemedium">
1456	<title>VBoxManage closemedium</title>
1457
1458	<para>This commands removes a hard disk, DVD or floppy image from a
1459	VirtualBox media registry.<footnote>
1460	<para>Before VirtualBox 4.0, it was necessary to call VBoxManage
1461	openmedium before a medium could be attached to a virtual machine;
1462	that call "registered" the medium with the global VirtualBox media
1463	registry. With VirtualBox 4.0 this is no longer necessary; media are
1464	added to media registries automatically. The "closemedium" call has
1465	been retained, however, to allow for explicitly removing a medium from
1466	a registry.</para>
1467	</footnote></para>
1468
1469	<para>Optionally, you can request that the image be deleted. You will get
1470	appropriate diagnostics that the deletion failed, however the image will
1471	become unregistered in any case.</para>
1472	</sect1>
1473
1474	<sect1>
1475	<title id="vboxmanage-storageattach">VBoxManage storageattach</title>
1476
1477	<para>This command attaches/modifies/removes a storage medium connected to
1478	a storage controller that was previously added with the
1479	<computeroutput>storagectl</computeroutput> command (see the previous
1480	section). The syntax is as follows:</para>
1481
1482	<screen>VBoxManage storageattach <uuid\|vmname>
1483	--storagectl <name>
1484	--port <number>
1485	--device <number>
1486	[--type dvddrive\|hdd\|fdd]
1487	[--medium none\|emptydrive\|
1488	<uuid>\|<filename>\|host:<drive>\|iscsi]
1489	[--mtype normal\|writethrough\|immutable\|shareable]
1490	[--comment <text>]
1491	[--passthrough on\|off]
1492	[--bandwidthgroup name\|none]
1493	[--forceunmount]
1494	[--server <name>\|<ip>]
1495	[--target <target>]
1496	[--port <port>]
1497	[--lun <lun>]
1498	[--encodedlun <lun>]
1499	[--username <username>]
1500	[--password <password>]
1501	[--intnet]
1502	</screen>
1503
1504	<para>A number of parameters are commonly required; the ones at the end of
1505	the list are required only for iSCSI targets (see below).</para>
1506
1507	<para>The common parameters are:<glosslist>
1508	<glossentry>
1509	<glossterm>uuid\|vmname</glossterm>
1510
1511	<glossdef>
1512	<para>The VM UUID or VM Name. Mandatory.</para>
1513	</glossdef>
1514	</glossentry>
1515
1516	<glossentry>
1517	<glossterm>storagectl</glossterm>
1518
1519	<glossdef>
1520	<para>Name of the storage controller. Mandatory. The list of the
1521	storage controllers currently attached to a VM can be obtained
1522	with <computeroutput>VBoxManage showvminfo</computeroutput>; see
1523	<xref linkend="vboxmanage-showvminfo" />.</para>
1524	</glossdef>
1525	</glossentry>
1526
1527	<glossentry>
1528	<glossterm>port</glossterm>
1529
1530	<glossdef>
1531	<para>The number of the storage controller's port which is to be
1532	modified. Mandatory.</para>
1533	</glossdef>
1534	</glossentry>
1535
1536	<glossentry>
1537	<glossterm>device</glossterm>
1538
1539	<glossdef>
1540	<para>The number of the port's device which is to be modified.
1541	Mandatory.</para>
1542	</glossdef>
1543	</glossentry>
1544
1545	<glossentry>
1546	<glossterm>type</glossterm>
1547
1548	<glossdef>
1549	<para>Define the type of the drive to which the medium is being
1550	attached/detached/modified. This argument can only be omitted if
1551	the type of medium can be determined from either the medium given
1552	with the <computeroutput>--medium</computeroutput> argument or
1553	from a previous medium attachment.</para>
1554	</glossdef>
1555	</glossentry>
1556
1557	<glossentry>
1558	<glossterm>medium</glossterm>
1559
1560	<glossdef>
1561	<para>Specifies what is to be attached. The following values are
1562	supported:<itemizedlist>
1563	<listitem>
1564	<para>"none": Any existing device should be removed from the
1565	given slot.</para>
1566	</listitem>
1567
1568	<listitem>
1569	<para>"emptydrive": For a virtual DVD or floppy drive only,
1570	this makes the device slot behaves like a removeable drive
1571	into which no media has been inserted.</para>
1572	</listitem>
1573
1574	<listitem>
1575	<para>If a UUID is specified, it must be the UUID of a
1576	storage medium that is already known to VirtualBox (e.g.
1577	because it has been attached to another virtual machine).
1578	See <xref linkend="vboxmanage-list" /> for how to list known
1579	media. This medium is then attached to the given device
1580	slot.</para>
1581	</listitem>
1582
1583	<listitem>
1584	<para>If a filename is specified, it must be the full path
1585	of an existing disk image (ISO, RAW, VDI, VMDK or other),
1586	which is then attached to the given device slot.</para>
1587	</listitem>
1588
1589	<listitem>
1590	<para>"host:<drive>": For a virtual DVD or floppy
1591	drive only, this connects the given device slot to the
1592	specified DVD or floppy drive on the host computer.</para>
1593	</listitem>
1594
1595	<listitem>
1596	<para>"iscsi": For virtual hard disks only, this allows for
1597	specifying an iSCSI target. In this case, more parameters
1598	must be given; see below.</para>
1599	</listitem>
1600	</itemizedlist></para>
1601
1602	<para>Some of the above changes, in particular for removeable
1603	media (floppies and CDs/DVDs), can be effected while a VM is
1604	running. Others (device changes or changes in hard disk device
1605	slots) require the VM to be powered off.</para>
1606	</glossdef>
1607	</glossentry>
1608
1609	<glossentry>
1610	<glossterm>mtype</glossterm>
1611
1612	<glossdef>
1613	<para>Defines how this medium behaves with respect to snapshots
1614	and write operations. See <xref linkend="hdimagewrites" /> for
1615	details.</para>
1616	</glossdef>
1617	</glossentry>
1618
1619	<glossentry>
1620	<glossterm>comment</glossterm>
1621
1622	<glossdef>
1623	<para>Any description that you want to have stored with this
1624	medium (optional; for example, for an iSCSI target, "Big storage
1625	server downstairs"). This is purely descriptive and not needed for
1626	the medium to function correctly.</para>
1627	</glossdef>
1628	</glossentry>
1629
1630	<glossentry>
1631	<glossterm>passthrough</glossterm>
1632
1633	<glossdef>
1634	<para>For a virtual DVD drive only, you can enable DVD writing
1635	support (currently experimental; see <xref
1636	linkend="storage-cds" />).</para>
1637	</glossdef>
1638	</glossentry>
1639
1640	<glossentry>
1641	<glossterm>bandwidthgroup</glossterm>
1642
1643	<glossdef>
1644	<para>Sets the bandwidth group to use for the given device; see
1645	<xref linkend="storage-bandwidth-limit" />.</para>
1646	</glossdef>
1647	</glossentry>
1648
1649	<glossentry>
1650	<glossterm>forceunmount</glossterm>
1651
1652	<glossdef>
1653	<para>For a virtual DVD or floppy drive only, this forcibly
1654	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
1655	the previous one is locked down by the guest for reading. Again,
1656	see <xref linkend="storage-cds" /> for details.</para>
1657	</glossdef>
1658	</glossentry>
1659	</glosslist></para>
1660
1661	<para>When "iscsi" is used with the
1662	<computeroutput>--medium</computeroutput> parameter for iSCSI support --
1663	see <xref linkend="storage-iscsi" /> --, additional parameters must or can
1664	be used:<glosslist>
1665	<glossentry>
1666	<glossterm>server</glossterm>
1667
1668	<glossdef>
1669	<para>The host name or IP address of the iSCSI target;
1670	required.</para>
1671	</glossdef>
1672	</glossentry>
1673
1674	<glossentry>
1675	<glossterm>target</glossterm>
1676
1677	<glossdef>
1678	<para>Target name string. This is determined by the iSCSI target
1679	and used to identify the storage resource; required.</para>
1680	</glossdef>
1681	</glossentry>
1682
1683	<glossentry>
1684	<glossterm>port</glossterm>
1685
1686	<glossdef>
1687	<para>TCP/IP port number of the iSCSI service on the target
1688	(optional).</para>
1689	</glossdef>
1690	</glossentry>
1691
1692	<glossentry>
1693	<glossterm>lun</glossterm>
1694
1695	<glossdef>
1696	<para>Logical Unit Number of the target resource (optional).
1697	Often, this value is zero.</para>
1698	</glossdef>
1699	</glossentry>
1700
1701	<glossentry>
1702	<glossterm>username, password</glossterm>
1703
1704	<glossdef>
1705	<para>Username and password for target authentication, if required
1706	(optional).<note>
1707	<para>Currently, username and password are stored without
1708	encryption (i.e. in clear text) in the XML machine
1709	configuration file.</para>
1710	</note></para>
1711	</glossdef>
1712	</glossentry>
1713
1714	<glossentry>
1715	<glossterm>intnet</glossterm>
1716
1717	<glossdef>
1718	<para>If specified, connect to the iSCSI target via Internal
1719	Networking. This needs further configuration which is described in
1720	<xref linkend="iscsi-intnet" />.</para>
1721	</glossdef>
1722	</glossentry>
1723	</glosslist></para>
1724	</sect1>
1725
1726	<sect1 id="vboxmanage-storagectl">
1727	<title>VBoxManage storagectl</title>
1728
1729	<para>This command attaches/modifies/removes a storage controller. After
1730	this, virtual media can be attached to the controller with the
1731	<computeroutput>storageattach</computeroutput> command (see the next
1732	section).</para>
1733
1734	<para>The syntax is as follows:</para>
1735
1736	<screen>VBoxManage storagectl <uuid\|vmname>
1737	--name <name>
1738	[--add <ide/sata/scsi/floppy>]
1739	[--controller <LsiLogic/BusLogic/IntelAhci/PIIX3/
1740	PIIX4/ICH6/I8207>]
1741	[--sataideemulation<1-4> <1-30>]
1742	[--sataportcount <1-30>]
1743	[--hostiocache on\|off]
1744	[--remove]</screen>
1745
1746	<para>where the parameters mean: <glosslist>
1747	<glossentry>
1748	<glossterm>uuid\|vmname</glossterm>
1749
1750	<glossdef>
1751	<para>The VM UUID or VM Name. Mandatory.</para>
1752	</glossdef>
1753	</glossentry>
1754
1755	<glossentry>
1756	<glossterm>name</glossterm>
1757
1758	<glossdef>
1759	<para>Name of the storage controller. Mandatory.</para>
1760	</glossdef>
1761	</glossentry>
1762
1763	<glossentry>
1764	<glossterm>add</glossterm>
1765
1766	<glossdef>
1767	<para>Define the type of the system bus to which the storage
1768	controller must be connected.</para>
1769	</glossdef>
1770	</glossentry>
1771
1772	<glossentry>
1773	<glossterm>controller</glossterm>
1774
1775	<glossdef>
1776	<para>Allows to choose the type of chipset being emulated for the
1777	given storage controller.</para>
1778	</glossdef>
1779	</glossentry>
1780
1781	<glossentry>
1782	<glossterm>sataideemulation</glossterm>
1783
1784	<glossdef>
1785	<para>This specifies which SATA ports should operate in IDE
1786	emulation mode. As explained in <xref
1787	linkend="harddiskcontrollers" />, by default, this is the case for
1788	SATA ports 1-4; with this command, you can map four IDE channels
1789	to any of the 30 supported SATA ports.</para>
1790	</glossdef>
1791	</glossentry>
1792
1793	<glossentry>
1794	<glossterm>sataportcount</glossterm>
1795
1796	<glossdef>
1797	<para>This determines how many ports the SATA controller should
1798	support.</para>
1799	</glossdef>
1800	</glossentry>
1801
1802	<glossentry>
1803	<glossterm>hostiocache</glossterm>
1804
1805	<glossdef>
1806	<para>Configures the use of the host I/O cache for all disk images
1807	attached to this storage controller. For details, please see <xref
1808	linkend="iocaching" />.</para>
1809	</glossdef>
1810	</glossentry>
1811
1812	<glossentry>
1813	<glossterm>remove</glossterm>
1814
1815	<glossdef>
1816	<para>Removes the storage controller from the VM config.</para>
1817	</glossdef>
1818	</glossentry>
1819	</glosslist></para>
1820	</sect1>
1821
1822	<sect1>
1823	<title>VBoxManage bandwidthctl</title>
1824
1825	<para>This command creates/deletes/modifies bandwidth groups of the given
1826	virtual machine:<screen>VBoxManage bandwidthctl <uuid\|vmname>
1827	--name <name>
1828	[--add disk
1829	[--delete]
1830	[--limit MB/s]</screen></para>
1831
1832	<para>See <xref linkend="storage-bandwidth-limit" /> for an introduction
1833	to bandwidth limits. The parameters mean:<glosslist>
1834	<glossentry>
1835	<glossterm>uuid\|vmname</glossterm>
1836
1837	<glossdef>
1838	<para>The VM UUID or VM Name. Mandatory.</para>
1839	</glossdef>
1840	</glossentry>
1841
1842	<glossentry>
1843	<glossterm>name</glossterm>
1844
1845	<glossdef>
1846	<para>Name of the bandwidth group. Mandatory.</para>
1847	</glossdef>
1848	</glossentry>
1849
1850	<glossentry>
1851	<glossterm>add</glossterm>
1852
1853	<glossdef>
1854	<para>Creates a new bandwdith group with the given type.</para>
1855	</glossdef>
1856	</glossentry>
1857
1858	<glossentry>
1859	<glossterm>delete</glossterm>
1860
1861	<glossdef>
1862	<para>Deletes a bandwdith group if it isn't used anymore.</para>
1863	</glossdef>
1864	</glossentry>
1865
1866	<glossentry>
1867	<glossterm>limit</glossterm>
1868
1869	<glossdef>
1870	<para>Sets the limit for the given group to the specified amount.
1871	Can be changed while the VM is running.</para>
1872	</glossdef>
1873	</glossentry>
1874	</glosslist></para>
1875	</sect1>
1876
1877	<sect1>
1878	<title>VBoxManage showhdinfo</title>
1879
1880	<para>This command shows information about a virtual hard disk image,
1881	notably its size, its size on disk, its type and the virtual machines
1882	which use it.<note>
1883	<para>For compatibility with earlier versions of VirtualBox, the
1884	"showvdiinfo" command is also supported and mapped internally to the
1885	"showhdinfo" command.</para>
1886	</note></para>
1887	</sect1>
1888
1889	<sect1 id="vboxmanage-createvdi">
1890	<title>VBoxManage createhd</title>
1891
1892	<para>This command creates a new virtual hard disk image. The syntax is as
1893	follows:</para>
1894
1895	<screen>VBoxManage createhd --filename <filename>
1896	--size <megabytes>
1897	[--format VDI\|VMDK\|VHD] (default: VDI)
1898	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
1899
1900	<para>where the parameters mean:<glosslist>
1901	<glossentry>
1902	<glossterm>filename</glossterm>
1903
1904	<glossdef>
1905	<para>Allows to choose a file name. Mandatory.</para>
1906	</glossdef>
1907	</glossentry>
1908
1909	<glossentry>
1910	<glossterm>size</glossterm>
1911
1912	<glossdef>
1913	<para>Allows to define the image capacity, in 1 MiB units.
1914	Mandatory.</para>
1915	</glossdef>
1916	</glossentry>
1917
1918	<glossentry>
1919	<glossterm>format</glossterm>
1920
1921	<glossdef>
1922	<para>Allows to choose a file format for the output file different
1923	from the file format of the input file.</para>
1924	</glossdef>
1925	</glossentry>
1926
1927	<glossentry>
1928	<glossterm>variant</glossterm>
1929
1930	<glossdef>
1931	<para>Allows to choose a file format variant for the output file.
1932	It is a comma-separated list of variant flags. Not all
1933	combinations are supported, and specifying inconsistent flags will
1934	result in an error message.</para>
1935	</glossdef>
1936	</glossentry>
1937	</glosslist> <note>
1938	<para>For compatibility with earlier versions of VirtualBox, the
1939	"createvdi" command is also supported and mapped internally to the
1940	"createhd" command.</para>
1941	</note></para>
1942	</sect1>
1943
1944	<sect1 id="vboxmanage-modifyvdi">
1945	<title>VBoxManage modifyhd</title>
1946
1947	<para>With the <computeroutput>modifyhd</computeroutput> command, you can
1948	change the characteristics of a disk image after it has been
1949	created:<screen>VBoxManage modifyhd <uuid>\|<filename>
1950	[--type normal\|writethrough\|immutable\|shareable\|
1951	readonly\|multiattach]
1952	[--autoreset on\|off]
1953	[--compact]
1954	[--resize <megabytes>\|--resizebyte <bytes>]</screen><note>
1955	<para>Despite the "hd" in the subcommand name, the command works with
1956	all disk images, not only hard disks. For compatibility with earlier
1957	versions of VirtualBox, the "modifyvdi" command is also supported and
1958	mapped internally to the "modifyhd" command.</para>
1959	</note></para>
1960
1961	<para>The following options are available:<itemizedlist>
1962	<listitem>
1963	<para>With the <computeroutput>--type</computeroutput> argument, you
1964	can change the type of an existing image between the normal,
1965	immutable, write-through and other modes; see <xref
1966	linkend="hdimagewrites" /> for details.</para>
1967	</listitem>
1968
1969	<listitem>
1970	<para>For immutable (differencing) hard disks only, the
1971	<computeroutput>--autoreset on\|off</computeroutput> option
1972	determines whether the disk is automatically reset on every VM
1973	startup (again, see <xref linkend="hdimagewrites" />). The default
1974	is "on".</para>
1975	</listitem>
1976
1977	<listitem>
1978	<para>With the <computeroutput>--compact</computeroutput> option,
1979	can be used to compact disk images, i.e. remove blocks that only
1980	contains zeroes. This will shrink a dynamically expanding image
1981	again; it will reduce the <emphasis>physical</emphasis> size of the
1982	image without affecting the logical size of the virtual disk.
1983	Compaction works both for base images and for diff images created as
1984	part of a snapshot.</para>
1985
1986	<para>For this operation to be effective, it is required that free
1987	space in the guest system first be zeroed out using a suitable
1988	software tool. For Windows guests, you can use the
1989	<computeroutput>sdelete</computeroutput> tool provided by Microsoft.
1990	Execute <computeroutput>sdelete -c</computeroutput> in the guest to
1991	zero the free disk space before compressing the virtual disk
1992	image.</para>
1993
1994	<para>Please note that compacting is currently only available for
1995	VDI images. A similar effect can be achieved by zeroing out free
1996	blocks and then cloning the disk to any other dynamically expanding
1997	format. You can use this workaround until compacting is also
1998	supported for disk formats other than VDI.</para>
1999	</listitem>
2000
2001	<listitem>
2002	<para>The --resize option allows you to expand the capacity of an
2003	existing image; this increases the <emphasis>logical</emphasis> size
2004	of a virtual disk without affecting the physical size much.<footnote>
2005	<para>Image resizing was added with VirtualBox 4.0.</para>
2006	</footnote> This currently works only for the VDI and VHD formats,
2007	and only for the dynamically expanding variants. For example, if you
2008	originally created a 10G disk which is now full, you can use the
2009	--resize command to add more space to the virtual disk without
2010	having to create a new image and copy all data from within a virtual
2011	machine.</para>
2012	</listitem>
2013	</itemizedlist></para>
2014	</sect1>
2015
2016	<sect1 id="vboxmanage-clonevdi">
2017	<title>VBoxManage clonehd</title>
2018
2019	<para>This command duplicates a registered virtual hard disk image to a
2020	new image file with a new unique identifier (UUID). The new image can be
2021	transferred to another host system or imported into VirtualBox again using
2022	the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
2023	linkend="cloningvdis" />. The syntax is as follows:</para>
2024
2025	<screen>VBoxManage clonehd <uuid>\|<filename> <outputfile>
2026	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
2027	[--variant Standard,Fixed,Split2G,Stream,ESX]
2028	[--existing]</screen>
2029
2030	<para>where the parameters mean:<glosslist>
2031	<glossentry>
2032	<glossterm>format</glossterm>
2033
2034	<glossdef>
2035	<para>Allow to choose a file format for the output file different
2036	from the file format of the input file.</para>
2037	</glossdef>
2038	</glossentry>
2039
2040	<glossentry>
2041	<glossterm>variant</glossterm>
2042
2043	<glossdef>
2044	<para>Allow to choose a file format variant for the output file.
2045	It is a comma-separated list of variant flags. Not all
2046	combinations are supported, and specifying inconsistent flags will
2047	result in an error message.</para>
2048	</glossdef>
2049	</glossentry>
2050
2051	<glossentry>
2052	<glossterm>existing</glossterm>
2053
2054	<glossdef>
2055	<para>Perform the clone operation to an already existing
2056	destination medium. Only the portion of the source medium which
2057	fits into the destination medium is copied. This means if the
2058	destination medium is smaller than the source only a part of it is
2059	copied, and if the destination medium is larger than the source
2060	the remaining part of the destination medium is unchanged.</para>
2061	</glossdef>
2062	</glossentry>
2063	</glosslist> <note>
2064	<para>For compatibility with earlier versions of VirtualBox, the
2065	"clonevdi" command is also supported and mapped internally to the
2066	"clonehd" command.</para>
2067	</note></para>
2068	</sect1>
2069
2070	<sect1>
2071	<title>VBoxManage convertfromraw</title>
2072
2073	<para>This command converts a raw disk image to a VirtualBox Disk Image
2074	(VDI) file. The syntax is as follows:</para>
2075
2076	<screen>VBoxManage convertfromraw <filename> <outputfile>
2077	[--format VDI\|VMDK\|VHD]
2078	[--variant Standard,Fixed,Split2G,Stream,ESX]
2079	VBoxManage convertfromraw stdin <outputfile> <bytes>
2080	[--format VDI\|VMDK\|VHD]
2081	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
2082
2083	<para>where the parameters mean:<glosslist>
2084	<glossentry>
2085	<glossterm>format</glossterm>
2086
2087	<glossdef>
2088	<para>Select the disk image format to create. Default is
2089	VDI.</para>
2090	</glossdef>
2091	</glossentry>
2092
2093	<glossentry>
2094	<glossterm>variant</glossterm>
2095
2096	<glossdef>
2097	<para>Allow to choose a file format variant for the output file.
2098	It is a comma-separated list of variant flags. Not all
2099	combinations are supported, and specifying inconsistent flags will
2100	result in an error message.</para>
2101	</glossdef>
2102	</glossentry>
2103	</glosslist> The second form forces VBoxManage to read the content for
2104	the disk image from standard input (useful for using that command in a
2105	pipe).</para>
2106
2107	<para><note>
2108	<para>For compatibility with earlier versions of VirtualBox, the
2109	"convertdd" command is also supported and mapped internally to the
2110	"convertfromraw" command.</para>
2111	</note></para>
2112	</sect1>
2113
2114	<sect1>
2115	<title>VBoxManage getextradata/setextradata</title>
2116
2117	<para>These commands let you attach and retrieve string data to a virtual
2118	machine or to a VirtualBox configuration (by specifying
2119	<computeroutput>global</computeroutput> instead of a virtual machine
2120	name). You must specify a key (as a text string) to associate the data
2121	with, which you can later use to retrieve it. For example:</para>
2122
2123	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
2124	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
2125
2126	<para>would associate the string "2006.01.01" with the key installdate for
2127	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
2128	could retrieve the information as follows:</para>
2129
2130	<screen>VBoxManage getextradata Fedora5 installdate</screen>
2131
2132	<para>which would return</para>
2133
2134	<screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
2135	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
2136	All rights reserved.
2137
2138	Value: 2006.01.01</screen>
2139	</sect1>
2140
2141	<sect1 id="vboxmanage-setproperty">
2142	<title>VBoxManage setproperty</title>
2143
2144	<para>This command is used to change global settings which affect the
2145	entire VirtualBox installation. Some of these correspond to the settings
2146	in the "Global settings" dialog in the graphical user interface. The
2147	following properties are available:<glosslist>
2148	<glossentry>
2149	<glossterm>machinefolder</glossterm>
2150
2151	<glossdef>
2152	<para>This specifies the default folder in which virtual machine
2153	definitions are kept; see <xref linkend="vboxconfigdata" /> for
2154	details.</para>
2155	</glossdef>
2156	</glossentry>
2157
2158	<glossentry>
2159	<glossterm>vrdeauthlibrary</glossterm>
2160
2161	<glossdef>
2162	<para>This specifies which library to use when "external"
2163	authentication has been selected for a particular virtual machine;
2164	see <xref linkend="vbox-auth" /> for details.</para>
2165	</glossdef>
2166	</glossentry>
2167
2168	<glossentry>
2169	<glossterm>websrvauthlibrary</glossterm>
2170
2171	<glossdef>
2172	<para>This specifies which library the web service uses to
2173	authenticate users. For details about the VirtualBox web service,
2174	please refer to the separate VirtualBox SDK reference (see <xref
2175	linkend="VirtualBoxAPI" />).</para>
2176	</glossdef>
2177	</glossentry>
2178
2179	<glossentry>
2180	<glossterm>vrdelibrary</glossterm>
2181
2182	<glossdef>
2183	<para>This specifies which library implements the VirtualBox
2184	Remote Desktop Extension.</para>
2185	</glossdef>
2186	</glossentry>
2187
2188	<glossentry>
2189	<glossterm>hwvirtexenabled</glossterm>
2190
2191	<glossdef>
2192	<para>This selects whether or not hardware virtualization support
2193	is enabled by default.</para>
2194	</glossdef>
2195	</glossentry>
2196	</glosslist></para>
2197	</sect1>
2198
2199	<sect1>
2200	<title>VBoxManage usbfilter add/modify/remove</title>
2201
2202	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
2203	working with USB filters in virtual machines, or global filters which
2204	affect the whole VirtualBox setup. Global filters are applied before
2205	machine-specific filters, and may be used to prevent devices from being
2206	captured by any virtual machine. Global filters are always applied in a
2207	particular order, and only the first filter which fits a device is
2208	applied. So for example, if the first global filter says to hold (make
2209	available) a particular Kingston memory stick device and the second to
2210	ignore all Kingston devices, that memory stick will be available to any
2211	machine with an appropriate filter, but no other Kingston device
2212	will.</para>
2213
2214	<para>When creating a USB filter using <computeroutput>usbfilter
2215	add</computeroutput>, you must supply three or four mandatory parameters.
2216	The index specifies the position in the list at which the filter should be
2217	placed. If there is already a filter at that position, then it and the
2218	following ones will be shifted back one place. Otherwise the new filter
2219	will be added onto the end of the list. The
2220	<computeroutput>target</computeroutput> parameter selects the virtual
2221	machine that the filter should be attached to or use "global" to apply it
2222	to all virtual machines. <computeroutput>name</computeroutput> is a name
2223	for the new filter and for global filters,
2224	<computeroutput>action</computeroutput> says whether to allow machines
2225	access to devices that fit the filter description ("hold") or not to give
2226	them access ("ignore"). In addition, you should specify parameters to
2227	filter by. You can find the parameters for devices attached to your system
2228	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
2229	you can specify whether the filter should be active, and for local
2230	filters, whether they are for local devices, remote (over an RDP
2231	connection) or either.</para>
2232
2233	<para>When you modify a USB filter using <computeroutput>usbfilter
2234	modify</computeroutput>, you must specify the filter by index (see the
2235	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
2236	find global filter indexes and that of <computeroutput>VBoxManage
2237	showvminfo</computeroutput> to find indexes for individual machines) and
2238	by target, which is either a virtual machine or "global". The properties
2239	which can be changed are the same as for <computeroutput>usbfilter
2240	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
2241	remove</computeroutput> and specify the index and the target.</para>
2242	</sect1>
2243
2244	<sect1 id="vboxmanage-sharedfolder">
2245	<title>VBoxManage sharedfolder add/remove</title>
2246
2247	<para>This command allows you to share folders on the host computer with
2248	guest operating systems. For this, the guest systems must have a version
2249	of the VirtualBox Guest Additions installed which supports this
2250	functionality.</para>
2251
2252	<para>Shared folders are described in detail in <xref
2253	linkend="sharedfolders" />.</para>
2254	</sect1>
2255
2256	<sect1 id="vboxmanage-guestproperty">
2257	<title>VBoxManage guestproperty</title>
2258
2259	<para>The "guestproperty" commands allow you to get or set properties of a
2260	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
2261	for an introduction. As explained there, guest properties are arbitrary
2262	key/value string pairs which can be written to and read from by either the
2263	guest or the host, so they can be used as a low-volume communication
2264	channel for strings, provided that a guest is running and has the Guest
2265	Additions installed. In addition, a number of values whose keys begin with
2266	"/VirtualBox/" are automatically set and maintained by the Guest
2267	Additions.</para>
2268
2269	<para>The following subcommands are available (where
2270	<computeroutput><vm></computeroutput>, in each case, can either be a
2271	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2272	<listitem>
2273	<para><computeroutput>enumerate <vm> [--patterns
2274	<pattern>]</computeroutput>: This lists all the guest
2275	properties that are available for the given VM, including the value.
2276	This list will be very limited if the guest's service process cannot
2277	be contacted, e.g. because the VM is not running or the Guest
2278	Additions are not installed.</para>
2279
2280	<para>If <computeroutput>--patterns <pattern></computeroutput>
2281	is specified, it acts as a filter to only list properties that match
2282	the given pattern. The pattern can contain the following wildcard
2283	characters:<itemizedlist>
2284	<listitem>
2285	<para><computeroutput>*</computeroutput> (asterisk):
2286	represents any number of characters; for example,
2287	"<computeroutput>/VirtualBox*</computeroutput>" would match
2288	all properties beginning with "/VirtualBox".</para>
2289	</listitem>
2290
2291	<listitem>
2292	<para><computeroutput>?</computeroutput> (question mark):
2293	represents a single arbitrary character; for example,
2294	"<computeroutput>fo?</computeroutput>" would match both "foo"
2295	and "for".</para>
2296	</listitem>
2297
2298	<listitem>
2299	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
2300	used to specify multiple alternative patterns; for example,
2301	"<computeroutput>s\|t</computeroutput>" would match anything
2302	starting with either "s" or "t".</para>
2303	</listitem>
2304	</itemizedlist></para>
2305	</listitem>
2306
2307	<listitem>
2308	<para><computeroutput>get <vm></computeroutput>: This
2309	retrieves the value of a single property only. If the property
2310	cannot be found (e.g. because the guest is not running), this will
2311	print "No value set!".</para>
2312	</listitem>
2313
2314	<listitem>
2315	<para><computeroutput>set <vm> <property> [<value>
2316	[--flags <flags>]]</computeroutput>: This allows you to set a
2317	guest property by specifying the key and value. If
2318	<computeroutput><value></computeroutput> is omitted, the
2319	property is deleted. With <computeroutput>--flags</computeroutput>
2320	you can optionally specify additional behavior (you can combine
2321	several by separating them with commas):<itemizedlist>
2322	<listitem>
2323	<para><computeroutput>TRANSIENT</computeroutput>: the value
2324	will not be stored with the VM data when the VM exits;</para>
2325	</listitem>
2326
2327	<listitem>
2328	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
2329	can only be changed by the host, but the guest can only read
2330	it;</para>
2331	</listitem>
2332
2333	<listitem>
2334	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
2335	the value can only be changed by the guest, but the host can
2336	only read it;</para>
2337	</listitem>
2338
2339	<listitem>
2340	<para><computeroutput>READONLY</computeroutput>: a combination
2341	of the two, the value cannot be changed at all.</para>
2342	</listitem>
2343	</itemizedlist></para>
2344	</listitem>
2345
2346	<listitem>
2347	<para><computeroutput>wait <vm> <pattern> --timeout
2348	<timeout></computeroutput>: This waits for a particular value
2349	described by "pattern" to change or to be deleted or created. The
2350	pattern rules are the same as for the "enumerate" subcommand
2351	above.</para>
2352	</listitem>
2353	</itemizedlist></para>
2354	</sect1>
2355
2356	<sect1 id="vboxmanage-guestcontrol">
2357	<title>VBoxManage guestcontrol</title>
2358
2359	<para>The "guestcontrol" commands allow you to control certain things
2360	inside a guest from the host. Please see <xref
2361	linkend="guestadd-guestcontrol" /> for an introduction.</para>
2362
2363	<para>Generally, the syntax is as follows:</para>
2364
2365	<screen>VBoxManage guestcontrol <command></screen>
2366
2367	<para>The following subcommands are available (where
2368	<computeroutput><vm></computeroutput>, in each case, can either be a
2369	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2370	<listitem>
2371	<para><computeroutput>execute</computeroutput>, which allows for
2372	executing a program/script (process) which is already installed and
2373	runnable on the guest. This command only works while a VM is up and
2374	running and has the following syntax:</para>
2375
2376	<screen>VBoxManage guestcontrol exec[ute] <vmname>\|<uuid>
2377	<path to program>
2378	--username <name> --password <password>
2379	[--arguments "<arguments>"]
2380	[--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
2381	[--flags <flags>] [--timeout <msec>]
2382	[--verbose] [--wait-for exit,stdout,stderr\|\|]</screen>
2383
2384	<para>where the parameters mean: <glosslist>
2385	<glossentry>
2386	<glossterm>uuid\|vmname</glossterm>
2387
2388	<glossdef>
2389	<para>The VM UUID or VM name. Mandatory.</para>
2390	</glossdef>
2391	</glossentry>
2392
2393	<glossentry>
2394	<glossterm>path to program</glossterm>
2395
2396	<glossdef>
2397	<para>Absolute path and process name of process to execute
2398	in the guest, e.g.
2399	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
2400	</glossdef>
2401	</glossentry>
2402
2403	<glossentry>
2404	<glossterm>--arguments "<arguments>"</glossterm>
2405
2406	<glossdef>
2407	<para>One or more arguments to pass to the process being
2408	executed.</para>
2409
2410	<para>Arguments containing spaces must be enclosed in
2411	quotation marks. More than one
2412	<computeroutput>--arguments</computeroutput> at a time can
2413	be specified to keep the command line tidy.</para>
2414	</glossdef>
2415	</glossentry>
2416
2417	<glossentry>
2418	<glossterm>--environment
2419	"<NAME>=<VALUE>"</glossterm>
2420
2421	<glossdef>
2422	<para>One or more environment variables to be set or
2423	unset.</para>
2424
2425	<para>By default, the new process in the guest will be
2426	created with the standard environment of the guest OS. This
2427	option allows for modifying that environment. To set/modify
2428	a variable, a pair of
2429	<computeroutput>NAME=VALUE</computeroutput> must be
2430	specified; to unset a certain variable, the name with no
2431	value must set, e.g.
2432	<computeroutput>NAME=</computeroutput>.</para>
2433
2434	<para>Arguments containing spaces must be enclosed in
2435	quotation marks. More than one
2436	<computeroutput>--environment</computeroutput> at a time can
2437	be specified to keep the command line tidy.</para>
2438	</glossdef>
2439	</glossentry>
2440
2441	<glossentry>
2442	<glossterm>--flags <flags></glossterm>
2443
2444	<glossdef>
2445	<para>Additional flags to set. This is not used at the
2446	moment.</para>
2447	</glossdef>
2448	</glossentry>
2449
2450	<glossentry>
2451	<glossterm>--timeout <msec></glossterm>
2452
2453	<glossdef>
2454	<para>Value (in milliseconds) that specifies the time how
2455	long the started process is allowed to run and how long
2456	VBoxManage waits for getting output from that process. If no
2457	timeout is specified, VBoxManage will wait forever until the
2458	started process ends or an error occured.</para>
2459	</glossdef>
2460	</glossentry>
2461
2462	<glossentry>
2463	<glossterm>--username <name></glossterm>
2464
2465	<glossdef>
2466	<para>Name of the user the process should run under. This
2467	user must exist on the guest OS.</para>
2468	</glossdef>
2469	</glossentry>
2470
2471	<glossentry>
2472	<glossterm>--password <password></glossterm>
2473
2474	<glossdef>
2475	<para>Password of the user account specified with
2476	<computeroutput>--username</computeroutput>. If not given,
2477	an empty password is assumed.</para>
2478	</glossdef>
2479	</glossentry>
2480
2481	<glossentry>
2482	<glossterm>--verbose</glossterm>
2483
2484	<glossdef>
2485	<para>Tells VBoxManage to be more verbose.</para>
2486	</glossdef>
2487	</glossentry>
2488
2489	<glossentry>
2490	<glossterm>--wait-for <action></glossterm>
2491
2492	<glossdef>
2493	<para>Tells VBoxManage to wait for a certain action to
2494	happen and react to it. The following actions are available:
2495	<glosslist>
2496	<glossentry>
2497	<glossterm>exit</glossterm>
2498
2499	<glossdef>
2500	<para>Waits until the process ends and outputs its
2501	exit code along with the exit reason/flags.</para>
2502	</glossdef>
2503	</glossentry>
2504
2505	<glossentry>
2506	<glossterm>stdout or stderr</glossterm>
2507
2508	<glossdef>
2509	<para>Waits until the process ends and outputs its
2510	exit code along with the exit reason/flags. After
2511	that VBoxManage retrieves the output collected from
2512	the guest process's stdout and stderr.</para>
2513	</glossdef>
2514	</glossentry>
2515	</glosslist></para>
2516	</glossdef>
2517	</glossentry>
2518	</glosslist></para>
2519
2520	<para><note>
2521	<para>On Windows there are certain limitations for graphical
2522	applications; please see <xref linkend="KnownIssues" /> for more
2523	information.</para>
2524	</note> Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr"
2525	--username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe"
2526	--username foo --password bar --wait-for stdout</screen> Note that
2527	the double backslashes in the second example are only required on
2528	Unix hosts.</para>
2529	</listitem>
2530
2531	<listitem>
2532	<para><computeroutput>copyto</computeroutput>, which allows copying
2533	files from the host to the guest (only with installed Guest
2534	Additions 4.0 and later).</para>
2535
2536	<screen>VBoxManage copyto\|cp <vmname>\|<uuid>
2537	<source on host> <destination on guest>
2538	--username <name> --password <password>
2539	[--dryrun] [--follow] [--recursive] [--verbose]</screen>
2540
2541	<para>where the parameters mean: <glosslist>
2542	<glossentry>
2543	<glossterm>uuid\|vmname</glossterm>
2544
2545	<glossdef>
2546	<para>The VM UUID or VM name. Mandatory.</para>
2547	</glossdef>
2548	</glossentry>
2549
2550	<glossentry>
2551	<glossterm>source on host</glossterm>
2552
2553	<glossdef>
2554	<para>Absolute path of source file(s) on host to copy over
2555	to the guest, e.g.
2556	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
2557	This also can be a wildcard expression, e.g.
2558	<computeroutput>C:\Windows\System32\*.dll</computeroutput></para>
2559	</glossdef>
2560	</glossentry>
2561
2562	<glossentry>
2563	<glossterm>destination on guest</glossterm>
2564
2565	<glossdef>
2566	<para>Absolute destination path on the guest, e.g.
2567	<computeroutput>C:\Temp</computeroutput></para>
2568	</glossdef>
2569	</glossentry>
2570
2571	<glossentry>
2572	<glossterm>--username <name></glossterm>
2573
2574	<glossdef>
2575	<para>Name of the user the copy process should run under.
2576	This user must exist on the guest OS.</para>
2577	</glossdef>
2578	</glossentry>
2579
2580	<glossentry>
2581	<glossterm>--password <password></glossterm>
2582
2583	<glossdef>
2584	<para>Password of the user account specified with
2585	<computeroutput>--username</computeroutput>. If not given,
2586	an empty password is assumed.</para>
2587	</glossdef>
2588	</glossentry>
2589
2590	<glossentry>
2591	<glossterm>--dryrun</glossterm>
2592
2593	<glossdef>
2594	<para>Tells VBoxManage to only perform a dry run instead of
2595	really copying files to the guest.</para>
2596	</glossdef>
2597	</glossentry>
2598
2599	<glossentry>
2600	<glossterm>--follow</glossterm>
2601
2602	<glossdef>
2603	<para>Enables following symlinks on the host's
2604	source.</para>
2605	</glossdef>
2606	</glossentry>
2607
2608	<glossentry>
2609	<glossterm>--recursive</glossterm>
2610
2611	<glossdef>
2612	<para>Recursively copies files/directories of the specified
2613	source.</para>
2614	</glossdef>
2615	</glossentry>
2616
2617	<glossentry>
2618	<glossterm>--verbose</glossterm>
2619
2620	<glossdef>
2621	<para>Tells VBoxManage to be more verbose.</para>
2622	</glossdef>
2623	</glossentry>
2624
2625	<glossentry>
2626	<glossterm>--flags <flags></glossterm>
2627
2628	<glossdef>
2629	<para>Additional flags to set. This is not used at the
2630	moment.</para>
2631	</glossdef>
2632	</glossentry>
2633	</glosslist></para>
2634	</listitem>
2635
2636	<listitem>
2637	<para><computeroutput>createdirectory</computeroutput>, which allows
2638	copying files from the host to the guest (only with installed Guest
2639	Additions 4.0 and later).</para>
2640
2641	<screen>VBoxManage createdir[ectory]\|mkdir\|md <vmname>\|<uuid>
2642	<directory to create on guest>
2643	[--username "<name>"] [--password "<password>"]
2644	[--parents] [--mode <mode>] [--verbose]</screen>
2645
2646	<para>where the parameters mean: <glosslist>
2647	<glossentry>
2648	<glossterm>uuid\|vmname</glossterm>
2649
2650	<glossdef>
2651	<para>The VM UUID or VM name. Mandatory.</para>
2652	</glossdef>
2653	</glossentry>
2654
2655	<glossentry>
2656	<glossterm>directory to create on guest</glossterm>
2657
2658	<glossdef>
2659	<para>Absolute path of directory/directories to create on
2660	guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>.
2661	Parent directories need to exist (e.g. in this example
2662	<computeroutput>D:\Foo</computeroutput>) when switch
2663	<computeroutput>--parents</computeroutput> is omitted. The
2664	specified user must have appropriate rights to create the
2665	specified directory.</para>
2666	</glossdef>
2667	</glossentry>
2668
2669	<glossentry>
2670	<glossterm>--username <name></glossterm>
2671
2672	<glossdef>
2673	<para>Name of the user the copy process should run under.
2674	This user must exist on the guest OS.</para>
2675	</glossdef>
2676	</glossentry>
2677
2678	<glossentry>
2679	<glossterm>--password <password></glossterm>
2680
2681	<glossdef>
2682	<para>Password of the user account specified with
2683	<computeroutput>--username</computeroutput>. If not given,
2684	an empty password is assumed.</para>
2685	</glossdef>
2686	</glossentry>
2687
2688	<glossentry>
2689	<glossterm>--parents</glossterm>
2690
2691	<glossdef>
2692	<para>Also creates not yet existing parent directories of
2693	the specified directory, e.g. if the directory
2694	<computeroutput>D:\Foo</computeroutput> of
2695	<computeroutput>D:\Foo\Bar</computeroutput> does not exist
2696	yet it will be created. Without specifying
2697	<computeroutput>--parent</computeroutput> the action would
2698	have failed.</para>
2699	</glossdef>
2700	</glossentry>
2701
2702	<glossentry>
2703	<glossterm>--mode <mode></glossterm>
2704
2705	<glossdef>
2706	<para>Sets the permission mode of the specified directory.
2707	Only octal modes (e.g.
2708	<computeroutput>0755</computeroutput>) are supported right
2709	now.</para>
2710	</glossdef>
2711	</glossentry>
2712
2713	<glossentry>
2714	<glossterm>--verbose</glossterm>
2715
2716	<glossdef>
2717	<para>Tells VBoxManage to be more verbose.</para>
2718	</glossdef>
2719	</glossentry>
2720	</glosslist></para>
2721	</listitem>
2722
2723	<listitem>
2724	<para><computeroutput>updateadditions</computeroutput>, which allows
2725	for updating an already installed Guest Additions version on the
2726	guest (only already installed Guest Additions 4.0 and later).</para>
2727
2728	<screen>VBoxManage guestcontrol updateadditions <vmname>\|<uuid>
2729	[--source "<guest additions .ISO file to use>"] [--verbose]</screen>
2730
2731	<para>where the parameters mean: <glosslist>
2732	<glossentry>
2733	<glossterm>uuid\|vmname</glossterm>
2734
2735	<glossdef>
2736	<para>The VM UUID or VM name. Mandatory.</para>
2737	</glossdef>
2738	</glossentry>
2739
2740	<glossentry>
2741	<glossterm>--source "<guest additions .ISO file to
2742	use>"</glossterm>
2743
2744	<glossdef>
2745	<para>Full path to an alternative VirtualBox Guest Additions
2746	.ISO file to use for the Guest Additions update.</para>
2747	</glossdef>
2748	</glossentry>
2749
2750	<glossentry>
2751	<glossterm>--verbose</glossterm>
2752
2753	<glossdef>
2754	<para>Tells VBoxManage to be more verbose.</para>
2755	</glossdef>
2756	</glossentry>
2757	</glosslist></para>
2758	</listitem>
2759	</itemizedlist></para>
2760	</sect1>
2761
2762	<sect1 id="vboxmanage-debugvm">
2763	<title>VBoxManage debugvm</title>
2764
2765	<para>The "debugvm" commands are for experts who want to tinker with the
2766	exact details of virtual machine execution. Like the VM debugger described
2767	in <xref linkend="debugger" />, these commands are only useful if you are
2768	very familiar with the details of the PC architecture and how to debug
2769	software.</para>
2770
2771	<para>The subcommands of "debugvm" all operate on a running virtual
2772	machine. The following are available:<itemizedlist>
2773	<listitem>
2774	<para>With <computeroutput>dumpguestcore --filename
2775	<name></computeroutput>, you can create a system dump of the
2776	running VM, which will be written into the given file. This file
2777	will have the standard ELF core format (with custom sections); see
2778	<xref linkend="guestcoreformat" />.</para>
2779
2780	<para>This corresponds to the
2781	<computeroutput>writecore</computeroutput> command in the debugger.
2782	</para>
2783	</listitem>
2784
2785	<listitem>
2786	<para>The <computeroutput>info</computeroutput> command is used to
2787	display info items relating to the VMM, device emulations and
2788	associated drivers. This command takes one or two arguments: the
2789	name of the info item, optionally followed by a string containing
2790	arguments specific to the info item.
2791	The <computeroutput>help</computeroutput> info item provides a
2792	listning of the available items and hints about any optional
2793	arguments.</para>
2794
2795	<para>This corresponds to the <computeroutput>info</computeroutput>
2796	command in the debugger.</para>
2797	</listitem>
2798
2799	<listitem>
2800	<para>The <computeroutput>injectnmi</computeroutput> command causes
2801	a non-maskable interrupt (NMI) in the guest, which might be useful
2802	for certain debugging scenarios. What happens exactly is dependent
2803	on the guest operating system, but an NMI can crash the whole guest
2804	operating system. Do not use unless you know what you're
2805	doing.</para>
2806	</listitem>
2807
2808	<listitem>
2809	<para>The <computeroutput>osdetect</computeroutput> command makes the
2810	VMM's debugger facility (re-)detection the guest operation
2811	system.</para>
2812
2813	<para>This corresponds to the <computeroutput>detect</computeroutput>
2814	command in the debugger.</para>
2815	</listitem>
2816
2817	<listitem>
2818	<para>The <computeroutput>osinfo</computeroutput> command is used to
2819	display info about the operating system (OS) detected by the VMM's
2820	debugger facility.</para>
2821	</listitem>
2822
2823	<listitem>
2824	<para>The <computeroutput>getregisters</computeroutput> command is
2825	used to display CPU and device registers. The command takes a list
2826	of registers, each having one of the following forms:
2827	<itemizedlist>
2828	<listitem><computeroutput>register-set.register-name.sub-field</computeroutput></listitem>
2829	<listitem><computeroutput>register-set.register-name</computeroutput></listitem>
2830	<listitem><computeroutput>cpu-register-name.sub-field</computeroutput></listitem>
2831	<listitem><computeroutput>cpu-register-name</computeroutput></listitem>
2832	<listitem><computeroutput>all</computeroutput></listitem>
2833	</itemizedlist>
2834	The <computeroutput>all</computeroutput> form will cause all
2835	registers to be shown (no sub-fields). The registers names are
2836	case-insensitive. When requesting a CPU register the register set
2837	can be omitted, it will be selected using the value of the
2838	<computeroutput>--cpu</computeroutput> option (defaulting to 0).
2839	</para>
2840	</listitem>
2841
2842	<listitem>
2843	<para>The <computeroutput>setregisters</computeroutput> command is
2844	used to change CPU and device registers. The command takes a list
2845	of register assignments, each having one of the following forms:
2846	<itemizedlist>
2847	<listitem><computeroutput>register-set.register-name.sub-field=value</computeroutput></listitem>
2848	<listitem><computeroutput>register-set.register-name=value</computeroutput></listitem>
2849	<listitem><computeroutput>cpu-register-name.sub-field=value</computeroutput></listitem>
2850	<listitem><computeroutput>cpu-register-name=value</computeroutput></listitem>
2851	</itemizedlist>
2852	The value format should be in the same style as what
2853	<computeroutput>getregisters</computeroutput> displays, with the
2854	exception that both octal and decimal can be used instead of
2855	hexadecimal. The register naming and the default CPU register set
2856	are handled the same way as with the
2857	<computeroutput>getregisters</computeroutput> command.</para>
2858	</listitem>
2859
2860	<listitem>
2861	<para>The <computeroutput>statistics</computeroutput> command can be
2862	used to display VMM statistics on the command line. The
2863	<computeroutput>--reset</computeroutput> option will reset
2864	statistics. The affected statistics can be filtered with the
2865	<computeroutput>--pattern</computeroutput> option, which accepts
2866	DOS/NT-style wildcards (<computeroutput>?</computeroutput> and
2867	<computeroutput>*</computeroutput>).</para>
2868	</listitem>
2869	</itemizedlist></para>
2870	</sect1>
2871
2872	<sect1>
2873	<title id="metrics">VBoxManage metrics</title>
2874
2875	<para>This command supports monitoring the usage of system resources.
2876	Resources are represented by various metrics associated with the host
2877	system or a particular VM. For example, the host system has a
2878	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
2879	percentage of time CPUs spend executing in user mode over a specific
2880	sampling period.</para>
2881
2882	<para>Metric data is collected and retained internally; it may be
2883	retrieved at any time with the <computeroutput>VBoxManage metrics
2884	query</computeroutput> subcommand. The data is available as long as the
2885	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
2886	process terminates shortly after all VMs and frontends have been
2887	closed.</para>
2888
2889	<para>By default no metrics are collected at all. Metrics collection does
2890	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
2891	is invoked with a proper sampling interval and the number of metrics to be
2892	retained. The interval is measured in seconds. For example, to enable
2893	collecting the host processor and memory usage metrics every second and
2894	keeping the 5 most current samples, the following command can be
2895	used:</para>
2896
2897	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
2898
2899	<para>Metric collection can only be enabled for started VMs. Collected
2900	data and collection settings for a particular VM will disappear as soon as
2901	it shuts down. Use <computeroutput>VBoxManage metrics list
2902	</computeroutput> subcommand to see which metrics are currently available.
2903	You can also use <computeroutput>--list</computeroutput> option with any
2904	subcommand that modifies metric settings to find out which metrics were
2905	affected.</para>
2906
2907	<para>Note that the <computeroutput>VBoxManage metrics
2908	setup</computeroutput> subcommand discards all samples that may have been
2909	previously collected for the specified set of objects and metrics.</para>
2910
2911	<para>To enable or disable metrics collection without discarding the data
2912	<computeroutput>VBoxManage metrics enable</computeroutput> and
2913	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
2914	can be used. Note that these subcommands expect metrics, not submetrics,
2915	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
2916	other words enabling <code>CPU/Load/User</code> while disabling
2917	<code>CPU/Load/Kernel</code> is not supported.</para>
2918
2919	<para>The host and VMs have different sets of associated metrics.
2920	Available metrics can be listed with <computeroutput>VBoxManage metrics
2921	list</computeroutput> subcommand.</para>
2922
2923	<para>A complete metric name may include an aggregate function. The name
2924	has the following form:
2925	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
2926	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
2927	for the minimum amount of available memory over all retained data if
2928	applied to the host object.</para>
2929
2930	<para>Subcommands may apply to all objects and metrics or can be limited
2931	to one object or/and a list of metrics. If no objects or metrics are given
2932	in the parameters, the subcommands will apply to all available metrics of
2933	all objects. You may use an asterisk
2934	("<computeroutput>*</computeroutput>") to explicitly specify that the
2935	command should be applied to all objects or metrics. Use "host" as the
2936	object name to limit the scope of the command to host-related metrics. To
2937	limit the scope to a subset of metrics, use a metric list with names
2938	separated by commas.</para>
2939
2940	<para>For example, to query metric data on the CPU time spent in user and
2941	kernel modes by the virtual machine named "test", you can use the
2942	following command:</para>
2943
2944	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
2945
2946	<para>The following list summarizes the available subcommands:</para>
2947
2948	<glosslist>
2949	<glossentry>
2950	<glossterm>list</glossterm>
2951
2952	<glossdef>
2953	<para>This subcommand shows the parameters of the currently existing
2954	metrics. Note that VM-specific metrics are only available when a
2955	particular VM is running.</para>
2956	</glossdef>
2957	</glossentry>
2958
2959	<glossentry>
2960	<glossterm>setup</glossterm>
2961
2962	<glossdef>
2963	<para>This subcommand sets the interval between taking two samples
2964	of metric data and the number of samples retained internally. The
2965	retained data is available for displaying with the
2966	<code>query</code> subcommand. The <computeroutput>--list
2967	</computeroutput> option shows which metrics have been modified as
2968	the result of the command execution.</para>
2969	</glossdef>
2970	</glossentry>
2971
2972	<glossentry>
2973	<glossterm>enable</glossterm>
2974
2975	<glossdef>
2976	<para>This subcommand "resumes" data collection after it has been
2977	stopped with <code>disable</code> subcommand. Note that specifying
2978	submetrics as parameters will not enable underlying metrics. Use
2979	<computeroutput>--list</computeroutput> to find out if the command
2980	did what was expected.</para>
2981	</glossdef>
2982	</glossentry>
2983
2984	<glossentry>
2985	<glossterm>disable</glossterm>
2986
2987	<glossdef>
2988	<para>This subcommand "suspends" data collection without affecting
2989	collection parameters or collected data. Note that specifying
2990	submetrics as parameters will not disable underlying metrics. Use
2991	<computeroutput>--list</computeroutput> to find out if the command
2992	did what was expected.</para>
2993	</glossdef>
2994	</glossentry>
2995
2996	<glossentry>
2997	<glossterm>query</glossterm>
2998
2999	<glossdef>
3000	<para>This subcommand retrieves and displays the currently retained
3001	metric data.<note>
3002	<para>The <code>query</code> subcommand does not remove or
3003	"flush" retained data. If you query often enough you will see
3004	how old samples are gradually being "phased out" by new
3005	samples.</para>
3006	</note></para>
3007	</glossdef>
3008	</glossentry>
3009
3010	<glossentry>
3011	<glossterm>collect</glossterm>
3012
3013	<glossdef>
3014	<para>This subcommand sets the interval between taking two samples
3015	of metric data and the number of samples retained internally. The
3016	collected data is displayed periodically until Ctrl-C is pressed
3017	unless the <computeroutput>--detach</computeroutput> option is
3018	specified. With the <computeroutput>--detach</computeroutput>
3019	option, this subcommand operates the same way as <code>setup</code>
3020	does. The <computeroutput>--list</computeroutput> option shows which
3021	metrics match the specified filter.</para>
3022	</glossdef>
3023	</glossentry>
3024	</glosslist>
3025	</sect1>
3026
3027	<sect1>
3028	<title>VBoxManage hostonlyif</title>
3029
3030	<para>With "hostonlyif" you can change the IP configuration of a host-only
3031	network interface. For a description of host-only networking, please
3032	refer to <xref linkend="network_hostonly" />. Each host-only interface is
3033	identified by a name and can either use the internal DHCP server or a
3034	manual IP configuration (both IP4 and IP6).</para>
3035	</sect1>
3036
3037	<sect1 id="vboxmanage-dhcpserver">
3038	<title>VBoxManage dhcpserver</title>
3039
3040	<para>The "dhcpserver" commands allow you to control the DHCP server that
3041	is built into VirtualBox. You may find this useful when using internal or
3042	host-only networking. (Theoretically, you can enable it for a bridged
3043	network as well, but that will likely cause conflicts with other DHCP
3044	servers in your physical network.)</para>
3045
3046	<para>Use the following command line options:<itemizedlist>
3047	<listitem>
3048	<para>If you use internal networking for a virtual network adapter
3049	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
3050	--netname <network_name></computeroutput>, where
3051	<computeroutput><network_name></computeroutput> is the same
3052	network name you used with <computeroutput>VBoxManage modifyvm
3053	<vmname> --intnet<X>
3054	<network_name></computeroutput>.</para>
3055	</listitem>
3056
3057	<listitem>
3058	<para>If you use host-only networking for a virtual network adapter
3059	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
3060	--ifname <hostonly_if_name></computeroutput> instead, where
3061	<computeroutput><hostonly_if_name></computeroutput> is the
3062	same host-only interface name you used with
3063	<computeroutput>VBoxManage modifyvm <vmname>
3064	--hostonlyadapter<X>
3065	<hostonly_if_name></computeroutput>.</para>
3066
3067	<para>Alternatively, you can also use the --netname option as with
3068	internal networks if you know the host-only network's name; you can
3069	see the names with <computeroutput>VBoxManage list
3070	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
3071	above).</para>
3072	</listitem>
3073	</itemizedlist></para>
3074
3075	<para>The following additional parameters are required when first adding a
3076	DHCP server:<itemizedlist>
3077	<listitem>
3078	<para>With <computeroutput>--ip</computeroutput>, specify the IP
3079	address of the DHCP server itself.</para>
3080	</listitem>
3081
3082	<listitem>
3083	<para>With <computeroutput>--netmask</computeroutput>, specify the
3084	netmask of the network.</para>
3085	</listitem>
3086
3087	<listitem>
3088	<para>With <computeroutput>--lowerip</computeroutput> and
3089	<computeroutput>--upperip</computeroutput>, you can specify the
3090	lowest and highest IP address, respectively, that the DHCP server
3091	will hand out to clients.</para>
3092	</listitem>
3093	</itemizedlist></para>
3094
3095	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
3096	or the DHCP server will be created in the disabled state, doing
3097	nothing.</para>
3098
3099	<para>After this, VirtualBox will automatically start the DHCP server for
3100	given internal or host-only network as soon as the first virtual machine
3101	which uses that network is started.</para>
3102
3103	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
3104	remove</computeroutput> with the given <computeroutput>--netname
3105	<network_name></computeroutput> or <computeroutput>--ifname
3106	<hostonly_if_name></computeroutput> to remove the DHCP server again
3107	for the given internal or host-only network.</para>
3108
3109	<para>To modify the settings of a DHCP server created earlier with
3110	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
3111	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
3112	network or host-only interface name.</para>
3113	</sect1>
3114
3115	<sect1 id="vboxmanage-extpack">
3116	<title>VBoxManage extpack</title>
3117
3118	<para>The "extpack" command allows you to add or remove VirtualBox
3119	extension packs, as described in <xref
3120	linkend="intro-installing" />.<itemizedlist>
3121	<listitem>
3122	<para>To add a new extension pack, use <computeroutput>VBoxManage
3123	extpack install <tarball></computeroutput>.</para>
3124	</listitem>
3125
3126	<listitem>
3127	<para>To remove a previously installed extension pack, use
3128	<computeroutput>VBoxManage extpack uninstall
3129	<name></computeroutput>. You can use
3130	<computeroutput>VBoxManage list extpacks</computeroutput> to show
3131	the names of the extension packs which are currently installed;
3132	please see <xref linkend="vboxmanage-list" /> also. The optional
3133	<computeroutput>--force</computeroutput> parameter can be used to
3134	override the refusal of an extension pack to be uninstalled.</para>
3135	</listitem>
3136
3137	<listitem>
3138	<para>The <computeroutput>VBoxManage extpack
3139	cleanup</computeroutput> command can be used to remove temporary
3140	files and directories that may have been left behind if a previous
3141	install or uninstall command failed.</para>
3142	</listitem>
3143	</itemizedlist></para>
3144	</sect1>
3145	</chapter>

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

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

Download in other formats: