user_VBoxManage.xml@ 43532

最後變更在這個檔案從43532是 43532,由 vboxsync 提交於 12 年前
VBoxManage: fixed copy-and-paste bug; document 'storageattach --nonrotational'
檔案大小: 155.1 KB

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

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

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

以其他格式下載: