user_VBoxManage.xml@ 56035

最後變更在這個檔案從56035是 55959,由 vboxsync 提交於 10 年前
Started updating the guestcontrol docs.
檔案大小: 202.9 KB

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

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

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

以其他格式下載: