user_VBoxManage.xml@ 32780

最後變更在這個檔案從32780是 31735,由 vboxsync 提交於 14 年前
export the manual to OSE
檔案大小: 110.2 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 control VM operation, use one of the following:<itemizedlist>
109	<listitem>
110	<para>To start a VM that is currently powered off, use
111	<computeroutput>VBoxManage startvm</computeroutput>; see <xref
112	linkend="vboxmanage-startvm" /> for details.</para>
113	</listitem>
114
115	<listitem>
116	<para>To pause or save a VM that is currently running or change
117	some of its settings, use <computeroutput>VBoxManage
118	controlvm</computeroutput>; see <xref
119	linkend="vboxmanage-controlvm" /> for details.</para>
120	</listitem>
121	</itemizedlist></para>
122	</listitem>
123	</itemizedlist>
124	</sect1>
125
126	<sect1>
127	<title>Commands overview</title>
128
129	<para>When running VBoxManage without parameters or when supplying an
130	invalid command line, the below syntax diagram will be shown. Note that
131	the output will be slightly different depending on the host platform; when
132	in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
133	for the commands available on your particular host.</para>
134
135	<screen>$VBOX_MANAGE_OUTPUT</screen>
136
137	<para>Each time VBoxManage is invoked, only one command can be executed.
138	However, a command might support several subcommands which then can be
139	invoked in one single call. The following sections provide detailed
140	reference information on the different commands.</para>
141	</sect1>
142
143	<sect1 id="vboxmanage-list">
144	<title>VBoxManage list</title>
145
146	<para>The <computeroutput>list</computeroutput> command gives relevant
147	information about your system and information about VirtualBox's current
148	settings.</para>
149
150	<para>The following subcommands are available with
151	<computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
152	<listitem>
153	<para><computeroutput>vms</computeroutput> lists all virtual
154	machines currently registered with VirtualBox. By default this
155	displays a compact list with each VM's name and UUID; if you also
156	specify <computeroutput>--long</computeroutput> or
157	<computeroutput>-l</computeroutput>, this will be a detailed list as
158	with the <computeroutput>showvminfo</computeroutput> command (see
159	below).</para>
160	</listitem>
161
162	<listitem>
163	<para><computeroutput>runningvms</computeroutput> lists all
164	currently running virtual machines by their unique identifiers
165	(UUIDs) in the same format as with
166	<computeroutput>vms</computeroutput>.</para>
167	</listitem>
168
169	<listitem>
170	<para><computeroutput>hdds</computeroutput>,
171	<computeroutput>dvds</computeroutput> and
172	<computeroutput>floppies</computeroutput> all give you information
173	about virtual disk images currently registered in VirtualBox,
174	including all their settings, the unique identifiers (UUIDs)
175	associated with them by VirtualBox and all files associated with
176	them.</para>
177	</listitem>
178
179	<listitem>
180	<para><computeroutput>ostypes</computeroutput> lists all guest
181	operating systems presently known to VirtualBox, along with the
182	identifiers used to refer to them with the
183	<computeroutput>modifyvm</computeroutput> command.</para>
184	</listitem>
185
186	<listitem>
187	<para><computeroutput>hostdvds</computeroutput>,
188	<computeroutput>hostfloppies</computeroutput> and
189	<computeroutput>hostifs</computeroutput>, respectively, list DVD,
190	floppy and host networking interfaces on the host, along with the
191	name used to access them from within VirtualBox.</para>
192	</listitem>
193
194	<listitem>
195	<para><computeroutput>hostusb</computeroutput> supplies information
196	about USB devices attached to the host, notably information useful
197	for constructing USB filters and whether they are currently in use
198	by the host.</para>
199	</listitem>
200
201	<listitem>
202	<para><computeroutput>usbfilters</computeroutput> lists all global
203	USB filters registered with VirtualBox -- that is, filters for
204	devices which are accessible to all virtual machines -- and displays
205	the filter parameters.</para>
206	</listitem>
207
208	<listitem>
209	<para><computeroutput>systemproperties</computeroutput> displays
210	some global VirtualBox settings, such as minimum and maximum guest
211	RAM and virtual hard disk size, folder settings and the current
212	authentication library in use.</para>
213	</listitem>
214
215	<listitem>
216	<para><computeroutput>hddbackends</computeroutput> lists all known
217	hdd backends of VirtualBox. Beside the name of the backend itself,
218	descriptions about the capabilities, configuration and other useful
219	informations are displayed.</para>
220	</listitem>
221	</itemizedlist></para>
222	</sect1>
223
224	<sect1 id="vboxmanage-showvminfo">
225	<title>VBoxManage showvminfo</title>
226
227	<para>The <computeroutput>showvminfo</computeroutput> command shows
228	information about a particular virtual machine. This is the same
229	information as <computeroutput>VBoxManage list vms --long</computeroutput>
230	would show for all virtual machines.</para>
231
232	<para>You will get information similar to the following:</para>
233
234	<para><screen>$ VBoxManage showvminfo "Windows XP"
235	VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
236	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
237	All rights reserved.
238
239	Name: Windows XP
240	Guest OS: Other/Unknown
241	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
242	Config file: /home/username/.VirtualBox/Machines/Windows XP/Windows XP.xml
243	Memory size: 512MB
244	VRAM size: 12MB
245	Number of CPUs: 2
246	Synthetic Cpu: off
247	Boot menu mode: message and menu
248	Boot Device (1): DVD
249	Boot Device (2): HardDisk
250	Boot Device (3): Not Assigned
251	Boot Device (4): Not Assigned
252	ACPI: on
253	IOAPIC: on
254	PAE: on
255	Time offset: 0 ms
256	Hardw. virt.ext: on
257	Hardw. virt.ext exclusive: on
258	Nested Paging: on
259	VT-x VPID: off
260	State: powered off (since 2009-10-20T14:52:19.000000000)
261	Monitor count: 1
262	3D Acceleration: off
263	2D Video Acceleration: off
264	Teleporter Enabled: off
265	Teleporter Port: 0
266	Teleporter Address:
267	Teleporter Password:
268	Storage Controller (0): IDE Controller
269	Storage Controller Type (0): PIIX4
270	Storage Controller (1): Floppy Controller 1
271	Storage Controller Type (1): I82078
272	IDE Controller (0, 0): /home/user/windows.vdi (UUID: 46f6e53a-4557-460a-9b95-68b0f17d744b)
273	IDE Controller (0, 1): /home/user/openbsd-cd46.iso (UUID: 4335e162-59d3-4512-91d5-b63e94eebe0b)
274	Floppy Controller 1 (0, 0): /home/user/floppy.img (UUID: 62ac6ccb-df36-42f2-972e-22f836368137)
275	NIC 1: disabled
276	NIC 2: disabled
277	NIC 3: disabled
278	NIC 4: disabled
279	NIC 5: disabled
280	NIC 6: disabled
281	NIC 7: disabled
282	NIC 8: disabled
283	UART 1: disabled
284	UART 2: disabled
285	Audio: disabled (Driver: Unknown)
286	Clipboard Mode: Bidirectional
287	VRDP: disabled
288	USB: disabled
289
290	USB Device Filters:
291	<none>
292
293	Shared folders:
294	<none>
295
296	Statistics update: disabled
297	</screen></para>
298	</sect1>
299
300	<sect1>
301	<title>VBoxManage registervm / unregistervm</title>
302
303	<para>The <computeroutput>registervm</computeroutput> command allows you
304	to import a virtual machine definition in an XML file into VirtualBox. The
305	machine must not conflict with one already registered in VirtualBox and it
306	may not have any hard or removable disks attached. It is advisable to
307	place the definition file in the machines folder before registering
308	it.<note>
309	<para>When creating a new virtual machine with
310	<computeroutput>VBoxManage createvm</computeroutput> (see below), you
311	can directly specify the <computeroutput>--register</computeroutput>
312	option to avoid having to register it separately.</para>
313	</note></para>
314
315	<para>The <computeroutput>unregistervm</computeroutput> command
316	unregisters a virtual machine. If
317	<computeroutput>--delete</computeroutput> is also specified, the following
318	files will automatically be deleted as well:<orderedlist>
319	<listitem>
320	<para>all hard disk image files, including differencing files, which
321	are used by the machine and not shared with other machines;</para>
322	</listitem>
323
324	<listitem>
325	<para>saved state files that the machine created, if any (one if the
326	machine was in "saved" state and one for each online
327	snapshot);</para>
328	</listitem>
329
330	<listitem>
331	<para>the machine XML file and its backups;</para>
332	</listitem>
333
334	<listitem>
335	<para>the machine log files, if any;</para>
336	</listitem>
337
338	<listitem>
339	<para>the machine directory, if it is empty after having deleted all
340	the above.</para>
341	</listitem>
342	</orderedlist></para>
343	</sect1>
344
345	<sect1>
346	<title id="vboxmanage-createvm">VBoxManage createvm</title>
347
348	<para>This command creates a new XML virtual machine definition
349	file.</para>
350
351	<para>The <computeroutput>--name <name></computeroutput> parameter
352	is required and must specify the name of the machine. Since this name is
353	used by default as the file name of the settings file (with the extension
354	<computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
355	of the <computeroutput>.VirtualBox/Machines</computeroutput> folder), it
356	must conform to your host operating system's requirements for file name
357	specifications. If the VM is later renamed, the file and folder names will
358	change automatically.</para>
359
360	<para>However, if the <computeroutput>--basefolder
361	<path></computeroutput> option is used, the machine folder will be
362	named <computeroutput><path></computeroutput>. In this case, the
363	names of the file and the folder will not change if the virtual machine is
364	renamed.</para>
365
366	<para>By default, this command only creates the XML file without
367	automatically registering the VM with your VirtualBox installation. To
368	register the VM instantly, use the optional
369	<computeroutput>--register</computeroutput> option, or run
370	<computeroutput>VBoxManage registervm</computeroutput> separately
371	afterwards.</para>
372	</sect1>
373
374	<sect1 id="vboxmanage-modifyvm">
375	<title>VBoxManage modifyvm</title>
376
377	<para>This command changes the properties of a registered virtual machine
378	which is not running. Most of the properties that this command makes
379	available correspond to the VM settings that VirtualBox graphical user
380	interface displays in each VM's "Settings" dialog; these were described in
381	<xref linkend="BasicConcepts" />. Some of the more advanced settings,
382	however, are only available through the
383	<computeroutput>VBoxManage</computeroutput> interface.</para>
384
385	<para>These commands require that the machine is powered off (neither
386	running nor in "saved" state). Some machine settings can also be changed
387	while a machine is running; those settings will then have a corresponding
388	subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
389	subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
390
391	<sect2>
392	<title>General settings</title>
393
394	<para>The following general settings are available through
395	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
396	<listitem>
397	<para><computeroutput>--name <name></computeroutput>: This
398	changes the VM's name and possibly renames the internal virtual
399	machine files, as described with <computeroutput>VBoxManage
400	createvm</computeroutput> above.</para>
401	</listitem>
402
403	<listitem>
404	<para><computeroutput>--ostype <ostype></computeroutput>:
405	This specifies what guest operating system is supposed to run in
406	the VM. To learn about the various identifiers that can be used
407	here, use <computeroutput>VBoxManage list
408	ostypes</computeroutput>.</para>
409	</listitem>
410
411	<listitem>
412	<para><computeroutput>--memory
413	<memorysize></computeroutput>: This sets the amount of RAM,
414	in MB, that the virtual machine should allocate for itself from
415	the host. See the remarks in <xref linkend="gui-createvm" /> for
416	more information.</para>
417	</listitem>
418
419	<listitem>
420	<para><computeroutput>--vram <vramsize></computeroutput>:
421	This sets the amount of RAM that the virtual graphics card should
422	have. See <xref linkend="settings-display" /> for details.</para>
423	</listitem>
424
425	<listitem>
426	<para><computeroutput>--acpi on\|off</computeroutput>;
427	<computeroutput>--ioapic on\|off</computeroutput>: These two
428	determine whether the VM should have ACPI and I/O APIC support,
429	respectively; see <xref linkend="settings-motherboard" /> for
430	details.</para>
431	</listitem>
432
433	<listitem>
434	<para><computeroutput>--hardwareuuid
435	<uuid></computeroutput>: The UUID presented to the guest via
436	memory tables (DMI/SMBIOS), hardware and guest properties. By
437	default this is the same as the VM uuid. Useful when cloning a VM.
438	Teleporting takes care of this automatically.</para>
439	</listitem>
440
441	<listitem>
442	<para><computeroutput>--cpus <cpucount></computeroutput>:
443	This sets the number of virtual CPUs for the virtual machine (see
444	<xref linkend="settings-processor" />). If CPU hot-plugging is
445	enabled (see below), this then sets the
446	<emphasis>maximum</emphasis> number of virtual CPUs that can be
447	plugged into the virtual machines.</para>
448	</listitem>
449
450	<listitem>
451	<para><computeroutput>--rtcuseutc on\|off</computeroutput>: This
452	option lets the real-time clock (RTC) operate in UTC time (see
453	<xref linkend="settings-motherboard" />).</para>
454	</listitem>
455
456	<listitem>
457	<para><computeroutput>--cpuhotplug on\|off</computeroutput>: This
458	enables CPU hot-plugging. When enabled, virtual CPUs can be added
459	to and removed from a virtual machine while it is running. See
460	<xref linkend="cpuhotplug" /> for more information.</para>
461	</listitem>
462
463	<listitem>
464	<para><computeroutput>--plugcpu\|unplugcpu
465	<id></computeroutput>: If CPU hot-plugging is enabled (see
466	above), this adds a virtual CPU to the virtual machines (or
467	removes one). <computeroutput><id></computeroutput>
468	specifies the index of the virtual CPU to be added or removed and
469	must be a number from 0 to the maximum no. of CPUs configured with
470	the <computeroutput>--cpus</computeroutput> option. CPU 0 can
471	never be removed.</para>
472	</listitem>
473
474	<listitem>
475	<para><computeroutput>--synthcpu on\|off</computeroutput>: This
476	setting determines whether VirtualBox will expose a synthetic CPU
477	to the guest to allow live migration between host systems that
478	differ significantly.</para>
479	</listitem>
480
481	<listitem>
482	<para><computeroutput>--pae on\|off</computeroutput>: This
483	enables/disables PAE (see <xref
484	linkend="settings-processor" />).</para>
485	</listitem>
486
487	<listitem>
488	<para><computeroutput>--hpet on\|off</computeroutput>: This
489	enables/disables a High Precision Event Timer (HPET) which can
490	replace the legacy system timers. This is turned off by default.
491	Note that Windows supports a HPET only from Vista onwards.</para>
492	</listitem>
493
494	<listitem>
495	<para><computeroutput>--hwvirtex on\|off\|default</computeroutput>:
496	This enables or disables the use of hardware virtualization
497	extensions (Intel VT-x or AMD-V) in the processor of your host
498	system; see <xref linkend="hwvirt" />.</para>
499	</listitem>
500
501	<listitem>
502	<para><computeroutput>--hwvirtexexcl on\|off</computeroutput>: This
503	specifies whether VirtualBox will make exclusive use of the
504	hardware virtualization extensions (Intel VT-x or AMD-V) in the
505	processor of your host system; see <xref linkend="hwvirt" />. If
506	you wish to simultaneously share these extensions with other
507	hypervisors, then you must disable this setting. Doing so has
508	negative performance implications.</para>
509	</listitem>
510
511	<listitem>
512	<para><computeroutput>--nestedpaging on\|off</computeroutput>: If
513	hardware virtualization is enabled, this additional setting
514	enables or disables the use of the nested paging feature in the
515	processor of your host system; see <xref
516	linkend="hwvirt" />.</para>
517	</listitem>
518
519	<listitem>
520	<para><computeroutput>--largepages on\|off</computeroutput>: If
521	hardware virtualization <emphasis>and</emphasis> nested paging are
522	enabled, for Intel VT-x only, an additional performance
523	improvement of up to 5% can be obtained by enabling this setting.
524	This causes the hypervisor to use large pages to reduce TLB use
525	and overhead.</para>
526	</listitem>
527
528	<listitem>
529	<para><computeroutput>--vtxvpid on\|off</computeroutput>: If
530	hardware virtualization is enabled, for Intel VT-x only, this
531	additional setting enables or disables the use of the tagged TLB
532	(VPID) feature in the processor of your host system; see <xref
533	linkend="hwvirt" />.</para>
534	</listitem>
535
536	<listitem>
537	<para><computeroutput>--accelerate3d on\|off</computeroutput>: This
538	enables, if the Guest Additions are installed, whether hardware 3D
539	acceleration should be available; see <xref
540	linkend="guestadd-3d" />.</para>
541	</listitem>
542
543	<listitem>
544	<para>You can influence the BIOS logo that is displayed when a
545	virtual machine starts up with a number of settings. Per default,
546	a VirtualBox logo is displayed.</para>
547
548	<para>With <computeroutput>--bioslogofadein
549	on\|off</computeroutput> and <computeroutput>--bioslogofadeout
550	on\|off</computeroutput>, you can determine whether the logo should
551	fade in and out, respectively.</para>
552
553	<para>With <computeroutput>--bioslogodisplaytime
554	<msec></computeroutput> you can set how long the logo should
555	be visible, in milliseconds.</para>
556
557	<para>With <computeroutput>--bioslogoimagepath
558	<imagepath></computeroutput> you can, if you are so
559	inclined, replace the image that is shown, with your own logo. The
560	image must be an uncompressed 256 color BMP file.</para>
561	</listitem>
562
563	<listitem>
564	<para><computeroutput>--biosbootmenu
565	disabled\|menuonly\|messageandmenu</computeroutput>: This specifies
566	whether the BIOS allows the user to select a temporary boot
567	device. <computeroutput>menuonly</computeroutput> suppresses the
568	message, but the user can still press F12 to select a temporary
569	boot device.</para>
570	</listitem>
571
572	<listitem>
573	<para><computeroutput>--boot<1-4>
574	none\|floppy\|dvd\|disk\|net</computeroutput>: This specifies the boot
575	order for the virtual machine. There are four "slots", which the
576	VM will try to access from 1 to 4, and for each of which you can
577	set a device that the VM should attempt to boot from.</para>
578	</listitem>
579
580	<listitem>
581	<para><computeroutput>--snapshotfolder
582	default\|<path></computeroutput>: This allows you to specify
583	the folder in which snapshots will be kept for a virtual
584	machine.</para>
585	</listitem>
586
587	<listitem>
588	<para><computeroutput>--firmware efi\|bios</computeroutput>:
589	Specifies which firmware is used to boot particular virtual
590	machine: EFI or BIOS. Use EFI only if your fully understand what
591	you're doing.</para>
592	</listitem>
593
594	<listitem>
595	<para><computeroutput>--guestmemoryballoon
596	<size></computeroutput> sets the default size of the guest
597	memory balloon, that is, memory allocated by the VirtualBox Guest
598	Additions from the guest operating system and returned to the
599	hypervisor for re-use by other virtual machines. <size> must
600	be specified in megabytes. The default size is 0 megabytes. For
601	details, see <xref linkend="guestadd-balloon" />.</para>
602	</listitem>
603	</itemizedlist></para>
604	</sect2>
605
606	<sect2>
607	<title>Networking settings</title>
608
609	<para>The following networking settings are available through
610	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
611	settings, the decimal number directly following the option name ("1-N"
612	in the list below) specifies the virtual network adapter whose settings
613	should be changed.<itemizedlist>
614	<listitem>
615	<para><computeroutput>--nic<1-N>
616	none\|null\|nat\|bridged\|intnet\|hostonly\|vde</computeroutput>: With
617	this, you can set, for each of the VM's virtual network cards,
618	what type of networking should be available. They can be not
619	present (<computeroutput>none</computeroutput>), not connected to
620	the host (<computeroutput>null</computeroutput>), use network
621	address translation (<computeroutput>nat</computeroutput>),
622	bridged networking (<computeroutput>bridged</computeroutput>) or
623	communicate with other virtual machines using internal networking
624	(<computeroutput>intnet</computeroutput>), host-only networking
625	(<computeroutput>hostonly</computeroutput>) or on Linux and
626	FreeBSD hosts a Virtual Distributed Ethernet switch
627	(<computeroutput>vde</computeroutput>). These options correspond
628	to the modes which are described in detail in <xref
629	linkend="networkingmodes" />.</para>
630	</listitem>
631
632	<listitem>
633	<para><computeroutput>--nictype<1-N>
634	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
635	This allows you, for each of the VM's virtual network cards, to
636	specify which networking hardware VirtualBox presents to the
637	guest; see <xref linkend="nichardware" />.</para>
638	</listitem>
639
640	<listitem>
641	<para><computeroutput>--cableconnected<1-N>
642	on\|off</computeroutput>: This allows you to temporarily disconnect
643	a virtual network interface, as if a network cable had been pulled
644	from a real network card. This might be useful for resetting
645	certain software components in the VM.</para>
646	</listitem>
647
648	<listitem>
649	<para>With the "nictrace" options, you can optionally trace
650	network traffic by dumping it to a file, for debugging
651	purposes.</para>
652
653	<para>With <computeroutput>--nictrace<1-N>
654	on\|off</computeroutput>, you can enable network tracing for a
655	particular virtual network card.</para>
656
657	<para>If enabled, you must specify with
658	<computeroutput>--nictracefile<1-N>
659	<filename></computeroutput> what file the trace should be
660	logged to.</para>
661	</listitem>
662
663	<listitem>
664	<para><computeroutput>--bridgeadapter<1-N>
665	none\|<devicename></computeroutput>: If bridged networking
666	has been enabled for a virtual network card (see the
667	<computeroutput>--nic</computeroutput> option above; otherwise
668	this setting has no effect), use this option to specify which host
669	interface the given virtual network interface will use. For
670	details, please see <xref linkend="network_bridged" />.</para>
671	</listitem>
672
673	<listitem>
674	<para><computeroutput>--hostonlyadapter<1-N>
675	none\|<devicename></computeroutput>: If host-only networking
676	has been enabled for a virtual network card (see the --nic option
677	above; otherwise this setting has no effect), use this option to
678	specify which host-only networking interface the given virtual
679	network interface will use. For details, please see <xref
680	linkend="network_hostonly" />.</para>
681	</listitem>
682
683	<listitem>
684	<para><computeroutput>--intnet<1-N>
685	network</computeroutput>: If internal networking has been enabled
686	for a virtual network card (see the
687	<computeroutput>--nic</computeroutput> option above; otherwise
688	this setting has no effect), use this option to specify the name
689	of the internal network (see <xref
690	linkend="network_internal" />).</para>
691	</listitem>
692
693	<listitem>
694	<para><computeroutput>--macaddress<1-N>
695	auto\|<mac></computeroutput>: With this option you can set
696	the MAC address of the virtual network card. Normally, each
697	virtual network card is assigned a random address by VirtualBox at
698	VM creation.</para>
699	</listitem>
700
701	<listitem>
702	<para><computeroutput>--vdenet<1-N>
703	network</computeroutput>: If Virtual Distributed Ethernet is
704	available on the host and has been enabled for a virtual network
705	card (see the <computeroutput>--nic</computeroutput> option above;
706	otherwise this setting has no effect). Use this option to specify
707	the name of a VDE network for the interface to connect to (see
708	<xref linkend="networkingmodes" /> and the VDE
709	documentation).</para>
710	</listitem>
711	</itemizedlist></para>
712
713	<sect3>
714	<title>NAT Networking settings.</title>
715
716	<para>The following NAT networking settings are available through
717	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
718	settings, the decimal number directly following the option name ("1-N"
719	in the list below) specifies the virtual network adapter whose
720	settings should be changed.<itemizedlist>
721	<listitem>
722	<para><computeroutput>--natpf<1-N>
723	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
724	<guestport></computeroutput>: This option defines a NAT
725	port-forwarding rule (please see <xref linkend="natforward" />
726	for details).</para>
727	</listitem>
728
729	<listitem>
730	<para><computeroutput>--natpf<1-N> delete
731	<name></computeroutput>: This option deletes a NAT
732	port-forwarding rule (please see <xref linkend="natforward" />
733	for details).</para>
734	</listitem>
735
736	<listitem>
737	<para><computeroutput>--nattftpprefix<1-N>
738	<prefix></computeroutput>: This option defines a prefix
739	for the built-in TFTP server, i.e. where the boot file is
740	located (please see <xref linkend="nat-tftp" /> and <xref
741	linkend="nat-adv-tftp" /> for details).</para>
742	</listitem>
743
744	<listitem>
745	<para><computeroutput>--nattftpfile<1-N>
746	<bootfile></computeroutput>: This option defines the TFT
747	boot file (please see <xref linkend="nat-adv-tftp" /> for
748	details).</para>
749	</listitem>
750
751	<listitem>
752	<para><computeroutput>--nattftpserver<1-N>
753	<tftpserver></computeroutput>: This option defines the
754	TFTP server address to boot from (please see <xref
755	linkend="nat-adv-tftp" /> for details).</para>
756	</listitem>
757
758	<listitem>
759	<para><computeroutput>--natdnspassdomain<1-N>
760	on\|off</computeroutput>: This option specifies whether the
761	built-in DHCP server passes the domain name for network name
762	resolution.</para>
763	</listitem>
764
765	<listitem>
766	<para><computeroutput>--natdnsproxy<1-N>
767	on\|off</computeroutput>: This option makes the NAT engine proxy
768	all guest DNS requests to the host's DNS servers (please see
769	<xref linkend="nat-adv-dns" /> for details).</para>
770	</listitem>
771
772	<listitem>
773	<para><computeroutput>--natdnshostresolver<1-N>
774	on\|off</computeroutput>: This option makes the NAT engine use
775	the host's resolver mechanisms to handle DNS requests (please
776	see <xref linkend="nat-adv-dns" /> for details).</para>
777	</listitem>
778
779	<listitem>
780	<para><computeroutput>--natnatsettings<1-N>
781	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
782	[<tcprcv>]</computeroutput>: This option controls several
783	NAT settings (please see <xref linkend="nat-adv-settings" /> for
784	details).</para>
785	</listitem>
786
787	<listitem>
788	<para><computeroutput>--nataliasmode<1-N>
789	default\|[log],[proxyonly],[sameports]</computeroutput>: This
790	option defines behaviour of NAT engine core: log - enables
791	logging, proxyonly - switches of aliasing mode makes NAT
792	transparent, sameports enforces NAT engine to send packets via
793	the same port as they originated on, default - disable all
794	mentioned modes above . (please see <xref
795	linkend="nat-adv-alias" /> for details).</para>
796	</listitem>
797	</itemizedlist></para>
798	</sect3>
799	</sect2>
800
801	<sect2 id="vboxmanage-modifyvm-other">
802	<title>Serial port, audio, clipboard, VRDP and USB settings</title>
803
804	<para>The following other hardware settings are available through
805	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
806	<listitem>
807	<para><computeroutput>--uart<1-N> off\|<I/O base>
808	<IRQ></computeroutput>: With this option you can configure
809	virtual serial ports for the VM; see <xref
810	linkend="serialports" /> for an introduction.</para>
811	</listitem>
812
813	<listitem>
814	<para><computeroutput>--uartmode<1-N>
815	<arg></computeroutput>: This setting controls how VirtualBox
816	connects a given virtual serial port (previously configured with
817	the <computeroutput>--uartX</computeroutput> setting, see above)
818	to the host on which the virtual machine is running. As described
819	in detail in <xref linkend="serialports" />, for each such port,
820	you can specify <computeroutput><arg></computeroutput> as
821	one of the following options:<itemizedlist>
822	<listitem>
823	<para><computeroutput>disconnected</computeroutput>: Even
824	though the serial port is shown to the guest, it has no
825	"other end" -- like a real COM port without a cable.</para>
826	</listitem>
827
828	<listitem>
829	<para><computeroutput>server
830	<pipename></computeroutput>: On a Windows host, this
831	tells VirtualBox to create a named pipe on the host named
832	<computeroutput><pipename></computeroutput> and
833	connect the virtual serial device to it. Note that Windows
834	requires that the name of a named pipe begin with
835	<computeroutput>\\.\pipe\</computeroutput>.</para>
836
837	<para>On a Linux host, instead of a named pipe, a local
838	domain socket is used.</para>
839	</listitem>
840
841	<listitem>
842	<para><computeroutput>client
843	<pipename></computeroutput>: This operates just like
844	<computeroutput>server ...</computeroutput>, except that the
845	pipe (or local domain socket) is not created by VirtualBox,
846	but assumed to exist already.</para>
847	</listitem>
848
849	<listitem>
850	<para><computeroutput><devicename></computeroutput>:
851	If, instead of the above, the device name of a physical
852	hardware serial port of the host is specified, the virtual
853	serial port is connected to that hardware port. On a Windows
854	host, the device name will be a COM port such as
855	<computeroutput>COM1</computeroutput>; on a Linux host, the
856	device name will look like
857	<computeroutput>/dev/ttyS0</computeroutput>. This allows you
858	to "wire" a real serial port to a virtual machine.</para>
859	</listitem>
860	</itemizedlist></para>
861	</listitem>
862
863	<listitem>
864	<para><computeroutput>--audio none\|null\|oss</computeroutput>: With
865	this option, you can set whether the VM should have audio
866	support.</para>
867	</listitem>
868
869	<listitem>
870	<para><computeroutput>--clipboard
871	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
872	With this setting, you can select whether the guest operating
873	system's clipboard should be shared with the host; see <xref
874	linkend="generalsettings" />. This requires that the Guest
875	Additions be installed in the virtual machine.</para>
876	</listitem>
877
878	<listitem>
879	<para><computeroutput>--monitorcount
880	<count></computeroutput>: This enables multi-monitor
881	support; see <xref linkend="settings-display" />.</para>
882	</listitem>
883
884	<listitem>
885	<para><computeroutput>--usb on\|off</computeroutput>: This option
886	enables or disables the VM's virtual USB controller; see <xref
887	linkend="settings-usb" /> for details.</para>
888	</listitem>
889
890	<listitem>
891	<para><computeroutput>--usbehci on\|off</computeroutput>: This
892	option enables or disables the VM's virtual USB 2.0 controller;
893	see <xref linkend="settings-usb" /> for details.</para>
894	</listitem>
895	</itemizedlist></para>
896	</sect2>
897
898	<sect2>
899	<title>Remote machine settings</title>
900
901	<para>The following settings that affect remote machine behavior are
902	available through <computeroutput>VBoxManage
903	modifyvm</computeroutput>:<itemizedlist>
904	<listitem>
905	<para><computeroutput>--vrdp on\|off</computeroutput>: With the
906	VirtualBox graphical user interface, this enables or disables the
907	built-in VRDP server. Note that if you are using
908	<computeroutput>VBoxHeadless</computeroutput> (see <xref
909	linkend="vboxheadless" />), VRDP output is always enabled.</para>
910	</listitem>
911
912	<listitem>
913	<para><computeroutput>--vrdpport
914	default\|<ports></computeroutput>: A port or a range of ports
915	the VRDP server can bind to; "default" or "0" means port 3389, the
916	standard port for RDP. You can specify a comma-separated list of
917	ports or ranges of ports. Use a dash between two port numbers to
918	specify a range. The VRDP server will bind to <emphasis
919	role="bold">one</emphasis> of available ports from the specified
920	list. Only one machine can use a given port at a time. For
921	example, the option <computeroutput> --vrdpport
922	5000,5010-5012</computeroutput> will tell the server to bind to
923	one of following ports: 5000, 5010, 5011 or 5012.</para>
924	</listitem>
925
926	<listitem>
927	<para><computeroutput>--vrdpaddress <IP
928	address></computeroutput>: The IP address of the host network
929	interface the VRDP server will bind to. If specified, the VRDP
930	server will accept connections only on the specified host network
931	interface.</para>
932	</listitem>
933
934	<listitem>
935	<para><computeroutput>--vrdpauthtype
936	null\|external\|guest</computeroutput>: This allows you to choose
937	whether and how authorization will be performed; see <xref
938	linkend="vrdp-auth" /> for details.</para>
939	</listitem>
940
941	<listitem>
942	<para><computeroutput>--vrdpmulticon on\|off</computeroutput>: This
943	enables multiple VRDP connections to the same VRDP server; see
944	<xref lang="" linkend="vrdp-multiconnection" />.</para>
945	</listitem>
946
947	<listitem>
948	<para><computeroutput>--vrdpreusecon on\|off</computeroutput>: This
949	specifies the VRDP server behavior when multiple connections are
950	disabled. When this option is enabled, the VRDP server will allow
951	a new client to connect and drop the existing connection. When
952	this option is disabled (this is the default setting), a new
953	connection will not be accepted if there is already a client
954	connected to the server.</para>
955	</listitem>
956
957	<listitem>
958	<para><computeroutput>--vrdpvideochannel on\|off</computeroutput>:
959	This enables VRDP video acceleration; see <xref lang=""
960	linkend="vrdp-videochannel" />.</para>
961	</listitem>
962
963	<listitem>
964	<para><computeroutput>--vrdpvideochannelquality
965	<percent></computeroutput>: Sets the image quality for VRDP
966	video acceleration; see <xref lang=""
967	linkend="vrdp-videochannel" />.</para>
968	</listitem>
969	</itemizedlist></para>
970	</sect2>
971
972	<sect2 id="vboxmanage-modifyvm-teleport">
973	<title>Teleporting settings</title>
974
975	<para>With the following commands for <computeroutput>VBoxManage
976	modifyvm</computeroutput> you can configure a machine to be a target for
977	teleporting. See <xref linkend="teleporting" /> for an
978	introduction.<itemizedlist>
979	<listitem>
980	<para><computeroutput>--teleporter on\|off</computeroutput>: With
981	this setting you turn on or off whether a machine waits for a
982	teleporting request to come in on the network when it is started.
983	If "on", when the machine is started, it does not boot the virtual
984	machine as it would normally; instead, it then waits for a
985	teleporting request to come in on the port and address listed with
986	the next two parameters.</para>
987	</listitem>
988
989	<listitem>
990	<para><computeroutput>--teleporterport
991	<port></computeroutput>, <computeroutput>--teleporteraddress
992	<address></computeroutput>: these must be used with
993	--teleporter and tell the virtual machine on which port and
994	address it should listen for a teleporting request from another
995	virtual machine. <computeroutput><port></computeroutput> can
996	be any free TCP/IP port number (e.g. 6000);
997	<computeroutput><address></computeroutput> can be any IP
998	address or hostname and specifies the TCP/IP socket to bind to.
999	The default is "0.0.0.0", which means any address.</para>
1000	</listitem>
1001
1002	<listitem>
1003	<para><computeroutput>--teleporterpassword
1004	<password></computeroutput>: if this optional argument is
1005	given, then the teleporting request will only succeed if the
1006	source machine specifies the same password as the one given with
1007	this command.</para>
1008	</listitem>
1009
1010	<listitem>
1011	<para><computeroutput>--cpuid <leaf> <eax> <ebx>
1012	<ecx> <edx></computeroutput>: Advanced users can use
1013	this command before a teleporting operation to restrict the
1014	virtual CPU capabilities that VirtualBox presents to the guest
1015	operating system. This must be run on both the source and the
1016	target machines involved in the teleporting and will then modify
1017	what the guest sees when it executes the
1018	<computeroutput>CPUID</computeroutput> machine instruction. This
1019	might help with misbehaving applications that wrongly assume that
1020	certain CPU capabilities are present. The meaning of the
1021	parameters is hardware dependent; please refer to the AMD or Intel
1022	processor manuals.</para>
1023	</listitem>
1024	</itemizedlist></para>
1025	</sect2>
1026	</sect1>
1027
1028	<sect1 id="vboxmanage-import">
1029	<title>VBoxManage import</title>
1030
1031	<para>This command imports a virtual appliance in OVF format by copying
1032	the virtual disk images and creating virtual machines in VirtualBox. See
1033	<xref linkend="ovf" /> for an introduction to appliances.</para>
1034
1035	<para>The <computeroutput>import</computeroutput> subcommand takes at
1036	least the path name of an OVF file as input and expects the disk images,
1037	if needed, in the same directory as the OVF file. A lot of additional
1038	command-line options are supported to control in detail what is being
1039	imported and modify the import parameters, but the details depend on the
1040	content of the OVF file.</para>
1041
1042	<para>It is therefore recommended to first run the import subcommand with
1043	the <computeroutput>--dry-run</computeroutput> or
1044	<computeroutput>-n</computeroutput> option. This will then print a
1045	description of the appliance's contents to the screen how it would be
1046	imported into VirtualBox, together with the optional command-line options
1047	to influence the import behavior.</para>
1048
1049	<para>As an example, here is the screen output with a sample appliance
1050	containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
1051	Interpreting WindowsXp.ovf...
1052	OK.
1053	Virtual system 0:
1054	0: Suggested OS type: "WindowsXP"
1055	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1056	1: Suggested VM name "Windows XP Professional_1"
1057	(change with "--vsys 0 --vmname <name>")
1058	3: Number of CPUs: 1
1059	(change with "--vsys 0 --cpus <n>")
1060	4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
1061	5: Sound card (appliance expects "ensoniq1371", can change on import)
1062	(disable with "--vsys 0 --unit 5 --ignore")
1063	6: USB controller
1064	(disable with "--vsys 0 --unit 6 --ignore")
1065	7: Network adapter: orig bridged, config 2, extra type=bridged
1066	8: Floppy
1067	(disable with "--vsys 0 --unit 8 --ignore")
1068	9: SCSI controller, type BusLogic
1069	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
1070	disable with "--vsys 0 --unit 9 --ignore")
1071	10: IDE controller, type PIIX4
1072	(disable with "--vsys 0 --unit 10 --ignore")
1073	11: Hard disk image: source image=WindowsXp.vmdk,
1074	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
1075	(change controller with "--vsys 0 --unit 11 --controller <id>";
1076	disable with "--vsys 0 --unit 11 --ignore")</screen></para>
1077
1078	<para>As you can see, the individual configuration items are numbered, and
1079	depending on their type support different command-line options. The import
1080	subcommand can be directed to ignore many such items with a
1081	<computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
1082	X is the number of the virtual system (zero unless there are several
1083	virtual system descriptions in the appliance) and Y the item number, as
1084	printed on the screen.</para>
1085
1086	<para>In the above example, Item #1 specifies the name of the target
1087	machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
1088	respectively. Item #11 describes a hard disk image; in this case, the
1089	additional <computeroutput>--controller</computeroutput> option indicates
1090	which item the disk image should be connected to, with the default coming
1091	from the OVF file.</para>
1092
1093	<para>You can combine several items for the same virtual system behind the
1094	same <computeroutput>--vsys</computeroutput> option. For example, to
1095	import a machine as described in the OVF, but without the sound card and
1096	without the USB controller, and with the disk image connected to the IDE
1097	controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
1098	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
1099	</sect1>
1100
1101	<sect1 id="vboxmanage-export">
1102	<title>VBoxManage export</title>
1103
1104	<para>This command exports one or more virtual machines from VirtualBox
1105	into a virtual appliance in OVF format, including copying their virtual
1106	disk images to compressed VMDK. See <xref linkend="ovf" /> for an
1107	introduction to appliances.</para>
1108
1109	<para>The <computeroutput>export</computeroutput> command is simple to
1110	use: list the machine (or the machines) that you would like to export to
1111	the same OVF file and specify the target OVF file after an additional
1112	<computeroutput>--output</computeroutput> or
1113	<computeroutput>-o</computeroutput> option. Note that the directory of the
1114	target OVF file will also receive the exported disk images in the
1115	compressed VMDK format (regardless of the original format) and should have
1116	enough disk space left for them.</para>
1117
1118	<para>Beside a simple export of a given virtual machine, you can append
1119	several product information to the appliance file. Use
1120	<computeroutput>--product</computeroutput>,
1121	<computeroutput>--producturl</computeroutput>,
1122	<computeroutput>--vendor</computeroutput>,
1123	<computeroutput>--vendorurl</computeroutput> and
1124	<computeroutput>--version</computeroutput> to specify this additional
1125	information. For legal reasons you may add a license text or the content
1126	of a license file by using the <computeroutput>--eula</computeroutput> and
1127	<computeroutput>--eulafile</computeroutput> option respectively. As with
1128	OVF import, you must use the <computeroutput>--vsys X</computeroutput>
1129	option to direct the previously mentioned options to the correct virtual
1130	machine.</para>
1131
1132	<para>For virtualization products which aren't fully compatible with the
1133	OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
1134	<computeroutput>--legacy09</computeroutput> option.</para>
1135	</sect1>
1136
1137	<sect1 id="vboxmanage-startvm">
1138	<title>VBoxManage startvm</title>
1139
1140	<para>This command starts a virtual machine that is currently in the
1141	"Powered off" or "Saved" states.</para>
1142
1143	<note>
1144	<para>This is provided for backwards compatibility only. We recommend to
1145	start virtual machines directly by running the respective front-end, as
1146	you might otherwise miss important error and state information that
1147	VirtualBox may display on the console. This is especially important for
1148	front-ends other than <computeroutput>VirtualBox</computeroutput>, our
1149	graphical user interface, because those cannot display error messages in
1150	a popup window. See <xref linkend="vboxheadless" /> for more
1151	information.</para>
1152	</note>
1153
1154	<para>The optional <computeroutput>--type</computeroutput> specifier
1155	determines whether the machine will be started in a window (GUI mode,
1156	which is the default) or whether the output should go through
1157	<computeroutput>VBoxHeadless</computeroutput>, with VRDP enabled or not;
1158	see <xref linkend="vboxheadless" /> for more information. The list of
1159	types is subject to change, and it's not guaranteed that all types are
1160	accepted by any product variant.</para>
1161
1162	<para>The following values are allowed:</para>
1163
1164	<glosslist>
1165	<glossentry>
1166	<glossterm>gui</glossterm>
1167
1168	<glossdef>
1169	<para>Starts a VM showing a GUI window. This is the default.</para>
1170	</glossdef>
1171	</glossentry>
1172
1173	<glossentry>
1174	<glossterm>vrdp</glossterm>
1175
1176	<glossdef>
1177	<para>Starts a VM showing a GUI window, with its graphics card
1178	output accessible by an RDP client.</para>
1179	</glossdef>
1180	</glossentry>
1181
1182	<glossentry>
1183	<glossterm>headless</glossterm>
1184
1185	<glossdef>
1186	<para>Starts a VM without a window for remote RDP display
1187	only.</para>
1188	</glossdef>
1189	</glossentry>
1190	</glosslist>
1191	</sect1>
1192
1193	<sect1 id="vboxmanage-controlvm">
1194	<title>VBoxManage controlvm</title>
1195
1196	<para>The <computeroutput>controlvm</computeroutput> subcommand allows you
1197	to change the state of a virtual machine that is currently running. The
1198	following can be specified:</para>
1199
1200	<para><itemizedlist>
1201	<listitem>
1202	<para><computeroutput>VBoxManage controlvm <vm>
1203	pause</computeroutput> temporarily puts a virtual machine on hold,
1204	without changing its state for good. The VM window will be painted
1205	in gray to indicate that the VM is currently paused. (This is
1206	equivalent to selecting the "Pause" item in the "Machine" menu of
1207	the GUI.)</para>
1208	</listitem>
1209
1210	<listitem>
1211	<para>Use <computeroutput>VBoxManage controlvm <vm>
1212	resume</computeroutput> to undo a previous
1213	<computeroutput>pause</computeroutput> command. (This is equivalent
1214	to selecting the "Resume" item in the "Machine" menu of the
1215	GUI.)</para>
1216	</listitem>
1217
1218	<listitem>
1219	<para><computeroutput>VBoxManage controlvm <vm>
1220	reset</computeroutput> has the same effect on a virtual machine as
1221	pressing the "Reset" button on a real computer: a cold reboot of the
1222	virtual machine, which will restart and boot the guest operating
1223	system again immediately. The state of the VM is not saved
1224	beforehand, and data may be lost. (This is equivalent to selecting
1225	the "Reset" item in the "Machine" menu of the GUI.)</para>
1226	</listitem>
1227
1228	<listitem>
1229	<para><computeroutput>VBoxManage controlvm <vm>
1230	poweroff</computeroutput> has the same effect on a virtual machine
1231	as pulling the power cable on a real computer. Again, the state of
1232	the VM is not saved beforehand, and data may be lost. (This is
1233	equivalent to selecting the "Close" item in the "Machine" menu of
1234	the GUI or pressing the window's close button, and then selecting
1235	"Power off the machine" in the dialog.)</para>
1236
1237	<para>After this, the VM's state will be "Powered off". From there,
1238	it can be started again; see <xref
1239	linkend="vboxmanage-startvm" />.</para>
1240	</listitem>
1241
1242	<listitem>
1243	<para><computeroutput>VBoxManage controlvm <vm>
1244	savestate</computeroutput> will save the current state of the VM to
1245	disk and then stop the VM. (This is equivalent to selecting the
1246	"Close" item in the "Machine" menu of the GUI or pressing the
1247	window's close button, and then selecting "Save the machine state"
1248	in the dialog.)</para>
1249
1250	<para>After this, the VM's state will be "Saved". From there, it can
1251	be started again; see <xref linkend="vboxmanage-startvm" />.</para>
1252	</listitem>
1253
1254	<listitem>
1255	<para><computeroutput>VBoxManage controlvm <vm> teleport
1256	--hostname <name> --port <port> [--password
1257	<password>]</computeroutput> makes the machine the source of a
1258	teleporting operation and initiates a teleport to the given target.
1259	See <xref linkend="teleporting" /> for an introduction. If the
1260	optional password is specified, it must match the password that was
1261	given to the <computeroutput>modifyvm</computeroutput> command for
1262	the target machine; see <xref
1263	linkend="vboxmanage-modifyvm-teleport" /> for details.</para>
1264	</listitem>
1265	</itemizedlist></para>
1266
1267	<para>A few extra options are available with
1268	<computeroutput>controlvm</computeroutput> that do not directly affect the
1269	VM's running state:</para>
1270
1271	<itemizedlist>
1272	<listitem>
1273	<para>The <computeroutput>setlinkstate<1-N></computeroutput>
1274	operation connects or disconnects virtual network cables from their
1275	network interfaces.</para>
1276	</listitem>
1277
1278	<listitem>
1279	<para><computeroutput>nic<1-N>
1280	null\|nat\|bridged\|intnet\|hostonly</computeroutput>: With this, you can
1281	set, for each of the VM's virtual network cards, what type of
1282	networking should be available. They can be not connected to the host
1283	(<computeroutput>null</computeroutput>), use network address
1284	translation (<computeroutput>nat</computeroutput>), bridged networking
1285	(<computeroutput>bridged</computeroutput>) or communicate with other
1286	virtual machines using internal networking
1287	(<computeroutput>intnet</computeroutput>) or host-only networking
1288	(<computeroutput>hostonly</computeroutput>). These options correspond
1289	to the modes which are described in detail in <xref
1290	linkend="networkingmodes" />.</para>
1291	</listitem>
1292
1293	<listitem>
1294	<para><computeroutput>usbattach</computeroutput> and
1295	<computeroutput>usbdettach</computeroutput> make host USB devices
1296	visible to the virtual machine on the fly, without the need for
1297	creating filters first. The USB devices can be specified by UUID
1298	(unique identifier) or by address on the host system.</para>
1299
1300	<para>You can use <computeroutput>VBoxManage list
1301	usbhost</computeroutput> to locate this information.</para>
1302	</listitem>
1303
1304	<listitem>
1305	<para><computeroutput>vrdp on\|off</computeroutput> lets you enable or
1306	disable the built-in VRDP server.</para>
1307	</listitem>
1308
1309	<listitem>
1310	<para><computeroutput>vrdpport default\|<ports></computeroutput>
1311	changes the port or a range of ports that the VRDP server can bind to;
1312	"default" or "0" means port 3389, the standard port for RDP. For
1313	details, see the description for the
1314	<computeroutput>--vrdpport</computeroutput> option in <xref
1315	linkend="vboxmanage-modifyvm-other" />.</para>
1316	</listitem>
1317
1318	<listitem>
1319	<para><computeroutput>setvideomodehint</computeroutput> requests that
1320	the guest system change to a particular video mode. This requires that
1321	the Guest Additions be installed, and will not work for all guest
1322	systems.</para>
1323	</listitem>
1324
1325	<listitem>
1326	<para>The <computeroutput>setcredentials</computeroutput> operation is
1327	used for remote logons in Windows guests. For details, please refer to
1328	<xref linkend="autologon" />.</para>
1329	</listitem>
1330
1331	<listitem>
1332	<para>The <computeroutput>guestmemoryballoon</computeroutput>
1333	operation changes the size of the guest memory balloon, that is,
1334	memory allocated by the VirtualBox Guest Additions from the guest
1335	operating system and returned to the hypervisor for re-use by other
1336	virtual machines. This must be specified in megabytes. For details,
1337	see <xref linkend="guestadd-balloon" />.</para>
1338	</listitem>
1339	</itemizedlist>
1340	</sect1>
1341
1342	<sect1>
1343	<title>VBoxManage discardstate</title>
1344
1345	<para>This command discards the saved state of a virtual machine which is
1346	not currently running, which will cause its operating system to restart
1347	next time you start it. This is the equivalent of pulling out the power
1348	cable on a physical machine, and should be avoided if possible.</para>
1349	</sect1>
1350
1351	<sect1>
1352	<title>VBoxManage snapshot</title>
1353
1354	<para>This command is used to control snapshots from the command line. A
1355	snapshot consists of a complete copy of the virtual machine settings,
1356	copied at the time when the snapshot was taken, and optionally a virtual
1357	machine saved state file if the snapshot was taken while the machine was
1358	running. After a snapshot has been taken, VirtualBox creates differencing
1359	hard disk for each normal hard disk associated with the machine so that
1360	when a snapshot is restored, the contents of the virtual machine's virtual
1361	hard disks can be quickly reset by simply dropping the pre-existing
1362	differencing files.</para>
1363
1364	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
1365	of the current state of the virtual machine. You must supply a name for
1366	the snapshot and can optionally supply a description. The new snapshot is
1367	inserted into the snapshots tree as a child of the current snapshot and
1368	then becomes the new current snapshot.</para>
1369
1370	<para>The <computeroutput>delete</computeroutput> operation deletes a
1371	snapshot (specified by name or by UUID). This can take a while to finish
1372	since the differencing images associated with the snapshot might need to
1373	be merged with their child differencing images.</para>
1374
1375	<para>The <computeroutput>restore</computeroutput> operation will restore
1376	the given snapshot (specified by name or by UUID) by resetting the virtual
1377	machine's settings and current state to that of the snapshot. The previous
1378	current state of the machine will be lost. After this, the given snapshot
1379	becomes the new "current" snapshot so that subsequent snapshots are
1380	inserted under the snapshot from which was restored.</para>
1381
1382	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
1383	shortcut to restore the current snapshot (i.e. the snapshot from which the
1384	current state is derived). This subcommand is equivalent to using the
1385	"restore" subcommand with the name or UUID of the current snapshot, except
1386	that it avoids the extra step of determining that name or UUID.</para>
1387
1388	<para>With the <computeroutput>edit</computeroutput> operation, you can
1389	change the name or description of an existing snapshot.</para>
1390
1391	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
1392	can view the virtual machine settings that were stored with an existing
1393	snapshot.</para>
1394	</sect1>
1395
1396	<sect1 id="vboxmanage-registerimage">
1397	<title>VBoxManage openmedium / closemedium</title>
1398
1399	<para>These commands register or unregister hard disk, DVD or floppy
1400	images in VirtualBox. This is the command-line equivalent of the Virtual
1401	Media Manager; see <xref linkend="vdis" /> for more information.<note>
1402	<para>For compatibility with earlier versions of VirtualBox, the
1403	"registerimage" and "unregisterimage" commands are also supported and
1404	mapped internally to the "openmedium" and "closemedium" commands,
1405	respectively.</para>
1406	</note></para>
1407
1408	<para>When you register an images you can optionally specify a new UUID
1409	for the image. For hard disk images the parent UUID can be changed as
1410	well. You can also specify the type of the medium, see <xref
1411	linkend="hdimagewrites" /> for details.</para>
1412
1413	<para>When you unregister an image, you can optionally specify that the
1414	image should be deleted. You will get appropriate diagnostics that the
1415	deletion failed, however the image will become unregistered in any
1416	case.</para>
1417	</sect1>
1418
1419	<sect1 id="vboxmanage-storage">
1420	<title>VBoxManage storagectl / storageattach</title>
1421
1422	<para>These commands allow to attach new storage controllers to a VM,
1423	modify or remove the existing ones and also allows the user to change the
1424	hard disk, DVD or floppy images attached to them. The list of the storage
1425	controllers attached to the VM can be found by the command:</para>
1426
1427	<screen>VBoxManage showvminfo <vmname></screen>
1428
1429	<para>See also <xref linkend="vboxmanage-showvminfo" />.</para>
1430
1431	<sect2 id="vboxmanage-storagectl">
1432	<title>VBoxManage storagectl</title>
1433
1434	<para>This command attaches/modifies/removes a storage controller. The
1435	syntax is as follows:</para>
1436
1437	<screen>VBoxManage storagectl <uuid\|vmname>
1438	--name <name>
1439	[--add <ide/sata/scsi/floppy>]
1440	[--controller <LsiLogic/BusLogic/IntelAhci/PIIX3/
1441	PIIX4/ICH6/I8207>]
1442	[--sataideemulation<1-4> <1-30>]
1443	[--sataportcount <1-30>]
1444	[--hostiocache on\|off]
1445	[--remove]</screen>
1446
1447	<para>where the parameters mean: <glosslist>
1448	<glossentry>
1449	<glossterm>uuid\|vmname</glossterm>
1450
1451	<glossdef>
1452	<para>The VM UUID or VM Name. Mandatory.</para>
1453	</glossdef>
1454	</glossentry>
1455
1456	<glossentry>
1457	<glossterm>name</glossterm>
1458
1459	<glossdef>
1460	<para>Name of the storage controller. Mandatory.</para>
1461	</glossdef>
1462	</glossentry>
1463
1464	<glossentry>
1465	<glossterm>add</glossterm>
1466
1467	<glossdef>
1468	<para>Define the type of the system bus to which the storage
1469	controller must be connected.</para>
1470	</glossdef>
1471	</glossentry>
1472
1473	<glossentry>
1474	<glossterm>controller</glossterm>
1475
1476	<glossdef>
1477	<para>Allows to choose the type of chipset being emulated for
1478	the given storage controller.</para>
1479	</glossdef>
1480	</glossentry>
1481
1482	<glossentry>
1483	<glossterm>sataideemulation</glossterm>
1484
1485	<glossdef>
1486	<para>This specifies which SATA ports should operate in IDE
1487	emulation mode. As explained in <xref
1488	linkend="harddiskcontrollers" />, by default, this is the case
1489	for SATA ports 1-4; with this command, you can map four IDE
1490	channels to any of the 30 supported SATA ports.</para>
1491	</glossdef>
1492	</glossentry>
1493
1494	<glossentry>
1495	<glossterm>sataportcount</glossterm>
1496
1497	<glossdef>
1498	<para>This determines how many ports the SATA controller should
1499	support.</para>
1500	</glossdef>
1501	</glossentry>
1502
1503	<glossentry>
1504	<glossterm>hostiocache</glossterm>
1505
1506	<glossdef>
1507	<para>Configures the use of the host I/O cache for all disk
1508	images attached to this storage controller. For details, please
1509	see <xref linkend="iocaching" />.</para>
1510	</glossdef>
1511	</glossentry>
1512
1513	<glossentry>
1514	<glossterm>remove</glossterm>
1515
1516	<glossdef>
1517	<para>Removes the storage controller from the VM config.</para>
1518	</glossdef>
1519	</glossentry>
1520	</glosslist></para>
1521	</sect2>
1522
1523	<sect2>
1524	<title>VBoxManage storageattach</title>
1525
1526	<para>This command attaches/modifies/removes a storage medium connected
1527	to the storage controller named by --storagectl. The syntax is as
1528	follows:</para>
1529
1530	<screen>VBoxManage storageattach <uuid\|vmname>
1531	--storagectl <name>
1532	--port <number>
1533	--device <number>
1534	[--type dvddrive\|hdd\|fdd
1535	--medium none\|emptydrive\|uuid\|filename\|host:<drive>]
1536	[--passthrough on\|off]
1537	[--forceunmount]</screen>
1538
1539	<para>where the parameters mean: <glosslist>
1540	<glossentry>
1541	<glossterm>uuid\|vmname</glossterm>
1542
1543	<glossdef>
1544	<para>The VM UUID or VM Name. Mandatory.</para>
1545	</glossdef>
1546	</glossentry>
1547
1548	<glossentry>
1549	<glossterm>storagectl</glossterm>
1550
1551	<glossdef>
1552	<para>Name of the storage controller. Mandatory.</para>
1553	</glossdef>
1554	</glossentry>
1555
1556	<glossentry>
1557	<glossterm>port</glossterm>
1558
1559	<glossdef>
1560	<para>Port number to which the medium has to be
1561	attached/detached/modified. Mandatory.</para>
1562	</glossdef>
1563	</glossentry>
1564
1565	<glossentry>
1566	<glossterm>device</glossterm>
1567
1568	<glossdef>
1569	<para>Device Number to which the medium has to be
1570	attached/detached/modified. Mandatory.</para>
1571	</glossdef>
1572	</glossentry>
1573
1574	<glossentry>
1575	<glossterm>type</glossterm>
1576
1577	<glossdef>
1578	<para>Define the type of the drive to which the medium is being
1579	attached/detached/modified.</para>
1580	</glossdef>
1581	</glossentry>
1582
1583	<glossentry>
1584	<glossterm>medium</glossterm>
1585
1586	<glossdef>
1587	<para>Allows to specify if the DVD/Floppy drive or Harddisk is
1588	to be completely detached (none) or just an empty DVD/Floppy
1589	drive needs to be attached (emptydrive). If uuid, filename or
1590	host:<drive> is specified then it is attached to the
1591	storage controller at the specified port and device
1592	number.</para>
1593	</glossdef>
1594	</glossentry>
1595
1596	<glossentry>
1597	<glossterm>passthrough</glossterm>
1598
1599	<glossdef>
1600	<para>With this, you can enable DVD writing support (currently
1601	experimental; see <xref linkend="storage-write-cds" />).</para>
1602	</glossdef>
1603	</glossentry>
1604
1605	<glossentry>
1606	<glossterm>forceunmount</glossterm>
1607
1608	<glossdef>
1609	<para>If this option is specified then you can unmount the
1610	DVD/CD/Floppy or mount a new DVD/CD/Floppy even if the previous
1611	one is locked down by the guest for reading.</para>
1612	</glossdef>
1613	</glossentry>
1614	</glosslist></para>
1615
1616	<note>
1617	<para>The option "--medium none" doesn't work when the VM is running
1618	because you can't remove DVD/Floppy Drives or Harddisks when the VM is
1619	running.</para>
1620	</note>
1621	</sect2>
1622	</sect1>
1623
1624	<sect1>
1625	<title>VBoxManage showhdinfo</title>
1626
1627	<para>This command shows information about a virtual hard disk image,
1628	notably its size, its size on disk, its type and the VM it is in use
1629	by.<note>
1630	<para>For compatibility with earlier versions of VirtualBox, the
1631	"showvdiinfo" command is also supported and mapped internally to the
1632	"showhdinfo" command.</para>
1633	</note></para>
1634	</sect1>
1635
1636	<sect1 id="vboxmanage-createvdi">
1637	<title>VBoxManage createhd</title>
1638
1639	<para>This command creates a new virtual hard disk image. The syntax is as
1640	follows:</para>
1641
1642	<screen>VBoxManage createhd --filename <filename>
1643	--size <megabytes>
1644	[--format VDI\|VMDK\|VHD] (default: VDI)
1645	[--variant Standard,Fixed,Split2G,Stream,ESX]
1646	[--type normal\|writethrough] (default: normal)
1647	[--comment <comment>]
1648	[--remember]</screen>
1649
1650	<para>where the parameters mean:<glosslist>
1651	<glossentry>
1652	<glossterm>filename</glossterm>
1653
1654	<glossdef>
1655	<para>Allows to choose a file name. Mandatory.</para>
1656	</glossdef>
1657	</glossentry>
1658
1659	<glossentry>
1660	<glossterm>size</glossterm>
1661
1662	<glossdef>
1663	<para>Allows to define the image capacity, in 1 MiB units.
1664	Mandatory.</para>
1665	</glossdef>
1666	</glossentry>
1667
1668	<glossentry>
1669	<glossterm>format</glossterm>
1670
1671	<glossdef>
1672	<para>Allows to choose a file format for the output file different
1673	from the file format of the input file.</para>
1674	</glossdef>
1675	</glossentry>
1676
1677	<glossentry>
1678	<glossterm>variant</glossterm>
1679
1680	<glossdef>
1681	<para>Allows to choose a file format variant for the output file.
1682	It is a comma-separated list of variant flags. Not all
1683	combinations are supported, and specifying inconsistent flags will
1684	result in an error message.</para>
1685	</glossdef>
1686	</glossentry>
1687
1688	<glossentry>
1689	<glossterm>type</glossterm>
1690
1691	<glossdef>
1692	<para>Only honored if --remember is also specified. Defines what
1693	kind of hard disk type this image should be.</para>
1694	</glossdef>
1695	</glossentry>
1696
1697	<glossentry>
1698	<glossterm>comment</glossterm>
1699
1700	<glossdef>
1701	<para>Allows to attach a comment to the image.</para>
1702	</glossdef>
1703	</glossentry>
1704
1705	<glossentry>
1706	<glossterm>remember</glossterm>
1707
1708	<glossdef>
1709	<para>Keep the destination image registered after it was
1710	successfully written.</para>
1711	</glossdef>
1712	</glossentry>
1713	</glosslist> <note>
1714	<para>For compatibility with earlier versions of VirtualBox, the
1715	"createvdi" command is also supported and mapped internally to the
1716	"createhd" command.</para>
1717	</note></para>
1718	</sect1>
1719
1720	<sect1 id="vboxmanage-modifyvdi">
1721	<title>VBoxManage modifyhd</title>
1722
1723	<para>With the <computeroutput>modifyhd</computeroutput> command, you can
1724	change the type of an existing image between the normal, immutable and
1725	write-through modes; see <xref linkend="hdimagewrites" /> for
1726	details.<note>
1727	<para>For compatibility with earlier versions of VirtualBox, the
1728	"modifyvdi" command is also supported and mapped internally to the
1729	"modifyhd" command.</para>
1730	</note></para>
1731
1732	<para>For immutable (differencing) hard disks only, the
1733	<computeroutput>modifyhd autoreset on\|off</computeroutput> command
1734	determines whether the disk is automatically reset on every VM startup
1735	(again, see <xref linkend="hdimagewrites" />). The default is "on".</para>
1736
1737	<para>In addition, the <computeroutput>modifyhd --compact</computeroutput>
1738	command can be used to compact disk images, i.e. remove blocks that only
1739	contains zeroes. For this operation to be effective, it is required to
1740	zero out free space in the guest system using a suitable software tool.
1741	Microsoft provides the <computeroutput>sdelete</computeroutput> tool for
1742	Windows guests. Execute <computeroutput>sdelete -c</computeroutput> in the
1743	guest to zero the free disk space before compressing the virtual disk
1744	image. Compaction works both for base images and for diff images created
1745	as part of a snapshot.</para>
1746	</sect1>
1747
1748	<sect1 id="vboxmanage-clonevdi">
1749	<title>VBoxManage clonehd</title>
1750
1751	<para>This command duplicates a registered virtual hard disk image to a
1752	new image file with a new unique identifier (UUID). The new image can be
1753	transferred to another host system or imported into VirtualBox again using
1754	the Virtual Media Manager; see <xref linkend="vdis" /> and <xref
1755	linkend="cloningvdis" />. The syntax is as follows:</para>
1756
1757	<screen>VBoxManage clonehd <uuid>\|<filename> <outputfile>
1758	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
1759	[--variant Standard,Fixed,Split2G,Stream,ESX]
1760	[--type normal\|writethrough\|immutable]
1761	[--remember]</screen>
1762
1763	<para>where the parameters mean:<glosslist>
1764	<glossentry>
1765	<glossterm>format</glossterm>
1766
1767	<glossdef>
1768	<para>Allow to choose a file format for the output file different
1769	from the file format of the input file.</para>
1770	</glossdef>
1771	</glossentry>
1772
1773	<glossentry>
1774	<glossterm>variant</glossterm>
1775
1776	<glossdef>
1777	<para>Allow to choose a file format variant for the output file.
1778	It is a comma-separated list of variant flags. Not all
1779	combinations are supported, and specifying inconsistent flags will
1780	result in an error message.</para>
1781	</glossdef>
1782	</glossentry>
1783
1784	<glossentry>
1785	<glossterm>type</glossterm>
1786
1787	<glossdef>
1788	<para>Only honored if --remember is also specified. Defines what
1789	kind of hard disk type this image should be.</para>
1790	</glossdef>
1791	</glossentry>
1792
1793	<glossentry>
1794	<glossterm>remember</glossterm>
1795
1796	<glossdef>
1797	<para>Keep the destination image registered after it was
1798	successfully written.</para>
1799	</glossdef>
1800	</glossentry>
1801	</glosslist> <note>
1802	<para>For compatibility with earlier versions of VirtualBox, the
1803	"clonevdi" command is also supported and mapped internally to the
1804	"clonehd" command.</para>
1805	</note></para>
1806	</sect1>
1807
1808	<sect1>
1809	<title>VBoxManage convertfromraw</title>
1810
1811	<para>This command converts a raw disk image to a VirtualBox Disk Image
1812	(VDI) file. The syntax is as follows:</para>
1813
1814	<screen>VBoxManage convertfromraw <filename> <outputfile>
1815	[--format VDI\|VMDK\|VHD]
1816	[--variant Standard,Fixed,Split2G,Stream,ESX]
1817	VBoxManage convertfromraw stdin <outputfile> <bytes>
1818	[--format VDI\|VMDK\|VHD]
1819	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
1820
1821	<para>where the parameters mean:<glosslist>
1822	<glossentry>
1823	<glossterm>format</glossterm>
1824
1825	<glossdef>
1826	<para>Select the disk image format to create. Default is
1827	VDI.</para>
1828	</glossdef>
1829	</glossentry>
1830
1831	<glossentry>
1832	<glossterm>variant</glossterm>
1833
1834	<glossdef>
1835	<para>Allow to choose a file format variant for the output file.
1836	It is a comma-separated list of variant flags. Not all
1837	combinations are supported, and specifying inconsistent flags will
1838	result in an error message.</para>
1839	</glossdef>
1840	</glossentry>
1841	</glosslist> The second form forces VBoxManage to read the content for
1842	the disk image from standard input (useful for using that command in a
1843	pipe).</para>
1844
1845	<para><note>
1846	<para>For compatibility with earlier versions of VirtualBox, the
1847	"convertdd" command is also supported and mapped internally to the
1848	"convertfromraw" command.</para>
1849	</note></para>
1850	</sect1>
1851
1852	<sect1 id="vboxmanage-addiscsidisk">
1853	<title>VBoxManage addiscsidisk</title>
1854
1855	<para>The <computeroutput>addiscsidisk</computeroutput> command attaches
1856	an iSCSI network storage unit to VirtualBox. The iSCSI target can then be
1857	made available to and used by a virtual machine as though it were a
1858	standard write-through virtual disk image.</para>
1859
1860	<para>This command has the following syntax:<screen>VBoxManage addiscsidisk --server <name>\|<ip>
1861	--target <target>
1862	[--port <port>]
1863	[--lun <lun>]
1864	[--username <username>]
1865	[--password <password>]
1866	[--type normal\|writethrough\|immutable]
1867	[--comment <comment>]
1868	[--intnet]</screen></para>
1869
1870	<para>where the parameters mean:<glosslist>
1871	<glossentry>
1872	<glossterm>server</glossterm>
1873
1874	<glossdef>
1875	<para>The host name or IP address of the iSCSI target.</para>
1876	</glossdef>
1877	</glossentry>
1878
1879	<glossentry>
1880	<glossterm>target</glossterm>
1881
1882	<glossdef>
1883	<para>Target name string. This is determined by the iSCSI target
1884	and used to identify the storage resource.</para>
1885	</glossdef>
1886	</glossentry>
1887
1888	<glossentry>
1889	<glossterm>port</glossterm>
1890
1891	<glossdef>
1892	<para>TCP/IP port number of the iSCSI service on the target
1893	(optional).</para>
1894	</glossdef>
1895	</glossentry>
1896
1897	<glossentry>
1898	<glossterm>lun</glossterm>
1899
1900	<glossdef>
1901	<para>Logical Unit Number of the target resource (optional).
1902	Often, this value is zero.</para>
1903	</glossdef>
1904	</glossentry>
1905
1906	<glossentry>
1907	<glossterm>username, password</glossterm>
1908
1909	<glossdef>
1910	<para>Username and password for target authentication, if required
1911	(optional).<note>
1912	<para>Currently, username and password are stored without
1913	encryption (i.e. in cleartext) in the machine configuration
1914	file.</para>
1915	</note></para>
1916	</glossdef>
1917	</glossentry>
1918
1919	<glossentry>
1920	<glossterm>type</glossterm>
1921
1922	<glossdef>
1923	<para>Defines what kind of hard disk type this image should
1924	be.</para>
1925	</glossdef>
1926	</glossentry>
1927
1928	<glossentry>
1929	<glossterm>comment</glossterm>
1930
1931	<glossdef>
1932	<para>Any description that you want to have stored with this item
1933	(optional; e.g. "Big storage server downstairs"). This is stored
1934	internally only and not needed for operation.</para>
1935	</glossdef>
1936	</glossentry>
1937
1938	<glossentry>
1939	<glossterm>intnet</glossterm>
1940
1941	<glossdef>
1942	<para>Connect to the iSCSI target via Internal Networking. This
1943	needs further configuration which is described in <xref
1944	linkend="iscsi-intnet" />.</para>
1945	</glossdef>
1946	</glossentry>
1947	</glosslist></para>
1948	</sect1>
1949
1950	<sect1>
1951	<title>VBoxManage getextradata/setextradata</title>
1952
1953	<para>These commands let you attach and retrieve string data to a virtual
1954	machine or to a VirtualBox configuration (by specifying
1955	<computeroutput>global</computeroutput> instead of a virtual machine
1956	name). You must specify a key (as a text string) to associate the data
1957	with, which you can later use to retrieve it. For example:</para>
1958
1959	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
1960	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
1961
1962	<para>would associate the string "2006.01.01" with the key installdate for
1963	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
1964	could retrieve the information as follows:</para>
1965
1966	<screen>VBoxManage getextradata Fedora5 installdate</screen>
1967
1968	<para>which would return</para>
1969
1970	<screen>VirtualBox Command Line Management Interface Version $VBOX_VERSION_MAJOR.$VBOX_VERSION_MINOR.$VBOX_VERSION_BUILD
1971	(C) 2005-$VBOX_C_YEAR $VBOX_VENDOR
1972	All rights reserved.
1973
1974	Value: 2006.01.01</screen>
1975	</sect1>
1976
1977	<sect1>
1978	<title>VBoxManage setproperty</title>
1979
1980	<para>This command is used to change global settings which affect the
1981	entire VirtualBox installation. Some of these correspond to the settings
1982	in the "Global settings" dialog in the graphical user interface. The
1983	following properties are available:<glosslist>
1984	<glossentry>
1985	<glossterm>hdfolder</glossterm>
1986
1987	<glossdef>
1988	<para>This specifies the default folder that is used to keep disk
1989	image files (.vdi, .vmdk, .vhd).</para>
1990	</glossdef>
1991	</glossentry>
1992
1993	<glossentry>
1994	<glossterm>machinefolder</glossterm>
1995
1996	<glossdef>
1997	<para>This specifies the default folder in which virtual machine
1998	definitions are kept; see <xref linkend="vboxconfigdata" /> for
1999	details.</para>
2000	</glossdef>
2001	</glossentry>
2002
2003	<glossentry>
2004	<glossterm>vrdpauthlibrary</glossterm>
2005
2006	<glossdef>
2007	<para>This specifies which library to use when "external" VRDP
2008	authentication has been selected for a particular virtual machine;
2009	see <xref linkend="vrdp-auth" /> for details.</para>
2010	</glossdef>
2011	</glossentry>
2012
2013	<glossentry>
2014	<glossterm>websrvauthlibrary</glossterm>
2015
2016	<glossdef>
2017	<para>This specifies which library the web service uses to
2018	authenticate users. For details about the VirtualBox web service,
2019	please refer to the separate VirtualBox SDK reference (see <xref
2020	linkend="VirtualBoxAPI" />).</para>
2021	</glossdef>
2022	</glossentry>
2023
2024	<glossentry>
2025	<glossterm>hwvirtexenabled</glossterm>
2026
2027	<glossdef>
2028	<para>This selects whether or not hardware virtualization support
2029	is enabled by default.</para>
2030	</glossdef>
2031	</glossentry>
2032	</glosslist></para>
2033	</sect1>
2034
2035	<sect1>
2036	<title>VBoxManage usbfilter add/modify/remove</title>
2037
2038	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
2039	working with USB filters in virtual machines, or global filters which
2040	affect the whole VirtualBox setup. Global filters are applied before
2041	machine-specific filters, and may be used to prevent devices from being
2042	captured by any virtual machine. Global filters are always applied in a
2043	particular order, and only the first filter which fits a device is
2044	applied. So for example, if the first global filter says to hold (make
2045	available) a particular Kingston memory stick device and the second to
2046	ignore all Kingston devices, that memory stick will be available to any
2047	machine with an appropriate filter, but no other Kingston device
2048	will.</para>
2049
2050	<para>When creating a USB filter using <computeroutput>usbfilter
2051	add</computeroutput>, you must supply three or four mandatory parameters.
2052	The index specifies the position in the list at which the filter should be
2053	placed. If there is already a filter at that position, then it and the
2054	following ones will be shifted back one place. Otherwise the new filter
2055	will be added onto the end of the list. The
2056	<computeroutput>target</computeroutput> parameter selects the virtual
2057	machine that the filter should be attached to or use "global" to apply it
2058	to all virtual machines. <computeroutput>name</computeroutput> is a name
2059	for the new filter and for global filters,
2060	<computeroutput>action</computeroutput> says whether to allow machines
2061	access to devices that fit the filter description ("hold") or not to give
2062	them access ("ignore"). In addition, you should specify parameters to
2063	filter by. You can find the parameters for devices attached to your system
2064	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
2065	you can specify whether the filter should be active, and for local
2066	filters, whether they are for local devices, remote (over an RDP
2067	connection) or either.</para>
2068
2069	<para>When you modify a USB filter using <computeroutput>usbfilter
2070	modify</computeroutput>, you must specify the filter by index (see the
2071	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
2072	find global filter indexes and that of <computeroutput>VBoxManage
2073	showvminfo</computeroutput> to find indexes for individual machines) and
2074	by target, which is either a virtual machine or "global". The properties
2075	which can be changed are the same as for <computeroutput>usbfilter
2076	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
2077	remove</computeroutput> and specify the index and the target.</para>
2078	</sect1>
2079
2080	<sect1>
2081	<title>VBoxManage sharedfolder add/remove</title>
2082
2083	<para>This command allows you to share folders on the host computer with
2084	guest operating systems. For this, the guest systems must have a version
2085	of the VirtualBox Guest Additions installed which supports this
2086	functionality.</para>
2087
2088	<para>Shared folders are described in detail in <xref
2089	linkend="sharedfolders" />.</para>
2090	</sect1>
2091
2092	<sect1>
2093	<title id="metrics">VBoxManage metrics</title>
2094
2095	<para>This command supports monitoring the usage of system resources.
2096	Resources are represented by various metrics associated with the host
2097	system or a particular VM. For example, the host system has a
2098	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
2099	percentage of time CPUs spend executing in user mode over a specific
2100	sampling period.</para>
2101
2102	<para>Metric data is collected and retained internally; it may be
2103	retrieved at any time with the <computeroutput>VBoxManage metrics
2104	query</computeroutput> subcommand. The data is available as long as the
2105	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
2106	process terminates shortly after all VMs and frontends have been
2107	closed.</para>
2108
2109	<para>By default no metrics are collected at all. Metrics collection does
2110	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
2111	is invoked with a proper sampling interval and the number of metrics to be
2112	retained. The interval is measured in seconds. For example, to enable
2113	collecting the host processor and memory usage metrics every second and
2114	keeping the 5 most current samples, the following command can be
2115	used:</para>
2116
2117	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
2118
2119	<para>Metric collection can only be enabled for started VMs. Collected
2120	data and collection settings for a particular VM will disappear as soon as
2121	it shuts down. Use <computeroutput>VBoxManage metrics list
2122	</computeroutput> subcommand to see which metrics are currently available.
2123	You can also use <computeroutput>--list</computeroutput> option with any
2124	subcommand that modifies metric settings to find out which metrics were
2125	affected.</para>
2126
2127	<para>Note that the <computeroutput>VBoxManage metrics
2128	setup</computeroutput> subcommand discards all samples that may have been
2129	previously collected for the specified set of objects and metrics.</para>
2130
2131	<para>To enable or disable metrics collection without discarding the data
2132	<computeroutput>VBoxManage metrics enable</computeroutput> and
2133	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
2134	can be used. Note that these subcommands expect metrics, not submetrics,
2135	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
2136	other words enabling <code>CPU/Load/User</code> while disabling
2137	<code>CPU/Load/Kernel</code> is not supported.</para>
2138
2139	<para>The host and VMs have different sets of associated metrics.
2140	Available metrics can be listed with <computeroutput>VBoxManage metrics
2141	list</computeroutput> subcommand.</para>
2142
2143	<para>A complete metric name may include an aggregate function. The name
2144	has the following form:
2145	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
2146	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
2147	for the minimum amount of available memory over all retained data if
2148	applied to the host object.</para>
2149
2150	<para>Subcommands may apply to all objects and metrics or can be limited
2151	to one object or/and a list of metrics. If no objects or metrics are given
2152	in the parameters, the subcommands will apply to all available metrics of
2153	all objects. You may use an asterisk
2154	("<computeroutput>*</computeroutput>") to explicitly specify that the
2155	command should be applied to all objects or metrics. Use "host" as the
2156	object name to limit the scope of the command to host-related metrics. To
2157	limit the scope to a subset of metrics, use a metric list with names
2158	separated by commas.</para>
2159
2160	<para>For example, to query metric data on the CPU time spent in user and
2161	kernel modes by the virtual machine named "test", you can use the
2162	following command:</para>
2163
2164	<screen>VBoxManage query test CPU/Load/User,CPU/Load/Kernel</screen>
2165
2166	<para>The following list summarizes the available subcommands:</para>
2167
2168	<glosslist>
2169	<glossentry>
2170	<glossterm>list</glossterm>
2171
2172	<glossdef>
2173	<para>This subcommand shows the parameters of the currently existing
2174	metrics. Note that VM-specific metrics are only available when a
2175	particular VM is running.</para>
2176	</glossdef>
2177	</glossentry>
2178
2179	<glossentry>
2180	<glossterm>setup</glossterm>
2181
2182	<glossdef>
2183	<para>This subcommand sets the interval between taking two samples
2184	of metric data and the number of samples retained internally. The
2185	retained data is available for displaying with the
2186	<code>query</code> subcommand. The <computeroutput>--list
2187	</computeroutput> option shows which metrics have been modified as
2188	the result of the command execution.</para>
2189	</glossdef>
2190	</glossentry>
2191
2192	<glossentry>
2193	<glossterm>enable</glossterm>
2194
2195	<glossdef>
2196	<para>This subcommand "resumes" data collection after it has been
2197	stopped with <code>disable</code> subcommand. Note that specifying
2198	submetrics as parameters will not enable underlying metrics. Use
2199	<computeroutput>--list</computeroutput> to find out if the command
2200	did what was expected.</para>
2201	</glossdef>
2202	</glossentry>
2203
2204	<glossentry>
2205	<glossterm>disable</glossterm>
2206
2207	<glossdef>
2208	<para>This subcommand "suspends" data collection without affecting
2209	collection parameters or collected data. Note that specifying
2210	submetrics as parameters will not disable underlying metrics. Use
2211	<computeroutput>--list</computeroutput> to find out if the command
2212	did what was expected.</para>
2213	</glossdef>
2214	</glossentry>
2215
2216	<glossentry>
2217	<glossterm>query</glossterm>
2218
2219	<glossdef>
2220	<para>This subcommand retrieves and displays the currently retained
2221	metric data.<note>
2222	<para>The <code>query</code> subcommand does not remove or
2223	"flush" retained data. If you query often enough you will see
2224	how old samples are gradually being "phased out" by new
2225	samples.</para>
2226	</note></para>
2227	</glossdef>
2228	</glossentry>
2229
2230	<glossentry>
2231	<glossterm>collect</glossterm>
2232
2233	<glossdef>
2234	<para>This subcommand sets the interval between taking two samples
2235	of metric data and the number of samples retained internally. The
2236	collected data is displayed periodically until Ctrl-C is pressed
2237	unless the <computeroutput>--detach</computeroutput> option is
2238	specified. With the <computeroutput>--detach</computeroutput>
2239	option, this subcommand operates the same way as <code>setup</code>
2240	does. The <computeroutput>--list</computeroutput> option shows which
2241	metrics match the specified filter.</para>
2242	</glossdef>
2243	</glossentry>
2244	</glosslist>
2245	</sect1>
2246
2247	<sect1 id="vboxmanage-guestproperty">
2248	<title>VBoxManage guestproperty</title>
2249
2250	<para>The "guestproperty" commands allow you to get or set properties of a
2251	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
2252	for an introduction. As explained there, guest properties are arbitrary
2253	key/value string pairs which can be written to and read from by either the
2254	guest or the host, so they can be used as a low-volume communication
2255	channel for strings, provided that a guest is running and has the Guest
2256	Additions installed. In addition, a number of values whose keys begin with
2257	"/VirtualBox/" are automatically set and maintained by the Guest
2258	Additions.</para>
2259
2260	<para>The following subcommands are available (where
2261	<computeroutput><vm></computeroutput>, in each case, can either be a
2262	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
2263	<listitem>
2264	<para><computeroutput>enumerate <vm> [-patterns
2265	<pattern>]</computeroutput>: This lists all the guest
2266	properties that are available for the given VM, including the value.
2267	This list will be very limited if the guest's service process cannot
2268	be contacted, e.g. because the VM is not running or the Guest
2269	Additions are not installed.</para>
2270
2271	<para>If <computeroutput>--patterns <pattern></computeroutput>
2272	is specified, it acts as a filter to only list properties that match
2273	the given pattern. The pattern can contain the following wildcard
2274	characters:<itemizedlist>
2275	<listitem>
2276	<para><computeroutput>*</computeroutput> (asterisk):
2277	represents any number of characters; for example,
2278	"<computeroutput>/VirtualBox*</computeroutput>" would match
2279	all properties beginning with "/VirtualBox".</para>
2280	</listitem>
2281
2282	<listitem>
2283	<para><computeroutput>?</computeroutput> (question mark):
2284	represents a single arbitrary character; for example,
2285	"<computeroutput>fo?</computeroutput>" would match both "foo"
2286	and "for".</para>
2287	</listitem>
2288
2289	<listitem>
2290	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
2291	used to specify multiple alternative patterns; for example,
2292	"<computeroutput>s\|t</computeroutput>" would match anything
2293	starting with either "s" or "t".</para>
2294	</listitem>
2295	</itemizedlist></para>
2296	</listitem>
2297
2298	<listitem>
2299	<para><computeroutput>get <vm></computeroutput>: This
2300	retrieves the value of a single property only. If the property
2301	cannot be found (e.g. because the guest is not running), this will
2302	print "No value set!".</para>
2303	</listitem>
2304
2305	<listitem>
2306	<para><computeroutput>set <vm> <property> [<value>
2307	[-flags <flags>]]</computeroutput>: This allows you to set a
2308	guest property by specifying the key and value. If
2309	<computeroutput><value></computeroutput> is omitted, the
2310	property is deleted. With <computeroutput>--flags</computeroutput>
2311	you can optionally specify additional behavior (you can combine
2312	several by separating them with commas):<itemizedlist>
2313	<listitem>
2314	<para><computeroutput>TRANSIENT</computeroutput>: the value
2315	will not be stored with the VM data when the VM exits;</para>
2316	</listitem>
2317
2318	<listitem>
2319	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
2320	can only be changed by the host, but the guest can only read
2321	it;</para>
2322	</listitem>
2323
2324	<listitem>
2325	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
2326	the value can only be changed by the guest, but the host can
2327	only read it;</para>
2328	</listitem>
2329
2330	<listitem>
2331	<para><computeroutput>READONLY</computeroutput>: a combination
2332	of the two, the value cannot be changed at all.</para>
2333	</listitem>
2334	</itemizedlist></para>
2335	</listitem>
2336
2337	<listitem>
2338	<para><computeroutput>wait <vm> <pattern> --timeout
2339	<timeout></computeroutput>: This waits for a particular value
2340	described by "pattern" to change or to be deleted or created. The
2341	pattern rules are the same as for the "enumerate" subcommand
2342	above.</para>
2343	</listitem>
2344	</itemizedlist></para>
2345	</sect1>
2346
2347	<sect1 id="vboxmanage-guestcontrol">
2348	<title>VBoxManage guestcontrol</title>
2349
2350	<para>The "guestcontrol" commands allow you to control certain things
2351	inside a guest from the host. Please see <xref
2352	linkend="guestadd-guestcontrol" /> for an introduction.</para>
2353
2354	<para>Generally, the syntax is as follows:</para>
2355
2356	<screen>VBoxManage guestcontrol <command></screen>
2357
2358	<para>At this time, the only available
2359	<computeroutput><command></computeroutput> is "execute", which
2360	allows for executing a program/script (process) which is already installed
2361	and runnable on the guest. This command only works while a VM is up and
2362	running and has the following syntax:</para>
2363
2364	<screen>VBoxManage guestcontrol execute <vmname>\|<uuid>
2365	<pathToProgram>
2366	--username <name> --password <password>
2367	[--arguments "<arguments>"]
2368	[--environment "<NAME>=<VALUE> [<NAME>=<VALUE>]"]
2369	[--flags <flags>] [--timeout <msec>]
2370	[--verbose] [--wait-for exit,stdout,stderr\|\|]</screen>
2371
2372	<para>where the parameters mean: <glosslist>
2373	<glossentry>
2374	<glossterm>uuid\|vmname</glossterm>
2375
2376	<glossdef>
2377	<para>The VM UUID or VM name. Mandatory.</para>
2378	</glossdef>
2379	</glossentry>
2380
2381	<glossentry>
2382	<glossterm>pathToProgram</glossterm>
2383
2384	<glossdef>
2385	<para>Absolute path and process name of process to execute in the
2386	guest, e.g.
2387	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
2388	</glossdef>
2389	</glossentry>
2390
2391	<glossentry>
2392	<glossterm>--arguments "<arguments>"</glossterm>
2393
2394	<glossdef>
2395	<para>One or more arguments to pass to the process being
2396	executed.</para>
2397
2398	<para>Arguments containing spaces must be enclosed in quotation
2399	marks. More than one <computeroutput>--arguments</computeroutput>
2400	at a time can be specified to keep the command line tidy.</para>
2401	</glossdef>
2402	</glossentry>
2403
2404	<glossentry>
2405	<glossterm>--environment "<NAME>=<VALUE>"</glossterm>
2406
2407	<glossdef>
2408	<para>One or more environment variables to be set or unset.</para>
2409
2410	<para>By default, the new process in the guest will be created
2411	with the the standard environment of the guest OS. This option
2412	allows for modifying that environment. To set/modify a variable, a
2413	pair of <computeroutput>NAME=VALUE</computeroutput> must be
2414	specified; to unset a certain variable, the name with no value
2415	must set, e.g. <computeroutput>NAME=</computeroutput>.</para>
2416
2417	<para>Arguments containing spaces must be enclosed in quotation
2418	marks. More than one
2419	<computeroutput>--environment</computeroutput> at a time can be
2420	specified to keep the command line tidy.</para>
2421	</glossdef>
2422	</glossentry>
2423
2424	<glossentry>
2425	<glossterm>--flags <flags></glossterm>
2426
2427	<glossdef>
2428	<para>Additional flags to set. This is not used at the
2429	moment.</para>
2430	</glossdef>
2431	</glossentry>
2432
2433	<glossentry>
2434	<glossterm>--timeout <msec></glossterm>
2435
2436	<glossdef>
2437	<para>Value (in milliseconds) that specifies the time how long the
2438	started process is allowed to run and how long VBoxManage waits
2439	for getting output from that process. If no timeout is specified,
2440	VBoxManage will wait forever until the started process ends or an
2441	error occured.</para>
2442	</glossdef>
2443	</glossentry>
2444
2445	<glossentry>
2446	<glossterm>--username <name></glossterm>
2447
2448	<glossdef>
2449	<para>Name of the user the process should run under. This user
2450	must exist on the guest OS.</para>
2451	</glossdef>
2452	</glossentry>
2453
2454	<glossentry>
2455	<glossterm>--password <password></glossterm>
2456
2457	<glossdef>
2458	<para>Password of the user account specified with
2459	<computeroutput>--username</computeroutput>. If not given, an
2460	empty password is assumed.</para>
2461	</glossdef>
2462	</glossentry>
2463
2464	<glossentry>
2465	<glossterm>--verbose</glossterm>
2466
2467	<glossdef>
2468	<para>Tells VBoxManage to be more verbose during the
2469	execution.</para>
2470	</glossdef>
2471	</glossentry>
2472
2473	<glossentry>
2474	<glossterm>--wait-for <action></glossterm>
2475
2476	<glossdef>
2477	<para>Tells VBoxManage to wait for a certain action to happen and
2478	react to it. The following actions are available: <glosslist>
2479	<glossentry>
2480	<glossterm>exit</glossterm>
2481
2482	<glossdef>
2483	<para>Waits until the process ends and outputs its exit
2484	code along with the exit reason/flags.</para>
2485	</glossdef>
2486	</glossentry>
2487
2488	<glossentry>
2489	<glossterm>stdout or stderr</glossterm>
2490
2491	<glossdef>
2492	<para>Waits until the process ends and outputs its exit
2493	code along with the exit reason/flags. After that
2494	VBoxManage retrieves the output collected from the guest
2495	process's stdout and stderr.</para>
2496	</glossdef>
2497	</glossentry>
2498	</glosslist></para>
2499	</glossdef>
2500	</glossentry>
2501	</glosslist></para>
2502
2503	<para><note>
2504	<para>On Windows there are certain limitations for graphical
2505	applications; please see <xref linkend="KnownIssues" /> for more
2506	information.</para>
2507	</note> Examples: <screen>VBoxManage --nologo guestcontrol execute "My VM" "/bin/ls" --arguments "-l /usr"
2508	--username foo --password bar --wait-for stdout</screen> <screen>VBoxManage --nologo guestcontrol execute "My VM" "c:\\windows\\system32\\ipconfig.exe"
2509	--username foo --password bar --wait-for stdout</screen> Note that
2510	the double backslashes in the second example are only required on Unix
2511	hosts.</para>
2512	</sect1>
2513
2514	<sect1 id="vboxmanage-dhcpserver">
2515	<title>VBoxManage dhcpserver</title>
2516
2517	<para>The "dhcpserver" commands allow you to control the DHCP server that
2518	is built into VirtualBox. You may find this useful when using internal or
2519	host-only networking. (Theoretically, you can enable it for a bridged
2520	network as well, but that will likely cause conflicts with other DHCP
2521	servers in your physical network.)</para>
2522
2523	<para>Use the following command line options:<itemizedlist>
2524	<listitem>
2525	<para>If you use internal networking for a virtual network adapter
2526	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
2527	--netname <network_name></computeroutput>, where
2528	<computeroutput><network_name></computeroutput> is the same
2529	network name you used with <computeroutput>VBoxManage modifyvm
2530	<vmname> --intnet<X>
2531	<network_name></computeroutput>.</para>
2532	</listitem>
2533
2534	<listitem>
2535	<para>If you use host-only networking for a virtual network adapter
2536	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
2537	--ifname <hostonly_if_name></computeroutput> instead, where
2538	<computeroutput><hostonly_if_name></computeroutput> is the
2539	same host-only interface name you used with
2540	<computeroutput>VBoxManage modifyvm <vmname>
2541	--hostonlyadapter<X>
2542	<hostonly_if_name></computeroutput>.</para>
2543
2544	<para>Alternatively, you can also use the --netname option as with
2545	internal networks if you know the host-only network's name; you can
2546	see the names with <computeroutput>VBoxManage list
2547	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
2548	above).</para>
2549	</listitem>
2550	</itemizedlist></para>
2551
2552	<para>The following additional parameters are required when first adding a
2553	DHCP server:<itemizedlist>
2554	<listitem>
2555	<para>With <computeroutput>--ip</computeroutput>, specify the IP
2556	address of the DHCP server itself.</para>
2557	</listitem>
2558
2559	<listitem>
2560	<para>With <computeroutput>--netmask</computeroutput>, specify the
2561	netmask of the network.</para>
2562	</listitem>
2563
2564	<listitem>
2565	<para>With <computeroutput>--lowerip</computeroutput> and
2566	<computeroutput>--upperip</computeroutput>, you can specify the
2567	lowest and highest IP address, respectively, that the DHCP server
2568	will hand out to clients.</para>
2569	</listitem>
2570	</itemizedlist></para>
2571
2572	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
2573	or the DHCP server will be created in the disabled state, doing
2574	nothing.</para>
2575
2576	<para>After this, VirtualBox will automatically start the DHCP server for
2577	given internal or host-only network as soon as the first virtual machine
2578	which uses that network is started.</para>
2579
2580	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
2581	remove</computeroutput> with the given <computeroutput>--netname
2582	<network_name></computeroutput> or <computeroutput>--ifname
2583	<hostonly_if_name></computeroutput> to remove the DHCP server again
2584	for the given internal or host-only network.</para>
2585
2586	<para>To modify the settings of a DHCP server created earlier with
2587	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
2588	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
2589	network or host-only interface name.</para>
2590	</sect1>
2591	</chapter>

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

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

以其他格式下載: