user_VBoxManage.xml@ 68929

Last change on this file since 68929 was 68515, checked in by vboxsync, 8 years ago
Documentation/VBoxManage: Added "audioin" / "audioout" commands for controlvm + modifyvm.
File size: 267.3 KB

Line
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	user_VBoxManage.xml:
4	VBoxManage documentation for the user manual.
5
6	This XML document is also be used for generating the help text
7	built into VBoxManage as well as manpages (hacking in progress).
8
9	Copyright (C) 2006-2017 Oracle Corporation
10
11	This file is part of VirtualBox Open Source Edition (OSE), as
12	available from http://www.virtualbox.org. This file is free software;
13	you can redistribute it and/or modify it under the terms of the GNU
14	General Public License (GPL) as published by the Free Software
15	Foundation, in version 2 as it comes in the "COPYING" file of the
16	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18	-->
19	<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
20	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
21	<chapter id="vboxmanage">
22	<title>VBoxManage</title>
23
24	<sect1>
25	<title>Introduction</title>
26
27	<para>As briefly mentioned in <xref linkend="frontends" />, VBoxManage is
28	the command-line interface to VirtualBox. With it, you can completely
29	control VirtualBox from the command line of your host operating system.
30	VBoxManage supports all the features that the graphical user interface
31	gives you access to, but it supports a lot more than that. It exposes
32	really all the features of the virtualization engine, even those that
33	cannot (yet) be accessed from the GUI.</para>
34
35	<para>You will need to use the command line if you want to</para>
36
37	<para><itemizedlist>
38	<listitem>
39	<para>use a different user interface than the main GUI (for example,
40	VBoxSDL or the VBoxHeadless server);</para>
41	</listitem>
42
43	<listitem>
44	<para>control some of the more advanced and experimental
45	configuration settings for a VM.</para>
46	</listitem>
47	</itemizedlist></para>
48
49	<para>There are two main things to keep in mind when using
50	<computeroutput>VBoxManage</computeroutput>: First,
51	<computeroutput>VBoxManage</computeroutput> must always be used with a
52	specific "subcommand", such as "list" or "createvm" or "startvm". All the
53	subcommands that <computeroutput>VBoxManage</computeroutput> supports are
54	described in detail in <xref linkend="vboxmanage" />.</para>
55
56	<para>Second, most of these subcommands require that you specify a
57	particular virtual machine after the subcommand. There are two ways you
58	can do this:</para>
59
60	<itemizedlist>
61	<listitem>
62	<para>You can specify the VM name, as it is shown in the VirtualBox
63	GUI. Note that if that name contains spaces, then you must enclose the
64	entire name in double quotes (as it is always required with command
65	line arguments that contain spaces).</para>
66
67	<para>For example:<screen>VBoxManage startvm "Windows XP"</screen></para>
68	</listitem>
69
70	<listitem>
71	<para>You can specify the UUID, which is the internal unique
72	identifier that VirtualBox uses to refer to the virtual machine.
73	Assuming that the aforementioned VM called "Windows XP" has the UUID
74	shown below, the following command has the same effect as the
75	previous:<screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen></para>
76	</listitem>
77	</itemizedlist>
78
79	<para>You can type <computeroutput>VBoxManage list vms</computeroutput> to
80	have all currently registered VMs listed with all their settings,
81	including their respective names and UUIDs.</para>
82
83	<para>Some typical examples of how to control VirtualBox from the command
84	line are listed below:</para>
85
86	<itemizedlist>
87	<listitem>
88	<para>To create a new virtual machine from the command line and
89	immediately register it with VirtualBox, use
90	<computeroutput>VBoxManage createvm</computeroutput> with the
91	<computeroutput>--register</computeroutput> option,<footnote>
92	<para>For details, see <xref
93	linkend="vboxmanage-createvm" />.</para>
94	</footnote> like this:</para>
95
96	<screen>$ VBoxManage createvm --name "SUSE 10.2" --register
97	VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
98	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
99	All rights reserved.
100
101	Virtual machine 'SUSE 10.2' is created.
102	UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
103	Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen>
104
105	<para>As can be seen from the above output, a new virtual machine has
106	been created with a new UUID and a new XML settings file.</para>
107	</listitem>
108
109	<listitem>
110	<para>To show the configuration of a particular VM, use
111	<computeroutput>VBoxManage showvminfo</computeroutput>; see <xref
112	linkend="vboxmanage-showvminfo" /> for details and an example.</para>
113	</listitem>
114
115	<listitem>
116	<para>To change settings while a VM is powered off, use
117	<computeroutput>VBoxManage modifyvm</computeroutput>, e.g. as
118	follows:<screen>VBoxManage modifyvm "Windows XP" --memory 512</screen></para>
119
120	<para>For details, see <xref linkend="vboxmanage-modifyvm" />.</para>
121	</listitem>
122
123	<listitem>
124	<para>To change the storage configuration (e.g. to add a storage
125	controller and then a virtual disk), use <computeroutput>VBoxManage
126	storagectl</computeroutput> and <computeroutput>VBoxManage
127	storageattach</computeroutput>; see <xref
128	linkend="vboxmanage-storagectl" /> and <xref
129	linkend="vboxmanage-storageattach" /> for details.</para>
130	</listitem>
131
132	<listitem>
133	<para>To control VM operation, use one of the following:<itemizedlist>
134	<listitem>
135	<para>To start a VM that is currently powered off, use
136	<computeroutput>VBoxManage startvm</computeroutput>; see <xref
137	linkend="vboxmanage-startvm" /> for details.</para>
138	</listitem>
139
140	<listitem>
141	<para>To pause or save a VM that is currently running or change
142	some of its settings, use <computeroutput>VBoxManage
143	controlvm</computeroutput>; see <xref
144	linkend="vboxmanage-controlvm" /> for details.</para>
145	</listitem>
146	</itemizedlist></para>
147	</listitem>
148	</itemizedlist>
149	</sect1>
150
151	<sect1>
152	<title>Commands overview</title>
153
154	<para>When running VBoxManage without parameters or when supplying an
155	invalid command line, the below syntax diagram will be shown. Note that
156	the output will be slightly different depending on the host platform; when
157	in doubt, check the output of <computeroutput>VBoxManage</computeroutput>
158	for the commands available on your particular host.</para>
159
160	<xi:include href="../user_VBoxManage_CommandsOverview.xml" xpointer="xpointer(/sect1/*)"
161	xmlns:xi="http://www.w3.org/2001/XInclude" />
162
163	<para>Each time VBoxManage is invoked, only one command can be executed.
164	However, a command might support several subcommands which then can be
165	invoked in one single call. The following sections provide detailed
166	reference information on the different commands.</para>
167	</sect1>
168
169	<sect1 id="vboxmanage-general">
170	<title>General options</title>
171	<para>
172	<itemizedlist>
173	<listitem>
174	<para><computeroutput>-v\|--version</computeroutput>: show the version of
175	this tool and exit.</para>
176	</listitem>
177	<listitem>
178	<para><computeroutput>--nologo</computeroutput>: suppress the output
179	of the logo information (useful for scripts)</para>
180	</listitem>
181	<listitem>
182	<para><computeroutput>--settingspw</computeroutput>: specifiy a settings
183	password</para>
184	</listitem>
185	<listitem>
186	<para><computeroutput>--settingspwfile</computeroutput>: specify a file
187	containing the settings password.</para>
188	</listitem>
189	</itemizedlist>
190	The settings password is used for certain settings which need to be
191	stored encrypted for security reasons. At the moment, the only encrypted
192	setting is the iSCSI initiator secret (see
193	<xref linkend="vboxmanage-storageattach" /> for details). As long as no
194	settings password is specified, this information is stored in
195	<emphasis role="bold">plain text</emphasis>. After using the
196	<computeroutput>--settingspw\|--settingspwfile</computeroutput> option
197	once, it must be always used, otherwise the encrypted setting cannot
198	be unencrypted.
199	</para>
200	</sect1>
201
202	<sect1 id="vboxmanage-list">
203	<title>VBoxManage list</title>
204
205	<para>The <computeroutput>list</computeroutput> command gives relevant
206	information about your system and information about VirtualBox's current
207	settings.</para>
208
209	<para>The following subcommands are available with
210	<computeroutput>VBoxManage list</computeroutput>: <itemizedlist>
211	<listitem>
212	<para><computeroutput>vms</computeroutput> lists all virtual
213	machines currently registered with VirtualBox. By default this
214	displays a compact list with each VM's name and UUID; if you also
215	specify <computeroutput>--long</computeroutput> or
216	<computeroutput>-l</computeroutput>, this will be a detailed list as
217	with the <computeroutput>showvminfo</computeroutput> command (see
218	below).</para>
219	</listitem>
220
221	<listitem>
222	<para><computeroutput>runningvms</computeroutput> lists all
223	currently running virtual machines by their unique identifiers
224	(UUIDs) in the same format as with
225	<computeroutput>vms</computeroutput>.</para>
226	</listitem>
227
228	<listitem>
229	<para><computeroutput>ostypes</computeroutput> lists all guest
230	operating systems presently known to VirtualBox, along with the
231	identifiers used to refer to them with the
232	<computeroutput>modifyvm</computeroutput> command.</para>
233	</listitem>
234
235	<listitem>
236	<para><computeroutput>hostdvds</computeroutput>,
237	<computeroutput>hostfloppies</computeroutput>, respectively, list
238	DVD, floppy, bridged networking and host-only networking interfaces
239	on the host, along with the name used to access them from within
240	VirtualBox.</para>
241	</listitem>
242
243	<listitem>
244	<para><computeroutput>intnets</computeroutput> displays information
245	about the internal networks.</para>
246	</listitem>
247
248	<listitem>
249	<para><computeroutput>bridgedifs</computeroutput>,
250	<computeroutput>hostonlyifs</computeroutput>,
251	<computeroutput>natnets</computeroutput> and
252	<computeroutput>dhcpservers</computeroutput>, respectively, list
253	bridged network interfaces, host-only network interfaces,
254	NAT network interfaces and DHCP servers currently available on the
255	host. Please see <xref
256	linkend="networkingdetails" /> for details on these.</para>
257	</listitem>
258
259	<listitem>
260	<para><computeroutput>hostinfo</computeroutput> displays information
261	about the host system, such as CPUs, memory size and operating
262	system version.</para>
263	</listitem>
264
265	<listitem>
266	<para><computeroutput>hostcpuids</computeroutput> dumps the CPUID
267	parameters for the host CPUs. This can be used for a more fine
268	grained analyis of the host's virtualization capabilities.</para>
269	</listitem>
270
271	<listitem>
272	<para><computeroutput>hddbackends</computeroutput> lists all known
273	virtual disk back-ends of VirtualBox. For each such format (such as
274	VDI, VMDK or RAW), this lists the back-end's capabilities and
275	configuration.</para>
276	</listitem>
277
278	<listitem>
279	<para><computeroutput>hdds</computeroutput>,
280	<computeroutput>dvds</computeroutput> and
281	<computeroutput>floppies</computeroutput> all give you information
282	about virtual disk images currently in use by VirtualBox, including
283	all their settings, the unique identifiers (UUIDs) associated with
284	them by VirtualBox and all files associated with them. This is the
285	command-line equivalent of the Virtual Media Manager; see <xref
286	linkend="vdis" />.</para>
287	</listitem>
288
289	<listitem>
290	<para><computeroutput>usbhost</computeroutput> supplies information
291	about USB devices attached to the host, notably information useful
292	for constructing USB filters and whether they are currently in use
293	by the host.</para>
294	</listitem>
295
296	<listitem>
297	<para><computeroutput>usbfilters</computeroutput> lists all global
298	USB filters registered with VirtualBox -- that is, filters for
299	devices which are accessible to all virtual machines -- and displays
300	the filter parameters.</para>
301	</listitem>
302
303	<listitem>
304	<para><computeroutput>systemproperties</computeroutput> displays
305	some global VirtualBox settings, such as minimum and maximum guest
306	RAM and virtual hard disk size, folder settings and the current
307	authentication library in use.</para>
308	</listitem>
309
310	<listitem>
311	<para><computeroutput>extpacks</computeroutput> displays all
312	VirtualBox extension packs currently installed; see <xref
313	linkend="intro-installing" /> and <xref
314	linkend="vboxmanage-extpack" /> for more information.</para>
315	</listitem>
316
317	<listitem>
318	<para><computeroutput>groups</computeroutput> displays
319	details of the VM Groups; see <xref linkend="gui-vmgroups" />
320	for more information.</para>
321	</listitem>
322
323	<listitem>
324	<para><computeroutput>webcams</computeroutput> displays a list of
325	webcams attached to the running VM. The output format is a list of
326	absolute paths or aliases that were used for attaching the webcams
327	to the VM using the 'webcam attach' command.</para>
328	</listitem>
329
330	<listitem>
331	<para><computeroutput>screenshotformats</computeroutput> displays a
332	list of available screenshot formats.</para>
333	</listitem>
334
335	</itemizedlist></para>
336	</sect1>
337
338	<sect1 id="vboxmanage-showvminfo">
339	<title>VBoxManage showvminfo</title>
340
341	<para>The <computeroutput>showvminfo</computeroutput> command shows
342	information about a particular virtual machine. This is the same
343	information as <computeroutput>VBoxManage list vms --long</computeroutput>
344	would show for all virtual machines.</para>
345
346	<para>You will get information that resembles the following example.</para>
347
348	<para><screen>$ VBoxManage showvminfo "Windows XP"
349	VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
350	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
351	All rights reserved.
352
353	Name: Windows XP
354	Guest OS: Other/Unknown
355	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
356	Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
357	Memory size: 512MB
358	VRAM size: 12MB
359	Number of CPUs: 2
360	Boot menu mode: message and menu
361	Boot Device (1): DVD
362	Boot Device (2): HardDisk
363	Boot Device (3): Not Assigned
364	Boot Device (4): Not Assigned
365	ACPI: on
366	IOAPIC: on
367	...
368	</screen></para>
369	<para>Use the <computeroutput>--machinereadable</computeroutput> option
370	to produce the same output, but in machine readable format: property="value" on a
371	line by line basis, e.g.:</para>
372	<para><screen>
373	name="VBoxSDL --startvm OL7.2"
374	groups="/"
375	ostype="Oracle (64-bit)"
376	UUID="457af700-bc0a-4258-aa3c-13b03da171f2"
377	...
378	</screen></para>
379	</sect1>
380
381	<sect1 id="vboxmanage-registervm">
382	<title>VBoxManage registervm / unregistervm</title>
383
384	<para>The <computeroutput>registervm</computeroutput> command allows you
385	to import a virtual machine definition in an XML file into VirtualBox. The
386	machine must not conflict with one already registered in VirtualBox and it
387	may not have any hard or removable disks attached. It is advisable to
388	place the definition file in the machines folder before registering
389	it.<note>
390	<para>When creating a new virtual machine with
391	<computeroutput>VBoxManage createvm</computeroutput> (see below), you
392	can directly specify the <computeroutput>--register</computeroutput>
393	option to avoid having to register it separately.</para>
394	</note></para>
395
396	<para>The <computeroutput>unregistervm</computeroutput> command
397	unregisters a virtual machine. If
398	<computeroutput>--delete</computeroutput> is also specified, the following
399	files will automatically be deleted as well:<orderedlist>
400	<listitem>
401	<para>all hard disk image files, including differencing files, which
402	are used by the machine and not shared with other machines;</para>
403	</listitem>
404
405	<listitem>
406	<para>saved state files that the machine created, if any (one if the
407	machine was in "saved" state and one for each online
408	snapshot);</para>
409	</listitem>
410
411	<listitem>
412	<para>the machine XML file and its backups;</para>
413	</listitem>
414
415	<listitem>
416	<para>the machine log files, if any;</para>
417	</listitem>
418
419	<listitem>
420	<para>the machine directory, if it is empty after having deleted all
421	the above.</para>
422	</listitem>
423	</orderedlist></para>
424	</sect1>
425
426	<sect1 id="vboxmanage-createvm">
427	<title>VBoxManage createvm</title>
428
429	<para>This command creates a new XML virtual machine definition
430	file.</para>
431
432	<para>The <computeroutput>--name <name></computeroutput> parameter
433	is required and must specify the name of the machine. Since this name is
434	used by default as the file name of the settings file (with the extension
435	<computeroutput>.xml</computeroutput>) and the machine folder (a subfolder
436	of the <computeroutput>.config/VirtualBox/Machines</computeroutput> folder
437	- this folder name may vary depending on the operating system and the
438	version of VirtualBox which you are using), it must conform to your host
439	operating system's requirements for file name specifications. If the VM
440	is later renamed, the file and folder names will change automatically.</para>
441
442	<para>However, if the <computeroutput>--basefolder
443	<path></computeroutput> option is used, the machine folder will be
444	named <computeroutput><path></computeroutput>. In this case, the
445	names of the file and the folder will not change if the virtual machine is
446	renamed.</para>
447
448	<para>If the <computeroutput>--group <group>, ...</computeroutput>
449	option is used, the machine will be assigned membership of the specified
450	VM groups in the list. Note that group ids always start with a
451	<computeroutput>/</computeroutput> and can be nested. By default,
452	VMs are always assigned membership of the group
453	<computeroutput>/</computeroutput>.</para>
454
455	<para>If the <computeroutput>--ostype <ostype></computeroutput>:
456	option is used, <ostype> specifies the guest operating system
457	to run in the VM. To learn about the available OS options,
458	run <computeroutput>VBoxManage list ostypes</computeroutput> .</para>
459
460	<para>If the <computeroutput>--uuid <uuid></computeroutput>:
461	option is used, <uuid> specifies the VM uuid. This must be
462	unique within the namespace of the host, or that of the VM Group if
463	it is assigned to a VM group membership. By default, a unique uuid
464	within the appropriate namespace is automatically generated.
465	</para>
466
467	<para>By default, this command only creates the XML file without
468	automatically registering the VM with your VirtualBox installation. To
469	register the VM instantly, use the optional
470	<computeroutput>--register</computeroutput> option, or run
471	<computeroutput>VBoxManage registervm</computeroutput> separately
472	afterwards.</para>
473
474	</sect1>
475
476	<sect1 id="vboxmanage-modifyvm">
477	<title>VBoxManage modifyvm</title>
478
479	<para>This command changes the properties of a registered virtual machine
480	which is not running. Most of the properties that this command makes
481	available correspond to the VM settings that VirtualBox graphical user
482	interface displays in each VM's "Settings" dialog; these were described in
483	<xref linkend="BasicConcepts" />. Some of the more advanced settings,
484	however, are only available through the
485	<computeroutput>VBoxManage</computeroutput> interface.</para>
486
487	<para>These commands require that the machine is powered off (neither
488	running nor in "saved" state). Some machine settings can also be changed
489	while a machine is running; those settings will then have a corresponding
490	subcommand with the <computeroutput>VBoxManage controlvm</computeroutput>
491	subcommand (see <xref linkend="vboxmanage-controlvm" />).</para>
492
493	<sect2>
494	<title>General settings</title>
495
496	<para>The following general settings are available through
497	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
498	<listitem>
499	<para><computeroutput>--name <name></computeroutput>: This
500	changes the VM's name and possibly renames the internal virtual
501	machine files, as described with <computeroutput>VBoxManage
502	createvm</computeroutput> above.</para>
503	</listitem>
504
505	<listitem>
506	<para><computeroutput>--groups <group>, ...</computeroutput>:
507	This changes the group membership of a VM. Groups always start with
508	a <computeroutput>/</computeroutput> and can be nested. By default
509	VMs are in group <computeroutput>/</computeroutput>.</para>
510	</listitem>
511
512	<listitem>
513	<para><computeroutput>--description <desc></computeroutput>:
514	This changes the VM's description, which is a way to record details
515	about the VM in a way which is meaningful for the user. The GUI
516	interprets HTML formatting, the command line allows arbitrary
517	strings potentially containing multiple lines.</para>
518	</listitem>
519
520	<listitem>
521	<para><computeroutput>--ostype <ostype></computeroutput>:
522	This specifies what guest operating system is supposed to run in
523	the VM. To learn about the various identifiers that can be used
524	here, use <computeroutput>VBoxManage list
525	ostypes</computeroutput>.</para>
526	</listitem>
527
528	<listitem>
529	<para><computeroutput>--iconfile <filename></computeroutput>:
530	This specifies the absolute path on the host file system for the VirtualBox
531	icon to be displayed in the VM.</para>
532	</listitem>
533
534	<listitem>
535	<para><computeroutput>--memory <memorysize></computeroutput>: This sets the amount of RAM,
536	in MB, that the virtual machine should allocate for itself from
537	the host. See the remarks in <xref linkend="gui-createvm" /> for
538	more information.</para>
539	</listitem>
540
541	<listitem>
542	<para><computeroutput>--pagefusion on\|off</computeroutput>:
543	Enables/disables (default) the Page Fusion feature.
544	The Page Fusion feature minimises memory duplication between VMs with similar
545	configurations running on the same host.
546	See <xref linkend="guestadd-pagefusion" /> for details.</para>
547	</listitem>
548
549	<listitem>
550	<para><computeroutput>--vram <vramsize></computeroutput>:
551	This sets the amount of RAM that the virtual graphics card should
552	have. See <xref linkend="settings-display" /> for details.</para>
553	</listitem>
554
555	<listitem>
556	<para><computeroutput>--acpi on\|off</computeroutput>;
557	<computeroutput>--ioapic on\|off</computeroutput>: These two
558	determine whether the VM should have ACPI and I/O APIC support,
559	respectively; see <xref linkend="settings-motherboard" /> for
560	details.</para>
561	</listitem>
562
563	<listitem>
564	<para><computeroutput>--pciattach <host PCI address [@ guest
565	PCI bus address]></computeroutput>: Attaches a specified PCI network
566	controller on the host to a PCI bus (can specify) on the guest.
567	See <xref linkend="pcipassthrough" /> for details. </para>
568	</listitem>
569
570	<listitem>
571	<para><computeroutput>--pcidetach <host PCI address></computeroutput>:
572	Detaches a specified PCI network controller on the host from the attached
573	PCI bus on the guest. See <xref linkend="pcipassthrough" />
574	for details. </para>
575	</listitem>
576
577	<listitem>
578	<para><computeroutput>--hardwareuuid
579	<uuid></computeroutput>: The UUID presented to the guest via
580	memory tables (DMI/SMBIOS), hardware and guest properties. By
581	default this is the same as the VM uuid. Useful when cloning a VM.
582	Teleporting takes care of this automatically.</para>
583	</listitem>
584
585	<listitem>
586	<para><computeroutput>--cpus <cpucount></computeroutput>:
587	This sets the number of virtual CPUs for the virtual machine (see
588	<xref linkend="settings-processor" />). If CPU hot-plugging is
589	enabled (see below), this then sets the
590	<emphasis>maximum</emphasis> number of virtual CPUs that can be
591	plugged into the virtual machines.</para>
592	</listitem>
593
594	<listitem>
595	<para><computeroutput>--cpuhotplug on\|off</computeroutput>: This
596	enables CPU hot-plugging. When enabled, virtual CPUs can be added
597	to and removed from a virtual machine while it is running. See
598	<xref linkend="cpuhotplug" /> for more information.</para>
599	</listitem>
600
601	<listitem>
602	<para><computeroutput>--plugcpu\|unplugcpu
603	<id></computeroutput>: If CPU hot-plugging is enabled (see
604	above), this adds a virtual CPU to the virtual machines (or
605	removes one). <computeroutput><id></computeroutput>
606	specifies the index of the virtual CPU to be added or removed and
607	must be a number from 0 to the maximum no. of CPUs configured with
608	the <computeroutput>--cpus</computeroutput> option. CPU 0 can
609	never be removed.</para>
610	</listitem>
611
612	<listitem>
613	<para><computeroutput>--cpuexecutioncap
614	<1-100></computeroutput>: This setting controls how much cpu
615	time a virtual CPU can use. A value of 50 implies a single virtual
616	CPU can use up to 50% of a single host CPU.</para>
617	</listitem>
618
619	<listitem>
620	<para><computeroutput>--pae on\|off</computeroutput>: This
621	enables/disables PAE. See <xref linkend="settings-processor" />.</para>
622	</listitem>
623
624	<listitem>
625	<para><computeroutput>--longmode on\|off</computeroutput>: This
626	enables/disables long mode. See <xref linkend="settings-processor" />.</para>
627	</listitem>
628
629	<listitem>
630	<para><computeroutput>--cpu-profile <host\|intel 80[86\|286\|386]></computeroutput>:
631	This enables specification of a profile for guest cpu emulation.
632	Specify either one based on the host system CPU (host), or one from
633	a number of older Intel Micro-architectures - 8086, 80286, 80386.</para>
634	</listitem>
635
636	<listitem>
637	<para><computeroutput>--hpet on\|off</computeroutput>: This
638	enables/disables a High Precision Event Timer (HPET) which can
639	replace the legacy system timers. This is turned off by default.
640	Note that Windows supports a HPET only from Vista onwards.</para>
641	</listitem>
642
643	<listitem>
644	<para><computeroutput>--hwvirtex on\|off</computeroutput>: This
645	enables or disables the use of hardware virtualization extensions
646	(Intel VT-x or AMD-V) in the processor of your host system;
647	see <xref linkend="hwvirt" />.</para>
648	</listitem>
649
650	<listitem>
651	<para><computeroutput>--triplefaultreset on\|off</computeroutput>:
652	This setting enables resetting of the guest instead of triggering a
653	Guru Meditation. Some guests raise a triple fault to reset the
654	CPU so sometimes this is desired behavior. Works only for non-SMP
655	guests.</para>
656	</listitem>
657
658	<listitem>
659	<para><computeroutput>--apic on\|off</computeroutput>:
660	This setting enables(default)/disables IO APIC. With
661	I/O APIC, operating systems can use more than 16 interrupt
662	requests (IRQs) thus avoiding IRQ sharing for improved
663	reliability. See <xref linkend="settings-motherboard" />.</para>
664	</listitem>
665
666	<listitem>
667	<para><computeroutput>--x2apic on\|off</computeroutput>:
668	This setting enables(default)/disables CPU x2APIC support.
669	CPU x2APIC support helps operating systems run more efficiently on high
670	core count configurations, and optimizes interrupt
671	distribution in virtualized environments. Disable when using host/guest
672	operating systems incompatible with x2APIC support.</para>
673	</listitem>
674
675	<listitem>
676	<para><computeroutput>--paravirtprovider
677	none\|default\|legacy\|minimal\|hyperv\|kvm</computeroutput>: This
678	setting specifies which paravirtualization interface to provide to
679	the guest operating system. Specifying
680	<computeroutput>none</computeroutput> explicitly turns off exposing
681	any paravirtualization interface. The option
682	<computeroutput>default</computeroutput>, will pick an appropriate
683	interface depending on the guest OS type while starting the VM.
684	This is the default option chosen while creating new VMs. The
685	<computeroutput>legacy</computeroutput> option is chosen for VMs
686	which were created with older VirtualBox versions and will pick a
687	paravirtualization interface while starting the VM with VirtualBox
688	5.0 and newer. The <computeroutput>minimal</computeroutput> provider
689	is mandatory for Mac OS X guests, while
690	<computeroutput>kvm</computeroutput> and
691	<computeroutput>hyperv</computeroutput> are recommended for Linux
692	and Windows guests respectively. These options are explained in
693	detail under <xref linkend="gimproviders" />.</para>
694	</listitem>
695
696	<listitem>
697	<para><computeroutput>--paravirtdebug <key=value>
698	[,<key=value> ...]</computeroutput>: This setting specifies debugging
699	options specific to the paravirtualization provider
700	configured for this VM. Please refer to the provider specific
701	options under <xref linkend="gimdebug" /> for a list of supported
702	key-value pairs for each provider.</para>
703	</listitem>
704
705	<listitem>
706	<para><computeroutput>--nestedpaging on\|off</computeroutput>: If
707	hardware virtualization is enabled, this additional setting
708	enables or disables the use of the nested paging feature in the
709	processor of your host system; see <xref
710	linkend="hwvirt" />.</para>
711	</listitem>
712
713	<listitem>
714	<para><computeroutput>--largepages on\|off</computeroutput>: If
715	hardware virtualization <emphasis>and</emphasis> nested paging are
716	enabled, for Intel VT-x only, an additional performance
717	improvement of up to 5% can be obtained by enabling this setting.
718	This causes the hypervisor to use large pages to reduce TLB use
719	and overhead.</para>
720	</listitem>
721
722	<listitem>
723	<para><computeroutput>--vtxvpid on\|off</computeroutput>: If
724	hardware virtualization is enabled, for Intel VT-x only, this
725	additional setting enables or disables the use of the tagged TLB
726	(VPID) feature in the processor of your host system; see <xref
727	linkend="hwvirt" />.</para>
728	</listitem>
729
730	<listitem>
731	<para><computeroutput>--vtxux on\|off</computeroutput>: If
732	hardware virtualization is enabled, for Intel VT-x only, this
733	setting enables or disables the use of the unrestricted guest mode
734	feature for executing your guest.</para>
735	</listitem>
736
737	<listitem>
738	<para><computeroutput>--accelerate3d on\|off</computeroutput>:
739	If the Guest Additions are installed, this setting enables or
740	disables hardware 3D acceleration; see <xref
741	linkend="guestadd-3d" />.</para>
742	</listitem>
743
744	<listitem>
745	<para><computeroutput>--accelerate2dvideo on\|off</computeroutput>:
746	If the Guest Additions are installed, this setting enables or
747	disables 2D video acceleration; see <xref
748	linkend="guestadd-2d" />.</para>
749	</listitem>
750
751	<listitem>
752	<para><computeroutput>--chipset piix3\|ich9</computeroutput>:
753	By default VirtualBox emulates an Intel PIIX3 chipset. Usually there
754	is no reason to change the default setting unless this is required to
755	relax some of its constraints; see <xref
756	linkend="settings-motherboard" />.</para>
757	</listitem>
758
759	<listitem>
760	<para>You can influence the BIOS logo that is displayed when a
761	virtual machine starts up with a number of settings. By default,
762	a VirtualBox logo is displayed.</para>
763
764	<para>With <computeroutput>--bioslogofadein
765	on\|off</computeroutput> and <computeroutput>--bioslogofadeout
766	on\|off</computeroutput>, you can determine whether the logo should
767	fade in and out, respectively.</para>
768
769	<para>With <computeroutput>--bioslogodisplaytime
770	<msec></computeroutput> you can set how long the logo should
771	be visible, in milliseconds.</para>
772
773	<para>With <computeroutput>--bioslogoimagepath
774	<imagepath></computeroutput> you can, if you are so
775	inclined, replace the image that is shown, with your own logo. The
776	image must be an uncompressed 256 color BMP file without color
777	space information (Windows 3.0 format). The image must not be
778	bigger than 640 x 480.</para>
779	</listitem>
780
781	<listitem>
782	<para><computeroutput>--biosbootmenu
783	disabled\|menuonly\|messageandmenu</computeroutput>: This specifies
784	whether the BIOS allows the user to select a temporary boot
785	device. <computeroutput>menuonly</computeroutput> suppresses the
786	message, but the user can still press F12 to select a temporary
787	boot device.</para>
788	</listitem>
789
790	<listitem>
791	<para><computeroutput>--biosapic
792	x2apic\|apic\|disabled</computeroutput>: This specifies
793	the firmware APIC level to be used. Options are: x2apic, apic or
794	disabled (no apic or x2apic) respectively.</para>
795
796	<para>Note that if x2apic is specified and x2apic is unsupported by the
797	VCPU, biosapic downgrades to apic, if supported - otherwise down to 'disabled'.
798	Similarly, if apic is specified, and apic is unsupported a
799	downgrade to 'disabled' results.</para>
800	</listitem>
801
802	<listitem>
803	<para><computeroutput>--biossystemtimeoffset <ms></computeroutput>:
804	This specifies a fixed time offset (milliseconds) of the guest relative to
805	the host time. If the offset is positive, the guest time runs ahead of the
806	host time.</para>
807	</listitem>
808
809	<listitem>
810	<para><computeroutput>--biospxedebug on\|off</computeroutput>:
811	This option enables additional debugging output when using the
812	Intel PXE boot ROM. The output will be written to the release log
813	file (<xref linkend="collect-debug-info" />.</para>
814	</listitem>
815
816	<listitem>
817	<para><computeroutput>--boot<1-4>
818	none\|floppy\|dvd\|disk\|net</computeroutput>: This specifies the boot
819	order for the virtual machine. There are four "slots", which the
820	VM will try to access from 1 to 4, and for each of which you can
821	set a device that the VM should attempt to boot from.</para>
822	</listitem>
823
824	<listitem>
825	<para><computeroutput>--rtcuseutc on\|off</computeroutput>: This
826	option lets the real-time clock (RTC) operate in UTC time. See
827	<xref linkend="settings-motherboard" />.</para>
828	</listitem>
829
830	<listitem>
831	<para><computeroutput>--graphicscontroller none\|vboxvga\|vmsvga</computeroutput>: This
832	option specifies use of a graphics controller, and type chosen from vboxvga or vmsvga.
833	<xref linkend="settings-motherboard" />).</para>
834	</listitem>
835
836	<listitem>
837	<para><computeroutput>--snapshotfolder
838	default\|<path></computeroutput>: This option specifies the folder in which
839	snapshots will be kept for a virtual machine.</para>
840	</listitem>
841
842	<listitem>
843	<para><computeroutput>--firmware bios\|efi\|efi32\|efi64</computeroutput>:
844	This option specifies which firmware to be used to boot the VM:
845	Available options are: BIOS, or one of the EFI options: efi, efi32 or efi64.
846	Use EFI options with care.</para>
847	</listitem>
848
849	<listitem>
850	<para><computeroutput>--guestmemoryballoon
851	<size></computeroutput> This option sets the default size of the guest
852	memory balloon, that is, memory allocated by the VirtualBox Guest
853	Additions from the guest operating system and returned to the
854	hypervisor for re-use by other virtual machines.
855	<computeroutput><size></computeroutput> must be specified in
856	megabytes. The default size is 0 megabytes. For details,
857	see <xref linkend="guestadd-balloon" />.</para>
858	</listitem>
859
860	<listitem>
861	<para><computeroutput>--defaultfrontend
862	default\|<name></computeroutput>: This option specifies
863	the default frontend to be used when starting this VM;
864	see <xref linkend="vboxmanage-startvm" /> for details.</para>
865	</listitem>
866	</itemizedlist></para>
867	</sect2>
868
869	<sect2>
870	<title>Networking settings</title>
871
872	<para>The following networking settings are available through
873	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
874	settings, the decimal number directly following the option name ("1-N"
875	in the list below) specifies the virtual network adapter whose settings
876	should be changed.<itemizedlist>
877	<listitem>
878	<para><computeroutput>--nic<1-N>
879	none\|null\|nat\|natnetwork\|bridged\|intnet\|hostonly\|generic</computeroutput>:
880	With this, you can set, for each of the VM's virtual network cards,
881	what type of networking should be available. They can be not
882	present (<computeroutput>none</computeroutput>), not connected to
883	the host (<computeroutput>null</computeroutput>), use network
884	address translation (<computeroutput>nat</computeroutput>),
885	use the new network address translation engine
886	(<computeroutput>natnetwork</computeroutput>),
887	bridged networking (<computeroutput>bridged</computeroutput>) or
888	communicate with other virtual machines using internal networking
889	(<computeroutput>intnet</computeroutput>), host-only networking
890	(<computeroutput>hostonly</computeroutput>), or access rarely used
891	sub-modes (<computeroutput>generic</computeroutput>).
892	These options correspond
893	to the modes which are described in detail in <xref
894	linkend="networkingmodes" />.</para>
895	</listitem>
896
897	<listitem>
898	<para><computeroutput>--nictype<1-N>
899	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
900	This enables you to specify which networking hardware VirtualBox presents
901	to the guest for a specified VM virtual network card;
902	see <xref linkend="nichardware" />.</para>
903	</listitem>
904
905	<listitem>
906	<para><computeroutput>--cableconnected<1-N>
907	on\|off</computeroutput>: This enables you to temporarily disconnect
908	a virtual network interface, as if a network cable had been pulled
909	from a real network card. This might be useful e.g. for resetting
910	certain software components in the VM.</para>
911	</listitem>
912
913	<listitem>
914	<para>With the "nictrace" options, you can optionally trace
915	network traffic by dumping it to a file, for debugging
916	purposes.</para>
917
918	<para>With <computeroutput>--nictrace<1-N>
919	on\|off</computeroutput>, you can enable network tracing for a
920	particular virtual network card.</para>
921
922	<para>If enabled, you must specify with
923	<computeroutput>--nictracefile<1-N>
924	<filename></computeroutput> the absolute path of the file the trace should be
925	logged to.</para>
926	</listitem>
927
928	<listitem>
929	<para><computeroutput>--nicproperty<1-N>
930	<paramname>="paramvalue"</computeroutput>:
931	This option, in combination with "nicgenericdrv" allows you to
932	pass parameters to rarely-used network backends.</para>
933
934	<para>These parameters are backend engine-specific, and are different
935	between UDP Tunnel and the VDE backend drivers. For examples,
936	please see <xref linkend="network_udp_tunnel" />.
937	</para>
938	</listitem>
939
940	<listitem>
941	<para><computeroutput>--nicspeed<1-N> <kbps></computeroutput>:
942	If generic networking has been enabled for a particular virtual network
943	card (see the <computeroutput>--nic</computeroutput> option above - otherwise
944	this setting has no effect), this mode enables access to rarely used networking
945	sub-modes, such as VDE network or UDP Tunnel. This option specifies the
946	throughput rate in KBytes/sec.
947	</para>
948	</listitem>
949
950	<listitem>
951	<para><computeroutput>--nicbootprio<1-N>
952	<priority></computeroutput>: This specifies the order in which
953	NICs are tried for booting over the network (using PXE). The
954	priority is an integer in the 0 to 4 range. Priority 1 is the
955	highest, priority 4 is low. Priority 0, which is the default unless
956	otherwise specified, is the lowest.</para>
957
958	<para>Note that this option only has effect when the Intel PXE boot
959	ROM is used.</para>
960	</listitem>
961
962	<listitem>
963	<para><computeroutput>--nicpromisc<1-N>
964	deny\|allow-vms\|allow-all</computeroutput>:
965	This ernables you to specify how the promiscuous mode is handled for
966	the specified VM virtual network card.
967	This setting is only relevant for bridged networking.
968	<computeroutput>deny</computeroutput> (default setting) hides
969	any traffic not intended for this VM.
970	<computeroutput>allow-vms</computeroutput> hides all host
971	traffic from this VM but allows the VM to see traffic from/to other
972	VMs.
973	<computeroutput>allow-all</computeroutput> removes this
974	restriction completely.</para>
975	</listitem>
976
977	<listitem>
978	<para><computeroutput>--nicbandwidthgroup<1-N>
979	none\|<name></computeroutput>: This removes/adds an assignment
980	of a bandwidth group from/to the specified virtual network interface.
981	Specifying <computeroutput>none</computeroutput> removes any current
982	bandwidth group assignment from the specified virtual network interface.
983	Specifying <computeroutput><name></computeroutput> adds an
984	assignment of a bandwidth group to the specified virtual network
985	interface.</para>
986	<para>For details, please see <xref linkend="network_bandwidth_limit" />.</para>
987	</listitem>
988
989	<listitem>
990	<para><computeroutput>--bridgeadapter<1-N>
991	none\|<devicename></computeroutput>: If bridged networking
992	has been enabled for a virtual network card (see the
993	<computeroutput>--nic</computeroutput> option above; otherwise
994	this setting has no effect), use this option to specify which host
995	interface the given virtual network interface will use. For
996	details, please see <xref linkend="network_bridged" />.</para>
997	</listitem>
998
999	<listitem>
1000	<para><computeroutput>--hostonlyadapter<1-N>
1001	none\|<devicename></computeroutput>: If host-only networking
1002	has been enabled for a virtual network card (see the
1003	<computeroutput>--nic</computeroutput> option
1004	above; otherwise this setting has no effect), use this option to
1005	specify which host-only networking interface the given virtual
1006	network interface will use. For details, please see <xref
1007	linkend="network_hostonly" />.</para>
1008	</listitem>
1009
1010	<listitem>
1011	<para><computeroutput>--intnet<1-N>
1012	network</computeroutput>: If internal networking has been enabled
1013	for a virtual network card (see the
1014	<computeroutput>--nic</computeroutput> option above; otherwise
1015	this setting has no effect), use this option to specify the name
1016	of the internal network (see <xref
1017	linkend="network_internal" />).</para>
1018	</listitem>
1019
1020
1021	<listitem>
1022	<para><computeroutput>--nat-network<1-N> <network
1023	name></computeroutput>: If the networking type is set to
1024	<computeroutput>natnetwork</computeroutput> (not
1025	<computeroutput>nat</computeroutput>) then this setting specifies
1026	the name of the NAT network this adapter is connected to. Optional.</para>
1027	</listitem>
1028
1029	<listitem>
1030	<para><computeroutput>--nicgenericdrv<1-N>
1031	<backend driver></computeroutput>: If generic networking has been
1032	enabled for a virtual network card (see the
1033	<computeroutput>--nic</computeroutput> option above; otherwise
1034	this setting has no effect), this mode allows you to access
1035	rarely used networking sub-modes, such as VDE network or UDP Tunnel.
1036	</para>
1037	</listitem>
1038
1039	<listitem>
1040	<para><computeroutput>--macaddress<1-N>
1041	auto\|<mac></computeroutput>: With this option you can set
1042	the MAC address of a particular network adapter on the VM. Normally, each
1043	network adapter is assigned a random address by VirtualBox at
1044	VM creation.</para>
1045	</listitem>
1046	</itemizedlist></para>
1047
1048	<sect3>
1049	<title>NAT Networking settings.</title>
1050
1051	<para>The following NAT networking settings are available through
1052	<computeroutput>VBoxManage modifyvm</computeroutput>. With all these
1053	settings, the decimal number directly following the option name ("1-N"
1054	in the list below) specifies the virtual network adapter whose
1055	settings should be changed.<itemizedlist>
1056
1057	<listitem>
1058	<para><computeroutput>--natnet<1-N>
1059	<network>\|default</computeroutput>:
1060	If the networking type is set to <computeroutput>nat</computeroutput>
1061	(not <computeroutput>natnetwork</computeroutput>) then this
1062	setting specifies the IP address range to be used for
1063	this network. See <xref linkend="changenat" /> for an
1064	example.</para>
1065	</listitem>
1066
1067	<listitem>
1068	<para><computeroutput>--natpf<1-N>
1069	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
1070	<guestport></computeroutput>: This setting defines a NAT
1071	port-forwarding rule. See <xref linkend="natforward" />
1072	for details.</para>
1073	</listitem>
1074
1075	<listitem>
1076	<para><computeroutput>--natpf<1-N> delete
1077	<name></computeroutput>: This setting deletes a NAT
1078	port-forwarding rule. See <xref linkend="natforward" />
1079	for details.</para>
1080	</listitem>
1081
1082	<listitem>
1083	<para><computeroutput>--nattftpprefix<1-N>
1084	<prefix></computeroutput>: This setting defines a prefix
1085	for the built-in TFTP server, i.e. where the boot file is
1086	located. See <xref linkend="nat-tftp" /> and <xref
1087	linkend="nat-adv-tftp" /> for details.</para>
1088	</listitem>
1089
1090	<listitem>
1091	<para><computeroutput>--nattftpfile<1-N>
1092	<bootfile></computeroutput>: This setting defines the TFT
1093	boot file. See <xref linkend="nat-adv-tftp" /> for
1094	details.</para>
1095	</listitem>
1096
1097	<listitem>
1098	<para><computeroutput>--nattftpserver<1-N>
1099	<tftpserver></computeroutput>: This setting defines the
1100	TFTP server address to boot from. Please see <xref
1101	linkend="nat-adv-tftp" /> for details.</para>
1102	</listitem>
1103
1104	<listitem>
1105	<para><computeroutput>--nattbindip<1-N>
1106	<ip;></computeroutput>: VirtualBox's NAT engine normally routes
1107	TCP/IP packets through the default interface assigned by the host's
1108	TCP/IP stack. Use this setting to instruct the NAT engine to bind
1109	to a specified IP address instead. Please see <xref
1110	linkend="nat-adv-settings" /> for details.</para>
1111	</listitem>
1112
1113	<listitem>
1114	<para><computeroutput>--natdnspassdomain<1-N>
1115	on\|off</computeroutput>: This setting specifies whether the
1116	built-in DHCP server passes the domain name for network name
1117	resolution.</para>
1118	</listitem>
1119
1120	<listitem>
1121	<para><computeroutput>--natdnsproxy<1-N>
1122	on\|off</computeroutput>: This setting makes the NAT engine proxy
1123	all guest DNS requests to the host's DNS servers. Please see
1124	<xref linkend="nat-adv-dns" /> for details.</para>
1125	</listitem>
1126
1127	<listitem>
1128	<para><computeroutput>--natdnshostresolver<1-N>
1129	on\|off</computeroutput>: This setting makes the NAT engine use
1130	the host's resolver mechanisms to handle DNS requests. Please
1131	see <xref linkend="nat-adv-dns" /> for detailsx).</para>
1132	</listitem>
1133
1134	<listitem>
1135	<para><computeroutput>--natsettings<1-N>
1136	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
1137	[<tcprcv>]</computeroutput>: This setting controls several
1138	NAT settings. Please see <xref linkend="nat-adv-settings" /> for
1139	details.</para>
1140	</listitem>
1141
1142	<listitem>
1143	<para><computeroutput>--nataliasmode<1-N>
1144	default\|[log],[proxyonly],[sameports]</computeroutput>: This
1145	setting defines behaviour of NAT engine core: log - enables
1146	logging, proxyonly - switches of aliasing mode makes NAT
1147	transparent, sameports enforces NAT engine to send packets via
1148	the same port as they originated on, default - disable all
1149	mentioned modes above. Please see <xref
1150	linkend="nat-adv-alias" /> for details.</para>
1151	</listitem>
1152	</itemizedlist></para>
1153	</sect3>
1154	</sect2>
1155
1156	<sect2 id="vboxmanage-modifyvm-other">
1157	<title>Miscellaneous settings</title>
1158
1159	<para>The following other hardware settings, such as serial port, audio,
1160	clipboard, drag and drop, monitor and USB settings are available through
1161	<computeroutput>VBoxManage modifyvm</computeroutput>:<itemizedlist>
1162	<listitem>
1163	<para><computeroutput>--mouse <ps2\|usb\|usbtablet\|usbmultitouch></computeroutput>:
1164	Specifies the mode of the mouse to be used in the VM. Available options are: ps2, usb,
1165	usbtablet, usbmultitouch.
1166	</para>
1167	</listitem>
1168
1169	<listitem>
1170	<para><computeroutput>--keyboard <ps2\|usb></computeroutput>:
1171	Specifies the mode of the keyboard to be used in the VM. Available options are: ps2, usb.
1172	</para>
1173	</listitem>
1174	<listitem>
1175	<para><computeroutput>--uart<1-N> off\|<I/O base>
1176	<IRQ></computeroutput>: With this setting you can configure
1177	virtual serial ports for the VM. See <xref
1178	linkend="serialports" /> for an introduction.</para>
1179	</listitem>
1180
1181	<listitem>
1182	<para><computeroutput>--uartmode<1-N>
1183	<arg></computeroutput>: This setting controls how VirtualBox
1184	connects a given virtual serial port (previously configured with
1185	the <computeroutput>--uartX</computeroutput> setting, see above)
1186	to the host on which the virtual machine is running. As
1187	described in detail in <xref linkend="serialports" />, for each
1188	such port, you can specify <computeroutput><arg></computeroutput>
1189	as one of the following options:<itemizedlist>
1190	<listitem>
1191	<para><computeroutput>disconnected</computeroutput>: Even
1192	though the serial port is shown to the guest, it has no
1193	"other end" -- like a real COM port without a cable.</para>
1194	</listitem>
1195
1196	<listitem>
1197	<para><computeroutput>server
1198	<pipename></computeroutput>: On a Windows host, this
1199	tells VirtualBox to create a named pipe on the host named
1200	<computeroutput><pipename></computeroutput> and
1201	connect the virtual serial device to it. Note that Windows
1202	requires that the name of a named pipe begin with
1203	<computeroutput>\\.\pipe\</computeroutput>.</para>
1204
1205	<para>On a Linux host, instead of a named pipe, a local
1206	domain socket is used.</para>
1207	</listitem>
1208
1209	<listitem>
1210	<para><computeroutput>client
1211	<pipename></computeroutput>: This operates just like
1212	<computeroutput>server ...</computeroutput>, except that the
1213	pipe (or local domain socket) is not created by VirtualBox,
1214	but assumed to exist already.</para>
1215	</listitem>
1216
1217	<listitem>
1218	<para><computeroutput>tcpserver
1219	<port></computeroutput>: This
1220	tells VirtualBox to create a TCP socket on the host with TCP
1221	<computeroutput><port></computeroutput> and
1222	connect the virtual serial device to it. Note that UNIX-like
1223	systems require ports over 1024 for normal users.</para>
1224	</listitem>
1225
1226	<listitem>
1227	<para><computeroutput>tcpclient
1228	<hostname:port></computeroutput>: This operates just like
1229	<computeroutput>tcpserver ...</computeroutput>, except that the
1230	TCP socket is not created by VirtualBox,
1231	but assumed to exist already.</para>
1232	</listitem>
1233
1234	<listitem>
1235	<para><computeroutput>file <file></computeroutput>:
1236	This redirects the serial port output to a raw file <file>
1237	specified by its absolute path on the host file system.</para>
1238	</listitem>
1239
1240	<listitem>
1241	<para><computeroutput><devicename></computeroutput>:
1242	If, instead of the above, the device name of a physical
1243	hardware serial port of the host is specified, the virtual
1244	serial port is connected to that hardware port. On a Windows
1245	host, the device name will be a COM port such as
1246	<computeroutput>COM1</computeroutput>; on a Linux host, the
1247	device name will look like
1248	<computeroutput>/dev/ttyS0</computeroutput>. This allows you
1249	to "wire" a real serial port to a virtual machine.</para>
1250	</listitem>
1251	</itemizedlist></para>
1252	</listitem>
1253
1254	<listitem>
1255	<para><computeroutput>--lptmode<1-N>
1256	<Device></computeroutput>:
1257	Specifies the Device Name of the parallel port that
1258	the Parallel Port feature will be using. Use this
1259	<emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
1260	This feature is host operating system specific. For Windows hosts, use
1261	a device name like <emphasis>lpt1</emphasis> while on Linux
1262	hosts you have to use a device name like <emphasis>/dev/lp0</emphasis></para>
1263	</listitem>
1264
1265	<listitem>
1266	<para><computeroutput>--lpt<1-N>
1267	<I/O base> <IRQ></computeroutput>:
1268	Specifies the I/O address of the parallel port and the IRQ
1269	number that the Parallel Port feature will be using. Optional. Use this
1270	<emphasis>after</emphasis> <computeroutput>--lptmod</computeroutput>.
1271	I/O base address and IRQ are the values that guest sees i.e. the values
1272	avalable under guest Device Manager.</para>
1273	</listitem>
1274
1275	<listitem>
1276	<para><computeroutput>--audio none\|null\|dsound\|oss\|alsa\|pulse\|coreaudio</computeroutput>:
1277	With this setting, you can specify whether the VM should have audio support, and
1278	– if so – which type. The list of supported audio types depends on the
1279	host and can be determined with <computeroutput>VBoxManage modifyvm</computeroutput>.
1280	</para>
1281	</listitem>
1282
1283	<listitem>
1284	<para><computeroutput>--audiocontroller ac97\|hda\|sb16</computeroutput>: With
1285	this setting, you can specify the audio controller to be used with this
1286	VM.
1287	</para>
1288	</listitem>
1289
1290	<listitem>
1291	<para><computeroutput>--audiocodec stac9700\|ad1980\|stac9221\|sb16</computeroutput>: With
1292	this setting, you can specify the audio codec to be used with this VM.
1293	</para>
1294	</listitem>
1295
1296	<listitem>
1297	<para><computeroutput>--audioin on</computeroutput>: With
1298	this setting, you can specify whether capturing audio from the
1299	host is enabled or disabled.</para>
1300	</listitem>
1301
1302	<listitem>
1303	<para><computeroutput>--audioout on</computeroutput>: With
1304	this setting, you can specify whether audio playback from the guest
1305	is enabled or disabled.</para>
1306	</listitem>
1307
1308	<listitem>
1309	<para><computeroutput>--clipboard
1310	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1311	With this setting, you can select if and how the guest or host
1312	operating system's clipboard should be shared with the host or guest.
1313	See <xref linkend="generalsettings" />. This requires that the Guest
1314	Additions be installed in the virtual machine.</para>
1315	</listitem>
1316
1317	<listitem>
1318	<para><computeroutput>--draganddrop
1319	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1320	With this setting, you can specify the current drag and drop mode
1321	being used between the host and the virtual machine.
1322	See <xref linkend="guestadd-dnd" />. This requires that the Guest
1323	Additions be installed in the virtual machine.</para>
1324	</listitem>
1325
1326	<listitem>
1327	<para><computeroutput>--monitorcount
1328	<count></computeroutput>: This enables multi-monitor
1329	support. See <xref linkend="settings-display" />.</para>
1330	</listitem>
1331
1332	<listitem>
1333	<para><computeroutput>--usb on\|off</computeroutput>: This setting
1334	enables or disables the VM's virtual USB controller. See <xref
1335	linkend="settings-usb" /> for details.</para>
1336	</listitem>
1337
1338	<listitem>
1339	<para><computeroutput>--usbehci on\|off</computeroutput>: This
1340	setting enables or disables the VM's virtual USB 2.0 controller.
1341	See <xref linkend="settings-usb" /> for details.</para>
1342	</listitem>
1343
1344	<listitem>
1345	<para><computeroutput>--usbxhci on\|off</computeroutput>: This
1346	setting enables or disables the VM's virtual USB 3.0 controller.
1347	See <xref linkend="settings-usb" /> for details.</para>
1348	</listitem>
1349
1350	<listitem>
1351	<para><computeroutput>--usbrename
1352	<oldname> <newname></computeroutput>: This
1353	setting enables renaming of the VM's virtual USB controller from <oldname>
1354	to <newname>.</para>
1355	</listitem>
1356	</itemizedlist></para>
1357
1358	</sect2>
1359
1360	<sect2 id="vboxmanage-modifyvm-videocap">
1361	<title>Video Capture settings</title>
1362
1363	<para>The following settings for changing video recording parameters are
1364	available through <computeroutput>VBoxManage modifyvm</computeroutput>.
1365	<itemizedlist>
1366	<listitem>
1367	<para><computeroutput>--videocap on\|off</computeroutput>:
1368	This option enables or disables recording a VM session into a WebM/VP8
1369	file. If this option is enabled, recording will start when the VM
1370	session is started.</para>
1371	</listitem>
1372	<listitem>
1373	<para><computeroutput>--videocapscreens all\|<screen ID>
1374	[<screen ID> ...]</computeroutput>: This option allows to specify which screens of
1375	the VM are being recorded. Each screen is recorded into a separate file.</para>
1376	</listitem>
1377	<listitem>
1378	<para><computeroutput>--videocapfile <filename></computeroutput>:
1379	This option sets the filename VirtualBox uses to save the recorded content.
1380	</para>
1381	</listitem>
1382	<listitem>
1383	<para><computeroutput>--videocapres <width>x<height></computeroutput>:
1384	This option sets the resolution (in pixels) of the recorded video.</para>
1385	</listitem>
1386	<listitem>
1387	<para><computeroutput>--videocaprate <rate></computeroutput>:
1388	This option sets the bitrate in kilobits (kb) per second. Increasing this
1389	value makes the video look better for the cost of an increased file size.</para>
1390	</listitem>
1391	<listitem>
1392	<para><computeroutput>--videocapfps <fps></computeroutput>:
1393	This option sets the maximum number of frames per second (FPS) to be
1394	recorded. Frames with a higher frequency will be skipped. Reducing this
1395	value increases the number of skipped frames and reduces the file size.</para>
1396	</listitem>
1397	<listitem>
1398	<para><computeroutput>--videocapmaxtime <ms></computeroutput>:
1399	This option sets the maximum time in milliseconds the video capturing
1400	will be enabled since activation. The capturing stops when the defined
1401	time interval has elapsed. If this value is zero the capturing is not
1402	limited by time.</para>
1403	</listitem>
1404	<listitem>
1405	<para><computeroutput>--videocapmaxsize <MB></computeroutput>:
1406	This option limits the maximum size of the captured video file (in MB).
1407	The capturing stops when the file size has reached the specified size. If
1408	this value is zero the capturing will not be limited by file size.</para>
1409	</listitem>
1410	<listitem>
1411	<para><computeroutput>--videocapopts <key=value>
1412	[,<key=value> ...]</computeroutput>:
1413	This format can be used to specify additional video capturing options.
1414	These options only are for advanced users and must be specified in a
1415	comma-separated key=value format, e.g.
1416	<computeroutput>foo=bar,a=b</computeroutput>.
1417	</para>
1418	</listitem>
1419	</itemizedlist></para>
1420
1421	</sect2>
1422
1423	<sect2 id="vboxmanage-modifyvm-vrde">
1424	<title>Remote machine settings</title>
1425
1426	<para>The following settings that affect remote machine behavior are
1427	available through <computeroutput>VBoxManage
1428	modifyvm</computeroutput>:<itemizedlist>
1429	<listitem>
1430	<para><computeroutput>--vrde on\|off</computeroutput>:
1431	This enables or disables the VirtualBox remote desktop extension
1432	(VRDE) server.</para>
1433	</listitem>
1434
1435	<listitem>
1436	<para><computeroutput>--vrdeproperty "TCP/Ports\|Address=<value>"</computeroutput>
1437	sets the port number(s) and IP address on the VM that the VRDE server can bind to.</para>
1438
1439	<itemizedlist>
1440	<listitem>
1441	<para>For TCP/Ports, <value> should be a port or a range of ports that the VRDE
1442	server can bind to; "default" or "0" means port 3389, the standard port for RDP.
1443	For details, see the description for the
1444	<computeroutput>--vrdeport</computeroutput> option in <xref
1445	linkend="vboxmanage-modifyvm-vrde" />.</para>
1446	</listitem>
1447
1448	<listitem>
1449	<para>For TCP/Address, <value> should be the IP address of the host network
1450	interface that the VRDE server will bind to. If specified, the server
1451	will accept connections only on the specified host network interface.
1452	For details, see the description for the
1453	<computeroutput>--vrdeaddress</computeroutput> option in <xref
1454	linkend="vboxmanage-modifyvm-vrde" />.</para>
1455	</listitem>
1456	</itemizedlist>
1457	</listitem>
1458
1459	<listitem>
1460	<para><computeroutput>--vrdeproperty "VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>
1461	sets the VRDP video redirection properties.</para>
1462	<itemizedlist>
1463	<listitem>
1464	<para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on.
1465	For details, see <xref linkend="vrde-videochannel" />.</para>
1466	</listitem>
1467
1468	<listitem>
1469	<para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive,
1470	representing a JPEG compression level on the VRDE server video channel. Lower values mean lower
1471	quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para>
1472	</listitem>
1473
1474	<listitem>
1475	<para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to
1476	enable the videochannel downscale protection feature. When enabled, if a video's size equals the shadow buffer
1477	size, then it is regarded as a full screen video, and is displayed; but if its size is between fullscreen and the downscale
1478	threshold - it is NOT displayed, as it could be an application window, which would be unreadable when downscaled.
1479	When the downscale protection feature is disabled, an attempt is always made to display videos.</para>
1480	</listitem>
1481	</itemizedlist>
1482	</listitem>
1483
1484	<listitem>
1485	<para><computeroutput>--vrdeproperty "Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput></para>
1486	<para>disables one of the VRDE server features: Display, Input, Audio or USB respectively.
1487	To re-enable a feature, use e.g. "Client/DisableDisplay=".
1488	For details, see <xref linkend="vrde-customization" />.</para>
1489	</listitem>
1490
1491	<listitem>
1492	<para><computeroutput>--vrdeproperty "Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput></para>
1493	<para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively.
1494	To re-enable a feature, use e.g. "Client/DisableClipboard=".
1495	For details, see <xref linkend="vrde-customization" />.</para>
1496	</listitem>
1497
1498	<listitem>
1499	<para><computeroutput>--vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para>
1500	<para>disables the VRDE server feature: RDP device redirection for smart cards.
1501	To re-enable this feature, use "Client/DisableRDPR=".</para>
1502	</listitem>
1503
1504	<listitem>
1505	<para><computeroutput>--vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para>
1506	<para>enables the VRDE server feature: 3D redirection.
1507	To re-disable this feature, use "H3DRedirect/Enabled=".</para>
1508	</listitem>
1509
1510	<listitem>
1511	<para><computeroutput>--vrdeproperty "Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>
1512	sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection.
1513
1514	<itemizedlist>
1515	<listitem>
1516	<para><computeroutput>--vrdeproperty "Security/Method=<value>"</computeroutput>
1517	sets the desired security method, which is used for a connection. Valid values are:
1518	<itemizedlist>
1519	<listitem>
1520	<para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS)
1521	and Standard RDP Security connections are allowed. The security
1522	method is negotiated with the client. This is the default setting.</para>
1523	</listitem>
1524	<listitem>
1525	<para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para>
1526	</listitem>
1527	<listitem>
1528	<para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted.
1529	The client must support TLS.</para>
1530	</listitem>
1531	</itemizedlist>
1532	For details, see <xref linkend="vrde-crypt" />.</para>
1533	</listitem>
1534
1535	<listitem>
1536	<para><computeroutput>--vrdeproperty "Security/ServerCertificate=<value>"</computeroutput>
1537	where <value> is the absolute path of the server certificate.
1538	For details, see <xref linkend="vrde-crypt" />.</para>
1539	</listitem>
1540
1541	<listitem>
1542	<para><computeroutput>--vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput>
1543	where <value> is the absolute path of the server private key.
1544	For details, see <xref linkend="vrde-crypt" />.</para>
1545	</listitem>
1546
1547	<listitem>
1548	<para><computeroutput>--vrdeproperty "Security/CACertificate=<value>"</computeroutput>
1549	where <value> is the absolute path of the CA self signed certificate.
1550	For details, see <xref linkend="vrde-crypt" />.</para>
1551	</listitem>
1552	</itemizedlist></para>
1553	</listitem>
1554
1555	<listitem>
1556	<para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>
1557	sets the Audio connection mode, or Path of the audio logfile.
1558
1559	<itemizedlist>
1560	<listitem>
1561	<para><computeroutput>--vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput>
1562	where <value> is the desired rate correction mode, allowed values are:
1563	<itemizedlist>
1564	<listitem>
1565	<para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to unset any Audio mode already set.</para>
1566	</listitem>
1567	<listitem>
1568	<para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para>
1569	</listitem>
1570	<listitem>
1571	<para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para>
1572	</listitem>
1573	<listitem>
1574	<para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent under/overflow of the client queue.</para>
1575	</listitem>
1576	</itemizedlist></para>
1577	</listitem>
1578	<listitem>
1579	<para><computeroutput>--vrdeproperty "Audio/LogPath=<value>"</computeroutput>
1580	where <value> is the absolute path of the Audio log file.</para>
1581	</listitem>
1582	</itemizedlist></para>
1583	</listitem>
1584
1585	<listitem>
1586	<para><computeroutput>--vrdeextpack default\|<name></computeroutput>:
1587	Enables specification of the library for accessing the VM
1588	remotely. The default is to use the RDP code which is part of the
1589	Oracle VM VirtualBox Extension Pack.</para>
1590	</listitem>
1591
1592	<listitem>
1593	<para><computeroutput>--vrdeport
1594	default\|<ports></computeroutput>: A port or a range of ports
1595	the VRDE server can bind to; "default" or "0" means port 3389, the
1596	standard port for RDP. You can specify a comma-separated list of
1597	ports or ranges of ports. Use a dash between two port numbers to
1598	specify a range. The VRDE server will bind to <emphasis
1599	role="bold">one</emphasis> of the available ports from the specified
1600	list. Only one machine can use a given port at a time. For
1601	example, the option <computeroutput> --vrdeport
1602	5000,5010-5012</computeroutput> will tell the server to bind to
1603	one of following ports: 5000, 5010, 5011 or 5012.</para>
1604	</listitem>
1605
1606	<listitem>
1607	<para><computeroutput>--vrdeaddress <IP
1608	address></computeroutput>: The IP address of the host network
1609	interface the VRDE server will bind to. If specified, the server
1610	will accept connections only on the specified host network
1611	interface.</para>
1612	<para>The setting can be used to specify whether the VRDP server
1613	should accept either IPv4, IPv6 or both connections:
1614	<itemizedlist>
1615	<listitem>
1616	<para>only IPv4: <computeroutput>--vrdeaddress "0.0.0.0"
1617	</computeroutput></para>
1618	</listitem>
1619	<listitem>
1620	<para>only IPv6: <computeroutput>--vrdeaddress "::"
1621	</computeroutput></para>
1622	</listitem>
1623	<listitem>
1624	<para>both IPv6 and IPv4 (default): <computeroutput>--vrdeaddress ""
1625	</computeroutput></para>
1626	</listitem>
1627	</itemizedlist></para>
1628	</listitem>
1629
1630	<listitem>
1631	<para><computeroutput>--vrdeauthtype
1632	null\|external\|guest</computeroutput>: This enables you to indicate
1633	use of authorization, and specify how authorization will be performed;
1634	see <xref linkend="vbox-auth" /> for details.</para>
1635	</listitem>
1636
1637	<listitem>
1638	<para><computeroutput>--vrdeauthlibrary
1639	default\|<name></computeroutput>: This specifies the
1640	library used for RDP authentication, see <xref lang=""
1641	linkend="vbox-auth" /> for details.</para>
1642	</listitem>
1643
1644	<listitem>
1645	<para><computeroutput>--vrdemulticon on\|off</computeroutput>: This
1646	enables multiple connections to be made to the same VRDE server, if the
1647	server supports this feature; see <xref lang=""
1648	linkend="vrde-multiconnection" />.</para>
1649	</listitem>
1650
1651	<listitem>
1652	<para><computeroutput>--vrdereusecon on\|off</computeroutput>: This
1653	specifies the VRDE server behavior when multiple connections are
1654	disabled. When this option is enabled, the server will allow a new
1655	client to connect and will drop the existing connection. When this
1656	option is disabled (this is the default setting), a new connection
1657	will not be accepted if there is already a client connected to the
1658	server.</para>
1659	</listitem>
1660
1661	<listitem>
1662	<para><computeroutput>--vrdevideochannel on\|off</computeroutput>:
1663	This enables video redirection, if it is supported by the VRDE
1664	server; see <xref lang="" linkend="vrde-videochannel" />.</para>
1665	</listitem>
1666
1667	<listitem>
1668	<para><computeroutput>--vrdevideochannelquality
1669	<percent></computeroutput>: Specifies the image quality for video
1670	redirection; see <xref lang=""
1671	linkend="vrde-videochannel" />.</para>
1672	</listitem>
1673	</itemizedlist></para>
1674	</sect2>
1675
1676	<sect2 id="vboxmanage-modifyvm-teleport">
1677	<title>Teleporting settings</title>
1678
1679	<para>With the following commands for <computeroutput>VBoxManage
1680	modifyvm</computeroutput> you can configure a machine to be a target for
1681	teleporting. See <xref linkend="teleporting" /> for an
1682	introduction.<itemizedlist>
1683	<listitem>
1684	<para><computeroutput>--teleporter on\|off</computeroutput>:
1685	This setting enables/disables the teleporter feature whereby when the
1686	machine is started, it waits to receieve a teleporting request from the
1687	network instead of booting normally; teleporting requests are received on the
1688	port and address specified using the following two parameters.</para>
1689	</listitem>
1690
1691	<listitem>
1692	<para><computeroutput>--teleporterport
1693	<port></computeroutput>, <computeroutput>--teleporteraddress
1694	<address></computeroutput>: these settings must be used with
1695	--teleporter and they specify the port and address the virtual machine should
1696	listen to to receive a teleporting request sent from another virtual machine.
1697	<computeroutput><port></computeroutput> can
1698	be any free TCP/IP port number (e.g. 6000);
1699	<computeroutput><address></computeroutput> can be any IP
1700	address or hostname and specifies the TCP/IP socket to bind to.
1701	The default is "0.0.0.0", which means any address.</para>
1702	</listitem>
1703
1704	<listitem>
1705	<para><computeroutput>--teleporterpassword
1706	<password></computeroutput>: if this optional setting is
1707	given, then the teleporting request will only succeed if the
1708	source machine specifies the same password as the one given with
1709	this command.</para>
1710	</listitem>
1711
1712	<listitem>
1713	<para><computeroutput>--teleporterpasswordfile
1714	<password></computeroutput>: if this optional setting is
1715	given, then the teleporting request will only succeed if the
1716	source machine specifies the same password as the one specified
1717	in the file give with this command. Use <computeroutput>stdin</computeroutput>
1718	to read the password from stdin.</para>
1719	</listitem>
1720
1721	<listitem>
1722	<para><computeroutput>--cpuid <leaf> <eax> <ebx>
1723	<ecx> <edx></computeroutput>: Advanced users can use
1724	this setting before a teleporting operation to restrict the
1725	virtual CPU capabilities that VirtualBox presents to the guest
1726	operating system. This must be run on both the source and the
1727	target machines involved in the teleporting and will then modify
1728	what the guest sees when it executes the
1729	<computeroutput>CPUID</computeroutput> machine instruction. This
1730	might help with misbehaving applications that wrongly assume that
1731	certain CPU capabilities are present. The meaning of the
1732	parameters is hardware dependent; please refer to the AMD or Intel
1733	processor manuals.</para>
1734	</listitem>
1735	</itemizedlist></para>
1736	</sect2>
1737
1738	<sect2 id="vboxmanage-modifyvm-debugging">
1739	<title>Debugging settings</title>
1740
1741	<para>The following settings are only relevant for low-level VM
1742	debugging. Regular users will never need these settings.<itemizedlist>
1743	<listitem>
1744	<para><computeroutput>--tracing-enabled on\|off</computeroutput>:
1745	Enable the tracebuffer. This consumes some memory for the tracebuffer
1746	and adds extra overhead.</para>
1747	</listitem>
1748	<listitem>
1749	<para><computeroutput>--tracing-config <config-string></computeroutput>:
1750	Enables tracing configuration. In particular, this defines which group of
1751	tracepoints are enabled.</para>
1752	</listitem>
1753	<listitem>
1754	<para><computeroutput>--tracing-allow-vm-access on\|off</computeroutput>:
1755	Enables/disables(default) VM access to the tracebuffer.</para>
1756	</listitem>
1757	</itemizedlist>
1758	</para>
1759	</sect2>
1760
1761	<sect2 id="vboxmanage-usbcardreader">
1762	<title>USB card reader settings</title>
1763
1764	<para>The following setting defines access to a USB Card Reader by the guest environment.
1765	USB card readers are typically used for accessing data on memory cards such as
1766	CompactFlash (CF), Secure Digital (SD) or MultiMediaCard (MMC).</para>
1767	<itemizedlist>
1768	<listitem>
1769	<para><computeroutput>--usbcardreader on\|off</computeroutput>:
1770	Enables/disables the USB card reader interface.</para>
1771	</listitem>
1772	</itemizedlist>
1773	</sect2>
1774
1775	<sect2 id="vboxmanage-autostart">
1776	<title>Auto starting VMs during host system boot</title>
1777
1778	<para>These settings configure the VM autostart feature,
1779	which automatically starts the VM at host system boot-up.
1780	Note that there are pre-requisites that need to be addressed before using this feature.
1781	See <xref lang="" linkend="autostart" /> for more details.</para>
1782	<itemizedlist>
1783	<listitem>
1784	<para><computeroutput>--autostart on\|off</computeroutput>:
1785	Enables/disables VM autostart at host system boot-up, using specified user name.</para>
1786	</listitem>
1787	<listitem>
1788	<para><computeroutput>--autostart-delay <seconds></computeroutput>:
1789	Specifies a delay (seconds) following host system boot-up, before VM autostarts.</para>
1790	</listitem>
1791	</itemizedlist>
1792	</sect2>
1793	</sect1>
1794
1795	<sect1 id="vboxmanage-clonevm">
1796	<title>VBoxManage clonevm</title>
1797
1798	<para>This command creates a full or linked copy of an existing virtual
1799	machine.</para>
1800
1801	<para>The <computeroutput>clonevm</computeroutput> subcommand takes at
1802	least the name of the virtual machine which should be cloned. The following
1803	additional settings can be used to further configure the clone VM
1804	operation:</para>
1805
1806	<itemizedlist>
1807	<listitem>
1808	<para><computeroutput>--snapshot <uuid>\|<name></computeroutput>:
1809	Select a specific snapshot where the clone operation should refer
1810	to. Default is referring to the current state.</para>
1811	</listitem>
1812	<listitem>
1813	<para><computeroutput>--mode machine\|machineandchildren\|all</computeroutput>:
1814	Selects the cloning mode of the operation. If
1815	<computeroutput>machine</computeroutput> is selected (the default),
1816	the current state of the VM without any snapshots is cloned. In the
1817	<computeroutput>machineandchildren</computeroutput> mode the snapshot
1818	provided by <computeroutput>--snapshot</computeroutput> and all
1819	child snapshots are cloned. If <computeroutput>all</computeroutput>
1820	is the selected mode all snapshots and the current state are cloned.
1821	</para>
1822	</listitem>
1823	<listitem>
1824	<para><computeroutput>--options link\|keepallmacs\|keepnatmacs\|keepdisknames</computeroutput>:
1825	Allows additional fine tuning of the clone operation. The first
1826	option defines that a linked clone should be created, which is
1827	only possible for a machine cloned from a snapshot. The next two
1828	options enable specification of the handling of MAC addresses of
1829	every virtual network card. They can either be reinitialized
1830	(the default), left unchanged
1831	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
1832	when the network type is NAT
1833	(<computeroutput>keepnatmacs</computeroutput>). If you add
1834	<computeroutput>keepdisknames</computeroutput> all new disk images
1835	are called like the original ones, otherwise they are
1836	renamed.</para>
1837	</listitem>
1838	<listitem>
1839	<para><computeroutput>--name <name></computeroutput>: Select a
1840	new name for the new virtual machine. Default is "Original Name
1841	Clone".</para>
1842	</listitem>
1843	<listitem>
1844	<para><computeroutput>--groups <group>, ...</computeroutput>
1845	Enables the clone to be assigned membership of the specified
1846	VM groups in the list. Note that group ids always start with a
1847	<computeroutput>/</computeroutput> and can be nested. By default,
1848	clones are always assigned membership of the group
1849	<computeroutput>/</computeroutput>.</para>
1850	</listitem>
1851	<listitem>
1852	<para><computeroutput>--basefolder <basefolder></computeroutput>:
1853	Select the folder where the new virtual machine configuration should
1854	be saved in.</para>
1855	</listitem>
1856	<listitem>
1857	<para><computeroutput>--uuid <uuid></computeroutput>:
1858	Select the UUID the new VM should have. This id has to be unique in
1859	the VirtualBox instance this clone should be registered. Default is
1860	creating a new UUID.</para>
1861	</listitem>
1862	<listitem>
1863	<para><computeroutput>--register</computeroutput>:
1864	Automatically register the new clone in this VirtualBox
1865	installation. If you manually want to register the new VM later, see
1866	<xref linkend="vboxmanage-registervm" /> for instructions how to do
1867	so.</para>
1868	</listitem>
1869	</itemizedlist>
1870	</sect1>
1871
1872	<sect1 id="vboxmanage-import">
1873	<title>VBoxManage import</title>
1874
1875	<para>This command imports a virtual appliance in OVF format by copying
1876	the virtual disk images and creating virtual machines in VirtualBox. See
1877	<xref linkend="ovf" /> for an introduction to appliances.</para>
1878
1879	<para>The <computeroutput>import</computeroutput> subcommand takes at
1880	least the path name of an OVF file as input and expects the disk images,
1881	if needed, in the same directory as the OVF file. A lot of additional
1882	command-line options are supported to control in detail what is being
1883	imported and modify the import parameters, but the details depend on the
1884	content of the OVF file.</para>
1885
1886	<para>It is therefore recommended to first run the import subcommand with
1887	the <computeroutput>--dry-run</computeroutput> or
1888	<computeroutput>-n</computeroutput> option. This will then print a
1889	description of the appliance's contents to the screen how it would be
1890	imported into VirtualBox, together with the optional command-line options
1891	to influence the import behavior.</para>
1892
1893	<para>Use of the <computeroutput>--options link\|keepallmacs\|keepnatmacs\|keepdisknames</computeroutput>:
1894	option enables additional fine tuning of the clone operation. The first
1895	option defines that a linked clone should be created, which is
1896	only possible for a machine clone from a snapshot. The next two
1897	options enable specification of how the MAC addresses of every virtual
1898	network card should be handled. They can either be reinitialized
1899	(the default), left unchanged
1900	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
1901	when the network type is NAT
1902	(<computeroutput>keepnatmacs</computeroutput>). If you add
1903	<computeroutput>keepdisknames</computeroutput> all new disk images
1904	are assigned the same names as the originals, otherwise they are
1905	renamed.</para>
1906
1907	<para>As an example, here is the screen output with a sample appliance
1908	containing a Windows XP guest:<screen>VBoxManage import WindowsXp.ovf --dry-run
1909	Interpreting WindowsXp.ovf...
1910	OK.
1911	Virtual system 0:
1912	0: Suggested OS type: "WindowsXP"
1913	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
1914	1: Suggested VM name "Windows XP Professional_1"
1915	(change with "--vsys 0 --vmname <name>")
1916	3: Number of CPUs: 1
1917	(change with "--vsys 0 --cpus <n>")
1918	4: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
1919	5: Sound card (appliance expects "ensoniq1371", can change on import)
1920	(disable with "--vsys 0 --unit 5 --ignore")
1921	6: USB controller
1922	(disable with "--vsys 0 --unit 6 --ignore")
1923	7: Network adapter: orig bridged, config 2, extra type=bridged
1924	8: Floppy
1925	(disable with "--vsys 0 --unit 8 --ignore")
1926	9: SCSI controller, type BusLogic
1927	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
1928	disable with "--vsys 0 --unit 9 --ignore")
1929	10: IDE controller, type PIIX4
1930	(disable with "--vsys 0 --unit 10 --ignore")
1931	11: Hard disk image: source image=WindowsXp.vmdk,
1932	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
1933	(change controller with "--vsys 0 --unit 11 --controller <id>";
1934	disable with "--vsys 0 --unit 11 --ignore")</screen></para>
1935
1936	<para>As you can see, the individual configuration items are numbered, and
1937	depending on their type support different command-line options. The import
1938	subcommand can be directed to ignore many such items with a
1939	<computeroutput>--vsys X --unit Y --ignore</computeroutput> option, where
1940	X is the number of the virtual system (zero unless there are several
1941	virtual system descriptions in the appliance) and Y the item number, as
1942	printed on the screen.</para>
1943
1944	<para>In the above example, Item #1 specifies the name of the target
1945	machine in VirtualBox. Items #9 and #10 specify hard disk controllers,
1946	respectively. Item #11 describes a hard disk image; in this case, the
1947	additional <computeroutput>--controller</computeroutput> option indicates
1948	which item the disk image should be connected to, with the default coming
1949	from the OVF file.</para>
1950
1951	<para>You can combine several items for the same virtual system behind the
1952	same <computeroutput>--vsys</computeroutput> option. For example, to
1953	import a machine as described in the OVF, but without the sound card and
1954	without the USB controller, and with the disk image connected to the IDE
1955	controller instead of the SCSI controller, use this:<screen>VBoxManage import WindowsXp.ovf
1956	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen></para>
1957	</sect1>
1958
1959	<sect1 id="vboxmanage-export">
1960	<title>VBoxManage export</title>
1961
1962	<para>This command exports one or more virtual machines from VirtualBox
1963	into a virtual appliance in OVF format, including copying their virtual
1964	disk images to compressed VMDK. See <xref linkend="ovf" /> for an
1965	introduction to appliances.</para>
1966
1967	<para>The <computeroutput>export</computeroutput> command is simple to
1968	use: list the machine (or the machines) that you would like to export to
1969	the same OVF file and specify the target OVF file after an additional
1970	<computeroutput>--output</computeroutput> or
1971	<computeroutput>-o</computeroutput> option. Note that the directory of the
1972	target OVF file will also receive the exported disk images in the
1973	compressed VMDK format (regardless of the original format) and should have
1974	enough disk space left for them.</para>
1975
1976	<para>Beside a simple export of a given virtual machine, you can append
1977	several product information to the appliance file. Use
1978	<computeroutput>--product</computeroutput>,
1979	<computeroutput>--producturl</computeroutput>,
1980	<computeroutput>--vendor</computeroutput>,
1981	<computeroutput>--vendorurl</computeroutput>,
1982	<computeroutput>--version</computeroutput> and
1983	<computeroutput>--description</computeroutput> to specify this additional
1984	information. For legal reasons you may add a license text or the content
1985	of a license file by using the <computeroutput>--eula</computeroutput> and
1986	<computeroutput>--eulafile</computeroutput> option respectively. As with
1987	OVF import, you must use the <computeroutput>--vsys X</computeroutput>
1988	option to direct the previously mentioned options to the correct virtual
1989	machine.</para>
1990
1991	<para>For virtualization products which aren't fully compatible with the
1992	OVF standard 1.0 you can enable a OVF 0.9 legacy mode with the
1993	<computeroutput>--legacy09</computeroutput> option. Other options are
1994	--ovf09, --ovf10, --ovf20.</para>
1995
1996	<para>To specify options controlling the exact content of the appliance
1997	file, you can use <computeroutput>--options</computeroutput> to request the
1998	creation of a manifest file (encouraged, allows detection of corrupted
1999	appliances on import), the additional export of DVD images, and the
2000	exclusion of MAC addresses. You can specify a list of options, e.g.
2001	<computeroutput>--options manifest,nomacs</computeroutput>. For details,
2002	check the help output of <computeroutput>VBoxManage export</computeroutput>.</para>
2003	</sect1>
2004
2005	<sect1 id="vboxmanage-startvm">
2006	<title>VBoxManage startvm</title>
2007
2008	<para>This command starts a virtual machine that is currently in the
2009	"Powered off" or "Saved" states.</para>
2010
2011	<para>The optional <computeroutput>--type</computeroutput> specifier
2012	determines whether the machine will be started in a window or whether the
2013	output should go through <computeroutput>VBoxHeadless</computeroutput>,
2014	with VRDE enabled or not; see <xref linkend="vboxheadless" /> for more
2015	information. The list of types is subject to change, and it's not
2016	guaranteed that all types are accepted by any product variant.</para>
2017
2018	<para>The global or per-VM default value for the VM frontend type will be
2019	taken if the type is not explicitly specified. If none of these are set,
2020	the GUI variant will be started.</para>
2021
2022	<para>The following values are allowed:</para>
2023
2024	<glosslist>
2025	<glossentry>
2026	<glossterm><computeroutput>gui</computeroutput></glossterm>
2027
2028	<glossdef>
2029	<para>Starts a VM showing a GUI window. This is the default.</para>
2030	</glossdef>
2031	</glossentry>
2032
2033	<glossentry>
2034	<glossterm><computeroutput>headless</computeroutput></glossterm>
2035
2036	<glossdef>
2037	<para>Starts a VM without a window for remote display only.</para>
2038	</glossdef>
2039	</glossentry>
2040
2041	<glossentry>
2042	<glossterm><computeroutput>sdl</computeroutput></glossterm>
2043
2044	<glossdef>
2045	<para>Starts a VM with a minimal GUI and limited features.</para>
2046	</glossdef>
2047	</glossentry>
2048
2049	<glossentry>
2050	<glossterm><computeroutput>separate</computeroutput></glossterm>
2051
2052	<glossdef>
2053	<para>Starts a VM with detachable UI (technically it is a headless VM
2054	with user interface in a separate process). This is an experimental
2055	feature as it lacks certain functionality at the moment (e.g. 3D
2056	acceleration will not work).</para>
2057	</glossdef>
2058	</glossentry>
2059	</glosslist>
2060
2061	<note>
2062	<para>If you experience problems with starting virtual machines with
2063	particular frontends and there is no conclusive error information,
2064	consider starting virtual machines directly by running the respective
2065	front-end, as this can give additional error information.</para>
2066	</note>
2067	</sect1>
2068
2069	<sect1 id="vboxmanage-controlvm">
2070	<title>VBoxManage controlvm</title>
2071
2072	<para>The <computeroutput>controlvm</computeroutput> subcommand allows you
2073	to change the state of a virtual machine that is currently running. The
2074	following can be specified:</para>
2075
2076	<para><itemizedlist>
2077	<listitem>
2078	<para><computeroutput>VBoxManage controlvm <vm>
2079	pause</computeroutput> temporarily puts a virtual machine on hold,
2080	without changing its state for good. The VM window will be painted
2081	in gray to indicate that the VM is currently paused. (This is
2082	equivalent to selecting the "Pause" item in the "Machine" menu of
2083	the GUI).</para>
2084	</listitem>
2085
2086	<listitem>
2087	<para>Use <computeroutput>VBoxManage controlvm <vm>
2088	resume</computeroutput> to undo a previous
2089	<computeroutput>pause</computeroutput> command. (This is equivalent
2090	to selecting the "Resume" item in the "Machine" menu of the
2091	GUI.)</para>
2092	</listitem>
2093
2094	<listitem>
2095	<para><computeroutput>VBoxManage controlvm <vm>
2096	reset</computeroutput> has the same effect on a virtual machine as
2097	pressing the "Reset" button on a real computer: a cold reboot of the
2098	virtual machine, which will restart and boot the guest operating
2099	system again immediately. The state of the VM is not saved
2100	beforehand, and data may be lost. (This is equivalent to selecting
2101	the "Reset" item in the "Machine" menu of the GUI).</para>
2102	</listitem>
2103
2104	<listitem>
2105	<para><computeroutput>VBoxManage controlvm <vm>
2106	poweroff</computeroutput> has the same effect on a virtual machine
2107	as pulling the power cable on a real computer. Again, the state of
2108	the VM is not saved beforehand, and data may be lost. (This is
2109	equivalent to selecting the "Close" item in the "Machine" menu of
2110	the GUI or pressing the window's close button, and then selecting
2111	"Power off the machine" in the dialog).</para>
2112
2113	<para>After this, the VM's state will be "Powered off". From there,
2114	it can be started again; see <xref
2115	linkend="vboxmanage-startvm" />.</para>
2116	</listitem>
2117
2118	<listitem>
2119	<para><computeroutput>VBoxManage controlvm <vm>
2120	savestate</computeroutput> will save the current state of the VM to
2121	disk and then stop the VM. (This is equivalent to selecting the
2122	"Close" item in the "Machine" menu of the GUI or pressing the
2123	window's close button, and then selecting "Save the machine state"
2124	in the dialog.)</para>
2125
2126	<para>After this, the VM's state will be "Saved". From there, it can
2127	be started again; see <xref linkend="vboxmanage-startvm" />.</para>
2128	</listitem>
2129
2130	<listitem>
2131	<para><computeroutput>VBoxManage controlvm <vm>
2132	acpipowerbutton</computeroutput> will send an ACPI shutdown signal to
2133	the VM, as if the power button on a real computer had been pressed.
2134	So long as the VM is running a fairly modern guest operating system
2135	providing ACPI support, this should trigger a proper shutdown mechanism
2136	from within the VM.</para>
2137	</listitem>
2138
2139	<listitem>
2140	<para><computeroutput>VBoxManage controlvm <vm>
2141	keyboardputscancode <hex> [<hex>...]</computeroutput>
2142	Sends commands using keycodes to the VM. Keycodes are documented in the
2143	public domain, e.g. http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.</para>
2144	</listitem>
2145
2146	<listitem>
2147	<para><computeroutput>VBoxManage controlvm "VM name" teleport
2148	--hostname <name> --port <port> [--passwordfile
2149	<file> \| --password <password>]</computeroutput> makes
2150	the machine the source of a teleporting operation and initiates a
2151	teleport to the given target. See <xref linkend="teleporting" /> for
2152	an introduction. If the optional password is specified, it must match
2153	the password that was given to the
2154	<computeroutput>modifyvm</computeroutput> command for the target
2155	machine; see <xref linkend="vboxmanage-modifyvm-teleport" /> for
2156	details.</para>
2157	</listitem>
2158	</itemizedlist></para>
2159
2160	<para>A few extra options are available with
2161	<computeroutput>controlvm</computeroutput> that do not directly affect the
2162	VM's running state:</para>
2163
2164	<itemizedlist>
2165	<listitem>
2166	<para>The <computeroutput>setlinkstate<1-N></computeroutput>
2167	operation connects or disconnects virtual network cables from their
2168	network interfaces.</para>
2169	</listitem>
2170
2171	<listitem>
2172	<para><computeroutput>nic<1-N>
2173	null\|nat\|bridged\|intnet\|hostonly\|generic\|natnetwork[<devicename>]</computeroutput>:
2174	specifies the type of networking that should be made available on the specified VM
2175	virtual network card.
2176	They can be: not connected to the host
2177	(<computeroutput>null</computeroutput>), use network address
2178	translation (<computeroutput>nat</computeroutput>), bridged networking
2179	(<computeroutput>bridged</computeroutput>) or communicate with other
2180	virtual machines using internal networking
2181	(<computeroutput>intnet</computeroutput>) or host-only networking
2182	(<computeroutput>hostonly</computeroutput>) or natnetwork networking
2183	(<computeroutput>natnetwork</computeroutput>) or access to rarely used
2184	sub-modes
2185	(<computeroutput>generic</computeroutput>).
2186	These options correspond to the modes which are described in detail in <xref
2187	linkend="networkingmodes" />.</para>
2188	</listitem>
2189
2190	<listitem>
2191	<para>With the "nictrace" options, you can optionally trace network traffic by dumping
2192	it to a file, for debugging purposes.</para>
2193
2194	<para>With <computeroutput>nictrace<1-N>
2195	on\|off</computeroutput>, you can enable network tracing for a particular virtual
2196	network card.</para>
2197
2198	<para>If enabled, you must specify with
2199	<computeroutput>--nictracefile<1-N>
2200	<filename></computeroutput> the pathname of the file to which the trace should be
2201	logged.</para>
2202	</listitem>
2203
2204	<listitem>
2205	<para><computeroutput>nicpromisc<1-N>
2206	deny\|allow-vms\|allow-all</computeroutput>:
2207	This specifies how the promiscious mode is handled for the specified VM
2208	virtual network card. This setting is only relevant for bridged networking.
2209	<computeroutput>deny</computeroutput> (default setting) hides
2210	any traffic not intended for this VM.
2211	<computeroutput>allow-vms</computeroutput> hides all host
2212	traffic from this VM but allows the VM to see traffic from/to other
2213	VMs.
2214	<computeroutput>allow-all</computeroutput> removes this
2215	restriction completely.</para>
2216	</listitem>
2217
2218	<listitem>
2219	<para><computeroutput>nicproperty<1-N>
2220	<paramname>="paramvalue"</computeroutput>:
2221	This option, in combination with "nicgenericdrv" enables you to
2222	pass parameters to rarely-used network backends.</para><para>
2223	Those parameters are backend engine-specific, and are different
2224	between UDP Tunnel and the VDE backend drivers. For example,
2225	please see <xref linkend="network_udp_tunnel" />.
2226	</para>
2227	</listitem>
2228
2229	<listitem>
2230	<para><computeroutput>natpf<1-N>
2231	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
2232	<guestport></computeroutput>: This option specifies a NAT
2233	port-forwarding rule (please see <xref linkend="natforward"/>
2234	for details).
2235	</para>
2236	</listitem>
2237
2238	<listitem>
2239	<para><computeroutput>natpf<1-N> delete
2240	<name></computeroutput>: This option deletes a NAT
2241	port-forwarding rule (please see <xref linkend="natforward"/>
2242	for details).</para>
2243	</listitem>
2244
2245	<listitem>
2246	<para>The <computeroutput>guestmemoryballoon<balloon size in MB></computeroutput>
2247	operation changes the size of the guest memory balloon, that is,
2248	memory allocated by the VirtualBox Guest Additions from the guest
2249	operating system and returned to the hypervisor for re-use by other
2250	virtual machines. This must be specified in megabytes. For details,
2251	see <xref linkend="guestadd-balloon" />.</para>
2252	</listitem>
2253
2254	<listitem>
2255	<para><computeroutput>usbattach<uuid\|address> [--capturefile <filename>]</computeroutput></para>
2256	<para>and <computeroutput>usbdetach <uuid\|address> [--capturefile <filename>]</computeroutput>
2257	make host USB devices visible/invisible to the virtual machine on the fly, without the need for
2258	creating filters first. The USB devices can be specified by UUID
2259	(unique identifier) or by address on the host system. Use the --capturefile
2260	option to specify the absolute path of a file for writing activity logging data.</para>
2261
2262	<para>You can use <computeroutput>VBoxManage list
2263	usbhost</computeroutput> to locate this information.</para>
2264	</listitem>
2265
2266	<listitem>
2267	<para><computeroutput>audioin on</computeroutput>: With
2268	this setting, you can select whether capturing audio from the
2269	host is enabled or disabled.</para>
2270	</listitem>
2271
2272	<listitem>
2273	<para><computeroutput>audioout on</computeroutput>: With
2274	this setting, you can select whether audio playback from the guest
2275	is enabled or disabled.</para>
2276	</listitem>
2277
2278	<listitem>
2279	<para><computeroutput>clipboard
2280	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
2281	With this setting, you can select if and how the guest or host
2282	operating system's clipboard should be shared with the host or guest;
2283	see <xref linkend="generalsettings" />. This requires that the Guest
2284	Additions be installed in the virtual machine.</para>
2285	</listitem>
2286
2287	<listitem>
2288	<para><computeroutput>draganddrop
2289	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
2290	With this setting, you can select the current drag and drop mode
2291	being used between the host and the virtual machine;
2292	see <xref linkend="guestadd-dnd" />. This requires that the Guest
2293	Additions be installed in the virtual machine.</para>
2294	</listitem>
2295
2296	<listitem>
2297	<para><computeroutput>vrde on\|off</computeroutput> lets you enable or
2298	disable the VRDE server, if it is installed.</para>
2299	</listitem>
2300
2301	<listitem>
2302	<para><computeroutput>vrdeport default\|<ports></computeroutput>
2303	changes the port or a range of ports that the VRDE server can bind to;
2304	"default" or "0" means port 3389, the standard port for RDP. For
2305	details, see the description for the
2306	<computeroutput>--vrdeport</computeroutput> option in <xref
2307	linkend="vboxmanage-modifyvm-vrde" />.</para>
2308	</listitem>
2309
2310	<listitem>
2311	<para><computeroutput>vrdeproperty "TCP/Ports\|Address=<value>"</computeroutput>
2312	sets the port number(s) and IP address on the VM to which the VRDE server can bind.</para>
2313
2314	<itemizedlist>
2315	<listitem>
2316	<para>For TCP/Ports, <value> should be a port or a range of ports to which
2317	the VRDE server can bind; "default" or "0" means port 3389, the standard port for RDP.
2318	For details, see the description for the
2319	<computeroutput>--vrdeport</computeroutput> option in <xref
2320	linkend="vboxmanage-modifyvm-vrde" />.</para>
2321	</listitem>
2322
2323	<listitem>
2324	<para>For TCP/Address, <value> should be the IP address of the host network
2325	interface that the VRDE server will bind to. If specified, the server
2326	will accept connections only on the specified host network interface.
2327	For details, see the description for the
2328	<computeroutput>--vrdeaddress</computeroutput> option in <xref
2329	linkend="vboxmanage-modifyvm-vrde" />.</para>
2330	</listitem>
2331	</itemizedlist>
2332	</listitem>
2333
2334	<listitem>
2335	<para><computeroutput>vrdeproperty "VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>
2336	sets the VRDP video redirection properties.</para>
2337	<itemizedlist>
2338	<listitem>
2339	<para>For VideoChannel/Enabled, <value> can be set to "1" switching the VRDP video channel on.
2340	For details, see <xref linkend="vrde-videochannel" />.</para>
2341	</listitem>
2342
2343	<listitem>
2344	<para>For VideoChannel/Quality, <value> should be set between 10 and 100% inclusive,
2345	representing a JPEG compression level on the VRDE server video channel. Lower values mean lower
2346	quality but higher compression. For details, see <xref linkend="vrde-videochannel" />.</para>
2347	</listitem>
2348
2349	<listitem>
2350	<para>For VideoChannel/DownscaleProtection, <value> can be set to "1" to enable the
2351	videochannel downscale protection feature. When enabled, if a video's size equals the shadow
2352	buffer size, then it is regarded as a full screen video, and is displayed; but if its size
2353	is between fullscreen and the downscale threshold - it is NOT displayed, as it could be an
2354	application window, which would be unreadable when downscaled.
2355	When the downscale protection feature is disabled, an attempt is always made to display videos.</para>
2356	</listitem>
2357	</itemizedlist>
2358	</listitem>
2359
2360	<listitem>
2361	<para><computeroutput>vrdeproperty "Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput></para>
2362	<para>disables one of the VRDE server features: Display, Input, Audio or USB respectively.
2363	To re-enable a feature, use e.g. "Client/DisableDisplay=".
2364	For details, see <xref linkend="vrde-customization" />.</para>
2365	</listitem>
2366
2367	<listitem>
2368	<para><computeroutput>vrdeproperty "Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput></para>
2369	<para>disables one of the VRDE server features: Clipboard or UpstreamAudio respectively.
2370	To re-enable a feature, use e.g. "Client/DisableClipboard=".
2371	For details, see <xref linkend="vrde-customization" />.</para>
2372	</listitem>
2373
2374	<listitem>
2375	<para><computeroutput>vrdeproperty "Client/DisableRDPDR=1"</computeroutput></para>
2376	<para>disables the VRDE server feature: RDP device redirection for smart cards.
2377	To re-enable this feature, use "Client/DisableRDPR=".</para>
2378	</listitem>
2379
2380	<listitem>
2381	<para><computeroutput>vrdeproperty "H3DRedirect/Enabled=1"</computeroutput></para>
2382	<para>enables the VRDE server feature: 3D redirection.
2383	To re-disable this feature, use "H3DRedirect/Enabled=".</para>
2384	</listitem>
2385
2386	<listitem>
2387	<para><computeroutput>vrdeproperty "Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>
2388	sets the desired security method/Path of server certificate, path of server private key, path of CA certificate, used for a connection.
2389
2390	<itemizedlist>
2391	<listitem>
2392	<para><computeroutput>vrdeproperty "Security/Method=<value>"</computeroutput>
2393	sets the desired security method, which is used for a connection. Valid values are:
2394	<itemizedlist>
2395	<listitem>
2396	<para> <computeroutput>Negotiate</computeroutput> - both Enhanced (TLS)
2397	and Standard RDP Security connections are allowed. The security
2398	method is negotiated with the client. This is the default setting.</para>
2399	</listitem>
2400	<listitem>
2401	<para> <computeroutput>RDP</computeroutput> - only Standard RDP Security is accepted.</para>
2402	</listitem>
2403	<listitem>
2404	<para> <computeroutput>TLS</computeroutput> - only Enhanced RDP Security is accepted.
2405	The client must support TLS.</para>
2406	</listitem>
2407	</itemizedlist>
2408	For details, see <xref linkend="vrde-crypt" />.</para>
2409	</listitem>
2410
2411	<listitem>
2412	<para><computeroutput>vrdeproperty "Security/ServerCertificate=<value>"</computeroutput>
2413	where <value> is the absolute path of the server certificate.
2414	For details, see <xref linkend="vrde-crypt" />.</para>
2415	</listitem>
2416
2417	<listitem>
2418	<para><computeroutput>vrdeproperty "Security/ServerPrivateKey=<value>"</computeroutput>
2419	where <value> is the absolute path of the server private key.
2420	For details, see <xref linkend="vrde-crypt" />.</para>
2421	</listitem>
2422
2423	<listitem>
2424	<para><computeroutput>vrdeproperty "Security/CACertificate=<value>"</computeroutput>
2425	where <value> is the absolute path of the CA self signed certificate.
2426	For details, see <xref linkend="vrde-crypt" />.</para>
2427	</listitem>
2428	</itemizedlist></para>
2429	</listitem>
2430
2431	<listitem>
2432	<para><computeroutput>vrdeproperty "Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>
2433	sets the Audio connection mode, or Path of the audio logfile.
2434
2435	<itemizedlist>
2436	<listitem>
2437	<para><computeroutput>vrdeproperty "Audio/RateCorrectionMode=<value>"</computeroutput>
2438	where <value> is the desired rate correction mode, allowed values are:
2439	<itemizedlist>
2440	<listitem>
2441	<para> <computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput> - no mode specified, use to
2442	unset any Audio mode already set.</para>
2443	</listitem>
2444	<listitem>
2445	<para> <computeroutput>VRDP_AUDIO_MODE_RC</computeroutput> - rate correction mode.</para>
2446	</listitem>
2447	<listitem>
2448	<para> <computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput> - low pass filter mode.</para>
2449	</listitem>
2450	<listitem>
2451	<para> <computeroutput>VRDP_AUDIO_MODE_CS</computeroutput> - client sync mode to prevent
2452	under/overflow of the client queue.</para>
2453	</listitem>
2454	</itemizedlist></para>
2455	</listitem>
2456	<listitem>
2457	<para><computeroutput>vrdeproperty "Audio/LogPath=<value>"</computeroutput>
2458	where <value> is the absolute path of the Audio log file.</para>
2459	</listitem>
2460	</itemizedlist></para>
2461	</listitem>
2462
2463	<listitem>
2464	<para><computeroutput>vrdevideochannelquality
2465	<percent></computeroutput>: Sets the image quality for video
2466	redirection; see <xref lang=""
2467	linkend="vrde-videochannel" />.</para>
2468	</listitem>
2469
2470	<listitem>
2471	<para><computeroutput>setvideomodehint</computeroutput> requests that
2472	the guest system change to a particular video mode. This requires that
2473	the Guest Additions be installed, and will not work for all guest
2474	systems.</para>
2475	</listitem>
2476
2477	<listitem>
2478	<para><computeroutput>screenshotpng</computeroutput> takes a screenshot
2479	of the guest display and saves it in PNG format.</para>
2480	</listitem>
2481
2482	<listitem>
2483	<para><computeroutput>videocap on\|off</computeroutput> enables or disables
2484	recording a VM session into a WebM/VP8 file.</para>
2485	</listitem>
2486
2487	<listitem>
2488	<para><computeroutput>videocapscreens all\|<screen ID>
2489	[<screen ID> ...]]</computeroutput> allows to specify which screens of
2490	the VM are being recorded. This setting
2491	cannot be changed while video capturing is enabled. Each screen is recorded
2492	into a separate file.</para>
2493	</listitem>
2494
2495	<listitem>
2496	<para><computeroutput>videocapfile <file></computeroutput> sets the filename
2497	VirtualBox uses to save the recorded content. This setting cannot be changed
2498	while video capturing is enabled.</para>
2499	</listitem>
2500
2501	<listitem>
2502	<para><computeroutput>videocapres <width> <height></computeroutput>
2503	sets the resolution (in pixels) of the recorded video. This setting cannot be
2504	changed while video capturing is enabled.</para>
2505	</listitem>
2506
2507	<listitem> <!-- @todo r=andy Clarify rate. -->
2508	<para><computeroutput>videocaprate <rate></computeroutput> sets the
2509	bitrate in kilobits (kb) per second. Increasing this value makes the video
2510	look better for the cost of an increased file size. This setting cannot be
2511	changed while video capturing is enabled.</para>
2512	</listitem>
2513
2514	<listitem>
2515	<para><computeroutput>videocapfps <fps></computeroutput> sets the
2516	maximum number of frames per second (FPS) to be recorded. Frames with a
2517	higher frequency will be skipped. Reducing this value increases the number
2518	of skipped frames and reduces the file size. This setting cannot be changed
2519	while video capturing is enabled.</para>
2520	</listitem>
2521
2522	<listitem> <!-- @todo r=andy Clarify time format. -->
2523	<para><computeroutput>videocapmaxtime <ms></computeroutput> sets
2524	the maximum time in milliseconds the video capturing will be enabled
2525	since activation.
2526	The capturing stops when the defined time interval has elapsed. If this
2527	value is zero the capturing is not limited by time. This setting cannot
2528	be changed while video capturing is enabled.</para>
2529	</listitem>
2530
2531	<listitem>
2532	<para><computeroutput>videocapmaxsize <MB></computeroutput> limits
2533	the maximum size of the captured video file (in MB). The capturing stops
2534	when the file size has reached the specified size. If this value is zero
2535	the capturing will not be limited by file size. This setting cannot be
2536	changed while video capturing is enabled.</para>
2537	</listitem>
2538
2539	<listitem>
2540	<para><computeroutput>videocapopts <key=value>[,<key=value> ...]</computeroutput>
2541	can be used to specify additional video capturing options. These options
2542	only are for advanced users and must be specified in a comma-separated
2543	key=value format, e.g. <computeroutput>foo=bar,a=b</computeroutput>.
2544	This setting cannot be changed while video capturing is enabled.</para>
2545	</listitem>
2546
2547	<listitem>
2548	<para>The <computeroutput>setcredentials</computeroutput> operation is
2549	used for remote logons in Windows guests. For details, please refer to
2550	<xref linkend="autologon" />.</para>
2551	</listitem>
2552
2553	<listitem>
2554	<para><computeroutput>teleport --host <name> --port <port></computeroutput>
2555	can be used to configure a VM as a target for teleporting.
2556	<name> specifies the virtual machine name. <port> specifies the port on the
2557	virtual machine which should listen for teleporting requests from other
2558	virtual machines. It can be any free TCP/IP port number (e.g. 6000);
2559	See <xref linkend="teleporting" /> for an introduction.</para>
2560	<itemizedlist>
2561	<listitem>
2562	<para><computeroutput>--maxdowntime <msec></computeroutput>:
2563	specifies the maximum downtime (milliseconds) for the
2564	teleporting target VM. Optional.</para>
2565	</listitem>
2566
2567	<listitem>
2568	<para><computeroutput>--password
2569	<password></computeroutput>:
2570	indicates that the teleporting request will only succeed if the
2571	source machine specifies the same password as the one given with
2572	this command. Optional.</para>
2573	</listitem>
2574
2575	<listitem>
2576	<para><computeroutput>--passwordfile
2577	<password file></computeroutput>:
2578	indicates that the teleporting request will only succeed if the
2579	source machine specifies the same password as the one specified
2580	in the password file with the path specified with this command.
2581	Use <computeroutput>stdin</computeroutput> to read the password
2582	from stdin. Optional.</para>
2583	</listitem>
2584	</itemizedlist>
2585	</listitem>
2586
2587	<listitem>
2588	<para><computeroutput>plugcpu\|unplugcpu
2589	<id></computeroutput>: If CPU hot-plugging is enabled, this adds
2590	a virtual CPU to the virtual machines (or removes one).
2591	<computeroutput><id></computeroutput> specifies the index of
2592	the virtual CPU to be added or removed and must be a number from 0
2593	to the maximum no. of CPUs configured. CPU 0 can never be removed.</para>
2594	</listitem>
2595
2596	<listitem>
2597	<para>The <computeroutput>cpuexecutioncap
2598	<1-100></computeroutput>: This operation controls how much cpu
2599	time a virtual CPU can use. A value of 50 implies a single virtual CPU
2600	can use up to 50% of a single host CPU.</para>
2601	</listitem>
2602
2603	<listitem>
2604	<para><computeroutput>webcam
2605	attach <path\|alias> [<key=value>[;<key=value>...]]</computeroutput>: This operation
2606	attaches a webcam to a running VM. Specify the absolute path of the
2607	webcam on the host operating system, or use its alias (obtained by using the command: VBoxManage
2608	list webcams).</para>
2609
2610	<para>Note that alias '.0' means default video input device on the host operating system, '.1', '.2',
2611	etc. mean first, second, etc. video input device. The device order is host-specific.</para>
2612
2613	<para>The optional settings parameter is a ';' delimited list of name/value pairs, enabling configuration
2614	of the emulated webcam device.</para>
2615
2616	<para>The following settings are supported:</para>
2617
2618	<para>MaxFramerate (default no maximum limit) - this specifies the highest rate (frames/sec) at which
2619	video frames are sent to the guest. Higher frame rates increase CPU load, so this setting can be useful
2620	when there is a need to reduce CPU load. Its default 'value' is 'no maximum limit', thus enabling the
2621	guest to use all frame rates supported by the host webcam.</para>
2622
2623	<para>MaxPayloadTransferSize (default 3060 bytes) - this specifies the maximum number of bytes the emulated
2624	webcam can send to the guest in one buffer. The default is used by some webcams. Higher values can
2625	slightly reduce CPU load, if the guest is able to use larger buffers.
2626	Note that higher MaxPayloadTransferSize values may be not supported by some guest operating systems.</para>
2627	</listitem>
2628
2629	<listitem>
2630	<para><computeroutput>webcam
2631	detach <path\|alias></computeroutput>: This operation
2632	detaches a webcam from a running VM. Specify the absolute path of the
2633	webcam on the host, or use its alias (obtained from webcam list below).</para>
2634	<para>Note the points below relating to specific Host Operating Systems:</para>
2635
2636	<para>Windows hosts</para>
2637
2638	<para>When the webcam device is detached from the host, the emulated webcam device
2639	is automatically detached from the guest.</para>
2640
2641	<para>Mac OS X hosts</para>
2642
2643	<para>OS X version 10.7 or newer is required.</para>
2644
2645	<para>When the webcam device is detached from the host, the emulated webcam device remains
2646	attached to the guest and must be manually detached using the
2647	VBoxManage controlvm "VM name" webcam detach command.</para>
2648
2649	<para>Linux hosts</para>
2650
2651	<para>When the webcam is detached from the host, the emulated webcam device is automatically detached
2652	from the guest only if the webcam is streaming video. If the emulated webcam is inactive, it
2653	should be manually detached using the VBoxManage controlvm "VM name" webcam detach command.</para>
2654	</listitem>
2655
2656	<listitem>
2657	<para><computeroutput>webcam list</computeroutput>: This operation
2658	lists webcams attached to the running VM.
2659	The output is a list of absolute paths or aliases that were used for attaching the webcams
2660	to the VM using the 'webcam attach' command above.
2661	</para>
2662	</listitem>
2663
2664	<listitem>
2665	<para><computeroutput>addencpassword
2666	<id> <password file>\|- [--removeonsuspend <yes\|no>]</computeroutput>: This operation
2667	supplies an encrypted VM specified by <id> with the encryption password to enable a headless start.
2668	Either specify the absolute path of a password file on the host file system: <password file>, or
2669	use a '-' to instruct VBoxManage to prompt the user for the encryption password. </para>
2670
2671	<para><computeroutput>--removeonsuspend <yes\|no></computeroutput> specifies whether to remove/keep
2672	the password from/in VM memory when the VM is suspended. If the VM has been suspended and the password has
2673	been removed, the user needs to resupply the password before the VM can be resumed. This feature is useful
2674	in cases where the user doesn't want the password to be stored in VM memory, and the VM is suspended by a
2675	host suspend event.</para>
2676
2677	<para>Note: On VirtualBox versions 5.0 and later, data stored on hard disk images can be transparently
2678	encrypted for the guest. VirtualBox uses the AES algorithm in XTS mode and supports 128 or 256
2679	bit data encryption keys (DEK). The DEK is stored encrypted in the medium properties, and is
2680	decrypted during VM startup by supplying the encryption password.</para>
2681
2682	<para>The "VBoxManage encryptmedium" operation is used to create a DEK encrypted medium.
2683	See <xref linkend="diskencryption-encryption" />" for details.
2684	When starting an encrypted VM from a VirtualBox GUI app, the user will be prompted for the
2685	encryption password.</para>
2686
2687	<para>For a headless encrypted VM start, use:</para>
2688
2689	<para>VBoxManage startvm "vmname" --type headless</para>
2690
2691	<para>followed by:</para>
2692
2693	<para>VBoxManage "vmname" controlvm "vmname" addencpassword ...</para>
2694
2695	<para>to supply the encryption password required.</para>
2696	</listitem>
2697
2698	<listitem>
2699	<para><computeroutput>removeencpassword <id></computeroutput>: This operation
2700	removes encryption password authorization for password <id> for all encrypted media
2701	attached to the VM.</para>
2702	</listitem>
2703
2704	<listitem>
2705	<para><computeroutput>removeallencpasswords</computeroutput>: This operation
2706	removes encryption password authorization for all passwords for all
2707	encrypted media attached to the VM.</para>
2708	</listitem>
2709
2710	</itemizedlist>
2711	</sect1>
2712
2713	<sect1>
2714	<title>VBoxManage discardstate</title>
2715
2716	<para>This command discards the saved state of a virtual machine which is
2717	not currently running, which will cause its operating system to restart
2718	next time you start it. This is the equivalent of pulling out the power
2719	cable on a physical machine, and should be avoided if possible.</para>
2720	</sect1>
2721
2722	<sect1>
2723	<title>VBoxManage adoptstate</title>
2724
2725	<para>If you have a saved state file (<computeroutput>.sav</computeroutput>)
2726	that is separate from the VM configuration, you can use this command to
2727	"adopt" the file. This will change the VM to saved state and when you
2728	start it, VirtualBox will attempt to restore it from the saved state file
2729	you indicated. This command should only be used in special setups.</para>
2730	</sect1>
2731
2732	<sect1>
2733	<title>VBoxManage snapshot</title>
2734
2735	<para>This command is used to control snapshots from the command line. A
2736	snapshot consists of a complete copy of the virtual machine settings,
2737	copied at the time when the snapshot was taken, and optionally a virtual
2738	machine saved state file if the snapshot was taken while the machine was
2739	running. After a snapshot has been taken, VirtualBox creates differencing
2740	hard disk for each normal hard disk associated with the machine so that
2741	when a snapshot is restored, the contents of the virtual machine's virtual
2742	hard disks can be quickly reset by simply dropping the pre-existing
2743	differencing files.</para>
2744
2745	<screen>VBoxManage snapshot <uuid\|vmname>
2746	take <name> [--description <desc>] [--live]
2747	[--uniquename Number,Timestamp,Space,Force] \|
2748	delete <uuid\|snapname> \|
2749	restore <uuid\|snapname> \|
2750	restorecurrent \|
2751	edit <uuid\|snapname>\|--current
2752	[--name <name>]
2753	[--description <desc>] \|
2754	list [--details\|--machinereadable]
2755	showvminfo <uuid\|snapname></screen>
2756
2757	<para>The <computeroutput>take</computeroutput> operation takes a snapshot
2758	of the current state of the virtual machine. You must supply a name for
2759	the snapshot and can optionally supply a description. The new snapshot is
2760	inserted into the snapshots tree as a child of the current snapshot and
2761	then becomes the new current snapshot. The
2762	<computeroutput>--description</computeroutput> parameter allows to
2763	describe the snapshot. If <computeroutput>--live</computeroutput>
2764	is specified, the VM will not be stopped during the snapshot creation
2765	(live snapshotting).</para>
2766
2767	<para>The <computeroutput>delete</computeroutput> operation deletes a
2768	snapshot (specified by name or by UUID). This can take a while to finish
2769	since the differencing images associated with the snapshot might need to
2770	be merged with their child differencing images.</para>
2771
2772	<para>The <computeroutput>restore</computeroutput> operation will restore
2773	the given snapshot (specified by name or by UUID) by resetting the virtual
2774	machine's settings and current state to that of the snapshot. The previous
2775	current state of the machine will be lost. After this, the given snapshot
2776	becomes the new "current" snapshot so that subsequent snapshots are
2777	inserted under the snapshot from which was restored.</para>
2778
2779	<para>The <computeroutput>restorecurrent</computeroutput> operation is a
2780	shortcut to restore the current snapshot (i.e. the snapshot from which the
2781	current state is derived). This subcommand is equivalent to using the
2782	"restore" subcommand with the name or UUID of the current snapshot, except
2783	that it avoids the extra step of determining that name or UUID.</para>
2784
2785	<para>With the <computeroutput>edit</computeroutput> operation, you can
2786	change the name or description of an existing snapshot.</para>
2787
2788	<para>The <computeroutput>list</computeroutput> operation shows all
2789	snapshots of a virtual machine.</para>
2790
2791	<para>With the <computeroutput>showvminfo</computeroutput> operation, you
2792	can view the virtual machine settings that were stored with an existing
2793	snapshot.</para>
2794	</sect1>
2795
2796	<sect1 id="vboxmanage-closemedium">
2797	<title>VBoxManage closemedium</title>
2798
2799	<para>This commands removes a hard disk, DVD or floppy image from a
2800	VirtualBox media registry.<footnote>
2801	<para>Before VirtualBox 4.0, it was necessary to call VBoxManage
2802	openmedium before a medium could be attached to a virtual machine;
2803	that call "registered" the medium with the global VirtualBox media
2804	registry. With VirtualBox 4.0 this is no longer necessary; media are
2805	added to media registries automatically. The "closemedium" call has
2806	been retained, however, to allow for explicitly removing a medium from
2807	a registry.</para>
2808	</footnote></para>
2809
2810	<screen>VBoxManage closemedium [disk\|dvd\|floppy] <uuid\|filename>
2811	[--delete]</screen>
2812
2813	<para>Optionally, you can request that the image be deleted. You will get
2814	appropriate diagnostics that the deletion failed, however the image will
2815	become unregistered in any case.</para>
2816	</sect1>
2817
2818	<sect1 id="vboxmanage-storageattach">
2819	<title>VBoxManage storageattach</title>
2820
2821	<para>This command attaches/modifies/removes a storage medium connected to
2822	a storage controller that was previously added with the
2823	<computeroutput>storagectl</computeroutput> command (see the previous
2824	section). The syntax is as follows:</para>
2825
2826	<screen>VBoxManage storageattach <uuid\|vmname>
2827	--storagectl <name>
2828	[--port <number>]
2829	[--device <number>]
2830	[--type dvddrive\|hdd\|fdd]
2831	[--medium none\|emptydrive\|additions\|
2832	<uuid>\|<filename>\|host:<drive>\|iscsi]
2833	[--mtype normal\|writethrough\|immutable\|shareable
2834	readonly\|multiattach]
2835	[--comment <text>]
2836	[--setuuid <uuid>]
2837	[--setparentuuid <uuid>]
2838	[--passthrough on\|off]
2839	[--tempeject on\|off]
2840	[--nonrotational on\|off]
2841	[--discard on\|off]
2842	[--hotpluggable on\|off]
2843	[--bandwidthgroup name\|none]
2844	[--forceunmount]
2845	[--server <name>\|<ip>]
2846	[--target <target>]
2847	[--tport <port>]
2848	[--lun <lun>]
2849	[--encodedlun <lun>]
2850	[--username <username>]
2851	[--password <password>]
2852	[--initiator <initiator>]
2853	[--intnet]</screen>
2854
2855	<para>A number of parameters are commonly required; the ones at the end of
2856	the list are required only for iSCSI targets (see below).</para>
2857
2858	<para>The common parameters are:<glosslist>
2859	<glossentry>
2860	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
2861
2862	<glossdef>
2863	<para>The VM UUID or VM Name. Mandatory.</para>
2864	</glossdef>
2865	</glossentry>
2866
2867	<glossentry>
2868	<glossterm><computeroutput>--storagectl</computeroutput></glossterm>
2869
2870	<glossdef>
2871	<para>Name of the storage controller. Mandatory. The list of the
2872	storage controllers currently attached to a VM can be obtained
2873	with <computeroutput>VBoxManage showvminfo</computeroutput>; see
2874	<xref linkend="vboxmanage-showvminfo" />.</para>
2875	</glossdef>
2876	</glossentry>
2877
2878	<glossentry>
2879	<glossterm><computeroutput>--port</computeroutput></glossterm>
2880
2881	<glossdef>
2882	<para>The number of the storage controller's port which is to be
2883	modified. Mandatory, unless the storage controller has only a
2884	single port.</para>
2885	</glossdef>
2886	</glossentry>
2887
2888	<glossentry>
2889	<glossterm><computeroutput>--device</computeroutput></glossterm>
2890
2891	<glossdef>
2892	<para>The number of the port's device which is to be modified.
2893	Mandatory, unless the storage controller has only a single device
2894	per port.</para>
2895	</glossdef>
2896	</glossentry>
2897
2898	<glossentry>
2899	<glossterm><computeroutput>--type</computeroutput></glossterm>
2900
2901	<glossdef>
2902	<para>Define the type of the drive to which the medium is being
2903	attached/detached/modified. This argument can only be omitted if
2904	the type of medium can be determined from either the medium given
2905	with the <computeroutput>--medium</computeroutput> argument or
2906	from a previous medium attachment.</para>
2907	</glossdef>
2908	</glossentry>
2909
2910	<glossentry>
2911	<glossterm><computeroutput>--medium</computeroutput></glossterm>
2912
2913	<glossdef>
2914	<para>Specifies what is to be attached. The following values are
2915	supported:<itemizedlist>
2916	<listitem>
2917	<para>"none": Any existing device should be removed from the
2918	given slot.</para>
2919	</listitem>
2920
2921	<listitem>
2922	<para>"emptydrive": For a virtual DVD or floppy drive only,
2923	this makes the device slot behaves like a removeable drive
2924	into which no media has been inserted.</para>
2925	</listitem>
2926
2927	<listitem>
2928	<para>"additions": For a virtual DVD drive only, this
2929	attaches the <emphasis>VirtualBox Guest Additions</emphasis>
2930	image to the given device slot.</para>
2931	</listitem>
2932
2933	<listitem>
2934	<para>If a UUID is specified, it must be the UUID of a
2935	storage medium that is already known to VirtualBox (e.g.
2936	because it has been attached to another virtual machine).
2937	See <xref linkend="vboxmanage-list" /> for how to list known
2938	media. This medium is then attached to the given device
2939	slot.</para>
2940	</listitem>
2941
2942	<listitem>
2943	<para>If a filename is specified, it must be the full path
2944	of an existing disk image (ISO, RAW, VDI, VMDK or other),
2945	which is then attached to the given device slot.</para>
2946	</listitem>
2947
2948	<listitem>
2949	<para>"host:<drive>": For a virtual DVD or floppy
2950	drive only, this connects the given device slot to the
2951	specified DVD or floppy drive on the host computer.</para>
2952	</listitem>
2953
2954	<listitem>
2955	<para>"iscsi": For virtual hard disks only, this allows for
2956	specifying an iSCSI target. In this case, more parameters
2957	must be given; see below.</para>
2958	</listitem>
2959	</itemizedlist></para>
2960
2961	<para>Some of the above changes, in particular for removeable
2962	media (floppies and CDs/DVDs), can be effected while a VM is
2963	running. Others (device changes or changes in hard disk device
2964	slots) require the VM to be powered off.</para>
2965	</glossdef>
2966	</glossentry>
2967
2968	<glossentry>
2969	<glossterm><computeroutput>--mtype</computeroutput></glossterm>
2970
2971	<glossdef>
2972	<para>Defines how this medium behaves with respect to snapshots
2973	and write operations. See <xref linkend="hdimagewrites" /> for
2974	details.</para>
2975	</glossdef>
2976	</glossentry>
2977
2978	<glossentry>
2979	<glossterm><computeroutput>--comment</computeroutput></glossterm>
2980
2981	<glossdef>
2982	<para>Any description that you want to have stored with this
2983	medium (optional; for example, for an iSCSI target, "Big storage
2984	server downstairs"). This is purely descriptive and not needed for
2985	the medium to function correctly.</para>
2986	</glossdef>
2987	</glossentry>
2988
2989	<glossentry>
2990	<glossterm><computeroutput>--setuuid, --setparentuuid</computeroutput></glossterm>
2991
2992	<glossdef>
2993	<para>Modifies the UUID or parent UUID of a medium before
2994	attaching it to a VM. This is an expert option. Inappropriate use
2995	can make the medium unusable or lead to broken VM configurations
2996	if any other VM is referring to the same media already. The most
2997	frequently used variant is <code>--setuuid ""</code>, which assigns
2998	a new (random) UUID to an image. This is useful to resolve the
2999	duplicate UUID errors if one duplicated an image using file copy
3000	utilities.</para>
3001	</glossdef>
3002	</glossentry>
3003
3004	<glossentry>
3005	<glossterm><computeroutput>--passthrough</computeroutput></glossterm>
3006
3007	<glossdef>
3008	<para>For a virtual DVD drive only, you can enable DVD writing
3009	support (currently experimental; see <xref
3010	linkend="storage-cds" />).</para>
3011	</glossdef>
3012	</glossentry>
3013
3014	<glossentry>
3015	<glossterm><computeroutput>--tempeject</computeroutput></glossterm>
3016
3017	<glossdef>
3018	<para>For a virtual DVD drive only, you can configure the behavior
3019	for guest-triggered medium eject. If this is set to "on", the eject
3020	has only temporary effects. If the VM is powered off and restarted
3021	the originally configured medium will be still in the drive.</para>
3022	</glossdef>
3023	</glossentry>
3024
3025	<glossentry>
3026	<glossterm><computeroutput>--nonrotational</computeroutput></glossterm>
3027
3028	<glossdef>
3029	<para>This switch allows to enable the non-rotational flag for virtual
3030	hard disks. Some guests (i.e. Windows 7+) treat such disks like SSDs
3031	and don't perform disk fragmentation on such media.</para>
3032	</glossdef>
3033	</glossentry>
3034
3035	<glossentry>
3036	<glossterm><computeroutput>--discard</computeroutput></glossterm>
3037	<glossdef>
3038	<para>This switch enables the auto-discard feature for the virtual
3039	hard disks. This specifies that a VDI image will be shrunk in response
3040	to the trim command from the guest OS. The following requirements
3041	must be met:
3042
3043	<itemizedlist>
3044	<listitem>
3045	<para>The disk format must be VDI.</para>
3046	</listitem>
3047	<listitem>
3048	<para>The size of the cleared area must be at least 1MB.</para>
3049	</listitem>
3050	<listitem>
3051	<para>VirtualBox will only trim whole 1MB blocks. The VDIs themselves are organized
3052	into 1MB blocks, so this will only work if the space being TRIM-ed is at least
3053	a 1MB contiguous block at a 1MB boundary. On Windows, occasional defrag (with "defrag.exe /D"),
3054	or under Linux running "btrfs filesystem defrag" as a background cron job may be
3055	beneficial.</para>
3056	</listitem>
3057	</itemizedlist></para>
3058
3059	<para>Notes: the Guest OS must be configured to issue trim command, and typically this
3060	means that the guest OS is made to 'see' the disk as an SSD. Ext4 supports -o discard mount flag;
3061	OSX probably requires additional settings. Windows ought to automatically detect and
3062	support SSDs - at least in versions 7, 8 and 10. Linux exFAT driver (courtesy of Samsung)
3063	supports the trim command.</para>
3064	<para>It is unclear whether Microsoft's implementation of exFAT supports this feature, even
3065	though that file system was originally designed for flash.</para>
3066	<para>Alternatively, there are ad hoc methods to issue trim, e.g. Linux fstrim command,
3067	part of util-linux package. Earlier solutions required a user to zero out unused areas,
3068	e.g. using zerofree, and explicitly compact the disk - only possible when the VM is
3069	offline.</para>
3070	</glossdef>
3071	</glossentry>
3072
3073	<glossentry>
3074	<glossterm><computeroutput>--bandwidthgroup</computeroutput></glossterm>
3075
3076	<glossdef>
3077	<para>Sets the bandwidth group to use for the given device; see
3078	<xref linkend="storage-bandwidth-limit" />.</para>
3079	</glossdef>
3080	</glossentry>
3081
3082	<glossentry>
3083	<glossterm><computeroutput>--forceunmount</computeroutput></glossterm>
3084
3085	<glossdef>
3086	<para>For a virtual DVD or floppy drive only, this forcibly
3087	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy even if
3088	the previous one is locked down by the guest for reading. Again,
3089	see <xref linkend="storage-cds" /> for details.</para>
3090	</glossdef>
3091	</glossentry>
3092	</glosslist></para>
3093
3094	<para>When "iscsi" is used with the
3095	<computeroutput>--medium</computeroutput> parameter for iSCSI support --
3096	see <xref linkend="storage-iscsi" /> --, additional parameters must or can
3097	be used:<glosslist>
3098	<glossentry>
3099	<glossterm><computeroutput>--server</computeroutput></glossterm>
3100
3101	<glossdef>
3102	<para>The host name or IP address of the iSCSI target;
3103	required.</para>
3104	</glossdef>
3105	</glossentry>
3106
3107	<glossentry>
3108	<glossterm><computeroutput>--target</computeroutput></glossterm>
3109
3110	<glossdef>
3111	<para>Target name string. This is determined by the iSCSI target
3112	and used to identify the storage resource; required.</para>
3113	</glossdef>
3114	</glossentry>
3115
3116	<glossentry>
3117	<glossterm><computeroutput>--tport</computeroutput></glossterm>
3118
3119	<glossdef>
3120	<para>TCP/IP port number of the iSCSI service on the target.
3121	Optional.</para>
3122	</glossdef>
3123	</glossentry>
3124
3125	<glossentry>
3126	<glossterm><computeroutput>--lun</computeroutput></glossterm>
3127
3128	<glossdef>
3129	<para>Logical Unit Number of the target resource. Optional.
3130	Often, this value is zero.</para>
3131	</glossdef>
3132	</glossentry>
3133
3134	<glossentry>
3135	<glossterm><computeroutput>--encodedlun</computeroutput></glossterm>
3136
3137	<glossdef>
3138	<para>Hex encoded Logical Unit Number of the target resource. Optional.
3139	Often, this value is zero.</para>
3140	</glossdef>
3141	</glossentry>
3142
3143	<glossentry>
3144	<glossterm><computeroutput>--username, --password</computeroutput></glossterm>
3145
3146	<glossdef>
3147	<para>Username and password (initiator secret) for target
3148	authentication, if required. Optional.<note>
3149	<para>Username and password are stored without
3150	encryption (i.e. in clear text) in the XML machine
3151	configuration file if no settings password is provided.
3152	When a settings password was specified the first time,
3153	the password is stored encrypted.</para>
3154	</note></para>
3155	</glossdef>
3156	</glossentry>
3157
3158	<glossentry>
3159	<glossterm><computeroutput>--initiator</computeroutput></glossterm>
3160
3161	<glossdef>
3162	<para>iSCSI Initiator (optional). Note:</para>
3163
3164	<para>Microsoft iSCSI Initiator is a system, such as a server that attaches to an IP network and initiates requests and receives responses
3165	from an iSCSI target. The SAN components in Microsoft iSCSI Initiator are largely analogous to Fibre Channel SAN components, and
3166	they include the following:/</para>
3167
3168	<para>To transport blocks of iSCSI commands over the IP network, an iSCSI driver must be installed on the iSCSI host.
3169	An iSCSI driver is included with Microsoft iSCSI Initiator.</para>
3170
3171	<para>A gigabit Ethernet adapter that transmits 1000 megabits per second (Mbps) is recommended for the connection to an iSCSI target. Like
3172	standard 10/100 adapters, most gigabit adapters use a pre-existing Category 5 or Category 6E cable. Each port on the adapter is
3173	identified by a unique IP address.</para>
3174
3175	<para>An iSCSI target is any device that receives iSCSI commands. The device can be an end node, such as a storage device, or it can be an
3176	intermediate device, such as a network bridge between IP and Fibre Channel devices. Each port on the storage array controller or network
3177	bridge is identified by one or more IP addresses</para>
3178	</glossdef>
3179	</glossentry>
3180
3181	<glossentry>
3182	<glossterm><computeroutput>--intnet</computeroutput></glossterm>
3183
3184	<glossdef>
3185	<para>If specified, connect to the iSCSI target via Internal
3186	Networking. This needs further configuration which is described in
3187	<xref linkend="iscsi-intnet" />.</para>
3188	</glossdef>
3189	</glossentry>
3190	</glosslist></para>
3191	</sect1>
3192
3193	<sect1 id="vboxmanage-storagectl">
3194	<title>VBoxManage storagectl</title>
3195
3196	<para>This command attaches/modifies/removes a storage controller. After
3197	this, virtual media can be attached to the controller with the
3198	<computeroutput>storageattach</computeroutput> command (see the next
3199	section).</para>
3200
3201	<para>The syntax is as follows:</para>
3202
3203	<screen>VBoxManage storagectl <uuid\|vmname>
3204	--name <name>
3205	[--add ide\|sata\|scsi\|floppy\|sas\|usb\|pcie]
3206	[--controller LSILogic\|LSILogicSAS\|BusLogic\|
3207	IntelAhci\|PIIX3\|PIIX4\|ICH6\|I82078\|
3208	USB\|NVMe]
3209	[--portcount <1-30>]
3210	[--hostiocache on\|off]
3211	[--bootable on\|off]
3212	[--rename <name>]
3213	[--remove]</screen>
3214
3215	<para>where the parameters mean: <glosslist>
3216	<glossentry>
3217	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3218
3219	<glossdef>
3220	<para>The VM UUID or VM Name. Mandatory.</para>
3221	</glossdef>
3222	</glossentry>
3223
3224	<glossentry>
3225	<glossterm><computeroutput>--name</computeroutput></glossterm>
3226
3227	<glossdef>
3228	<para>Specifies the name of the storage controller. Mandatory.</para>
3229	</glossdef>
3230	</glossentry>
3231
3232	<glossentry>
3233	<glossterm><computeroutput>--add</computeroutput></glossterm>
3234
3235	<glossdef>
3236	<para>Specifies the type of the system bus to which the storage
3237	controller must be connected.</para>
3238	</glossdef>
3239	</glossentry>
3240
3241	<glossentry>
3242	<glossterm><computeroutput>--controller</computeroutput></glossterm>
3243
3244	<glossdef>
3245	<para>Enables a choice of chipset type being emulated for the
3246	given storage controller.</para>
3247	</glossdef>
3248	</glossentry>
3249
3250	<glossentry>
3251	<glossterm><computeroutput>--portcount</computeroutput></glossterm>
3252
3253	<glossdef>
3254	<para>This specifies the number of ports the storage controller should
3255	support.</para>
3256	</glossdef>
3257	</glossentry>
3258
3259	<glossentry>
3260	<glossterm><computeroutput>--hostiocache</computeroutput></glossterm>
3261
3262	<glossdef>
3263	<para>Configures the use of the host I/O cache for all disk images
3264	attached to this storage controller. For details, please see <xref
3265	linkend="iocaching" />.</para>
3266	</glossdef>
3267	</glossentry>
3268
3269	<glossentry>
3270	<glossterm><computeroutput>--bootable</computeroutput></glossterm>
3271
3272	<glossdef>
3273	<para>Specifies whether this controller is bootable.</para>
3274	</glossdef>
3275	</glossentry>
3276
3277	<glossentry>
3278	<glossterm><computeroutput>--rename</computeroutput></glossterm>
3279
3280	<glossdef>
3281	<para>Specifies a new name for the storage controller.</para>
3282	</glossdef>
3283	</glossentry>
3284
3285	<glossentry>
3286	<glossterm><computeroutput>--remove</computeroutput></glossterm>
3287
3288	<glossdef>
3289	<para>Removes the storage controller from the VM config.</para>
3290	</glossdef>
3291	</glossentry>
3292	</glosslist></para>
3293	</sect1>
3294
3295	<sect1>
3296	<title>VBoxManage bandwidthctl</title>
3297
3298	<para>This command creates/deletes/modifies/shows bandwidth groups of the given
3299	virtual machine:
3300	<screen>VBoxManage bandwidthctl <uuid\|vmname>
3301	add <name> --type disk\|network --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
3302	set <name> --limit <megabytes per second>[k\|m\|g\|K\|M\|G] \|
3303	remove <name> \|
3304	list [--machinereadable]</screen></para>
3305
3306	<para>The following subcommands are available:<itemizedlist>
3307	<listitem>
3308	<para><computeroutput>add</computeroutput>, creates a new bandwidth
3309	group of a given type.</para>
3310	</listitem>
3311	<listitem>
3312	<para><computeroutput>set</computeroutput>, modifies the limit for an
3313	existing bandwidth group.</para>
3314	</listitem>
3315	<listitem>
3316	<para><computeroutput>remove</computeroutput>, destroys a bandwidth
3317	group.</para>
3318	</listitem>
3319	<listitem>
3320	<para><computeroutput>list</computeroutput>, shows all bandwidth groups
3321	defined for the given VM. Use the <computeroutput>--machinereadable</computeroutput>
3322	option to produce the same output, but in machine readable format. This is of the
3323	form: name="value" on a line by line basis.</para>
3324	</listitem>
3325	</itemizedlist>
3326	</para>
3327	<para>The parameters mean:<glosslist>
3328	<glossentry>
3329	<glossterm><computeroutput>uuid\|vmname</computeroutput></glossterm>
3330
3331	<glossdef>
3332	<para>The VM UUID or VM Name. Mandatory.</para>
3333	</glossdef>
3334	</glossentry>
3335
3336	<glossentry>
3337	<glossterm><computeroutput>--name</computeroutput></glossterm>
3338
3339	<glossdef>
3340	<para>Name of the bandwidth group. Mandatory.</para>
3341	</glossdef>
3342	</glossentry>
3343
3344	<glossentry>
3345	<glossterm><computeroutput>--type</computeroutput></glossterm>
3346
3347	<glossdef>
3348	<para>Type of the bandwidth group. Mandatory. Two types are
3349	supported: <computeroutput>disk</computeroutput> and
3350	<computeroutput>network</computeroutput>. See
3351	<xref linkend="storage-bandwidth-limit" /> or
3352	<xref linkend="network_bandwidth_limit" /> for the description of a
3353	particular type.</para>
3354	</glossdef>
3355	</glossentry>
3356
3357	<glossentry>
3358	<glossterm><computeroutput>--limit</computeroutput></glossterm>
3359
3360	<glossdef>
3361	<para>Specifies the limit for the given bandwidth group. This can be changed
3362	while the VM is running. The default unit is megabytes per
3363	second. The unit can be changed by specifying one of the
3364	following suffixes: <computeroutput>k</computeroutput> for kilobits/s,
3365	<computeroutput>m</computeroutput> for megabits/s,
3366	<computeroutput>g</computeroutput> for gigabits/s,
3367	<computeroutput>K</computeroutput> for kilobytes/s,
3368	<computeroutput>M</computeroutput> for megabytes/s,
3369	<computeroutput>G</computeroutput> for gigabytes/s.</para>
3370	</glossdef>
3371	</glossentry>
3372	</glosslist>
3373	<note>
3374	<para>The network bandwidth limits apply only to the traffic being sent by
3375	virtual machines. The traffic being received by VMs is unlimited.</para>
3376	</note>
3377	<note>
3378	<para>To remove a bandwidth group it must not be referenced by any disks
3379	or adapters in the running VM.</para>
3380	</note>
3381	</para>
3382	</sect1>
3383
3384	<sect1>
3385	<title>VBoxManage showmediuminfo</title>
3386
3387	<para>This command shows information about a medium,
3388	notably its size, its size on disk, its type and the virtual machines
3389	which use it.<note>
3390	<para>For compatibility with earlier versions of VirtualBox, the
3391	"showvdiinfo" command is also supported and mapped internally to the
3392	"showmediuminfo" command.</para>
3393	</note></para>
3394
3395	<screen>VBoxManage showmediuminfo [disk\|dvd\|floppy] <uuid\|filename></screen>
3396
3397	<para>The medium must be specified either by its UUID (if the medium
3398	is registered) or by its filename. Registered images can be listed by
3399	<computeroutput>VBoxManage list hdds</computeroutput>,
3400	<computeroutput>VBoxManage list dvds</computeroutput>,
3401	or <computeroutput>VBoxManage list floppies</computeroutput>, as appropriate.
3402	(see <xref linkend="vboxmanage-list" />
3403	for more information).</para>
3404	</sect1>
3405
3406	<sect1 id="vboxmanage-createmedium">
3407	<title>VBoxManage createmedium</title>
3408
3409	<para>This command creates a new medium. The syntax is as follows:</para>
3410
3411	<screen>VBoxManage createmedium [disk\|dvd\|floppy] --filename <filename>
3412	[--size <megabytes>\|--sizebyte <bytes>]
3413	[--diffparent <uuid>\|<filename>
3414	[--format VDI\|VMDK\|VHD] (default: VDI)
3415	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
3416
3417	<para>where the parameters mean:<glosslist>
3418	<glossentry>
3419	<glossterm><computeroutput>--filename <filename></computeroutput></glossterm>
3420
3421	<glossdef>
3422	<para>Specifies a file name <filename> as an absolute path on the host file
3423	system. Mandatory.</para>
3424	</glossdef>
3425	</glossentry>
3426
3427	<glossentry>
3428	<glossterm><computeroutput>--size <megabytes></computeroutput></glossterm>
3429
3430	<glossdef>
3431	<para><megabytes> Specifies the image capacity, in 1 MB units.
3432	Optional.</para>
3433	</glossdef>
3434	</glossentry>
3435
3436	<glossentry>
3437	<glossterm><computeroutput>--diffparent <uuid>\|<filename></computeroutput></glossterm>
3438
3439	<glossdef>
3440	<para>Specifies the differencing image parent, either as a UUID or
3441	by the absolute pathname of the file on the host file system.
3442	Useful for sharing a base box disk image among several VMs.</para>
3443	</glossdef>
3444	</glossentry>
3445
3446	<glossentry>
3447	<glossterm><computeroutput>--format VDI\|VMDK\|VHD</computeroutput></glossterm>
3448
3449	<glossdef>
3450	<para>Specifies the file format for the output file. Available
3451	options are VDI, VMDK, VHD. Default is VDI. Optional. </para>
3452	</glossdef>
3453	</glossentry>
3454
3455	<glossentry>
3456	<glossterm><computeroutput>--variant Standard,Fixed,Split2G,Stream,ESX</computeroutput></glossterm>
3457
3458	<glossdef>
3459	<para>Specifies any required file format variant(s) for the output file. It is a
3460	comma-separated list of variant flags. Not all combinations are supported, and specifying
3461	mutually incompatible flags results in an error message. Optional.</para>
3462	</glossdef>
3463	</glossentry>
3464	</glosslist> <note>
3465	<para>For compatibility with earlier versions of VirtualBox, the "createvdi" and "createhd" commands
3466	are also supported and mapped internally to the "createmedium" command.</para>
3467	</note></para>
3468	</sect1>
3469
3470	<sect1 id="vboxmanage-modifyvdi">
3471	<title>VBoxManage modifymedium</title>
3472
3473	<para>With the <computeroutput>modifymedium</computeroutput> command, you can
3474	change the characteristics of a disk image after it has been
3475	created:<screen>VBoxManage modifymedium [disk\|dvd\|floppy] <uuid\|filename>
3476	[--type normal\|writethrough\|immutable\|shareable\|
3477	readonly\|multiattach]
3478	[--autoreset on\|off]
3479	[--property <name=[value]>]
3480	[--compact]
3481	[--resize <megabytes>\|--resizebyte <bytes>]
3482	[--move <path></screen><note>
3483	<para>For compatibility with earlier versions of VirtualBox, the "modifyvdi" and "modifyhd"
3484	commands are also supported and mapped internally to the "modifymedium" command.</para>
3485	</note></para>
3486
3487	<para>The disk image to modify must be specified either by its UUID
3488	(if the medium is registered) or by its filename. Registered images
3489	can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
3490	(see <xref linkend="vboxmanage-list" /> for more information).
3491	A filename must be specified as valid path, either as an absolute path
3492	or as a relative path starting from the current directory.</para>
3493	<para>The following options are available:<itemizedlist>
3494	<listitem>
3495	<para>With the <computeroutput>--type</computeroutput> argument, you
3496	can change the type of an existing image between the normal,
3497	immutable, write-through and other modes; see <xref
3498	linkend="hdimagewrites" /> for details.</para>
3499	</listitem>
3500
3501	<listitem>
3502	<para>For immutable (differencing) hard disks only, the
3503	<computeroutput>--autoreset on\|off</computeroutput> option
3504	determines whether the disk is automatically reset on every VM
3505	startup (again, see <xref linkend="hdimagewrites" />). The default
3506	is "on".</para>
3507	</listitem>
3508
3509	<listitem>
3510	<para>The <computeroutput>--compact</computeroutput> option
3511	can be used to compact disk images, i.e. remove blocks that only
3512	contains zeroes. This will shrink a dynamically allocated image
3513	again; it will reduce the <emphasis>physical</emphasis> size of the
3514	image without affecting the logical size of the virtual disk.
3515	Compaction works both for base images and for diff images created as
3516	part of a snapshot.</para>
3517
3518	<para>For this operation to be effective, it is required that free
3519	space in the guest system first be zeroed out using a suitable
3520	software tool. For Windows guests, you can use the
3521	<computeroutput>sdelete</computeroutput> tool provided by Microsoft.
3522	Execute <computeroutput>sdelete -z</computeroutput> in the guest to
3523	zero the free disk space before compressing the virtual disk
3524	image. For Linux, use the <code>zerofree</code> utility which
3525	supports ext2/ext3 filesystems. For Mac OS X guests, use the
3526	<code>diskutil secureErase freespace 0 /</code> command line
3527	from an elevated Terminal.</para>
3528
3529	<para>Please note that compacting is currently only available for
3530	VDI images. A similar effect can be achieved by zeroing out free
3531	blocks and then cloning the disk to any other dynamically allocated
3532	format. You can use this workaround until compacting is also
3533	supported for disk formats other than VDI.</para>
3534	</listitem>
3535
3536	<listitem>
3537	<para>The <computeroutput>--resize x</computeroutput> option (where x
3538	is the desired new total space in <emphasis role="bold">megabytes</emphasis>)
3539	allows you to change the capacity of an existing image; this adjusts the
3540	<emphasis>logical</emphasis> size of a virtual disk without affecting
3541	the physical size much.<footnote>
3542	<para>Image resizing was added with VirtualBox 4.0.</para>
3543	</footnote> This currently works only for VDI and VHD formats, and only
3544	for the dynamically allocated variants, and can only be used to expand
3545	(not shrink) the capacity.
3546	For example, if you originally created a 10G disk which is now full,
3547	you can use the <computeroutput>--resize 15360</computeroutput>
3548	command to change the capacity to 15G (15,360MB) without having to create a new
3549	image and copy all data from within a virtual machine. Note however that
3550	this only changes the drive capacity; you will typically next need to use
3551	a partition management tool inside the guest to adjust the main partition
3552	to fill the drive.</para><para>The <computeroutput>--resizebyte x</computeroutput>
3553	option does almost the same thing, except that x is expressed in bytes
3554	instead of megabytes.</para>
3555	</listitem>
3556
3557	<listitem>
3558	<para>The <computeroutput>--move <path></computeroutput> option
3559	can be used to relocate a medium to a different location <path> on the
3560	host file system. The path can be either relative to the current directory or
3561	absolute.</para>
3562	</listitem>
3563	</itemizedlist></para>
3564	</sect1>
3565
3566	<sect1 id="vboxmanage-clonevdi">
3567	<title>VBoxManage clonemedium</title>
3568
3569	<para>This command duplicates a virtual disk/DVD/floppy medium to a
3570	new medium (usually an image file) with a new unique identifier (UUID).
3571	The new image can be transferred to another host system or imported into
3572	VirtualBox again using the Virtual Media Manager; see <xref linkend="vdis" />
3573	and <xref linkend="cloningvdis" />. The syntax is as follows:</para>
3574
3575	<screen>VBoxManage clonemedium [disk\|dvd\|floppy] <uuid\|inputfile> <uuid\|outputfile>
3576
3577	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
3578	[--variant Standard,Fixed,Split2G,Stream,ESX]
3579	[--existing]</screen>
3580
3581
3582	<para>The medium to clone as well as the target image must be described
3583	either by its UUIDs (if the mediums are registered) or by its filename.
3584	Registered images can be listed by <computeroutput>VBoxManage list hdds</computeroutput>
3585	(see <xref linkend="vboxmanage-list" /> for more information).
3586	A filename must be specified as valid path, either as an absolute path or
3587	as a relative path starting from the current directory.</para>
3588	<para>The following options are available:<glosslist>
3589	<glossentry>
3590	<glossterm><computeroutput>--format</computeroutput></glossterm>
3591
3592	<glossdef>
3593	<para>Allow to choose a file format for the output file different
3594	from the file format of the input file.</para>
3595	</glossdef>
3596	</glossentry>
3597
3598	<glossentry>
3599	<glossterm><computeroutput>--variant</computeroutput></glossterm>
3600
3601	<glossdef>
3602	<para>Allow to choose a file format variant for the output file.
3603	It is a comma-separated list of variant flags. Not all
3604	combinations are supported, and specifying inconsistent flags will
3605	result in an error message.</para>
3606	</glossdef>
3607	</glossentry>
3608
3609	<glossentry>
3610	<glossterm><computeroutput>--existing</computeroutput></glossterm>
3611
3612	<glossdef>
3613	<para>Perform the clone operation to an already existing
3614	destination medium. Only the portion of the source medium which
3615	fits into the destination medium is copied. This means if the
3616	destination medium is smaller than the source only a part of it is
3617	copied, and if the destination medium is larger than the source
3618	the remaining part of the destination medium is unchanged.</para>
3619	</glossdef>
3620	</glossentry>
3621	</glosslist> <note>
3622	<para>For compatibility with earlier versions of VirtualBox, the
3623	"clonevdi" and "clonehd" commands are still supported and mapped
3624	internally to the "clonehd disk" command.</para>
3625	</note></para>
3626	</sect1>
3627
3628	<sect1 id="vboxmanage-mediumproperty">
3629	<title>VBoxManage mediumproperty</title>
3630
3631	<para>This command sets up, gets or deletes a medium property.
3632	The syntax is as follows:</para>
3633
3634	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] set <uuid\|filename>
3635	<property> <value></screen>
3636
3637
3638	<para><itemizedlist>
3639	<listitem>
3640	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3641	the type of medium: disk (hard drive), dvd or floppy.</para>
3642	</listitem>
3643
3644	<listitem>
3645	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3646	or absolute path of the medium/image to be encrypted.</para>
3647	</listitem>
3648
3649	<listitem>
3650	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3651	property.</para>
3652	</listitem>
3653
3654	<listitem>
3655	<para>Use <computeroutput><value></computeroutput> to supply the property value.</para>
3656	</listitem>
3657	</itemizedlist></para>
3658
3659	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] get <uuid\|filename>
3660	<property></screen>
3661	<para><itemizedlist>
3662	<listitem>
3663	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3664	the type of medium: disk (hard drive), dvd or floppy.</para>
3665	</listitem>
3666
3667	<listitem>
3668	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3669	or absolute path of the medium/image to be encrypted.</para>
3670	</listitem>
3671
3672	<listitem>
3673	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3674	property.</para>
3675	</listitem>
3676	</itemizedlist></para>
3677
3678	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] delete <uuid\|filename>
3679	<property></screen>
3680
3681
3682	<para><itemizedlist>
3683	<listitem>
3684	<para>Use <computeroutput><disk\|dvd\|floppy></computeroutput> to optionally specify
3685	the type of medium: disk (hard drive), dvd or floppy.</para>
3686	</listitem>
3687
3688	<listitem>
3689	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply either the uuid
3690	or absolute path of the medium/image.</para>
3691	</listitem>
3692
3693	<listitem>
3694	<para>Use <computeroutput><property></computeroutput> to supply the name of the
3695	property.</para>
3696	</listitem>
3697	</itemizedlist></para>
3698	</sect1>
3699
3700	<sect1 id="vboxmanage-encryptmedium">
3701	<title>VBoxManage encryptmedium</title>
3702
3703	<para>This command is used to create a DEK encrypted medium/image.
3704	See <xref linkend="diskencryption-encryption" />" for details.</para>
3705
3706	<para>The syntax is as follows:</para>
3707
3708	<screen>VBoxManage encryptmedium <uuid\|filename>
3709	[--newpassword <file\|->]
3710	[--oldpassword <file\|->]
3711	[--cipher <cipher id>]
3712	[--newpasswordid <password id>]</screen>
3713
3714	<para><itemizedlist>
3715	<listitem>
3716	<para>use <computeroutput><uuid\|filename></computeroutput> to supply the
3717	uuid or absolute path of the medium/image to be encrypted.</para>
3718	</listitem>
3719
3720	<listitem>
3721	<para>Use <computeroutput>--newpassword <file\|-></computeroutput> to supply a new
3722	encryption password; either specify the absolute pathname of a password file on the host operating system,
3723	or <computeroutput>-</computeroutput> to prompt you for the password on the command line.
3724	Always use the <computeroutput>--newpasswordid</computeroutput> option with this option.</para>
3725	</listitem>
3726
3727	<listitem>
3728	<para>use <computeroutput>--oldpassword <file\|-></computeroutput> to supply any old
3729	encryption password; either specify the absolute pathname of a password file on the host operating system,
3730	or <computeroutput>-</computeroutput> to prompt you for the old password on the command line.</para>
3731
3732	<para>Use this option to gain access to an encrypted medium/image to change its password using
3733	<computeroutput>--newpassword</computeroutput> and/or change its encryption using
3734	<computeroutput>--cipher</computeroutput>.</para>
3735	</listitem>
3736
3737	<listitem>
3738	<para>Use <computeroutput>--cipher <cipher></computeroutput> to specify the cipher to use for
3739	encryption; this can be either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or
3740	<computeroutput>AES-AXTS256-PLAIN64</computeroutput>.</para>
3741
3742	<para>Use this option to change any existing encryption on the medium/image, or setup new encryption on
3743	it for the 1st time.</para>
3744	</listitem>
3745
3746	<listitem>
3747	<para>Use <computeroutput>--newpasswordid <password id></computeroutput> to supply the new password identifier.
3748	This can be freely chosen by the user, and is used for correct identification when supplying multiple
3749	passwords during VM startup.</para>
3750
3751	<para>If the user uses the same password when encrypting multiple images and also the same password identifier, the
3752	user needs to supply the password only once during VM startup.</para>
3753	</listitem>
3754	</itemizedlist></para>
3755
3756	</sect1>
3757
3758	<sect1 id="vboxmanage-checkmediumpwd">
3759
3760	<title>VBoxManage checkmediumpwd</title>
3761
3762	<para>This command is used to check the current encryption password on a DEK encrypted medium/image.
3763	See <xref linkend="diskencryption-encryption" />" for details.</para>
3764
3765	<para>The syntax is as follows:</para>
3766
3767	<screen>VBoxManage checkmediumpwd <uuid\|filename>
3768	<pwd file\|-></screen>
3769	<para><itemizedlist>
3770	<listitem>
3771	<para>Use <computeroutput><uuid\|filename></computeroutput> to supply the uuid or absolute path of the
3772	medium/image to be checked.</para>
3773	</listitem>
3774
3775	<listitem>
3776	<para>Use <computeroutput><pwd file\|-></computeroutput> to supply the password identifier to be checked. Either
3777	specify the absolute pathname of a password file on the host operating system, or <computeroutput>-</computeroutput> to
3778	prompt you for the password on the command line.</para>
3779	</listitem>
3780	</itemizedlist></para>
3781
3782	</sect1>
3783
3784	<sect1>
3785	<title>VBoxManage convertfromraw</title>
3786
3787	<para>This command converts a raw disk image to a VirtualBox Disk Image
3788	(VDI) file. The syntax is as follows:</para>
3789
3790	<screen>VBoxManage convertfromraw <filename> <outputfile>
3791	[--format VDI\|VMDK\|VHD]
3792	[--variant Standard,Fixed,Split2G,Stream,ESX]
3793	[--uuid <uuid>]
3794	VBoxManage convertfromraw stdin <outputfile> <bytes>
3795	[--format VDI\|VMDK\|VHD]
3796	[--variant Standard,Fixed,Split2G,Stream,ESX]
3797	[--uuid <uuid>]</screen>
3798
3799	<para>where the parameters mean:<glosslist>
3800	<glossentry>
3801	<glossterm><computeroutput>--bytes</computeroutput></glossterm>
3802
3803	<glossdef>
3804	<para>The size of the image file, in bytes, provided through
3805	stdin.</para>
3806	</glossdef>
3807	</glossentry>
3808
3809	<glossentry>
3810	<glossterm><computeroutput>--format</computeroutput></glossterm>
3811
3812	<glossdef>
3813	<para>Select the disk image format to create. Default is
3814	VDI. Other options are VMDK and VHD.</para>
3815	</glossdef>
3816	</glossentry>
3817
3818	<glossentry>
3819	<glossterm><computeroutput>--variant</computeroutput></glossterm>
3820
3821	<glossdef>
3822	<para>Allow to choose a file format variant for the output file.
3823	It is a comma-separated list of variant flags. Not all
3824	combinations are supported, and specifying inconsistent flags will
3825	result in an error message.</para>
3826	</glossdef>
3827	</glossentry>
3828
3829	<glossentry>
3830	<glossterm><computeroutput>--uuid</computeroutput></glossterm>
3831
3832	<glossdef>
3833	<para>Allow to specifiy the UUID of the output file.</para>
3834	</glossdef>
3835	</glossentry>
3836	</glosslist> The second form forces VBoxManage to read the content for
3837	the disk image from standard input (useful for using that command in a
3838	pipe).</para>
3839
3840	<para><note>
3841	<para>For compatibility with earlier versions of VirtualBox, the
3842	"convertdd" command is also supported and mapped internally to the
3843	"convertfromraw" command.</para>
3844	</note></para>
3845	</sect1>
3846
3847	<sect1>
3848	<title>VBoxManage getextradata/setextradata</title>
3849
3850	<para>These commands let you attach and retrieve string data to a virtual
3851	machine or to a VirtualBox configuration (by specifying
3852	<computeroutput>global</computeroutput> instead of a virtual machine
3853	name). You must specify a key (as a text string) to associate the data
3854	with, which you can later use to retrieve it. For example:</para>
3855
3856	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
3857	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
3858
3859	<para>would associate the string "2006.01.01" with the key installdate for
3860	the virtual machine Fedora5, and "2006.02.02" on the machine SUSE10. You
3861	could retrieve the information as follows:</para>
3862
3863	<screen>VBoxManage getextradata Fedora5 installdate</screen>
3864
3865	<para>which would return</para>
3866
3867	<screen>VirtualBox Command Line Management Interface Version @VBOX_VERSION_MAJOR@.@VBOX_VERSION_MINOR@.@VBOX_VERSION_BUILD@
3868	(C) 2005-@VBOX_C_YEAR@ @VBOX_VENDOR@
3869	All rights reserved.
3870
3871	Value: 2006.01.01</screen>
3872
3873	<para>You could retrieve the information for all keys as follows:</para>
3874
3875	<screen>VBoxManage getextradata Fedora5 enumerate</screen>
3876
3877	<para>To remove a key, the <computeroutput>setextradata</computeroutput>
3878	command must be run without specifying data (only the key), for example:
3879	</para>
3880
3881	<screen>VBoxManage setextradata Fedora5 installdate</screen>
3882
3883	</sect1>
3884
3885	<sect1 id="vboxmanage-setproperty">
3886	<title>VBoxManage setproperty</title>
3887
3888	<para>This command is used to change global settings which affect the
3889	entire VirtualBox installation. Some of these correspond to the settings
3890	in the "Global settings" dialog in the graphical user interface. The
3891	following properties are available:<glosslist>
3892	<glossentry>
3893	<glossterm><computeroutput>machinefolder</computeroutput></glossterm>
3894	<glossdef>
3895	<para>This specifies the default folder in which virtual machine
3896	definitions are kept; see <xref linkend="vboxconfigdata" /> for
3897	details.</para>
3898	</glossdef>
3899	</glossentry>
3900
3901	<glossentry>
3902	<glossterm><computeroutput>hwvirtexclusive</computeroutput></glossterm>
3903	<glossdef><para>This specifies whether VirtualBox will make exclusive use of
3904	the hardware virtualization extensions (Intel VT-x or AMD-V) of the
3905	host system's processor; see <xref linkend="hwvirt" />. If you wish to
3906	share these extensions with other hypervisors running at the same time,
3907	you must disable this setting. Doing so has negative performance implications.
3908	</para></glossdef>
3909	</glossentry>
3910
3911	<glossentry>
3912	<glossterm><computeroutput>vrdeauthlibrary</computeroutput></glossterm>
3913
3914	<glossdef>
3915	<para>This specifies which library to use when "external"
3916	authentication has been selected for a particular virtual machine;
3917	see <xref linkend="vbox-auth" /> for details.</para>
3918	</glossdef>
3919	</glossentry>
3920
3921	<glossentry>
3922	<glossterm><computeroutput>websrvauthlibrary</computeroutput></glossterm>
3923
3924	<glossdef>
3925	<para>This specifies which library the web service uses to
3926	authenticate users. For details about the VirtualBox web service,
3927	please refer to the separate VirtualBox SDK reference (see <xref
3928	linkend="VirtualBoxAPI" />).</para>
3929	</glossdef>
3930	</glossentry>
3931
3932	<glossentry>
3933	<glossterm><computeroutput>vrdeextpack</computeroutput></glossterm>
3934
3935	<glossdef>
3936	<para>This specifies which library implements the VirtualBox
3937	Remote Desktop Extension.</para>
3938	</glossdef>
3939	</glossentry>
3940
3941	<glossentry>
3942	<glossterm><computeroutput>loghistorycount</computeroutput></glossterm>
3943
3944	<glossdef>
3945	<para>This selects how many rotated (old) VM logs are kept.</para>
3946	</glossdef>
3947	</glossentry>
3948
3949	<glossentry>
3950	<glossterm><computeroutput>autostartdbpath</computeroutput></glossterm>
3951
3952	<glossdef>
3953	<para>This selects the path to the autostart database. See
3954	<xref linkend="autostart" />.</para>
3955	</glossdef>
3956	</glossentry>
3957
3958	<glossentry>
3959	<glossterm><computeroutput>defaultfrontend</computeroutput></glossterm>
3960
3961	<glossdef>
3962	<para>This selects the global default VM frontend setting. See
3963	<xref linkend="vboxmanage-startvm" />.</para>
3964	</glossdef>
3965	</glossentry>
3966
3967	<glossentry>
3968	<glossterm><computeroutput>logginglevel</computeroutput></glossterm>
3969
3970	<glossdef>
3971	<para>This configures the VBoxSVC release logging details.<footnote>
3972	<para><ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>.</para>
3973	</footnote>
3974	</para>
3975	</glossdef>
3976	</glossentry>
3977	</glosslist></para>
3978	</sect1>
3979
3980	<sect1>
3981	<title>VBoxManage usbfilter add/modify/remove</title>
3982
3983	<screen>VBoxManage usbfilter add <index,0-N>
3984	--target <uuid\|vmname>global
3985	--name <string>
3986	--action ignore\|hold (global filters only)
3987	[--active yes\|no (yes)]
3988	[--vendorid <XXXX> (null)]
3989	[--productid <XXXX> (null)]
3990	[--revision <IIFF> (null)]
3991	[--manufacturer <string> (null)]
3992	[--product <string> (null)]
3993	[--remote yes\|no (null, VM filters only)]
3994	[--serialnumber <string> (null)]
3995	[--maskedinterfaces <XXXXXXXX>]
3996	</screen>
3997
3998	<screen>VBoxManage usbfilter modify <index,0-N>
3999	--target <uuid\|vmname>global
4000	[--name <string>]
4001	[--action ignore\|hold (global filters only)]
4002	[--active yes\|no]
4003	[--vendorid <XXXX>]
4004	[--productid <XXXX>]
4005	[--revision <IIFF>]
4006	[--manufacturer <string>]
4007	[--product <string>]
4008	[--remote yes\|no (null, VM filters only)]
4009	[--serialnumber <string>]
4010	[--maskedinterfaces <XXXXXXXX>]
4011	</screen>
4012
4013	<screen>VBoxManage usbfilter remove <index,0-N>
4014	--target <uuid\|vmname>global
4015	</screen>
4016
4017	<para>The <computeroutput>usbfilter</computeroutput> commands are used for
4018	working with USB filters in virtual machines, or global filters which
4019	affect the whole VirtualBox setup. Global filters are applied before
4020	machine-specific filters, and may be used to prevent devices from being
4021	captured by any virtual machine. Global filters are always applied in a
4022	particular order, and only the first filter which fits a device is
4023	applied. So for example, if the first global filter says to hold (make
4024	available) a particular Kingston memory stick device and the second to
4025	ignore all Kingston devices, that memory stick will be available to any
4026	machine with an appropriate filter, but no other Kingston device
4027	will.</para>
4028
4029	<para>When creating a USB filter using <computeroutput>usbfilter
4030	add</computeroutput>, you must supply three or four mandatory parameters.
4031	The index specifies the position in the list at which the filter should be
4032	placed. If there is already a filter at that position, then it and the
4033	following ones will be shifted back one place. Otherwise the new filter
4034	will be added onto the end of the list. The
4035	<computeroutput>target</computeroutput> parameter selects the virtual
4036	machine that the filter should be attached to or use "global" to apply it
4037	to all virtual machines. <computeroutput>name</computeroutput> is a name
4038	for the new filter and for global filters,
4039	<computeroutput>action</computeroutput> says whether to allow VMs
4040	access to devices that fit the filter description ("hold") or not to give
4041	them access ("ignore"). In addition, you should specify parameters to
4042	filter by. You can find the parameters for devices attached to your system
4043	using <computeroutput>VBoxManage list usbhost</computeroutput>. Finally,
4044	you can specify whether the filter should be active, and for local
4045	filters, whether they are for local devices, remote (over an RDP
4046	connection) or either.</para>
4047
4048	<para>When you modify a USB filter using <computeroutput>usbfilter
4049	modify</computeroutput>, you must specify the filter by index (see the
4050	output of <computeroutput>VBoxManage list usbfilters</computeroutput> to
4051	find global filter indexes and that of <computeroutput>VBoxManage
4052	showvminfo</computeroutput> to find indexes for individual machines) and
4053	by target, which is either a virtual machine or "global". The properties
4054	which can be changed are the same as for <computeroutput>usbfilter
4055	add</computeroutput>. To remove a filter, use <computeroutput>usbfilter
4056	remove</computeroutput> and specify the index and the target.</para>
4057
4058	<para>The following is a list of the additional
4059	<computeroutput>usbfilter add</computeroutput> and
4060	<computeroutput>usbfilter modify</computeroutput> options, with detailed
4061	explanations on how to use them.</para>
4062
4063	<para><itemizedlist>
4064	<listitem>
4065	<para><computeroutput>--action ignore\|hold</computeroutput>Specifies
4066	whether devices that fit the filter description are allowed access by
4067	machines ("hold"), or have access denied ("ignore"). Applies to
4068	global filters only.</para>
4069	</listitem>
4070
4071	<listitem>
4072	<para><computeroutput>--active yes\|no</computeroutput>Specifies whether
4073	the USB Filter is active or temporarily disabled. For
4074	<computeroutput>usbfilter create</computeroutput> the default is
4075	active.</para>
4076	</listitem>
4077
4078	<listitem>
4079	<para><computeroutput>--vendorid <XXXX>\|""</computeroutput>Specifies
4080	a vendor ID filter - the string representation for the exact matching
4081	has the form XXXX, where X is the hex digit (including leading zeroes).</para>
4082	</listitem>
4083
4084	<listitem>
4085	<para><computeroutput>--productid <XXXX>\|""</computeroutput>Specifies
4086	a product ID filter - The string representation for the exact matching has
4087	the form XXXX, where X is the hex digit (including leading zeroes).</para>
4088	</listitem>
4089
4090	<listitem>
4091	<para><computeroutput>--revision <IIFF>\|""</computeroutput>Specifies
4092	a revision ID filter - the string representation for the exact matching has
4093	the form IIFF, where I is the decimal digit of the integer part of the revision,
4094	and F is the decimal digit of its fractional part (including leading and trailing zeros).
4095	Note that for interval filters, it's best to use the hex form, because the revision is
4096	stored as a 16 bit packed BCD value; so the expression int:0x0100-0x0199 will match
4097	any revision from 1.0 to 1.99 inclusive.</para>
4098	</listitem>
4099
4100	<listitem>
4101	<para><computeroutput>--manufacturer <string>\|""</computeroutput>Specifies
4102	a manufacturer ID filter, as a string.</para>
4103	</listitem>
4104
4105	<listitem>
4106	<para><computeroutput>--product <string>\|""</computeroutput>Specifies
4107	a product ID filter, as a string.</para>
4108	</listitem>
4109
4110	<listitem>
4111	<para><computeroutput>--remote yes\|no""</computeroutput>Specifies
4112	a remote filter - indicating whether the device is physically connected to a
4113	remote VRDE client or to a local host machine. Applies to VM filters only.</para>
4114	</listitem>
4115
4116	<listitem>
4117	<para><computeroutput>--serialnumber <string>\|""</computeroutput>Specifies
4118	a serial number filter, as a string.</para>
4119	</listitem>
4120
4121	<listitem>
4122	<para><computeroutput>--maskedinterfaces <XXXXXXXX></computeroutput>Specifies
4123	a masked interface filter, for hiding one or more USB interfaces from the guest.
4124	The value is a bit mask where the set bits correspond to the USB interfaces that
4125	should be hidden, or masked off. This feature only works on Linux hosts.</para>
4126	</listitem>
4127	</itemizedlist></para>
4128	</sect1>
4129
4130	<sect1 id="vboxmanage-sharedfolder">
4131	<title>VBoxManage sharedfolder add/remove</title>
4132
4133	<screen>
4134	VBoxManage sharedfolder add <uuid\|vmname>
4135	--name <name> --hostpath <hostpath>
4136	[--transient] [--readonly] [--automount]
4137	</screen>
4138
4139	<para>This command allows you to share folders on the host computer with
4140	guest operating systems. For this, the guest systems must have a version
4141	of the VirtualBox Guest Additions installed which supports this
4142	functionality.</para>
4143
4144	<para>Parameters are:</para>
4145
4146	<para><itemizedlist>
4147	<listitem>
4148	<para><computeroutput><uuid\|vmname></computeroutput>
4149	Specifies the UUID or name of the VM whose guest operating system will be
4150	sharing folders with the host computer. Mandatory.</para>
4151	</listitem>
4152
4153	<listitem>
4154	<para><computeroutput>--name <name></computeroutput>
4155	Specifies the name of the share. Each share has a unique name within the
4156	namespace of the host operating system. Mandatory.</para>
4157	</listitem>
4158
4159	<listitem>
4160	<para><computeroutput>-hostpath <hostpath></computeroutput>
4161	Specifies the absolute path on the host operating system of the
4162	folder/directory to be shared with the guest operating system.
4163	Mandatory.</para>
4164	</listitem>
4165
4166	<listitem>
4167	<para><computeroutput>-transient</computeroutput>
4168	Specifies that the share is 'transient', meaning that it can be added
4169	and removed at runtime and does not persist after the VM has stopped.
4170	Optional.</para>
4171	</listitem>
4172
4173	<listitem>
4174	<para><computeroutput>-readonly</computeroutput>
4175	Specifies that the share has only read-only access to files at the host path.</para>
4176
4177	<para>By default, shared folders have read/write access to the files at the host
4178	path. More specifically, on Linux distros - shared folders are mounted with
4179	770 io permissions with root user and vboxsf as the group, and using this option
4180	the io permissions change to 700. Optional.</para>
4181	</listitem>
4182
4183	<listitem>
4184	<para><computeroutput>-automount</computeroutput>
4185	Specifies that the share will be automatically mounted. On Linux distros, this will
4186	be to either /media/USER/sf_<name> or /media/sf_<name> - depending on
4187	your guest OS. Where <name> is the share name. Optional.</para>
4188	</listitem>
4189	</itemizedlist></para>
4190
4191	<screen>
4192	VBoxManage sharedfolder remove <uuid\|vmname>
4193	--name <name> [--transient]
4194
4195	</screen>
4196
4197	<para>This command allows you to delete shared folders on the host computer shares with
4198	the guest operating systems. For this, the guest systems must have a version
4199	of the VirtualBox Guest Additions installed which supports this
4200	functionality.</para>
4201
4202	<para>Parameters are:</para>
4203
4204	<para><itemizedlist>
4205	<listitem>
4206	<para><computeroutput><uuid\|vmname></computeroutput>
4207	Specifies the UUID or name of the VM whose guest operating system is
4208	sharing folders with the host computer. Mandatory.</para>
4209	</listitem>
4210
4211	<listitem>
4212	<para><computeroutput>--name <name></computeroutput>
4213	Specifies the name of the share to be removed. Each share has a unique name within the
4214	namespace of the host operating system. Mandatory.</para>
4215	</listitem>
4216
4217	<listitem>
4218	<para><computeroutput>-transient</computeroutput>
4219	Specifies that the share is 'transient', meaning that it can be added
4220	and removed at runtime and does not persist after the VM has stopped.
4221	Optional.</para>
4222	</listitem>
4223	</itemizedlist></para>
4224
4225
4226	<para>Shared folders are described in detail in <xref linkend="sharedfolders" />.</para>
4227	</sect1>
4228
4229	<sect1 id="vboxmanage-guestproperty">
4230	<title>VBoxManage guestproperty</title>
4231
4232	<para>The "guestproperty" commands allow you to get or set properties of a
4233	running virtual machine. Please see <xref linkend="guestadd-guestprops" />
4234	for an introduction. As explained there, guest properties are arbitrary
4235	key/value string pairs which can be written to and read from by either the
4236	guest or the host, so they can be used as a low-volume communication
4237	channel for strings, provided that a guest is running and has the Guest
4238	Additions installed. In addition, a number of values whose keys begin with
4239	"/VirtualBox/" are automatically set and maintained by the Guest
4240	Additions.</para>
4241
4242	<para>The following subcommands are available (where
4243	<computeroutput><vm></computeroutput>, in each case, can either be a
4244	VM name or a VM UUID, as with the other VBoxManage commands):<itemizedlist>
4245	<listitem>
4246	<para><computeroutput>enumerate <vm> [--patterns
4247	<pattern>]</computeroutput>: This lists all the guest
4248	properties that are available for the given VM, including the value.
4249	This list will be very limited if the guest's service process cannot
4250	be contacted, e.g. because the VM is not running or the Guest
4251	Additions are not installed.</para>
4252
4253	<para>If <computeroutput>--patterns <pattern></computeroutput>
4254	is specified, it acts as a filter to only list properties that match
4255	the given pattern. The pattern can contain the following wildcard
4256	characters:<itemizedlist>
4257	<listitem>
4258	<para><computeroutput>*</computeroutput> (asterisk):
4259	represents any number of characters; for example,
4260	"<computeroutput>/VirtualBox*</computeroutput>" would match
4261	all properties beginning with "/VirtualBox".</para>
4262	</listitem>
4263
4264	<listitem>
4265	<para><computeroutput>?</computeroutput> (question mark):
4266	represents a single arbitrary character; for example,
4267	"<computeroutput>fo?</computeroutput>" would match both "foo"
4268	and "for".</para>
4269	</listitem>
4270
4271	<listitem>
4272	<para><computeroutput>\|</computeroutput> (pipe symbol): can be
4273	used to specify multiple alternative patterns; for example,
4274	"<computeroutput>s\|t</computeroutput>" would match anything
4275	starting with either "s" or "t".</para>
4276	</listitem>
4277	</itemizedlist></para>
4278	</listitem>
4279
4280	<listitem>
4281	<para><computeroutput>get <vm> <property>
4282	</computeroutput>: This
4283	retrieves the value of a single property only. If the property
4284	cannot be found (e.g. because the guest is not running), this will
4285	print <screen>No value set!</screen></para>
4286	</listitem>
4287
4288	<listitem>
4289	<para><computeroutput>set <vm> <property> [<value>
4290	[--flags <flags>]]</computeroutput>: This allows you to set a
4291	guest property by specifying the key and value. If
4292	<computeroutput><value></computeroutput> is omitted, the
4293	property is deleted. With <computeroutput>--flags</computeroutput>
4294	you can optionally specify additional behavior (you can combine
4295	several by separating them with commas):<itemizedlist>
4296	<listitem>
4297	<para><computeroutput>TRANSIENT</computeroutput>: the value
4298	will not be stored with the VM data when the VM exits;</para>
4299	</listitem>
4300
4301	<listitem>
4302	<para><computeroutput>TRANSRESET</computeroutput>: the value
4303	will be deleted as soon as the VM restarts and/or exits;</para>
4304	</listitem>
4305
4306	<listitem>
4307	<para><computeroutput>RDONLYGUEST</computeroutput>: the value
4308	can only be changed by the host, but the guest can only read
4309	it;</para>
4310	</listitem>
4311
4312	<listitem>
4313	<para><computeroutput>RDONLYHOST</computeroutput>: reversely,
4314	the value can only be changed by the guest, but the host can
4315	only read it;</para>
4316	</listitem>
4317
4318	<listitem>
4319	<para><computeroutput>READONLY</computeroutput>: a combination
4320	of the two, the value cannot be changed at all.</para>
4321	</listitem>
4322	</itemizedlist></para>
4323	</listitem>
4324
4325	<listitem>
4326	<para><computeroutput>wait <vm> <pattern> --timeout
4327	<timeout></computeroutput>: This waits for a particular value
4328	described by "pattern" to change or to be deleted or created. The
4329	pattern rules are the same as for the "enumerate" subcommand
4330	above.</para>
4331	</listitem>
4332
4333	<listitem>
4334	<para><computeroutput>delete <vm> <property>
4335	</computeroutput>: Deletes a formerly set guest property.
4336	</para></listitem>
4337	</itemizedlist></para>
4338	</sect1>
4339
4340	<sect1 id="vboxmanage-guestcontrol">
4341	<title>VBoxManage guestcontrol</title>
4342
4343	<para>The <computeroutput>guestcontrol</computeroutput> commands enable
4344	control of the guest from the host. Please see <xref
4345	linkend="guestadd-guestcontrol" /> for an introduction.</para>
4346
4347	<para>guestcontrol has two sets of subcommands. The first set requires guest
4348	credentials to be specified, the second does not.</para>
4349
4350	<para>The first set of subcommands is of the form:</para>
4351	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
4352	[--username <name> ]
4353	[--passwordfile <file> \| --password <password>]
4354	[--domain <domain> ]
4355	[-v\|--verbose] [-q\|quiet] ...
4356	</screen>
4357
4358	<para>The "common-options" are:</para>
4359	<screen>
4360	[--username <name> ]
4361	[--passwordfile <file> \| --password <password>]
4362	[--domain <domain> ]
4363	[-v\|--verbose] [-q\|quiet]
4364	</screen>
4365
4366	<para>Where details of the common options for the first set of subcommands are:
4367	<glosslist>
4368
4369	<glossentry>
4370	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4371	<glossdef>
4372	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4373	</glossdef>
4374	</glossentry>
4375
4376	<glossentry>
4377	<glossterm><computeroutput>--username <name></computeroutput></glossterm>
4378	<glossdef><para>Specifies the user name on guest OS under which the process should run. This
4379	user name must already exist on the guest OS. If unspecified, the host user name is used. Optional</para>
4380	</glossdef>
4381	</glossentry>
4382
4383	<glossentry>
4384	<glossterm><computeroutput>--passwordfile <file>\|--password</computeroutput></glossterm>
4385	<glossdef><para>Specifies the absolute path on guest file system of password file containing the
4386	password for the specified user account or password for the specified user account. Optional.
4387	If both are omitted, empty password is assumed.</para></glossdef>
4388	</glossentry>
4389
4390	<glossentry>
4391	<glossterm><computeroutput>--domain <domain></computeroutput></glossterm>
4392	<glossdef><para>User domain for Windows guests. Optional.</para></glossdef>
4393	</glossentry>
4394
4395	<glossentry>
4396	<glossterm><computeroutput>-v\|--verbose</computeroutput></glossterm>
4397	<glossdef><para>Makes the subcommand execution more verbose. Optional</para></glossdef>
4398	</glossentry>
4399
4400	<glossentry>
4401	<glossterm><computeroutput>-q\|--quiet</computeroutput></glossterm>
4402	<glossdef><para>Makes the subcommand execution quieter. Optional.</para></glossdef>
4403	</glossentry>
4404	</glosslist>
4405	</para>
4406
4407	<para>The first set of subcommands: <itemizedlist>
4408	<listitem>
4409	<para><emphasis role="bold"><computeroutput>run</computeroutput></emphasis>
4410	Executes a guest program - forwarding stdout, stderr and stdin to/from the host
4411	until it completes.</para>
4412	<screen>VBoxManage guestcontrol <uuid\|vmname> run [common-options]
4413	--exe <path to executable> [--timeout <msec>]
4414	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
4415	[--ignore-operhaned-processes] [--profile]
4416	[--no-wait-stdout\|--wait-stdout]
4417	[--no-wait-stderr\|--wait-stderr]
4418	[--dos2unix] [--unix2dos]
4419	-- <program/arg0> [argument1] ... [argumentN]]
4420	</screen>
4421	<glosslist>
4422	<glossentry>
4423	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4424	<glossdef>
4425	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4426	</glossdef>
4427	</glossentry>
4428
4429	<glossentry>
4430	<glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm>
4431	<glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
4432	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.</para>
4433	</glossdef>
4434	</glossentry>
4435
4436	<glossentry>
4437	<glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
4438	<glossdef>
4439	<para>Specifies the maximum time (microseconds) that the executable can run,
4440	during which VBoxManage receives its output. Optional.
4441	If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para>
4442	</glossdef>
4443	</glossentry>
4444
4445	<glossentry>
4446	<glossterm><computeroutput>-E\|--putenv <NAME>=<VALUE>
4447	</computeroutput></glossterm>
4448	<glossdef>
4449	<para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para>
4450	<para>The guest process is created with the standard default guest OS environment.
4451	Use this option to modify that default environment. To set/modify a variable use:
4452	<computeroutput><NAME>=<VALUE></computeroutput>.
4453	To unset a variable use:
4454	<computeroutput><NAME>=</computeroutput></para>
4455	<para>Any spaces in names/values should be enclosed by quotes. </para>
4456	<para>To set/modify/unset multiple variables, use multiple instances of the
4457	<computeroutput>--E\|--putenv</computeroutput> option. </para>
4458	</glossdef>
4459	</glossentry>
4460
4461	<glossentry>
4462	<glossterm><computeroutput>--unquoted-args</computeroutput></glossterm>
4463	<glossdef>
4464	<para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para>
4465	</glossdef>
4466	</glossentry>
4467
4468	<glossentry>
4469	<glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm>
4470	<glossdef>
4471	<para>Ignore orphaned processes. Not yet implemented. Optional.</para>
4472	</glossdef>
4473	</glossentry>
4474
4475	<glossentry>
4476	<glossterm><computeroutput>--profile</computeroutput></glossterm>
4477	<glossdef>
4478	<para>Use Profile. Not yet implemented. Optional.</para>
4479	</glossdef>
4480	</glossentry>
4481
4482	<glossentry>
4483	<glossterm><computeroutput>--no-wait-stdout\|--wait-stdout</computeroutput></glossterm>
4484	<glossdef>
4485	<para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags.
4486	In the case of --wait-stdout - while the process runs, VBoxManage receives its stdout. Optional.</para>
4487	</glossdef>
4488	</glossentry>
4489
4490	<glossentry>
4491	<glossterm><computeroutput>--no-wait-stderr\|--wait-stderr</computeroutput></glossterm>
4492	<glossdef>
4493	<para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags.
4494	In case of --wait-stderr - while the process runs, VBoxManage receives its stderr. Optional.</para>
4495	</glossdef>
4496	</glossentry>
4497
4498	<glossentry>
4499	<glossterm><computeroutput>--dos2unix</computeroutput></glossterm>
4500	<glossdef><para>
4501	Converts output from DOS/Windows guests to UNIX/Linux-compatible line endings
4502	(CR + LF → LF). Not yet implemented. Optional.</para>
4503	</glossdef>
4504	</glossentry>
4505
4506	<glossentry>
4507	<glossterm><computeroutput>--unix2dos</computeroutput></glossterm>
4508	<glossdef><para>
4509	Converts output from a UNIX/Linux guests to DOS/Windows-compatible
4510	line endings (LF → CR + LF). Not yet implemented. Optional.</para>
4511	</glossdef>
4512	</glossentry>
4513
4514	<glossentry>
4515	<glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm>
4516	<glossdef>
4517	<para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para>
4518	<para>Note: Any spaces in arguments should be enclosed by quotes.</para>
4519	</glossdef>
4520	</glossentry>
4521	</glosslist>
4522
4523	<para><note>
4524	<para>On Windows there are certain limitations for graphical
4525	applications; please see <xref linkend="KnownIssues" /> for more
4526	information.</para>
4527	</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls"
4528	--username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe"
4529	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
4530	the double backslashes in the second example are only required on
4531	Unix hosts.</para>
4532
4533	<para><note>
4534	<para>For certain commands a user name of an existing user account on the guest
4535	must be specified; anonymous executions are not supported for security reasons. A
4536	user account password, however, is optional and depends on the guest's OS security
4537	policy or rules. If no password is specified for a given user name, an empty password
4538	will be used. On certain OSes like Windows the security policy may needs to be adjusted
4539	in order to allow user accounts with an empty password set. Also, global domain rules might
4540	apply and therefore cannot be changed.</para>
4541	</note></para>
4542
4543	<para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
4544	to serve up to 5 guest processes at a time. If a new guest process gets started
4545	which would exceed this limit, the oldest not running guest process will be discarded
4546	in order to be able to run that new process. Also, retrieving output from this
4547	old guest process will not be possible anymore then. If all 5 guest processes
4548	are still active and running, starting a new guest process will result in an
4549	appropriate error message.</para>
4550
4551	<para>To raise or lower the guest process execution limit, either the guest
4552	property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
4553	or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
4554	needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
4555	guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
4556	</listitem>
4557
4558	<listitem>
4559	<para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis>
4560	Executes a guest program until it completes.</para>
4561	<screen>VBoxManage guestcontrol <uuid\|vmname> start [common-options]
4562	[--exe <path to executable>] [--timeout <msec>]
4563	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
4564	[--ignore-operhaned-processes] [--profile]
4565	-- <program/arg0> [argument1] ... [argumentN]]
4566	</screen>
4567
4568	<para>Where the options are: <glosslist>
4569	<glossentry>
4570	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4571	<glossdef>
4572	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4573	</glossdef>
4574	</glossentry>
4575
4576	<glossentry>
4577	<glossterm><computeroutput>--exe <path to executable></computeroutput></glossterm>
4578	<glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.:
4579	<computeroutput>C:\Windows\System32\calc.exe</computeroutput></para>
4580	</glossdef>
4581	</glossentry>
4582
4583	<glossentry>
4584	<glossterm><computeroutput>--timeout <msec></computeroutput></glossterm>
4585	<glossdef>
4586	<para>Specifies the maximum time (microseconds) that the executable can run. Optional.
4587	If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para>
4588	</glossdef>
4589	</glossentry>
4590
4591	<glossentry>
4592	<glossterm><computeroutput>-E\|--putenv <NAME>=<VALUE>
4593	</computeroutput></glossterm>
4594	<glossdef>
4595	<para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para>
4596	<para>The guest process is created with the standard default guest OS environment.
4597	Use this option to modify that default environment. To set/modify a variable use:
4598	<computeroutput><NAME>=<VALUE></computeroutput>.
4599	To unset a variable use:
4600	<computeroutput><NAME>=</computeroutput></para>
4601	<para>Any spaces in names/values should be enclosed by quotes. </para>
4602	<para>To set/modify/unset multiple variables, use multiple instances of the
4603	<computeroutput>--E\|--putenv</computeroutput> option. </para>
4604	</glossdef>
4605	</glossentry>
4606
4607	<glossentry>
4608	<glossterm><computeroutput>--unquoted-args</computeroutput></glossterm>
4609	<glossdef>
4610	<para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para>
4611	</glossdef>
4612	</glossentry>
4613
4614	<glossentry>
4615	<glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm>
4616	<glossdef>
4617	<para>Ignores orphaned processes. Not yet implemented. Optional.</para>
4618	</glossdef>
4619	</glossentry>
4620
4621	<glossentry>
4622	<glossterm><computeroutput>--profile</computeroutput></glossterm>
4623	<glossdef>
4624	<para>Use a profile. Not yet implemented. Optional.</para>
4625	</glossdef>
4626	</glossentry>
4627
4628	<glossentry>
4629	<glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm>
4630	<glossdef>
4631	<para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para>
4632	<para>Note: Any spaces in arguments should be enclosed by quotes.</para>
4633	</glossdef>
4634	</glossentry>
4635	</glosslist></para>
4636
4637	<para><note>
4638	<para>On Windows there are certain limitations for graphical
4639	applications; please see <xref linkend="KnownIssues" /> for more
4640	information.</para>
4641	</note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls"
4642	--username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe"
4643	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that
4644	the double backslashes in the second example are only required on
4645	Unix hosts.</para>
4646
4647	<para><note>
4648	<para>For certain commands a user name of an existing user account on the guest
4649	must be specified; anonymous executions are not supported for security reasons. A
4650	user account password, however, is optional and depends on the guest's OS security
4651	policy or rules. If no password is specified for a given user name, an empty password
4652	will be used. On certain OSes like Windows the security policy may needs to be adjusted
4653	in order to allow user accounts with an empty password set. Also, global domain rules might
4654	apply and therefore cannot be changed.</para>
4655	</note></para>
4656
4657	<para>Starting at VirtualBox 4.1.2 guest process execution by default is limited
4658	to serve up to 5 guest processes at a time. If a new guest process gets started
4659	which would exceed this limit, the oldest not running guest process will be discarded
4660	in order to be able to run that new process. Also, retrieving output from this
4661	old guest process will not be possible anymore then. If all 5 guest processes
4662	are still active and running, starting a new guest process will result in an
4663	appropriate error message.</para>
4664
4665	<para>To raise or lower the guest process execution limit, either the guest
4666	property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
4667	or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput>
4668	needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited
4669	guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para>
4670	</listitem>
4671
4672	<listitem>
4673	<para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>
4674	Copies files from the guest to the host file system.
4675	(Note - only with Guest Additions 4.0 or later installed).</para>
4676
4677	<screen>VBoxManage guestcontrol <uuid\|vmname> copyfrom [common-options]
4678	[--dryrun] [--follow] [--R\|recursive]
4679	--target-directory <host-dst-dir>
4680	<guest-src0> [<guest-src1> [...]] </screen>
4681
4682	<para>Where the parameters are:<glosslist>
4683	<glossentry>
4684	<glossterm><computeroutput><uid\|vmname></computeroutput></glossterm>
4685	<glossdef>
4686	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4687	</glossdef>
4688	</glossentry>
4689
4690	<glossentry>
4691	<glossterm><computeroutput>--dryrun</computeroutput></glossterm>
4692	<glossdef>
4693	<para>Instructs VBoxManage to perform a dry run instead of an actual file copying
4694	operation. Optional. </para>
4695	</glossdef>
4696	</glossentry>
4697
4698	<glossentry>
4699	<glossterm><computeroutput>--follow</computeroutput></glossterm>
4700	<glossdef>
4701	<para>Enables symlink following on the guest file system. Optional.</para>
4702	</glossdef>
4703	</glossentry>
4704
4705	<glossentry>
4706	<glossterm><computeroutput>-R\|--recursive</computeroutput></glossterm>
4707	<glossdef>
4708	<para>Enables recursive copying of files/directories from the specified guest file system
4709	directory. Optional.</para>
4710	</glossdef>
4711	</glossentry>
4712
4713	<glossentry>
4714	<glossterm><computeroutput>--target-directory <host-dst-dir></computeroutput></glossterm>
4715	<glossdef>
4716	<para>Specifies the absolute path of the host file system destination directory. Mandatory. e.g.
4717	<computeroutput>C:\Temp</computeroutput>.</para>
4718	</glossdef>
4719	</glossentry>
4720
4721	<glossentry>
4722	<glossterm><computeroutput><guest-src0> [<guest-src1> [...]]</computeroutput></glossterm>
4723	<glossdef>
4724	<para>Specifies the absolute path(s) of guest file system file(s) to be copied. Mandatory. e.g.
4725	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
4726	Wildcards can be used in the expression(s), e.g.
4727	<computeroutput>C:\Windows\System\.dll</computeroutput>.</para>
4728	</glossdef>
4729	</glossentry>
4730	</glosslist>
4731	</para>
4732	</listitem>
4733
4734	<listitem>
4735	<para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>
4736	Copies files from the host to the guest file system.
4737	(Note - only with Guest Additions 4.0 or later installed).</para>
4738
4739	<screen>VBoxManage guestcontrol <uuid\|vmname> copyto [common-options]
4740	[--dryrun] [--follow] [--R\|recursive]
4741	--target-directory <guest-dst>
4742	<host-src0> [<host-src1> [...]] </screen>
4743
4744	<para>Where the parameters are:<glosslist>
4745	<glossentry>
4746	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4747	<glossdef>
4748	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4749	</glossdef>
4750	</glossentry>
4751
4752	<glossentry>
4753	<glossterm><computeroutput>--dryrun</computeroutput></glossterm>
4754	<glossdef>
4755	<para>Instructs VBoxManage to perform a dry run instead of an actual file copying
4756	operation. Optional. </para>
4757	</glossdef>
4758	</glossentry>
4759
4760	<glossentry>
4761	<glossterm><computeroutput>--follow</computeroutput></glossterm>
4762	<glossdef>
4763	<para>Enables symlink following on the host file system. Optional.</para>
4764	</glossdef>
4765	</glossentry>
4766
4767	<glossentry>
4768	<glossterm><computeroutput>-R\|--recursive</computeroutput></glossterm>
4769	<glossdef>
4770	<para>Enables recursive copying of files/directories from the specified host file system
4771	directory(ies). Optional.</para>
4772	</glossdef>
4773	</glossentry>
4774
4775	<glossentry>
4776	<glossterm><computeroutput>--target-directory <guest-dst></computeroutput></glossterm>
4777	<glossdef>
4778	<para>Specifies the absolute path of the guest file system destination directory. Mandatory. e.g.
4779	<computeroutput>C:\Temp</computeroutput>.</para>
4780	</glossdef>
4781	</glossentry>
4782
4783	<glossentry>
4784	<glossterm><computeroutput><host-src0> [<host-src1> [...]]</computeroutput></glossterm>
4785	<glossdef>
4786	<para>Specifies the absolute path(s) of host file system file(s) to be copied. Mandatory. e.g.
4787	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
4788	Wildcards can be used in the expression(s), e.g.
4789	<computeroutput>C:\Windows\System\.dll</computeroutput>.</para>
4790	</glossdef>
4791	</glossentry>
4792	</glosslist>
4793	</para>
4794	</listitem>
4795
4796	<listitem>
4797	<para><emphasis role="bold"><computeroutput>md\|mkdir\|createdir\|createdirectory</computeroutput></emphasis>
4798	Creates one or more directory(ies) on the guest file system.
4799	(Note - only with Guest Additions 4.0 or later installed).</para>
4800
4801	<screen>VBoxManage guestcontrol <uuid\|vmname> md\|mkdir\|createdir\|createdirectory [common-options]
4802	[--parents] [--mode <mode>]
4803	<guest-dir0> [<guest-dir1> [...]] </screen>
4804
4805	<para>Where the parameters are: <glosslist>
4806	<glossentry>
4807	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4808	<glossdef>
4809	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4810	</glossdef>
4811	</glossentry>
4812	<glossentry>
4813	<glossterm><computeroutput>--parents</computeroutput></glossterm>
4814	<glossdef>
4815	<para>Creates any absent parent directory(ies) of the specified directory. Optional.</para>
4816	<para>e.g. If specified directory is <computeroutput>D:\Foo\Bar</computeroutput>
4817	and <computeroutput>D:\Foo</computeroutput> is absent, it will
4818	be created. In such a case, had the <computeroutput>--parents</computeroutput>
4819	option not been used, this command would have failed.</para>
4820	</glossdef>
4821	</glossentry>
4822
4823	<glossentry>
4824	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
4825	<glossdef>
4826	<para>Specifies the permission mode on the specified directory(ies) (and any parents,
4827	where <computeroutput>--parents</computeroutput> option used).
4828	Currently octal modes (e.g. <computeroutput>0755</computeroutput>) only are
4829	supported.</para>
4830	</glossdef>
4831	</glossentry>
4832
4833	<glossentry>
4834	<glossterm><computeroutput><guest-dir0> [<guest-dir1> [...]]</computeroutput></glossterm>
4835	<glossdef>
4836	<para>Specifies list of absolute path(s) of directory(ies) to be created on
4837	guest file system. Mandatory.
4838	e.g. <computeroutput>D:\Foo\Bar</computeroutput>.</para>
4839	<para>All parent directories must already exist
4840	unless switch <computeroutput>--parents</computeroutput> used.
4841	(e.g. in the above example <computeroutput>D:\Foo</computeroutput>).
4842	The specified user must have sufficient rights to create the
4843	specified directory(ies), and any parents that need
4844	to be created.</para>
4845	</glossdef>
4846	</glossentry>
4847	</glosslist>
4848	</para>
4849	</listitem>
4850
4851	<listitem>
4852	<para><emphasis role="bold"><computeroutput>rmdir\|removedir\|removedirectory</computeroutput></emphasis>
4853	Deletes specified guest file system directories. (Only with installed Guest Additions 4.3.2 and later).</para>
4854
4855	<screen>VBoxManage guestcontrol <uuid\|vmname> rmdir\|removedir\|removedirectory [common-options]
4856	[--recursive\|-R]
4857	<guest-dir0> [<guest-dir1> [...]]
4858	</screen>
4859
4860	<para>Where the parameters are: <glosslist>
4861	<glossentry>
4862	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4863	<glossdef>
4864	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4865	</glossdef>
4866	</glossentry>
4867
4868	<glossentry>
4869	<glossterm><computeroutput>--recursive</computeroutput></glossterm>
4870	<glossdef>
4871	<para>Recursively removes directories and contents. Optional.</para>
4872	</glossdef>
4873	</glossentry>
4874
4875	<glossentry>
4876	<glossterm><computeroutput><guest-dir0> [<guest-dir1> [...]]</computeroutput></glossterm>
4877	<glossdef>
4878	<para>Specifies list of the absolute path(s) of directory(ies) to be deleted on
4879	guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\*Bar</computeroutput>.
4880	The specified user must have sufficient rights to delete the
4881	specified directory(ies).</para>
4882	</glossdef>
4883	</glossentry>
4884	</glosslist></para>
4885	</listitem>
4886
4887	<listitem>
4888	<para><emphasis role="bold"><computeroutput>rm\|removefile</computeroutput></emphasis>
4889	Deletes specified files on the guest file system. (Only with installed Guest
4890	Additions 4.3.2 and later).</para>
4891
4892	<screen>VBoxManage guestcontrol <uuid\|vmname> rm\|removefile [common-options]
4893	[-f\|--force]
4894	<guest-file0> [<guest-file1> [...]] </screen>
4895
4896	<para>Where the parameters are: <glosslist>
4897	<glossentry>
4898	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4899	<glossdef>
4900	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4901	</glossdef>
4902	</glossentry>
4903
4904	<glossentry>
4905	<glossterm><computeroutput>-f\|--force</computeroutput></glossterm>
4906	<glossdef>
4907	<para>Enforce operation (override any requests for confirmations). Optional.</para>
4908	</glossdef>
4909	</glossentry>
4910
4911	<glossentry>
4912	<glossterm><computeroutput><guest-file0> [<guest-file1> [...]]</computeroutput></glossterm>
4913	<glossdef>
4914	<para>Specifies list of absolute path(s) of file(s) to be deleted on guest file system. Mandatory.
4915	Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text*.txt</computeroutput>.
4916	The specified user should have sufficient rights to delete the specified file(s).</para>
4917	</glossdef>
4918	</glossentry>
4919	</glosslist>
4920	</para>
4921	</listitem>
4922
4923	<listitem>
4924	<para><emphasis role="bold"><computeroutput>mv\|move\|ren\|rename</computeroutput></emphasis>
4925	This subcommand renames file(s) and/or directory(ies) on the guest file system. (Only with installed Guest
4926	Additions 4.3.2 and later).</para>
4927
4928	<screen>VBoxManage guestcontrol <uuid\|vmname> mv\|move\|ren\|rename [common-options]
4929	<guest-source0> [<guest-source1> [...]] <guest-dest></screen>
4930
4931	<para>Where the parameters are: <glosslist>
4932	<glossentry>
4933	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4934	<glossdef>
4935	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4936	</glossdef>
4937	</glossentry>
4938
4939	<glossentry>
4940	<glossterm><computeroutput><guest-source0> [<guest-source1> [...]]</computeroutput></glossterm>
4941	<glossdef>
4942	<para>Specifies absolute path(s) of file(s) and/or single directory to be moved/renamed on guest
4943	file system. Mandatory.
4944	Wildcards are allowed in file names(s). The specified user should have sufficient rights to
4945	access the specified file(s).</para>
4946	</glossdef>
4947	</glossentry>
4948
4949	<glossentry>
4950	<glossterm><computeroutput><dest></computeroutput></glossterm>
4951	<glossdef>
4952	<para>Specifies the absolute path of the destination file/directory to which the file(s)
4953	are to be moved. Mandatory. If only one file to be moved, <dest> can be file or directory,
4954	else it must be a directory.
4955	The specified user must have sufficient rights to access the destination file/directory.</para>
4956	</glossdef>
4957	</glossentry>
4958	</glosslist></para>
4959	</listitem>
4960
4961	<listitem>
4962	<para><emphasis role="bold"><computeroutput>mktemp\|createtemp\|createtemporary</computeroutput></emphasis>
4963	Creates a temporary file/directory on the guest file system, to assist subsequent
4964	copying of files from the host to the guest file systems. By default, the file/directory
4965	is created in the guest's platform specific temp directory. Not currently supported.
4966	(Only with installed Guest Additions 4.2 and later).</para>
4967
4968	<screen>VBoxManage guestcontrol <uuid\|vmname> mktemp\|createtemp\|createtemporary [common-options]
4969	[--directory] [--secure] [--mode <mode>] [--tmpdir <directory>]
4970	<template>
4971	</screen>
4972
4973	<para>The parameters are: <glosslist>
4974	<glossentry>
4975	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
4976	<glossdef>
4977	<para>Specifies the VM UUID or VM name. Mandatory.</para>
4978	</glossdef>
4979	</glossentry>
4980
4981	<glossentry>
4982	<glossterm><computeroutput>--directory</computeroutput></glossterm>
4983	<glossdef>
4984	<para>Creates a temporary directory instead of a file, specified by the <template> parameter. Optional.</para>
4985	</glossdef>
4986	</glossentry>
4987
4988	<glossentry>
4989	<glossterm><computeroutput>--secure</computeroutput></glossterm>
4990	<glossdef>
4991	<para>
4992	Enforces secure file/directory creation. Optional. The permission mode is set to
4993	<computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely.
4994	</para>
4995	</glossdef>
4996	</glossentry>
4997
4998	<glossentry>
4999	<glossterm><computeroutput>--mode <mode></computeroutput></glossterm>
5000	<glossdef>
5001	<para>Specifies the permission mode of the specified directory. Optional.
5002	Currently only octal modes (e.g. <computeroutput>0755</computeroutput>)
5003	are supported.</para>
5004	</glossdef>
5005	</glossentry>
5006
5007	<glossentry>
5008	<glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm>
5009	<glossdef>
5010	<para>
5011	Specifies the absolute path of the directory on the guest file system into which the
5012	file/directory specified in will be created. Optional.
5013	If unspecified, the platform-specific temp directory is used.
5014	</para>
5015	</glossdef>
5016	</glossentry>
5017
5018	<glossentry>
5019	<glossterm><computeroutput><template></computeroutput></glossterm>
5020	<glossdef>
5021	<para>Specifies a file name without a directory path, containing at least one sequence comprising
5022	three consecutive 'X' characters, or ending in 'X'. Mandatory.
5023	</para>
5024	</glossdef>
5025	</glossentry>
5026	</glosslist></para>
5027	</listitem>
5028
5029	<listitem>
5030	<para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>
5031	Displays file or file system status(es) on the guest.</para>
5032
5033	<screen>VBoxManage guestcontrol <uuid\|vmname> stat [common-options]
5034	<file0> [<file1> [...]]</screen>
5035
5036	<para>Where the parameters are: <glosslist>
5037	<glossentry>
5038	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5039	<glossdef>
5040	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5041	</glossdef>
5042	</glossentry>
5043
5044	<glossentry>
5045	<glossterm><computeroutput><file0> [<file1> [...]]</computeroutput></glossterm>
5046	<glossdef>
5047	<para>Specifies absolute path(s) of file(s) and/or file system(s) on guest file system. Mandatory.
5048	e.g. <computeroutput>/home/foo/a.out</computeroutput>.
5049	The specified user should have sufficient rights to access
5050	the specified file(s)/file system(s).</para>
5051	</glossdef>
5052	</glossentry>
5053	</glosslist></para>
5054	</listitem>
5055	</itemizedlist>
5056	</para>
5057
5058	<para>The second set of subcommands is of the form:</para>
5059	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
5060	[-v\|--verbose] [-q\|quiet] ...
5061	</screen>
5062
5063	<para>The "common-options" are:</para>
5064	<screen>
5065	[-v\|--verbose] [-q\|--quiet]
5066	</screen>
5067
5068	<para>Where details of the common options for the second set of subcommands are:
5069	<glosslist>
5070
5071	<glossentry>
5072	<glossterm><computeroutput>-v\|--verbose</computeroutput></glossterm>
5073	<glossdef><para>Makes the sub-command execution more verbose. Optional.</para></glossdef>
5074	</glossentry>
5075
5076	<glossentry>
5077	<glossterm><computeroutput>-q\|--quiet</computeroutput></glossterm>
5078	<glossdef><para>Makes the sub-command execution quieter. Optional.</para></glossdef>
5079	</glossentry>
5080	</glosslist>
5081	</para>
5082
5083	<para>The second set of subcommands: <itemizedlist>
5084	<listitem>
5085	<para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>
5086	Lists guest control configuration and status data, e.g. open guest sessions,
5087	guest processes and files.</para>
5088
5089	<screen>VBoxManage guestcontrol <uuid\|vmname> list [common-opts]
5090	<all\|sessions\|processes\|files> </screen>
5091
5092	<para>Where the parameters are: <glosslist>
5093	<glossentry>
5094	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5095	<glossdef>
5096	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5097	</glossdef>
5098	</glossentry>
5099
5100	<glossentry>
5101	<glossterm><computeroutput>all\|sessions\|processes\|files</computeroutput></glossterm>
5102	<glossdef>
5103	<para>Indicates whether to list all available data or guest sessions, processes or files.
5104	Mandatory.</para>
5105	</glossdef>
5106	</glossentry>
5107
5108	</glosslist></para>
5109	</listitem>
5110
5111	<listitem>
5112	<para><emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>
5113	Terminates guest processes specified by PID(s))running in guest session(s),
5114	specified by the session ID or name(s).</para>
5115
5116	<screen>VBoxManage guestcontrol <uuid\|vmname> closeprocess [common-options]
5117	--session-id <ID> \| --session-name <name or pattern>
5118	<PID0> [<PID1> [...]] </screen>
5119
5120	<para>Where the parameters are: <glosslist>
5121	<glossentry>
5122	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5123	<glossdef>
5124	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5125	</glossdef>
5126	</glossentry>
5127
5128	<glossentry>
5129	<glossterm><computeroutput>--session-id <ID></computeroutput></glossterm>
5130	<glossdef>
5131	<para>Specifies the guest session by its ID. Optional.</para>
5132	</glossdef>
5133	</glossentry>
5134
5135	<glossentry>
5136	<glossterm><computeroutput>--session-name <name or pattern></computeroutput></glossterm>
5137	<glossdef>
5138	<para>Specifies the guest session by its name, or multiple sessions
5139	using a pattern containing wildcards. Optional.</para>
5140	</glossdef>
5141	</glossentry>
5142
5143	<glossentry>
5144	<glossterm><computeroutput><PID0> [<PID1> [...]]</computeroutput></glossterm>
5145	<glossdef>
5146	<para>Specifies a list of process identifiers (PIDs) of guest processes to be terminated. Mandatory.</para>
5147	</glossdef>
5148	</glossentry>
5149	</glosslist></para>
5150	</listitem>
5151
5152	<listitem>
5153	<para><emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>
5154	Closes specified guest sessions, specified either by session ID or name.</para>
5155
5156	<screen>VBoxManage guestcontrol <uuid\|vmname> closesession [common-options]
5157	--session-id <ID> \| --session-name <name or pattern> \| --all </screen>
5158
5159	<para>Where the parameters are: <glosslist>
5160	<glossentry>
5161	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5162	<glossdef>
5163	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5164	</glossdef>
5165	</glossentry>
5166
5167	<glossentry>
5168	<glossterm><computeroutput>--session-id <ID></computeroutput></glossterm>
5169	<glossdef>
5170	<para>Specifies the guest session to be closed by ID. Optional.</para>
5171	</glossdef>
5172	</glossentry>
5173
5174	<glossentry>
5175	<glossterm><computeroutput>--session-name <name or pattern></computeroutput></glossterm>
5176	<glossdef>
5177	<para>Specifies the guest session to be closed by name. Optional.
5178	Multiple sessions can be specified by using a pattern
5179	containing wildcards. </para>
5180	</glossdef>
5181	</glossentry>
5182
5183	<glossentry>
5184	<glossterm><computeroutput>--all</computeroutput></glossterm>
5185	<glossdef>
5186	<para>Close all guest sessions. Optional.</para>
5187	</glossdef>
5188	</glossentry>
5189	</glosslist></para>
5190	</listitem>
5191
5192	<listitem>
5193	<para><emphasis role="bold"><computeroutput>updatega\|updateadditions\|updateguestadditions</computeroutput></emphasis>
5194	Ugrades Guest Additions already installed on the guest.
5195	(Only already installed Guest Additions 4.0 and later).</para>
5196
5197	<screen>VBoxManage guestcontrol <uuid\|vmname> updatega\|updateadditions\|updateguestadditions [common-options]
5198	[--source <New .ISO path>]
5199	[--wait-start]
5200	[-- <argument0> [<argument1> [...]]]</screen>
5201
5202	<para>Where the parameters are: <glosslist>
5203	<glossentry>
5204	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5205	<glossdef>
5206	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5207	</glossdef>
5208	</glossentry>
5209
5210	<glossentry>
5211	<glossterm><computeroutput>--source</computeroutput> <New .ISO path></glossterm>
5212	<glossdef>
5213	<para>Specifies the absolute path on guest file system of the .ISO file for Guest Additions update. Mandatory.</para>
5214	</glossdef>
5215	</glossentry>
5216
5217	<glossentry>
5218	<glossterm><computeroutput>--wait-start</computeroutput></glossterm>
5219	<glossdef>
5220	<para>Indicates that VBoxManage starts the usual updating process on the guest and then waits
5221	until the actual Guest Additions updating begins, at which point VBoxManage self-terminates. Optional.</para>
5222	<para>Default behavior is that VBoxManage waits for completion of the Guest Additions update before
5223	terminating. Use of this option is sometimes necessary, as a running VBoxManage
5224	can affect the interaction between the installer and the guest OS.</para>
5225	</glossdef>
5226	</glossentry>
5227
5228	<glossentry>
5229	<glossterm><computeroutput>[-- <argument0> [<argument1> [...]]]</computeroutput></glossterm>
5230	<glossdef>
5231	<para>Specifies optional command line arguments to be supplied to the Guest Additions
5232	updater. Useful for retrofitting features which are not currently installed.</para>
5233	<para>Arguments containing spaces should be enclosed by quotes.</para>
5234	</glossdef>
5235	</glossentry>
5236	</glosslist></para>
5237	</listitem>
5238
5239	<listitem>
5240	<para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>
5241	This subcommand prints current guest control activity.</para>
5242
5243	<screen>VBoxManage guestcontrol <uuid\|vmname> watch [common-options]
5244	</screen>
5245	<para>Where the parameters are: <glosslist>
5246	<glossentry>
5247	<glossterm><computeroutput><uuid\|vmname></computeroutput></glossterm>
5248	<glossdef>
5249	<para>Specifies the VM UUID or VM name. Mandatory.</para>
5250	</glossdef>
5251	</glossentry>
5252	</glosslist></para>
5253	</listitem>
5254	</itemizedlist></para>
5255	</sect1>
5256
5257	<sect1 id="metrics">
5258	<title>VBoxManage metrics</title>
5259
5260	<para>This command supports monitoring the usage of system resources.
5261	Resources are represented by various metrics associated with the host
5262	system or a particular VM. For example, the host system has a
5263	<computeroutput>CPU/Load/User</computeroutput> metric that shows the
5264	percentage of time CPUs spend executing in user mode over a specific
5265	sampling period.</para>
5266
5267	<para>Metric data is collected and retained internally; it may be
5268	retrieved at any time with the <computeroutput>VBoxManage metrics
5269	query</computeroutput> subcommand. The data is available as long as the
5270	background <computeroutput>VBoxSVC</computeroutput> process is alive. That
5271	process terminates shortly after all VMs and frontends have been
5272	closed.</para>
5273
5274	<para>By default no metrics are collected at all. Metrics collection does
5275	not start until <computeroutput>VBoxManage metrics setup</computeroutput>
5276	is invoked with a proper sampling interval and the number of metrics to be
5277	retained. The interval is measured in seconds. For example, to enable
5278	collecting the host processor and memory usage metrics every second and
5279	keeping the 5 most current samples, the following command can be
5280	used:</para>
5281
5282	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
5283
5284	<para>Metric collection can only be enabled for started VMs. Collected
5285	data and collection settings for a particular VM will disappear as soon as
5286	it shuts down. Use <computeroutput>VBoxManage metrics list
5287	</computeroutput> subcommand to see which metrics are currently available.
5288	You can also use <computeroutput>--list</computeroutput> option with any
5289	subcommand that modifies metric settings to find out which metrics were
5290	affected.</para>
5291
5292	<para>Note that the <computeroutput>VBoxManage metrics
5293	setup</computeroutput> subcommand discards all samples that may have been
5294	previously collected for the specified set of objects and metrics.</para>
5295
5296	<para>To enable or disable metrics collection without discarding the data
5297	<computeroutput>VBoxManage metrics enable</computeroutput> and
5298	<computeroutput>VBoxManage metrics disable</computeroutput> subcommands
5299	can be used. Note that these subcommands expect metrics, not submetrics,
5300	like <code>CPU/Load</code> or <code>RAM/Usage</code> as parameters. In
5301	other words enabling <code>CPU/Load/User</code> while disabling
5302	<code>CPU/Load/Kernel</code> is not supported.</para>
5303
5304	<para>The host and VMs have different sets of associated metrics.
5305	Available metrics can be listed with <computeroutput>VBoxManage metrics
5306	list</computeroutput> subcommand.</para>
5307
5308	<para>A complete metric name may include an aggregate function. The name
5309	has the following form:
5310	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
5311	For example, <computeroutput>RAM/Usage/Free:min</computeroutput> stands
5312	for the minimum amount of available memory over all retained data if
5313	applied to the host object.</para>
5314
5315	<para>Subcommands may apply to all objects and metrics or can be limited
5316	to one object or/and a list of metrics. If no objects or metrics are given
5317	in the parameters, the subcommands will apply to all available metrics of
5318	all objects. You may use an asterisk
5319	("<computeroutput>*</computeroutput>") to explicitly specify that the
5320	command should be applied to all objects or metrics. Use "host" as the
5321	object name to limit the scope of the command to host-related metrics. To
5322	limit the scope to a subset of metrics, use a metric list with names
5323	separated by commas.</para>
5324
5325	<para>For example, to query metric data on the CPU time spent in user and
5326	kernel modes by the virtual machine named "test", you can use the
5327	following command:</para>
5328
5329	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
5330
5331	<para>The following list summarizes the available subcommands:</para>
5332
5333	<glosslist>
5334	<glossentry>
5335	<glossterm><computeroutput>list</computeroutput></glossterm>
5336
5337	<glossdef>
5338	<para>This subcommand shows the parameters of the currently existing
5339	metrics. Note that VM-specific metrics are only available when a
5340	particular VM is running.</para>
5341	</glossdef>
5342	</glossentry>
5343
5344	<glossentry>
5345	<glossterm><computeroutput>setup</computeroutput></glossterm>
5346
5347	<glossdef>
5348	<para>This subcommand sets the interval between taking two samples
5349	of metric data and the number of samples retained internally. The
5350	retained data is available for displaying with the
5351	<code>query</code> subcommand. The <computeroutput>--list
5352	</computeroutput> option shows which metrics have been modified as
5353	the result of the command execution.</para>
5354	</glossdef>
5355	</glossentry>
5356
5357	<glossentry>
5358	<glossterm><computeroutput>enable</computeroutput></glossterm>
5359
5360	<glossdef>
5361	<para>This subcommand "resumes" data collection after it has been
5362	stopped with <code>disable</code> subcommand. Note that specifying
5363	submetrics as parameters will not enable underlying metrics. Use
5364	<computeroutput>--list</computeroutput> to find out if the command
5365	did what was expected.</para>
5366	</glossdef>
5367	</glossentry>
5368
5369	<glossentry>
5370	<glossterm><computeroutput>disable</computeroutput></glossterm>
5371
5372	<glossdef>
5373	<para>This subcommand "suspends" data collection without affecting
5374	collection parameters or collected data. Note that specifying
5375	submetrics as parameters will not disable underlying metrics. Use
5376	<computeroutput>--list</computeroutput> to find out if the command
5377	did what was expected.</para>
5378	</glossdef>
5379	</glossentry>
5380
5381	<glossentry>
5382	<glossterm><computeroutput>query</computeroutput></glossterm>
5383
5384	<glossdef>
5385	<para>This subcommand retrieves and displays the currently retained
5386	metric data.<note>
5387	<para>The <code>query</code> subcommand does not remove or
5388	"flush" retained data. If you query often enough you will see
5389	how old samples are gradually being "phased out" by new
5390	samples.</para>
5391	</note></para>
5392	</glossdef>
5393	</glossentry>
5394
5395	<glossentry>
5396	<glossterm><computeroutput>collect</computeroutput></glossterm>
5397
5398	<glossdef>
5399	<para>This subcommand sets the interval between taking two samples
5400	of metric data and the number of samples retained internally. The
5401	collected data is displayed periodically until Ctrl-C is pressed
5402	unless the <computeroutput>--detach</computeroutput> option is
5403	specified. With the <computeroutput>--detach</computeroutput>
5404	option, this subcommand operates the same way as <code>setup</code>
5405	does. The <computeroutput>--list</computeroutput> option shows which
5406	metrics match the specified filter.</para>
5407	</glossdef>
5408	</glossentry>
5409	</glosslist>
5410	</sect1>
5411
5412	<sect1 id="vboxmanage-natnetwork">
5413	<title>VBoxManage natnetwork</title>
5414
5415	<para>NAT networks use the Network Address Translation (NAT) service - which works in a
5416	similar way to a home router. It groups systems using it into a network and prevents
5417	outside systems from directly accessing those inside, while letting systems inside communicate
5418	with each other and outside systems using TCP and UDP over IPv4 and IPv6.</para>
5419
5420	<para>A NAT service is attached to an internal network. Virtual machines to make use of one
5421	should be attached to it. The name of an internal network is chosen when the NAT service is
5422	created, and the internal network will be created if it does not already exist.
5423	An example command to create a NAT network:</para>
5424
5425	<screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen>
5426
5427	<para>Here, "natnet1" is the name of the internal network to be used and "192.168.15.0/24" is the
5428	network address and mask of the NAT service interface. By default, in this static configuration
5429	- the gateway will be assigned the address 192.168.15.1 (the address after the interface address),
5430	though this is subject to change.</para>
5431
5432	<para>To add a DHCP server to the NAT network after creation:</para>
5433
5434	<screen>VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen>
5435
5436	<para>Below are the subcommands for <emphasis role="bold"><computeroutput>VBoxManage natnetwork </computeroutput></emphasis></para>
5437
5438	<screen>VBoxManage natnetwork add --netname <name>
5439	[--network <network>]
5440	[--enable\|--disable]
5441	[--dhcp on\|off]
5442	[--port-forward-4 <rule>]
5443	[--loopback-4 <rule>]
5444	[--ipv6 on\|off]
5445	[--port-forward-6 <rule>]
5446	[--loopback-6 <rule>]
5447	</screen>
5448
5449
5450	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork add</computeroutput></emphasis>
5451	Creates a new internal network interface, and adds a NAT network service. This command is a
5452	prerequisite for enabling attachment of VMs to the NAT network. Parameters:</para>
5453
5454	<para>
5455	<glosslist>
5456	<glossentry>
5457	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5458	<glossdef>
5459	<para>Where <name> is the name of the new internal network interface on the host OS. </para>
5460	</glossdef>
5461	</glossentry>
5462	<glossentry>
5463	<glossterm><computeroutput>--network <network></computeroutput></glossterm>
5464	<glossdef>
5465	<para>Where <network> specifies the static(default)/DHCP network address and mask of
5466	the NAT service interface.</para>
5467	</glossdef>
5468	</glossentry>
5469	<glossentry>
5470	<glossterm><computeroutput>--enable\|--disable</computeroutput></glossterm>
5471	<glossdef>
5472	<para>Enables/disables the NAT network service.</para>
5473	</glossdef>
5474	</glossentry>
5475	<glossentry>
5476	<glossterm><computeroutput>--dhcp on\|off</computeroutput></glossterm>
5477	<glossdef>
5478	<para>Enables/disables DHCP server specified by --netname; its use also indicates that it
5479	is a DHCP server.</para>
5480	</glossdef>
5481	</glossentry>
5482	<glossentry>
5483	<glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm>
5484	<glossdef>
5485	<para>Enables IPv4 port forwarding, rule specified by <rule>.</para>
5486	</glossdef>
5487	</glossentry>
5488	<glossentry>
5489	<glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm>
5490	<glossdef>
5491	<para>Enables IPv4 loopback interface, rule specified by <rule>.</para>
5492	</glossdef>
5493	</glossentry>
5494	<glossentry>
5495	<glossterm><computeroutput>--ipv6 on\|off</computeroutput></glossterm>
5496	<glossdef>
5497	<para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para>
5498	</glossdef>
5499	</glossentry>
5500	<glossentry>
5501	<glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm>
5502	<glossdef>
5503	<para>Enables IPv6 port forwarding, rule specified by <rule>.</para>
5504	</glossdef>
5505	</glossentry>
5506	<glossentry>
5507	<glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm>
5508	<glossdef>
5509	<para>Enables IPv6 loopback interface, rule specified by <rule>.</para>
5510	</glossdef>
5511	</glossentry>
5512	</glosslist>
5513	</para>
5514
5515	<screen>VBoxManage natnetwork remove --netname <name> </screen>
5516
5517	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork remove</computeroutput></emphasis>
5518	Removes a NAT network service, parameters:</para>
5519
5520	<para>
5521	<glosslist>
5522	<glossentry>
5523	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5524	<glossdef>
5525	<para>Where <name> specifies an existing NAT network service.
5526	Does not remove any DHCP server enabled on the network.</para>
5527	</glossdef>
5528	</glossentry>
5529	</glosslist>
5530	</para>
5531
5532	<screen>VBoxManage natnetwork modify --netname <name>
5533	[--network <network>]
5534	[--enable\|--disable]
5535	[--dhcp on\|off]
5536	[--port-forward-4 <rule>]
5537	[--loopback-4 <rule>]
5538	[--ipv6 on\|off]
5539	[--port-forward-6 <rule>]
5540	[--loopback-6 <rule>]
5541	</screen>
5542
5543	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork modify</computeroutput></emphasis>
5544	Modifies an existing NAT network service, parameters:</para>
5545
5546	<para>
5547	<glosslist>
5548	<glossentry>
5549	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5550	<glossdef>
5551	<para>Where <name> specifies an existing NAT network service.</para>
5552	</glossdef>
5553	</glossentry>
5554	<glossentry>
5555	<glossterm><computeroutput>--network <network></computeroutput></glossterm>
5556	<glossdef>
5557	<para>Where <network> specifies the new static(default)/DHCP network address and mask
5558	of the NAT service interface.</para>
5559	</glossdef>
5560	</glossentry>
5561	<glossentry>
5562	<glossterm><computeroutput>--enable\|--disable</computeroutput></glossterm>
5563	<glossdef>
5564	<para>Enables/disables the NAT network service.</para>
5565	</glossdef>
5566	</glossentry>
5567	<glossentry>
5568	<glossterm><computeroutput>--dhcp on\|off</computeroutput></glossterm>
5569	<glossdef>
5570	<para>Enables (and if absent, adds)/disables (if any) DHCP server.</para>
5571	</glossdef>
5572	</glossentry>
5573	<glossentry>
5574	<glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm>
5575	<glossdef>
5576	<para>Enables IPv4 port forwarding, rule specified by <rule>.</para>
5577	</glossdef>
5578	</glossentry>
5579	<glossentry>
5580	<glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm>
5581	<glossdef>
5582	<para>Enables IPv4 loopback interface, rule specified by <rule>.</para>
5583	</glossdef>
5584	</glossentry>
5585	<glossentry>
5586	<glossterm><computeroutput>--ipv6 on\|off</computeroutput></glossterm>
5587	<glossdef>
5588	<para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para>
5589	</glossdef>
5590	</glossentry>
5591	<glossentry>
5592	<glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm>
5593	<glossdef>
5594	<para>Enables IPv6 port forwarding, rule specified by <rule>.</para>
5595	</glossdef>
5596	</glossentry>
5597	<glossentry>
5598	<glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm>
5599	<glossdef>
5600	<para>Enables IPv6 loopback interface, rule specified by <rule>.</para>
5601	</glossdef>
5602	</glossentry>
5603	</glosslist>
5604	</para>
5605
5606	<screen>VBoxManage natnetwork start --netname <name>
5607	</screen>
5608
5609	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork start</computeroutput></emphasis>
5610	Starts specified NAT network service and any associated DHCP server, parameters:</para>
5611
5612	<para>
5613	<glosslist>
5614	<glossentry>
5615	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5616	<glossdef>
5617	<para>Where <name> specifies an existing NAT network service.</para>
5618	</glossdef>
5619	</glossentry>
5620	</glosslist>
5621	</para>
5622
5623	<screen>VBoxManage natnetwork stop --netname <name>
5624	</screen>
5625
5626	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork stop</computeroutput></emphasis>
5627	Stops specified NAT network service and any DHCP server, parameters:</para>
5628
5629	<para>
5630	<glosslist>
5631	<glossentry>
5632	<glossterm><computeroutput>--netname <name></computeroutput></glossterm>
5633	<glossdef>
5634	<para>Where <name> specifies an existing NAT network service.</para>
5635	</glossdef>
5636	</glossentry>
5637	</glosslist>
5638	</para>
5639
5640	<screen>VBoxManage natnetwork list [<pattern>] </screen>
5641
5642	<para><emphasis role="bold"><computeroutput>VBoxManage natnetwork list</computeroutput></emphasis>
5643	Lists all NAT network services with optional filtering, parameters:</para>
5644
5645	<para>
5646	<glosslist>
5647	<glossentry>
5648	<glossterm><computeroutput>[<pattern>]</computeroutput></glossterm>
5649	<glossdef>
5650	<para>Where <pattern> is optional filtering pattern.</para>
5651	</glossdef>
5652	</glossentry>
5653	</glosslist>
5654	</para>
5655	</sect1>
5656
5657	<sect1 id="vboxmanage-hostonlyif">
5658	<title>VBoxManage hostonlyif</title>
5659
5660	<para>With "hostonlyif" you can change the IP configuration of a host-only
5661	network interface. For a description of host-only networking, please
5662	refer to <xref linkend="network_hostonly" />. Each host-only interface is
5663	identified by a name and can either use the internal DHCP server or a
5664	manual IP configuration (both IP4 and IP6).</para>
5665
5666	<para>The following list summarizes the available subcommands:</para>
5667
5668	<glosslist>
5669	<glossentry>
5670	<glossterm><computeroutput>ipconfig "<name>"</computeroutput></glossterm>
5671	<glossdef>
5672	<para>Configure a hostonly interface</para>
5673	</glossdef>
5674	</glossentry>
5675	<glossentry>
5676	<glossterm><computeroutput>create</computeroutput></glossterm>
5677	<glossdef>
5678	<para>Creates a new vboxnet<N> interface on the host OS.
5679	This command is essential before you can attach VMs to host-only network.</para>
5680	</glossdef>
5681	</glossentry>
5682	<glossentry>
5683	<glossterm><computeroutput>remove vboxnet<N></computeroutput></glossterm>
5684	<glossdef>
5685	<para>Removes a vboxnet<N> interface from the host OS.</para>
5686	</glossdef>
5687	</glossentry>
5688	</glosslist>
5689
5690	</sect1>
5691
5692	<sect1 id="vboxmanage-dhcpserver">
5693	<title>VBoxManage dhcpserver</title>
5694
5695	<para>The "dhcpserver" commands allow you to control the DHCP server that
5696	is built into VirtualBox. You may find this useful when using internal or
5697	host-only networking. (Theoretically, you can enable it for a bridged
5698	network as well, but that will likely cause conflicts with other DHCP
5699	servers in your physical network.)</para>
5700
5701	<para>Use the following command line options:<itemizedlist>
5702	<listitem>
5703	<para>If you use internal networking for a virtual network adapter
5704	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
5705	--netname <network_name></computeroutput>, where
5706	<computeroutput><network_name></computeroutput> is the same
5707	network name you used with <computeroutput>VBoxManage modifyvm
5708	<vmname> --intnet<X>
5709	<network_name></computeroutput>.</para>
5710	</listitem>
5711
5712	<listitem>
5713	<para>If you use host-only networking for a virtual network adapter
5714	of a virtual machine, use <computeroutput>VBoxManage dhcpserver add
5715	--ifname <hostonly_if_name></computeroutput> instead, where
5716	<computeroutput><hostonly_if_name></computeroutput> is the
5717	same host-only interface name you used with
5718	<computeroutput>VBoxManage modifyvm <vmname>
5719	--hostonlyadapter<X>
5720	<hostonly_if_name></computeroutput>.</para>
5721
5722	<para>Alternatively, you can also use the
5723	<computeroutput>--netname</computeroutput> option as with
5724	internal networks if you know the host-only network's name; you can
5725	see the names with <computeroutput>VBoxManage list
5726	hostonlyifs</computeroutput> (see <xref linkend="vboxmanage-list" />
5727	above).</para>
5728	</listitem>
5729	</itemizedlist></para>
5730
5731	<para>The following additional parameters are required when first adding a
5732	DHCP server:<itemizedlist>
5733	<listitem>
5734	<para>With <computeroutput>--ip</computeroutput>, specify the IP
5735	address of the DHCP server itself.</para>
5736	</listitem>
5737
5738	<listitem>
5739	<para>With <computeroutput>--netmask</computeroutput>, specify the
5740	netmask of the network.</para>
5741	</listitem>
5742
5743	<listitem>
5744	<para>With <computeroutput>--lowerip</computeroutput> and
5745	<computeroutput>--upperip</computeroutput>, you can specify the
5746	lowest and highest IP address, respectively, that the DHCP server
5747	will hand out to clients.</para>
5748	</listitem>
5749	</itemizedlist></para>
5750
5751	<para>Finally, you must specify <computeroutput>--enable</computeroutput>
5752	or the DHCP server will be created in the disabled state, doing
5753	nothing.</para>
5754
5755	<para>After this, VirtualBox will automatically start the DHCP server for
5756	given internal or host-only network as soon as the first virtual machine
5757	which uses that network is started.</para>
5758
5759	<para>Reversely, use <computeroutput>VBoxManage dhcpserver
5760	remove</computeroutput> with the given <computeroutput>--netname
5761	<network_name></computeroutput> or <computeroutput>--ifname
5762	<hostonly_if_name></computeroutput> to remove the DHCP server again
5763	for the given internal or host-only network.</para>
5764
5765	<para>To modify the settings of a DHCP server created earlier with
5766	<computeroutput>VBoxManage dhcpserver add</computeroutput>, you can use
5767	<computeroutput>VBoxManage dhcpserver modify</computeroutput> for a given
5768	network or host-only interface name. This has the same parameters as
5769	<computeroutput>VBoxManage dhcpserver add</computeroutput>.</para>
5770	</sect1>
5771
5772	<sect1 id="vboxmanage-usbdevsource">
5773	<title>VBoxManage usbdevsource</title>
5774
5775	<para>The "usbdevsource" commands enables you to add and remove USB devices
5776	globally.</para>
5777
5778	<para>The following command adds a USB device.</para>
5779
5780	<screen>VBoxManage usbdevsource add <source name>
5781	--backend <backend>
5782	--address <address>
5783	</screen>
5784
5785	<para>Where the command line options are:<itemizedlist>
5786	<listitem>
5787	<para><source name> specifies the ID of the 'source' USB
5788	device to be added. Mandatory.</para>
5789	</listitem>
5790	<listitem>
5791	<para>--backend <backend> specifies the USB proxy service
5792	backend to use. Mandatory.</para>
5793	</listitem>
5794	<listitem>
5795	<para>--address <address> specifies the backend specific
5796	address. Mandatory.</para>
5797	</listitem>
5798	</itemizedlist></para>
5799
5800	<para>The following command removes a USB device.</para>
5801
5802	<screen>VBoxManage usbdevsource remove <source name>
5803	</screen>
5804
5805	<para>Where the command line options are:<itemizedlist>
5806	<listitem>
5807	<para><source name> specifies the ID of the 'source' USB
5808	device to be removed. Mandatory.</para>
5809	</listitem>
5810	</itemizedlist></para>
5811	</sect1>
5812
5813
5814	<xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
5815	<xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
5816	<xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
5817	</chapter>

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: