user_VBoxManage.xml@ 49313

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

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

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

以其他格式下載: