user_VBoxManage.xml@ 53545

最後變更在這個檔案從53545是 53545,由 vboxsync 提交於 10 年前
doc/manual: fixed 'VBoxManage guestproperty get' description
檔案大小: 191.6 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/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen>
87
88	<para>As can be seen from the above output, a new virtual machine has
89	been created with a new UUID and a new XML settings file.</para>
90	</listitem>
91
92	<listitem>
93	<para>To show the configuration of a particular VM, use
94	<computeroutput>VBoxManage showvminfo</computeroutput>; see <xref
95	linkend="vboxmanage-showvminfo" /> for details and an example.</para>
96	</listitem>
97
98	<listitem>
99	<para>To change settings while a VM is powered off, use
100	<computeroutput>VBoxManage modifyvm</computeroutput>, e.g. as
101	follows:<screen>VBoxManage modifyvm "Windows XP" --memory 512</screen></para>
102
103	<para>For details, see <xref linkend="vboxmanage-modifyvm" />.</para>
104	</listitem>
105
106	<listitem>
107	<para>To change the storage configuration (e.g. to add a storage
108	controller and then a virtual disk), use <computeroutput>VBoxManage
109	storagectl</computeroutput> and <computeroutput>VBoxManage
110	storageattach</computeroutput>; see <xref
111	linkend="vboxmanage-storagectl" /> and <xref
112	linkend="vboxmanage-storageattach" /> for details.</para>
113	</listitem>
114
115	<listitem>
116	<para>To control VM operation, use one of the following:<itemizedlist>
117	<listitem>
118	<para>To start a VM that is currently powered off, use
119	<computeroutput>VBoxManage startvm</computeroutput>; see <xref
120	linkend="vboxmanage-startvm" /> for details.</para>
121	</listitem>
122
123	<listitem>
124	<para>To pause or save a VM that is currently running or change
125	some of its settings, use <computeroutput>VBoxManage
126	controlvm</computeroutput>; see <xref
127	linkend="vboxmanage-controlvm" /> for details.</para>
128	</listitem>
129	</itemizedlist></para>
130	</listitem>
131	</itemizedlist>
132	</sect1>
133
134	<sect1>
135	<title>Commands overview</title>
136
137	<para>When running VBoxManage without parameters or when supplying an
138	invalid command line, the below syntax diagram will be shown. Note that
139	the output will be slightly different depending on the host platform; when
140	in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
141	for the commands available on your particular host.</para>
142
143	<screen>$VBOX_MANAGE_OUTPUT</screen>
144
145	<para>Each time VBoxManage is invoked, only one command can be executed.
146	However, a command might support several subcommands which then can be
147	invoked in one single call. The following sections provide detailed
148	reference information on the different commands.</para>
149	</sect1>
150
151	<sect1 id="vboxmanage-general">
152	<title>General options</title>
153	<para>
154	<itemizedlist>
155	<listitem>
156	<para><computeroutput>--version</computeroutput>: show the version of
157	this tool and exit.</para>
158	</listitem>
159	<listitem>
160	<para><computeroutput>--nologo</computeroutput>: suppress the output
161	of the logo information (useful for scripts)</para>
162	</listitem>
163	<listitem>
164	<para><computeroutput>--settingspw</computeroutput>: specifiy a settings
165	password</para>
166	</listitem>
167	<listitem>
168	<para><computeroutput>--settingspwfile</computeroutput>: specify a file
169	containing the settings password.</para>
170	</listitem>
171	</itemizedlist>
172	The settings password is used for certain settings which need to be
173	stored encrypted for security reasons. At the moment, the only encrypted
174	setting is the iSCSI initiator secret (see
175	<xref linkend="vboxmanage-storageattach" /> for details). As long as no
176	settings password is specified, this information is stored in
177	<emphasis role="bold">plain text</emphasis>. After using the
178	<computeroutput>--settingspw\|--settingspwfile</computeroutput> option
179	once, it must be always used, otherwise the encrypted setting cannot
180	be unencrypted.
181	</para>
182	</sect1>
183
184	<sect1 id="vboxmanage-list">
185	<title>VBoxManage list</title>
186
187	<para>The <computeroutput>list</computeroutput> command gives relevant
188	information about your system and information about VirtualBox's current
189	settings.</para>
190
191	<para>The following subcommands are available with
192	<computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
193	<listitem>
194	<para><computeroutput>vms</computeroutput> lists all virtual
195	machines currently registered with VirtualBox. By default this
196	displays a compact list with each VM's name and UUID; if you also
197	specify <computeroutput>--long</computeroutput> or
198	<computeroutput>-l</computeroutput>, this will be a detailed list as
199	with the <computeroutput>showvminfo</computeroutput> command (see
200	below).</para>
201	</listitem>
202
203	<listitem>
204	<para><computeroutput>runningvms</computeroutput> lists all
205	currently running virtual machines by their unique identifiers
206	(UUIDs) in the same format as with
207	<computeroutput>vms</computeroutput>.</para>
208	</listitem>
209
210	<listitem>
211	<para><computeroutput>ostypes</computeroutput> lists all guest
212	operating systems presently known to VirtualBox, along with the
213	identifiers used to refer to them with the
214	<computeroutput>modifyvm</computeroutput> command.</para>
215	</listitem>
216
217	<listitem>
218	<para><computeroutput>hostdvds</computeroutput>,
219	<computeroutput>hostfloppies</computeroutput>, respectively, list
220	DVD, floppy, bridged networking and host-only networking interfaces
221	on the host, along with the name used to access them from within
222	VirtualBox.</para>
223	</listitem>
224
225	<listitem>
226	<para><computeroutput>bridgedifs</computeroutput>,
227	<computeroutput>hostonlyifs</computeroutput> and
228	<computeroutput>dhcpservers</computeroutput>, respectively, list
229	bridged network interfaces, host-only network interfaces and DHCP
230	servers currently available on the host. Please see <xref
231	linkend="networkingdetails" /> for details on these.</para>
232	</listitem>
233
234	<listitem>
235	<para><computeroutput>hostinfo</computeroutput> displays information
236	about the host system, such as CPUs, memory size and operating
237	system version.</para>
238	</listitem>
239
240	<listitem>
241	<para><computeroutput>hostcpuids</computeroutput> dumps the CPUID
242	parameters for the host CPUs. This can be used for a more fine
243	grained analyis of the host's virtualization capabilities.</para>
244	</listitem>
245
246	<listitem>
247	<para><computeroutput>hddbackends</computeroutput> lists all known
248	virtual disk back-ends of VirtualBox. For each such format (such as
249	VDI, VMDK or RAW), this lists the back-end's capabilities and
250	configuration.</para>
251	</listitem>
252
253	<listitem>
254	<para><computeroutput>hdds</computeroutput>,
255	<computeroutput>dvds</computeroutput> and
256	<computeroutput>floppies</computeroutput> all give you information
257	about virtual disk images currently in use by VirtualBox, including
258	all their settings, the unique identifiers (UUIDs) associated with
259	them by VirtualBox and all files associated with them. This is the
260	command-line equivalent of the Virtual Media Manager; see <xref
261	linkend="vdis" />.</para>
262	</listitem>
263
264	<listitem>
265	<para><computeroutput>usbhost</computeroutput> supplies information
266	about USB devices attached to the host, notably information useful
267	for constructing USB filters and whether they are currently in use
268	by the host.</para>
269	</listitem>
270
271	<listitem>
272	<para><computeroutput>usbfilters</computeroutput> lists all global
273	USB filters registered with VirtualBox -- that is, filters for
274	devices which are accessible to all virtual machines -- and displays
275	the filter parameters.</para>
276	</listitem>
277
278	<listitem>
279	<para><computeroutput>systemproperties</computeroutput> displays
280	some global VirtualBox settings, such as minimum and maximum guest
281	RAM and virtual hard disk size, folder settings and the current
282	authentication library in use.</para>
283	</listitem>
284
285	<listitem>
286	<para><computeroutput>extpacks</computeroutput> displays all
287	VirtualBox extension packs currently installed; see <xref
288	linkend="intro-installing" /> and <xref
289	linkend="vboxmanage-extpack" /> for more information.</para>
290	</listitem>
291	</itemizedlist></para>
292	</sect1>
293
294	<sect1 id="vboxmanage-showvminfo">
295	<title>VBoxManage showvminfo</title>
296
297	<para>The <computeroutput>showvminfo</computeroutput> command shows
298	information about a particular virtual machine. This is the same
299	information as <computeroutput>VBoxManage list vms --long</computeroutput>
300	would show for all virtual machines.</para>
301
302	<para>You will get information similar to the following:</para>
303
304	<para><screen>$ VBoxManage showvminfo "Windows XP"
305	VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
306	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
307	All rights reserved.
308
309	Name: Windows XP
310	Guest OS: Other/Unknown
311	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
312	Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
313	Memory size: 512MB
314	VRAM size: 12MB
315	Number of CPUs: 2
316	Synthetic Cpu: off
317	Boot menu mode: message and menu
318	Boot Device (1): DVD
319	Boot Device (2): HardDisk
320	Boot Device (3): Not Assigned
321	Boot Device (4): Not Assigned
322	ACPI: on
323	IOAPIC: on
324	PAE: on
325	Time offset: 0 ms
326	Hardw. virt.ext: on
327	Nested Paging: on
328	VT-x VPID: off
329	State: powered off (since 2009-10-20T14:52:19.000000000)
330	Monitor count: 1
331	3D Acceleration: off
332	2D Video Acceleration: off
333	Teleporter Enabled: off
334	Teleporter Port: 0
335	Teleporter Address:
336	Teleporter Password:
337	Storage Controller (0): IDE Controller
338	Storage Controller Type (0): PIIX4
339	Storage Controller (1): Floppy Controller 1
340	Storage Controller Type (1): I82078
341	IDE Controller (0, 0): /home/user/windows.vdi (UUID: 46f6e53a-4557-460a-9b95-68b0f17d744b)
342	IDE Controller (0, 1): /home/user/openbsd-cd46.iso (UUID: 4335e162-59d3-4512-91d5-b63e94eebe0b)
343	Floppy Controller 1 (0, 0): /home/user/floppy.img (UUID: 62ac6ccb-df36-42f2-972e-22f836368137)
344	NIC 1: disabled
345	NIC 2: disabled
346	NIC 3: disabled
347	NIC 4: disabled
348	NIC 5: disabled
349	NIC 6: disabled
350	NIC 7: disabled
351	NIC 8: disabled
352	UART 1: disabled
353	UART 2: disabled
354	Audio: disabled (Driver: Unknown)
355	Clipboard Mode: Bidirectional
356	VRDE: disabled
357	USB: disabled
358
359	USB Device Filters:
360	<none>
361
362	Shared folders:
363	<none>
364
365	Statistics update: disabled</screen></para>
366	</sect1>
367
368	<sect1 id="vboxmanage-registervm">
369	<title>VBoxManage registervm / unregistervm</title>
370
371	<para>The <computeroutput>registervm</computeroutput> command allows you
372	to import a virtual machine definition in an XML file into VirtualBox. The
373	machine must not conflict with one already registered in VirtualBox and it
374	may not have any hard or removable disks attached. It is advisable to
375	place the definition file in the machines folder before registering
376	it.<note>
377	<para>When creating a new virtual machine with
378	<computeroutput>VBoxManage createvm</computeroutput> (see below), you
379	can directly specify the <computeroutput>--register</computeroutput>
380	option to avoid having to register it separately.</para>
381	</note></para>
382
383	<para>The <computeroutput>unregistervm</computeroutput> command
384	unregisters a virtual machine. If
385	<computeroutput>--delete</computeroutput> is also specified, the following
386	files will automatically be deleted as well:<orderedlist>
387	<listitem>
388	<para>all hard disk image files, including differencing files, which
389	are used by the machine and not shared with other machines;</para>
390	</listitem>
391
392	<listitem>
393	<para>saved state files that the machine created, if any (one if the
394	machine was in "saved" state and one for each online
395	snapshot);</para>
396	</listitem>
397
398	<listitem>
399	<para>the machine XML file and its backups;</para>
400	</listitem>
401
402	<listitem>
403	<para>the machine log files, if any;</para>
404	</listitem>
405
406	<listitem>
407	<para>the machine directory, if it is empty after having deleted all
408	the above.</para>
409	</listitem>
410	</orderedlist></para>
411	</sect1>
412
413	<sect1 id="vboxmanage-createvm">
414	<title>VBoxManage createvm</title>
415
416	<para>This command creates a new XML virtual machine definition
417	file.</para>
418
419	<para>The <computeroutput>--name <name></computeroutput> parameter
420	is required and must specify the name of the machine. Since this name is
421	used by default as the file name of the settings file (with the extension
422	<computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
423	of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder - this folder name may vary depending on the operating system and the version of VirtualBox which you are using), it
424	must conform to your host operating system's requirements for file name
425	specifications. If the VM is later renamed, the file and folder names will
426	change automatically.</para>
427
428	<para>However, if the <computeroutput>--basefolder
429	<path></computeroutput> option is used, the machine folder will be
430	named <computeroutput><path></computeroutput>. In this case, the
431	names of the file and the folder will not change if the virtual machine is
432	renamed.</para>
433
434	<para>By default, this command only creates the XML file without
435	automatically registering the VM with your VirtualBox installation. To
436	register the VM instantly, use the optional
437	<computeroutput>--register</computeroutput> option, or run
438	<computeroutput>VBoxManage registervm</computeroutput> separately
439	afterwards.</para>
440	</sect1>
441
442	<sect1 id="vboxmanage-modifyvm">
443	<title>VBoxManage modifyvm</title>
444
445	<para>This command changes the properties of a registered virtual machine
446	which is not running. Most of the properties that this command makes
447	available correspond to the VM settings that VirtualBox graphical user
448	interface displays in each VM's "Settings" dialog; these were described in
449	<xref linkend="BasicConcepts" />. Some of the more advanced settings,
450	however, are only available through the
451	<computeroutput>VBoxManage</computeroutput> interface.</para>
452
453	<para>These commands require that the machine is powered off (neither
454	running nor in "saved" state). Some machine settings can also be changed
455	while a machine is running; those settings will then have a corresponding
456	subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
457	subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
458
459	<sect2>
460	<title>General settings</title>
461
462	<para>The following general settings are available through
463	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
464	<listitem>
465	<para><computeroutput>--name <name></computeroutput>: This
466	changes the VM's name and possibly renames the internal virtual
467	machine files, as described with <computeroutput>VBoxManage
468	createvm</computeroutput> above.</para>
469	</listitem>
470
471	<listitem>
472	<para><computeroutput>--groups <group>, ...</computeroutput>:
473	This changes the group membership of a VM. Groups always start with
474	a <computeroutput>/</computeroutput> and can be nested. By default
475	VMs are in group <computeroutput>/</computeroutput>.</para>
476	</listitem>
477
478	<listitem>
479	<para><computeroutput>--description <desc></computeroutput>:
480	This changes the VM's description, which is a way to record details
481	about the VM in a way which is meaningful for the user. The GUI
482	interprets HTML formatting, the command line allows arbitrary
483	strings potentially containing multiple lines.</para>
484	</listitem>
485
486	<listitem>
487	<para><computeroutput>--ostype <ostype></computeroutput>:
488	This specifies what guest operating system is supposed to run in
489	the VM. To learn about the various identifiers that can be used
490	here, use <computeroutput>VBoxManage list
491	ostypes</computeroutput>.</para>
492	</listitem>
493
494	<listitem>
495	<para><computeroutput>--memory
496	<memorysize></computeroutput>: This sets the amount of RAM,
497	in MB, that the virtual machine should allocate for itself from
498	the host. See the remarks in <xref linkend="gui-createvm" /> for
499	more information.</para>
500	</listitem>
501
502	<listitem>
503	<para><computeroutput>--vram <vramsize></computeroutput>:
504	This sets the amount of RAM that the virtual graphics card should
505	have. See <xref linkend="settings-display" /> for details.</para>
506	</listitem>
507
508	<listitem>
509	<para><computeroutput>--acpi on\|off</computeroutput>;
510	<computeroutput>--ioapic on\|off</computeroutput>: These two
511	determine whether the VM should have ACPI and I/O APIC support,
512	respectively; see <xref linkend="settings-motherboard" /> for
513	details.</para>
514	</listitem>
515
516	<listitem>
517	<para><computeroutput>--hardwareuuid
518	<uuid></computeroutput>: The UUID presented to the guest via
519	memory tables (DMI/SMBIOS), hardware and guest properties. By
520	default this is the same as the VM uuid. Useful when cloning a VM.
521	Teleporting takes care of this automatically.</para>
522	</listitem>
523
524	<listitem>
525	<para><computeroutput>--cpus <cpucount></computeroutput>:
526	This sets the number of virtual CPUs for the virtual machine (see
527	<xref linkend="settings-processor" />). If CPU hot-plugging is
528	enabled (see below), this then sets the
529	<emphasis>maximum</emphasis> number of virtual CPUs that can be
530	plugged into the virtual machines.</para>
531	</listitem>
532
533	<listitem>
534	<para><computeroutput>--rtcuseutc on\|off</computeroutput>: This
535	option lets the real-time clock (RTC) operate in UTC time (see
536	<xref linkend="settings-motherboard" />).</para>
537	</listitem>
538
539	<listitem>
540	<para><computeroutput>--cpuhotplug on\|off</computeroutput>: This
541	enables CPU hot-plugging. When enabled, virtual CPUs can be added
542	to and removed from a virtual machine while it is running. See
543	<xref linkend="cpuhotplug" /> for more information.</para>
544	</listitem>
545
546	<listitem>
547	<para><computeroutput>--plugcpu\|unplugcpu
548	<id></computeroutput>: If CPU hot-plugging is enabled (see
549	above), this adds a virtual CPU to the virtual machines (or
550	removes one). <computeroutput><id></computeroutput>
551	specifies the index of the virtual CPU to be added or removed and
552	must be a number from 0 to the maximum no. of CPUs configured with
553	the <computeroutput>--cpus</computeroutput> option. CPU 0 can
554	never be removed.</para>
555	</listitem>
556
557	<listitem>
558	<para><computeroutput>--cpuexecutioncap
559	<1-100></computeroutput>: This setting controls how much cpu
560	time a virtual CPU can use. A value of 50 implies a single virtual
561	CPU can use up to 50% of a single host CPU.</para>
562	</listitem>
563
564	<listitem>
565	<para><computeroutput>--pae on\|off</computeroutput>: This
566	enables/disables PAE (see <xref
567	linkend="settings-processor" />).</para>
568	</listitem>
569
570	<listitem>
571	<para><computeroutput>--longmode on\|off</computeroutput>: This
572	enables/disables long mode (see <xref
573	linkend="settings-processor" />).</para>
574	</listitem>
575
576	<listitem>
577	<para><computeroutput>--synthcpu on\|off</computeroutput>: This
578	setting determines whether VirtualBox will expose a synthetic CPU
579	to the guest to allow live migration between host systems that
580	differ significantly.</para>
581	</listitem>
582
583	<listitem>
584	<para><computeroutput>--hpet on\|off</computeroutput>: This
585	enables/disables a High Precision Event Timer (HPET) which can
586	replace the legacy system timers. This is turned off by default.
587	Note that Windows supports a HPET only from Vista onwards.</para>
588	</listitem>
589
590	<listitem>
591	<para><computeroutput>--hwvirtex on\|off</computeroutput>: This
592	enables or disables the use of hardware virtualization extensions
593	(Intel VT-x or AMD-V) in the processor of your host system; see
594	<xref linkend="hwvirt" />.</para>
595	</listitem>
596
597	<listitem>
598	<para><computeroutput>--triplefaultreset on\|off</computeroutput>:
599	This setting allows to reset the guest instead of triggering a
600	Guru Meditation. Some guests raise a triple fault to reset the
601	CPU so sometimes this is desired behavior. Works only for non-SMP
602	guests.</para>
603	</listitem>
604
605	<listitem>
606	<para><computeroutput>--nestedpaging on\|off</computeroutput>: If
607	hardware virtualization is enabled, this additional setting
608	enables or disables the use of the nested paging feature in the
609	processor of your host system; see <xref
610	linkend="hwvirt" />.</para>
611	</listitem>
612
613	<listitem>
614	<para><computeroutput>--largepages on\|off</computeroutput>: If
615	hardware virtualization <emphasis>and</emphasis> nested paging are
616	enabled, for Intel VT-x only, an additional performance
617	improvement of up to 5% can be obtained by enabling this setting.
618	This causes the hypervisor to use large pages to reduce TLB use
619	and overhead.</para>
620	</listitem>
621
622	<listitem>
623	<para><computeroutput>--vtxvpid on\|off</computeroutput>: If
624	hardware virtualization is enabled, for Intel VT-x only, this
625	additional setting enables or disables the use of the tagged TLB
626	(VPID) feature in the processor of your host system; see <xref
627	linkend="hwvirt" />.</para>
628	</listitem>
629
630	<listitem>
631	<para><computeroutput>--vtxux on\|off</computeroutput>: If
632	hardware virtualization is enabled, for Intel VT-x only, this
633	setting enables or disables the use of the unrestricted guest mode
634	feature for executing your guest.</para>
635	</listitem>
636
637	<listitem>
638	<para><computeroutput>--accelerate3d on\|off</computeroutput>: This
639	enables, if the Guest Additions are installed, whether hardware 3D
640	acceleration should be available; see <xref
641	linkend="guestadd-3d" />.</para>
642	</listitem>
643
644	<listitem>
645	<para>You can influence the BIOS logo that is displayed when a
646	virtual machine starts up with a number of settings. Per default,
647	a VirtualBox logo is displayed.</para>
648
649	<para>With <computeroutput>--bioslogofadein
650	on\|off</computeroutput> and <computeroutput>--bioslogofadeout
651	on\|off</computeroutput>, you can determine whether the logo should
652	fade in and out, respectively.</para>
653
654	<para>With <computeroutput>--bioslogodisplaytime
655	<msec></computeroutput> you can set how long the logo should
656	be visible, in milliseconds.</para>
657
658	<para>With <computeroutput>--bioslogoimagepath
659	<imagepath></computeroutput> you can, if you are so
660	inclined, replace the image that is shown, with your own logo. The
661	image must be an uncompressed 256 color BMP file without color
662	space information (Windows 3.0 format). The image must not be
663	bigger than 640 x 480.</para>
664	</listitem>
665
666	<listitem>
667	<para><computeroutput>--biosbootmenu
668	disabled\|menuonly\|messageandmenu</computeroutput>: This specifies
669	whether the BIOS allows the user to select a temporary boot
670	device. <computeroutput>menuonly</computeroutput> suppresses the
671	message, but the user can still press F12 to select a temporary
672	boot device.</para>
673	</listitem>
674
675	<listitem>
676	<para><computeroutput>--nicbootprio<1-N>
677	<priority></computeroutput>: This specifies the order in which
678	NICs are tried for booting over the network (using PXE). The
679	priority is an integer in the 0 to 4 range. Priority 1 is the
680	highest, priority 4 is low. Priority 0, which is the default unless
681	otherwise specified, is the lowest.
682	</para>
683	<para> Note that this option only has effect when the Intel PXE boot
684	ROM is used.
685	</para>
686	</listitem>
687
688	<listitem>
689	<para><computeroutput>--boot<1-4>
690	none\|floppy\|dvd\|disk\|net</computeroutput>: This specifies the boot
691	order for the virtual machine. There are four "slots", which the
692	VM will try to access from 1 to 4, and for each of which you can
693	set a device that the VM should attempt to boot from.</para>
694	</listitem>
695
696	<listitem>
697	<para><computeroutput>--snapshotfolder
698	default\|<path></computeroutput>: This allows you to specify
699	the folder in which snapshots will be kept for a virtual
700	machine.</para>
701	</listitem>
702
703	<listitem>
704	<para><computeroutput>--firmware efi\|bios</computeroutput>:
705	Specifies which firmware is used to boot particular virtual
706	machine: EFI or BIOS. Use EFI only if your fully understand what
707	you're doing.</para>
708	</listitem>
709
710	<listitem>
711	<para><computeroutput>--guestmemoryballoon
712	<size></computeroutput> sets the default size of the guest
713	memory balloon, that is, memory allocated by the VirtualBox Guest
714	Additions from the guest operating system and returned to the
715	hypervisor for re-use by other virtual machines. <size> must
716	be specified in megabytes. The default size is 0 megabytes. For
717	details, see <xref linkend="guestadd-balloon" />.</para>
718	</listitem>
719
720	<listitem>
721	<para><computeroutput>--lptmode<1-N>
722	<Device></computeroutput>
723	Specifies the Device Name of the parallel port that
724	the Parallel Port feature will be using. Use this
725	<emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
726	This feature is host operating system specific.</para>
727	</listitem>
728
729	<listitem>
730	<para><computeroutput>--lpt<1-N>
731	<I/O base> <IRQ></computeroutput>
732	Specifies the I/O address of the parallel port and the IRQ
733	number that the Parallel Port feature will be using. Use this
734	<emphasis>after</emphasis>
735	<computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
736	the values that guest sees i.e. the values avalable under guest Device Manager.</para>
737	</listitem>
738
739	<listitem>
740	<para><computeroutput>--defaultfrontend
741	default\|<name></computeroutput>: This allows you to specify
742	the default frontend which will be used when starting this VM; see
743	<xref linkend="vboxmanage-startvm" /> for details.</para>
744	</listitem>
745	</itemizedlist></para>
746	</sect2>
747
748	<sect2>
749	<title>Networking settings</title>
750
751	<para>The following networking settings are available through
752	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
753	settings, the decimal number directly following the option name ("1-N"
754	in the list below) specifies the virtual network adapter whose settings
755	should be changed.<itemizedlist>
756	<listitem>
757	<para><computeroutput>--nic<1-N>
758	none\|null\|nat\|bridged\|intnet\|hostonly\|generic
759	</computeroutput>: With
760	this, you can set, for each of the VM's virtual network cards,
761	what type of networking should be available. They can be not
762	present (<computeroutput>none</computeroutput>), not connected to
763	the host (<computeroutput>null</computeroutput>), use network
764	address translation (<computeroutput>nat</computeroutput>),
765	bridged networking (<computeroutput>bridged</computeroutput>) or
766	communicate with other virtual machines using internal networking
767	(<computeroutput>intnet</computeroutput>), host-only networking
768	(<computeroutput>hostonly</computeroutput>), or access rarely used
769	sub-modes (<computeroutput>generic</computeroutput>).
770	These options correspond
771	to the modes which are described in detail in <xref
772	linkend="networkingmodes" />.</para>
773	</listitem>
774
775	<listitem>
776	<para><computeroutput>--nictype<1-N>
777	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
778	This allows you, for each of the VM's virtual network cards, to
779	specify which networking hardware VirtualBox presents to the
780	guest; see <xref linkend="nichardware" />.</para>
781	</listitem>
782
783	<listitem>
784	<para><computeroutput>--cableconnected<1-N>
785	on\|off</computeroutput>: This allows you to temporarily disconnect
786	a virtual network interface, as if a network cable had been pulled
787	from a real network card. This might be useful for resetting
788	certain software components in the VM.</para>
789	</listitem>
790
791	<listitem>
792	<para>With the "nictrace" options, you can optionally trace
793	network traffic by dumping it to a file, for debugging
794	purposes.</para>
795
796	<para>With <computeroutput>--nictrace<1-N>
797	on\|off</computeroutput>, you can enable network tracing for a
798	particular virtual network card.</para>
799
800	<para>If enabled, you must specify with
801	<computeroutput>--nictracefile<1-N>
802	<filename></computeroutput> what file the trace should be
803	logged to.</para>
804	</listitem>
805
806	<listitem>
807	<para><computeroutput>--bridgeadapter<1-N>
808	none\|<devicename></computeroutput>: If bridged networking
809	has been enabled for a virtual network card (see the
810	<computeroutput>--nic</computeroutput> option above; otherwise
811	this setting has no effect), use this option to specify which host
812	interface the given virtual network interface will use. For
813	details, please see <xref linkend="network_bridged" />.</para>
814	</listitem>
815
816	<listitem>
817	<para><computeroutput>--hostonlyadapter<1-N>
818	none\|<devicename></computeroutput>: If host-only networking
819	has been enabled for a virtual network card (see the --nic option
820	above; otherwise this setting has no effect), use this option to
821	specify which host-only networking interface the given virtual
822	network interface will use. For details, please see <xref
823	linkend="network_hostonly" />.</para>
824	</listitem>
825
826	<listitem>
827	<para><computeroutput>--intnet<1-N>
828	network</computeroutput>: If internal networking has been enabled
829	for a virtual network card (see the
830	<computeroutput>--nic</computeroutput> option above; otherwise
831	this setting has no effect), use this option to specify the name
832	of the internal network (see <xref
833	linkend="network_internal" />).</para>
834	</listitem>
835
836	<listitem>
837	<para><computeroutput>--macaddress<1-N>
838	auto\|<mac></computeroutput>: With this option you can set
839	the MAC address of the virtual network card. Normally, each
840	virtual network card is assigned a random address by VirtualBox at
841	VM creation.</para>
842	</listitem>
843
844	<listitem>
845	<para><computeroutput>--nicgenericdrv<1-N>
846	<backend driver></computeroutput>: If generic networking has been
847	enabled for a virtual network card (see the
848	<computeroutput>--nic</computeroutput> option above; otherwise
849	this setting has no effect), this mode allows you to access
850	rarely used networking sub-modes, such as VDE network or UDP Tunnel.
851	</para>
852	</listitem>
853
854	<listitem>
855	<para><computeroutput>--nicproperty<1-N>
856	<paramname>="paramvalue"</computeroutput>:
857	This option, in combination with "nicgenericdrv" allows you to
858	pass parameters to rarely-used network backends.</para><para>
859	Those parameters are backend engine-specific, and are different
860	between UDP Tunnel and the VDE backend drivers. For example,
861	please see <xref linkend="network_udp_tunnel" />.
862	</para>
863	</listitem>
864	</itemizedlist></para>
865
866	<sect3>
867	<title>NAT Networking settings.</title>
868
869	<para>The following NAT networking settings are available through
870	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
871	settings, the decimal number directly following the option name ("1-N"
872	in the list below) specifies the virtual network adapter whose
873	settings should be changed.<itemizedlist>
874	<listitem>
875	<para><computeroutput>--natpf<1-N>
876	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
877	<guestport></computeroutput>: This option defines a NAT
878	port-forwarding rule (please see <xref linkend="natforward" />
879	for details).</para>
880	</listitem>
881
882	<listitem>
883	<para><computeroutput>--natpf<1-N> delete
884	<name></computeroutput>: This option deletes a NAT
885	port-forwarding rule (please see <xref linkend="natforward" />
886	for details).</para>
887	</listitem>
888
889	<listitem>
890	<para><computeroutput>--nattftpprefix<1-N>
891	<prefix></computeroutput>: This option defines a prefix
892	for the built-in TFTP server, i.e. where the boot file is
893	located (please see <xref linkend="nat-tftp" /> and <xref
894	linkend="nat-adv-tftp" /> for details).</para>
895	</listitem>
896
897	<listitem>
898	<para><computeroutput>--nattftpfile<1-N>
899	<bootfile></computeroutput>: This option defines the TFT
900	boot file (please see <xref linkend="nat-adv-tftp" /> for
901	details).</para>
902	</listitem>
903
904	<listitem>
905	<para><computeroutput>--nattftpserver<1-N>
906	<tftpserver></computeroutput>: This option defines the
907	TFTP server address to boot from (please see <xref
908	linkend="nat-adv-tftp" /> for details).</para>
909	</listitem>
910
911	<listitem>
912	<para><computeroutput>--natdnspassdomain<1-N>
913	on\|off</computeroutput>: This option specifies whether the
914	built-in DHCP server passes the domain name for network name
915	resolution.</para>
916	</listitem>
917
918	<listitem>
919	<para><computeroutput>--natdnsproxy<1-N>
920	on\|off</computeroutput>: This option makes the NAT engine proxy
921	all guest DNS requests to the host's DNS servers (please see
922	<xref linkend="nat-adv-dns" /> for details).</para>
923	</listitem>
924
925	<listitem>
926	<para><computeroutput>--natdnshostresolver<1-N>
927	on\|off</computeroutput>: This option makes the NAT engine use
928	the host's resolver mechanisms to handle DNS requests (please
929	see <xref linkend="nat-adv-dns" /> for details).</para>
930	</listitem>
931
932	<listitem>
933	<para><computeroutput>--natsettings<1-N>
934	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
935	[<tcprcv>]</computeroutput>: This option controls several
936	NAT settings (please see <xref linkend="nat-adv-settings" /> for
937	details).</para>
938	</listitem>
939
940	<listitem>
941	<para><computeroutput>--nataliasmode<1-N>
942	default\|[log],[proxyonly],[sameports]</computeroutput>: This
943	option defines behaviour of NAT engine core: log - enables
944	logging, proxyonly - switches of aliasing mode makes NAT
945	transparent, sameports enforces NAT engine to send packets via
946	the same port as they originated on, default - disable all
947	mentioned modes above . (please see <xref
948	linkend="nat-adv-alias" /> for details).</para>
949	</listitem>
950	</itemizedlist></para>
951	</sect3>
952	</sect2>
953
954	<sect2 id="vboxmanage-modifyvm-other">
955	<title>Miscellaneous settings</title>
956
957	<para>The following other hardware settings, such as serial port, audio,
958	clipboard, drag'n drop, monitor and USB settings are available through
959	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
960	<listitem>
961	<para><computeroutput>--uart<1-N> off\|<I/O base>
962	<IRQ></computeroutput>: With this option you can configure
963	virtual serial ports for the VM; see <xref
964	linkend="serialports" /> for an introduction.</para>
965	</listitem>
966
967	<listitem>
968	<para><computeroutput>--uartmode<1-N>
969	<arg></computeroutput>: This setting controls how VirtualBox
970	connects a given virtual serial port (previously configured with
971	the <computeroutput>--uartX</computeroutput> setting, see above)
972	to the host on which the virtual machine is running. As described
973	in detail in <xref linkend="serialports" />, for each such port,
974	you can specify <computeroutput><arg></computeroutput> as
975	one of the following options:<itemizedlist>
976	<listitem>
977	<para><computeroutput>disconnected</computeroutput>: Even
978	though the serial port is shown to the guest, it has no
979	"other end" -- like a real COM port without a cable.</para>
980	</listitem>
981
982	<listitem>
983	<para><computeroutput>server
984	<pipename></computeroutput>: On a Windows host, this
985	tells VirtualBox to create a named pipe on the host named
986	<computeroutput><pipename></computeroutput> and
987	connect the virtual serial device to it. Note that Windows
988	requires that the name of a named pipe begin with
989	<computeroutput>\\.\pipe\</computeroutput>.</para>
990
991	<para>On a Linux host, instead of a named pipe, a local
992	domain socket is used.</para>
993	</listitem>
994
995	<listitem>
996	<para><computeroutput>client
997	<pipename></computeroutput>: This operates just like
998	<computeroutput>server ...</computeroutput>, except that the
999	pipe (or local domain socket) is not created by VirtualBox,
1000	but assumed to exist already.</para>
1001	</listitem>
1002
1003	<listitem>
1004	<para><computeroutput><devicename></computeroutput>:
1005	If, instead of the above, the device name of a physical
1006	hardware serial port of the host is specified, the virtual
1007	serial port is connected to that hardware port. On a Windows
1008	host, the device name will be a COM port such as
1009	<computeroutput>COM1</computeroutput>; on a Linux host, the
1010	device name will look like
1011	<computeroutput>/dev/ttyS0</computeroutput>. This allows you
1012	to "wire" a real serial port to a virtual machine.</para>
1013	</listitem>
1014	</itemizedlist></para>
1015	</listitem>
1016
1017	<listitem>
1018	<para><computeroutput>--audio none\|null\|oss</computeroutput>: With
1019	this option, you can set whether the VM should have audio
1020	support.</para>
1021	</listitem>
1022
1023	<listitem>
1024	<para><computeroutput>--clipboard
1025	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1026	With this setting, you can select if and how the guest or host
1027	operating system's clipboard should be shared with the host or guest;
1028	see <xref linkend="generalsettings" />. This requires that the Guest
1029	Additions be installed in the virtual machine.</para>
1030	</listitem>
1031
1032	<listitem>
1033	<para><computeroutput>--draganddrop
1034	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1035	With this setting, you can select the current drag'n drop mode
1036	being used between the host and the virtual machine;
1037	see <xref linkend="guestadd-dnd" />. This requires that the Guest
1038	Additions be installed in the virtual machine.</para>
1039	</listitem>
1040
1041	<listitem>
1042	<para><computeroutput>--monitorcount
1043	<count></computeroutput>: This enables multi-monitor
1044	support; see <xref linkend="settings-display" />.</para>
1045	</listitem>
1046
1047	<listitem>
1048	<para><computeroutput>--usb on\|off</computeroutput>: This option
1049	enables or disables the VM's virtual USB controller; see <xref
1050	linkend="settings-usb" /> for details.</para>
1051	</listitem>
1052
1053	<listitem>
1054	<para><computeroutput>--usbehci on\|off</computeroutput>: This
1055	option enables or disables the VM's virtual USB 2.0 controller;
1056	see <xref linkend="settings-usb" /> for details.</para>
1057	</listitem>
1058	</itemizedlist></para>
1059
1060	<!-- @todo r=andy Document tracing-* commands -->
1061	</sect2>
1062
1063	<sect2 id="vboxmanage-modifyvm-vrde">
1064	<title>Remote machine settings</title>
1065
1066	<para>The following settings that affect remote machine behavior are
1067	available through <computeroutput>VBoxManage
1068	modifyvm</computeroutput>:<itemizedlist>
1069	<listitem>
1070	<para><computeroutput>--vrde on\|off</computeroutput>: With the
1071	VirtualBox graphical user interface, this enables or disables the
1072	VirtualBox remote desktop extension (VRDE) server. Note that if
1073	you are using <computeroutput>VBoxHeadless</computeroutput> (see
1074	<xref linkend="vboxheadless" />), VRDE is enabled by
1075	default.</para>
1076	</listitem>
1077
1078	<!-- @todo r=andy Document vrdeproperty -->
1079
1080	<listitem>
1081	<para><computeroutput>--vrdeport
1082	default\|<ports></computeroutput>: A port or a range of ports
1083	the VRDE server can bind to; "default" or "0" means port 3389, the
1084	standard port for RDP. You can specify a comma-separated list of
1085	ports or ranges of ports. Use a dash between two port numbers to
1086	specify a range. The VRDE server will bind to <emphasis
1087	role="bold">one</emphasis> of available ports from the specified
1088	list. Only one machine can use a given port at a time. For
1089	example, the option <computeroutput> --vrdeport
1090	5000,5010-5012</computeroutput> will tell the server to bind to
1091	one of following ports: 5000, 5010, 5011 or 5012.</para>
1092	</listitem>
1093
1094	<listitem>
1095	<para><computeroutput>--vrdeaddress <IP
1096	address></computeroutput>: The IP address of the host network
1097	interface the VRDE server will bind to. If specified, the server
1098	will accept connections only on the specified host network
1099	interface.</para>
1100	<para>The setting can be used to specify whether the VRDP server
1101	should accept either IPv4 or IPv6 or both connections:
1102	<itemizedlist>
1103	<listitem>
1104	<para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"
1105	</computeroutput></para>
1106	</listitem>
1107	<listitem>
1108	<para>only IPv6: <computeroutput>--vrdeaddress "::"
1109	</computeroutput></para>
1110	</listitem>
1111	<listitem>
1112	<para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress ""
1113	</computeroutput></para>
1114	</listitem>
1115	</itemizedlist></para>
1116	</listitem>
1117
1118	<listitem>
1119	<para><computeroutput>--vrdeauthtype
1120	null\|external\|guest</computeroutput>: This allows you to choose
1121	whether and how authorization will be performed; see <xref
1122	linkend="vbox-auth" /> for details.</para>
1123	</listitem>
1124
1125	<listitem>
1126	<para><computeroutput>--vrdemulticon on\|off</computeroutput>: This
1127	enables multiple connections to the same VRDE server, if the
1128	server supports this feature; see <xref lang=""
1129	linkend="vrde-multiconnection" />.</para>
1130	</listitem>
1131
1132	<listitem>
1133	<para><computeroutput>--vrdereusecon on\|off</computeroutput>: This
1134	specifies the VRDE server behavior when multiple connections are
1135	disabled. When this option is enabled, the server will allow a new
1136	client to connect and will drop the existing connection. When this
1137	option is disabled (this is the default setting), a new connection
1138	will not be accepted if there is already a client connected to the
1139	server.</para>
1140	</listitem>
1141
1142	<listitem>
1143	<para><computeroutput>--vrdevideochannel on\|off</computeroutput>:
1144	This enables video redirection, if it is supported by the VRDE
1145	server; see <xref lang="" linkend="vrde-videochannel" />.</para>
1146	</listitem>
1147
1148	<listitem>
1149	<para><computeroutput>--vrdevideochannelquality
1150	<percent></computeroutput>: Sets the image quality for video
1151	redirection; see <xref lang=""
1152	linkend="vrde-videochannel" />.</para>
1153	</listitem>
1154	</itemizedlist></para>
1155	</sect2>
1156
1157	<sect2 id="vboxmanage-modifyvm-teleport">
1158	<title>Teleporting settings</title>
1159
1160	<para>With the following commands for <computeroutput>VBoxManage
1161	modifyvm</computeroutput> you can configure a machine to be a target for
1162	teleporting. See <xref linkend="teleporting" /> for an
1163	introduction.<itemizedlist>
1164	<listitem>
1165	<para><computeroutput>--teleporter on\|off</computeroutput>: With
1166	this setting you turn on or off whether a machine waits for a
1167	teleporting request to come in on the network when it is started.
1168	If "on", when the machine is started, it does not boot the virtual
1169	machine as it would normally; instead, it then waits for a
1170	teleporting request to come in on the port and address listed with
1171	the next two parameters.</para>
1172	</listitem>
1173
1174	<listitem>
1175	<para><computeroutput>--teleporterport
1176	<port></computeroutput>, <computeroutput>--teleporteraddress
1177	<address></computeroutput>: these must be used with
1178	--teleporter and tell the virtual machine on which port and
1179	address it should listen for a teleporting request from another
1180	virtual machine. <computeroutput><port></computeroutput> can
1181	be any free TCP/IP port number (e.g. 6000);
1182	<computeroutput><address></computeroutput> can be any IP
1183	address or hostname and specifies the TCP/IP socket to bind to.
1184	The default is "0.0.0.0", which means any address.</para>
1185	</listitem>
1186
1187	<listitem>
1188	<para><computeroutput>--teleporterpassword
1189	<password></computeroutput>: if this optional argument is
1190	given, then the teleporting request will only succeed if the
1191	source machine specifies the same password as the one given with
1192	this command.</para>
1193	</listitem>
1194
1195	<listitem>
1196	<para><computeroutput>--teleporterpasswordfile
1197	<password></computeroutput>: if this optional argument is
1198	given, then the teleporting request will only succeed if the
1199	source machine specifies the same password as the one specified
1200	in the file give with this command. Use <computeroutput>stdin</computeroutput>
1201	to read the password from stdin.</para>
1202	</listitem>
1203
1204	<listitem>
1205	<para><computeroutput>--cpuid <leaf> <eax> <ebx>
1206	<ecx> <edx></computeroutput>: Advanced users can use
1207	this command before a teleporting operation to restrict the
1208	virtual CPU capabilities that VirtualBox presents to the guest
1209	operating system. This must be run on both the source and the
1210	target machines involved in the teleporting and will then modify
1211	what the guest sees when it executes the
1212	<computeroutput>CPUID</computeroutput> machine instruction. This
1213	might help with misbehaving applications that wrongly assume that
1214	certain CPU capabilities are present. The meaning of the
1215	parameters is hardware dependent; please refer to the AMD or Intel
1216	processor manuals.</para>
1217	</listitem>
1218	</itemizedlist></para>
1219	</sect2>
1220	</sect1>
1221
1222	<sect1 id="vboxmanage-clonevm">
1223	<title>VBoxManage clonevm</title>
1224
1225	<para>This command creates a full or linked copy of an existing virtual
1226	machine.</para>
1227
1228	<para>The <computeroutput>clonevm</computeroutput> subcommand takes at
1229	least the name of the virtual machine which should be cloned. The following
1230	additional settings can be used to further configure the clone VM
1231	operation:</para>
1232
1233	<itemizedlist>
1234	<listitem>
1235	<para><computeroutput>--snapshot <uuid>\|<name></computeroutput>:
1236	Select a specific snapshot where the clone operation should refer
1237	to. Default is referring to the current state.</para>
1238	</listitem>
1239	<listitem>
1240	<para><computeroutput>--mode machine\|machineandchildren\|all</computeroutput>:
1241	Selects the cloning mode of the operation. If
1242	<computeroutput>machine</computeroutput> is selected (the default),
1243	the current state of the VM without any snapshots is cloned. In the
1244	<computeroutput>machineandchildren</computeroutput> mode the snapshot
1245	provided by <computeroutput>--snapshot</computeroutput> and all
1246	child snapshots are cloned. If <computeroutput>all</computeroutput>
1247	is the selected mode all snapshots and the current state are cloned.
1248	</para>
1249	</listitem>
1250	<listitem>
1251	<para><computeroutput>--options link\|keepallmacs\|keepnatmacs\|keepdisknames</computeroutput>:
1252	Allows additional fine tuning of the clone operation. The first
1253	option defines that a linked clone should be created, which is
1254	only possible for a machine clone from a snapshot. The next two
1255	options allow to define how the MAC addresses of every virtual
1256	network card should be handled. They can either be reinitialized
1257	(the default), left unchanged
1258	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
1259	when the network type is NAT
1260	(<computeroutput>keepnatmacs</computeroutput>). If you add
1261	<computeroutput>keepdisknames</computeroutput> all new disk images
1262	are called like the original ones, otherwise they are
1263	renamed.</para>
1264	</listitem>
1265	<listitem>
1266	<para><computeroutput>--name <name></computeroutput>: Select a
1267	new name for the new virtual machine. Default is "Original Name
1268	Clone".</para>
1269	</listitem>
1270	<listitem>
1271	<para><computeroutput>--basefolder <basefolder></computeroutput>:
1272	Select the folder where the new virtual machine configuration should
1273	be saved in.</para>
1274	</listitem>
1275	<listitem>
1276	<para><computeroutput>--uuid <uuid></computeroutput>:
1277	Select the UUID the new VM should have. This id has to be unique in
1278	the VirtualBox instance this clone should be registered. Default is
1279	creating a new UUID.</para>
1280	</listitem>
1281	<listitem>
1282	<para><computeroutput>--register</computeroutput>:
1283	Automatically register the new clone in this VirtualBox
1284	installation. If you manually want to register the new VM later, see
1285	<xref linkend="vboxmanage-registervm" /> for instructions how to do
1286	so.</para>
1287	</listitem>
1288	</itemizedlist>
1289	</sect1>
1290
1291	<sect1 id="vboxmanage-import">
1292	<title>VBoxManage import</title>
1293
1294	<para>This command imports a virtual appliance in OVF format by copying
1295	the virtual disk images and creating virtual machines in VirtualBox. See
1296	<xref linkend="ovf" /> for an introduction to appliances.</para>
1297
1298	<para>The <computeroutput>import</computeroutput> subcommand takes at
1299	least the path name of an OVF file as input and expects the disk images,
1300	if needed, in the same directory as the OVF file. A lot of additional
1301	command-line options are supported to control in detail what is being
1302	imported and modify the import parameters, but the details depend on the
1303	content of the OVF file.</para>
1304
1305	<para>It is therefore recommended to first run the import subcommand with
1306	the <computeroutput>--dry-run</computeroutput> or
1307	<computeroutput>-n</computeroutput> option. This will then print a
1308	description of the appliance's contents to the screen how it would be
1309	imported into VirtualBox, together with the optional command-line options
1310	to influence the import behavior.</para>
1311
1312	<para>As an example, here is the screen output with a sample appliance
1313	containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
1314	Interpreting WindowsXp.ovf...
1315	OK.
1316	Virtual system 0:
1317	0: Suggested OS type: "WindowsXP"
1318	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1319	1: Suggested VM name "Windows XP Professional_1"
1320	(change with "--vsys 0 --vmname <name>")
1321	3: Number of CPUs: 1
1322	(change with "--vsys 0 --cpus <n>")
1323	4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
1324	5: Sound card (appliance expects "ensoniq1371", can change on import)
1325	(disable with "--vsys 0 --unit 5 --ignore")
1326	6: USB controller
1327	(disable with "--vsys 0 --unit 6 --ignore")
1328	7: Network adapter: orig bridged, config 2, extra type=bridged
1329	8: Floppy
1330	(disable with "--vsys 0 --unit 8 --ignore")
1331	9: SCSI controller, type BusLogic
1332	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
1333	disable with "--vsys 0 --unit 9 --ignore")
1334	10: IDE controller, type PIIX4
1335	(disable with "--vsys 0 --unit 10 --ignore")
1336	11: Hard disk image: source image=WindowsXp.vmdk,
1337	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
1338	(change controller with "--vsys 0 --unit 11 --controller <id>";
1339	disable with "--vsys 0 --unit 11 --ignore")</screen></para>
1340
1341	<para>As you can see, the individual configuration items are numbered, and
1342	depending on their type support different command-line options. The import
1343	subcommand can be directed to ignore many such items with a
1344	<computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
1345	X is the number of the virtual system (zero unless there are several
1346	virtual system descriptions in the appliance) and Y the item number, as
1347	printed on the screen.</para>
1348
1349	<para>In the above example, Item #1 specifies the name of the target
1350	machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
1351	respectively. Item #11 describes a hard disk image; in this case, the
1352	additional <computeroutput>--controller</computeroutput> option indicates
1353	which item the disk image should be connected to, with the default coming
1354	from the OVF file.</para>
1355
1356	<para>You can combine several items for the same virtual system behind the
1357	same <computeroutput>--vsys</computeroutput> option. For example, to
1358	import a machine as described in the OVF, but without the sound card and
1359	without the USB controller, and with the disk image connected to the IDE
1360	controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
1361	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
1362	</sect1>
1363
1364	<sect1 id="vboxmanage-export">
1365	<title>VBoxManage export</title>
1366
1367	<para>This command exports one or more virtual machines from VirtualBox
1368	into a virtual appliance in OVF format, including copying their virtual
1369	disk images to compressed VMDK. See <xref linkend="ovf" /> for an
1370	introduction to appliances.</para>
1371
1372	<para>The <computeroutput>export</computeroutput> command is simple to
1373	use: list the machine (or the machines) that you would like to export to
1374	the same OVF file and specify the target OVF file after an additional
1375	<computeroutput>--output</computeroutput> or
1376	<computeroutput>-o</computeroutput> option. Note that the directory of the
1377	target OVF file will also receive the exported disk images in the
1378	compressed VMDK format (regardless of the original format) and should have
1379	enough disk space left for them.</para>
1380
1381	<para>Beside a simple export of a given virtual machine, you can append
1382	several product information to the appliance file. Use
1383	<computeroutput>--product</computeroutput>,
1384	<computeroutput>--producturl</computeroutput>,
1385	<computeroutput>--vendor</computeroutput>,
1386	<computeroutput>--vendorurl</computeroutput> and
1387	<computeroutput>--version</computeroutput> to specify this additional
1388	information. For legal reasons you may add a license text or the content
1389	of a license file by using the <computeroutput>--eula</computeroutput> and
1390	<computeroutput>--eulafile</computeroutput> option respectively. As with
1391	OVF import, you must use the <computeroutput>--vsys X</computeroutput>
1392	option to direct the previously mentioned options to the correct virtual
1393	machine.</para>
1394
1395	<para>For virtualization products which aren't fully compatible with the
1396	OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
1397	<computeroutput>--legacy09</computeroutput> option.</para>
1398
1399	<para>To specify options controlling the exact content of the appliance
1400	file, you can use <computeroutput>--option</computeroutput> to request the
1401	creation of a manifest file (encouraged, allows detection of corrupted
1402	appliances on import), the additional export of DVD images, and the
1403	exclusion of MAC addresses. You can specify a list of options, e.g.
1404	<computeroutput>--option manifest,nomacs</computeroutput>. For details,
1405	check the help output of <computeroutput>VBoxManage export</computeroutput>.</para>
1406	</sect1>
1407
1408	<sect1 id="vboxmanage-startvm">
1409	<title>VBoxManage startvm</title>
1410
1411	<para>This command starts a virtual machine that is currently in the
1412	"Powered off" or "Saved" states.</para>
1413
1414	<para>The optional <computeroutput>--type</computeroutput> specifier
1415	determines whether the machine will be started in a window or whether the
1416	output should go through <computeroutput>VBoxHeadless</computeroutput>,
1417	with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more
1418	information. The list of types is subject to change, and it's not
1419	guaranteed that all types are accepted by any product variant.</para>
1420
1421	<para>The global or per-VM default value for the VM frontend type will be
1422	taken if the type is not explicitly specified. If none of these are set,
1423	the GUI variant will be started.</para>
1424
1425	<para>The following values are allowed:</para>
1426
1427	<glosslist>
1428	<glossentry>
1429	<glossterm><computeroutput>gui</computeroutput></glossterm>
1430
1431	<glossdef>
1432	<para>Starts a VM showing a GUI window. This is the default.</para>
1433	</glossdef>
1434	</glossentry>
1435
1436	<glossentry>
1437	<glossterm><computeroutput>headless</computeroutput></glossterm>
1438
1439	<glossdef>
1440	<para>Starts a VM without a window for remote display only.</para>
1441	</glossdef>
1442	</glossentry>
1443
1444	<glossentry>
1445	<glossterm><computeroutput>sdl</computeroutput></glossterm>
1446
1447	<glossdef>
1448	<para>Starts a VM with a minimal GUI and limited features.</para>
1449	</glossdef>
1450	</glossentry>
1451	</glosslist>
1452
1453	<note>
1454	<para>If you experience problems with starting virtual machines with
1455	particular frontends and there is no conclusive error information,
1456	consider starting virtual machines directly by running the respective
1457	front-end, as this can give additional error information.</para>
1458	</note>
1459	</sect1>
1460
1461	<sect1 id="vboxmanage-controlvm">
1462	<title>VBoxManage controlvm</title>
1463
1464	<para>The <computeroutput>controlvm</computeroutput> subcommand allows you
1465	to change the state of a virtual machine that is currently running. The
1466	following can be specified:</para>
1467
1468	<para><itemizedlist>
1469	<listitem>
1470	<para><computeroutput>VBoxManage controlvm <vm>
1471	pause</computeroutput> temporarily puts a virtual machine on hold,
1472	without changing its state for good. The VM window will be painted
1473	in gray to indicate that the VM is currently paused. (This is
1474	equivalent to selecting the "Pause" item in the "Machine" menu of
1475	the GUI.)</para>
1476	</listitem>
1477
1478	<listitem>
1479	<para>Use <computeroutput>VBoxManage controlvm <vm>
1480	resume</computeroutput> to undo a previous
1481	<computeroutput>pause</computeroutput> command. (This is equivalent
1482	to selecting the "Resume" item in the "Machine" menu of the
1483	GUI.)</para>
1484	</listitem>
1485
1486	<listitem>
1487	<para><computeroutput>VBoxManage controlvm <vm>
1488	reset</computeroutput> has the same effect on a virtual machine as
1489	pressing the "Reset" button on a real computer: a cold reboot of the
1490	virtual machine, which will restart and boot the guest operating
1491	system again immediately. The state of the VM is not saved
1492	beforehand, and data may be lost. (This is equivalent to selecting
1493	the "Reset" item in the "Machine" menu of the GUI.)</para>
1494	</listitem>
1495
1496	<listitem>
1497	<para><computeroutput>VBoxManage controlvm <vm>
1498	poweroff</computeroutput> has the same effect on a virtual machine
1499	as pulling the power cable on a real computer. Again, the state of
1500	the VM is not saved beforehand, and data may be lost. (This is
1501	equivalent to selecting the "Close" item in the "Machine" menu of
1502	the GUI or pressing the window's close button, and then selecting
1503	"Power off the machine" in the dialog.)</para>
1504
1505	<para>After this, the VM's state will be "Powered off". From there,
1506	it can be started again; see <xref
1507	linkend="vboxmanage-startvm" />.</para>
1508	</listitem>
1509
1510	<listitem>
1511	<para><computeroutput>VBoxManage controlvm <vm>
1512	savestate</computeroutput> will save the current state of the VM to
1513	disk and then stop the VM. (This is equivalent to selecting the
1514	"Close" item in the "Machine" menu of the GUI or pressing the
1515	window's close button, and then selecting "Save the machine state"
1516	in the dialog.)</para>
1517
1518	<para>After this, the VM's state will be "Saved". From there, it can
1519	be started again; see <xref linkend="vboxmanage-startvm" />.</para>
1520	</listitem>
1521
1522	<listitem>
1523	<para><computeroutput>VBoxManage controlvm "VM name" teleport
1524	--hostname <name> --port <port> [--passwordfile
1525	<file> \| --password <password>]</computeroutput> makes
1526	the machine the source of a teleporting operation and initiates a
1527	teleport to the given target. See <xref linkend="teleporting" /> for
1528	an introduction. If the optional password is specified, it must match
1529	the password that was given to the
1530	<computeroutput>modifyvm</computeroutput> command for the target
1531	machine; see <xref linkend="vboxmanage-modifyvm-teleport" /> for
1532	details.</para>
1533	</listitem>
1534	</itemizedlist></para>
1535
1536	<para>A few extra options are available with
1537	<computeroutput>controlvm</computeroutput> that do not directly affect the
1538	VM's running state:</para>
1539
1540	<itemizedlist>
1541	<!-- @todo r=andy Document keyboardputscancode -->
1542
1543	<listitem>
1544	<para>The <computeroutput>setlinkstate<1-N></computeroutput>
1545	operation connects or disconnects virtual network cables from their
1546	network interfaces.</para>
1547	</listitem>
1548
1549	<listitem>
1550	<para><computeroutput>nic<1-N>
1551	null\|nat\|bridged\|intnet\|hostonly\|generic</computeroutput>: With this, you can
1552	set, for each of the VM's virtual network cards, what type of
1553	networking should be available. They can be not connected to the host
1554	(<computeroutput>null</computeroutput>), use network address
1555	translation (<computeroutput>nat</computeroutput>), bridged networking
1556	(<computeroutput>bridged</computeroutput>) or communicate with other
1557	virtual machines using internal networking
1558	(<computeroutput>intnet</computeroutput>) or host-only networking
1559	(<computeroutput>hostonly</computeroutput>) or access to rarely used
1560	sub-modes
1561	(<computeroutput>generic</computeroutput>). These options correspond
1562	to the modes which are described in detail in <xref
1563	linkend="networkingmodes" />.</para>
1564	</listitem>
1565
1566	<listitem>
1567	<para>With the "nictrace" options, you can optionally trace
1568	network traffic by dumping it to a file, for debugging
1569	purposes.</para>
1570
1571	<para>With <computeroutput>--nictrace<1-N>
1572	on\|off</computeroutput>, you can enable network tracing for a
1573	particular virtual network card.</para>
1574
1575	<para>If enabled, you must specify with
1576	<computeroutput>--nictracefile<1-N>
1577	<filename></computeroutput> what file the trace should be
1578	logged to.</para>
1579	</listitem>
1580
1581	<!-- @todo r=andy Document nicpromisc -->
1582
1583	<listitem>
1584	<para><computeroutput>nicproperty<1-N>
1585	<paramname>="paramvalue"</computeroutput>:
1586	This option, in combination with "nicgenericdrv" allows you to
1587	pass parameters to rarely-used network backends.</para><para>
1588	Those parameters are backend engine-specific, and are different
1589	between UDP Tunnel and the VDE backend drivers. For example,
1590	please see <xref linkend="network_udp_tunnel" />.
1591	</para>
1592	</listitem>
1593
1594	<listitem>
1595	<para>The <computeroutput>guestmemoryballoon</computeroutput>
1596	operation changes the size of the guest memory balloon, that is,
1597	memory allocated by the VirtualBox Guest Additions from the guest
1598	operating system and returned to the hypervisor for re-use by other
1599	virtual machines. This must be specified in megabytes. For details,
1600	see <xref linkend="guestadd-balloon" />.</para>
1601	</listitem>
1602
1603	<listitem>
1604	<para><computeroutput>usbattach</computeroutput> and
1605	<computeroutput>usbdettach</computeroutput> make host USB devices
1606	visible to the virtual machine on the fly, without the need for
1607	creating filters first. The USB devices can be specified by UUID
1608	(unique identifier) or by address on the host system.</para>
1609
1610	<para>You can use <computeroutput>VBoxManage list
1611	usbhost</computeroutput> to locate this information.</para>
1612	</listitem>
1613
1614	<listitem>
1615	<para><computeroutput>clipboard
1616	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1617	With this setting, you can select if and how the guest or host
1618	operating system's clipboard should be shared with the host or guest;
1619	see <xref linkend="generalsettings" />. This requires that the Guest
1620	Additions be installed in the virtual machine.</para>
1621	</listitem>
1622
1623	<listitem>
1624	<para><computeroutput>draganddrop
1625	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1626	With this setting, you can select the current drag'n drop mode
1627	being used between the host and the virtual machine;
1628	see <xref linkend="guestadd-dnd" />. This requires that the Guest
1629	Additions be installed in the virtual machine.</para>
1630	</listitem>
1631
1632	<listitem>
1633	<para><computeroutput>vrde on\|off</computeroutput> lets you enable or
1634	disable the VRDE server, if it is installed.</para>
1635	</listitem>
1636
1637	<listitem>
1638	<para><computeroutput>vrdeport default\|<ports></computeroutput>
1639	changes the port or a range of ports that the VRDE server can bind to;
1640	"default" or "0" means port 3389, the standard port for RDP. For
1641	details, see the description for the
1642	<computeroutput>--vrdeport</computeroutput> option in <xref
1643	linkend="vboxmanage-modifyvm-other" />.</para>
1644	</listitem>
1645
1646
1647	<listitem>
1648	<para><computeroutput>setvideomodehint</computeroutput> requests that
1649	the guest system change to a particular video mode. This requires that
1650	the Guest Additions be installed, and will not work for all guest
1651	systems.</para>
1652	</listitem>
1653
1654	<listitem>
1655	<para><computeroutput>screenshotpng</computeroutput> takes a screenshot
1656	of the guest display and saves it in PNG format.</para>
1657	</listitem>
1658
1659	<listitem>
1660	<para><computeroutput>vcpenabled on\|off</computeroutput> if enabled
1661	VirtualBox uses video recording to
1662	record VM session into webm/vp8 file.</para>
1663	</listitem>
1664
1665	<listitem>
1666	<para><computeroutput>vcpscreens</computeroutput> determines for which
1667	screens video recording is enabled.</para>
1668	</listitem>
1669
1670	<listitem>
1671	<para><computeroutput>vcpfile</computeroutput> determines the filename
1672	VirtualBox uses to save the recorded content. This setting cannot be changed
1673	while video capturing is enabled.</para>
1674	</listitem>
1675
1676	<listitem>
1677	<para><computeroutput>vcpwidth</computeroutput> determines the horizontal
1678	resolution of the recorded video. This setting cannot be changed while
1679	video capturing is enabled.</para>
1680	</listitem>
1681
1682	<listitem>
1683	<para><computeroutput>vcpheight</computeroutput> determines the vertical
1684	resolution of the recorded video. This setting cannot be changed while
1685	video capturing is enabled.</para>
1686	</listitem>
1687
1688	<listitem>
1689	<para><computeroutput>vcprate</computeroutput> determines the bitrate
1690	in kilobits per second. Increasing this value makes the video look better
1691	for the cost of an increased file size. This setting cannot be changed
1692	while video capturing is enabled.</para>
1693	</listitem>
1694
1695	<listitem>
1696	<para><computeroutput>vcpfps</computeroutput> determines the maximum
1697	number of frames per second. Frames with a higher frequency will be skipped.
1698	Reducing this value increases the number of skipped frames and reduces the
1699	file size. This setting cannot be changed while video capturing
1700	is enabled.</para>
1701	</listitem>
1702
1703	<listitem>
1704	<para><computeroutput>vcpmaxtime</computeroutput> determines the maximum time
1705	video capturing works. The capture stops when the defined time interval
1706	has elapsed. If this value is zero the capturing is not limited
1707	by time. This setting cannot be changed while video capturing is enabled.</para>
1708	</listitem>
1709
1710	<listitem>
1711	<para><computeroutput>vcpmaxsize</computeroutput> determines the maximum
1712	size of captured video file in MB. The capture stops when captured video file size
1713	has reached the defined. If this value is zero the capturing
1714	will not be limited by file size. This setting cannot be changed
1715	while video capturing is enabled.</para>
1716	</listitem>
1717
1718	<listitem>
1719	<para><computeroutput>vcpoptions</computeroutput> contains any additional
1720	video capturing options required in comma-separated key=value format. This setting
1721	cannot be changed while video capturing is enabled.</para>
1722	</listitem>
1723
1724	<listitem>
1725	<para>The <computeroutput>setcredentials</computeroutput> operation is
1726	used for remote logons in Windows guests. For details, please refer to
1727	<xref linkend="autologon" />.</para>
1728	</listitem>
1729
1730	<!-- @todo r=andy Document teleport! -->
1731
1732	<listitem>
1733	<para><computeroutput>--plugcpu\|unplugcpu
1734	<id></computeroutput>: If CPU hot-plugging is enabled, this adds
1735	a virtual CPU to the virtual machines (or removes one).
1736	<computeroutput><id></computeroutput> specifies the index of
1737	the virtual CPU to be added or removed and must be a number from 0
1738	to the maximum no. of CPUs configured. CPU 0 can never be removed.</para>
1739	</listitem>
1740
1741	<listitem>
1742	<para>The <computeroutput>cpuexecutioncap
1743	<1-100></computeroutput>: This operation controls how much cpu
1744	time a virtual CPU can use. A value of 50 implies a single virtual CPU
1745	can use up to 50% of a single host CPU.</para>
1746	</listitem>
1747
1748	<!-- @todo r=andy Document webcam! -->
1749
1750	</itemizedlist>
1751	</sect1>
1752
1753	<sect1>
1754	<title>VBoxManage discardstate</title>
1755
1756	<para>This command discards the saved state of a virtual machine which is
1757	not currently running, which will cause its operating system to restart
1758	next time you start it. This is the equivalent of pulling out the power
1759	cable on a physical machine, and should be avoided if possible.</para>
1760	</sect1>
1761
1762	<sect1>
1763	<title>VBoxManage adoptstate</title>
1764
1765	<para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
1766	that is separate from the VM configuration, you can use this command to
1767	"adopt" the file. This will change the VM to saved state and when you
1768	start it, VirtualBox will attempt to restore it from the saved state file
1769	you indicated. This command should only be used in special setups.</para>
1770	</sect1>
1771
1772	<sect1>
1773	<title>VBoxManage snapshot</title>
1774
1775	<para>This command is used to control snapshots from the command line. A
1776	snapshot consists of a complete copy of the virtual machine settings,
1777	copied at the time when the snapshot was taken, and optionally a virtual
1778	machine saved state file if the snapshot was taken while the machine was
1779	running. After a snapshot has been taken, VirtualBox creates differencing
1780	hard disk for each normal hard disk associated with the machine so that
1781	when a snapshot is restored, the contents of the virtual machine's virtual
1782	hard disks can be quickly reset by simply dropping the pre-existing
1783	differencing files.</para>
1784
1785	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
1786	of the current state of the virtual machine. You must supply a name for
1787	the snapshot and can optionally supply a description. The new snapshot is
1788	inserted into the snapshots tree as a child of the current snapshot and
1789	then becomes the new current snapshot. The
1790	<computeroutput>--description</computeroutput> parameter allows to
1791	describe the snapshot. If <computeroutput>--live</computeroutput>
1792	is specified, the VM will not be stopped during the snapshot creation
1793	(live smapshotting).</para>
1794
1795	<para>The <computeroutput>delete</computeroutput> operation deletes a
1796	snapshot (specified by name or by UUID). This can take a while to finish
1797	since the differencing images associated with the snapshot might need to
1798	be merged with their child differencing images.</para>
1799
1800	<para>The <computeroutput>restore</computeroutput> operation will restore
1801	the given snapshot (specified by name or by UUID) by resetting the virtual
1802	machine's settings and current state to that of the snapshot. The previous
1803	current state of the machine will be lost. After this, the given snapshot
1804	becomes the new "current" snapshot so that subsequent snapshots are
1805	inserted under the snapshot from which was restored.</para>
1806
1807	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
1808	shortcut to restore the current snapshot (i.e. the snapshot from which the
1809	current state is derived). This subcommand is equivalent to using the
1810	"restore" subcommand with the name or UUID of the current snapshot, except
1811	that it avoids the extra step of determining that name or UUID.</para>
1812
1813	<para>With the <computeroutput>edit</computeroutput> operation, you can
1814	change the name or description of an existing snapshot.</para>
1815
1816	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
1817	can view the virtual machine settings that were stored with an existing
1818	snapshot.</para>
1819	</sect1>
1820
1821	<sect1 id="vboxmanage-closemedium">
1822	<title>VBoxManage closemedium</title>
1823
1824	<para>This commands removes a hard disk, DVD or floppy image from a
1825	VirtualBox media registry.<footnote>
1826	<para>Before VirtualBox 4.0, it was necessary to call VBoxManage
1827	openmedium before a medium could be attached to a virtual machine;
1828	that call "registered" the medium with the global VirtualBox media
1829	registry. With VirtualBox 4.0 this is no longer necessary; media are
1830	added to media registries automatically. The "closemedium" call has
1831	been retained, however, to allow for explicitly removing a medium from
1832	a registry.</para>
1833	</footnote></para>
1834
1835	<para>Optionally, you can request that the image be deleted. You will get
1836	appropriate diagnostics that the deletion failed, however the image will
1837	become unregistered in any case.</para>
1838	</sect1>
1839
1840	<sect1 id="vboxmanage-storageattach">
1841	<title>VBoxManage storageattach</title>
1842
1843	<para>This command attaches/modifies/removes a storage medium connected to
1844	a storage controller that was previously added with the
1845	<computeroutput>storagectl</computeroutput> command (see the previous
1846	section). The syntax is as follows:</para>
1847
1848	<screen>VBoxManage storageattach <uuid\|vmname>
1849	--storagectl <name>
1850	[--port <number>]
1851	[--device <number>]
1852	[--type dvddrive\|hdd\|fdd]
1853	[--medium none\|emptydrive\|
1854	<uuid>\|<filename>\|host:<drive>\|iscsi]
1855	[--mtype normal\|writethrough\|immutable\|shareable]
1856	[--comment <text>]
1857	[--setuuid <uuid>]
1858	[--setparentuuid <uuid>]
1859	[--passthrough on\|off]
1860	[--tempeject on\|off]
1861	[--nonrotational on\|off]
1862	[--discard on\|off]
1863	[--bandwidthgroup name\|none]
1864	[--forceunmount]
1865	[--server <name>\|<ip>]
1866	[--target <target>]
1867	[--tport <port>]
1868	[--lun <lun>]
1869	[--encodedlun <lun>]
1870	[--username <username>]
1871	[--password <password>]
1872	[--initiator <initiator>]
1873	[--intnet]</screen>
1874
1875	<para>A number of parameters are commonly required; the ones at the end of
1876	the list are required only for iSCSI targets (see below).</para>
1877
1878	<para>The common parameters are:<glosslist>
1879	<glossentry>
1880	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
1881
1882	<glossdef>
1883	<para>The VM UUID or VM Name. Mandatory.</para>
1884	</glossdef>
1885	</glossentry>
1886
1887	<glossentry>
1888	<glossterm><computeroutput>--storagectl</computeroutput></glossterm>
1889
1890	<glossdef>
1891	<para>Name of the storage controller. Mandatory. The list of the
1892	storage controllers currently attached to a VM can be obtained
1893	with <computeroutput>VBoxManage showvminfo</computeroutput>; see
1894	<xref linkend="vboxmanage-showvminfo" />.</para>
1895	</glossdef>
1896	</glossentry>
1897
1898	<glossentry>
1899	<glossterm><computeroutput>--port</computeroutput></glossterm>
1900
1901	<glossdef>
1902	<para>The number of the storage controller's port which is to be
1903	modified. Mandatory, unless the storage controller has only a
1904	single port.</para>
1905	</glossdef>
1906	</glossentry>
1907
1908	<glossentry>
1909	<glossterm><computeroutput>--device</computeroutput></glossterm>
1910
1911	<glossdef>
1912	<para>The number of the port's device which is to be modified.
1913	Mandatory, unless the storage controller has only a single device
1914	per port.</para>
1915	</glossdef>
1916	</glossentry>
1917
1918	<glossentry>
1919	<glossterm><computeroutput>--type</computeroutput></glossterm>
1920
1921	<glossdef>
1922	<para>Define the type of the drive to which the medium is being
1923	attached/detached/modified. This argument can only be omitted if
1924	the type of medium can be determined from either the medium given
1925	with the <computeroutput>--medium</computeroutput> argument or
1926	from a previous medium attachment.</para>
1927	</glossdef>
1928	</glossentry>
1929
1930	<glossentry>
1931	<glossterm><computeroutput>--medium</computeroutput></glossterm>
1932
1933	<glossdef>
1934	<para>Specifies what is to be attached. The following values are
1935	supported:<itemizedlist>
1936	<listitem>
1937	<para>"none": Any existing device should be removed from the
1938	given slot.</para>
1939	</listitem>
1940
1941	<listitem>
1942	<para>"emptydrive": For a virtual DVD or floppy drive only,
1943	this makes the device slot behaves like a removeable drive
1944	into which no media has been inserted.</para>
1945	</listitem>
1946
1947	<listitem>
1948	<para>"additions": For a virtual DVD drive only, this
1949	attaches the <emphasis>VirtualBox Guest Additions</emphasis>
1950	image to the given device slot.</para>
1951	</listitem>
1952
1953	<listitem>
1954	<para>If a UUID is specified, it must be the UUID of a
1955	storage medium that is already known to VirtualBox (e.g.
1956	because it has been attached to another virtual machine).
1957	See <xref linkend="vboxmanage-list" /> for how to list known
1958	media. This medium is then attached to the given device
1959	slot.</para>
1960	</listitem>
1961
1962	<listitem>
1963	<para>If a filename is specified, it must be the full path
1964	of an existing disk image (ISO, RAW, VDI, VMDK or other),
1965	which is then attached to the given device slot.</para>
1966	</listitem>
1967
1968	<listitem>
1969	<para>"host:<drive>": For a virtual DVD or floppy
1970	drive only, this connects the given device slot to the
1971	specified DVD or floppy drive on the host computer.</para>
1972	</listitem>
1973
1974	<listitem>
1975	<para>"iscsi": For virtual hard disks only, this allows for
1976	specifying an iSCSI target. In this case, more parameters
1977	must be given; see below.</para>
1978	</listitem>
1979	</itemizedlist></para>
1980
1981	<para>Some of the above changes, in particular for removeable
1982	media (floppies and CDs/DVDs), can be effected while a VM is
1983	running. Others (device changes or changes in hard disk device
1984	slots) require the VM to be powered off.</para>
1985	</glossdef>
1986	</glossentry>
1987
1988	<glossentry>
1989	<glossterm><computeroutput>--mtype</computeroutput></glossterm>
1990
1991	<glossdef>
1992	<para>Defines how this medium behaves with respect to snapshots
1993	and write operations. See <xref linkend="hdimagewrites" /> for
1994	details.</para>
1995	</glossdef>
1996	</glossentry>
1997
1998	<glossentry>
1999	<glossterm><computeroutput>--comment</computeroutput></glossterm>
2000
2001	<glossdef>
2002	<para>Any description that you want to have stored with this
2003	medium (optional; for example, for an iSCSI target, "Big storage
2004	server downstairs"). This is purely descriptive and not needed for
2005	the medium to function correctly.</para>
2006	</glossdef>
2007	</glossentry>
2008
2009	<glossentry>
2010	<glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
2011
2012	<glossdef>
2013	<para>Modifies the UUID or parent UUID of a medium before
2014	attaching it to a VM. This is an expert option. Inappropriate use
2015	can make the medium unusable or lead to broken VM configurations
2016	if any other VM is referring to the same media already. The most
2017	frequently used variant is <code>--setuuid ""</code>, which assigns
2018	a new (random) UUID to an image. This is useful to resolve the
2019	duplicate UUID errors if one duplicated an image using file copy
2020	utilities.</para>
2021	</glossdef>
2022	</glossentry>
2023
2024	<glossentry>
2025	<glossterm><computeroutput>--passthrough</computeroutput></glossterm>
2026
2027	<glossdef>
2028	<para>For a virtual DVD drive only, you can enable DVD writing
2029	support (currently experimental; see <xref
2030	linkend="storage-cds" />).</para>
2031	</glossdef>
2032	</glossentry>
2033
2034	<glossentry>
2035	<glossterm><computeroutput>--tempeject</computeroutput></glossterm>
2036
2037	<glossdef>
2038	<para>For a virtual DVD drive only, you can configure the behavior
2039	for guest-triggered medium eject. If this is set to "on", the eject
2040	has only temporary effects. If the VM is powered off and restarted
2041	the originally configured medium will be still in the drive.</para>
2042	</glossdef>
2043	</glossentry>
2044
2045	<glossentry>
2046	<glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
2047
2048	<glossdef>
2049	<para>This switch allows to enable the non-rotational flag for virtual
2050	hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs
2051	and don't perform disk fragmentation on such media.
2052	</para>
2053	</glossdef>
2054	</glossentry>
2055
2056	<glossentry>
2057	<glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
2058
2059	<glossdef>
2060	<para>Sets the bandwidth group to use for the given device; see
2061	<xref linkend="storage-bandwidth-limit" />.</para>
2062	</glossdef>
2063	</glossentry>
2064
2065	<glossentry>
2066	<glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
2067
2068	<glossdef>
2069	<para>For a virtual DVD or floppy drive only, this forcibly
2070	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
2071	the previous one is locked down by the guest for reading. Again,
2072	see <xref linkend="storage-cds" /> for details.</para>
2073	</glossdef>
2074	</glossentry>
2075	</glosslist></para>
2076
2077	<para>When "iscsi" is used with the
2078	<computeroutput>--medium</computeroutput> parameter for iSCSI support --
2079	see <xref linkend="storage-iscsi" /> --, additional parameters must or can
2080	be used:<glosslist>
2081	<glossentry>
2082	<glossterm><computeroutput>--server</computeroutput></glossterm>
2083
2084	<glossdef>
2085	<para>The host name or IP address of the iSCSI target;
2086	required.</para>
2087	</glossdef>
2088	</glossentry>
2089
2090	<glossentry>
2091	<glossterm><computeroutput>--target</computeroutput></glossterm>
2092
2093	<glossdef>
2094	<para>Target name string. This is determined by the iSCSI target
2095	and used to identify the storage resource; required.</para>
2096	</glossdef>
2097	</glossentry>
2098
2099	<glossentry>
2100	<glossterm><computeroutput>--tport</computeroutput></glossterm>
2101
2102	<glossdef>
2103	<para>TCP/IP port number of the iSCSI service on the target
2104	(optional).</para>
2105	</glossdef>
2106	</glossentry>
2107
2108	<glossentry>
2109	<glossterm><computeroutput>--lun</computeroutput></glossterm>
2110
2111	<glossdef>
2112	<para>Logical Unit Number of the target resource (optional).
2113	Often, this value is zero.</para>
2114	</glossdef>
2115	</glossentry>
2116
2117	<glossentry>
2118	<glossterm><computeroutput>--username, --password</computeroutput></glossterm>
2119
2120	<glossdef>
2121	<para>Username and password (initiator secret) for target
2122	authentication, if required (optional).<note>
2123	<para>Username and password are stored without
2124	encryption (i.e. in clear text) in the XML machine
2125	configuration file if no settings password is provided.
2126	When a settings password was specified the first time,
2127	the password is stored encrypted.</para>
2128	</note></para>
2129	</glossdef>
2130	</glossentry>
2131
2132	<glossentry>
2133	<glossterm><computeroutput>--intnet</computeroutput></glossterm>
2134
2135	<glossdef>
2136	<para>If specified, connect to the iSCSI target via Internal
2137	Networking. This needs further configuration which is described in
2138	<xref linkend="iscsi-intnet" />.</para>
2139	</glossdef>
2140	</glossentry>
2141	</glosslist></para>
2142	</sect1>
2143
2144	<sect1 id="vboxmanage-storagectl">
2145	<title>VBoxManage storagectl</title>
2146
2147	<para>This command attaches/modifies/removes a storage controller. After
2148	this, virtual media can be attached to the controller with the
2149	<computeroutput>storageattach</computeroutput> command (see the next
2150	section).</para>
2151
2152	<para>The syntax is as follows:</para>
2153
2154	<screen>VBoxManage storagectl <uuid\|vmname>
2155	--name <name>
2156	[--add <ide/sata/scsi/floppy>]
2157	[--controller <LsiLogic\|LSILogicSAS\|BusLogic\|
2158	IntelAhci\|PIIX3\|PIIX4\|ICH6\|I82078>]
2159	[--sataportcount <1-30>]
2160	[--hostiocache on\|off]
2161	[--bootable on\|off]
2162	[--remove]</screen>
2163
2164	<para>where the parameters mean: <glosslist>
2165	<glossentry>
2166	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
2167
2168	<glossdef>
2169	<para>The VM UUID or VM Name. Mandatory.</para>
2170	</glossdef>
2171	</glossentry>
2172
2173	<glossentry>
2174	<glossterm><computeroutput>--name</computeroutput></glossterm>
2175
2176	<glossdef>
2177	<para>Name of the storage controller. Mandatory.</para>
2178	</glossdef>
2179	</glossentry>
2180
2181	<glossentry>
2182	<glossterm><computeroutput>--add</computeroutput></glossterm>
2183
2184	<glossdef>
2185	<para>Define the type of the system bus to which the storage
2186	controller must be connected.</para>
2187	</glossdef>
2188	</glossentry>
2189
2190	<glossentry>
2191	<glossterm><computeroutput>--controller</computeroutput></glossterm>
2192
2193	<glossdef>
2194	<para>Allows to choose the type of chipset being emulated for the
2195	given storage controller.</para>
2196	</glossdef>
2197	</glossentry>
2198
2199	<glossentry>
2200	<glossterm><computeroutput>--sataportcount</computeroutput></glossterm>
2201
2202	<glossdef>
2203	<para>This determines how many ports the SATA controller should
2204	support.</para>
2205	</glossdef>
2206	</glossentry>
2207
2208	<glossentry>
2209	<glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
2210
2211	<glossdef>
2212	<para>Configures the use of the host I/O cache for all disk images
2213	attached to this storage controller. For details, please see <xref
2214	linkend="iocaching" />.</para>
2215	</glossdef>
2216	</glossentry>
2217
2218	<glossentry>
2219	<glossterm><computeroutput>--bootable</computeroutput></glossterm>
2220
2221	<glossdef>
2222	<para>Selects whether this controller is bootable.</para>
2223	</glossdef>
2224	</glossentry>
2225
2226	<glossentry>
2227	<glossterm><computeroutput>--remove</computeroutput></glossterm>
2228
2229	<glossdef>
2230	<para>Removes the storage controller from the VM config.</para>
2231	</glossdef>
2232	</glossentry>
2233	</glosslist></para>
2234	</sect1>
2235
2236	<sect1>
2237	<title>VBoxManage bandwidthctl</title>
2238
2239	<para>This command creates/deletes/modifies/shows bandwidth groups of the given
2240	virtual machine:<screen>VBoxManage bandwidthctl <uuid\|vmname>
2241	add <name> --type disk\|network --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
2242	set <name> --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
2243	remove <name> \|
2244	list [--machinereadable]</screen></para>
2245
2246	<para>The following subcommands are available:<itemizedlist>
2247	<listitem>
2248	<para><computeroutput>add</computeroutput>, creates a new bandwidth
2249	group of given type.</para>
2250	</listitem>
2251	<listitem>
2252	<para><computeroutput>set</computeroutput>, modifies the limit for an
2253	existing bandwidth group.</para>
2254	</listitem>
2255	<listitem>
2256	<para><computeroutput>remove</computeroutput>, destroys a bandwidth
2257	group.</para>
2258	</listitem>
2259	<listitem>
2260	<para><computeroutput>list</computeroutput>, shows all bandwidth groups
2261	defined for the given VM.</para>
2262	</listitem>
2263	</itemizedlist>
2264	</para>
2265	<para>The parameters mean:<glosslist>
2266	<glossentry>
2267	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
2268
2269	<glossdef>
2270	<para>The VM UUID or VM Name. Mandatory.</para>
2271	</glossdef>
2272	</glossentry>
2273
2274	<glossentry>
2275	<glossterm><computeroutput>--name</computeroutput></glossterm>
2276
2277	<glossdef>
2278	<para>Name of the bandwidth group. Mandatory.</para>
2279	</glossdef>
2280	</glossentry>
2281
2282	<glossentry>
2283	<glossterm><computeroutput>--type</computeroutput></glossterm>
2284
2285	<glossdef>
2286	<para>Type of the bandwidth group. Mandatory. Two types are
2287	supported: <computeroutput>disk</computeroutput> and
2288	<computeroutput>network</computeroutput>. See
2289	<xref linkend="storage-bandwidth-limit" /> or
2290	<xref linkend="network_bandwidth_limit" /> for a description of a
2291	particular type.</para>
2292	</glossdef>
2293	</glossentry>
2294
2295	<glossentry>
2296	<glossterm><computeroutput>--limit</computeroutput></glossterm>
2297
2298	<glossdef>
2299	<para>Specifies the limit for the given group. Can be changed
2300	while the VM is running. The default unit is megabytes per
2301	second. The unit can be changed by specifying one of the
2302	following suffixes: <computeroutput>k</computeroutput> for kilobits/s, <computeroutput>m</computeroutput> for megabits/s, <computeroutput>g</computeroutput> for gigabits/s, <computeroutput>K</computeroutput> for kilobytes/s, <computeroutput>M</computeroutput> for megabytes/s, <computeroutput>G</computeroutput> for gigabytes/s.</para>
2303	</glossdef>
2304	</glossentry>
2305	</glosslist>
2306	<note>
2307	<para>The network bandwidth limits apply only to the traffic being sent by
2308	virtual machines. The traffic being received by VMs is unlimited.</para>
2309	</note>
2310	<note>
2311	<para>To remove a bandwidth group it must not be referenced by any disks
2312	or adapters in running VM.</para>
2313	</note>
2314	</para>
2315	</sect1>
2316
2317	<sect1>
2318	<title>VBoxManage showhdinfo</title>
2319
2320	<para>This command shows information about a virtual hard disk image,
2321	notably its size, its size on disk, its type and the virtual machines
2322	which use it.<note>
2323	<para>For compatibility with earlier versions of VirtualBox, the
2324	"showvdiinfo" command is also supported and mapped internally to the
2325	"showhdinfo" command.</para>
2326	</note></para>
2327	<para>The disk image must be specified either by its UUID (if the medium
2328	is registered) or by its filename. Registered images can be listed by
2329	<computeroutput>VBoxManage list hdds</computeroutput> (see <xref linkend="vboxmanage-list" />
2330	for more information). A filename must be specified as valid path, either
2331	as an absolute path or as a relative path starting from the current
2332	directory.</para>
2333	</sect1>
2334
2335	<sect1 id="vboxmanage-createvdi">
2336	<title>VBoxManage createhd</title>
2337
2338	<para>This command creates a new virtual hard disk image. The syntax is as
2339	follows:</para>
2340
2341	<screen>VBoxManage createhd --filename <filename>
2342	--size <megabytes>
2343	[--format VDI\|VMDK\|VHD] (default: VDI)
2344	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
2345
2346	<para>where the parameters mean:<glosslist>
2347	<glossentry>
2348	<glossterm><computeroutput>--filename</computeroutput></glossterm>
2349
2350	<glossdef>
2351	<para>Allows to choose a file name. Mandatory.</para>
2352	</glossdef>
2353	</glossentry>
2354
2355	<glossentry>
2356	<glossterm><computeroutput>--size</computeroutput></glossterm>
2357
2358	<glossdef>
2359	<para>Allows to define the image capacity, in 1 MiB units.
2360	Mandatory.</para>
2361	</glossdef>
2362	</glossentry>
2363
2364	<glossentry>
2365	<glossterm><computeroutput>--format</computeroutput></glossterm>
2366
2367	<glossdef>
2368	<para>Allows to choose a file format for the output file different
2369	from the file format of the input file.</para>
2370	</glossdef>
2371	</glossentry>
2372
2373	<glossentry>
2374	<glossterm><computeroutput>--variant</computeroutput></glossterm>
2375
2376	<glossdef>
2377	<para>Allows to choose a file format variant for the output file.
2378	It is a comma-separated list of variant flags. Not all
2379	combinations are supported, and specifying inconsistent flags will
2380	result in an error message.</para>
2381	</glossdef>
2382	</glossentry>
2383	</glosslist> <note>
2384	<para>For compatibility with earlier versions of VirtualBox, the
2385	"createvdi" command is also supported and mapped internally to the
2386	"createhd" command.</para>
2387	</note></para>
2388	</sect1>
2389
2390	<sect1 id="vboxmanage-modifyvdi">
2391	<title>VBoxManage modifyhd</title>
2392
2393	<para>With the <computeroutput>modifyhd</computeroutput> command, you can
2394	change the characteristics of a disk image after it has been
2395	created:<screen>VBoxManage modifyhd <uuid\|filename>
2396	[--type normal\|writethrough\|immutable\|shareable\|
2397	readonly\|multiattach]
2398	[--autoreset on\|off]
2399	[--compact]
2400	[--resize <megabytes>\|--resizebyte <bytes>]</screen><note>
2401	<para>Despite the "hd" in the subcommand name, the command works with
2402	all disk images, not only hard disks. For compatibility with earlier
2403	versions of VirtualBox, the "modifyvdi" command is also supported and
2404	mapped internally to the "modifyhd" command.</para>
2405	</note></para>
2406
2407	<para>The disk image to modify must be specified either by its UUID
2408	(if the medium is registered) or by its filename. Registered images
2409	can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
2410	(see <xref linkend="vboxmanage-list" /> for more information).
2411	A filename must be specified as valid path, either as an absolute path
2412	or as a relative path starting from the current directory.</para>
2413	<para>The following options are available:<itemizedlist>
2414	<listitem>
2415	<para>With the <computeroutput>--type</computeroutput> argument, you
2416	can change the type of an existing image between the normal,
2417	immutable, write-through and other modes; see <xref
2418	linkend="hdimagewrites" /> for details.</para>
2419	</listitem>
2420
2421	<listitem>
2422	<para>For immutable (differencing) hard disks only, the
2423	<computeroutput>--autoreset on\|off</computeroutput> option
2424	determines whether the disk is automatically reset on every VM
2425	startup (again, see <xref linkend="hdimagewrites" />). The default
2426	is "on".</para>
2427	</listitem>
2428
2429	<listitem>
2430	<para>With the <computeroutput>--compact</computeroutput> option,
2431	can be used to compact disk images, i.e. remove blocks that only
2432	contains zeroes. This will shrink a dynamically allocated image
2433	again; it will reduce the <emphasis>physical</emphasis> size of the
2434	image without affecting the logical size of the virtual disk.
2435	Compaction works both for base images and for diff images created as
2436	part of a snapshot.</para>
2437
2438	<para>For this operation to be effective, it is required that free
2439	space in the guest system first be zeroed out using a suitable
2440	software tool. For Windows guests, you can use the
2441	<computeroutput>sdelete</computeroutput> tool provided by Microsoft.
2442	Execute <computeroutput>sdelete -z</computeroutput> in the guest to
2443	zero the free disk space before compressing the virtual disk
2444	image. For Linux, use the <code>zerofree</code> utility which
2445	supports ext2/ext3 filesystems. For Mac OS X guests, use the
2446	<emphasis>Erase Free Space</emphasis> feature of the built-in
2447	<emphasis>Disk Utility</emphasis>. Use
2448	<emphasis>Zero Out Data</emphasis> there.</para>
2449
2450	<para>Please note that compacting is currently only available for
2451	VDI images. A similar effect can be achieved by zeroing out free
2452	blocks and then cloning the disk to any other dynamically allocated
2453	format. You can use this workaround until compacting is also
2454	supported for disk formats other than VDI.</para>
2455	</listitem>
2456
2457	<listitem>
2458	<para>The <computeroutput>--resize x</computeroutput> option (where x
2459	is the desired new total space in <emphasis role="bold">megabytes</emphasis>)
2460	allows you to change the capacity of an existing image; this adjusts the
2461	<emphasis>logical</emphasis> size of a virtual disk without affecting
2462	the physical size much.<footnote>
2463	<para>Image resizing was added with VirtualBox 4.0.</para>
2464	</footnote> This currently works only for VDI and VHD formats, and only
2465	for the dynamically allocated variants, and can only be used to expand
2466	(not shrink) the capacity.
2467	For example, if you originally created a 10G disk which is now full,
2468	you can use the <computeroutput>--resize 15360</computeroutput>
2469	command to change the capacity to 15G (15,360MB) without having to create a new
2470	image and copy all data from within a virtual machine. Note however that
2471	this only changes the drive capacity; you will typically next need to use
2472	a partition management tool inside the guest to adjust the main partition
2473	to fill the drive.</para><para>The <computeroutput>--resizebyte x</computeroutput>
2474	option does almost the same thing, except that x is expressed in bytes
2475	instead of megabytes.</para>
2476	</listitem>
2477	</itemizedlist></para>
2478	</sect1>
2479
2480	<sect1 id="vboxmanage-clonevdi">
2481	<title>VBoxManage clonehd</title>
2482
2483	<para>This command duplicates a registered virtual hard disk image to a
2484	new image file with a new unique identifier (UUID). The new image can be
2485	transferred to another host system or imported into VirtualBox again using
2486	the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
2487	linkend="cloningvdis" />. The syntax is as follows:</para>
2488
2489	<screen>VBoxManage clonehd <uuid\|inutfile> <uuid\|outputfile>
2490	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
2491	[--variant Standard,Fixed,Split2G,Stream,ESX]
2492	[--existing]</screen>
2493
2494	<para>The disk image to clone as well as the target image must be described
2495	either by its UUIDs (if the mediums are registered) or by its filename.
2496	Registered images can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
2497	(see <xref linkend="vboxmanage-list" /> for more information).
2498	A filename must be specified as valid path, either as an absolute path or
2499	as a relative path starting from the current directory.</para>
2500	<para>The following options are available:<glosslist>
2501	<glossentry>
2502	<glossterm><computeroutput>--format</computeroutput></glossterm>
2503
2504	<glossdef>
2505	<para>Allow to choose a file format for the output file different
2506	from the file format of the input file.</para>
2507	</glossdef>
2508	</glossentry>
2509
2510	<glossentry>
2511	<glossterm><computeroutput>--variant</computeroutput></glossterm>
2512
2513	<glossdef>
2514	<para>Allow to choose a file format variant for the output file.
2515	It is a comma-separated list of variant flags. Not all
2516	combinations are supported, and specifying inconsistent flags will
2517	result in an error message.</para>
2518	</glossdef>
2519	</glossentry>
2520
2521	<glossentry>
2522	<glossterm><computeroutput>--existing</computeroutput></glossterm>
2523
2524	<glossdef>
2525	<para>Perform the clone operation to an already existing
2526	destination medium. Only the portion of the source medium which
2527	fits into the destination medium is copied. This means if the
2528	destination medium is smaller than the source only a part of it is
2529	copied, and if the destination medium is larger than the source
2530	the remaining part of the destination medium is unchanged.</para>
2531	</glossdef>
2532	</glossentry>
2533	</glosslist> <note>
2534	<para>For compatibility with earlier versions of VirtualBox, the
2535	"clonevdi" command is also supported and mapped internally to the
2536	"clonehd" command.</para>
2537	</note></para>
2538	</sect1>
2539
2540	<sect1>
2541	<title>VBoxManage convertfromraw</title>
2542
2543	<para>This command converts a raw disk image to a VirtualBox Disk Image
2544	(VDI) file. The syntax is as follows:</para>
2545
2546	<screen>VBoxManage convertfromraw <filename> <outputfile>
2547	[--format VDI\|VMDK\|VHD]
2548	[--variant Standard,Fixed,Split2G,Stream,ESX]
2549	[--uuid <uuid>]
2550	VBoxManage convertfromraw stdin <outputfile> <bytes>
2551	[--format VDI\|VMDK\|VHD]
2552	[--variant Standard,Fixed,Split2G,Stream,ESX]
2553	[--uuid <uuid>]</screen>
2554
2555	<para>where the parameters mean:<glosslist>
2556	<glossentry>
2557	<glossterm><computeroutput>--bytes</computeroutput></glossterm>
2558
2559	<glossdef>
2560	<para>The size of the image file, in bytes, provided through
2561	stdin.</para>
2562	</glossdef>
2563	</glossentry>
2564
2565	<glossentry>
2566	<glossterm><computeroutput>--format</computeroutput></glossterm>
2567
2568	<glossdef>
2569	<para>Select the disk image format to create. Default is
2570	VDI.</para>
2571	</glossdef>
2572	</glossentry>
2573
2574	<glossentry>
2575	<glossterm><computeroutput>--variant</computeroutput></glossterm>
2576
2577	<glossdef>
2578	<para>Allow to choose a file format variant for the output file.
2579	It is a comma-separated list of variant flags. Not all
2580	combinations are supported, and specifying inconsistent flags will
2581	result in an error message.</para>
2582	</glossdef>
2583	</glossentry>
2584
2585	<glossentry>
2586	<glossterm><computeroutput>--uuid</computeroutput></glossterm>
2587
2588	<glossdef>
2589	<para>Allow to specifiy the UUID of the output file.</para>
2590	</glossdef>
2591	</glossentry>
2592	</glosslist> The second form forces VBoxManage to read the content for
2593	the disk image from standard input (useful for using that command in a
2594	pipe).</para>
2595
2596	<para><note>
2597	<para>For compatibility with earlier versions of VirtualBox, the
2598	"convertdd" command is also supported and mapped internally to the
2599	"convertfromraw" command.</para>
2600	</note></para>
2601	</sect1>
2602
2603	<sect1>
2604	<title>VBoxManage getextradata/setextradata</title>
2605
2606	<para>These commands let you attach and retrieve string data to a virtual
2607	machine or to a VirtualBox configuration (by specifying
2608	<computeroutput>global</computeroutput> instead of a virtual machine
2609	name). You must specify a key (as a text string) to associate the data
2610	with, which you can later use to retrieve it. For example:</para>
2611
2612	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
2613	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
2614
2615	<para>would associate the string "2006.01.01" with the key installdate for
2616	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
2617	could retrieve the information as follows:</para>
2618
2619	<screen>VBoxManage getextradata Fedora5 installdate</screen>
2620
2621	<para>which would return</para>
2622
2623	<screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
2624	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
2625	All rights reserved.
2626
2627	Value: 2006.01.01</screen>
2628	<para>To remove a key, the <computeroutput>setextradata</computeroutput>
2629	command must be run without specifying data (only the key), for example:
2630	</para>
2631
2632	<screen>VBoxManage setextradata Fedora5 installdate</screen>
2633
2634	</sect1>
2635
2636	<sect1 id="vboxmanage-setproperty">
2637	<title>VBoxManage setproperty</title>
2638
2639	<para>This command is used to change global settings which affect the
2640	entire VirtualBox installation. Some of these correspond to the settings
2641	in the "Global settings" dialog in the graphical user interface. The
2642	following properties are available:<glosslist>
2643	<glossentry>
2644	<glossterm><computeroutput>machinefolder</computeroutput></glossterm>
2645
2646	<glossdef>
2647	<para>This specifies the default folder in which virtual machine
2648	definitions are kept; see <xref linkend="vboxconfigdata" /> for
2649	details.</para>
2650	</glossdef>
2651	</glossentry>
2652
2653	<glossentry>
2654	<glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm>
2655	<para>This specifies whether VirtualBox will make exclusive use of
2656	the hardware virtualization extensions (Intel VT-x or AMD-V) of the
2657	host system's processor; see <xref linkend="hwvirt" />. If you wish to
2658	share these extensions with other hypervisors running at the same time,
2659	you must disable this setting. Doing so has negative performance implications.
2660	</para>
2661	</glossentry>
2662
2663
2664	<glossentry>
2665	<glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
2666
2667	<glossdef>
2668	<para>This specifies which library to use when "external"
2669	authentication has been selected for a particular virtual machine;
2670	see <xref linkend="vbox-auth" /> for details.</para>
2671	</glossdef>
2672	</glossentry>
2673
2674	<glossentry>
2675	<glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
2676
2677	<glossdef>
2678	<para>This specifies which library the web service uses to
2679	authenticate users. For details about the VirtualBox web service,
2680	please refer to the separate VirtualBox SDK reference (see <xref
2681	linkend="VirtualBoxAPI" />).</para>
2682	</glossdef>
2683	</glossentry>
2684
2685	<glossentry>
2686	<glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
2687
2688	<glossdef>
2689	<para>This specifies which library implements the VirtualBox
2690	Remote Desktop Extension.</para>
2691	</glossdef>
2692	</glossentry>
2693
2694	<glossentry>
2695	<glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
2696
2697	<glossdef>
2698	<para>This selects how many rotated (old) VM logs are kept.</para>
2699	</glossdef>
2700	</glossentry>
2701
2702	<glossentry>
2703	<glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
2704
2705	<glossdef>
2706	<para>This selects the path to the autostart database. See
2707	<xref linkend="autostart" />.</para>
2708	</glossdef>
2709	</glossentry>
2710
2711	<glossentry>
2712	<glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
2713
2714	<glossdef>
2715	<para>This selects the global default VM frontend setting. See
2716	<xref linkend="vboxmanage-startvm" />.</para>
2717	</glossdef>
2718	</glossentry>
2719	</glosslist></para>
2720	</sect1>
2721
2722	<sect1>
2723	<title>VBoxManage usbfilter add/modify/remove</title>
2724
2725	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
2726	working with USB filters in virtual machines, or global filters which
2727	affect the whole VirtualBox setup. Global filters are applied before
2728	machine-specific filters, and may be used to prevent devices from being
2729	captured by any virtual machine. Global filters are always applied in a
2730	particular order, and only the first filter which fits a device is
2731	applied. So for example, if the first global filter says to hold (make
2732	available) a particular Kingston memory stick device and the second to
2733	ignore all Kingston devices, that memory stick will be available to any
2734	machine with an appropriate filter, but no other Kingston device
2735	will.</para>
2736
2737	<para>When creating a USB filter using <computeroutput>usbfilter
2738	add</computeroutput>, you must supply three or four mandatory parameters.
2739	The index specifies the position in the list at which the filter should be
2740	placed. If there is already a filter at that position, then it and the
2741	following ones will be shifted back one place. Otherwise the new filter
2742	will be added onto the end of the list. The
2743	<computeroutput>target</computeroutput> parameter selects the virtual
2744	machine that the filter should be attached to or use "global" to apply it
2745	to all virtual machines. <computeroutput>name</computeroutput> is a name
2746	for the new filter and for global filters,
2747	<computeroutput>action</computeroutput> says whether to allow machines
2748	access to devices that fit the filter description ("hold") or not to give
2749	them access ("ignore"). In addition, you should specify parameters to
2750	filter by. You can find the parameters for devices attached to your system
2751	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
2752	you can specify whether the filter should be active, and for local
2753	filters, whether they are for local devices, remote (over an RDP
2754	connection) or either.</para>
2755
2756	<para>When you modify a USB filter using <computeroutput>usbfilter
2757	modify</computeroutput>, you must specify the filter by index (see the
2758	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
2759	find global filter indexes and that of <computeroutput>VBoxManage
2760	showvminfo</computeroutput> to find indexes for individual machines) and
2761	by target, which is either a virtual machine or "global". The properties
2762	which can be changed are the same as for <computeroutput>usbfilter
2763	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
2764	remove</computeroutput> and specify the index and the target.</para>
2765	</sect1>
2766
2767	<sect1 id="vboxmanage-sharedfolder">
2768	<title>VBoxManage sharedfolder add/remove</title>
2769
2770	<para>This command allows you to share folders on the host computer with
2771	guest operating systems. For this, the guest systems must have a version
2772	of the VirtualBox Guest Additions installed which supports this
2773	functionality.</para>
2774
2775	<para>Shared folders are described in detail in <xref
2776	linkend="sharedfolders" />.</para>
2777	</sect1>
2778
2779	<sect1 id="vboxmanage-guestproperty">
2780	<title>VBoxManage guestproperty</title>
2781
2782	<para>The "guestproperty" commands allow you to get or set properties of a
2783	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
2784	for an introduction. As explained there, guest properties are arbitrary
2785	key/value string pairs which can be written to and read from by either the
2786	guest or the host, so they can be used as a low-volume communication
2787	channel for strings, provided that a guest is running and has the Guest
2788	Additions installed. In addition, a number of values whose keys begin with
2789	"/VirtualBox/" are automatically set and maintained by the Guest
2790	Additions.</para>
2791
2792	<para>The following subcommands are available (where
2793	<computeroutput><vm></computeroutput>, in each case, can either be a
2794	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2795	<listitem>
2796	<para><computeroutput>enumerate <vm> [--patterns
2797	<pattern>]</computeroutput>: This lists all the guest
2798	properties that are available for the given VM, including the value.
2799	This list will be very limited if the guest's service process cannot
2800	be contacted, e.g. because the VM is not running or the Guest
2801	Additions are not installed.</para>
2802
2803	<para>If <computeroutput>--patterns <pattern></computeroutput>
2804	is specified, it acts as a filter to only list properties that match
2805	the given pattern. The pattern can contain the following wildcard
2806	characters:<itemizedlist>
2807	<listitem>
2808	<para><computeroutput>*</computeroutput> (asterisk):
2809	represents any number of characters; for example,
2810	"<computeroutput>/VirtualBox*</computeroutput>" would match
2811	all properties beginning with "/VirtualBox".</para>
2812	</listitem>
2813
2814	<listitem>
2815	<para><computeroutput>?</computeroutput> (question mark):
2816	represents a single arbitrary character; for example,
2817	"<computeroutput>fo?</computeroutput>" would match both "foo"
2818	and "for".</para>
2819	</listitem>
2820
2821	<listitem>
2822	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
2823	used to specify multiple alternative patterns; for example,
2824	"<computeroutput>s\|t</computeroutput>" would match anything
2825	starting with either "s" or "t".</para>
2826	</listitem>
2827	</itemizedlist></para>
2828	</listitem>
2829
2830	<listitem>
2831	<para><computeroutput>get <vm> <property>
2832	</computeroutput>: This
2833	retrieves the value of a single property only. If the property
2834	cannot be found (e.g. because the guest is not running), this will
2835	print <screen>No value set!</screen></para>
2836	</listitem>
2837
2838	<listitem>
2839	<para><computeroutput>set <vm> <property> [<value>
2840	[--flags <flags>]]</computeroutput>: This allows you to set a
2841	guest property by specifying the key and value. If
2842	<computeroutput><value></computeroutput> is omitted, the
2843	property is deleted. With <computeroutput>--flags</computeroutput>
2844	you can optionally specify additional behavior (you can combine
2845	several by separating them with commas):<itemizedlist>
2846	<listitem>
2847	<para><computeroutput>TRANSIENT</computeroutput>: the value
2848	will not be stored with the VM data when the VM exits;</para>
2849	</listitem>
2850
2851	<listitem>
2852	<para><computeroutput>TRANSRESET</computeroutput>: the value
2853	will be deleted as soon as the VM restarts and/or exits;</para>
2854	</listitem>
2855
2856	<listitem>
2857	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
2858	can only be changed by the host, but the guest can only read
2859	it;</para>
2860	</listitem>
2861
2862	<listitem>
2863	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
2864	the value can only be changed by the guest, but the host can
2865	only read it;</para>
2866	</listitem>
2867
2868	<listitem>
2869	<para><computeroutput>READONLY</computeroutput>: a combination
2870	of the two, the value cannot be changed at all.</para>
2871	</listitem>
2872	</itemizedlist></para>
2873	</listitem>
2874
2875	<listitem>
2876	<para><computeroutput>wait <vm> <pattern> --timeout
2877	<timeout></computeroutput>: This waits for a particular value
2878	described by "pattern" to change or to be deleted or created. The
2879	pattern rules are the same as for the "enumerate" subcommand
2880	above.</para>
2881	</listitem>
2882
2883	<listitem>
2884	<para><computeroutput>delete <vm> <property>
2885	</computeroutput>: Deletes a formerly set guest property.
2886	</para></listitem>
2887	</itemizedlist></para>
2888	</sect1>
2889
2890	<sect1 id="vboxmanage-guestcontrol">
2891	<title>VBoxManage guestcontrol</title>
2892
2893	<para>The <computeroutput>guestcontrol</computeroutput> commands allow you
2894	to control certain things inside a guest from the host. Please see <xref
2895	linkend="guestadd-guestcontrol" /> for an introduction.</para>
2896
2897	<para>Generally, the syntax is as follows:</para>
2898
2899	<screen>VBoxManage guestcontrol <uuid\|vmname> <command></screen>
2900
2901	<para>The following subcommands are available (where
2902	<computeroutput><uuid\|vmname></computeroutput>, in each case, can either be a
2903	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2904	<listitem>
2905	<para><emphasis role="bold"><computeroutput>execute</computeroutput></emphasis>,
2906	which allows for
2907	executing a program/script (process) which already is installed and
2908	runnable on the guest. This command only works while a VM is up and
2909	running and has the following syntax:</para>
2910
2911	<screen>VBoxManage guestcontrol <uuid\|vmname> exec[ute]
2912	--image <path to program> --username <name>
2913	[--passwordfile <file> \| --password <password>]
2914	[--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
2915	[--verbose] [--timeout <msec>]
2916	[--wait-exit] [--wait-stdout] [--wait-stderr]
2917	[--dos2unix] [--unix2dos]
2918	-- [[<argument1>] ... [<argumentN>]]</screen>
2919
2920	<para>where the parameters mean: <glosslist>
2921	<glossentry>
2922	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
2923
2924	<glossdef>
2925	<para>The VM UUID or VM name. Mandatory.</para>
2926	</glossdef>
2927	</glossentry>
2928
2929	<glossentry>
2930	<glossterm><computeroutput>--image "<path to program>"</computeroutput></glossterm>
2931
2932	<glossdef>
2933	<para>Absolute path and process name of process to execute
2934	in the guest, e.g.
2935	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
2936	</glossdef>
2937	</glossentry>
2938
2939	<glossentry>
2940	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
2941
2942	<glossdef>
2943	<para>Name of the user the process should run under. This
2944	user must exist on the guest OS.</para>
2945	</glossdef>
2946	</glossentry>
2947
2948	<glossentry>
2949	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
2950
2951	<glossdef>
2952	<para>Password of the user account specified to be read from
2953	the given file. If not given, an empty password is
2954	assumed.</para>
2955	</glossdef>
2956	</glossentry>
2957
2958	<glossentry>
2959	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
2960
2961	<glossdef>
2962	<para>Password of the user account specified with
2963	<computeroutput>--username</computeroutput>. If not given,
2964	an empty password is assumed.</para>
2965	</glossdef>
2966	</glossentry>
2967
2968	<glossentry>
2969	<glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
2970
2971	<glossdef>
2972	Converts output from DOS/Windows guests to UNIX-compatible
2973	line endings (CR + LF -> LF). Not implemented yet.
2974	</glossdef>
2975	</glossentry>
2976
2977	<glossentry>
2978	<glossterm><computeroutput>--environment
2979	"<NAME>=<VALUE>"</computeroutput></glossterm>
2980
2981	<glossdef>
2982	<para>One or more environment variables to be set or
2983	unset.</para>
2984
2985	<para>By default, the new process in the guest will be
2986	created with the standard environment of the guest OS. This
2987	option allows for modifying that environment. To set/modify
2988	a variable, a pair of
2989	<computeroutput>NAME=VALUE</computeroutput> must be
2990	specified; to unset a certain variable, the name with no
2991	value must set, e.g.
2992	<computeroutput>NAME=</computeroutput>.</para>
2993
2994	<para>Arguments containing spaces must be enclosed in
2995	quotation marks. More than one
2996	<computeroutput>--environment</computeroutput> at a time can
2997	be specified to keep the command line tidy.</para>
2998	</glossdef>
2999	</glossentry>
3000
3001	<glossentry>
3002	<glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
3003
3004	<glossdef>
3005	<para>Value (in milliseconds) that specifies the time how
3006	long the started process is allowed to run and how long
3007	VBoxManage waits for getting output from that process. If no
3008	timeout is specified, VBoxManage will wait forever until the
3009	started process ends or an error occured.</para>
3010	</glossdef>
3011	</glossentry>
3012
3013	<glossentry>
3014	<glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
3015
3016	<glossdef>
3017	Converts output from a UNIX/Linux guests to DOS-/Windows-compatible
3018	line endings (LF -> CR + LF). Not implemented yet.
3019	</glossdef>
3020	</glossentry>
3021
3022	<glossentry>
3023	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3024
3025	<glossdef>
3026	<para>Tells VBoxManage to be more verbose.</para>
3027	</glossdef>
3028	</glossentry>
3029
3030	<glossentry>
3031	<glossterm><computeroutput>--wait-exit</computeroutput></glossterm>
3032
3033	<glossdef>
3034	<para>Waits until the process ends and outputs its
3035	exit code along with the exit reason/flags.</para>
3036	</glossdef>
3037	</glossentry>
3038
3039	<glossentry>
3040	<glossterm><computeroutput>--wait-stdout</computeroutput></glossterm>
3041
3042	<glossdef>
3043	<para>Waits until the process ends and outputs its
3044	exit code along with the exit reason/flags. While waiting
3045	VBoxManage retrieves the process output collected from stdout.</para>
3046	</glossdef>
3047	</glossentry>
3048
3049	<glossentry>
3050	<glossterm><computeroutput>--wait-stderr</computeroutput></glossterm>
3051
3052	<glossdef>
3053	<para>Waits until the process ends and outputs its
3054	exit code along with the exit reason/flags. While waiting
3055	VBoxManage retrieves the process output collected from stderr.</para>
3056	</glossdef>
3057	</glossentry>
3058
3059	<glossentry>
3060	<glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm>
3061
3062	<glossdef>
3063	<para>One or more arguments to pass to the process being
3064	executed.</para>
3065	<para>Arguments containing spaces must be enclosed in
3066	quotation marks.</para>
3067	</glossdef>
3068	</glossentry>
3069
3070	</glosslist></para>
3071
3072	<para><note>
3073	<para>On Windows there are certain limitations for graphical
3074	applications; please see <xref linkend="KnownIssues" /> for more
3075	information.</para>
3076	</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls"
3077	--username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe"
3078	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
3079	the double backslashes in the second example are only required on
3080	Unix hosts.</para>
3081
3082	<para><note>
3083	<para>For certain commands a user name of an existing user account on the guest
3084	must be specified; anonymous executions are not supported for security reasons. A
3085	user account password, however, is optional and depends on the guest's OS security
3086	policy or rules. If no password is specified for a given user name, an empty password
3087	will be used. On certain OSes like Windows the security policy may needs to be adjusted
3088	in order to allow user accounts with an empty password set. Also, global domain rules might
3089	apply and therefore cannot be changed.</para>
3090	</note></para>
3091
3092	<para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
3093	to serve up to 5 guest processes at a time. If a new guest process gets started
3094	which would exceed this limit, the oldest not running guest process will be discarded
3095	in order to be able to run that new process. Also, retrieving output from this
3096	old guest process will not be possible anymore then. If all 5 guest processes
3097	are still active and running, starting a new guest process will result in an
3098	appropriate error message.</para>
3099
3100	<para>To raise or lower the guest process execution limit, either the guest
3101	property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
3102	or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
3103	needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
3104	guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
3105	</listitem>
3106
3107	<listitem>
3108	<para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>,
3109	which allows copying
3110	files from the host to the guest (only with installed Guest
3111	Additions 4.0 and later).</para>
3112
3113	<screen>VBoxManage guestcontrol <uuid\|vmname> copyto\|cp
3114	<guest source> <host dest> --username <name>
3115	[--passwordfile <file> \| --password <password>]
3116	[--dryrun] [--follow] [--recursive] [--verbose]</screen>
3117
3118	<para>where the parameters mean: <glosslist>
3119	<glossentry>
3120	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3121
3122	<glossdef>
3123	<para>The VM UUID or VM name. Mandatory.</para>
3124	</glossdef>
3125	</glossentry>
3126
3127	<glossentry>
3128	<glossterm><computeroutput>source on host</computeroutput></glossterm>
3129
3130	<glossdef>
3131	<para>Absolute path of source file(s) on host to copy over
3132	to the guest, e.g.
3133	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
3134	This also can be a wildcard expression, e.g.
3135	<computeroutput>C:\Windows\System32\*.dll</computeroutput></para>
3136	</glossdef>
3137	</glossentry>
3138
3139	<glossentry>
3140	<glossterm><computeroutput>destination on guest</computeroutput></glossterm>
3141
3142	<glossdef>
3143	<para>Absolute destination path on the guest, e.g.
3144	<computeroutput>C:\Temp</computeroutput></para>
3145	</glossdef>
3146	</glossentry>
3147
3148	<glossentry>
3149	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3150
3151	<glossdef>
3152	<para>Name of the user the copy process should run under.
3153	This user must exist on the guest OS.</para>
3154	</glossdef>
3155	</glossentry>
3156
3157	<glossentry>
3158	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3159
3160	<glossdef>
3161	<para>Password of the user account specified to be read from
3162	the given file. If not given, an empty password is
3163	assumed.</para>
3164	</glossdef>
3165	</glossentry>
3166
3167	<glossentry>
3168	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3169
3170	<glossdef>
3171	<para>Password of the user account specified with
3172	<computeroutput>--username</computeroutput>. If not given,
3173	an empty password is assumed.</para>
3174	</glossdef>
3175	</glossentry>
3176
3177	<glossentry>
3178	<glossterm><computeroutput>--dryrun</computeroutput></glossterm>
3179
3180	<glossdef>
3181	<para>Tells VBoxManage to only perform a dry run instead of
3182	really copying files to the guest.</para>
3183	</glossdef>
3184	</glossentry>
3185
3186	<glossentry>
3187	<glossterm><computeroutput>--follow</computeroutput></glossterm>
3188
3189	<glossdef>
3190	<para>Enables following symlinks on the host's
3191	source.</para>
3192	</glossdef>
3193	</glossentry>
3194
3195	<glossentry>
3196	<glossterm><computeroutput>--recursive</computeroutput></glossterm>
3197
3198	<glossdef>
3199	<para>Recursively copies files/directories of the specified
3200	source.</para>
3201	</glossdef>
3202	</glossentry>
3203
3204	<glossentry>
3205	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3206
3207	<glossdef>
3208	<para>Tells VBoxManage to be more verbose.</para>
3209	</glossdef>
3210	</glossentry>
3211
3212	<glossentry>
3213	<glossterm><computeroutput>--flags <flags></computeroutput></glossterm>
3214
3215	<glossdef>
3216	<para>Additional flags to set. This is not used at the
3217	moment.</para>
3218	</glossdef>
3219	</glossentry>
3220	</glosslist></para>
3221	</listitem>
3222
3223	<listitem>
3224	<para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>,
3225	which allows copying
3226	files from the guest to the host (only with installed Guest
3227	Additions 4.0 and later). It has the same parameters as
3228	<computeroutput>copyto</computeroutput> above.</para>
3229	</listitem>
3230
3231	<listitem>
3232	<para><emphasis role="bold"><computeroutput>createdirectory</computeroutput></emphasis>,
3233	which allows
3234	copying files from the host to the guest (only with installed Guest
3235	Additions 4.0 and later).</para>
3236
3237	<screen>VBoxManage guestcontrol <uuid\|vmname> createdir[ectory]\|mkdir\|md
3238	<guest directory>... --username <name>
3239	[--passwordfile <file> \| --password <password>]
3240	[--parents] [--mode <mode>] [--verbose]</screen>
3241
3242	<para>where the parameters mean: <glosslist>
3243	<glossentry>
3244	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3245
3246	<glossdef>
3247	<para>The VM UUID or VM name. Mandatory.</para>
3248	</glossdef>
3249	</glossentry>
3250
3251	<glossentry>
3252	<glossterm><computeroutput>directory to create on guest</computeroutput></glossterm>
3253
3254	<glossdef>
3255	<para>Absolute path of directory/directories to create on
3256	guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>.
3257	Parent directories need to exist (e.g. in this example
3258	<computeroutput>D:\Foo</computeroutput>) when switch
3259	<computeroutput>--parents</computeroutput> is omitted. The
3260	specified user must have appropriate rights to create the
3261	specified directory.</para>
3262	</glossdef>
3263	</glossentry>
3264
3265	<glossentry>
3266	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3267
3268	<glossdef>
3269	<para>Name of the user the copy process should run under.
3270	This user must exist on the guest OS.</para>
3271	</glossdef>
3272	</glossentry>
3273
3274	<glossentry>
3275	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3276
3277	<glossdef>
3278	<para>Password of the user account specified to be read from
3279	the given file. If not given, an empty password is
3280	assumed.</para>
3281	</glossdef>
3282	</glossentry>
3283
3284	<glossentry>
3285	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3286
3287	<glossdef>
3288	<para>Password of the user account specified with
3289	<computeroutput>--username</computeroutput>. If not given,
3290	an empty password is assumed.</para>
3291	</glossdef>
3292	</glossentry>
3293
3294	<glossentry>
3295	<glossterm><computeroutput>--parents</computeroutput></glossterm>
3296
3297	<glossdef>
3298	<para>Also creates not yet existing parent directories of
3299	the specified directory, e.g. if the directory
3300	<computeroutput>D:\Foo</computeroutput> of
3301	<computeroutput>D:\Foo\Bar</computeroutput> does not exist
3302	yet it will be created. Without specifying
3303	<computeroutput>--parent</computeroutput> the action would
3304	have failed.</para>
3305	</glossdef>
3306	</glossentry>
3307
3308	<glossentry>
3309	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
3310
3311	<glossdef>
3312	<para>Sets the permission mode of the specified directory.
3313	Only octal modes (e.g.
3314	<computeroutput>0755</computeroutput>) are supported right
3315	now.</para>
3316	</glossdef>
3317	</glossentry>
3318
3319	<glossentry>
3320	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3321
3322	<glossdef>
3323	<para>Tells VBoxManage to be more verbose.</para>
3324	</glossdef>
3325	</glossentry>
3326	</glosslist></para>
3327	</listitem>
3328
3329	<listitem>
3330	<para><emphasis role="bold"><computeroutput>removedirectory</computeroutput></emphasis>,
3331	which allows deletion of guest directories (only with installed Guest
3332	Additions 4.3.2 and later).</para>
3333
3334	<screen>VBoxManage guestcontrol <uuid\|vmname> removedir[ectory]\|rmdir
3335	<guest directory>... --username <name>
3336	[--passwordfile <file> \| --password <password>]
3337	[--recursive\|-R\|-r] [--verbose]</screen>
3338
3339	<para>where the parameters mean: <glosslist>
3340	<glossentry>
3341	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3342
3343	<glossdef>
3344	<para>The VM UUID or VM name. Mandatory.</para>
3345	</glossdef>
3346	</glossentry>
3347
3348	<glossentry>
3349	<glossterm><computeroutput>directory to remove on guest</computeroutput></glossterm>
3350
3351	<glossdef>
3352	<para>Absolute path of directory/directories to remove on
3353	guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>. The
3354	specified user must have appropriate rights to delete the
3355	specified guest directories.</para>
3356	</glossdef>
3357	</glossentry>
3358
3359	<glossentry>
3360	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3361
3362	<glossdef>
3363	<para>Name of the user the copy process should run under.
3364	This user must exist on the guest OS.</para>
3365	</glossdef>
3366	</glossentry>
3367
3368	<glossentry>
3369	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3370
3371	<glossdef>
3372	<para>Password of the user account specified to be read from
3373	the given file. If not given, an empty password is
3374	assumed.</para>
3375	</glossdef>
3376	</glossentry>
3377
3378	<glossentry>
3379	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3380
3381	<glossdef>
3382	<para>Password of the user account specified with
3383	<computeroutput>--username</computeroutput>. If not given,
3384	an empty password is assumed.</para>
3385	</glossdef>
3386	</glossentry>
3387
3388	<glossentry>
3389	<glossterm><computeroutput>--recursive</computeroutput></glossterm>
3390
3391	<glossdef>
3392	<para>Remove directories and their contents recursively.</para>
3393	</glossdef>
3394	</glossentry>
3395
3396	<glossentry>
3397	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3398
3399	<glossdef>
3400	<para>Tells VBoxManage to be more verbose.</para>
3401	</glossdef>
3402	</glossentry>
3403	</glosslist></para>
3404	</listitem>
3405
3406	<listitem>
3407	<para><emphasis role="bold"><computeroutput>removefile</computeroutput></emphasis>,
3408	which allows deletion of guest files (only with installed Guest
3409	Additions 4.3.2 and later).</para>
3410
3411	<screen>VBoxManage guestcontrol <uuid\|vmname> removefile\|rm
3412	<guest file>... --username <name>
3413	[--passwordfile <file> \| --password <password>]
3414	[--verbose]</screen>
3415
3416	<para>where the parameters mean: <glosslist>
3417	<glossentry>
3418	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3419
3420	<glossdef>
3421	<para>The VM UUID or VM name. Mandatory.</para>
3422	</glossdef>
3423	</glossentry>
3424
3425	<glossentry>
3426	<glossterm><computeroutput>file to remove on guest</computeroutput></glossterm>
3427
3428	<glossdef>
3429	<para>Absolute path of a file/files to remove on
3430	guest, e.g. <computeroutput>D:\Foo\Bar\text.txt</computeroutput>. The
3431	specified user must have appropriate rights to delete the
3432	specified guest files.</para>
3433	</glossdef>
3434	</glossentry>
3435
3436	<glossentry>
3437	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3438
3439	<glossdef>
3440	<para>Name of the user the copy process should run under.
3441	This user must exist on the guest OS.</para>
3442	</glossdef>
3443	</glossentry>
3444
3445	<glossentry>
3446	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3447
3448	<glossdef>
3449	<para>Password of the user account specified to be read from
3450	the given file. If not given, an empty password is
3451	assumed.</para>
3452	</glossdef>
3453	</glossentry>
3454
3455	<glossentry>
3456	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3457
3458	<glossdef>
3459	<para>Password of the user account specified with
3460	<computeroutput>--username</computeroutput>. If not given,
3461	an empty password is assumed.</para>
3462	</glossdef>
3463	</glossentry>
3464
3465	<glossentry>
3466	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3467
3468	<glossdef>
3469	<para>Tells VBoxManage to be more verbose.</para>
3470	</glossdef>
3471	</glossentry>
3472	</glosslist></para>
3473	</listitem>
3474
3475	<listitem>
3476	<para><emphasis role="bold"><computeroutput>ren[ame]\|mv</computeroutput></emphasis>,
3477	which allows renaming of guest files and/or directories (only with installed Guest
3478	Additions 4.3.2 and later).</para>
3479
3480	<screen>VBoxManage guestcontrol <uuid\|vmname> ren[ame]\|mv
3481	<source>... <dest> --username <name>
3482	[--passwordfile <file> \| --password <password>]
3483	[--verbose]</screen>
3484
3485	<para>where the parameters mean: <glosslist>
3486	<glossentry>
3487	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3488
3489	<glossdef>
3490	<para>The VM UUID or VM name. Mandatory.</para>
3491	</glossdef>
3492	</glossentry>
3493
3494	<glossentry>
3495	<glossterm><computeroutput>source</computeroutput></glossterm>
3496
3497	<glossdef>
3498	<para>Absolute path of one or more source(s) to move to
3499	destination. If more than one source is specified, destination
3500	must be an existing directory on the guest. The specified user
3501	must have appropriate rights to access source and destination
3502	files and directories.</para>
3503	</glossdef>
3504	</glossentry>
3505
3506	<glossentry>
3507	<glossterm><computeroutput>dest</computeroutput></glossterm>
3508
3509	<glossdef>
3510	<para>Absolute path of the destination to move the source(s)
3511	to. This can be a directory or a file, depending if one or more
3512	sources have been specified. The specified user
3513	must have appropriate rights to access the destination
3514	file and directory.</para>
3515	</glossdef>
3516	</glossentry>
3517
3518	<glossentry>
3519	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3520
3521	<glossdef>
3522	<para>Name of the user the copy process should run under.
3523	This user must exist on the guest OS.</para>
3524	</glossdef>
3525	</glossentry>
3526
3527	<glossentry>
3528	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3529
3530	<glossdef>
3531	<para>Password of the user account specified to be read from
3532	the given file. If not given, an empty password is
3533	assumed.</para>
3534	</glossdef>
3535	</glossentry>
3536
3537	<glossentry>
3538	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3539
3540	<glossdef>
3541	<para>Password of the user account specified with
3542	<computeroutput>--username</computeroutput>. If not given,
3543	an empty password is assumed.</para>
3544	</glossdef>
3545	</glossentry>
3546
3547	<glossentry>
3548	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3549
3550	<glossdef>
3551	<para>Tells VBoxManage to be more verbose.</para>
3552	</glossdef>
3553	</glossentry>
3554	</glosslist></para>
3555	</listitem>
3556
3557	<listitem>
3558	<para><emphasis role="bold"><computeroutput>createtemporary</computeroutput></emphasis>,
3559	which allows
3560	copying files from the host to the guest (only with installed Guest
3561	Additions 4.2 and later).</para>
3562
3563	<screen>VBoxManage guestcontrol <uuid\|vmname> createtemp[orary]\|mktemp
3564	<template> --username <name>
3565	[--passwordfile <file> \| --password <password>]
3566	[--directory] [--secure] [--tmpdir <directory>]
3567	[--domain <domain>] [--mode <mode>] [--verbose]</screen>
3568
3569	<para>where the parameters mean: <glosslist>
3570	<glossentry>
3571	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3572
3573	<glossdef>
3574	<para>The VM UUID or VM name. Mandatory.</para>
3575	</glossdef>
3576	</glossentry>
3577
3578	<glossentry>
3579	<glossterm><computeroutput>template</computeroutput></glossterm>
3580
3581	<glossdef>
3582	<para>A file name without a path and with at least three consecutive 'X'
3583	characters or ending in 'X'
3584	</para>
3585	</glossdef>
3586	</glossentry>
3587
3588	<glossentry>
3589	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3590
3591	<glossdef>
3592	<para>Name of the user the copy process should run under.
3593	This user must exist on the guest OS.</para>
3594	</glossdef>
3595	</glossentry>
3596
3597	<glossentry>
3598	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3599
3600	<glossdef>
3601	<para>Password of the user account specified to be read from
3602	the given file. If not given, an empty password is
3603	assumed.</para>
3604	</glossdef>
3605	</glossentry>
3606
3607	<glossentry>
3608	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3609
3610	<glossdef>
3611	<para>Password of the user account specified with
3612	<computeroutput>--username</computeroutput>. If not given,
3613	an empty password is assumed.</para>
3614	</glossdef>
3615	</glossentry>
3616
3617	<glossentry>
3618	<glossterm><computeroutput>--directory</computeroutput></glossterm>
3619
3620	<glossdef>
3621	<para>Create a temporary directory instead of a file.</para>
3622	</glossdef>
3623	</glossentry>
3624
3625	<glossentry>
3626	<glossterm><computeroutput>--secure</computeroutput></glossterm>
3627
3628	<glossdef>
3629	<para>
3630	Secure creation. The file mode is fixed to
3631	<computeroutput>0755</computeroutput>. And the operation
3632	will fail if it cannot performed securely.
3633	</para>
3634	</glossdef>
3635	</glossentry>
3636
3637	<glossentry>
3638	<glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm>
3639
3640	<glossdef>
3641	<para>
3642	Directory where the file / directory is created. If not
3643	specified, the platform-specific temp directory is used.
3644	</para>
3645	</glossdef>
3646	</glossentry>
3647
3648	<glossentry>
3649	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
3650
3651	<glossdef>
3652	<para>Sets the permission mode of the specified directory.
3653	Only octal modes (e.g.
3654	<computeroutput>0755</computeroutput>) are supported right
3655	now.</para>
3656	</glossdef>
3657	</glossentry>
3658
3659	<glossentry>
3660	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3661
3662	<glossdef>
3663	<para>Tells VBoxManage to be more verbose.</para>
3664	</glossdef>
3665	</glossentry>
3666	</glosslist></para>
3667	</listitem>
3668
3669	<listitem>
3670	<para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>,
3671	which lists various guest control information such as open guest sessions,
3672	guest processes and guest files.</para>
3673
3674	<screen>VBoxManage guestcontrol <uuid\|vmname> list
3675	<all\|sessions\|processes\|files> [--verbose]</screen>
3676
3677	<para>where the parameters mean: <glosslist>
3678	<glossentry>
3679	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3680
3681	<glossdef>
3682	<para>The VM UUID or VM name. Mandatory.</para>
3683	</glossdef>
3684	</glossentry>
3685
3686	<glossentry>
3687	<glossterm><computeroutput>all\|sessions\|processes\|files</computeroutput></glossterm>
3688
3689	<glossdef>
3690	<para>Whether to list guest sessions, guest processes, guest files
3691	or all information available. Mandatory.</para>
3692	</glossdef>
3693	</glossentry>
3694
3695	<glossentry>
3696	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3697
3698	<glossdef>
3699	<para>Tells VBoxManage to be more verbose.</para>
3700	</glossdef>
3701	</glossentry>
3702	</glosslist></para>
3703	</listitem>
3704
3705	<listitem>
3706	<para><emphasis role="bold"><computeroutput>process kill</computeroutput></emphasis>,
3707	which terminates specific guest processes of a guest session, based on either the
3708	session's ID or the session's name.</para>
3709
3710	<screen>VBoxManage guestcontrol <uuid\|vmname> process kill
3711	--session-id <ID>
3712	\| --session-name <name or pattern>
3713	[--verbose]
3714	<PID> ... <PID n></screen>
3715
3716	<para>where the parameters mean: <glosslist>
3717	<glossentry>
3718	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3719
3720	<glossdef>
3721	<para>The VM UUID or VM name. Mandatory.</para>
3722	</glossdef>
3723	</glossentry>
3724
3725	<glossentry>
3726	<glossterm><computeroutput>--session-id</computeroutput></glossterm>
3727
3728	<glossdef>
3729	<para>Specifies the guest session to use by its ID.</para>
3730	</glossdef>
3731	</glossentry>
3732
3733	<glossentry>
3734	<glossterm><computeroutput>--session-name</computeroutput></glossterm>
3735
3736	<glossdef>
3737	<para>Specifies the guest session to use by its name. Multiple
3738	sessions can be closed when specifying * or ? wildcards.</para>
3739	</glossdef>
3740	</glossentry>
3741
3742	<glossentry>
3743	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3744
3745	<glossdef>
3746	<para>Tells VBoxManage to be more verbose.</para>
3747	</glossdef>
3748	</glossentry>
3749
3750	<glossentry>
3751	<glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm>
3752
3753	<glossdef>
3754	<para>List of process identifiers (PIDs) to terminate.</para>
3755	</glossdef>
3756	</glossentry>
3757	</glosslist></para>
3758	</listitem>
3759
3760	<listitem>
3761	<para><emphasis role="bold"><computeroutput>[p[s]]kill</computeroutput></emphasis>,
3762	which terminates specific guest processes of a guest session, based on either the
3763	session's ID or the session's name.</para>
3764
3765	<screen>VBoxManage guestcontrol <uuid\|vmname> process kill
3766	--session-id <ID>
3767	\| --session-name <name or pattern>
3768	[--verbose]
3769	<PID> ... <PID n></screen>
3770
3771	<para>where the parameters mean: <glosslist>
3772	<glossentry>
3773	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3774
3775	<glossdef>
3776	<para>The VM UUID or VM name. Mandatory.</para>
3777	</glossdef>
3778	</glossentry>
3779
3780	<glossentry>
3781	<glossterm><computeroutput>--session-id</computeroutput></glossterm>
3782
3783	<glossdef>
3784	<para>Specifies the guest session to use by its ID.</para>
3785	</glossdef>
3786	</glossentry>
3787
3788	<glossentry>
3789	<glossterm><computeroutput>--session-name</computeroutput></glossterm>
3790
3791	<glossdef>
3792	<para>Specifies the guest session to use by its name. Multiple
3793	sessions can be closed when specifying * or ? wildcards.</para>
3794	</glossdef>
3795	</glossentry>
3796
3797	<glossentry>
3798	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3799
3800	<glossdef>
3801	<para>Tells VBoxManage to be more verbose.</para>
3802	</glossdef>
3803	</glossentry>
3804
3805	<glossentry>
3806	<glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm>
3807
3808	<glossdef>
3809	<para>List of process identifiers (PIDs) to terminate.</para>
3810	</glossdef>
3811	</glossentry>
3812	</glosslist></para>
3813	</listitem>
3814
3815	<listitem>
3816	<para><emphasis role="bold"><computeroutput>session close</computeroutput></emphasis>,
3817	which closes specific guest sessions, based on either the session's ID or the
3818	session's name.</para>
3819
3820	<screen>VBoxManage guestcontrol <uuid\|vmname> session close
3821	--session-id <ID>
3822	\| --session-name <name or pattern>
3823	\| --all
3824	[--verbose]</screen>
3825
3826	<para>where the parameters mean: <glosslist>
3827	<glossentry>
3828	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3829
3830	<glossdef>
3831	<para>The VM UUID or VM name. Mandatory.</para>
3832	</glossdef>
3833	</glossentry>
3834
3835	<glossentry>
3836	<glossterm><computeroutput>--session-id</computeroutput></glossterm>
3837
3838	<glossdef>
3839	<para>Close a guest session specified by its ID.</para>
3840	</glossdef>
3841	</glossentry>
3842
3843	<glossentry>
3844	<glossterm><computeroutput>--session-name</computeroutput></glossterm>
3845
3846	<glossdef>
3847	<para>Close a guest session specified by its name. Multiple sessions
3848	can be closed when specifying * or ? wildcards.</para>
3849	</glossdef>
3850	</glossentry>
3851
3852	<glossentry>
3853	<glossterm><computeroutput>--all</computeroutput></glossterm>
3854
3855	<glossdef>
3856	<para>Close all guest sessions.</para>
3857	</glossdef>
3858	</glossentry>
3859
3860	<glossentry>
3861	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3862
3863	<glossdef>
3864	<para>Tells VBoxManage to be more verbose.</para>
3865	</glossdef>
3866	</glossentry>
3867	</glosslist></para>
3868	</listitem>
3869
3870	<listitem>
3871	<para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>,
3872	which displays file
3873	or file system status on the guest.</para>
3874
3875	<screen>VBoxManage guestcontrol <uuid\|vmname> stat
3876	<file>... --username <name>
3877	[--passwordfile <file> \| --password <password>]
3878	[--verbose]</screen>
3879
3880	<para>where the parameters mean: <glosslist>
3881	<glossentry>
3882	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3883
3884	<glossdef>
3885	<para>The VM UUID or VM name. Mandatory.</para>
3886	</glossdef>
3887	</glossentry>
3888
3889	<glossentry>
3890	<glossterm><computeroutput>file element(s) to check on guest</computeroutput></glossterm>
3891
3892	<glossdef>
3893	<para>Absolute path of directory/directories to check on
3894	guest, e.g. <computeroutput>/home/foo/a.out</computeroutput>.
3895	The specified user must have appropriate rights to access
3896	the given file element(s).</para>
3897	</glossdef>
3898	</glossentry>
3899
3900	<glossentry>
3901	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
3902
3903	<glossdef>
3904	<para>Name of the user the copy process should run under.
3905	This user must exist on the guest OS.</para>
3906	</glossdef>
3907	</glossentry>
3908
3909	<glossentry>
3910	<glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm>
3911
3912	<glossdef>
3913	<para>Password of the user account specified to be read from
3914	the given file. If not given, an empty password is
3915	assumed.</para>
3916	</glossdef>
3917	</glossentry>
3918
3919	<glossentry>
3920	<glossterm><computeroutput>--password <password></computeroutput></glossterm>
3921
3922	<glossdef>
3923	<para>Password of the user account specified with
3924	<computeroutput>--username</computeroutput>. If not given,
3925	an empty password is assumed.</para>
3926	</glossdef>
3927	</glossentry>
3928
3929	<glossentry>
3930	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3931
3932	<glossdef>
3933	<para>Tells VBoxManage to be more verbose.</para>
3934	</glossdef>
3935	</glossentry>
3936	</glosslist></para>
3937	</listitem>
3938
3939	<listitem>
3940	<para><emphasis role="bold"><computeroutput>updateadditions</computeroutput></emphasis>,
3941	which allows
3942	for updating an already installed Guest Additions version on the
3943	guest (only already installed Guest Additions 4.0 and later).</para>
3944
3945	<screen>VBoxManage guestcontrol <uuid\|vmname> updateadditions
3946	[--source "<guest additions .ISO file to use>"] [--verbose]
3947	[--wait-start] [-- [<argument1>] ... [<argumentN>]]</screen>
3948
3949	<para>where the parameters mean: <glosslist>
3950	<glossentry>
3951	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3952
3953	<glossdef>
3954	<para>The VM UUID or VM name. Mandatory.</para>
3955	</glossdef>
3956	</glossentry>
3957
3958	<glossentry>
3959	<glossterm><computeroutput>--source</computeroutput> "<guest additions .ISO file to
3960	use>"</glossterm>
3961
3962	<glossdef>
3963	<para>Full path to an alternative VirtualBox Guest Additions
3964	.ISO file to use for the Guest Additions update.</para>
3965	</glossdef>
3966	</glossentry>
3967
3968	<glossentry>
3969	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
3970
3971	<glossdef>
3972	<para>Tells VBoxManage to be more verbose.</para>
3973	</glossdef>
3974	</glossentry>
3975
3976	<glossentry>
3977	<glossterm><computeroutput>--wait-start</computeroutput></glossterm>
3978	<glossdef>
3979	<para>Starts the regular updating process and waits until the
3980	actual Guest Additions update inside the guest was started.
3981	This can be necessary due to needed interaction with the
3982	guest OS during the installation phase.</para>
3983	<para>When omitting this flag VBoxManage will wait for the
3984	whole Guest Additions update to complete.</para>
3985	</glossdef>
3986	</glossentry>
3987
3988	<glossentry>
3989	<glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm>
3990
3991	<glossdef>
3992	<para>Optional command line arguments to use for the Guest Additions
3993	installer. Useful for retrofitting features which weren't installed
3994	before on the guest.</para>
3995	<para>Arguments containing spaces must be enclosed in
3996	quotation marks.</para>
3997	</glossdef>
3998	</glossentry>
3999	</glosslist></para>
4000	</listitem>
4001	<listitem>
4002	<para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>,
4003	which prints current guest control activity.</para>
4004
4005	<screen>VBoxManage guestcontrol <uuid\|vmname> watch
4006	[--verbose]</screen>
4007
4008	<para>where the parameters mean: <glosslist>
4009	<glossentry>
4010	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
4011
4012	<glossdef>
4013	<para>The VM UUID or VM name. Mandatory.</para>
4014	</glossdef>
4015	</glossentry>
4016
4017	<glossentry>
4018	<glossterm><computeroutput>--verbose</computeroutput></glossterm>
4019
4020	<glossdef>
4021	<para>Tells VBoxManage to be more verbose.</para>
4022	</glossdef>
4023	</glossentry>
4024	</glosslist></para>
4025	</listitem>
4026	</itemizedlist></para>
4027	</sect1>
4028
4029	<sect1 id="vboxmanage-debugvm">
4030	<title>VBoxManage debugvm</title>
4031
4032	<para>The "debugvm" commands are for experts who want to tinker with the
4033	exact details of virtual machine execution. Like the VM debugger described
4034	in <xref linkend="ts_debugger" />, these commands are only useful if you are
4035	very familiar with the details of the PC architecture and how to debug
4036	software.</para>
4037
4038	<para>The subcommands of "debugvm" all operate on a running virtual
4039	machine. The following are available:<itemizedlist>
4040	<listitem>
4041	<para>With <computeroutput>dumpguestcore --filename
4042	<name></computeroutput>, you can create a system dump of the
4043	running VM, which will be written into the given file. This file
4044	will have the standard ELF core format (with custom sections); see
4045	<xref linkend="ts_guest-core-format" />.</para>
4046
4047	<para>This corresponds to the
4048	<computeroutput>writecore</computeroutput> command in the debugger.
4049	</para>
4050	</listitem>
4051
4052	<listitem>
4053	<para>The <computeroutput>info</computeroutput> command is used to
4054	display info items relating to the VMM, device emulations and
4055	associated drivers. This command takes one or two arguments: the
4056	name of the info item, optionally followed by a string containing
4057	arguments specific to the info item.
4058	The <computeroutput>help</computeroutput> info item provides a
4059	listning of the available items and hints about any optional
4060	arguments.</para>
4061
4062	<para>This corresponds to the <computeroutput>info</computeroutput>
4063	command in the debugger.</para>
4064	</listitem>
4065
4066	<listitem>
4067	<para>The <computeroutput>injectnmi</computeroutput> command causes
4068	a non-maskable interrupt (NMI) in the guest, which might be useful
4069	for certain debugging scenarios. What happens exactly is dependent
4070	on the guest operating system, but an NMI can crash the whole guest
4071	operating system. Do not use unless you know what you're
4072	doing.</para>
4073	</listitem>
4074
4075	<listitem>
4076	<para>The <computeroutput>osdetect</computeroutput> command makes the
4077	VMM's debugger facility (re-)detection the guest operation
4078	system.</para>
4079
4080	<para>This corresponds to the <computeroutput>detect</computeroutput>
4081	command in the debugger.</para>
4082	</listitem>
4083
4084	<listitem>
4085	<para>The <computeroutput>osinfo</computeroutput> command is used to
4086	display info about the operating system (OS) detected by the VMM's
4087	debugger facility.</para>
4088	</listitem>
4089
4090	<listitem>
4091	<para>The <computeroutput>getregisters</computeroutput> command is
4092	used to display CPU and device registers. The command takes a list
4093	of registers, each having one of the following forms:
4094	<itemizedlist>
4095	<listitem><computeroutput>register-set.register-name.sub-field</computeroutput></listitem>
4096	<listitem><computeroutput>register-set.register-name</computeroutput></listitem>
4097	<listitem><computeroutput>cpu-register-name.sub-field</computeroutput></listitem>
4098	<listitem><computeroutput>cpu-register-name</computeroutput></listitem>
4099	<listitem><computeroutput>all</computeroutput></listitem>
4100	</itemizedlist>
4101	The <computeroutput>all</computeroutput> form will cause all
4102	registers to be shown (no sub-fields). The registers names are
4103	case-insensitive. When requesting a CPU register the register set
4104	can be omitted, it will be selected using the value of the
4105	<computeroutput>--cpu</computeroutput> option (defaulting to 0).
4106	</para>
4107	</listitem>
4108
4109	<listitem>
4110	<para>The <computeroutput>setregisters</computeroutput> command is
4111	used to change CPU and device registers. The command takes a list
4112	of register assignments, each having one of the following forms:
4113	<itemizedlist>
4114	<listitem><computeroutput>register-set.register-name.sub-field=value</computeroutput></listitem>
4115	<listitem><computeroutput>register-set.register-name=value</computeroutput></listitem>
4116	<listitem><computeroutput>cpu-register-name.sub-field=value</computeroutput></listitem>
4117	<listitem><computeroutput>cpu-register-name=value</computeroutput></listitem>
4118	</itemizedlist>
4119	The value format should be in the same style as what
4120	<computeroutput>getregisters</computeroutput> displays, with the
4121	exception that both octal and decimal can be used instead of
4122	hexadecimal. The register naming and the default CPU register set
4123	are handled the same way as with the
4124	<computeroutput>getregisters</computeroutput> command.</para>
4125	</listitem>
4126
4127	<listitem>
4128	<para>The <computeroutput>statistics</computeroutput> command can be
4129	used to display VMM statistics on the command line. The
4130	<computeroutput>--reset</computeroutput> option will reset
4131	statistics. The affected statistics can be filtered with the
4132	<computeroutput>--pattern</computeroutput> option, which accepts
4133	DOS/NT-style wildcards (<computeroutput>?</computeroutput> and
4134	<computeroutput>*</computeroutput>).</para>
4135	</listitem>
4136	</itemizedlist></para>
4137	</sect1>
4138
4139	<sect1 id="metrics">
4140	<title>VBoxManage metrics</title>
4141
4142	<para>This command supports monitoring the usage of system resources.
4143	Resources are represented by various metrics associated with the host
4144	system or a particular VM. For example, the host system has a
4145	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
4146	percentage of time CPUs spend executing in user mode over a specific
4147	sampling period.</para>
4148
4149	<para>Metric data is collected and retained internally; it may be
4150	retrieved at any time with the <computeroutput>VBoxManage metrics
4151	query</computeroutput> subcommand. The data is available as long as the
4152	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
4153	process terminates shortly after all VMs and frontends have been
4154	closed.</para>
4155
4156	<para>By default no metrics are collected at all. Metrics collection does
4157	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
4158	is invoked with a proper sampling interval and the number of metrics to be
4159	retained. The interval is measured in seconds. For example, to enable
4160	collecting the host processor and memory usage metrics every second and
4161	keeping the 5 most current samples, the following command can be
4162	used:</para>
4163
4164	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
4165
4166	<para>Metric collection can only be enabled for started VMs. Collected
4167	data and collection settings for a particular VM will disappear as soon as
4168	it shuts down. Use <computeroutput>VBoxManage metrics list
4169	</computeroutput> subcommand to see which metrics are currently available.
4170	You can also use <computeroutput>--list</computeroutput> option with any
4171	subcommand that modifies metric settings to find out which metrics were
4172	affected.</para>
4173
4174	<para>Note that the <computeroutput>VBoxManage metrics
4175	setup</computeroutput> subcommand discards all samples that may have been
4176	previously collected for the specified set of objects and metrics.</para>
4177
4178	<para>To enable or disable metrics collection without discarding the data
4179	<computeroutput>VBoxManage metrics enable</computeroutput> and
4180	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
4181	can be used. Note that these subcommands expect metrics, not submetrics,
4182	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
4183	other words enabling <code>CPU/Load/User</code> while disabling
4184	<code>CPU/Load/Kernel</code> is not supported.</para>
4185
4186	<para>The host and VMs have different sets of associated metrics.
4187	Available metrics can be listed with <computeroutput>VBoxManage metrics
4188	list</computeroutput> subcommand.</para>
4189
4190	<para>A complete metric name may include an aggregate function. The name
4191	has the following form:
4192	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
4193	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
4194	for the minimum amount of available memory over all retained data if
4195	applied to the host object.</para>
4196
4197	<para>Subcommands may apply to all objects and metrics or can be limited
4198	to one object or/and a list of metrics. If no objects or metrics are given
4199	in the parameters, the subcommands will apply to all available metrics of
4200	all objects. You may use an asterisk
4201	("<computeroutput>*</computeroutput>") to explicitly specify that the
4202	command should be applied to all objects or metrics. Use "host" as the
4203	object name to limit the scope of the command to host-related metrics. To
4204	limit the scope to a subset of metrics, use a metric list with names
4205	separated by commas.</para>
4206
4207	<para>For example, to query metric data on the CPU time spent in user and
4208	kernel modes by the virtual machine named "test", you can use the
4209	following command:</para>
4210
4211	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
4212
4213	<para>The following list summarizes the available subcommands:</para>
4214
4215	<glosslist>
4216	<glossentry>
4217	<glossterm><computeroutput>list</computeroutput></glossterm>
4218
4219	<glossdef>
4220	<para>This subcommand shows the parameters of the currently existing
4221	metrics. Note that VM-specific metrics are only available when a
4222	particular VM is running.</para>
4223	</glossdef>
4224	</glossentry>
4225
4226	<glossentry>
4227	<glossterm><computeroutput>setup</computeroutput></glossterm>
4228
4229	<glossdef>
4230	<para>This subcommand sets the interval between taking two samples
4231	of metric data and the number of samples retained internally. The
4232	retained data is available for displaying with the
4233	<code>query</code> subcommand. The <computeroutput>--list
4234	</computeroutput> option shows which metrics have been modified as
4235	the result of the command execution.</para>
4236	</glossdef>
4237	</glossentry>
4238
4239	<glossentry>
4240	<glossterm><computeroutput>enable</computeroutput></glossterm>
4241
4242	<glossdef>
4243	<para>This subcommand "resumes" data collection after it has been
4244	stopped with <code>disable</code> subcommand. Note that specifying
4245	submetrics as parameters will not enable underlying metrics. Use
4246	<computeroutput>--list</computeroutput> to find out if the command
4247	did what was expected.</para>
4248	</glossdef>
4249	</glossentry>
4250
4251	<glossentry>
4252	<glossterm><computeroutput>disable</computeroutput></glossterm>
4253
4254	<glossdef>
4255	<para>This subcommand "suspends" data collection without affecting
4256	collection parameters or collected data. Note that specifying
4257	submetrics as parameters will not disable underlying metrics. Use
4258	<computeroutput>--list</computeroutput> to find out if the command
4259	did what was expected.</para>
4260	</glossdef>
4261	</glossentry>
4262
4263	<glossentry>
4264	<glossterm><computeroutput>query</computeroutput></glossterm>
4265
4266	<glossdef>
4267	<para>This subcommand retrieves and displays the currently retained
4268	metric data.<note>
4269	<para>The <code>query</code> subcommand does not remove or
4270	"flush" retained data. If you query often enough you will see
4271	how old samples are gradually being "phased out" by new
4272	samples.</para>
4273	</note></para>
4274	</glossdef>
4275	</glossentry>
4276
4277	<glossentry>
4278	<glossterm><computeroutput>collect</computeroutput></glossterm>
4279
4280	<glossdef>
4281	<para>This subcommand sets the interval between taking two samples
4282	of metric data and the number of samples retained internally. The
4283	collected data is displayed periodically until Ctrl-C is pressed
4284	unless the <computeroutput>--detach</computeroutput> option is
4285	specified. With the <computeroutput>--detach</computeroutput>
4286	option, this subcommand operates the same way as <code>setup</code>
4287	does. The <computeroutput>--list</computeroutput> option shows which
4288	metrics match the specified filter.</para>
4289	</glossdef>
4290	</glossentry>
4291	</glosslist>
4292	</sect1>
4293
4294	<sect1>
4295	<title>VBoxManage hostonlyif</title>
4296
4297	<para>With "hostonlyif" you can change the IP configuration of a host-only
4298	network interface. For a description of host-only networking, please
4299	refer to <xref linkend="network_hostonly" />. Each host-only interface is
4300	identified by a name and can either use the internal DHCP server or a
4301	manual IP configuration (both IP4 and IP6).</para>
4302	</sect1>
4303
4304	<sect1 id="vboxmanage-dhcpserver">
4305	<title>VBoxManage dhcpserver</title>
4306
4307	<para>The "dhcpserver" commands allow you to control the DHCP server that
4308	is built into VirtualBox. You may find this useful when using internal or
4309	host-only networking. (Theoretically, you can enable it for a bridged
4310	network as well, but that will likely cause conflicts with other DHCP
4311	servers in your physical network.)</para>
4312
4313	<para>Use the following command line options:<itemizedlist>
4314	<listitem>
4315	<para>If you use internal networking for a virtual network adapter
4316	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
4317	--netname <network_name></computeroutput>, where
4318	<computeroutput><network_name></computeroutput> is the same
4319	network name you used with <computeroutput>VBoxManage modifyvm
4320	<vmname> --intnet<X>
4321	<network_name></computeroutput>.</para>
4322	</listitem>
4323
4324	<listitem>
4325	<para>If you use host-only networking for a virtual network adapter
4326	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
4327	--ifname <hostonly_if_name></computeroutput> instead, where
4328	<computeroutput><hostonly_if_name></computeroutput> is the
4329	same host-only interface name you used with
4330	<computeroutput>VBoxManage modifyvm <vmname>
4331	--hostonlyadapter<X>
4332	<hostonly_if_name></computeroutput>.</para>
4333
4334	<para>Alternatively, you can also use the --netname option as with
4335	internal networks if you know the host-only network's name; you can
4336	see the names with <computeroutput>VBoxManage list
4337	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
4338	above).</para>
4339	</listitem>
4340	</itemizedlist></para>
4341
4342	<para>The following additional parameters are required when first adding a
4343	DHCP server:<itemizedlist>
4344	<listitem>
4345	<para>With <computeroutput>--ip</computeroutput>, specify the IP
4346	address of the DHCP server itself.</para>
4347	</listitem>
4348
4349	<listitem>
4350	<para>With <computeroutput>--netmask</computeroutput>, specify the
4351	netmask of the network.</para>
4352	</listitem>
4353
4354	<listitem>
4355	<para>With <computeroutput>--lowerip</computeroutput> and
4356	<computeroutput>--upperip</computeroutput>, you can specify the
4357	lowest and highest IP address, respectively, that the DHCP server
4358	will hand out to clients.</para>
4359	</listitem>
4360	</itemizedlist></para>
4361
4362	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
4363	or the DHCP server will be created in the disabled state, doing
4364	nothing.</para>
4365
4366	<para>After this, VirtualBox will automatically start the DHCP server for
4367	given internal or host-only network as soon as the first virtual machine
4368	which uses that network is started.</para>
4369
4370	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
4371	remove</computeroutput> with the given <computeroutput>--netname
4372	<network_name></computeroutput> or <computeroutput>--ifname
4373	<hostonly_if_name></computeroutput> to remove the DHCP server again
4374	for the given internal or host-only network.</para>
4375
4376	<para>To modify the settings of a DHCP server created earlier with
4377	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
4378	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
4379	network or host-only interface name.</para>
4380	</sect1>
4381
4382	<sect1 id="vboxmanage-extpack">
4383	<title>VBoxManage extpack</title>
4384
4385	<para>The "extpack" command allows you to add or remove VirtualBox
4386	extension packs, as described in <xref
4387	linkend="intro-installing" />.<itemizedlist>
4388	<listitem>
4389	<para>To add a new extension pack, use <computeroutput>VBoxManage
4390	extpack install <.vbox-extpack></computeroutput>. This command
4391	will fail if an older version of the same extension pack is already
4392	installed. The optional <computeroutput>--replace</computeroutput>
4393	parameter can be used to uninstall the old package before the new
4394	package is installed.</para>
4395	</listitem>
4396
4397	<listitem>
4398	<para>To remove a previously installed extension pack, use
4399	<computeroutput>VBoxManage extpack uninstall
4400	<name></computeroutput>. You can use
4401	<computeroutput>VBoxManage list extpacks</computeroutput> to show
4402	the names of the extension packs which are currently installed;
4403	please see <xref linkend="vboxmanage-list" /> also. The optional
4404	<computeroutput>--force</computeroutput> parameter can be used to
4405	override the refusal of an extension pack to be uninstalled.</para>
4406	</listitem>
4407
4408	<listitem>
4409	<para>The <computeroutput>VBoxManage extpack
4410	cleanup</computeroutput> command can be used to remove temporary
4411	files and directories that may have been left behind if a previous
4412	install or uninstall command failed.</para>
4413	</listitem>
4414	</itemizedlist></para>
4415	<para>The following commands show examples how to list extension packs and
4416	remove one:<screen>
4417	$ VBoxManage list extpacks
4418	Extension Packs: 1
4419	Pack no. 0: Oracle VM VirtualBox Extension Pack
4420	Version: 4.1.12
4421	Revision: 77218
4422	Edition:
4423	Description: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support.
4424	VRDE Module: VBoxVRDP
4425	Usable: true
4426	Why unusable:
4427	$ VBoxManage extpack uninstall "Oracle VM VirtualBox Extension Pack"
4428	0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
4429	Successfully uninstalled "Oracle VM VirtualBox Extension Pack".</screen></para>
4430	</sect1>
4431	</chapter>

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

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

以其他格式下載: