user_VBoxManage.xml@ 37419

最後變更在這個檔案從37419是 36855,由 vboxsync 提交於 14 年前
doc: describe screenshotpng subcommand
檔案大小: 135.2 KB

行
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><computeroutput>screenshotpng</computeroutput> takes a screenshot
1369	of the guest display and saves it in PNG format.</para>
1370	</listitem>
1371
1372	<listitem>
1373	<para>The <computeroutput>setcredentials</computeroutput> operation is
1374	used for remote logons in Windows guests. For details, please refer to
1375	<xref linkend="autologon" />.</para>
1376	</listitem>
1377
1378	<listitem>
1379	<para>The <computeroutput>guestmemoryballoon</computeroutput>
1380	operation changes the size of the guest memory balloon, that is,
1381	memory allocated by the VirtualBox Guest Additions from the guest
1382	operating system and returned to the hypervisor for re-use by other
1383	virtual machines. This must be specified in megabytes. For details,
1384	see <xref linkend="guestadd-balloon" />.</para>
1385	</listitem>
1386
1387	<listitem>
1388	<para>The <computeroutput>cpuexecutioncap
1389	<1-100></computeroutput>: This operation controls how much cpu
1390	time a virtual CPU can use. A value of 50 implies a single virtual CPU
1391	can use up to 50% of a single host CPU.</para>
1392	</listitem>
1393	</itemizedlist>
1394	</sect1>
1395
1396	<sect1>
1397	<title>VBoxManage discardstate</title>
1398
1399	<para>This command discards the saved state of a virtual machine which is
1400	not currently running, which will cause its operating system to restart
1401	next time you start it. This is the equivalent of pulling out the power
1402	cable on a physical machine, and should be avoided if possible.</para>
1403	</sect1>
1404
1405	<sect1>
1406	<title>VBoxManage adoptstate</title>
1407
1408	<para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
1409	that is seperate from the VM configuration, you can use this command to
1410	"adopt" the file. This will change the VM to saved state and when you
1411	start it, VirtualBox will attempt to restore it from the saved state file
1412	you indicated. This command should only be used in special setups.</para>
1413	</sect1>
1414
1415	<sect1>
1416	<title>VBoxManage snapshot</title>
1417
1418	<para>This command is used to control snapshots from the command line. A
1419	snapshot consists of a complete copy of the virtual machine settings,
1420	copied at the time when the snapshot was taken, and optionally a virtual
1421	machine saved state file if the snapshot was taken while the machine was
1422	running. After a snapshot has been taken, VirtualBox creates differencing
1423	hard disk for each normal hard disk associated with the machine so that
1424	when a snapshot is restored, the contents of the virtual machine's virtual
1425	hard disks can be quickly reset by simply dropping the pre-existing
1426	differencing files.</para>
1427
1428	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
1429	of the current state of the virtual machine. You must supply a name for
1430	the snapshot and can optionally supply a description. The new snapshot is
1431	inserted into the snapshots tree as a child of the current snapshot and
1432	then becomes the new current snapshot.</para>
1433
1434	<para>The <computeroutput>delete</computeroutput> operation deletes a
1435	snapshot (specified by name or by UUID). This can take a while to finish
1436	since the differencing images associated with the snapshot might need to
1437	be merged with their child differencing images.</para>
1438
1439	<para>The <computeroutput>restore</computeroutput> operation will restore
1440	the given snapshot (specified by name or by UUID) by resetting the virtual
1441	machine's settings and current state to that of the snapshot. The previous
1442	current state of the machine will be lost. After this, the given snapshot
1443	becomes the new "current" snapshot so that subsequent snapshots are
1444	inserted under the snapshot from which was restored.</para>
1445
1446	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
1447	shortcut to restore the current snapshot (i.e. the snapshot from which the
1448	current state is derived). This subcommand is equivalent to using the
1449	"restore" subcommand with the name or UUID of the current snapshot, except
1450	that it avoids the extra step of determining that name or UUID.</para>
1451
1452	<para>With the <computeroutput>edit</computeroutput> operation, you can
1453	change the name or description of an existing snapshot.</para>
1454
1455	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
1456	can view the virtual machine settings that were stored with an existing
1457	snapshot.</para>
1458	</sect1>
1459
1460	<sect1 id="vboxmanage-closemedium">
1461	<title>VBoxManage closemedium</title>
1462
1463	<para>This commands removes a hard disk, DVD or floppy image from a
1464	VirtualBox media registry.<footnote>
1465	<para>Before VirtualBox 4.0, it was necessary to call VBoxManage
1466	openmedium before a medium could be attached to a virtual machine;
1467	that call "registered" the medium with the global VirtualBox media
1468	registry. With VirtualBox 4.0 this is no longer necessary; media are
1469	added to media registries automatically. The "closemedium" call has
1470	been retained, however, to allow for explicitly removing a medium from
1471	a registry.</para>
1472	</footnote></para>
1473
1474	<para>Optionally, you can request that the image be deleted. You will get
1475	appropriate diagnostics that the deletion failed, however the image will
1476	become unregistered in any case.</para>
1477	</sect1>
1478
1479	<sect1>
1480	<title id="vboxmanage-storageattach">VBoxManage storageattach</title>
1481
1482	<para>This command attaches/modifies/removes a storage medium connected to
1483	a storage controller that was previously added with the
1484	<computeroutput>storagectl</computeroutput> command (see the previous
1485	section). The syntax is as follows:</para>
1486
1487	<screen>VBoxManage storageattach <uuid\|vmname>
1488	--storagectl <name>
1489	--port <number>
1490	--device <number>
1491	[--type dvddrive\|hdd\|fdd]
1492	[--medium none\|emptydrive\|
1493	<uuid>\|<filename>\|host:<drive>\|iscsi]
1494	[--mtype normal\|writethrough\|immutable\|shareable]
1495	[--comment <text>]
1496	[--passthrough on\|off]
1497	[--bandwidthgroup name\|none]
1498	[--forceunmount]
1499	[--server <name>\|<ip>]
1500	[--target <target>]
1501	[--port <port>]
1502	[--lun <lun>]
1503	[--encodedlun <lun>]
1504	[--username <username>]
1505	[--password <password>]
1506	[--intnet]
1507	</screen>
1508
1509	<para>A number of parameters are commonly required; the ones at the end of
1510	the list are required only for iSCSI targets (see below).</para>
1511
1512	<para>The common parameters are:<glosslist>
1513	<glossentry>
1514	<glossterm>uuid\|vmname</glossterm>
1515
1516	<glossdef>
1517	<para>The VM UUID or VM Name. Mandatory.</para>
1518	</glossdef>
1519	</glossentry>
1520
1521	<glossentry>
1522	<glossterm>storagectl</glossterm>
1523
1524	<glossdef>
1525	<para>Name of the storage controller. Mandatory. The list of the
1526	storage controllers currently attached to a VM can be obtained
1527	with <computeroutput>VBoxManage showvminfo</computeroutput>; see
1528	<xref linkend="vboxmanage-showvminfo" />.</para>
1529	</glossdef>
1530	</glossentry>
1531
1532	<glossentry>
1533	<glossterm>port</glossterm>
1534
1535	<glossdef>
1536	<para>The number of the storage controller's port which is to be
1537	modified. Mandatory.</para>
1538	</glossdef>
1539	</glossentry>
1540
1541	<glossentry>
1542	<glossterm>device</glossterm>
1543
1544	<glossdef>
1545	<para>The number of the port's device which is to be modified.
1546	Mandatory.</para>
1547	</glossdef>
1548	</glossentry>
1549
1550	<glossentry>
1551	<glossterm>type</glossterm>
1552
1553	<glossdef>
1554	<para>Define the type of the drive to which the medium is being
1555	attached/detached/modified. This argument can only be omitted if
1556	the type of medium can be determined from either the medium given
1557	with the <computeroutput>--medium</computeroutput> argument or
1558	from a previous medium attachment.</para>
1559	</glossdef>
1560	</glossentry>
1561
1562	<glossentry>
1563	<glossterm>medium</glossterm>
1564
1565	<glossdef>
1566	<para>Specifies what is to be attached. The following values are
1567	supported:<itemizedlist>
1568	<listitem>
1569	<para>"none": Any existing device should be removed from the
1570	given slot.</para>
1571	</listitem>
1572
1573	<listitem>
1574	<para>"emptydrive": For a virtual DVD or floppy drive only,
1575	this makes the device slot behaves like a removeable drive
1576	into which no media has been inserted.</para>
1577	</listitem>
1578
1579	<listitem>
1580	<para>If a UUID is specified, it must be the UUID of a
1581	storage medium that is already known to VirtualBox (e.g.
1582	because it has been attached to another virtual machine).
1583	See <xref linkend="vboxmanage-list" /> for how to list known
1584	media. This medium is then attached to the given device
1585	slot.</para>
1586	</listitem>
1587
1588	<listitem>
1589	<para>If a filename is specified, it must be the full path
1590	of an existing disk image (ISO, RAW, VDI, VMDK or other),
1591	which is then attached to the given device slot.</para>
1592	</listitem>
1593
1594	<listitem>
1595	<para>"host:<drive>": For a virtual DVD or floppy
1596	drive only, this connects the given device slot to the
1597	specified DVD or floppy drive on the host computer.</para>
1598	</listitem>
1599
1600	<listitem>
1601	<para>"iscsi": For virtual hard disks only, this allows for
1602	specifying an iSCSI target. In this case, more parameters
1603	must be given; see below.</para>
1604	</listitem>
1605	</itemizedlist></para>
1606
1607	<para>Some of the above changes, in particular for removeable
1608	media (floppies and CDs/DVDs), can be effected while a VM is
1609	running. Others (device changes or changes in hard disk device
1610	slots) require the VM to be powered off.</para>
1611	</glossdef>
1612	</glossentry>
1613
1614	<glossentry>
1615	<glossterm>mtype</glossterm>
1616
1617	<glossdef>
1618	<para>Defines how this medium behaves with respect to snapshots
1619	and write operations. See <xref linkend="hdimagewrites" /> for
1620	details.</para>
1621	</glossdef>
1622	</glossentry>
1623
1624	<glossentry>
1625	<glossterm>comment</glossterm>
1626
1627	<glossdef>
1628	<para>Any description that you want to have stored with this
1629	medium (optional; for example, for an iSCSI target, "Big storage
1630	server downstairs"). This is purely descriptive and not needed for
1631	the medium to function correctly.</para>
1632	</glossdef>
1633	</glossentry>
1634
1635	<glossentry>
1636	<glossterm>passthrough</glossterm>
1637
1638	<glossdef>
1639	<para>For a virtual DVD drive only, you can enable DVD writing
1640	support (currently experimental; see <xref
1641	linkend="storage-cds" />).</para>
1642	</glossdef>
1643	</glossentry>
1644
1645	<glossentry>
1646	<glossterm>bandwidthgroup</glossterm>
1647
1648	<glossdef>
1649	<para>Sets the bandwidth group to use for the given device; see
1650	<xref linkend="storage-bandwidth-limit" />.</para>
1651	</glossdef>
1652	</glossentry>
1653
1654	<glossentry>
1655	<glossterm>forceunmount</glossterm>
1656
1657	<glossdef>
1658	<para>For a virtual DVD or floppy drive only, this forcibly
1659	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
1660	the previous one is locked down by the guest for reading. Again,
1661	see <xref linkend="storage-cds" /> for details.</para>
1662	</glossdef>
1663	</glossentry>
1664	</glosslist></para>
1665
1666	<para>When "iscsi" is used with the
1667	<computeroutput>--medium</computeroutput> parameter for iSCSI support --
1668	see <xref linkend="storage-iscsi" /> --, additional parameters must or can
1669	be used:<glosslist>
1670	<glossentry>
1671	<glossterm>server</glossterm>
1672
1673	<glossdef>
1674	<para>The host name or IP address of the iSCSI target;
1675	required.</para>
1676	</glossdef>
1677	</glossentry>
1678
1679	<glossentry>
1680	<glossterm>target</glossterm>
1681
1682	<glossdef>
1683	<para>Target name string. This is determined by the iSCSI target
1684	and used to identify the storage resource; required.</para>
1685	</glossdef>
1686	</glossentry>
1687
1688	<glossentry>
1689	<glossterm>port</glossterm>
1690
1691	<glossdef>
1692	<para>TCP/IP port number of the iSCSI service on the target
1693	(optional).</para>
1694	</glossdef>
1695	</glossentry>
1696
1697	<glossentry>
1698	<glossterm>lun</glossterm>
1699
1700	<glossdef>
1701	<para>Logical Unit Number of the target resource (optional).
1702	Often, this value is zero.</para>
1703	</glossdef>
1704	</glossentry>
1705
1706	<glossentry>
1707	<glossterm>username, password</glossterm>
1708
1709	<glossdef>
1710	<para>Username and password for target authentication, if required
1711	(optional).<note>
1712	<para>Currently, username and password are stored without
1713	encryption (i.e. in clear text) in the XML machine
1714	configuration file.</para>
1715	</note></para>
1716	</glossdef>
1717	</glossentry>
1718
1719	<glossentry>
1720	<glossterm>intnet</glossterm>
1721
1722	<glossdef>
1723	<para>If specified, connect to the iSCSI target via Internal
1724	Networking. This needs further configuration which is described in
1725	<xref linkend="iscsi-intnet" />.</para>
1726	</glossdef>
1727	</glossentry>
1728	</glosslist></para>
1729	</sect1>
1730
1731	<sect1 id="vboxmanage-storagectl">
1732	<title>VBoxManage storagectl</title>
1733
1734	<para>This command attaches/modifies/removes a storage controller. After
1735	this, virtual media can be attached to the controller with the
1736	<computeroutput>storageattach</computeroutput> command (see the next
1737	section).</para>
1738
1739	<para>The syntax is as follows:</para>
1740
1741	<screen>VBoxManage storagectl <uuid\|vmname>
1742	--name <name>
1743	[--add <ide/sata/scsi/floppy>]
1744	[--controller <LsiLogic\|LSILogicSAS\|BusLogic\|
1745	IntelAhci\|PIIX3\|PIIX4\|ICH6\|I82078>]
1746	[--sataideemulation<1-4> <1-30>]
1747	[--sataportcount <1-30>]
1748	[--hostiocache on\|off]
1749	[--bootable on\|off]
1750	[--remove]</screen>
1751
1752	<para>where the parameters mean: <glosslist>
1753	<glossentry>
1754	<glossterm>uuid\|vmname</glossterm>
1755
1756	<glossdef>
1757	<para>The VM UUID or VM Name. Mandatory.</para>
1758	</glossdef>
1759	</glossentry>
1760
1761	<glossentry>
1762	<glossterm>name</glossterm>
1763
1764	<glossdef>
1765	<para>Name of the storage controller. Mandatory.</para>
1766	</glossdef>
1767	</glossentry>
1768
1769	<glossentry>
1770	<glossterm>add</glossterm>
1771
1772	<glossdef>
1773	<para>Define the type of the system bus to which the storage
1774	controller must be connected.</para>
1775	</glossdef>
1776	</glossentry>
1777
1778	<glossentry>
1779	<glossterm>controller</glossterm>
1780
1781	<glossdef>
1782	<para>Allows to choose the type of chipset being emulated for the
1783	given storage controller.</para>
1784	</glossdef>
1785	</glossentry>
1786
1787	<glossentry>
1788	<glossterm>sataideemulation</glossterm>
1789
1790	<glossdef>
1791	<para>This specifies which SATA ports should operate in IDE
1792	emulation mode. As explained in <xref
1793	linkend="harddiskcontrollers" />, by default, this is the case for
1794	SATA ports 1-4; with this command, you can map four IDE channels
1795	to any of the 30 supported SATA ports.</para>
1796	</glossdef>
1797	</glossentry>
1798
1799	<glossentry>
1800	<glossterm>sataportcount</glossterm>
1801
1802	<glossdef>
1803	<para>This determines how many ports the SATA controller should
1804	support.</para>
1805	</glossdef>
1806	</glossentry>
1807
1808	<glossentry>
1809	<glossterm>hostiocache</glossterm>
1810
1811	<glossdef>
1812	<para>Configures the use of the host I/O cache for all disk images
1813	attached to this storage controller. For details, please see <xref
1814	linkend="iocaching" />.</para>
1815	</glossdef>
1816	</glossentry>
1817
1818	<glossentry>
1819	<glossterm>bootable</glossterm>
1820
1821	<glossdef>
1822	<para>Selects whether this controller is bootable.</para>
1823	</glossdef>
1824	</glossentry>
1825
1826	<glossentry>
1827	<glossterm>remove</glossterm>
1828
1829	<glossdef>
1830	<para>Removes the storage controller from the VM config.</para>
1831	</glossdef>
1832	</glossentry>
1833	</glosslist></para>
1834	</sect1>
1835
1836	<sect1>
1837	<title>VBoxManage bandwidthctl</title>
1838
1839	<para>This command creates/deletes/modifies bandwidth groups of the given
1840	virtual machine:<screen>VBoxManage bandwidthctl <uuid\|vmname>
1841	--name <name>
1842	[--add disk
1843	[--delete]
1844	[--limit MB/s]</screen></para>
1845
1846	<para>See <xref linkend="storage-bandwidth-limit" /> for an introduction
1847	to bandwidth limits. The parameters mean:<glosslist>
1848	<glossentry>
1849	<glossterm>uuid\|vmname</glossterm>
1850
1851	<glossdef>
1852	<para>The VM UUID or VM Name. Mandatory.</para>
1853	</glossdef>
1854	</glossentry>
1855
1856	<glossentry>
1857	<glossterm>name</glossterm>
1858
1859	<glossdef>
1860	<para>Name of the bandwidth group. Mandatory.</para>
1861	</glossdef>
1862	</glossentry>
1863
1864	<glossentry>
1865	<glossterm>add</glossterm>
1866
1867	<glossdef>
1868	<para>Creates a new bandwdith group with the given type.</para>
1869	</glossdef>
1870	</glossentry>
1871
1872	<glossentry>
1873	<glossterm>delete</glossterm>
1874
1875	<glossdef>
1876	<para>Deletes a bandwdith group if it isn't used anymore.</para>
1877	</glossdef>
1878	</glossentry>
1879
1880	<glossentry>
1881	<glossterm>limit</glossterm>
1882
1883	<glossdef>
1884	<para>Sets the limit for the given group to the specified amount.
1885	Can be changed while the VM is running.</para>
1886	</glossdef>
1887	</glossentry>
1888	</glosslist></para>
1889	</sect1>
1890
1891	<sect1>
1892	<title>VBoxManage showhdinfo</title>
1893
1894	<para>This command shows information about a virtual hard disk image,
1895	notably its size, its size on disk, its type and the virtual machines
1896	which use it.<note>
1897	<para>For compatibility with earlier versions of VirtualBox, the
1898	"showvdiinfo" command is also supported and mapped internally to the
1899	"showhdinfo" command.</para>
1900	</note></para>
1901	</sect1>
1902
1903	<sect1 id="vboxmanage-createvdi">
1904	<title>VBoxManage createhd</title>
1905
1906	<para>This command creates a new virtual hard disk image. The syntax is as
1907	follows:</para>
1908
1909	<screen>VBoxManage createhd --filename <filename>
1910	--size <megabytes>
1911	[--format VDI\|VMDK\|VHD] (default: VDI)
1912	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
1913
1914	<para>where the parameters mean:<glosslist>
1915	<glossentry>
1916	<glossterm>filename</glossterm>
1917
1918	<glossdef>
1919	<para>Allows to choose a file name. Mandatory.</para>
1920	</glossdef>
1921	</glossentry>
1922
1923	<glossentry>
1924	<glossterm>size</glossterm>
1925
1926	<glossdef>
1927	<para>Allows to define the image capacity, in 1 MiB units.
1928	Mandatory.</para>
1929	</glossdef>
1930	</glossentry>
1931
1932	<glossentry>
1933	<glossterm>format</glossterm>
1934
1935	<glossdef>
1936	<para>Allows to choose a file format for the output file different
1937	from the file format of the input file.</para>
1938	</glossdef>
1939	</glossentry>
1940
1941	<glossentry>
1942	<glossterm>variant</glossterm>
1943
1944	<glossdef>
1945	<para>Allows to choose a file format variant for the output file.
1946	It is a comma-separated list of variant flags. Not all
1947	combinations are supported, and specifying inconsistent flags will
1948	result in an error message.</para>
1949	</glossdef>
1950	</glossentry>
1951	</glosslist> <note>
1952	<para>For compatibility with earlier versions of VirtualBox, the
1953	"createvdi" command is also supported and mapped internally to the
1954	"createhd" command.</para>
1955	</note></para>
1956	</sect1>
1957
1958	<sect1 id="vboxmanage-modifyvdi">
1959	<title>VBoxManage modifyhd</title>
1960
1961	<para>With the <computeroutput>modifyhd</computeroutput> command, you can
1962	change the characteristics of a disk image after it has been
1963	created:<screen>VBoxManage modifyhd <uuid>\|<filename>
1964	[--type normal\|writethrough\|immutable\|shareable\|
1965	readonly\|multiattach]
1966	[--autoreset on\|off]
1967	[--compact]
1968	[--resize <megabytes>\|--resizebyte <bytes>]</screen><note>
1969	<para>Despite the "hd" in the subcommand name, the command works with
1970	all disk images, not only hard disks. For compatibility with earlier
1971	versions of VirtualBox, the "modifyvdi" command is also supported and
1972	mapped internally to the "modifyhd" command.</para>
1973	</note></para>
1974
1975	<para>The following options are available:<itemizedlist>
1976	<listitem>
1977	<para>With the <computeroutput>--type</computeroutput> argument, you
1978	can change the type of an existing image between the normal,
1979	immutable, write-through and other modes; see <xref
1980	linkend="hdimagewrites" /> for details.</para>
1981	</listitem>
1982
1983	<listitem>
1984	<para>For immutable (differencing) hard disks only, the
1985	<computeroutput>--autoreset on\|off</computeroutput> option
1986	determines whether the disk is automatically reset on every VM
1987	startup (again, see <xref linkend="hdimagewrites" />). The default
1988	is "on".</para>
1989	</listitem>
1990
1991	<listitem>
1992	<para>With the <computeroutput>--compact</computeroutput> option,
1993	can be used to compact disk images, i.e. remove blocks that only
1994	contains zeroes. This will shrink a dynamically expanding image
1995	again; it will reduce the <emphasis>physical</emphasis> size of the
1996	image without affecting the logical size of the virtual disk.
1997	Compaction works both for base images and for diff images created as
1998	part of a snapshot.</para>
1999
2000	<para>For this operation to be effective, it is required that free
2001	space in the guest system first be zeroed out using a suitable
2002	software tool. For Windows guests, you can use the
2003	<computeroutput>sdelete</computeroutput> tool provided by Microsoft.
2004	Execute <computeroutput>sdelete -c</computeroutput> in the guest to
2005	zero the free disk space before compressing the virtual disk
2006	image. For Linux, use the <code>zerofree</code> utility which
2007	supports ext2/ext3 filesystems.</para>
2008
2009	<para>Please note that compacting is currently only available for
2010	VDI images. A similar effect can be achieved by zeroing out free
2011	blocks and then cloning the disk to any other dynamically expanding
2012	format. You can use this workaround until compacting is also
2013	supported for disk formats other than VDI.</para>
2014	</listitem>
2015
2016	<listitem>
2017	<para>The --resize option allows you to expand the capacity of an
2018	existing image; this increases the <emphasis>logical</emphasis> size
2019	of a virtual disk without affecting the physical size much.<footnote>
2020	<para>Image resizing was added with VirtualBox 4.0.</para>
2021	</footnote> This currently works only for the VDI and VHD formats,
2022	and only for the dynamically expanding variants. For example, if you
2023	originally created a 10G disk which is now full, you can use the
2024	--resize command to add more space to the virtual disk without
2025	having to create a new image and copy all data from within a virtual
2026	machine.</para>
2027	</listitem>
2028	</itemizedlist></para>
2029	</sect1>
2030
2031	<sect1 id="vboxmanage-clonevdi">
2032	<title>VBoxManage clonehd</title>
2033
2034	<para>This command duplicates a registered virtual hard disk image to a
2035	new image file with a new unique identifier (UUID). The new image can be
2036	transferred to another host system or imported into VirtualBox again using
2037	the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
2038	linkend="cloningvdis" />. The syntax is as follows:</para>
2039
2040	<screen>VBoxManage clonehd <uuid>\|<filename> <outputfile>
2041	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
2042	[--variant Standard,Fixed,Split2G,Stream,ESX]
2043	[--existing]</screen>
2044
2045	<para>where the parameters mean:<glosslist>
2046	<glossentry>
2047	<glossterm>format</glossterm>
2048
2049	<glossdef>
2050	<para>Allow to choose a file format for the output file different
2051	from the file format of the input file.</para>
2052	</glossdef>
2053	</glossentry>
2054
2055	<glossentry>
2056	<glossterm>variant</glossterm>
2057
2058	<glossdef>
2059	<para>Allow to choose a file format variant for the output file.
2060	It is a comma-separated list of variant flags. Not all
2061	combinations are supported, and specifying inconsistent flags will
2062	result in an error message.</para>
2063	</glossdef>
2064	</glossentry>
2065
2066	<glossentry>
2067	<glossterm>existing</glossterm>
2068
2069	<glossdef>
2070	<para>Perform the clone operation to an already existing
2071	destination medium. Only the portion of the source medium which
2072	fits into the destination medium is copied. This means if the
2073	destination medium is smaller than the source only a part of it is
2074	copied, and if the destination medium is larger than the source
2075	the remaining part of the destination medium is unchanged.</para>
2076	</glossdef>
2077	</glossentry>
2078	</glosslist> <note>
2079	<para>For compatibility with earlier versions of VirtualBox, the
2080	"clonevdi" command is also supported and mapped internally to the
2081	"clonehd" command.</para>
2082	</note></para>
2083	</sect1>
2084
2085	<sect1>
2086	<title>VBoxManage convertfromraw</title>
2087
2088	<para>This command converts a raw disk image to a VirtualBox Disk Image
2089	(VDI) file. The syntax is as follows:</para>
2090
2091	<screen>VBoxManage convertfromraw <filename> <outputfile>
2092	[--format VDI\|VMDK\|VHD]
2093	[--variant Standard,Fixed,Split2G,Stream,ESX]
2094	VBoxManage convertfromraw stdin <outputfile> <bytes>
2095	[--format VDI\|VMDK\|VHD]
2096	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
2097
2098	<para>where the parameters mean:<glosslist>
2099	<glossentry>
2100	<glossterm>format</glossterm>
2101
2102	<glossdef>
2103	<para>Select the disk image format to create. Default is
2104	VDI.</para>
2105	</glossdef>
2106	</glossentry>
2107
2108	<glossentry>
2109	<glossterm>variant</glossterm>
2110
2111	<glossdef>
2112	<para>Allow to choose a file format variant for the output file.
2113	It is a comma-separated list of variant flags. Not all
2114	combinations are supported, and specifying inconsistent flags will
2115	result in an error message.</para>
2116	</glossdef>
2117	</glossentry>
2118	</glosslist> The second form forces VBoxManage to read the content for
2119	the disk image from standard input (useful for using that command in a
2120	pipe).</para>
2121
2122	<para><note>
2123	<para>For compatibility with earlier versions of VirtualBox, the
2124	"convertdd" command is also supported and mapped internally to the
2125	"convertfromraw" command.</para>
2126	</note></para>
2127	</sect1>
2128
2129	<sect1>
2130	<title>VBoxManage getextradata/setextradata</title>
2131
2132	<para>These commands let you attach and retrieve string data to a virtual
2133	machine or to a VirtualBox configuration (by specifying
2134	<computeroutput>global</computeroutput> instead of a virtual machine
2135	name). You must specify a key (as a text string) to associate the data
2136	with, which you can later use to retrieve it. For example:</para>
2137
2138	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
2139	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
2140
2141	<para>would associate the string "2006.01.01" with the key installdate for
2142	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
2143	could retrieve the information as follows:</para>
2144
2145	<screen>VBoxManage getextradata Fedora5 installdate</screen>
2146
2147	<para>which would return</para>
2148
2149	<screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
2150	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
2151	All rights reserved.
2152
2153	Value: 2006.01.01</screen>
2154	</sect1>
2155
2156	<sect1 id="vboxmanage-setproperty">
2157	<title>VBoxManage setproperty</title>
2158
2159	<para>This command is used to change global settings which affect the
2160	entire VirtualBox installation. Some of these correspond to the settings
2161	in the "Global settings" dialog in the graphical user interface. The
2162	following properties are available:<glosslist>
2163	<glossentry>
2164	<glossterm>machinefolder</glossterm>
2165
2166	<glossdef>
2167	<para>This specifies the default folder in which virtual machine
2168	definitions are kept; see <xref linkend="vboxconfigdata" /> for
2169	details.</para>
2170	</glossdef>
2171	</glossentry>
2172
2173	<glossentry>
2174	<glossterm>vrdeauthlibrary</glossterm>
2175
2176	<glossdef>
2177	<para>This specifies which library to use when "external"
2178	authentication has been selected for a particular virtual machine;
2179	see <xref linkend="vbox-auth" /> for details.</para>
2180	</glossdef>
2181	</glossentry>
2182
2183	<glossentry>
2184	<glossterm>websrvauthlibrary</glossterm>
2185
2186	<glossdef>
2187	<para>This specifies which library the web service uses to
2188	authenticate users. For details about the VirtualBox web service,
2189	please refer to the separate VirtualBox SDK reference (see <xref
2190	linkend="VirtualBoxAPI" />).</para>
2191	</glossdef>
2192	</glossentry>
2193
2194	<glossentry>
2195	<glossterm>vrdelibrary</glossterm>
2196
2197	<glossdef>
2198	<para>This specifies which library implements the VirtualBox
2199	Remote Desktop Extension.</para>
2200	</glossdef>
2201	</glossentry>
2202
2203	<glossentry>
2204	<glossterm>hwvirtexenabled</glossterm>
2205
2206	<glossdef>
2207	<para>This selects whether or not hardware virtualization support
2208	is enabled by default.</para>
2209	</glossdef>
2210	</glossentry>
2211	</glosslist></para>
2212	</sect1>
2213
2214	<sect1>
2215	<title>VBoxManage usbfilter add/modify/remove</title>
2216
2217	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
2218	working with USB filters in virtual machines, or global filters which
2219	affect the whole VirtualBox setup. Global filters are applied before
2220	machine-specific filters, and may be used to prevent devices from being
2221	captured by any virtual machine. Global filters are always applied in a
2222	particular order, and only the first filter which fits a device is
2223	applied. So for example, if the first global filter says to hold (make
2224	available) a particular Kingston memory stick device and the second to
2225	ignore all Kingston devices, that memory stick will be available to any
2226	machine with an appropriate filter, but no other Kingston device
2227	will.</para>
2228
2229	<para>When creating a USB filter using <computeroutput>usbfilter
2230	add</computeroutput>, you must supply three or four mandatory parameters.
2231	The index specifies the position in the list at which the filter should be
2232	placed. If there is already a filter at that position, then it and the
2233	following ones will be shifted back one place. Otherwise the new filter
2234	will be added onto the end of the list. The
2235	<computeroutput>target</computeroutput> parameter selects the virtual
2236	machine that the filter should be attached to or use "global" to apply it
2237	to all virtual machines. <computeroutput>name</computeroutput> is a name
2238	for the new filter and for global filters,
2239	<computeroutput>action</computeroutput> says whether to allow machines
2240	access to devices that fit the filter description ("hold") or not to give
2241	them access ("ignore"). In addition, you should specify parameters to
2242	filter by. You can find the parameters for devices attached to your system
2243	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
2244	you can specify whether the filter should be active, and for local
2245	filters, whether they are for local devices, remote (over an RDP
2246	connection) or either.</para>
2247
2248	<para>When you modify a USB filter using <computeroutput>usbfilter
2249	modify</computeroutput>, you must specify the filter by index (see the
2250	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
2251	find global filter indexes and that of <computeroutput>VBoxManage
2252	showvminfo</computeroutput> to find indexes for individual machines) and
2253	by target, which is either a virtual machine or "global". The properties
2254	which can be changed are the same as for <computeroutput>usbfilter
2255	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
2256	remove</computeroutput> and specify the index and the target.</para>
2257	</sect1>
2258
2259	<sect1 id="vboxmanage-sharedfolder">
2260	<title>VBoxManage sharedfolder add/remove</title>
2261
2262	<para>This command allows you to share folders on the host computer with
2263	guest operating systems. For this, the guest systems must have a version
2264	of the VirtualBox Guest Additions installed which supports this
2265	functionality.</para>
2266
2267	<para>Shared folders are described in detail in <xref
2268	linkend="sharedfolders" />.</para>
2269	</sect1>
2270
2271	<sect1 id="vboxmanage-guestproperty">
2272	<title>VBoxManage guestproperty</title>
2273
2274	<para>The "guestproperty" commands allow you to get or set properties of a
2275	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
2276	for an introduction. As explained there, guest properties are arbitrary
2277	key/value string pairs which can be written to and read from by either the
2278	guest or the host, so they can be used as a low-volume communication
2279	channel for strings, provided that a guest is running and has the Guest
2280	Additions installed. In addition, a number of values whose keys begin with
2281	"/VirtualBox/" are automatically set and maintained by the Guest
2282	Additions.</para>
2283
2284	<para>The following subcommands are available (where
2285	<computeroutput><vm></computeroutput>, in each case, can either be a
2286	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2287	<listitem>
2288	<para><computeroutput>enumerate <vm> [--patterns
2289	<pattern>]</computeroutput>: This lists all the guest
2290	properties that are available for the given VM, including the value.
2291	This list will be very limited if the guest's service process cannot
2292	be contacted, e.g. because the VM is not running or the Guest
2293	Additions are not installed.</para>
2294
2295	<para>If <computeroutput>--patterns <pattern></computeroutput>
2296	is specified, it acts as a filter to only list properties that match
2297	the given pattern. The pattern can contain the following wildcard
2298	characters:<itemizedlist>
2299	<listitem>
2300	<para><computeroutput>*</computeroutput> (asterisk):
2301	represents any number of characters; for example,
2302	"<computeroutput>/VirtualBox*</computeroutput>" would match
2303	all properties beginning with "/VirtualBox".</para>
2304	</listitem>
2305
2306	<listitem>
2307	<para><computeroutput>?</computeroutput> (question mark):
2308	represents a single arbitrary character; for example,
2309	"<computeroutput>fo?</computeroutput>" would match both "foo"
2310	and "for".</para>
2311	</listitem>
2312
2313	<listitem>
2314	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
2315	used to specify multiple alternative patterns; for example,
2316	"<computeroutput>s\|t</computeroutput>" would match anything
2317	starting with either "s" or "t".</para>
2318	</listitem>
2319	</itemizedlist></para>
2320	</listitem>
2321
2322	<listitem>
2323	<para><computeroutput>get <vm></computeroutput>: This
2324	retrieves the value of a single property only. If the property
2325	cannot be found (e.g. because the guest is not running), this will
2326	print <screen>No value set!</screen></para>
2327	</listitem>
2328
2329	<listitem>
2330	<para><computeroutput>set <vm> <property> [<value>
2331	[--flags <flags>]]</computeroutput>: This allows you to set a
2332	guest property by specifying the key and value. If
2333	<computeroutput><value></computeroutput> is omitted, the
2334	property is deleted. With <computeroutput>--flags</computeroutput>
2335	you can optionally specify additional behavior (you can combine
2336	several by separating them with commas):<itemizedlist>
2337	<listitem>
2338	<para><computeroutput>TRANSIENT</computeroutput>: the value
2339	will not be stored with the VM data when the VM exits;</para>
2340	</listitem>
2341
2342	<listitem>
2343	<para><computeroutput>TRANSRESET</computeroutput>: the value
2344	will be deleted as soon as the VM restarts and/or exits;</para>
2345	</listitem>
2346
2347	<listitem>
2348	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
2349	can only be changed by the host, but the guest can only read
2350	it;</para>
2351	</listitem>
2352
2353	<listitem>
2354	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
2355	the value can only be changed by the guest, but the host can
2356	only read it;</para>
2357	</listitem>
2358
2359	<listitem>
2360	<para><computeroutput>READONLY</computeroutput>: a combination
2361	of the two, the value cannot be changed at all.</para>
2362	</listitem>
2363	</itemizedlist></para>
2364	</listitem>
2365
2366	<listitem>
2367	<para><computeroutput>wait <vm> <pattern> --timeout
2368	<timeout></computeroutput>: This waits for a particular value
2369	described by "pattern" to change or to be deleted or created. The
2370	pattern rules are the same as for the "enumerate" subcommand
2371	above.</para>
2372	</listitem>
2373	</itemizedlist></para>
2374	</sect1>
2375
2376	<sect1 id="vboxmanage-guestcontrol">
2377	<title>VBoxManage guestcontrol</title>
2378
2379	<para>The "guestcontrol" commands allow you to control certain things
2380	inside a guest from the host. Please see <xref
2381	linkend="guestadd-guestcontrol" /> for an introduction.</para>
2382
2383	<para>Generally, the syntax is as follows:</para>
2384
2385	<screen>VBoxManage guestcontrol <command></screen>
2386
2387	<para>The following subcommands are available (where
2388	<computeroutput><vm></computeroutput>, in each case, can either be a
2389	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2390	<listitem>
2391	<para><computeroutput>execute</computeroutput>, which allows for
2392	executing a program/script (process) which is already installed and
2393	runnable on the guest. This command only works while a VM is up and
2394	running and has the following syntax:</para>
2395
2396	<screen>VBoxManage guestcontrol <vmname>\|<uuid> exec[ute]
2397	<path to program>
2398	--username <name> --password <password>
2399	[--arguments "<arguments>"]
2400	[--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
2401	[--flags <flags>] [--timeout <msec>]
2402	[--verbose] [--wait-for exit,stdout,stderr\|\|]</screen>
2403
2404	<para>where the parameters mean: <glosslist>
2405	<glossentry>
2406	<glossterm>uuid\|vmname</glossterm>
2407
2408	<glossdef>
2409	<para>The VM UUID or VM name. Mandatory.</para>
2410	</glossdef>
2411	</glossentry>
2412
2413	<glossentry>
2414	<glossterm>path to program</glossterm>
2415
2416	<glossdef>
2417	<para>Absolute path and process name of process to execute
2418	in the guest, e.g.
2419	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
2420	</glossdef>
2421	</glossentry>
2422
2423	<glossentry>
2424	<glossterm>--arguments "<arguments>"</glossterm>
2425
2426	<glossdef>
2427	<para>One or more arguments to pass to the process being
2428	executed.</para>
2429
2430	<para>Arguments containing spaces must be enclosed in
2431	quotation marks. More than one
2432	<computeroutput>--arguments</computeroutput> at a time can
2433	be specified to keep the command line tidy.</para>
2434	</glossdef>
2435	</glossentry>
2436
2437	<glossentry>
2438	<glossterm>--environment
2439	"<NAME>=<VALUE>"</glossterm>
2440
2441	<glossdef>
2442	<para>One or more environment variables to be set or
2443	unset.</para>
2444
2445	<para>By default, the new process in the guest will be
2446	created with the standard environment of the guest OS. This
2447	option allows for modifying that environment. To set/modify
2448	a variable, a pair of
2449	<computeroutput>NAME=VALUE</computeroutput> must be
2450	specified; to unset a certain variable, the name with no
2451	value must set, e.g.
2452	<computeroutput>NAME=</computeroutput>.</para>
2453
2454	<para>Arguments containing spaces must be enclosed in
2455	quotation marks. More than one
2456	<computeroutput>--environment</computeroutput> at a time can
2457	be specified to keep the command line tidy.</para>
2458	</glossdef>
2459	</glossentry>
2460
2461	<glossentry>
2462	<glossterm>--flags <flags></glossterm>
2463
2464	<glossdef>
2465	<para>Additional flags to set. This is not used at the
2466	moment.</para>
2467	</glossdef>
2468	</glossentry>
2469
2470	<glossentry>
2471	<glossterm>--timeout <msec></glossterm>
2472
2473	<glossdef>
2474	<para>Value (in milliseconds) that specifies the time how
2475	long the started process is allowed to run and how long
2476	VBoxManage waits for getting output from that process. If no
2477	timeout is specified, VBoxManage will wait forever until the
2478	started process ends or an error occured.</para>
2479	</glossdef>
2480	</glossentry>
2481
2482	<glossentry>
2483	<glossterm>--username <name></glossterm>
2484
2485	<glossdef>
2486	<para>Name of the user the process should run under. This
2487	user must exist on the guest OS.</para>
2488	</glossdef>
2489	</glossentry>
2490
2491	<glossentry>
2492	<glossterm>--password <password></glossterm>
2493
2494	<glossdef>
2495	<para>Password of the user account specified with
2496	<computeroutput>--username</computeroutput>. If not given,
2497	an empty password is assumed.</para>
2498	</glossdef>
2499	</glossentry>
2500
2501	<glossentry>
2502	<glossterm>--verbose</glossterm>
2503
2504	<glossdef>
2505	<para>Tells VBoxManage to be more verbose.</para>
2506	</glossdef>
2507	</glossentry>
2508
2509	<glossentry>
2510	<glossterm>--wait-for <action></glossterm>
2511
2512	<glossdef>
2513	<para>Tells VBoxManage to wait for a certain action to
2514	happen and react to it. The following actions are available:
2515	<glosslist>
2516	<glossentry>
2517	<glossterm>exit</glossterm>
2518
2519	<glossdef>
2520	<para>Waits until the process ends and outputs its
2521	exit code along with the exit reason/flags.</para>
2522	</glossdef>
2523	</glossentry>
2524
2525	<glossentry>
2526	<glossterm>stdout or stderr</glossterm>
2527
2528	<glossdef>
2529	<para>Waits until the process ends and outputs its
2530	exit code along with the exit reason/flags. After
2531	that VBoxManage retrieves the output collected from
2532	the guest process's stdout and stderr.</para>
2533	</glossdef>
2534	</glossentry>
2535	</glosslist></para>
2536	</glossdef>
2537	</glossentry>
2538	</glosslist></para>
2539
2540	<para><note>
2541	<para>On Windows there are certain limitations for graphical
2542	applications; please see <xref linkend="KnownIssues" /> for more
2543	information.</para>
2544	</note> Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr"
2545	--username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe"
2546	--username foo --password bar --wait-for stdout</screen> Note that
2547	the double backslashes in the second example are only required on
2548	Unix hosts.</para>
2549	</listitem>
2550
2551	<listitem>
2552	<para><computeroutput>copyto</computeroutput>, which allows copying
2553	files from the host to the guest (only with installed Guest
2554	Additions 4.0 and later).</para>
2555
2556	<screen>VBoxManage guestcontrol <vmname>\|<uuid> copyto\|cp
2557	<source on host> <destination on guest>
2558	--username <name> --password <password>
2559	[--dryrun] [--follow] [--recursive] [--verbose]</screen>
2560
2561	<para>where the parameters mean: <glosslist>
2562	<glossentry>
2563	<glossterm>uuid\|vmname</glossterm>
2564
2565	<glossdef>
2566	<para>The VM UUID or VM name. Mandatory.</para>
2567	</glossdef>
2568	</glossentry>
2569
2570	<glossentry>
2571	<glossterm>source on host</glossterm>
2572
2573	<glossdef>
2574	<para>Absolute path of source file(s) on host to copy over
2575	to the guest, e.g.
2576	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
2577	This also can be a wildcard expression, e.g.
2578	<computeroutput>C:\Windows\System32\*.dll</computeroutput></para>
2579	</glossdef>
2580	</glossentry>
2581
2582	<glossentry>
2583	<glossterm>destination on guest</glossterm>
2584
2585	<glossdef>
2586	<para>Absolute destination path on the guest, e.g.
2587	<computeroutput>C:\Temp</computeroutput></para>
2588	</glossdef>
2589	</glossentry>
2590
2591	<glossentry>
2592	<glossterm>--username <name></glossterm>
2593
2594	<glossdef>
2595	<para>Name of the user the copy process should run under.
2596	This user must exist on the guest OS.</para>
2597	</glossdef>
2598	</glossentry>
2599
2600	<glossentry>
2601	<glossterm>--password <password></glossterm>
2602
2603	<glossdef>
2604	<para>Password of the user account specified with
2605	<computeroutput>--username</computeroutput>. If not given,
2606	an empty password is assumed.</para>
2607	</glossdef>
2608	</glossentry>
2609
2610	<glossentry>
2611	<glossterm>--dryrun</glossterm>
2612
2613	<glossdef>
2614	<para>Tells VBoxManage to only perform a dry run instead of
2615	really copying files to the guest.</para>
2616	</glossdef>
2617	</glossentry>
2618
2619	<glossentry>
2620	<glossterm>--follow</glossterm>
2621
2622	<glossdef>
2623	<para>Enables following symlinks on the host's
2624	source.</para>
2625	</glossdef>
2626	</glossentry>
2627
2628	<glossentry>
2629	<glossterm>--recursive</glossterm>
2630
2631	<glossdef>
2632	<para>Recursively copies files/directories of the specified
2633	source.</para>
2634	</glossdef>
2635	</glossentry>
2636
2637	<glossentry>
2638	<glossterm>--verbose</glossterm>
2639
2640	<glossdef>
2641	<para>Tells VBoxManage to be more verbose.</para>
2642	</glossdef>
2643	</glossentry>
2644
2645	<glossentry>
2646	<glossterm>--flags <flags></glossterm>
2647
2648	<glossdef>
2649	<para>Additional flags to set. This is not used at the
2650	moment.</para>
2651	</glossdef>
2652	</glossentry>
2653	</glosslist></para>
2654	</listitem>
2655
2656	<listitem>
2657	<para><computeroutput>createdirectory</computeroutput>, which allows
2658	copying files from the host to the guest (only with installed Guest
2659	Additions 4.0 and later).</para>
2660
2661	<screen>VBoxManage guestcontrol <vmname>\|<uuid> createdir[ectory]\|mkdir\|md
2662	<directory to create on guest>
2663	[--username "<name>"] [--password "<password>"]
2664	[--parents] [--mode <mode>] [--verbose]</screen>
2665
2666	<para>where the parameters mean: <glosslist>
2667	<glossentry>
2668	<glossterm>uuid\|vmname</glossterm>
2669
2670	<glossdef>
2671	<para>The VM UUID or VM name. Mandatory.</para>
2672	</glossdef>
2673	</glossentry>
2674
2675	<glossentry>
2676	<glossterm>directory to create on guest</glossterm>
2677
2678	<glossdef>
2679	<para>Absolute path of directory/directories to create on
2680	guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>.
2681	Parent directories need to exist (e.g. in this example
2682	<computeroutput>D:\Foo</computeroutput>) when switch
2683	<computeroutput>--parents</computeroutput> is omitted. The
2684	specified user must have appropriate rights to create the
2685	specified directory.</para>
2686	</glossdef>
2687	</glossentry>
2688
2689	<glossentry>
2690	<glossterm>--username <name></glossterm>
2691
2692	<glossdef>
2693	<para>Name of the user the copy process should run under.
2694	This user must exist on the guest OS.</para>
2695	</glossdef>
2696	</glossentry>
2697
2698	<glossentry>
2699	<glossterm>--password <password></glossterm>
2700
2701	<glossdef>
2702	<para>Password of the user account specified with
2703	<computeroutput>--username</computeroutput>. If not given,
2704	an empty password is assumed.</para>
2705	</glossdef>
2706	</glossentry>
2707
2708	<glossentry>
2709	<glossterm>--parents</glossterm>
2710
2711	<glossdef>
2712	<para>Also creates not yet existing parent directories of
2713	the specified directory, e.g. if the directory
2714	<computeroutput>D:\Foo</computeroutput> of
2715	<computeroutput>D:\Foo\Bar</computeroutput> does not exist
2716	yet it will be created. Without specifying
2717	<computeroutput>--parent</computeroutput> the action would
2718	have failed.</para>
2719	</glossdef>
2720	</glossentry>
2721
2722	<glossentry>
2723	<glossterm>--mode <mode></glossterm>
2724
2725	<glossdef>
2726	<para>Sets the permission mode of the specified directory.
2727	Only octal modes (e.g.
2728	<computeroutput>0755</computeroutput>) are supported right
2729	now.</para>
2730	</glossdef>
2731	</glossentry>
2732
2733	<glossentry>
2734	<glossterm>--verbose</glossterm>
2735
2736	<glossdef>
2737	<para>Tells VBoxManage to be more verbose.</para>
2738	</glossdef>
2739	</glossentry>
2740	</glosslist></para>
2741	</listitem>
2742
2743	<listitem>
2744	<para><computeroutput>updateadditions</computeroutput>, which allows
2745	for updating an already installed Guest Additions version on the
2746	guest (only already installed Guest Additions 4.0 and later).</para>
2747
2748	<screen>VBoxManage guestcontrol updateadditions <vmname>\|<uuid>
2749	[--source "<guest additions .ISO file to use>"] [--verbose]</screen>
2750
2751	<para>where the parameters mean: <glosslist>
2752	<glossentry>
2753	<glossterm>uuid\|vmname</glossterm>
2754
2755	<glossdef>
2756	<para>The VM UUID or VM name. Mandatory.</para>
2757	</glossdef>
2758	</glossentry>
2759
2760	<glossentry>
2761	<glossterm>--source "<guest additions .ISO file to
2762	use>"</glossterm>
2763
2764	<glossdef>
2765	<para>Full path to an alternative VirtualBox Guest Additions
2766	.ISO file to use for the Guest Additions update.</para>
2767	</glossdef>
2768	</glossentry>
2769
2770	<glossentry>
2771	<glossterm>--verbose</glossterm>
2772
2773	<glossdef>
2774	<para>Tells VBoxManage to be more verbose.</para>
2775	</glossdef>
2776	</glossentry>
2777	</glosslist></para>
2778	</listitem>
2779	</itemizedlist></para>
2780	</sect1>
2781
2782	<sect1 id="vboxmanage-debugvm">
2783	<title>VBoxManage debugvm</title>
2784
2785	<para>The "debugvm" commands are for experts who want to tinker with the
2786	exact details of virtual machine execution. Like the VM debugger described
2787	in <xref linkend="debugger" />, these commands are only useful if you are
2788	very familiar with the details of the PC architecture and how to debug
2789	software.</para>
2790
2791	<para>The subcommands of "debugvm" all operate on a running virtual
2792	machine. The following are available:<itemizedlist>
2793	<listitem>
2794	<para>With <computeroutput>dumpguestcore --filename
2795	<name></computeroutput>, you can create a system dump of the
2796	running VM, which will be written into the given file. This file
2797	will have the standard ELF core format (with custom sections); see
2798	<xref linkend="guestcoreformat" />.</para>
2799
2800	<para>This corresponds to the
2801	<computeroutput>writecore</computeroutput> command in the debugger.
2802	</para>
2803	</listitem>
2804
2805	<listitem>
2806	<para>The <computeroutput>info</computeroutput> command is used to
2807	display info items relating to the VMM, device emulations and
2808	associated drivers. This command takes one or two arguments: the
2809	name of the info item, optionally followed by a string containing
2810	arguments specific to the info item.
2811	The <computeroutput>help</computeroutput> info item provides a
2812	listning of the available items and hints about any optional
2813	arguments.</para>
2814
2815	<para>This corresponds to the <computeroutput>info</computeroutput>
2816	command in the debugger.</para>
2817	</listitem>
2818
2819	<listitem>
2820	<para>The <computeroutput>injectnmi</computeroutput> command causes
2821	a non-maskable interrupt (NMI) in the guest, which might be useful
2822	for certain debugging scenarios. What happens exactly is dependent
2823	on the guest operating system, but an NMI can crash the whole guest
2824	operating system. Do not use unless you know what you're
2825	doing.</para>
2826	</listitem>
2827
2828	<listitem>
2829	<para>The <computeroutput>osdetect</computeroutput> command makes the
2830	VMM's debugger facility (re-)detection the guest operation
2831	system.</para>
2832
2833	<para>This corresponds to the <computeroutput>detect</computeroutput>
2834	command in the debugger.</para>
2835	</listitem>
2836
2837	<listitem>
2838	<para>The <computeroutput>osinfo</computeroutput> command is used to
2839	display info about the operating system (OS) detected by the VMM's
2840	debugger facility.</para>
2841	</listitem>
2842
2843	<listitem>
2844	<para>The <computeroutput>getregisters</computeroutput> command is
2845	used to display CPU and device registers. The command takes a list
2846	of registers, each having one of the following forms:
2847	<itemizedlist>
2848	<listitem><computeroutput>register-set.register-name.sub-field</computeroutput></listitem>
2849	<listitem><computeroutput>register-set.register-name</computeroutput></listitem>
2850	<listitem><computeroutput>cpu-register-name.sub-field</computeroutput></listitem>
2851	<listitem><computeroutput>cpu-register-name</computeroutput></listitem>
2852	<listitem><computeroutput>all</computeroutput></listitem>
2853	</itemizedlist>
2854	The <computeroutput>all</computeroutput> form will cause all
2855	registers to be shown (no sub-fields). The registers names are
2856	case-insensitive. When requesting a CPU register the register set
2857	can be omitted, it will be selected using the value of the
2858	<computeroutput>--cpu</computeroutput> option (defaulting to 0).
2859	</para>
2860	</listitem>
2861
2862	<listitem>
2863	<para>The <computeroutput>setregisters</computeroutput> command is
2864	used to change CPU and device registers. The command takes a list
2865	of register assignments, each having one of the following forms:
2866	<itemizedlist>
2867	<listitem><computeroutput>register-set.register-name.sub-field=value</computeroutput></listitem>
2868	<listitem><computeroutput>register-set.register-name=value</computeroutput></listitem>
2869	<listitem><computeroutput>cpu-register-name.sub-field=value</computeroutput></listitem>
2870	<listitem><computeroutput>cpu-register-name=value</computeroutput></listitem>
2871	</itemizedlist>
2872	The value format should be in the same style as what
2873	<computeroutput>getregisters</computeroutput> displays, with the
2874	exception that both octal and decimal can be used instead of
2875	hexadecimal. The register naming and the default CPU register set
2876	are handled the same way as with the
2877	<computeroutput>getregisters</computeroutput> command.</para>
2878	</listitem>
2879
2880	<listitem>
2881	<para>The <computeroutput>statistics</computeroutput> command can be
2882	used to display VMM statistics on the command line. The
2883	<computeroutput>--reset</computeroutput> option will reset
2884	statistics. The affected statistics can be filtered with the
2885	<computeroutput>--pattern</computeroutput> option, which accepts
2886	DOS/NT-style wildcards (<computeroutput>?</computeroutput> and
2887	<computeroutput>*</computeroutput>).</para>
2888	</listitem>
2889	</itemizedlist></para>
2890	</sect1>
2891
2892	<sect1>
2893	<title id="metrics">VBoxManage metrics</title>
2894
2895	<para>This command supports monitoring the usage of system resources.
2896	Resources are represented by various metrics associated with the host
2897	system or a particular VM. For example, the host system has a
2898	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
2899	percentage of time CPUs spend executing in user mode over a specific
2900	sampling period.</para>
2901
2902	<para>Metric data is collected and retained internally; it may be
2903	retrieved at any time with the <computeroutput>VBoxManage metrics
2904	query</computeroutput> subcommand. The data is available as long as the
2905	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
2906	process terminates shortly after all VMs and frontends have been
2907	closed.</para>
2908
2909	<para>By default no metrics are collected at all. Metrics collection does
2910	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
2911	is invoked with a proper sampling interval and the number of metrics to be
2912	retained. The interval is measured in seconds. For example, to enable
2913	collecting the host processor and memory usage metrics every second and
2914	keeping the 5 most current samples, the following command can be
2915	used:</para>
2916
2917	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
2918
2919	<para>Metric collection can only be enabled for started VMs. Collected
2920	data and collection settings for a particular VM will disappear as soon as
2921	it shuts down. Use <computeroutput>VBoxManage metrics list
2922	</computeroutput> subcommand to see which metrics are currently available.
2923	You can also use <computeroutput>--list</computeroutput> option with any
2924	subcommand that modifies metric settings to find out which metrics were
2925	affected.</para>
2926
2927	<para>Note that the <computeroutput>VBoxManage metrics
2928	setup</computeroutput> subcommand discards all samples that may have been
2929	previously collected for the specified set of objects and metrics.</para>
2930
2931	<para>To enable or disable metrics collection without discarding the data
2932	<computeroutput>VBoxManage metrics enable</computeroutput> and
2933	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
2934	can be used. Note that these subcommands expect metrics, not submetrics,
2935	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
2936	other words enabling <code>CPU/Load/User</code> while disabling
2937	<code>CPU/Load/Kernel</code> is not supported.</para>
2938
2939	<para>The host and VMs have different sets of associated metrics.
2940	Available metrics can be listed with <computeroutput>VBoxManage metrics
2941	list</computeroutput> subcommand.</para>
2942
2943	<para>A complete metric name may include an aggregate function. The name
2944	has the following form:
2945	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
2946	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
2947	for the minimum amount of available memory over all retained data if
2948	applied to the host object.</para>
2949
2950	<para>Subcommands may apply to all objects and metrics or can be limited
2951	to one object or/and a list of metrics. If no objects or metrics are given
2952	in the parameters, the subcommands will apply to all available metrics of
2953	all objects. You may use an asterisk
2954	("<computeroutput>*</computeroutput>") to explicitly specify that the
2955	command should be applied to all objects or metrics. Use "host" as the
2956	object name to limit the scope of the command to host-related metrics. To
2957	limit the scope to a subset of metrics, use a metric list with names
2958	separated by commas.</para>
2959
2960	<para>For example, to query metric data on the CPU time spent in user and
2961	kernel modes by the virtual machine named "test", you can use the
2962	following command:</para>
2963
2964	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
2965
2966	<para>The following list summarizes the available subcommands:</para>
2967
2968	<glosslist>
2969	<glossentry>
2970	<glossterm>list</glossterm>
2971
2972	<glossdef>
2973	<para>This subcommand shows the parameters of the currently existing
2974	metrics. Note that VM-specific metrics are only available when a
2975	particular VM is running.</para>
2976	</glossdef>
2977	</glossentry>
2978
2979	<glossentry>
2980	<glossterm>setup</glossterm>
2981
2982	<glossdef>
2983	<para>This subcommand sets the interval between taking two samples
2984	of metric data and the number of samples retained internally. The
2985	retained data is available for displaying with the
2986	<code>query</code> subcommand. The <computeroutput>--list
2987	</computeroutput> option shows which metrics have been modified as
2988	the result of the command execution.</para>
2989	</glossdef>
2990	</glossentry>
2991
2992	<glossentry>
2993	<glossterm>enable</glossterm>
2994
2995	<glossdef>
2996	<para>This subcommand "resumes" data collection after it has been
2997	stopped with <code>disable</code> subcommand. Note that specifying
2998	submetrics as parameters will not enable underlying metrics. Use
2999	<computeroutput>--list</computeroutput> to find out if the command
3000	did what was expected.</para>
3001	</glossdef>
3002	</glossentry>
3003
3004	<glossentry>
3005	<glossterm>disable</glossterm>
3006
3007	<glossdef>
3008	<para>This subcommand "suspends" data collection without affecting
3009	collection parameters or collected data. Note that specifying
3010	submetrics as parameters will not disable underlying metrics. Use
3011	<computeroutput>--list</computeroutput> to find out if the command
3012	did what was expected.</para>
3013	</glossdef>
3014	</glossentry>
3015
3016	<glossentry>
3017	<glossterm>query</glossterm>
3018
3019	<glossdef>
3020	<para>This subcommand retrieves and displays the currently retained
3021	metric data.<note>
3022	<para>The <code>query</code> subcommand does not remove or
3023	"flush" retained data. If you query often enough you will see
3024	how old samples are gradually being "phased out" by new
3025	samples.</para>
3026	</note></para>
3027	</glossdef>
3028	</glossentry>
3029
3030	<glossentry>
3031	<glossterm>collect</glossterm>
3032
3033	<glossdef>
3034	<para>This subcommand sets the interval between taking two samples
3035	of metric data and the number of samples retained internally. The
3036	collected data is displayed periodically until Ctrl-C is pressed
3037	unless the <computeroutput>--detach</computeroutput> option is
3038	specified. With the <computeroutput>--detach</computeroutput>
3039	option, this subcommand operates the same way as <code>setup</code>
3040	does. The <computeroutput>--list</computeroutput> option shows which
3041	metrics match the specified filter.</para>
3042	</glossdef>
3043	</glossentry>
3044	</glosslist>
3045	</sect1>
3046
3047	<sect1>
3048	<title>VBoxManage hostonlyif</title>
3049
3050	<para>With "hostonlyif" you can change the IP configuration of a host-only
3051	network interface. For a description of host-only networking, please
3052	refer to <xref linkend="network_hostonly" />. Each host-only interface is
3053	identified by a name and can either use the internal DHCP server or a
3054	manual IP configuration (both IP4 and IP6).</para>
3055	</sect1>
3056
3057	<sect1 id="vboxmanage-dhcpserver">
3058	<title>VBoxManage dhcpserver</title>
3059
3060	<para>The "dhcpserver" commands allow you to control the DHCP server that
3061	is built into VirtualBox. You may find this useful when using internal or
3062	host-only networking. (Theoretically, you can enable it for a bridged
3063	network as well, but that will likely cause conflicts with other DHCP
3064	servers in your physical network.)</para>
3065
3066	<para>Use the following command line options:<itemizedlist>
3067	<listitem>
3068	<para>If you use internal networking for a virtual network adapter
3069	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
3070	--netname <network_name></computeroutput>, where
3071	<computeroutput><network_name></computeroutput> is the same
3072	network name you used with <computeroutput>VBoxManage modifyvm
3073	<vmname> --intnet<X>
3074	<network_name></computeroutput>.</para>
3075	</listitem>
3076
3077	<listitem>
3078	<para>If you use host-only networking for a virtual network adapter
3079	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
3080	--ifname <hostonly_if_name></computeroutput> instead, where
3081	<computeroutput><hostonly_if_name></computeroutput> is the
3082	same host-only interface name you used with
3083	<computeroutput>VBoxManage modifyvm <vmname>
3084	--hostonlyadapter<X>
3085	<hostonly_if_name></computeroutput>.</para>
3086
3087	<para>Alternatively, you can also use the --netname option as with
3088	internal networks if you know the host-only network's name; you can
3089	see the names with <computeroutput>VBoxManage list
3090	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
3091	above).</para>
3092	</listitem>
3093	</itemizedlist></para>
3094
3095	<para>The following additional parameters are required when first adding a
3096	DHCP server:<itemizedlist>
3097	<listitem>
3098	<para>With <computeroutput>--ip</computeroutput>, specify the IP
3099	address of the DHCP server itself.</para>
3100	</listitem>
3101
3102	<listitem>
3103	<para>With <computeroutput>--netmask</computeroutput>, specify the
3104	netmask of the network.</para>
3105	</listitem>
3106
3107	<listitem>
3108	<para>With <computeroutput>--lowerip</computeroutput> and
3109	<computeroutput>--upperip</computeroutput>, you can specify the
3110	lowest and highest IP address, respectively, that the DHCP server
3111	will hand out to clients.</para>
3112	</listitem>
3113	</itemizedlist></para>
3114
3115	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
3116	or the DHCP server will be created in the disabled state, doing
3117	nothing.</para>
3118
3119	<para>After this, VirtualBox will automatically start the DHCP server for
3120	given internal or host-only network as soon as the first virtual machine
3121	which uses that network is started.</para>
3122
3123	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
3124	remove</computeroutput> with the given <computeroutput>--netname
3125	<network_name></computeroutput> or <computeroutput>--ifname
3126	<hostonly_if_name></computeroutput> to remove the DHCP server again
3127	for the given internal or host-only network.</para>
3128
3129	<para>To modify the settings of a DHCP server created earlier with
3130	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
3131	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
3132	network or host-only interface name.</para>
3133	</sect1>
3134
3135	<sect1 id="vboxmanage-extpack">
3136	<title>VBoxManage extpack</title>
3137
3138	<para>The "extpack" command allows you to add or remove VirtualBox
3139	extension packs, as described in <xref
3140	linkend="intro-installing" />.<itemizedlist>
3141	<listitem>
3142	<para>To add a new extension pack, use <computeroutput>VBoxManage
3143	extpack install <tarball></computeroutput>.</para>
3144	</listitem>
3145
3146	<listitem>
3147	<para>To remove a previously installed extension pack, use
3148	<computeroutput>VBoxManage extpack uninstall
3149	<name></computeroutput>. You can use
3150	<computeroutput>VBoxManage list extpacks</computeroutput> to show
3151	the names of the extension packs which are currently installed;
3152	please see <xref linkend="vboxmanage-list" /> also. The optional
3153	<computeroutput>--force</computeroutput> parameter can be used to
3154	override the refusal of an extension pack to be uninstalled.</para>
3155	</listitem>
3156
3157	<listitem>
3158	<para>The <computeroutput>VBoxManage extpack
3159	cleanup</computeroutput> command can be used to remove temporary
3160	files and directories that may have been left behind if a previous
3161	install or uninstall command failed.</para>
3162	</listitem>
3163	</itemizedlist></para>
3164	</sect1>
3165	</chapter>

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: