user_VBoxManage.xml@ 37961

最後變更在這個檔案從37961是 37929,由 vboxsync 提交於 13 年前
Frontends/VBoxManage: make --port and --device parameter for storageattach optional if there is only one port or device per port
檔案大小: 142.3 KB

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

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

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

以其他格式下載: