user_VBoxManage.xml@ 77888

Last change on this file since 77888 was 77883, checked in by vboxsync, 6 years ago
bugref:9404. Added two new commands for VBoxManage - one displays the list of cloud machine instances, second displays the list of cloud images. The generated documentation uses new style.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 299.5 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-2018 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.5//EN"
20	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
21	<!ENTITY % all.entities SYSTEM "all-entities.ent">
22	%all.entities;
23	]>
24	<chapter id="vboxmanage">
25
26	<title>VBoxManage</title>
27
28	<sect1 id="vboxmanage-intro">
29
30	<title>Introduction</title>
31
32	<para>
33	As briefly mentioned in <xref linkend="frontends" />,
34	<command>VBoxManage</command> is the command-line interface to
35	&product-name;. With it, you can completely control &product-name;
36	from the command line of your host operating system.
37	<command>VBoxManage</command> supports all the features that the
38	graphical user interface gives you access to, but it supports a
39	lot more than that. It exposes all the features of the
40	virtualization engine, even those that cannot be accessed from the
41	GUI.
42	</para>
43
44	<para>
45	You will need to use the command line if you want to do the
46	following:
47	</para>
48
49	<itemizedlist>
50
51	<listitem>
52	<para>
53	Use a different user interface than the main GUI such as the
54	VBoxHeadless server.
55	</para>
56	</listitem>
57
58	<listitem>
59	<para>
60	Control some of the more advanced and experimental
61	configuration settings for a VM.
62	</para>
63	</listitem>
64
65	</itemizedlist>
66
67	<para>
68	There are two main things to keep in mind when using
69	<command>VBoxManage</command>. First,
70	<command>VBoxManage</command> must always be used with a specific
71	subcommand, such as <command>list</command> or
72	<command>createvm</command> or <command>startvm</command>. All the
73	subcommands that <command>VBoxManage</command> supports are
74	described in detail in <xref linkend="vboxmanage" />.
75	</para>
76
77	<para>
78	Second, most of these subcommands require that you specify a
79	particular virtual machine after the subcommand. There are two
80	ways you can do this:
81	</para>
82
83	<itemizedlist>
84
85	<listitem>
86	<para>
87	You can specify the VM name, as it is shown in the
88	&product-name; GUI. Note that if that name contains spaces,
89	then you must enclose the entire name in double quotes. This
90	is always required with command line arguments that contain
91	spaces. For example:
92	</para>
93
94	<screen>VBoxManage startvm "Windows XP"</screen>
95	</listitem>
96
97	<listitem>
98	<para>
99	You can specify the UUID, which is the internal unique
100	identifier that &product-name; uses to refer to the virtual
101	machine. Assuming that the VM called "Windows XP" has the UUID
102	shown below, the following command has the same effect as the
103	previous example:
104	</para>
105
106	<screen>VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5</screen>
107	</listitem>
108
109	</itemizedlist>
110
111	<para>
112	You can enter <command>VBoxManage list vms</command> to have all
113	currently registered VMs listed with all their settings, including
114	their respective names and UUIDs.
115	</para>
116
117	<para>
118	Some typical examples of how to control &product-name; from the
119	command line are listed below:
120	</para>
121
122	<itemizedlist>
123
124	<listitem>
125	<para>
126	To create a new virtual machine from the command line and
127	immediately register it with &product-name;, use
128	<command>VBoxManage createvm</command> with the
129	<option>--register</option> option, as follows:
130	</para>
131
132	<screen>$ VBoxManage createvm --name "SUSE 10.2" --register
133	VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
134	(C) 2005-2018 Oracle Corporation
135	All rights reserved.
136
137	Virtual machine 'SUSE 10.2' is created.
138	UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5
139	Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml'</screen>
140
141	<para>
142	As can be seen from the above output, a new virtual machine
143	has been created with a new UUID and a new XML settings file.
144	</para>
145
146	<para>
147	For more details, see
148	<xref
149	linkend="vboxmanage-createvm" />.
150	</para>
151	</listitem>
152
153	<listitem>
154	<para>
155	To show the configuration of a particular VM, use
156	<command>VBoxManage showvminfo</command>. See
157	<xref
158	linkend="vboxmanage-showvminfo" /> for details
159	and an example.
160	</para>
161	</listitem>
162
163	<listitem>
164	<para>
165	To change settings while a VM is powered off, use
166	<command>VBoxManage modifyvm</command>. For example:
167	</para>
168
169	<screen>VBoxManage modifyvm "Windows XP" --memory 512</screen>
170
171	<para>
172	See also <xref linkend="vboxmanage-modifyvm" />.
173	</para>
174	</listitem>
175
176	<listitem>
177	<para>
178	To change the storage configuration, such as to add a storage
179	controller and then a virtual disk, use <command>VBoxManage
180	storagectl</command> and <command>VBoxManage
181	storageattach</command>. See
182	<xref
183	linkend="vboxmanage-storagectl" /> and
184	<xref
185	linkend="vboxmanage-storageattach" />.
186	</para>
187	</listitem>
188
189	<listitem>
190	<para>
191	To control VM operation, use one of the following:
192	</para>
193
194	<itemizedlist>
195
196	<listitem>
197	<para>
198	To start a VM that is currently powered off, use
199	<command>VBoxManage startvm</command>. See
200	<xref
201	linkend="vboxmanage-startvm" />.
202	</para>
203	</listitem>
204
205	<listitem>
206	<para>
207	To pause or save a VM that is currently running or change
208	some of its settings, use <command>VBoxManage
209	controlvm</command>. See
210	<xref
211	linkend="vboxmanage-controlvm" />.
212	</para>
213	</listitem>
214
215	</itemizedlist>
216	</listitem>
217
218	</itemizedlist>
219
220	</sect1>
221
222	<sect1 id="vboxmanage-cmd-overview">
223
224	<title>Commands Overview</title>
225
226	<para>
227	When running <command>VBoxManage</command> without parameters or
228	when supplying an invalid command line, the following command
229	syntax list is shown. Note that the output will be slightly
230	different depending on the host platform. If in doubt, check the
231	output of <command>VBoxManage</command> for the commands available
232	on your particular host.
233	</para>
234
235	<xi:include href="user_VBoxManage_CommandsOverview.xml" xpointer="xpointer(/sect1/*)"
236	xmlns:xi="http://www.w3.org/2001/XInclude" />
237
238	<para>
239	Each time <command>VBoxManage</command> is invoked, only one
240	command can be executed. However, a command might support several
241	subcommands which then can be invoked in one single call. The
242	following sections provide detailed reference information on the
243	different commands.
244	</para>
245
246	</sect1>
247
248	<sect1 id="vboxmanage-general">
249
250	<title>General Options</title>
251
252	<itemizedlist>
253
254	<listitem>
255	<para>
256	<computeroutput>-v\|--version</computeroutput>: Show the
257	version of this tool and exit.
258	</para>
259	</listitem>
260
261	<listitem>
262	<para>
263	<computeroutput>--nologo</computeroutput>: Suppress the output
264	of the logo information. This option is useful for scripts.
265	</para>
266	</listitem>
267
268	<listitem>
269	<para>
270	<computeroutput>--settingspw</computeroutput>: Specifiy a
271	settings password.
272	</para>
273	</listitem>
274
275	<listitem>
276	<para>
277	<computeroutput>--settingspwfile</computeroutput>: Specify a
278	file containing the settings password.
279	</para>
280	</listitem>
281
282	</itemizedlist>
283
284	<para>
285	The settings password is used for certain settings which need to
286	be stored in encrypted form for security reasons. At the moment,
287	the only encrypted setting is the iSCSI initiator secret, see
288	<xref linkend="vboxmanage-storageattach" />. As long as no
289	settings password is specified, this information is stored in
290	<emphasis>plain text</emphasis>. After using the
291	<computeroutput>--settingspw\|--settingspwfile</computeroutput>
292	option once, it must be always used. Otherwise, the encrypted
293	setting cannot be unencrypted.
294	</para>
295
296	</sect1>
297
298	<sect1 id="vboxmanage-list">
299
300	<title>VBoxManage list</title>
301
302	<para>
303	The <command>list</command> command gives relevant information
304	about your system and information about &product-name;'s current
305	settings.
306	</para>
307
308	<para>
309	The following subcommands are available with <command>VBoxManage
310	list</command>:
311	</para>
312
313	<itemizedlist>
314
315	<listitem>
316	<para>
317	<command>vms</command>: Lists all virtual machines currently
318	registered with &product-name;. By default this displays a
319	compact list with each VM's name and UUID. If you also specify
320	<computeroutput>--long</computeroutput> or
321	<computeroutput>-l</computeroutput>, this will be a detailed
322	list as with the <command>showvminfo</command> command, see
323	<xref linkend="vboxmanage-showvminfo"/>.
324	</para>
325	</listitem>
326
327	<listitem>
328	<para>
329	<command>runningvms</command>: Lists all currently running
330	virtual machines by their unique identifiers (UUIDs) in the
331	same format as with <command>vms</command>.
332	</para>
333	</listitem>
334
335	<listitem>
336	<para>
337	<command>ostypes</command>: Lists all guest operating systems
338	presently known to &product-name;, along with the identifiers
339	used to refer to them with the <command>modifyvm</command>
340	command.
341	</para>
342	</listitem>
343
344	<listitem>
345	<para>
346	<command>hostdvds</command>, <command>hostfloppies</command>:
347	Lists the DVD, floppy, bridged networking, and host-only
348	networking interfaces on the host, along with the name used to
349	access them from within &product-name;.
350	</para>
351	</listitem>
352
353	<listitem>
354	<para>
355	<command>intnets</command>: Displays information about the
356	internal networks.
357	</para>
358	</listitem>
359
360	<listitem>
361	<para>
362	<command>bridgedifs</command>, <command>hostonlyifs</command>,
363	<command>natnets</command>, <command>dhcpservers</command>:
364	Lists the bridged network interfaces, host-only network
365	interfaces, NAT network interfaces, and DHCP servers currently
366	available on the host. See
367	<xref linkend="networkingdetails" />.
368	</para>
369	</listitem>
370
371	<listitem>
372	<para>
373	<command>hostinfo</command>: Displays information about the
374	host system, such as CPUs, memory size, and operating system
375	version.
376	</para>
377	</listitem>
378
379	<listitem>
380	<para>
381	<command>hostcpuids</command>: Lists the CPUID parameters for
382	the host CPUs. This can be used for a more fine grained
383	analyis of the host's virtualization capabilities.
384	</para>
385	</listitem>
386
387	<listitem>
388	<para>
389	<command>hddbackends</command>: Lists all known virtual disk
390	back-ends of &product-name;. For each such format, such as
391	VDI, VMDK, or RAW, this subcommand lists the back-end's
392	capabilities and configuration.
393	</para>
394	</listitem>
395
396	<listitem>
397	<para>
398	<command>hdds</command>, <command>dvds</command>,
399	<command>floppies</command>: Shows information about virtual
400	disk images currently in use by &product-name;, including all
401	their settings, the unique identifiers (UUIDs) associated with
402	them by &product-name; and all files associated with them.
403	This is the command-line equivalent of the Virtual Media
404	Manager. See <xref linkend="vdis" />.
405	</para>
406	</listitem>
407
408	<listitem>
409	<para>
410	<command>usbhost</command>: Shows information about USB
411	devices attached to the host, including information useful for
412	constructing USB filters and whether they are currently in use
413	by the host.
414	</para>
415	</listitem>
416
417	<listitem>
418	<para>
419	<command>usbfilters</command>: Lists all global USB filters
420	registered with &product-name; and displays the filter
421	parameters. Global USB filters are for devices which are
422	accessible to all virtual machines.
423	</para>
424	</listitem>
425
426	<listitem>
427	<para>
428	<command>systemproperties</command>: Displays some global
429	&product-name; settings, such as minimum and maximum guest RAM
430	and virtual hard disk size, folder settings and the current
431	authentication library in use.
432	</para>
433	</listitem>
434
435	<listitem>
436	<para>
437	<command>extpacks</command>: Displays all &product-name;
438	extension packs that are currently installed. See
439	<xref linkend="intro-installing" /> and
440	<xref linkend="vboxmanage-extpack" />.
441	</para>
442	</listitem>
443
444	<listitem>
445	<para>
446	<command>groups</command>: Displays details of the VM Groups.
447	See <xref linkend="gui-vmgroups" />.
448	</para>
449	</listitem>
450
451	<listitem>
452	<para>
453	<command>webcams</command>: Displays a list of webcams
454	attached to the running VM. The output format is a list of
455	absolute paths or aliases that were used for attaching the
456	webcams to the VM using the webcam attach command.
457	</para>
458	</listitem>
459
460	<listitem>
461	<para>
462	<command>screenshotformats</command>: Displays a list of
463	available screenshot formats.
464	</para>
465	</listitem>
466
467	<listitem>
468	<para>
469	<command>cloudproviders</command>: Displays a list of cloud
470	providers that are supported by &product-name;. &oci; is an
471	example of a cloud provider.
472	</para>
473	</listitem>
474
475	<listitem>
476	<para>
477	<command>cloudprofiles</command>: Displays a list of cloud
478	profiles that have been configured.
479	</para>
480
481	<para>
482	Cloud profiles are used when exporting VMs to a cloud service.
483	See <xref linkend="ovf-export-oci"/>.
484	</para>
485	</listitem>
486
487	</itemizedlist>
488
489	</sect1>
490
491	<sect1 id="vboxmanage-showvminfo">
492
493	<title>VBoxManage showvminfo</title>
494
495	<para>
496	The <command>showvminfo</command> command shows information about
497	a particular virtual machine. This is the same information as
498	<command>VBoxManage list vms --long</command> would show for all
499	virtual machines.
500	</para>
501
502	<para>
503	You will see information as shown in the following example.
504	</para>
505
506	<screen>$ VBoxManage showvminfo "Windows XP"
507	VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
508	(C) 2005-2018 Oracle Corporation
509	All rights reserved.
510
511	Name: Windows XP
512	Guest OS: Other/Unknown
513	UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7
514	Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml
515	Memory size: 512MB
516	VRAM size: 12MB
517	Number of CPUs: 2
518	Boot menu mode: message and menu
519	Boot Device (1): DVD
520	Boot Device (2): HardDisk
521	Boot Device (3): Not Assigned
522	Boot Device (4): Not Assigned
523	ACPI: on
524	IOAPIC: on
525	...
526	</screen>
527
528	<para>
529	Use the <computeroutput>--machinereadable</computeroutput> option
530	to produce the same output, but in machine readable format with a
531	property=value string on each line. For example:
532	</para>
533
534	<screen>
535	...
536	groups="/"
537	ostype="Oracle (64-bit)"
538	UUID="457af700-bc0a-4258-aa3c-13b03da171f2"
539	...
540	</screen>
541
542	</sect1>
543
544	<sect1 id="vboxmanage-registervm">
545
546	<title>VBoxManage registervm/unregistervm</title>
547
548	<para>
549	The <computeroutput>registervm</computeroutput> command enables
550	you to import a virtual machine definition in an XML file into
551	&product-name;. The machine must not conflict with one already
552	registered in &product-name; and it may not have any hard or
553	removable disks attached. It is advisable to place the definition
554	file in the machines folder before registering it.
555	</para>
556
557	<note>
558	<para>
559	When creating a new virtual machine with <command>VBoxManage
560	createvm</command>, as shown in
561	<xref linkend="vboxmanage-createvm"/>, you can directly specify
562	the <option>--register</option> option to avoid having to
563	register it separately.
564	</para>
565	</note>
566
567	<para>
568	The <command>unregistervm</command> command unregisters a virtual
569	machine. If <option>--delete</option> is also specified, the
570	following files will also be deleted automatically:
571	</para>
572
573	<itemizedlist>
574
575	<listitem>
576	<para>
577	All hard disk image files, including differencing files, which
578	are used by the machine and not shared with other machines.
579	</para>
580	</listitem>
581
582	<listitem>
583	<para>
584	Saved state files that the machine created. One if the machine
585	was in Saved state and one for each online snapshot.
586	</para>
587	</listitem>
588
589	<listitem>
590	<para>
591	The machine XML file and its backups.
592	</para>
593	</listitem>
594
595	<listitem>
596	<para>
597	The machine log files.
598	</para>
599	</listitem>
600
601	<listitem>
602	<para>
603	The machine directory, if it is empty after having deleted all
604	of the above files.
605	</para>
606	</listitem>
607
608	</itemizedlist>
609
610	</sect1>
611
612	<sect1 id="vboxmanage-createvm">
613
614	<title>VBoxManage createvm</title>
615
616	<para>
617	The <command>VBoxManage createvm</command> command creates a new
618	XML virtual machine definition file.
619	</para>
620
621	<para>
622	You must specify the name of the VM by using <option>--name
623	<replaceable>name</replaceable></option>. This name is used by
624	default as the file name of the settings file that has the
625	<computeroutput>.xml</computeroutput> extension and the machine
626	folder, which is a subfolder of the
627	<computeroutput>.config/VirtualBox/Machines</computeroutput>
628	folder. Note that the machine folder path name varies based on the
629	OS type and the &product-name; version.
630	</para>
631
632	<para>
633	Ensure that the VM name conforms to the host OS's file name
634	requirements. If you later rename the VM, the file and folder
635	names will be updated to match the new name automatically.
636	</para>
637
638	<para>
639	The <option>--basefolder <replaceable>path</replaceable></option>
640	option specifies the machine folder path name. Note that the names
641	of the file and the folder do not change if you rename the VM.
642	</para>
643
644	<para>
645	The <option>--group <replaceable>group-ID</replaceable>,
646	...</option> option assigns the VM to the specified groups. Note
647	that group IDs always start with
648	<computeroutput>/</computeroutput> so that they can be nested. By
649	default, each VM is assigned membership to the
650	<computeroutput>/</computeroutput> group.
651	</para>
652
653	<para>
654	The <option>--ostype <replaceable>ostype</replaceable></option>
655	option specifies the guest OS to run in the VM. Run the
656	<command>VBoxManage list ostypes</command> command to see the
657	available OS types.
658	</para>
659
660	<para>
661	The <option>--uuid <replaceable>uuid</replaceable></option> option
662	specifies the universal unique identifier (UUID) of the VM. The
663	UUID must be unique within the namespace of the host or of its VM
664	group memberships. By default, the <command>VBoxManage</command>
665	command automatically generates the UUID.
666	</para>
667
668	<para>
669	The <computeroutput>--default</computeroutput> option applies a
670	default hardware configuration for the specified guest OS. By
671	default, the VM is created with minimal hardware.
672	</para>
673
674	<para>
675	The <option>--register</option> option registers the VM with your
676	&product-name; installation. By default, the <command>VBoxManage
677	createvm</command> command creates only the XML configuration for
678	the VM but does not registered the VM. If you do not register the
679	VM at creation, you can run the <command>VBoxManage
680	registervm</command> command after you create the VM.
681	</para>
682
683	</sect1>
684
685	<sect1 id="vboxmanage-modifyvm">
686
687	<title>VBoxManage modifyvm</title>
688
689	<para>
690	This command changes the properties of a registered virtual
691	machine which is not running. Most of the properties that this
692	command makes available correspond to the VM settings that
693	&product-name; graphical user interface displays in each VM's
694	<emphasis role="bold">Settings</emphasis> dialog. These are
695	described in <xref linkend="BasicConcepts" />. However, some of
696	the more advanced settings are only available through the
697	<command>VBoxManage</command> interface.
698	</para>
699
700	<para>
701	These commands require that the machine is powered off, neither
702	running nor in a Saved state. Some machine settings can also be
703	changed while a machine is running. Those settings will then have
704	a corresponding subcommand with the <command>VBoxManage
705	controlvm</command> subcommand. See
706	<xref linkend="vboxmanage-controlvm" />.
707	</para>
708
709	<sect2 id="vboxmanage-modifyvm-general">
710
711	<title>General Settings</title>
712
713	<para>
714	The following general settings are available through
715	<command>VBoxManage modifyvm</command>:
716	</para>
717
718	<itemizedlist>
719
720	<listitem>
721	<para>
722	<computeroutput>--name <name></computeroutput>:
723	Changes the VM's name and can be used to rename the internal
724	virtual machine files, as described in
725	<xref linkend="vboxmanage-createvm"/>.
726	</para>
727	</listitem>
728
729	<listitem>
730	<para>
731	<computeroutput>--groups <group>,
732	...</computeroutput>: Changes the group membership of a VM.
733	Groups always start with a
734	<computeroutput>/</computeroutput> and can be nested. By
735	default VMs are in group <computeroutput>/</computeroutput>.
736	</para>
737	</listitem>
738
739	<listitem>
740	<para>
741	<computeroutput>--description <desc></computeroutput>:
742	Changes the VM's description, which is a way to record
743	details about the VM in a way which is meaningful for the
744	user. The GUI interprets HTML formatting, the command line
745	allows arbitrary strings potentially containing multiple
746	lines.
747	</para>
748	</listitem>
749
750	<listitem>
751	<para>
752	<computeroutput>--ostype <ostype></computeroutput>:
753	Specifies what guest operating system is supposed to run in
754	the VM. To learn about the various identifiers that can be
755	used here, use <command>VBoxManage list ostypes</command>.
756	</para>
757	</listitem>
758
759	<listitem>
760	<para>
761	<computeroutput>--iconfile
762	<filename></computeroutput>: Specifies the absolute
763	path on the host file system for the &product-name; icon to
764	be displayed in the VM.
765	</para>
766	</listitem>
767
768	<listitem>
769	<para>
770	<computeroutput>--memory
771	<memorysize></computeroutput>: Sets the amount of RAM,
772	in MB, that the virtual machine should allocate for itself
773	from the host. See <xref linkend="gui-createvm" />.
774	</para>
775	</listitem>
776
777	<listitem>
778	<para>
779	<computeroutput>--pagefusion on\|off</computeroutput>:
780	Enables and disables the Page Fusion feature. Page Fusion is
781	disabled by default. The Page Fusion feature minimises
782	memory duplication between VMs with similar configurations
783	running on the same host. See
784	<xref linkend="guestadd-pagefusion" />.
785	</para>
786	</listitem>
787
788	<listitem>
789	<para>
790	<computeroutput>--vram <vramsize></computeroutput>:
791	Sets the amount of RAM that the virtual graphics card should
792	have. See <xref linkend="settings-display" />.
793	</para>
794	</listitem>
795
796	<listitem>
797	<para>
798	<computeroutput>--acpi on\|off</computeroutput> and
799	<computeroutput>--ioapic on\|off</computeroutput>: Determines
800	whether the VM has ACPI and I/O APIC support. See
801	<xref linkend="settings-motherboard" />.
802	</para>
803	</listitem>
804
805	<listitem>
806	<para>
807	<computeroutput>--pciattach <host PCI address [@ guest
808	PCI bus address]></computeroutput>: Attaches a specified
809	PCI network controller on the host to a specified PCI bus on
810	the guest. See <xref linkend="pcipassthrough" />.
811	</para>
812	</listitem>
813
814	<listitem>
815	<para>
816	<computeroutput>--pcidetach <host PCI
817	address></computeroutput>: Detaches a specified PCI
818	network controller on the host from the attached PCI bus on
819	the guest. See <xref linkend="pcipassthrough" />.
820	</para>
821	</listitem>
822
823	<listitem>
824	<para>
825	<computeroutput>--hardwareuuid
826	<uuid></computeroutput>: The UUID presented to the
827	guest through memory tables (DMI/SMBIOS), hardware, and
828	guest properties. By default this is the same as the VM
829	UUID. This setting is useful when cloning a VM. Teleporting
830	takes care of this automatically.
831	</para>
832	</listitem>
833
834	<listitem>
835	<para>
836	<computeroutput>--cpus <cpucount></computeroutput>:
837	Sets the number of virtual CPUs for the virtual machine, see
838	<xref linkend="settings-processor" />. If CPU hot-plugging
839	is enabled, this then sets the <emphasis>maximum</emphasis>
840	number of virtual CPUs that can be plugged into the virtual
841	machines.
842	</para>
843	</listitem>
844
845	<listitem>
846	<para>
847	<computeroutput>--cpuhotplug on\|off</computeroutput>:
848	Enables CPU hot-plugging. When enabled, virtual CPUs can be
849	added to and removed from a virtual machine while it is
850	running. See <xref linkend="cpuhotplug" />.
851	</para>
852	</listitem>
853
854	<listitem>
855	<para>
856	<computeroutput>--plugcpu\|unplugcpu
857	<id></computeroutput>: If CPU hot-plugging is enabled,
858	this setting adds or removes a virtual CPU on the virtual
859	machine. <computeroutput><id></computeroutput>
860	specifies the index of the virtual CPU to be added or
861	removed and must be a number from 0 to the maximum number of
862	CPUs configured with the
863	<computeroutput>--cpus</computeroutput> option. CPU 0 can
864	never be removed.
865	</para>
866	</listitem>
867
868	<listitem>
869	<para>
870	<computeroutput>--cpuexecutioncap
871	<1-100></computeroutput>: Controls how much CPU time a
872	virtual CPU can use. A value of 50 implies a single virtual
873	CPU can use up to 50% of a single host CPU.
874	</para>
875	</listitem>
876
877	<listitem>
878	<para>
879	<computeroutput>--pae on\|off</computeroutput>: Enables and
880	disables PAE. See <xref linkend="settings-processor" />.
881	</para>
882	</listitem>
883
884	<listitem>
885	<para>
886	<computeroutput>--longmode on\|off</computeroutput>: Enables
887	and disables long mode. See
888	<xref linkend="settings-processor" />.
889	</para>
890	</listitem>
891
892	<listitem>
893	<para>
894	<computeroutput>--spec-ctrl on\|off</computeroutput>: Enables
895	and disables the exposure of speculation control interfaces
896	to the guest, provided they are available on the host.
897	Depending on the host CPU and workload, enabling speculation
898	control may significantly reduce performance.
899	</para>
900	</listitem>
901
902	<listitem>
903	<para>
904	<computeroutput>--cpu-profile <host\|intel
905	80[86\|286\|386]></computeroutput>: Enables specification
906	of a profile for guest CPU emulation. Specify either one
907	based on the host system CPU (host), or one from a number of
908	older Intel Micro-architectures: 8086, 80286, 80386.
909	</para>
910	</listitem>
911
912	<listitem>
913	<para>
914	<computeroutput>--hpet on\|off</computeroutput>: Enables and
915	disables a High Precision Event Timer (HPET) which can
916	replace the legacy system timers. This is turned off by
917	default. Note that Windows supports a HPET only from Vista
918	onwards.
919	</para>
920	</listitem>
921
922	<listitem>
923	<para>
924	<computeroutput>--hwvirtex on\|off</computeroutput>: Enables
925	and disables the use of hardware virtualization extensions,
926	such as Intel VT-x or AMD-V, in the processor of your host
927	system. See <xref linkend="hwvirt" />.
928	</para>
929	</listitem>
930
931	<listitem>
932	<para>
933	<computeroutput>--triplefaultreset on\|off</computeroutput>:
934	Enables resetting of the guest instead of triggering a Guru
935	Meditation. Some guests raise a triple fault to reset the
936	CPU so sometimes this is desired behavior. Works only for
937	non-SMP guests.
938	</para>
939	</listitem>
940
941	<listitem>
942	<para>
943	<computeroutput>--apic on\|off</computeroutput>: Enables and
944	disables I/O APIC. With I/O APIC, operating systems can use
945	more than 16 interrupt requests (IRQs) thus avoiding IRQ
946	sharing for improved reliability. This setting is enabled by
947	default. See <xref linkend="settings-motherboard" />.
948	</para>
949	</listitem>
950
951	<listitem>
952	<para>
953	<computeroutput>--x2apic on\|off</computeroutput>: Enables
954	and disables CPU x2APIC support. CPU x2APIC support helps
955	operating systems run more efficiently on high core count
956	configurations, and optimizes interrupt distribution in
957	virtualized environments. This setting is enabled by
958	default. Disable this setting when using host or guest
959	operating systems that are incompatible with x2APIC support.
960	</para>
961	</listitem>
962
963	<listitem>
964	<para>
965	<computeroutput>--paravirtprovider
966	none\|default\|legacy\|minimal\|hyperv\|kvm</computeroutput>:
967	Specifies which paravirtualization interface to provide to
968	the guest operating system. Specifying
969	<computeroutput>none</computeroutput> explicitly turns off
970	exposing any paravirtualization interface. The option
971	<computeroutput>default</computeroutput> selects an
972	appropriate interface when starting the VM, depending on the
973	guest OS type. This is the default option chosen when
974	creating new VMs. The
975	<computeroutput>legacy</computeroutput> option is used for
976	VMs which were created with older &product-name; versions
977	and will pick a paravirtualization interface when starting
978	the VM with &product-name; 5.0 and newer. The
979	<computeroutput>minimal</computeroutput> provider is
980	mandatory for Mac OS X guests.
981	<computeroutput>kvm</computeroutput> and
982	<computeroutput>hyperv</computeroutput> are recommended for
983	Linux and Windows guests respectively. These options are
984	explained in <xref linkend="gimproviders" />.
985	</para>
986	</listitem>
987
988	<listitem>
989	<para>
990	<computeroutput>--paravirtdebug <keyword=value>
991	[,<keyword=value> ...]</computeroutput>: Specifies
992	debugging options specific to the paravirtualization
993	provider configured for this VM. See the provider specific
994	options in <xref linkend="gimdebug" /> for a list of
995	supported keyword-value pairs for each provider.
996	</para>
997	</listitem>
998
999	<listitem>
1000	<para>
1001	<computeroutput>--nestedpaging on\|off</computeroutput>: If
1002	hardware virtualization is enabled, this additional setting
1003	enables or disables the use of the nested paging feature in
1004	the processor of your host system. See
1005	<xref linkend="hwvirt" /> and
1006	<xref linkend="sec-rec-cve-2018-3646" />.
1007	</para>
1008	</listitem>
1009
1010	<listitem>
1011	<para>
1012	<computeroutput>--largepages on\|off</computeroutput>: If
1013	hardware virtualization <emphasis>and</emphasis> nested
1014	paging are enabled, for Intel VT-x only, an additional
1015	performance improvement of up to 5% can be obtained by
1016	enabling this setting. This causes the hypervisor to use
1017	large pages to reduce TLB use and overhead.
1018	</para>
1019	</listitem>
1020
1021	<listitem>
1022	<para>
1023	<computeroutput>--vtxvpid on\|off</computeroutput>: If
1024	hardware virtualization is enabled, for Intel VT-x only,
1025	this additional setting enables or disables the use of the
1026	tagged TLB (VPID) feature in the processor of your host
1027	system. See <xref linkend="hwvirt" />.
1028	</para>
1029	</listitem>
1030
1031	<listitem>
1032	<para>
1033	<computeroutput>--vtxux on\|off</computeroutput>: If hardware
1034	virtualization is enabled, for Intel VT-x only, this setting
1035	enables or disables the use of the unrestricted guest mode
1036	feature for executing your guest.
1037	</para>
1038	</listitem>
1039
1040	<listitem>
1041	<para>
1042	<computeroutput>--accelerate3d on\|off</computeroutput>: If
1043	the Guest Additions are installed, this setting enables or
1044	disables hardware 3D acceleration. See
1045	<xref linkend="guestadd-3d" />.
1046	</para>
1047	</listitem>
1048
1049	<listitem>
1050	<para>
1051	<computeroutput>--accelerate2dvideo on\|off</computeroutput>:
1052	If the Guest Additions are installed, this setting enables
1053	or disables 2D video acceleration. See
1054	<xref linkend="guestadd-2d" />.
1055	</para>
1056	</listitem>
1057
1058	<listitem>
1059	<para>
1060	<computeroutput>--chipset piix3\|ich9</computeroutput>: By
1061	default, &product-name; emulates an Intel PIIX3 chipset.
1062	Usually there is no reason to change the default setting
1063	unless this is required to relax some of its constraints.
1064	See <xref linkend="settings-motherboard" />.
1065	</para>
1066	</listitem>
1067
1068	<listitem>
1069	<para>
1070	You can influence the BIOS logo that is displayed when a
1071	virtual machine starts up with a number of settings. By
1072	default, an &product-name; logo is displayed.
1073	</para>
1074
1075	<para>
1076	With <computeroutput>--bioslogofadein
1077	on\|off</computeroutput> and
1078	<computeroutput>--bioslogofadeout on\|off</computeroutput>,
1079	you can determine whether the logo should fade in and out,
1080	respectively.
1081	</para>
1082
1083	<para>
1084	With <computeroutput>--bioslogodisplaytime
1085	<msec></computeroutput> you can set how long the logo
1086	should be visible, in milliseconds.
1087	</para>
1088
1089	<para>
1090	With <computeroutput>--bioslogoimagepath
1091	<imagepath></computeroutput> you can replace the image
1092	that is shown with your own logo. The image must be an
1093	uncompressed 256 color BMP file without color space
1094	information (Windows 3.0 format). The image must not be
1095	bigger than 640 x 480.
1096	</para>
1097	</listitem>
1098
1099	<listitem>
1100	<para>
1101	<computeroutput>--biosbootmenu
1102	disabled\|menuonly\|messageandmenu</computeroutput>: Specifies
1103	whether the BIOS enables the user to select a temporary boot
1104	device. The <computeroutput>menuonly</computeroutput> option
1105	suppresses the message, but the user can still press F12 to
1106	select a temporary boot device.
1107	</para>
1108	</listitem>
1109
1110	<listitem>
1111	<para>
1112	<computeroutput>--biosapic
1113	x2apic\|apic\|disabled</computeroutput>: Specifies the
1114	firmware APIC level to be used. Options are: x2apic, apic or
1115	disabled (no apic or x2apic) respectively.
1116	</para>
1117
1118	<para>
1119	Note that if x2apic is specified and x2APIC is unsupported
1120	by the VCPU, biosapic downgrades to apic, if supported.
1121	Otherwise biosapic downgrades to disabled. Similarly, if
1122	apic is specified, and APIC is unsupported, a downgrade to
1123	disabled results.
1124	</para>
1125	</listitem>
1126
1127	<listitem>
1128	<para>
1129	<computeroutput>--biossystemtimeoffset
1130	<ms></computeroutput>: Specifies a fixed time offset,
1131	in milliseconds, of the guest relative to the host time. If
1132	the offset is positive, the guest time runs ahead of the
1133	host time.
1134	</para>
1135	</listitem>
1136
1137	<listitem>
1138	<para>
1139	<computeroutput>--biospxedebug on\|off</computeroutput>:
1140	Enables additional debugging output when using the Intel PXE
1141	boot ROM. The output is written to the release log file. See
1142	<xref linkend="collect-debug-info" />.
1143	</para>
1144	</listitem>
1145
1146	<listitem>
1147	<para>
1148	<computeroutput>--boot<1-4>
1149	none\|floppy\|dvd\|disk\|net</computeroutput>: Specifies the
1150	boot order for the virtual machine. There are four
1151	<emphasis>slots</emphasis>, which the VM will try to access
1152	from 1 to 4, and for each of which you can set a device that
1153	the VM should attempt to boot from.
1154	</para>
1155	</listitem>
1156
1157	<listitem>
1158	<para>
1159	<computeroutput>--rtcuseutc on\|off</computeroutput>: Sets
1160	the real-time clock (RTC) to operate in UTC time. See
1161	<xref linkend="settings-motherboard" />.
1162	</para>
1163	</listitem>
1164
1165	<listitem>
1166	<para>
1167	<computeroutput>--graphicscontroller
1168	none\|vboxvga\|vmsvga\|vboxsvga</computeroutput>: Specifies the
1169	use of a graphics controller, with an option to choose a
1170	specific type. See <xref linkend="settings-screen" />.
1171	</para>
1172	</listitem>
1173
1174	<listitem>
1175	<para>
1176	<computeroutput>--snapshotfolder
1177	default\|<path></computeroutput>: Specifies the folder
1178	where snapshots are kept for a virtual machine.
1179	</para>
1180	</listitem>
1181
1182	<listitem>
1183	<para>
1184	<computeroutput>--firmware
1185	bios\|efi\|efi32\|efi64</computeroutput>: Specifies the
1186	firmware to be used to boot the VM: Available options are:
1187	BIOS, or one of the EFI options: efi, efi32, or efi64. Use
1188	EFI options with care.
1189	</para>
1190	</listitem>
1191
1192	<listitem>
1193	<para>
1194	<computeroutput>--guestmemoryballoon
1195	<size></computeroutput> Sets the default size of the
1196	guest memory balloon. This is the memory allocated by the
1197	&product-name; Guest Additions from the guest operating
1198	system and returned to the hypervisor for reuse by other
1199	virtual machines.
1200	<computeroutput><size></computeroutput> must be
1201	specified in megabytes. The default size is 0 megabytes. See
1202	<xref linkend="guestadd-balloon" />.
1203	</para>
1204	</listitem>
1205
1206	<listitem>
1207	<para>
1208	<computeroutput>--defaultfrontend
1209	default\|<name></computeroutput>: Specifies the default
1210	frontend to be used when starting this VM. See
1211	<xref linkend="vboxmanage-startvm" />.
1212	</para>
1213	</listitem>
1214
1215	</itemizedlist>
1216
1217	</sect2>
1218
1219	<sect2 id="vboxmanage-modifyvm-networking">
1220
1221	<title>Networking Settings</title>
1222
1223	<para>
1224	The following networking settings are available through
1225	<command>VBoxManage modifyvm</command>. With all these settings,
1226	the decimal number directly following the option name, 1-N in
1227	the list below, specifies the virtual network adapter whose
1228	settings should be changed.
1229	</para>
1230
1231	<itemizedlist>
1232
1233	<listitem>
1234	<para>
1235	<computeroutput>--nic<1-N>
1236	none\|null\|nat\|natnetwork\|bridged\|intnet\|hostonly\|generic</computeroutput>:
1237	Configures the type of networking for each of the VM's
1238	virtual network cards. Options are: not present
1239	(<computeroutput>none</computeroutput>), not connected to
1240	the host (<computeroutput>null</computeroutput>), use
1241	network address translation
1242	(<computeroutput>nat</computeroutput>), use the new network
1243	address translation engine
1244	(<computeroutput>natnetwork</computeroutput>), bridged
1245	networking (<computeroutput>bridged</computeroutput>), or
1246	use internal networking
1247	(<computeroutput>intnet</computeroutput>), host-only
1248	networking (<computeroutput>hostonly</computeroutput>), or
1249	access rarely used sub-modes
1250	(<computeroutput>generic</computeroutput>). These options
1251	correspond to the modes described in
1252	<xref
1253	linkend="networkingmodes" />.
1254	</para>
1255	</listitem>
1256
1257	<listitem>
1258	<para>
1259	<computeroutput>--nictype<1-N>
1260	Am79C970A\|Am79C973\|82540EM\|82543GC\|82545EM\|virtio</computeroutput>:
1261	Enables you to specify the networking hardware that
1262	&product-name; presents to the guest for a specified VM
1263	virtual network card. See <xref linkend="nichardware" />.
1264	</para>
1265	</listitem>
1266
1267	<listitem>
1268	<para>
1269	<computeroutput>--cableconnected<1-N>
1270	on\|off</computeroutput>: Enables you to temporarily
1271	disconnect a virtual network interface, as if a network
1272	cable had been pulled from a real network card. This might
1273	be useful, for example for resetting certain software
1274	components in the VM.
1275	</para>
1276	</listitem>
1277
1278	<listitem>
1279	<para>
1280	With the <computeroutput>nictrace</computeroutput> options,
1281	you can optionally trace network traffic by dumping it to a
1282	file, for debugging purposes.
1283	</para>
1284
1285	<para>
1286	With <computeroutput>--nictrace<1-N>
1287	on\|off</computeroutput>, you can enable network tracing for
1288	a particular virtual network card.
1289	</para>
1290
1291	<para>
1292	If enabled, you must specify with
1293	<computeroutput>--nictracefile<1-N>
1294	<filename></computeroutput> the absolute path of the
1295	file the trace should be logged to.
1296	</para>
1297	</listitem>
1298
1299	<listitem>
1300	<para>
1301	<computeroutput>--nicproperty<1-N>
1302	<paramname>="paramvalue"</computeroutput>: This
1303	option, in combination with
1304	<computeroutput>nicgenericdrv</computeroutput> enables you
1305	to pass parameters to rarely-used network backends.
1306	</para>
1307
1308	<para>
1309	These parameters are backend engine-specific, and are
1310	different between UDP Tunnel and the VDE backend drivers.
1311	For examples, see <xref linkend="network_udp_tunnel" />.
1312	</para>
1313	</listitem>
1314
1315	<listitem>
1316	<para>
1317	<computeroutput>--nicspeed<1-N>
1318	<kbps></computeroutput>: Only has an effect if generic
1319	networking has been enabled for a particular virtual network
1320	card. See the <computeroutput>--nic</computeroutput> option.
1321	This mode enables access to rarely used networking
1322	sub-modes, such as VDE network or UDP Tunnel. This option
1323	specifies the throughput rate in KBps.
1324	</para>
1325	</listitem>
1326
1327	<listitem>
1328	<para>
1329	<computeroutput>--nicbootprio<1-N>
1330	<priority></computeroutput>: Specifies the order in
1331	which NICs are tried for booting over the network, using
1332	PXE. The priority is an integer in the 0 to 4 range.
1333	Priority 1 is the highest, priority 4 is low. Priority 0,
1334	which is the default unless otherwise specified, is the
1335	lowest.
1336	</para>
1337
1338	<para>
1339	Note that this option only has an effect when the Intel PXE
1340	boot ROM is used.
1341	</para>
1342	</listitem>
1343
1344	<listitem>
1345	<para>
1346	<computeroutput>--nicpromisc<1-N>
1347	deny\|allow-vms\|allow-all</computeroutput>: Enables you to
1348	specify how promiscuous mode is handled for the specified VM
1349	virtual network card. This setting is only relevant for
1350	bridged networking. <computeroutput>deny</computeroutput>,
1351	the default setting, hides any traffic not intended for the
1352	VM. <computeroutput>allow-vms</computeroutput> hides all
1353	host traffic from the VM, but allows the VM to see traffic
1354	to and from other VMs.
1355	<computeroutput>allow-all</computeroutput> removes this
1356	restriction completely.
1357	</para>
1358	</listitem>
1359
1360	<listitem>
1361	<para>
1362	<computeroutput>--nicbandwidthgroup<1-N>
1363	none\|<name></computeroutput>: Adds and removes an
1364	assignment of a bandwidth group for the specified virtual
1365	network interface. Specifying
1366	<computeroutput>none</computeroutput> removes any current
1367	bandwidth group assignment from the specified virtual
1368	network interface. Specifying
1369	<computeroutput><name></computeroutput> adds an
1370	assignment of a bandwidth group to the specified virtual
1371	network interface.
1372	</para>
1373
1374	<para>
1375	See <xref linkend="network_bandwidth_limit" />.
1376	</para>
1377	</listitem>
1378
1379	<listitem>
1380	<para>
1381	<computeroutput>--bridgeadapter<1-N>
1382	none\|<devicename></computeroutput>: Only has an effect
1383	if bridged networking has been enabled for a virtual network
1384	card. See the <computeroutput>--nic</computeroutput> option.
1385	Use this option to specify which host interface the given
1386	virtual network interface will use. See
1387	<xref linkend="network_bridged" />.
1388	</para>
1389	</listitem>
1390
1391	<listitem>
1392	<para>
1393	<computeroutput>--hostonlyadapter<1-N>
1394	none\|<devicename></computeroutput>: Only has an effect
1395	if host-only networking has been enabled for a virtual
1396	network card. See the <computeroutput>--nic</computeroutput>
1397	option. Use this option to specify which host-only
1398	networking interface the given virtual network interface
1399	will use. See <xref linkend="network_hostonly" />.
1400	</para>
1401	</listitem>
1402
1403	<listitem>
1404	<para>
1405	<computeroutput>--intnet<1-N>
1406	network</computeroutput>: Only has an effect if internal
1407	networking has been enabled for a virtual network card. See
1408	the <computeroutput>--nic</computeroutput> option. Use this
1409	option to specify the name of the internal network. See
1410	<xref linkend="network_internal" />.
1411	</para>
1412	</listitem>
1413
1414	<listitem>
1415	<para>
1416	<computeroutput>--nat-network<1-N> <network
1417	name></computeroutput>: If the networking type is set to
1418	<computeroutput>natnetwork</computeroutput>, not
1419	<computeroutput>nat</computeroutput>, then this setting
1420	specifies the name of the NAT network this adapter is
1421	connected to. Optional.
1422	</para>
1423	</listitem>
1424
1425	<listitem>
1426	<para>
1427	<computeroutput>--nicgenericdrv<1-N> <backend
1428	driver></computeroutput>: Only has an effect if generic
1429	networking has been enabled for a virtual network card. See
1430	the <computeroutput>--nic</computeroutput> option. This mode
1431	enables you to access rarely used networking sub-modes, such
1432	as VDE network or UDP Tunnel.
1433	</para>
1434	</listitem>
1435
1436	<listitem>
1437	<para>
1438	<computeroutput>--macaddress<1-N>
1439	auto\|<mac></computeroutput>: With this option you can
1440	set the MAC address of a particular network adapter on the
1441	VM. Normally, each network adapter is assigned a random
1442	address by &product-name; at VM creation.
1443	</para>
1444	</listitem>
1445
1446	</itemizedlist>
1447
1448	<sect3 id="vboxmanage-modifyvm-networking-nat">
1449
1450	<title>NAT Networking Settings</title>
1451
1452	<para>
1453	The following NAT networking settings are available through
1454	<command>VBoxManage modifyvm</command>. With all these
1455	settings, the decimal number directly following the option
1456	name, 1-N in the list below, specifies the virtual network
1457	adapter whose settings should be changed.
1458	</para>
1459
1460	<itemizedlist>
1461
1462	<listitem>
1463	<para>
1464	<computeroutput>--natnet<1-N>
1465	<network>\|default</computeroutput>: If the
1466	networking type is set to
1467	<computeroutput>nat</computeroutput>, not
1468	<computeroutput>natnetwork</computeroutput>, then this
1469	setting specifies the IP address range to be used for this
1470	network. See <xref linkend="changenat" />.
1471	</para>
1472	</listitem>
1473
1474	<listitem>
1475	<para>
1476	<computeroutput>--natpf<1-N>
1477	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
1478	<guestport></computeroutput>: Defines a NAT
1479	port-forwarding rule. See <xref linkend="natforward" />.
1480	</para>
1481	</listitem>
1482
1483	<listitem>
1484	<para>
1485	<computeroutput>--natpf<1-N> delete
1486	<name></computeroutput>: Deletes a NAT
1487	port-forwarding rule. See <xref linkend="natforward" />.
1488	</para>
1489	</listitem>
1490
1491	<listitem>
1492	<para>
1493	<computeroutput>--nattftpprefix<1-N>
1494	<prefix></computeroutput>: Defines a prefix for the
1495	built-in TFTP server. For example, where the boot file is
1496	located. See <xref linkend="nat-tftp" /> and
1497	<xref linkend="nat-adv-tftp" />.
1498	</para>
1499	</listitem>
1500
1501	<listitem>
1502	<para>
1503	<computeroutput>--nattftpfile<1-N>
1504	<bootfile></computeroutput>: Defines the TFT boot
1505	file. See <xref linkend="nat-adv-tftp" />.
1506	</para>
1507	</listitem>
1508
1509	<listitem>
1510	<para>
1511	<computeroutput>--nattftpserver<1-N>
1512	<tftpserver></computeroutput>: Defines the TFTP
1513	server address to boot from. See
1514	<xref linkend="nat-adv-tftp" />.
1515	</para>
1516	</listitem>
1517
1518	<listitem>
1519	<para>
1520	<computeroutput>--nattbindip<1-N>
1521	<ip;></computeroutput>: &product-name;'s NAT engine
1522	normally routes TCP/IP packets through the default
1523	interface assigned by the host's TCP/IP stack. Use this
1524	setting to instruct the NAT engine to bind to a specified
1525	IP address instead. See
1526	<xref linkend="nat-adv-settings" />.
1527	</para>
1528	</listitem>
1529
1530	<listitem>
1531	<para>
1532	<computeroutput>--natdnspassdomain<1-N>
1533	on\|off</computeroutput>: Specifies whether the built-in
1534	DHCP server passes the domain name for network name
1535	resolution.
1536	</para>
1537	</listitem>
1538
1539	<listitem>
1540	<para>
1541	<computeroutput>--natdnsproxy<1-N>
1542	on\|off</computeroutput>: Makes the NAT engine proxy all
1543	guest DNS requests to the host's DNS servers. See
1544	<xref linkend="nat-adv-dns" />.
1545	</para>
1546	</listitem>
1547
1548	<listitem>
1549	<para>
1550	<computeroutput>--natdnshostresolver<1-N>
1551	on\|off</computeroutput>: Makes the NAT engine use the
1552	host's resolver mechanisms to handle DNS requests. See
1553	<xref linkend="nat-adv-dns" />.
1554	</para>
1555	</listitem>
1556
1557	<listitem>
1558	<para>
1559	<computeroutput>--natsettings<1-N>
1560	[<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>],
1561	[<tcprcv>]</computeroutput>: Controls several NAT
1562	settings. See <xref linkend="nat-adv-settings" />.
1563	</para>
1564	</listitem>
1565
1566	<listitem>
1567	<para>
1568	<computeroutput>--nataliasmode<1-N>
1569	default\|[log],[proxyonly],[sameports]</computeroutput>:
1570	Defines behaviour of the NAT engine core: log - enables
1571	logging, proxyonly - switches off aliasing mode and makes
1572	NAT transparent, sameports - enforces the NAT engine to
1573	send packets through the same port as they originated on,
1574	default - disable all aliasing modes. See
1575	<xref linkend="nat-adv-alias" />.
1576	</para>
1577	</listitem>
1578
1579	</itemizedlist>
1580
1581	</sect3>
1582
1583	</sect2>
1584
1585	<sect2 id="vboxmanage-modifyvm-other">
1586
1587	<title>Miscellaneous Settings</title>
1588
1589	<para>
1590	The following hardware settings, such as serial port, audio,
1591	clipboard, drag and drop, monitor, and USB settings are
1592	available through <command>VBoxManage modifyvm</command>:
1593	</para>
1594
1595	<itemizedlist>
1596
1597	<listitem>
1598	<para>
1599	<computeroutput>--mouse
1600	<ps2\|usb\|usbtablet\|usbmultitouch></computeroutput>:
1601	Specifies the mode of the mouse to be used in the VM.
1602	Available options are: ps2, usb, usbtablet, usbmultitouch.
1603	</para>
1604	</listitem>
1605
1606	<listitem>
1607	<para>
1608	<computeroutput>--keyboard <ps2\|usb></computeroutput>:
1609	Specifies the mode of the keyboard to be used in the VM.
1610	Available options are: ps2, usb.
1611	</para>
1612	</listitem>
1613
1614	<listitem>
1615	<para>
1616	<computeroutput>--uart<1-N> off\|<I/O base>
1617	<IRQ></computeroutput>: Configures virtual serial
1618	ports for the VM. See <xref linkend="serialports" />.
1619	</para>
1620	</listitem>
1621
1622	<listitem>
1623	<para>
1624	<computeroutput>--uartmode<1-N>
1625	<arg></computeroutput>: Controls how &product-name;
1626	connects a given virtual serial port, configured with the
1627	<computeroutput>--uartX</computeroutput> setting, to the
1628	host on which the virtual machine is running. As described
1629	in <xref linkend="serialports" />, for each such port, you
1630	can specify <computeroutput><arg></computeroutput> as
1631	one of the following options:
1632	</para>
1633
1634	<itemizedlist>
1635
1636	<listitem>
1637	<para>
1638	<computeroutput>disconnected</computeroutput>: Even
1639	though the serial port is shown to the guest, it has no
1640	"other end". This is like a real COM port without a
1641	cable.
1642	</para>
1643	</listitem>
1644
1645	<listitem>
1646	<para>
1647	<computeroutput>server
1648	<pipename></computeroutput>: On a Windows host,
1649	this tells &product-name; to create a named pipe on the
1650	host named
1651	<computeroutput><pipename></computeroutput> and
1652	connect the virtual serial device to it. Note that
1653	Windows requires that the name of a named pipe begins
1654	with <computeroutput>\\.\pipe\</computeroutput>.
1655	</para>
1656
1657	<para>
1658	On a Linux host, instead of a named pipe, a local domain
1659	socket is used.
1660	</para>
1661	</listitem>
1662
1663	<listitem>
1664	<para>
1665	<computeroutput>client
1666	<pipename></computeroutput>: Operates as for
1667	<computeroutput>server</computeroutput>, except that the
1668	pipe, or local domain socket, is not created by
1669	&product-name; but is assumed to exist already.
1670	</para>
1671	</listitem>
1672
1673	<listitem>
1674	<para>
1675	<computeroutput>tcpserver <port></computeroutput>:
1676	Configures &product-name; to create a TCP socket on the
1677	host with TCP
1678	<computeroutput><port></computeroutput> and
1679	connect the virtual serial device to it. Note that
1680	UNIX-like systems require ports over 1024 for normal
1681	users.
1682	</para>
1683	</listitem>
1684
1685	<listitem>
1686	<para>
1687	<computeroutput>tcpclient
1688	<hostname:port></computeroutput>: Operates as for
1689	<computeroutput>tcpserver</computeroutput>, except that
1690	the TCP socket is not created by &product-name;, but is
1691	assumed to exist already.
1692	</para>
1693	</listitem>
1694
1695	<listitem>
1696	<para>
1697	<computeroutput>uarttype <1-N>
1698	16450\|16550A\|16750</computeroutput>: Confgures the UART
1699	type for a virtual serial port. The default UART type is
1700	16550A.
1701	</para>
1702	</listitem>
1703
1704	<listitem>
1705	<para>
1706	<computeroutput>file <file></computeroutput>:
1707	Redirects the serial port output to a raw file
1708	<file> specified by its absolute path on the host
1709	file system.
1710	</para>
1711	</listitem>
1712
1713	<listitem>
1714	<para>
1715	<computeroutput><devicename></computeroutput>: If,
1716	instead of the above options, the device name of a
1717	physical hardware serial port of the host is specified,
1718	the virtual serial port is connected to that hardware
1719	port. On a Windows host, the device name will be a COM
1720	port such as <computeroutput>COM1</computeroutput>. On a
1721	Linux host, the device name will be
1722	<computeroutput>/dev/ttyS0</computeroutput> or similar.
1723	This enables you to wire up a real serial port to a
1724	virtual machine.
1725	</para>
1726	</listitem>
1727
1728	</itemizedlist>
1729	</listitem>
1730
1731	<listitem>
1732	<para>
1733	<computeroutput>--lptmode<1-N>
1734	<Device></computeroutput>: Specifies the Device Name
1735	of the parallel port that the Parallel Port feature will be
1736	using. Use this <emphasis>before</emphasis>
1737	<computeroutput>--lpt</computeroutput>. This feature depends
1738	on the host operating system. For Windows hosts, use a
1739	device name such as lpt1. On Linux hosts, use a device name
1740	such as /dev/lp0.
1741	</para>
1742	</listitem>
1743
1744	<listitem>
1745	<para>
1746	<computeroutput>--lpt<1-N> <I/O base>
1747	<IRQ></computeroutput>: Specifies the I/O address of
1748	the parallel port and the IRQ number that the Parallel Port
1749	feature will be using. Optional. Use this
1750	<emphasis>after</emphasis>
1751	<computeroutput>--lptmod</computeroutput>. I/O base address
1752	and IRQ are the values that guest sees. For example, the
1753	values avalable under guest Device Manager.
1754	</para>
1755	</listitem>
1756
1757	<listitem>
1758	<para>
1759	<computeroutput>--audio
1760	none\|null\|dsound\|oss\|alsa\|pulse\|coreaudio</computeroutput>:
1761	Specifies whether the VM should have audio support, and if
1762	so, which type. The list of supported audio types depends on
1763	the host and can be determined with <command>VBoxManage
1764	modifyvm</command>.
1765	</para>
1766	</listitem>
1767
1768	<listitem>
1769	<para>
1770	<computeroutput>--audiocontroller
1771	ac97\|hda\|sb16</computeroutput>: Specifies the audio
1772	controller to be used with the VM.
1773	</para>
1774	</listitem>
1775
1776	<listitem>
1777	<para>
1778	<computeroutput>--audiocodec
1779	stac9700\|ad1980\|stac9221\|sb16</computeroutput>: Specifies
1780	the audio codec to be used with the VM.
1781	</para>
1782	</listitem>
1783
1784	<listitem>
1785	<para>
1786	<computeroutput>--audioin on</computeroutput>: Specifies
1787	whether capturing audio from the host is enabled or
1788	disabled.
1789	</para>
1790	</listitem>
1791
1792	<listitem>
1793	<para>
1794	<computeroutput>--audioout on</computeroutput>: Specifies
1795	whether audio playback from the guest is enabled or
1796	disabled.
1797	</para>
1798	</listitem>
1799
1800	<listitem>
1801	<para>
1802	<computeroutput>--clipboard
1803	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1804	Configues how the guest or host operating system's clipboard
1805	should be shared with the host or guest. See
1806	<xref linkend="generalsettings" />. This setting requires
1807	that the Guest Additions be installed in the virtual
1808	machine.
1809	</para>
1810	</listitem>
1811
1812	<listitem>
1813	<para>
1814	<computeroutput>--draganddrop
1815	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
1816	Specifies the drag and drop mode to use between the host and
1817	the virtual machine. See <xref linkend="guestadd-dnd" />.
1818	This requires that the Guest Additions be installed in the
1819	virtual machine.
1820	</para>
1821	</listitem>
1822
1823	<listitem>
1824	<para>
1825	<computeroutput>--monitorcount
1826	<count></computeroutput>: Enables multi-monitor
1827	support. See <xref linkend="settings-display" />.
1828	</para>
1829	</listitem>
1830
1831	<listitem>
1832	<para>
1833	<computeroutput>--usb on\|off</computeroutput>: Enables and
1834	disables the VM's virtual USB controller. See
1835	<xref linkend="settings-usb" />.
1836	</para>
1837	</listitem>
1838
1839	<listitem>
1840	<para>
1841	<computeroutput>--usbehci on\|off</computeroutput>: Enables
1842	and disables the VM's virtual USB 2.0 controller. See
1843	<xref linkend="settings-usb" />.
1844	</para>
1845	</listitem>
1846
1847	<listitem>
1848	<para>
1849	<computeroutput>--usbxhci on\|off</computeroutput>: Enables
1850	and disables the VM's virtual USB 3.0 controller. See
1851	<xref linkend="settings-usb" />.
1852	</para>
1853	</listitem>
1854
1855	<listitem>
1856	<para>
1857	<computeroutput>--usbrename <oldname>
1858	<newname></computeroutput>: Enables renaming of the
1859	VM's virtual USB controller from <oldname> to
1860	<newname>.
1861	</para>
1862	</listitem>
1863
1864	</itemizedlist>
1865
1866	</sect2>
1867
1868	<sect2 id="vboxmanage-modifyvm-recording">
1869
1870	<title>Recording Settings</title>
1871
1872	<para>
1873	The <command>VBoxManage modifyvm</command> command enables you
1874	to modify recording settings for video recording, audio
1875	recording, or both.
1876	</para>
1877
1878	<para>
1879	Use the following options to update the recording settings:
1880	</para>
1881
1882	<itemizedlist>
1883
1884	<listitem>
1885	<para>
1886	<option>--recording on\|off</option> enables or disables the
1887	recording of a VM session into a WebM/VP8 file. When this
1888	option value is <computeroutput>on</computeroutput>,
1889	recording begins when the VM session starts.
1890	</para>
1891	</listitem>
1892
1893	<listitem>
1894	<para>
1895	<option>--recordingscreens
1896	all\|<replaceable>screen-ID</replaceable>
1897	[<replaceable>screen-ID</replaceable> ...]</option> enables
1898	you to specify which VM screens to record. The recording for
1899	each screen that you specify is saved to its own file.
1900	</para>
1901	</listitem>
1902
1903	<listitem>
1904	<para>
1905	<option>--recordingfile
1906	<replaceable>filename</replaceable></option> specifies the
1907	file in which to save the recording.
1908	</para>
1909	</listitem>
1910
1911	<listitem>
1912	<para>
1913	<option>--recordingmaxsize
1914	<replaceable>MB</replaceable></option> specifies the maximum
1915	size of the recorded video file in megabytes. The recording
1916	stops when the file reaches the specified size. If this
1917	value is zero, the recording continues until you stop the
1918	recording.
1919	</para>
1920	</listitem>
1921
1922	<listitem>
1923	<para>
1924	<option>--recordingmaxtime
1925	<replaceable>seconds</replaceable></option> specifies the
1926	maximum amount time to record in seconds. The recording
1927	stops after the specified number of seconds elapses. If this
1928	value is zero, the recording continues until you stop the
1929	recording.
1930	</para>
1931	</listitem>
1932
1933	<listitem>
1934	<para>
1935	<option>--recordingopts
1936	<replaceable>keyword</replaceable>=<replaceable>value</replaceable>[,<replaceable>keyword</replaceable>=<replaceable>value</replaceable>
1937	...]</option> specifies additional video-recording options
1938	in a comma-separated keyword-value format. For example,
1939	<computeroutput>foo=bar,a=b</computeroutput>.
1940	</para>
1941
1942	<para>
1943	Only use this option only if you are an advanced user. For
1944	information about keywords, see <emphasis>Oracle VM
1945	VirtualBox Programming Guide and Reference</emphasis>.
1946	</para>
1947	</listitem>
1948
1949	<listitem>
1950	<para>
1951	<option>--recordingvideofps
1952	<replaceable>fps</replaceable></option> specifies the
1953	maximum number of video frames per second (FPS) to record.
1954	Frames that have a higher frequency are skipped. Increasing
1955	this value reduces the number of skipped frames and
1956	increases the file size.
1957	</para>
1958	</listitem>
1959
1960	<listitem>
1961	<para>
1962	<option>--recordingvideorate
1963	<replaceable>bit-rate</replaceable></option> specifies the
1964	bit rate of the video in kilobits per second. Increasing
1965	this value improves the appearance of the video at the cost
1966	of an increased file size.
1967	</para>
1968	</listitem>
1969
1970	<listitem>
1971	<para>
1972	<option>--recordingvideores
1973	<replaceable>width</replaceable>x<replaceable>height</replaceable></option>
1974	specifies the video resolution of the recorded video in
1975	pixels.
1976	</para>
1977	</listitem>
1978
1979	</itemizedlist>
1980
1981	</sect2>
1982
1983	<sect2 id="vboxmanage-modifyvm-vrde">
1984
1985	<title>Remote Machine Settings</title>
1986
1987	<para>
1988	The following settings that affect remote machine behavior are
1989	available through <command>VBoxManage modifyvm</command>:
1990	</para>
1991
1992	<itemizedlist>
1993
1994	<listitem>
1995	<para>
1996	<computeroutput>--vrde on\|off</computeroutput>: Enables and
1997	disables the VirtualBox Remote Desktop Extension (VRDE)
1998	server.
1999	</para>
2000	</listitem>
2001
2002	<listitem>
2003	<para>
2004	<computeroutput>--vrdeproperty
2005	"TCP/Ports\|Address=<value>"</computeroutput>: Sets the
2006	port numbers and IP address on the VM that the VRDE server
2007	can bind to.
2008	</para>
2009
2010	<itemizedlist>
2011
2012	<listitem>
2013	<para>
2014	For TCP/Ports, <value> should be a port or a range
2015	of ports that the VRDE server can bind to.
2016	<computeroutput>default</computeroutput> or
2017	<computeroutput>0</computeroutput> means port 3389, the
2018	standard port for RDP. See the description for the
2019	<computeroutput>--vrdeport</computeroutput> option in
2020	<xref linkend="vboxmanage-modifyvm-vrde" />.
2021	</para>
2022	</listitem>
2023
2024	<listitem>
2025	<para>
2026	For TCP/Address, <value> should be the IP address
2027	of the host network interface that the VRDE server will
2028	bind to. If specified, the server will accept
2029	connections only on the specified host network
2030	interface. See the description for the
2031	<computeroutput>--vrdeaddress</computeroutput> option in
2032	<xref linkend="vboxmanage-modifyvm-vrde" />.
2033	</para>
2034	</listitem>
2035
2036	</itemizedlist>
2037	</listitem>
2038
2039	<listitem>
2040	<para>
2041	<computeroutput>--vrdeproperty
2042	"VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>:
2043	Sets the VRDP video redirection properties.
2044	</para>
2045
2046	<itemizedlist>
2047
2048	<listitem>
2049	<para>
2050	For VideoChannel/Enabled, <value> can be set to
2051	"1", switching the VRDP video channel on. See
2052	<xref linkend="vrde-videochannel" />.
2053	</para>
2054	</listitem>
2055
2056	<listitem>
2057	<para>
2058	For VideoChannel/Quality, <value> should be set
2059	between 10 and 100% inclusive, representing a JPEG
2060	compression level on the VRDE server video channel.
2061	Lower values mean lower quality but higher compression.
2062	See <xref linkend="vrde-videochannel" />.
2063	</para>
2064	</listitem>
2065
2066	<listitem>
2067	<para>
2068	For VideoChannel/DownscaleProtection, <value> can
2069	be set to "1" to enable the videochannel downscale
2070	protection feature. When enabled, if a video's size
2071	equals the shadow buffer size, then it is regarded as a
2072	full screen video, and is displayed. But if its size is
2073	between fullscreen and the downscale threshold then it
2074	is <emphasis>not</emphasis> displayed, as it could be an
2075	application window, which would be unreadable when
2076	downscaled. When the downscale protection feature is
2077	disabled, an attempt is always made to display videos.
2078	</para>
2079	</listitem>
2080
2081	</itemizedlist>
2082	</listitem>
2083
2084	<listitem>
2085	<para>
2086	<computeroutput>--vrdeproperty
2087	"Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput>:
2088	Disables one of the VRDE server features: Display, Input,
2089	Audio or USB respectively. To reenable a feature, use
2090	"Client/DisableDisplay=" for example. See
2091	<xref linkend="vrde-customization" />.
2092	</para>
2093	</listitem>
2094
2095	<listitem>
2096	<para>
2097	<computeroutput>--vrdeproperty
2098	"Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput>:
2099	Disables one of the VRDE server features: Clipboard or
2100	UpstreamAudio respectively. To reenable a feature, use
2101	"Client/DisableClipboard=" for example. See
2102	<xref linkend="vrde-customization" />.
2103	</para>
2104	</listitem>
2105
2106	<listitem>
2107	<para>
2108	<computeroutput>--vrdeproperty
2109	"Client/DisableRDPDR=1"</computeroutput>: Disables the VRDE
2110	server feature: RDP device redirection for smart cards. To
2111	reenable this feature, use "Client/DisableRDPR=".
2112	</para>
2113	</listitem>
2114
2115	<listitem>
2116	<para>
2117	<computeroutput>--vrdeproperty
2118	"H3DRedirect/Enabled=1"</computeroutput>: Enables the VRDE
2119	server feature: 3D redirection. To disable this feature, use
2120	"H3DRedirect/Enabled=".
2121	</para>
2122	</listitem>
2123
2124	<listitem>
2125	<para>
2126	<computeroutput>--vrdeproperty
2127	"Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>:
2128	Sets the desired security method and path of server
2129	certificate, path of server private key, path of CA
2130	certificate, that are used for a connection.
2131	</para>
2132
2133	<itemizedlist>
2134
2135	<listitem>
2136	<para>
2137	<computeroutput>--vrdeproperty
2138	"Security/Method=<value>"</computeroutput> sets
2139	the desired security method, which is used for a
2140	connection. Valid values are:
2141	</para>
2142
2143	<itemizedlist>
2144
2145	<listitem>
2146	<para>
2147	<computeroutput>Negotiate</computeroutput>: Both
2148	Enhanced (TLS) and Standard RDP Security connections
2149	are allowed. The security method is negotiated with
2150	the client. This is the default setting.
2151	</para>
2152	</listitem>
2153
2154	<listitem>
2155	<para>
2156	<computeroutput>RDP</computeroutput>: Only Standard
2157	RDP Security is accepted.
2158	</para>
2159	</listitem>
2160
2161	<listitem>
2162	<para>
2163	<computeroutput>TLS</computeroutput>: Only Enhanced
2164	RDP Security is accepted. The client must support
2165	TLS.
2166	</para>
2167	</listitem>
2168
2169	</itemizedlist>
2170
2171	<para>
2172	See <xref linkend="vrde-crypt" />.
2173	</para>
2174	</listitem>
2175
2176	<listitem>
2177	<para>
2178	<computeroutput>--vrdeproperty
2179	"Security/ServerCertificate=<value>"</computeroutput>
2180	where <value> is the absolute path of the server
2181	certificate. See <xref linkend="vrde-crypt" />.
2182	</para>
2183	</listitem>
2184
2185	<listitem>
2186	<para>
2187	<computeroutput>--vrdeproperty
2188	"Security/ServerPrivateKey=<value>"</computeroutput>
2189	where <value> is the absolute path of the server
2190	private key. See <xref linkend="vrde-crypt" />.
2191	</para>
2192	</listitem>
2193
2194	<listitem>
2195	<para>
2196	<computeroutput>--vrdeproperty
2197	"Security/CACertificate=<value>"</computeroutput>
2198	where <value> is the absolute path of the CA self
2199	signed certificate. See <xref linkend="vrde-crypt" />.
2200	</para>
2201	</listitem>
2202
2203	</itemizedlist>
2204	</listitem>
2205
2206	<listitem>
2207	<para>
2208	<computeroutput>--vrdeproperty
2209	"Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>
2210	sets the audio connection mode, or path of the audio
2211	logfile.
2212	</para>
2213
2214	<itemizedlist>
2215
2216	<listitem>
2217	<para>
2218	<computeroutput>--vrdeproperty
2219	"Audio/RateCorrectionMode=<value>"</computeroutput>
2220	where <value> is the desired rate correction mode.
2221	Allowed values are:
2222	</para>
2223
2224	<itemizedlist>
2225
2226	<listitem>
2227	<para>
2228	<computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput>:
2229	No mode specified, use to unset any Audio mode
2230	already set.
2231	</para>
2232	</listitem>
2233
2234	<listitem>
2235	<para>
2236	<computeroutput>VRDP_AUDIO_MODE_RC</computeroutput>:
2237	Rate correction mode.
2238	</para>
2239	</listitem>
2240
2241	<listitem>
2242	<para>
2243	<computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput>:
2244	Low pass filter mode.
2245	</para>
2246	</listitem>
2247
2248	<listitem>
2249	<para>
2250	<computeroutput>VRDP_AUDIO_MODE_CS</computeroutput>:
2251	Client sync mode to prevent underflow or overflow of
2252	the client queue.
2253	</para>
2254	</listitem>
2255
2256	</itemizedlist>
2257	</listitem>
2258
2259	<listitem>
2260	<para>
2261	<computeroutput>--vrdeproperty
2262	"Audio/LogPath=<value>"</computeroutput> where
2263	<value> is the absolute path of the Audio log
2264	file.
2265	</para>
2266	</listitem>
2267
2268	</itemizedlist>
2269	</listitem>
2270
2271	<listitem>
2272	<para>
2273	<computeroutput>--vrdeextpack
2274	default\|<name></computeroutput>: Specifies the library
2275	to use for accessing the VM remotely. The default is to use
2276	the RDP code which is part of the &product-name; Extension
2277	Pack.
2278	</para>
2279	</listitem>
2280
2281	<listitem>
2282	<para>
2283	<computeroutput>--vrdeport
2284	default\|<ports></computeroutput>: A port or a range of
2285	ports the VRDE server can bind to.
2286	<computeroutput>default</computeroutput> or
2287	<computeroutput>0</computeroutput> means port 3389, the
2288	standard port for RDP. You can specify a comma-separated
2289	list of ports or ranges of ports. Use a dash between two
2290	port numbers to specify a range. The VRDE server will bind
2291	to <emphasis>one</emphasis> of the available ports from the
2292	specified list. Only one machine can use a given port at a
2293	time. For example, the option <computeroutput> --vrdeport
2294	5000,5010-5012</computeroutput> will tell the server to bind
2295	to one of following ports: 5000, 5010, 5011, or 5012.
2296	</para>
2297	</listitem>
2298
2299	<listitem>
2300	<para>
2301	<computeroutput>--vrdeaddress <IP
2302	address></computeroutput>: The IP address of the host
2303	network interface the VRDE server will bind to. If
2304	specified, the server will accept connections only on the
2305	specified host network interface.
2306	</para>
2307
2308	<para>
2309	The setting can be used to specify whether the VRDP server
2310	should accept either IPv4, IPv6, or both connections:
2311	</para>
2312
2313	<itemizedlist>
2314
2315	<listitem>
2316	<para>
2317	Only IPv4: <computeroutput>--vrdeaddress
2318	"0.0.0.0"</computeroutput>
2319	</para>
2320	</listitem>
2321
2322	<listitem>
2323	<para>
2324	Only IPv6: <computeroutput>--vrdeaddress
2325	"::"</computeroutput>
2326	</para>
2327	</listitem>
2328
2329	<listitem>
2330	<para>
2331	Both IPv6 and IPv4: <computeroutput>--vrdeaddress
2332	""</computeroutput>
2333	</para>
2334
2335	<para>
2336	This is the default setting.
2337	</para>
2338	</listitem>
2339
2340	</itemizedlist>
2341	</listitem>
2342
2343	<listitem>
2344	<para>
2345	<computeroutput>--vrdeauthtype
2346	null\|external\|guest</computeroutput>: Enables you to
2347	indicate use of authorization, and specify how authorization
2348	will be performed. See <xref linkend="vbox-auth" />.
2349	</para>
2350	</listitem>
2351
2352	<listitem>
2353	<para>
2354	<computeroutput>--vrdeauthlibrary
2355	default\|<name></computeroutput>: Specifies the library
2356	used for RDP authentication. See
2357	<xref linkend="vbox-auth" />.
2358	</para>
2359	</listitem>
2360
2361	<listitem>
2362	<para>
2363	<computeroutput>--vrdemulticon on\|off</computeroutput>:
2364	Enables multiple connections to be made to the same VRDE
2365	server, if the server supports this feature. See
2366	<xref linkend="vrde-multiconnection" />.
2367	</para>
2368	</listitem>
2369
2370	<listitem>
2371	<para>
2372	<computeroutput>--vrdereusecon on\|off</computeroutput>: This
2373	specifies the VRDE server behavior when multiple connections
2374	are disabled. When this option is enabled, the server will
2375	allow a new client to connect and will drop the existing
2376	connection. When this option is disabled, the default
2377	setting, a new connection will not be accepted if there is
2378	already a client connected to the server.
2379	</para>
2380	</listitem>
2381
2382	<listitem>
2383	<para>
2384	<computeroutput>--vrdevideochannel on\|off</computeroutput>:
2385	Enables video redirection, if it is supported by the VRDE
2386	server. See <xref linkend="vrde-videochannel" />.
2387	</para>
2388	</listitem>
2389
2390	<listitem>
2391	<para>
2392	<computeroutput>--vrdevideochannelquality
2393	<percent></computeroutput>: Specifies the image
2394	quality for video redirection. See
2395	<xref linkend="vrde-videochannel" />.
2396	</para>
2397	</listitem>
2398
2399	</itemizedlist>
2400
2401	</sect2>
2402
2403	<sect2 id="vboxmanage-modifyvm-teleport">
2404
2405	<title>Teleporting Settings</title>
2406
2407	<para>
2408	With the following commands for <command>VBoxManage
2409	modifyvm</command> you can configure a machine to be a target
2410	for teleporting. See <xref linkend="teleporting" />.
2411	</para>
2412
2413	<itemizedlist>
2414
2415	<listitem>
2416	<para>
2417	<computeroutput>--teleporter on\|off</computeroutput>:
2418	Enables and disables the teleporter feature whereby when the
2419	machine is started, it waits to receive a teleporting
2420	request from the network instead of booting normally.
2421	Teleporting requests are received on the port and address
2422	specified using the following parameters.
2423	</para>
2424	</listitem>
2425
2426	<listitem>
2427	<para>
2428	<computeroutput>--teleporterport
2429	<port></computeroutput>,
2430	<computeroutput>--teleporteraddress
2431	<address></computeroutput>: These settings must be
2432	used with <computeroutput>--teleporter</computeroutput>.
2433	They specify the port and address the virtual machine should
2434	listen to in order to receive a teleporting request sent
2435	from another virtual machine.
2436	<computeroutput><port></computeroutput> can be any
2437	free TCP/IP port number, such as 6000.
2438	<computeroutput><address></computeroutput> can be any
2439	IP address or hostname and specifies the TCP/IP socket to
2440	bind to. The default is 0.0.0.0, which means any address.
2441	</para>
2442	</listitem>
2443
2444	<listitem>
2445	<para>
2446	<computeroutput>--teleporterpassword
2447	<password></computeroutput>: If this optional setting
2448	is used, then the teleporting request will only succeed if
2449	the source machine specifies the same password as the one
2450	given with this command.
2451	</para>
2452	</listitem>
2453
2454	<listitem>
2455	<para>
2456	<computeroutput>--teleporterpasswordfile
2457	<password></computeroutput>: If this optional setting
2458	is used, then the teleporting request will only succeed if
2459	the source machine specifies the same password as the one
2460	specified in the file give with this command. Use
2461	<computeroutput>stdin</computeroutput> to read the password
2462	from stdin.
2463	</para>
2464	</listitem>
2465
2466	<listitem>
2467	<para>
2468	<computeroutput>--cpuid <leaf> <eax> <ebx>
2469	<ecx> <edx></computeroutput>: Advanced users can
2470	use this setting before a teleporting operation, to restrict
2471	the virtual CPU capabilities that &product-name; presents to
2472	the guest operating system. This must be run on both the
2473	source and the target machines involved in the teleporting
2474	and will then modify what the guest sees when it executes
2475	the <computeroutput>CPUID</computeroutput> machine
2476	instruction. This might help with misbehaving applications
2477	that wrongly assume that certain CPU capabilities are
2478	present. The meaning of the parameters is hardware
2479	dependent, refer to the AMD or Intel processor
2480	documentation.
2481	</para>
2482	</listitem>
2483
2484	</itemizedlist>
2485
2486	</sect2>
2487
2488	<sect2 id="vboxmanage-modifyvm-debugging">
2489
2490	<title>Debugging Settings</title>
2491
2492	<para>
2493	The following settings are only relevant for low-level VM
2494	debugging. Regular users will never need these settings.
2495	</para>
2496
2497	<itemizedlist>
2498
2499	<listitem>
2500	<para>
2501	<computeroutput>--tracing-enabled on\|off</computeroutput>:
2502	Enables the tracebuffer. This consumes some memory for the
2503	tracebuffer and adds extra overhead.
2504	</para>
2505	</listitem>
2506
2507	<listitem>
2508	<para>
2509	<computeroutput>--tracing-config
2510	<config-string></computeroutput>: Enables tracing
2511	configuration. In particular, this defines which group of
2512	tracepoints are enabled.
2513	</para>
2514	</listitem>
2515
2516	<listitem>
2517	<para>
2518	<computeroutput>--tracing-allow-vm-access
2519	on\|off</computeroutput>: Enables and disables VM access to
2520	the tracebuffer. By default, this setting is disabled.
2521	</para>
2522	</listitem>
2523
2524	</itemizedlist>
2525
2526	</sect2>
2527
2528	<sect2 id="vboxmanage-usbcardreader">
2529
2530	<title>USB Card Reader Settings</title>
2531
2532	<para>
2533	The following setting defines access to a USB Card Reader by the
2534	guest environment. USB card readers are typically used for
2535	accessing data on memory cards such as CompactFlash (CF), Secure
2536	Digital (SD), or MultiMediaCard (MMC).
2537	</para>
2538
2539	<itemizedlist>
2540
2541	<listitem>
2542	<para>
2543	<computeroutput>--usbcardreader on\|off</computeroutput>:
2544	Enables and disables the USB card reader interface.
2545	</para>
2546	</listitem>
2547
2548	</itemizedlist>
2549
2550	</sect2>
2551
2552	<sect2 id="vboxmanage-autostart">
2553
2554	<title>Autostarting VMs During Host System Boot</title>
2555
2556	<para>
2557	These settings configure the VM autostart feature, which
2558	automatically starts the VM at host system boot-up. Note that
2559	there are prerequisites that need to be addressed before using
2560	this feature. See <xref linkend="autostart" />.
2561	</para>
2562
2563	<itemizedlist>
2564
2565	<listitem>
2566	<para>
2567	<computeroutput>--autostart-enabled on\|off</computeroutput>:
2568	Enables and disables VM autostart at host system boot-up,
2569	using the specified user name.
2570	</para>
2571	</listitem>
2572
2573	<listitem>
2574	<para>
2575	<computeroutput>--autostart-delay
2576	<seconds></computeroutput>: Specifies a delay, in
2577	seconds, following host system boot-up, before the VM
2578	autostarts.
2579	</para>
2580	</listitem>
2581
2582	</itemizedlist>
2583
2584	</sect2>
2585
2586	</sect1>
2587
2588	<sect1 id="vboxmanage-clonevm">
2589
2590	<title>VBoxManage clonevm</title>
2591
2592	<para>
2593	The <command>VBoxManage clonevm</command> command creates a clone
2594	of an existing virtual machine (VM). The clone can be a full copy
2595	of the VM or a linked copy of a VM.
2596	</para>
2597
2598	<screen>
2599	VBoxManage clonevm <replaceable>vm</replaceable> [ --basefolder <replaceable>basefolder</replaceable> ]
2600	[ --group <replaceable>group</replaceable>, ... ] [ --mode machine \| machinechildren \| all ]
2601	[ --name <replaceable>name</replaceable> ] [ --options link \| keepallmacs \| keepnatmacs \| keepdisknames \| keephwuuids ]
2602	[ --register ] [ --snapshot <replaceable>vm</replaceable> ] [ --uuid <replaceable>uuid</replaceable> ]
2603	</screen>
2604
2605	<para>
2606	In addition to specifying the name of the VM to clone, which is
2607	required, you can specify any of the following options:
2608	</para>
2609
2610	<itemizedlist>
2611
2612	<listitem>
2613	<para>
2614	<option>--basefolder</option>
2615	<replaceable>basefolder</replaceable> specifies the name of
2616	the folder in which to save the configuration for the new VM.
2617	</para>
2618	</listitem>
2619
2620	<listitem>
2621	<para>
2622	<option>--groups <replaceable>group</replaceable>,
2623	...</option> assigns the clone to the specified group or
2624	groups. If you specify more than one group, separate each
2625	group name with a comma.
2626	</para>
2627
2628	<para>
2629	Note that each group is identified by a group ID that starts
2630	with a slash character (<computeroutput>/</computeroutput>) so
2631	that groups can be nested. By default, a clone is always
2632	assigned membership to the <computeroutput>/</computeroutput>
2633	group.
2634	</para>
2635	</listitem>
2636
2637	<listitem>
2638	<para>
2639	<option>--mode machine\|machineandchildren\|all</option>
2640	specifies which of the following cloning modes to use:
2641	</para>
2642
2643	<itemizedlist>
2644
2645	<listitem>
2646	<para>
2647	<computeroutput>machine</computeroutput> mode clones the
2648	current state of the existing VM without any snapshots.
2649	This is the default mode.
2650	</para>
2651	</listitem>
2652
2653	<listitem>
2654	<para>
2655	<computeroutput>machineandchildren</computeroutput> mode
2656	clones the snapshot specified by by the
2657	<option>--snapshot</option> option and all child
2658	snapshots.
2659	</para>
2660	</listitem>
2661
2662	<listitem>
2663	<para>
2664	<computeroutput>all</computeroutput> mode clones all
2665	snapshots and the current state of the existing VM.
2666	</para>
2667	</listitem>
2668
2669	</itemizedlist>
2670	</listitem>
2671
2672	<listitem>
2673	<para>
2674	<option>--name <replaceable>name</replaceable></option>
2675	specifies a new name for the new VM. The default value is
2676	"<replaceable>name</replaceable> Clone", where
2677	<replaceable>name</replaceable> is the original name of the
2678	VM.
2679	</para>
2680	</listitem>
2681
2682	<listitem>
2683	<para>
2684	<option>--options</option> specifies how to create a new
2685	clone.
2686	</para>
2687
2688	<itemizedlist>
2689
2690	<listitem>
2691	<para>
2692	<option>--options link</option> creates a linked clone,
2693	which can be cloned only from a snapshot.
2694	</para>
2695	</listitem>
2696
2697	<listitem>
2698	<para>
2699	<option>--options keepallmacs</option> specifies that the
2700	new clone reuses the MAC addresses of each virtual network
2701	card from the existing VM.
2702	</para>
2703
2704	<para>
2705	If you do not specify this option or the <option>--options
2706	keepnatmacs</option> option, the default behavior is to
2707	reinitialize the MAC addresses of each virtual network
2708	card.
2709	</para>
2710	</listitem>
2711
2712	<listitem>
2713	<para>
2714	<option>--options keepnatmacs</option> specifies that the
2715	new clone reuses the MAC addresses of each virtual network
2716	card from the existing VM when the network type is NAT.
2717	</para>
2718
2719	<para>
2720	If you do not specify this option or the <option>--options
2721	keepallmacs</option> option, the default behavior is to
2722	reinitialize the MAC addresses of each virtual network
2723	card.
2724	</para>
2725	</listitem>
2726
2727	<listitem>
2728	<para>
2729	<option>--option keepdisknames</option> specifies that the
2730	new clone reuses the disk image names from the existing
2731	VM. By default, disk images are renamed. You can preserve
2732	source hardware IDs by adding
2733	<computeroutput>keephwuuids</computeroutput>.
2734	</para>
2735	</listitem>
2736
2737	<listitem>
2738	<para>
2739	<option>--option keephwuuids</option> specifies that the
2740	new clone reuses the hardware IDs from the existing VM. By
2741	default, new UUIDs are used.
2742	</para>
2743	</listitem>
2744
2745	</itemizedlist>
2746	</listitem>
2747
2748	<listitem>
2749	<para>
2750	<option>--register</option> automatically registers the new
2751	clone in this &product-name; installation. You can manually
2752	register the new VM later by using the <command>VBoxManage
2753	registervm</command> command. See
2754	<xref linkend="vboxmanage-registervm" />.
2755	</para>
2756	</listitem>
2757
2758	<listitem>
2759	<para>
2760	<option>--snapshot <replaceable>vm</replaceable></option>
2761	specifies the snapshot on which to base the new VM. By
2762	default, the clone is created from the current state of the
2763	specified VM.
2764	</para>
2765	</listitem>
2766
2767	<listitem>
2768	<para>
2769	<option>--uuid <replaceable>uuid</replaceable></option>
2770	specifies the UUID for the new VM. Ensure that this ID is
2771	unique for the &product-name; instance if you decide to
2772	register this new VM. By default, &product-name; provides a
2773	new UUID.
2774	</para>
2775	</listitem>
2776
2777	</itemizedlist>
2778
2779	</sect1>
2780
2781	<sect1 id="vboxmanage-movevm">
2782
2783	<title>VBoxManage movevm</title>
2784
2785	<para>
2786	This command moves a virtual machine to a new location on the
2787	host.
2788	</para>
2789
2790	<para>
2791	Associated files of the virtual machine, such as settings files
2792	and disk image files, are moved to the new location. The
2793	&product-name; configuration is updated automatically.
2794	</para>
2795
2796	<para>
2797	The <command>movevm</command> subcommand requires the name of the
2798	virtual machine which should be moved.
2799	</para>
2800
2801	<para>
2802	Also required is the type of move operation, specified by
2803	<computeroutput>--type basic</computeroutput>. Other types of move
2804	operation may be supported in future releases.
2805	</para>
2806
2807	<para>
2808	The <computeroutput>--folder</computeroutput> setting configures
2809	the new location on the host file system. Enter a relative
2810	pathname or a full pathname.
2811	</para>
2812
2813	</sect1>
2814
2815	<sect1 id="vboxmanage-import">
2816
2817	<title>VBoxManage import</title>
2818
2819	<para>
2820	This command imports a virtual appliance in OVF format by copying
2821	the virtual disk images and creating virtual machines in
2822	&product-name;. See <xref linkend="ovf" /> for an introduction to
2823	appliances.
2824	</para>
2825
2826	<para>
2827	The <command>import</command> subcommand takes at least the path
2828	name of an OVF file as input and expects the disk images, if
2829	needed, in the same directory as the OVF file. A lot of additional
2830	command-line options are supported to control in detail what is
2831	being imported and modify the import parameters, but the details
2832	depend on the content of the OVF file.
2833	</para>
2834
2835	<para>
2836	It is therefore recommended to first run the
2837	<command>import</command> subcommand with the
2838	<computeroutput>--dry-run</computeroutput> or
2839	<computeroutput>-n</computeroutput> option. This will then print a
2840	description of the appliance's contents to the screen how it would
2841	be imported into &product-name;, together with the optional
2842	command-line options to influence the import behavior.
2843	</para>
2844
2845	<para>
2846	Use of the <computeroutput>--options
2847	keepallmacs\|keepnatmacs\|keepdisknames</computeroutput> option
2848	enables additional fine tuning of the clone operation. The first
2849	two options enable specification of how the MAC addresses of every
2850	virtual network card should be handled. They can either be
2851	reinitialized, which is the default setting, left unchanged
2852	(<computeroutput>keepallmacs</computeroutput>) or left unchanged
2853	when the network type is NAT
2854	(<computeroutput>keepnatmacs</computeroutput>). If you add
2855	<computeroutput>keepdisknames</computeroutput> all new disk images
2856	are assigned the same names as the originals, otherwise they are
2857	renamed.
2858	</para>
2859
2860	<para>
2861	As an example, the following is a screen output for a sample
2862	appliance containing a Windows XP guest:
2863	</para>
2864
2865	<screen>VBoxManage import WindowsXp.ovf --dry-run
2866	Interpreting WindowsXp.ovf...
2867	OK.
2868	Virtual system 0:
2869	0: Suggested OS type: "WindowsXP"
2870	(change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all)
2871	1: Suggested VM name "Windows XP Professional_1"
2872	(change with "--vsys 0 --vmname <name>")
2873	2: Suggested VM group "/"
2874	(change with "--vsys 0 --group <group>")
2875	3: Suggested VM settings file name "/home/klaus/VirtualBox VMs/dummy2 2/dummy2 2.vbox"
2876	(change with "--vsys 0 --settingsfile <filename>")
2877	4: Suggested VM base folder "/home/klaus/VirtualBox VMs"
2878	(change with "--vsys 0 --basefolder <path>")
2879	5: End-user license agreement
2880	(display with "--vsys 0 --eula show";
2881	accept with "--vsys 0 --eula accept")
2882	6: Number of CPUs: 1
2883	(change with "--vsys 0 --cpus <n>")
2884	7: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>")
2885	8: Sound card (appliance expects "ensoniq1371", can change on import)
2886	(disable with "--vsys 0 --unit 5 --ignore")
2887	9: USB controller
2888	(disable with "--vsys 0 --unit 6 --ignore")
2889	10: Network adapter: orig bridged, config 2, extra type=bridged
2890	11: Floppy
2891	(disable with "--vsys 0 --unit 8 --ignore")
2892	12: SCSI controller, type BusLogic
2893	(change with "--vsys 0 --unit 9 --scsitype {BusLogic\|LsiLogic}";
2894	disable with "--vsys 0 --unit 9 --ignore")
2895	13: IDE controller, type PIIX4
2896	(disable with "--vsys 0 --unit 10 --ignore")
2897	14: Hard disk image: source image=WindowsXp.vmdk,
2898	target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0
2899	(change controller with "--vsys 0 --unit 11 --controller <id>";
2900	disable with "--vsys 0 --unit 11 --ignore")</screen>
2901
2902	<para>
2903	The individual configuration items are numbered, and depending on
2904	their type support different command-line options. The import
2905	subcommand can be directed to ignore many such items with a
2906	<computeroutput>--vsys X --unit Y --ignore</computeroutput>
2907	option, where X is the number of the virtual system and Y the item
2908	number, as printed on the screen. X is zero, unless there are
2909	several virtual system descriptions in the appliance.
2910	</para>
2911
2912	<para>
2913	In the above example, Item #1 specifies the name of the target
2914	machine in &product-name;. Items #9 and #10 specify hard disk
2915	controllers, respectively. Item #11 describes a hard disk image.
2916	In this case, the additional
2917	<computeroutput>--controller</computeroutput> option indicates
2918	which item the disk image should be connected to, with the default
2919	coming from the OVF file.
2920	</para>
2921
2922	<para>
2923	You can combine several items for the same virtual system behind
2924	the same <computeroutput>--vsys</computeroutput> option. For
2925	example, to import a machine as described in the OVF, but without
2926	the sound card and without the USB controller, and with the disk
2927	image connected to the IDE controller instead of the SCSI
2928	controller, use the following command:
2929	</para>
2930
2931	<screen>VBoxManage import WindowsXp.ovf
2932	--vsys 0 --unit 5 --ignore --unit 6 --ignore --unit 11 --controller 10</screen>
2933
2934	</sect1>
2935
2936	<sect1 id="vboxmanage-export">
2937
2938	<title>VBoxManage export</title>
2939
2940	<para>
2941	This command exports one or more virtual machines from
2942	&product-name;. You can export to either of the following:
2943	</para>
2944
2945	<itemizedlist>
2946
2947	<listitem>
2948	<para>
2949	A virtual appliance in OVF format, including copying their
2950	virtual disk images to compressed VMDK.
2951	</para>
2952	</listitem>
2953
2954	<listitem>
2955	<para>
2956	A cloud service, such as &oci;. A single VM can be exported in
2957	VMDK format.
2958	</para>
2959	</listitem>
2960
2961	</itemizedlist>
2962
2963	<para>
2964	See <xref linkend="ovf" /> for more details on exporting VMs from
2965	&product-name;.
2966	</para>
2967
2968	<sect2 id="vboxmanage-export-ovf">
2969
2970	<title>Export to OVF</title>
2971
2972	<para>
2973	List the machine, or the machines, that you would like to export
2974	to the same OVF file and specify the target OVF file after an
2975	additional <computeroutput>--output</computeroutput> or
2976	<computeroutput>-o</computeroutput> option. Note that the
2977	directory of the target OVF file will also receive the exported
2978	disk images in the compressed VMDK format, regardless of the
2979	original format, and should have enough disk space left for
2980	them.
2981	</para>
2982
2983	<para>
2984	Beside a simple export of a given virtual machine, you can
2985	append several product information to the appliance file. Use
2986	<computeroutput>--product</computeroutput>,
2987	<computeroutput>--producturl</computeroutput>,
2988	<computeroutput>--vendor</computeroutput>,
2989	<computeroutput>--vendorurl</computeroutput>,
2990	<computeroutput>--version</computeroutput> and
2991	<computeroutput>--description</computeroutput> to specify this
2992	additional information. For legal reasons you may add a license
2993	text or the content of a license file by using the
2994	<computeroutput>--eula</computeroutput> and
2995	<computeroutput>--eulafile</computeroutput> option respectively.
2996	</para>
2997
2998	<para>
2999	As with OVF import, you use the <computeroutput>--vsys
3000	X</computeroutput> option to apply these options to the correct
3001	virtual machine.
3002	</para>
3003
3004	<para>
3005	For virtualization products which are not fully compatible with
3006	the OVF standard 1.0 you can enable an OVF 0.9 legacy mode with
3007	the <computeroutput>--legacy09</computeroutput> option. Other
3008	options are <computeroutput>--ovf09</computeroutput>,
3009	<computeroutput>--ovf10</computeroutput>,
3010	<computeroutput>--ovf20</computeroutput>.
3011	</para>
3012
3013	<para>
3014	To specify options controlling the exact content of the
3015	appliance file, you can use <option>--options</option> to
3016	request the creation of a manifest file, which enables detection
3017	of corrupted appliances on import, the additional export of DVD
3018	images, and the exclusion of MAC addresses. You can specify a
3019	list of options, such as <option>--options
3020	manifest,nomacs</option>. For details, check the help output of
3021	<command>VBoxManage export</command>.
3022	</para>
3023
3024	</sect2>
3025
3026	<sect2 id="vboxmanage-export-cloud">
3027
3028	<title>Export to &oci;</title>
3029
3030	<para>
3031	By default, an exported disk image is converted into stream VMDK
3032	format. This ensures compatibility with &oci;.
3033	</para>
3034
3035	<para>
3036	List the machine that you want to export to &oci; and specify
3037	the target cloud service provider by using the
3038	<computeroutput>--output</computeroutput> or
3039	<computeroutput>-o</computeroutput> option.
3040	</para>
3041
3042	<para>
3043	To export a VM to a cloud service such as &oci;, use the
3044	<option>--cloud</option> option to specify the VM to export.
3045	This option works in the same way as the <option>--vsys</option>
3046	option for OVF export.
3047	</para>
3048
3049	<para>
3050	Some of the following options are settings for the VM instance.
3051	As a result, you must enter an Oracle Cloud Identifier (OCID)
3052	for a resource. Use the &oci; Console to view OCIDs.
3053	</para>
3054
3055	<itemizedlist>
3056
3057	<listitem>
3058	<para>
3059	<option>--output/-o</option>: Specifies the short name of
3060	the cloud service provider to which you export. For &oci;,
3061	enter <computeroutput>OCI://</computeroutput>.
3062	</para>
3063	</listitem>
3064
3065	<listitem>
3066	<para>
3067	<option>--cloud</option>
3068	<replaceable>number-of-virtual-system</replaceable>:
3069	Specifies a number that identifies the VM that you are
3070	exporting. Numbering starts at
3071	<computeroutput>0</computeroutput> for the first VM.
3072	</para>
3073	</listitem>
3074
3075	<listitem>
3076	<para>
3077	<option>--vmname</option> <replaceable>name</replaceable>:
3078	Specifies the name of the exported VM. This name is used as
3079	the VM instance name in &oci;.
3080	</para>
3081	</listitem>
3082
3083	<listitem>
3084	<para>
3085	<option>--cloudprofile</option>
3086	<replaceable>cloud-profile-name</replaceable>: Specifies the
3087	cloud profile that is used to connect to the cloud service
3088	provider. The cloud profile contains your &oci; account
3089	details, such as your user OCID and the fingerprint for your
3090	public key. See <xref linkend="ovf-export-oci"/>.
3091	</para>
3092
3093	<para>
3094	To use a cloud profile, you must have the required
3095	permissions on &oci;.
3096	</para>
3097
3098	<remark>
3099	Add xref to information about the required permissions.
3100	</remark>
3101	</listitem>
3102
3103	<listitem>
3104	<para>
3105	<option>--cloudshape</option>
3106	<replaceable>shape</replaceable>: Specifies the shape used
3107	for the VM instance. The shape defines the number of CPUs
3108	and the amount of memory allocated to the VM instance. The
3109	shape must be compatible with the exported image.
3110	</para>
3111	</listitem>
3112
3113	<listitem>
3114	<para>
3115	<option>--clouddomain</option>
3116	<replaceable>domain</replaceable>: Specifies the
3117	availability domain to use for the VM instance. Enter the
3118	OCID for the availability domain.
3119	</para>
3120	</listitem>
3121
3122	<listitem>
3123	<para>
3124	<option>--clouddisksize</option>
3125	<replaceable>disk-size-in-GB</replaceable>: Specifies the
3126	disk size used for the exported disk image in gigabytes. The
3127	minimum value is 50 GB and the maximum value is 300 GB.
3128	</para>
3129	</listitem>
3130
3131	<listitem>
3132	<para>
3133	<option>--cloudbucket</option>
3134	<replaceable>bucket-name</replaceable>: Specifies the bucket
3135	in which to store the uploaded files. In &oci;, a bucket is
3136	a logical container for storing objects.
3137	</para>
3138	</listitem>
3139
3140	<listitem>
3141	<para>
3142	<option>--cloudocivcn</option>
3143	<replaceable>OCI-vcn-ID</replaceable>: Specifies the virtual
3144	cloud network (VCN) to use for the VM instance. Enter the
3145	OCID for the VCN.
3146	</para>
3147	</listitem>
3148
3149	<listitem>
3150	<para>
3151	<option>--cloudocisubnet</option>
3152	<replaceable>OCI-subnet-ID</replaceable>: Specifies the
3153	subnet of the VCN to use for the VM instance. Enter the OCID
3154	for the subnet.
3155	</para>
3156	</listitem>
3157
3158	<listitem>
3159	<para>
3160	<option>--cloudkeepobject true \| false</option>: Specifies
3161	whether to store the exported disk image in Oracle Object
3162	Storage.
3163	</para>
3164	</listitem>
3165
3166	<listitem>
3167	<para>
3168	<option>--cloudlaunchinstance true \| false</option>:
3169	Specifies whether to start the VM instance after the export
3170	to &oci; completes.
3171	</para>
3172	</listitem>
3173
3174	<listitem>
3175	<para>
3176	<option>--cloudpublicip true \| false</option>: Specifies
3177	whether to enable a public IP address for the VM instance.
3178	</para>
3179	</listitem>
3180
3181	</itemizedlist>
3182
3183	<para>
3184	The following example shows a typical command line for exporting
3185	a VM to &oci;.
3186	</para>
3187
3188	<remark>
3189	For the next release, describe exactly what this command does in
3190	terms of the command line options.
3191	</remark>
3192
3193	<screen># VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \
3194	--cloudprofile "standard user" --cloudbucket myBucket \
3195	--cloudshape VM.Standard2.1 --clouddomain aaaa:US-ASHBURN-AD-1 --clouddisksize 50 \
3196	--cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \
3197	--cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true</screen>
3198
3199	</sect2>
3200
3201	</sect1>
3202
3203	<sect1 id="vboxmanage-startvm">
3204
3205	<title>VBoxManage startvm</title>
3206
3207	<para>
3208	This command starts a virtual machine that is currently in the
3209	Powered Off or Saved states.
3210	</para>
3211
3212	<para>
3213	The optional <computeroutput>--type</computeroutput> specifier
3214	determines whether the machine will be started in a window or
3215	whether the output should go through
3216	<command>VBoxHeadless</command>, with VRDE enabled or not. See
3217	<xref linkend="vboxheadless" />. The list of types is subject to
3218	change, and it is not guaranteed that all types are accepted by
3219	any product variant.
3220	</para>
3221
3222	<para>
3223	The global or per-VM default value for the VM frontend type will
3224	be taken if the type is not explicitly specified. If none of these
3225	are set, the GUI variant will be started.
3226	</para>
3227
3228	<para>
3229	The following values are allowed:
3230	</para>
3231
3232	<variablelist>
3233
3234	<varlistentry>
3235	<term>
3236	<computeroutput>gui</computeroutput>
3237	</term>
3238
3239	<listitem>
3240	<para>
3241	Starts a VM showing a GUI window. This is the default.
3242	</para>
3243	</listitem>
3244	</varlistentry>
3245
3246	<varlistentry>
3247	<term>
3248	<computeroutput>headless</computeroutput>
3249	</term>
3250
3251	<listitem>
3252	<para>
3253	Starts a VM without a window for remote display only.
3254	</para>
3255	</listitem>
3256	</varlistentry>
3257
3258	<varlistentry>
3259	<term>
3260	<computeroutput>separate</computeroutput>
3261	</term>
3262
3263	<listitem>
3264	<para>
3265	Starts a VM with a detachable UI. Technically, it is a
3266	headless VM with user interface in a separate process. This
3267	is an experimental feature as it lacks certain
3268	functionality, such as 3D acceleration.
3269	</para>
3270	</listitem>
3271	</varlistentry>
3272
3273	</variablelist>
3274
3275	<note>
3276	<para>
3277	If you experience problems with starting virtual machines with
3278	particular frontends and there is no conclusive error
3279	information, consider starting virtual machines directly by
3280	running the respective front-end, as this can give additional
3281	error information.
3282	</para>
3283	</note>
3284
3285	</sect1>
3286
3287	<sect1 id="vboxmanage-controlvm">
3288
3289	<title>VBoxManage controlvm</title>
3290
3291	<para>
3292	The <command>controlvm</command> subcommand enables you to change
3293	the state of a virtual machine that is currently running. The
3294	following can be specified:
3295	</para>
3296
3297	<itemizedlist>
3298
3299	<listitem>
3300	<para>
3301	<command>VBoxManage controlvm <vm> pause</command>:
3302	Temporarily puts a virtual machine on hold, without
3303	permanently changing its state. The VM window is gray, to
3304	indicate that the VM is currently paused. This is equivalent
3305	to selecting the <emphasis role="bold">Pause</emphasis> item
3306	in the <emphasis role="bold">Machine</emphasis> menu of the
3307	GUI.
3308	</para>
3309	</listitem>
3310
3311	<listitem>
3312	<para>
3313	Use <command>VBoxManage controlvm <vm> resume</command>:
3314	Undoes a previous <command>pause</command> command. This is
3315	equivalent to selecting the
3316	<emphasis role="bold">Resume</emphasis> item in the
3317	<emphasis role="bold">Machine</emphasis> menu of the GUI.
3318	</para>
3319	</listitem>
3320
3321	<listitem>
3322	<para>
3323	<command>VBoxManage controlvm <vm> reset</command>: Has
3324	the same effect on a virtual machine as pressing the Reset
3325	button on a real computer. A cold reboot of the virtual
3326	machine is done, which immediately restarts and reboots the
3327	guest operating system. The state of the VM is not saved
3328	beforehand, and data may be lost. This is equivalent to
3329	selecting the <emphasis role="bold">Reset</emphasis> item in
3330	the <emphasis role="bold">Machine</emphasis> menu of the GUI.
3331	</para>
3332	</listitem>
3333
3334	<listitem>
3335	<para>
3336	<command>VBoxManage controlvm <vm> poweroff</command>:
3337	Has the same effect on a virtual machine as pulling the power
3338	cable on a real computer. The state of the VM is not saved
3339	beforehand, and data may be lost. This is equivalent to
3340	selecting the <emphasis role="bold">Close</emphasis> item in
3341	the <emphasis role="bold">Machine</emphasis> menu of the GUI,
3342	or clicking the VM window's close button, and then selecting
3343	<emphasis role="bold">Power Off the Machine</emphasis> in the
3344	displayed dialog.
3345	</para>
3346
3347	<para>
3348	After this, the VM's state will be Powered Off. From that
3349	state, it can be started again. See
3350	<xref
3351	linkend="vboxmanage-startvm" />.
3352	</para>
3353	</listitem>
3354
3355	<listitem>
3356	<para>
3357	<command>VBoxManage controlvm <vm> savestate</command>:
3358	Saves the current state of the VM to disk and then stops the
3359	VM. This is equivalent to selecting the
3360	<emphasis role="bold">Close</emphasis> item in the
3361	<emphasis role="bold">Machine</emphasis> menu of the GUI or
3362	clicking the VM window's close button, and then selecting
3363	<emphasis role="bold">Save the Machine State</emphasis> in the
3364	displayed dialog.
3365	</para>
3366
3367	<para>
3368	After this, the VM's state will be Saved. From this state, it
3369	can be started again. See
3370	<xref linkend="vboxmanage-startvm" />.
3371	</para>
3372	</listitem>
3373
3374	<listitem>
3375	<para>
3376	<command>VBoxManage controlvm <vm>
3377	acpipowerbutton</command>: Sends an ACPI shutdown signal to
3378	the VM, as if the power button on a real computer had been
3379	pressed. So long as the VM is running a fairly modern guest
3380	operating system providing ACPI support, this should trigger a
3381	proper shutdown mechanism from within the VM.
3382	</para>
3383	</listitem>
3384
3385	<listitem>
3386	<para>
3387	<command>VBoxManage controlvm <vm> keyboardputscancode
3388	<hex> [<hex>...]</command>: Sends commands using
3389	keycodes to the VM. Keycodes are documented in the public
3390	domain. For example:
3391	http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html.
3392	</para>
3393	</listitem>
3394
3395	<listitem>
3396	<para>
3397	<command>VBoxManage controlvm "VM name" teleport --hostname
3398	<name> --port <port> [--passwordfile <file>
3399	\| --password <password>]</command>: Makes the machine
3400	the source of a teleporting operation and initiates a teleport
3401	to the given target. See <xref linkend="teleporting" />. If
3402	the optional password is specified, it must match the password
3403	that was given to the <command>modifyvm</command> command for
3404	the target machine. See
3405	<xref linkend="vboxmanage-modifyvm-teleport" />.
3406	</para>
3407	</listitem>
3408
3409	</itemizedlist>
3410
3411	<para>
3412	The following extra options are available with
3413	<command>controlvm</command> that do not directly affect the VM's
3414	running state:
3415	</para>
3416
3417	<itemizedlist>
3418
3419	<listitem>
3420	<para>
3421	<computeroutput>setlinkstate<1-N></computeroutput>:
3422	Connects or disconnects virtual network cables from their
3423	network interfaces.
3424	</para>
3425	</listitem>
3426
3427	<listitem>
3428	<para>
3429	<computeroutput>nic<1-N>
3430	null\|nat\|bridged\|intnet\|hostonly\|generic\|natnetwork[<devicename>]</computeroutput>:
3431	Specifies the type of networking that should be made available
3432	on the specified VM virtual network card. They available types
3433	are: not connected to the host
3434	(<computeroutput>null</computeroutput>), use network address
3435	translation (<computeroutput>nat</computeroutput>), bridged
3436	networking (<computeroutput>bridged</computeroutput>),
3437	communicate with other virtual machines using internal
3438	networking (<computeroutput>intnet</computeroutput>),
3439	host-only networking
3440	(<computeroutput>hostonly</computeroutput>), natnetwork
3441	networking (<computeroutput>natnetwork</computeroutput>), or
3442	access to rarely used submodes
3443	(<computeroutput>generic</computeroutput>). These options
3444	correspond to the modes which are described in detail in
3445	<xref
3446	linkend="networkingmodes" />.
3447	</para>
3448	</listitem>
3449
3450	<listitem>
3451	<para>
3452	With the <computeroutput>nictrace</computeroutput> options,
3453	you can optionally trace network traffic by dumping it to a
3454	file, for debugging purposes.
3455	</para>
3456
3457	<para>
3458	<computeroutput>nictrace<1-N> on\|off</computeroutput>:
3459	Enables network tracing for a particular virtual network card.
3460	</para>
3461
3462	<para>
3463	If enabled, you must specify with
3464	<computeroutput>--nictracefile<1-N>
3465	<filename></computeroutput> the pathname of the file to
3466	which the trace should be logged.
3467	</para>
3468	</listitem>
3469
3470	<listitem>
3471	<para>
3472	<computeroutput>nicpromisc<1-N>
3473	deny\|allow-vms\|allow-all</computeroutput>: Specifies how the
3474	promiscious mode is handled for the specified VM virtual
3475	network card. This setting is only relevant for bridged
3476	networking. The default setting of
3477	<computeroutput>deny</computeroutput> hides any traffic not
3478	intended for this VM.
3479	<computeroutput>allow-vms</computeroutput> hides all host
3480	traffic from this VM but enables the VM to see traffic to and
3481	from other VMs. <computeroutput>allow-all</computeroutput>
3482	removes this restriction completely.
3483	</para>
3484	</listitem>
3485
3486	<listitem>
3487	<para>
3488	<computeroutput>nicproperty<1-N>
3489	<paramname>="paramvalue"</computeroutput>: This option,
3490	in combination with
3491	<computeroutput>nicgenericdrv</computeroutput> enables you to
3492	pass parameters to rarely-used network backends.
3493	</para>
3494
3495	<para>
3496	Those parameters are backend engine-specific, and are
3497	different between UDP Tunnel and the VDE backend drivers. See
3498	<xref linkend="network_udp_tunnel" />.
3499	</para>
3500	</listitem>
3501
3502	<listitem>
3503	<para>
3504	<computeroutput>natpf<1-N>
3505	[<name>],tcp\|udp,[<hostip>],<hostport>,[<guestip>],
3506	<guestport></computeroutput>: Specifies a NAT
3507	port-forwarding rule. See <xref linkend="natforward"/>.
3508	</para>
3509	</listitem>
3510
3511	<listitem>
3512	<para>
3513	<computeroutput>natpf<1-N> delete
3514	<name></computeroutput>: Deletes a NAT port-forwarding
3515	rule. See <xref linkend="natforward"/>.
3516	</para>
3517	</listitem>
3518
3519	<listitem>
3520	<para>
3521	The <computeroutput>guestmemoryballoon<balloon size in
3522	MB></computeroutput>: Changes the size of the guest memory
3523	balloon. This is the memory allocated by the &product-name;
3524	Guest Additions from the guest operating system and returned
3525	to the hypervisor for reuse by other virtual machines. This
3526	must be specified in megabytes. See
3527	<xref linkend="guestadd-balloon" />.
3528	</para>
3529	</listitem>
3530
3531	<listitem>
3532	<para>
3533	<computeroutput>usbattach<uuid\|address> [--capturefile
3534	<filename>]</computeroutput>
3535	</para>
3536
3537	<para>
3538	and <computeroutput>usbdetach <uuid\|address>
3539	[--capturefile <filename>]</computeroutput>: Makes host
3540	USB devices visible or invisible to the virtual machine on the
3541	fly, without the need for creating filters first. The USB
3542	devices can be specified by UUID (unique identifier) or by
3543	address on the host system. Use the
3544	<computeroutput>--capturefile</computeroutput> option to
3545	specify the absolute path of a file for writing activity
3546	logging data.
3547	</para>
3548
3549	<para>
3550	You can use <command>VBoxManage list usbhost</command> to
3551	locate this information.
3552	</para>
3553	</listitem>
3554
3555	<listitem>
3556	<para>
3557	<computeroutput>audioin on</computeroutput>: Selects whether
3558	capturing audio from the host is enabled or disabled.
3559	</para>
3560	</listitem>
3561
3562	<listitem>
3563	<para>
3564	<computeroutput>audioout on</computeroutput>: Selects whether
3565	audio playback from the guest is enabled or disabled.
3566	</para>
3567	</listitem>
3568
3569	<listitem>
3570	<para>
3571	<computeroutput>clipboard
3572	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
3573	Selects how the guest or host operating system's clipboard
3574	should be shared with the host or guest. See
3575	<xref linkend="generalsettings" />. This requires that the
3576	Guest Additions be installed in the virtual machine.
3577	</para>
3578	</listitem>
3579
3580	<listitem>
3581	<para>
3582	<computeroutput>draganddrop
3583	disabled\|hosttoguest\|guesttohost\|bidirectional</computeroutput>:
3584	Selects the current drag and drop mode being used between the
3585	host and the virtual machine. See
3586	<xref linkend="guestadd-dnd" />. This requires that the Guest
3587	Additions be installed in the virtual machine.
3588	</para>
3589	</listitem>
3590
3591	<listitem>
3592	<para>
3593	<computeroutput>vrde on\|off</computeroutput>: Enables and
3594	disables the VRDE server, if it is installed.
3595	</para>
3596	</listitem>
3597
3598	<listitem>
3599	<para>
3600	<computeroutput>vrdeport
3601	default\|<ports></computeroutput>: Changes the port or a
3602	range of ports that the VRDE server can bind to.
3603	<computeroutput>default</computeroutput> or
3604	<computeroutput>0</computeroutput> means port 3389, the
3605	standard port for RDP. See the description for the
3606	<computeroutput>--vrdeport</computeroutput> option in
3607	<xref
3608	linkend="vboxmanage-modifyvm-vrde" />.
3609	</para>
3610	</listitem>
3611
3612	<listitem>
3613	<para>
3614	<computeroutput>vrdeproperty
3615	"TCP/Ports\|Address=<value>"</computeroutput>: Sets the
3616	port numbers and IP address on the VM to which the VRDE server
3617	can bind.
3618	</para>
3619
3620	<itemizedlist>
3621
3622	<listitem>
3623	<para>
3624	For TCP/Ports, <value> should be a port or a range
3625	of ports to which the VRDE server can bind.
3626	<computeroutput>default</computeroutput> or
3627	<computeroutput>0</computeroutput> means port 3389, the
3628	standard port for RDP. See the description for the
3629	<computeroutput>--vrdeport</computeroutput> option in
3630	<xref
3631	linkend="vboxmanage-modifyvm-vrde" />.
3632	</para>
3633	</listitem>
3634
3635	<listitem>
3636	<para>
3637	For TCP/Address, <value>: The IP address of the host
3638	network interface that the VRDE server will bind to. If
3639	specified, the server will accept connections only on the
3640	specified host network interface. See the description for
3641	the <computeroutput>--vrdeaddress</computeroutput> option
3642	in
3643	<xref
3644	linkend="vboxmanage-modifyvm-vrde" />.
3645	</para>
3646	</listitem>
3647
3648	</itemizedlist>
3649	</listitem>
3650
3651	<listitem>
3652	<para>
3653	<computeroutput>vrdeproperty
3654	"VideoChannel/Enabled\|Quality\|DownscaleProtection=<value>"</computeroutput>:
3655	Sets the VRDP video redirection properties.
3656	</para>
3657
3658	<itemizedlist>
3659
3660	<listitem>
3661	<para>
3662	For VideoChannel/Enabled, <value> can be set to "1"
3663	switching the VRDP video channel on. See
3664	<xref linkend="vrde-videochannel" />.
3665	</para>
3666	</listitem>
3667
3668	<listitem>
3669	<para>
3670	For VideoChannel/Quality, <value> should be set
3671	between 10 and 100% inclusive, representing a JPEG
3672	compression level on the VRDE server video channel. Lower
3673	values mean lower quality but higher compression. See
3674	<xref linkend="vrde-videochannel" />.
3675	</para>
3676	</listitem>
3677
3678	<listitem>
3679	<para>
3680	For VideoChannel/DownscaleProtection, <value> can be
3681	set to "1" to enable the videochannel downscale protection
3682	feature. When enabled, if a video's size equals the shadow
3683	buffer size, then it is regarded as a full screen video,
3684	and is displayed. If its size is between fullscreen and
3685	the downscale threshold it is not displayed, as it could
3686	be an application window, which would be unreadable when
3687	downscaled. When the downscale protection feature is
3688	disabled, an attempt is always made to display videos.
3689	</para>
3690	</listitem>
3691
3692	</itemizedlist>
3693	</listitem>
3694
3695	<listitem>
3696	<para>
3697	<computeroutput>vrdeproperty
3698	"Client/DisableDisplay\|DisableInput\|DisableAudio\|DisableUSB=1"</computeroutput>:
3699	Disables one of the VRDE server features: Display, Input,
3700	Audio, or USB. To reenable a feature, use
3701	"Client/DisableDisplay=" for example. See
3702	<xref linkend="vrde-customization" />.
3703	</para>
3704	</listitem>
3705
3706	<listitem>
3707	<para>
3708	<computeroutput>vrdeproperty
3709	"Client/DisableClipboard\|DisableUpstreamAudio=1"</computeroutput>.
3710	Disables one of the VRDE server features: Clipboard or
3711	UpstreamAudio. To reenable a feature, use
3712	"Client/DisableClipboard=" for example. See
3713	<xref linkend="vrde-customization" />.
3714	</para>
3715	</listitem>
3716
3717	<listitem>
3718	<para>
3719	<computeroutput>vrdeproperty
3720	"Client/DisableRDPDR=1"</computeroutput>: Disables the VRDE
3721	server feature: RDP device redirection for smart cards. To
3722	reenable this feature, use "Client/DisableRDPR=".
3723	</para>
3724	</listitem>
3725
3726	<listitem>
3727	<para>
3728	<computeroutput>vrdeproperty
3729	"H3DRedirect/Enabled=1"</computeroutput>: Enables the VRDE
3730	server feature: 3D redirection. To disable this feature, use
3731	"H3DRedirect/Enabled=".
3732	</para>
3733	</listitem>
3734
3735	<listitem>
3736	<para>
3737	<computeroutput>vrdeproperty
3738	"Security/Method\|ServerCertificate\|ServerPrivateKey\|CACertificate=<value>"</computeroutput>:
3739	Sets the desired security method, path of the server
3740	certificate, path of the server private key, and path of CA
3741	certificate, used for a connection.
3742	</para>
3743
3744	<itemizedlist>
3745
3746	<listitem>
3747	<para>
3748	<computeroutput>vrdeproperty
3749	"Security/Method=<value>"</computeroutput>: Sets the
3750	desired security method, which is used for a connection.
3751	Valid values are as follows:
3752	</para>
3753
3754	<itemizedlist>
3755
3756	<listitem>
3757	<para>
3758	<computeroutput>Negotiate</computeroutput>: Both
3759	Enhanced (TLS) and Standard RDP Security connections
3760	are allowed. The security method is negotiated with
3761	the client. This is the default setting.
3762	</para>
3763	</listitem>
3764
3765	<listitem>
3766	<para>
3767	<computeroutput>RDP</computeroutput>: Only Standard
3768	RDP Security is accepted.
3769	</para>
3770	</listitem>
3771
3772	<listitem>
3773	<para>
3774	<computeroutput>TLS</computeroutput>: Only Enhanced
3775	RDP Security is accepted. The client must support TLS.
3776	</para>
3777	</listitem>
3778
3779	</itemizedlist>
3780
3781	<para>
3782	See <xref linkend="vrde-crypt" />.
3783	</para>
3784	</listitem>
3785
3786	<listitem>
3787	<para>
3788	<computeroutput>vrdeproperty
3789	"Security/ServerCertificate=<value>"</computeroutput>
3790	where <value> is the absolute path of the server
3791	certificate. See <xref linkend="vrde-crypt" />.
3792	</para>
3793	</listitem>
3794
3795	<listitem>
3796	<para>
3797	<computeroutput>vrdeproperty
3798	"Security/ServerPrivateKey=<value>"</computeroutput>
3799	where <value> is the absolute path of the server
3800	private key. See <xref linkend="vrde-crypt" />.
3801	</para>
3802	</listitem>
3803
3804	<listitem>
3805	<para>
3806	<computeroutput>vrdeproperty
3807	"Security/CACertificate=<value>"</computeroutput>
3808	where <value> is the absolute path of the CA self
3809	signed certificate. See <xref linkend="vrde-crypt" />.
3810	</para>
3811	</listitem>
3812
3813	</itemizedlist>
3814	</listitem>
3815
3816	<listitem>
3817	<para>
3818	<computeroutput>vrdeproperty
3819	"Audio/RateCorrectionMode\|LogPath=<value>"</computeroutput>:
3820	Sets the audio connection mode, or path of the audio logfile.
3821	</para>
3822
3823	<itemizedlist>
3824
3825	<listitem>
3826	<para>
3827	<computeroutput>vrdeproperty
3828	"Audio/RateCorrectionMode=<value>"</computeroutput>
3829	where <value> is the desired rate correction mode,
3830	allowed values are:
3831	</para>
3832
3833	<itemizedlist>
3834
3835	<listitem>
3836	<para>
3837	<computeroutput>VRDP_AUDIO_MODE_VOID</computeroutput>:
3838	No mode specified, use to unset any Audio mode already
3839	set.
3840	</para>
3841	</listitem>
3842
3843	<listitem>
3844	<para>
3845	<computeroutput>VRDP_AUDIO_MODE_RC</computeroutput>:
3846	Rate correction mode.
3847	</para>
3848	</listitem>
3849
3850	<listitem>
3851	<para>
3852	<computeroutput>VRDP_AUDIO_MODE_LPF</computeroutput>:
3853	Low pass filter mode.
3854	</para>
3855	</listitem>
3856
3857	<listitem>
3858	<para>
3859	<computeroutput>VRDP_AUDIO_MODE_CS</computeroutput>:
3860	Client sync mode to prevent underflow or overflow of
3861	the client queue.
3862	</para>
3863	</listitem>
3864
3865	</itemizedlist>
3866	</listitem>
3867
3868	<listitem>
3869	<para>
3870	<computeroutput>vrdeproperty
3871	"Audio/LogPath=<value>"</computeroutput> where
3872	<value> is the absolute path of the audio log file.
3873	</para>
3874	</listitem>
3875
3876	</itemizedlist>
3877	</listitem>
3878
3879	<listitem>
3880	<para>
3881	<computeroutput>vrdevideochannelquality
3882	<percent></computeroutput>: Sets the image quality for
3883	video redirection. See <xref linkend="vrde-videochannel" />.
3884	</para>
3885	</listitem>
3886
3887	<listitem>
3888	<para>
3889	<computeroutput>setvideomodehint</computeroutput>: Requests
3890	that the guest system change to a particular video mode. This
3891	requires that the Guest Additions be installed, and will not
3892	work for all guest systems.
3893	</para>
3894	</listitem>
3895
3896	<listitem>
3897	<para>
3898	<computeroutput>screenshotpng</computeroutput>: Takes a
3899	screenshot of the guest display and saves it in PNG format.
3900	</para>
3901	</listitem>
3902
3903	<listitem>
3904	<para>
3905	<computeroutput>recording on\|off</computeroutput> enables or
3906	disables the recording of a VM session into a WebM/VP8 file.
3907	When this option value is <computeroutput>on</computeroutput>,
3908	recording begins when the VM session starts.
3909	</para>
3910	</listitem>
3911
3912	<listitem>
3913	<para>
3914	<computeroutput>recordingscreens
3915	all\|<replaceable>screen-ID</replaceable>
3916	[<replaceable>screen-ID</replaceable> ...]</computeroutput>
3917	enables you to specify which VM screens to record. The
3918	recording for each screen that you specify is saved to its own
3919	file. You cannot modify this setting while recording is
3920	enabled.
3921	</para>
3922	</listitem>
3923
3924	<listitem>
3925	<para>
3926	<computeroutput>recordingfile
3927	<replaceable>filename</replaceable></computeroutput> specifies
3928	the file in which to save the recording. You cannot modify
3929	this setting while recording is enabled.
3930	</para>
3931	</listitem>
3932
3933	<listitem>
3934	<para>
3935	<computeroutput>recordingvideores
3936	<replaceable>width</replaceable>x<replaceable>height</replaceable></computeroutput>
3937	specifies the resolution of the recorded video in pixels. You
3938	cannot modify this setting while recording is enabled.
3939	</para>
3940	</listitem>
3941
3942	<listitem>
3943	<!-- @todo r=andy Clarify rate. -->
3944
3945	<para>
3946	<computeroutput>recordingvideorate
3947	<replaceable>bit-rate</replaceable></computeroutput> specifies
3948	the bit rate of the video in kilobits per second. Increasing
3949	this value improves the appearance of the video at the cost of
3950	an increased file size. You cannot modify this setting while
3951	recording is enabled.
3952	</para>
3953	</listitem>
3954
3955	<listitem>
3956	<para>
3957	<computeroutput>recordingvideofps
3958	<replaceable>fps</replaceable></computeroutput> specifies the
3959	maximum number of video frames per second (FPS) to record.
3960	Frames that have a higher frequency are skipped. Increasing
3961	this value reduces the number of skipped frames and increases
3962	the file size. You cannot modify this setting while recording
3963	is enabled.
3964	</para>
3965	</listitem>
3966
3967	<listitem>
3968	<!-- @todo r=andy Clarify time format. -->
3969
3970	<para>
3971	<computeroutput>recordingmaxtime
3972	<replaceable>seconds</replaceable></computeroutput> specifies
3973	the maximum amount time to record in seconds. The recording
3974	stops after the specified number of seconds elapses. If this
3975	value is zero, the recording continues until you stop the
3976	recording.
3977	</para>
3978	</listitem>
3979
3980	<listitem>
3981	<para>
3982	<computeroutput>recordingmaxsize
3983	<replaceable>MB</replaceable></computeroutput> specifies the
3984	maximum size of the recorded video file in megabytes. The
3985	recording stops when the file reaches the specified size. If
3986	this value is zero, the recording continues until you stop the
3987	recording. You cannot modify this setting while recording is
3988	enabled.
3989	</para>
3990	</listitem>
3991
3992	<listitem>
3993	<para>
3994	<computeroutput>recordingopts
3995	<replaceable>keyword</replaceable>=<replaceable>value</replaceable>[,<replaceable>keyword</replaceable>=<replaceable>value</replaceable>
3996	...]</computeroutput> specifies additional recording options
3997	in a comma-separated keyword-value format. For example,
3998	<computeroutput>foo=bar,a=b</computeroutput>. You cannot
3999	modify this setting while recording is enabled.
4000	</para>
4001
4002	<para>
4003	Only use this option only if you are an advanced user. For
4004	information about keywords, see <emphasis>Oracle VM VirtualBox
4005	Programming Guide and Reference</emphasis>.
4006	</para>
4007	</listitem>
4008
4009	<listitem>
4010	<para>
4011	<computeroutput>setcredentials</computeroutput>: Used for
4012	remote logins on Windows guests. See
4013	<xref linkend="autologon" />.
4014	</para>
4015	</listitem>
4016
4017	<listitem>
4018	<para>
4019	<computeroutput>teleport --host <name> --port
4020	<port></computeroutput>: Configures a VM as a target for
4021	teleporting. <name> specifies the virtual machine name.
4022	<port> specifies the port on the virtual machine which
4023	should listen for teleporting requests from other virtual
4024	machines. It can be any free TCP/IP port number, such as 6000.
4025	See <xref linkend="teleporting" />.
4026	</para>
4027
4028	<itemizedlist>
4029
4030	<listitem>
4031	<para>
4032	<computeroutput>--maxdowntime
4033	<msec></computeroutput>: Specifies the maximum
4034	downtime, in milliseconds, for the teleporting target VM.
4035	Optional.
4036	</para>
4037	</listitem>
4038
4039	<listitem>
4040	<para>
4041	<computeroutput>--password
4042	<password></computeroutput>: The teleporting request
4043	will only succeed if the source machine specifies the same
4044	password as the one given with this command. Optional.
4045	</para>
4046	</listitem>
4047
4048	<listitem>
4049	<para>
4050	<computeroutput>--passwordfile <password
4051	file></computeroutput>: The teleporting request will
4052	only succeed if the source machine specifies the same
4053	password as the one specified in the password file with
4054	the path specified with this command. Use
4055	<computeroutput>stdin</computeroutput> to read the
4056	password from stdin. Optional.
4057	</para>
4058	</listitem>
4059
4060	</itemizedlist>
4061	</listitem>
4062
4063	<listitem>
4064	<para>
4065	<computeroutput>plugcpu\|unplugcpu <id></computeroutput>:
4066	If CPU hot-plugging is enabled, this setting adds and removes
4067	a virtual CPU to the virtual machine.
4068	<computeroutput><id></computeroutput> specifies the
4069	index of the virtual CPU to be added or removed and must be a
4070	number from 0 to the maximum number of CPUs configured. CPU 0
4071	can never be removed.
4072	</para>
4073	</listitem>
4074
4075	<listitem>
4076	<para>
4077	The <computeroutput>cpuexecutioncap
4078	<1-100></computeroutput>: Controls how much CPU time a
4079	virtual CPU can use. A value of 50 implies a single virtual
4080	CPU can use up to 50% of a single host CPU.
4081	</para>
4082	</listitem>
4083
4084	<listitem>
4085	<para>
4086	<computeroutput>webcam attach <path\|alias>
4087	[<keyword=value>[;<keyword=value>...]]</computeroutput>:
4088	Attaches a webcam to a running VM. Specify the absolute path
4089	of the webcam on the host operating system, or use its alias,
4090	obtained by using the command: <command>VBoxManage list
4091	webcams</command>.
4092	</para>
4093
4094	<para>
4095	Note that alias '.0' means the default video input device on
4096	the host operating system, '.1', '.2', etc. mean first,
4097	second, etc. video input device. The device order is
4098	host-specific.
4099	</para>
4100
4101	<para>
4102	The optional settings parameter is a
4103	<computeroutput>;</computeroutput> delimited list of
4104	name-value pairs, enabling configuration of the emulated
4105	webcam device.
4106	</para>
4107
4108	<para>
4109	The following settings are supported:
4110	</para>
4111
4112	<para>
4113	MaxFramerate: Specifies the highest rate in frames per second,
4114	at which video frames are sent to the guest. Higher frame
4115	rates increase CPU load, so this setting can be useful when
4116	there is a need to reduce CPU load. The default setting is
4117	<computeroutput>no maximum limit</computeroutput>, thus
4118	enabling the guest to use all frame rates supported by the
4119	host webcam.
4120	</para>
4121
4122	<para>
4123	MaxPayloadTransferSize: Specifies the maximum number of bytes
4124	the emulated webcam can send to the guest in one buffer. The
4125	default setting is 3060 bytes, which is used by some webcams.
4126	Higher values can slightly reduce CPU load, if the guest is
4127	able to use larger buffers. Note that higher
4128	MaxPayloadTransferSize values may be not supported by some
4129	guest operating systems.
4130	</para>
4131	</listitem>
4132
4133	<listitem>
4134	<para>
4135	<computeroutput>webcam detach
4136	<path\|alias></computeroutput>: Detaches a webcam from a
4137	running VM. Specify the absolute path of the webcam on the
4138	host, or use its alias obtained from the <command>webcam
4139	list</command> command.
4140	</para>
4141
4142	<para>
4143	Please note the following points, relating to specific host
4144	operating systems:
4145	</para>
4146
4147	<itemizedlist>
4148
4149	<listitem>
4150	<para>
4151	Windows hosts: When the webcam device is detached from the
4152	host, the emulated webcam device is automatically detached
4153	from the guest.
4154	</para>
4155	</listitem>
4156
4157	<listitem>
4158	<para>
4159	Mac OS X hosts: OS X version 10.7 or newer is required.
4160	</para>
4161
4162	<para>
4163	When the webcam device is detached from the host, the
4164	emulated webcam device remains attached to the guest and
4165	must be manually detached using the <command>VBoxManage
4166	controlvm webcam detach</command> command.
4167	</para>
4168	</listitem>
4169
4170	<listitem>
4171	<para>
4172	Linux hosts: When the webcam is detached from the host,
4173	the emulated webcam device is automatically detached from
4174	the guest only if the webcam is streaming video. If the
4175	emulated webcam is inactive, it should be manually
4176	detached using the <command>VBoxManage controlvm webcam
4177	detach</command> command.
4178	</para>
4179	</listitem>
4180
4181	</itemizedlist>
4182	</listitem>
4183
4184	<listitem>
4185	<para>
4186	<computeroutput>webcam list</computeroutput>: Lists webcams
4187	attached to the running VM. The output is a list of absolute
4188	paths or aliases that were used for attaching the webcams to
4189	the VM using the <command>webcam attach</command> command.
4190	</para>
4191	</listitem>
4192
4193	<listitem>
4194	<para>
4195	<computeroutput>addencpassword <id> <password
4196	file>\|- [--removeonsuspend
4197	<yes\|no>]</computeroutput>: Supplies an encrypted VM
4198	specified by <id> with the encryption password to enable
4199	a headless start. Either specify the absolute path of a
4200	password file on the host file system: <password file>,
4201	or use <option>-</option> to instruct
4202	<command>VBoxManage</command> to prompt the user for the
4203	encryption password.
4204	</para>
4205
4206	<para>
4207	<computeroutput>--removeonsuspend
4208	<yes\|no></computeroutput>: Specifies whether to remove
4209	the passsword or keep the password in VM memory when the VM is
4210	suspended. If the VM has been suspended and the password has
4211	been removed, the user needs to resupply the password before
4212	the VM can be resumed. This feature is useful in cases where
4213	the user does not want the password to be stored in VM memory,
4214	and the VM is suspended by a host suspend event.
4215	</para>
4216
4217	<note>
4218	<para>
4219	On &product-name; versions 5.0 and later, data stored on
4220	hard disk images can be transparently encrypted for the
4221	guest. &product-name; uses the AES algorithm in XTS mode and
4222	supports 128 or 256 bit data encryption keys (DEK). The DEK
4223	is stored encrypted in the medium properties, and is
4224	decrypted during VM startup by supplying the encryption
4225	password.
4226	</para>
4227	</note>
4228
4229	<para>
4230	The <command>VBoxManage encryptmedium</command> command is
4231	used to create a DEK encrypted medium. See
4232	<xref linkend="diskencryption-encryption" />. When starting an
4233	encrypted VM from the &product-name; GUI, the user will be
4234	prompted for the encryption password.
4235	</para>
4236
4237	<para>
4238	For a headless encrypted VM start, use the following command:
4239	</para>
4240
4241	<screen>
4242	VBoxManage startvm "vmname" --type headless
4243	</screen>
4244
4245	<para>
4246	Then supply the required encryption password as follows:
4247	</para>
4248
4249	<screen>
4250	VBoxManage "vmname" controlvm "vmname" addencpassword ...
4251	</screen>
4252
4253	<para></para>
4254	</listitem>
4255
4256	<listitem>
4257	<para>
4258	<computeroutput>removeencpassword <id></computeroutput>:
4259	Removes encryption password authorization for password
4260	<id> for all encrypted media attached to the VM.
4261	</para>
4262	</listitem>
4263
4264	<listitem>
4265	<para>
4266	<computeroutput>removeallencpasswords</computeroutput>:
4267	Removes encryption password authorization for all passwords
4268	for all encrypted media attached to the VM.
4269	</para>
4270	</listitem>
4271
4272	<listitem>
4273	<para>
4274	<computeroutput>changeuartmode <1-N></computeroutput>:
4275	Changes the connection mode for a given virtual serial port.
4276	</para>
4277	</listitem>
4278
4279	</itemizedlist>
4280
4281	</sect1>
4282
4283	<sect1 id="vboxmanage-discardstate">
4284
4285	<title>VBoxManage discardstate</title>
4286
4287	<para>
4288	This command discards the saved state of a virtual machine which
4289	is not currently running. This will cause the VM's operating
4290	system to restart next time you start it. This is the equivalent
4291	of pulling out the power cable on a physical machine, and should
4292	be avoided if possible.
4293	</para>
4294
4295	</sect1>
4296
4297	<sect1 id="vboxmanage-adoptstate">
4298
4299	<title>VBoxManage adoptstate</title>
4300
4301	<para>
4302	If you have a Saved state file
4303	(<computeroutput>.sav</computeroutput>) that is separate from the
4304	VM configuration, you can use this command to
4305	<emphasis>adopt</emphasis> the file. This will change the VM to
4306	saved state and when you start it, &product-name; will attempt to
4307	restore it from the saved state file you indicated. This command
4308	should only be used in special setups.
4309	</para>
4310
4311	</sect1>
4312
4313	<sect1 id="vboxmanage-closemedium">
4314
4315	<title>VBoxManage closemedium</title>
4316
4317	<para>
4318	This command removes a hard disk, DVD, or floppy image from a
4319	&product-name; media registry.
4320	</para>
4321
4322	<screen>VBoxManage closemedium [disk\|dvd\|floppy] <uuid\|filename>
4323	[--delete]</screen>
4324
4325	<para>
4326	Optionally, you can request that the image be deleted. You will
4327	get appropriate diagnostics that the deletion failed, however the
4328	image will become unregistered in any case.
4329	</para>
4330
4331	</sect1>
4332
4333	<sect1 id="vboxmanage-storageattach">
4334
4335	<title>VBoxManage storageattach</title>
4336
4337	<para>
4338	This command attaches, modifies, and removes a storage medium
4339	connected to a storage controller that was previously added with
4340	the <command>storagectl</command> command. The syntax is as
4341	follows:
4342	</para>
4343
4344	<screen>VBoxManage storageattach <uuid\|vmname>
4345	--storagectl <name>
4346	[--port <number>]
4347	[--device <number>]
4348	[--type dvddrive\|hdd\|fdd]
4349	[--medium none\|emptydrive\|additions\|
4350	<uuid>\|<filename>\|host:<drive>\|iscsi]
4351	[--mtype normal\|writethrough\|immutable\|shareable
4352	readonly\|multiattach]
4353	[--comment <text>]
4354	[--setuuid <uuid>]
4355	[--setparentuuid <uuid>]
4356	[--passthrough on\|off]
4357	[--tempeject on\|off]
4358	[--nonrotational on\|off]
4359	[--discard on\|off]
4360	[--hotpluggable on\|off]
4361	[--bandwidthgroup name\|none]
4362	[--forceunmount]
4363	[--server <name>\|<ip>]
4364	[--target <target>]
4365	[--tport <port>]
4366	[--lun <lun>]
4367	[--encodedlun <lun>]
4368	[--username <username>]
4369	[--password <password>]
4370	[--passwordfile <file>]
4371	[--initiator <initiator>]
4372	[--intnet]</screen>
4373
4374	<para>
4375	A number of parameters are commonly required. Some parameters are
4376	required only for iSCSI targets.
4377	</para>
4378
4379	<para>
4380	The common parameters are as follows:
4381	</para>
4382
4383	<variablelist>
4384
4385	<varlistentry>
4386	<term>
4387	<computeroutput>uuid\|vmname</computeroutput>
4388	</term>
4389
4390	<listitem>
4391	<para>
4392	The VM UUID or VM Name. Mandatory.
4393	</para>
4394	</listitem>
4395	</varlistentry>
4396
4397	<varlistentry>
4398	<term>
4399	<computeroutput>--storagectl</computeroutput>
4400	</term>
4401
4402	<listitem>
4403	<para>
4404	Name of the storage controller. Mandatory. The list of the
4405	storage controllers currently attached to a VM can be
4406	obtained with <command>VBoxManage showvminfo</command>. See
4407	<xref linkend="vboxmanage-showvminfo" />.
4408	</para>
4409	</listitem>
4410	</varlistentry>
4411
4412	<varlistentry>
4413	<term>
4414	<computeroutput>--port</computeroutput>
4415	</term>
4416
4417	<listitem>
4418	<para>
4419	The number of the storage controller's port which is to be
4420	modified. Mandatory, unless the storage controller has only
4421	a single port.
4422	</para>
4423	</listitem>
4424	</varlistentry>
4425
4426	<varlistentry>
4427	<term>
4428	<computeroutput>--device</computeroutput>
4429	</term>
4430
4431	<listitem>
4432	<para>
4433	The number of the port's device which is to be modified.
4434	Mandatory, unless the storage controller has only a single
4435	device per port.
4436	</para>
4437	</listitem>
4438	</varlistentry>
4439
4440	<varlistentry>
4441	<term>
4442	<computeroutput>--type</computeroutput>
4443	</term>
4444
4445	<listitem>
4446	<para>
4447	Define the type of the drive to which the medium is being
4448	attached, detached, or modified. This argument can only be
4449	omitted if the type of medium can be determined from either
4450	the medium given with the
4451	<computeroutput>--medium</computeroutput> argument or from a
4452	previous medium attachment.
4453	</para>
4454	</listitem>
4455	</varlistentry>
4456
4457	<varlistentry>
4458	<term>
4459	<computeroutput>--medium</computeroutput>
4460	</term>
4461
4462	<listitem>
4463	<para>
4464	Specifies what is to be attached. The following values are
4465	supported:
4466	</para>
4467
4468	<itemizedlist>
4469
4470	<listitem>
4471	<para>
4472	<computeroutput>none</computeroutput>: Any existing
4473	device should be removed from the given slot.
4474	</para>
4475	</listitem>
4476
4477	<listitem>
4478	<para>
4479	<computeroutput>emptydrive</computeroutput>: For a
4480	virtual DVD or floppy drive only, this makes the device
4481	slot behave like a removeable drive into which no media
4482	has been inserted.
4483	</para>
4484	</listitem>
4485
4486	<listitem>
4487	<para>
4488	<computeroutput>additions</computeroutput>: For a
4489	virtual DVD drive only, this attaches the
4490	<emphasis>VirtualBox Guest Additions</emphasis> image to
4491	the given device slot.
4492	</para>
4493	</listitem>
4494
4495	<listitem>
4496	<para>
4497	If a UUID is specified, it must be the UUID of a storage
4498	medium that is already known to &product-name;. For
4499	example, because it has been attached to another virtual
4500	machine. See <xref linkend="vboxmanage-list" /> for
4501	details of how to list known media. This medium is then
4502	attached to the given device slot.
4503	</para>
4504	</listitem>
4505
4506	<listitem>
4507	<para>
4508	If a filename is specified, it must be the full path of
4509	an existing disk image in ISO, RAW, VDI, VMDK, or other
4510	format. The disk image is then attached to the given
4511	device slot.
4512	</para>
4513	</listitem>
4514
4515	<listitem>
4516	<para>
4517	<computeroutput>host:<drive></computeroutput>: For
4518	a virtual DVD or floppy drive only, this connects the
4519	given device slot to the specified DVD or floppy drive
4520	on the host computer.
4521	</para>
4522	</listitem>
4523
4524	<listitem>
4525	<para>
4526	<computeroutput>iscsi</computeroutput>: For virtual hard
4527	disks only, this is used for specifying an iSCSI target.
4528	In this case, additional parameters must be given. These
4529	are described below.
4530	</para>
4531	</listitem>
4532
4533	</itemizedlist>
4534
4535	<para>
4536	Some of the above changes, in particular for removeable
4537	media such as floppies and CDs/DVDs, can be effected while a
4538	VM is running. Others, such as device changes or changes in
4539	hard disk device slots, require the VM to be powered off.
4540	</para>
4541	</listitem>
4542	</varlistentry>
4543
4544	<varlistentry>
4545	<term>
4546	<computeroutput>--mtype</computeroutput>
4547	</term>
4548
4549	<listitem>
4550	<para>
4551	Defines how this medium behaves with respect to snapshots
4552	and write operations. See <xref linkend="hdimagewrites" />.
4553	</para>
4554	</listitem>
4555	</varlistentry>
4556
4557	<varlistentry>
4558	<term>
4559	<computeroutput>--comment</computeroutput>
4560	</term>
4561
4562	<listitem>
4563	<para>
4564	An optional description that you want to have stored with
4565	this medium. For example, for an iSCSI target, "Big storage
4566	server downstairs". This is purely descriptive and not
4567	needed for the medium to function correctly.
4568	</para>
4569	</listitem>
4570	</varlistentry>
4571
4572	<varlistentry>
4573	<term>
4574	<computeroutput>--setuuid, --setparentuuid</computeroutput>
4575	</term>
4576
4577	<listitem>
4578	<para>
4579	Modifies the UUID or parent UUID of a medium before
4580	attaching it to a VM. This is an expert option.
4581	Inappropriate use can make the medium unusable or lead to
4582	broken VM configurations if any other VM is referring to the
4583	same media already. The most frequently used variant is
4584	<computeroutput>--setuuid ""</computeroutput>, which assigns
4585	a new random UUID to an image. This option is useful for
4586	resolving duplicate UUID errors if you duplicated an image
4587	using a file copy utility.
4588	</para>
4589	</listitem>
4590	</varlistentry>
4591
4592	<varlistentry>
4593	<term>
4594	<computeroutput>--passthrough</computeroutput>
4595	</term>
4596
4597	<listitem>
4598	<para>
4599	For a virtual DVD drive only, you can enable DVD writing
4600	support. This feature is currently experimental, see
4601	<xref
4602	linkend="storage-cds" />.
4603	</para>
4604	</listitem>
4605	</varlistentry>
4606
4607	<varlistentry>
4608	<term>
4609	<computeroutput>--tempeject</computeroutput>
4610	</term>
4611
4612	<listitem>
4613	<para>
4614	For a virtual DVD drive only, you can configure the behavior
4615	for guest-triggered medium eject. If this is set to on, the
4616	eject has only a temporary effect. If the VM is powered off
4617	and restarted the originally configured medium will be still
4618	in the drive.
4619	</para>
4620	</listitem>
4621	</varlistentry>
4622
4623	<varlistentry>
4624	<term>
4625	<computeroutput>--nonrotational</computeroutput>
4626	</term>
4627
4628	<listitem>
4629	<para>
4630	Enables you to enable the non-rotational flag for virtual
4631	hard disks. Some guests, such as Windows 7 or later, treat
4632	such disks like SSDs and do not perform disk fragmentation
4633	on such media.
4634	</para>
4635	</listitem>
4636	</varlistentry>
4637
4638	<varlistentry>
4639	<term>
4640	<computeroutput>--discard</computeroutput>
4641	</term>
4642
4643	<listitem>
4644	<para>
4645	Enables the auto-discard feature for a virtual hard disks.
4646	This specifies that a VDI image will be shrunk in response
4647	to the trim command from the guest OS. The following
4648	requirements must be met:
4649	</para>
4650
4651	<itemizedlist>
4652
4653	<listitem>
4654	<para>
4655	The disk format must be VDI.
4656	</para>
4657	</listitem>
4658
4659	<listitem>
4660	<para>
4661	The size of the cleared area must be at least 1 MB.
4662	</para>
4663	</listitem>
4664
4665	<listitem>
4666	<para>
4667	&product-name; will only trim whole 1 MB blocks. The
4668	VDIs themselves are organized into 1 MB blocks, so this
4669	will only work if the space being trimmed is at least a
4670	1 MB contiguous block at a 1 MB boundary. On Windows,
4671	occasional defragmentation with <command>defrag.exe
4672	/D</command>, or on Linux running <command>btrfs
4673	filesystem defrag</command> as a background cron job may
4674	be beneficial.
4675	</para>
4676	</listitem>
4677
4678	</itemizedlist>
4679
4680	<note>
4681	<para>
4682	The Guest OS must be configured to issue the
4683	<command>trim</command> command, and typically this means
4684	that the guest OS is made to see the disk as an SSD. Ext4
4685	supports the -o discard mount flag. Mac OS X probably
4686	requires additional settings. Windows should automatically
4687	detect and support SSDs, at least in versions 7, 8, and
4688	10. The Linux exFAT driver from Samsung supports the
4689	<command>trim</command> command.
4690	</para>
4691	</note>
4692
4693	<para>
4694	It is unclear whether Microsoft's implementation of exFAT
4695	supports this feature, even though that file system was
4696	originally designed for flash.
4697	</para>
4698
4699	<para>
4700	Alternatively, there are other methods to issue trim. For
4701	example, the Linux <command>fstrim</command> command, part
4702	of the util-linux package. Earlier solutions required a user
4703	to zero out unused areas, using zerofree or similar, and to
4704	compact the disk. This is only possible when the VM is
4705	offline.
4706	</para>
4707	</listitem>
4708	</varlistentry>
4709
4710	<varlistentry>
4711	<term>
4712	<computeroutput>--bandwidthgroup</computeroutput>
4713	</term>
4714
4715	<listitem>
4716	<para>
4717	Sets the bandwidth group to use for the given device. See
4718	<xref linkend="storage-bandwidth-limit" />.
4719	</para>
4720	</listitem>
4721	</varlistentry>
4722
4723	<varlistentry>
4724	<term>
4725	<computeroutput>--forceunmount</computeroutput>
4726	</term>
4727
4728	<listitem>
4729	<para>
4730	For a virtual DVD or floppy drive only, this forcibly
4731	unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy
4732	even if the previous one is locked down by the guest for
4733	reading. See <xref linkend="storage-cds" />.
4734	</para>
4735	</listitem>
4736	</varlistentry>
4737
4738	</variablelist>
4739
4740	<para>
4741	When <computeroutput>iscsi</computeroutput> is used with the
4742	<computeroutput>--medium</computeroutput> parameter for iSCSI
4743	support, additional parameters must or can be used. See also
4744	<xref linkend="storage-iscsi" />.
4745	</para>
4746
4747	<variablelist>
4748
4749	<varlistentry>
4750	<term>
4751	<computeroutput>--server</computeroutput>
4752	</term>
4753
4754	<listitem>
4755	<para>
4756	The host name or IP address of the iSCSI target. Required.
4757	</para>
4758	</listitem>
4759	</varlistentry>
4760
4761	<varlistentry>
4762	<term>
4763	<computeroutput>--target</computeroutput>
4764	</term>
4765
4766	<listitem>
4767	<para>
4768	Target name string. This is determined by the iSCSI target
4769	and used to identify the storage resource. Required.
4770	</para>
4771	</listitem>
4772	</varlistentry>
4773
4774	<varlistentry>
4775	<term>
4776	<computeroutput>--tport</computeroutput>
4777	</term>
4778
4779	<listitem>
4780	<para>
4781	TCP/IP port number of the iSCSI service on the target.
4782	Optional.
4783	</para>
4784	</listitem>
4785	</varlistentry>
4786
4787	<varlistentry>
4788	<term>
4789	<computeroutput>--lun</computeroutput>
4790	</term>
4791
4792	<listitem>
4793	<para>
4794	Logical Unit Number of the target resource. Optional. Often,
4795	this value is zero.
4796	</para>
4797	</listitem>
4798	</varlistentry>
4799
4800	<varlistentry>
4801	<term>
4802	<computeroutput>--encodedlun</computeroutput>
4803	</term>
4804
4805	<listitem>
4806	<para>
4807	Hex-encoded Logical Unit Number of the target resource.
4808	Optional. Often, this value is zero.
4809	</para>
4810	</listitem>
4811	</varlistentry>
4812
4813	<varlistentry>
4814	<term>
4815	<computeroutput>--username, --password,
4816	--passwordfile</computeroutput>
4817	</term>
4818
4819	<listitem>
4820	<para>
4821	Username and password, called the initiator secret, for
4822	target authentication, if required. Optional.
4823	</para>
4824
4825	<note>
4826	<para>
4827	Username and password are stored without encryption, in
4828	clear text, in the XML machine configuration file if no
4829	settings password is provided. When a settings password is
4830	specified for the first time, the password is stored in
4831	encrypted form. As an alternative to providing the
4832	password on the command line, a reference to a file
4833	containing the text can be provided using the
4834	<computeroutput>passwordfile</computeroutput> option.
4835	</para>
4836	</note>
4837	</listitem>
4838	</varlistentry>
4839
4840	<varlistentry>
4841	<term>
4842	<computeroutput>--initiator</computeroutput>
4843	</term>
4844
4845	<listitem>
4846	<para>
4847	iSCSI Initiator. Optional.
4848	</para>
4849
4850	<para>
4851	Microsoft iSCSI Initiator is a system, such as a server that
4852	attaches to an IP network and initiates requests and
4853	receives responses from an iSCSI target. The SAN components
4854	in Microsoft iSCSI Initiator are largely analogous to Fibre
4855	Channel SAN components, and they include the following:
4856	</para>
4857
4858	<itemizedlist>
4859
4860	<listitem>
4861	<para>
4862	To transport blocks of iSCSI commands over the IP
4863	network, an iSCSI driver must be installed on the iSCSI
4864	host. An iSCSI driver is included with Microsoft iSCSI
4865	Initiator.
4866	</para>
4867	</listitem>
4868
4869	<listitem>
4870	<para>
4871	A gigabit Ethernet adapter that transmits 1000 megabits
4872	per second (Mbps) is recommended for the connection to
4873	an iSCSI target. Like standard 10/100 adapters, most
4874	gigabit adapters use a preexisting Category 5 or
4875	Category 6E cable. Each port on the adapter is
4876	identified by a unique IP address.
4877	</para>
4878	</listitem>
4879
4880	<listitem>
4881	<para>
4882	An iSCSI target is any device that receives iSCSI
4883	commands. The device can be an end node, such as a
4884	storage device, or it can be an intermediate device,
4885	such as a network bridge between IP and Fibre Channel
4886	devices. Each port on the storage array controller or
4887	network bridge is identified by one or more IP addresses
4888	</para>
4889	</listitem>
4890
4891	</itemizedlist>
4892	</listitem>
4893	</varlistentry>
4894
4895	<varlistentry>
4896	<term>
4897	<computeroutput>--intnet</computeroutput>
4898	</term>
4899
4900	<listitem>
4901	<para>
4902	If specified, connect to the iSCSI target using Internal
4903	Networking. This needs further configuration, see
4904	<xref linkend="iscsi-intnet" />.
4905	</para>
4906	</listitem>
4907	</varlistentry>
4908
4909	</variablelist>
4910
4911	</sect1>
4912
4913	<sect1 id="vboxmanage-storagectl">
4914
4915	<title>VBoxManage storagectl</title>
4916
4917	<para>
4918	This command attaches, modifies, and removes a storage controller.
4919	After this, virtual media can be attached to the controller with
4920	the <command>storageattach</command> command.
4921	</para>
4922
4923	<para>
4924	The syntax for this command is as follows:
4925	</para>
4926
4927	<screen>VBoxManage storagectl <uuid\|vmname>
4928	--name <name>
4929	[--add ide\|sata\|scsi\|floppy\|sas\|usb\|pcie]
4930	[--controller LSILogic\|LSILogicSAS\|BusLogic\|
4931	IntelAhci\|PIIX3\|PIIX4\|ICH6\|I82078\|
4932	USB\|NVMe]
4933	[--portcount <1-30>]
4934	[--hostiocache on\|off]
4935	[--bootable on\|off]
4936	[--rename <name>]
4937	[--remove]</screen>
4938
4939	<para>
4940	The parameters are as follows:
4941	</para>
4942
4943	<variablelist>
4944
4945	<varlistentry>
4946	<term>
4947	<computeroutput>uuid\|vmname</computeroutput>
4948	</term>
4949
4950	<listitem>
4951	<para>
4952	The VM UUID or VM Name. Mandatory.
4953	</para>
4954	</listitem>
4955	</varlistentry>
4956
4957	<varlistentry>
4958	<term>
4959	<computeroutput>--name</computeroutput>
4960	</term>
4961
4962	<listitem>
4963	<para>
4964	Specifies the name of the storage controller. Mandatory.
4965	</para>
4966	</listitem>
4967	</varlistentry>
4968
4969	<varlistentry>
4970	<term>
4971	<computeroutput>--add</computeroutput>
4972	</term>
4973
4974	<listitem>
4975	<para>
4976	Specifies the type of the system bus to which the storage
4977	controller must be connected.
4978	</para>
4979	</listitem>
4980	</varlistentry>
4981
4982	<varlistentry>
4983	<term>
4984	<computeroutput>--controller</computeroutput>
4985	</term>
4986
4987	<listitem>
4988	<para>
4989	Enables a choice of chipset type being emulated for the
4990	given storage controller.
4991	</para>
4992	</listitem>
4993	</varlistentry>
4994
4995	<varlistentry>
4996	<term>
4997	<computeroutput>--portcount</computeroutput>
4998	</term>
4999
5000	<listitem>
5001	<para>
5002	This specifies the number of ports the storage controller
5003	should support.
5004	</para>
5005	</listitem>
5006	</varlistentry>
5007
5008	<varlistentry>
5009	<term>
5010	<computeroutput>--hostiocache</computeroutput>
5011	</term>
5012
5013	<listitem>
5014	<para>
5015	Configures the use of the host I/O cache for all disk images
5016	attached to this storage controller. See
5017	<xref
5018	linkend="iocaching" />.
5019	</para>
5020	</listitem>
5021	</varlistentry>
5022
5023	<varlistentry>
5024	<term>
5025	<computeroutput>--bootable</computeroutput>
5026	</term>
5027
5028	<listitem>
5029	<para>
5030	Specifies whether this controller is bootable.
5031	</para>
5032	</listitem>
5033	</varlistentry>
5034
5035	<varlistentry>
5036	<term>
5037	<computeroutput>--rename</computeroutput>
5038	</term>
5039
5040	<listitem>
5041	<para>
5042	Specifies a new name for the storage controller.
5043	</para>
5044	</listitem>
5045	</varlistentry>
5046
5047	<varlistentry>
5048	<term>
5049	<computeroutput>--remove</computeroutput>
5050	</term>
5051
5052	<listitem>
5053	<para>
5054	Removes the storage controller from the VM configuration.
5055	</para>
5056	</listitem>
5057	</varlistentry>
5058
5059	</variablelist>
5060
5061	</sect1>
5062
5063	<sect1 id="vboxmanage-bandwidthctl">
5064
5065	<title>VBoxManage bandwidthctl</title>
5066
5067	<para>
5068	This command creates, deletes, modifies, and shows bandwidth
5069	groups of the given virtual machine.
5070	</para>
5071
5072	<screen>VBoxManage bandwidthctl <uuid\|vmname>
5073	add <name> --type disk\|network --limit <MBps>[k\|m\|g\|K\|M\|G] \|
5074	set <name> --limit <MBps>[k\|m\|g\|K\|M\|G] \|
5075	remove <name> \|
5076	list [--machinereadable]</screen>
5077
5078	<para>
5079	The following subcommands are available:
5080	</para>
5081
5082	<itemizedlist>
5083
5084	<listitem>
5085	<para>
5086	<command>add</command>: Creates a new bandwidth group of a
5087	given type.
5088	</para>
5089	</listitem>
5090
5091	<listitem>
5092	<para>
5093	<command>set</command>: Modifies the limit for an existing
5094	bandwidth group.
5095	</para>
5096	</listitem>
5097
5098	<listitem>
5099	<para>
5100	<command>remove</command>: Deletes a bandwidth group.
5101	</para>
5102	</listitem>
5103
5104	<listitem>
5105	<para>
5106	<command>list</command>: Shows all bandwidth groups defined
5107	for the given VM. Use the
5108	<computeroutput>--machinereadable</computeroutput> option to
5109	produce the same output, but in machine readable format. This
5110	is of the form: name="value" on a line by line basis.
5111	</para>
5112	</listitem>
5113
5114	</itemizedlist>
5115
5116	<para>
5117	The parameters are as follows:
5118	</para>
5119
5120	<variablelist>
5121
5122	<varlistentry>
5123	<term>
5124	<computeroutput>uuid\|vmname</computeroutput>
5125	</term>
5126
5127	<listitem>
5128	<para>
5129	The VM UUID or VM Name. Mandatory.
5130	</para>
5131	</listitem>
5132	</varlistentry>
5133
5134	<varlistentry>
5135	<term>
5136	<computeroutput>--name</computeroutput>
5137	</term>
5138
5139	<listitem>
5140	<para>
5141	Name of the bandwidth group. Mandatory.
5142	</para>
5143	</listitem>
5144	</varlistentry>
5145
5146	<varlistentry>
5147	<term>
5148	<computeroutput>--type</computeroutput>
5149	</term>
5150
5151	<listitem>
5152	<para>
5153	Type of the bandwidth group. Mandatory. Two types are
5154	supported: <computeroutput>disk</computeroutput> and
5155	<computeroutput>network</computeroutput>. See
5156	<xref linkend="storage-bandwidth-limit" /> or
5157	<xref linkend="network_bandwidth_limit" /> for the
5158	description of a particular type.
5159	</para>
5160	</listitem>
5161	</varlistentry>
5162
5163	<varlistentry>
5164	<term>
5165	<computeroutput>--limit</computeroutput>
5166	</term>
5167
5168	<listitem>
5169	<para>
5170	Specifies the limit for the given bandwidth group. This can
5171	be changed while the VM is running. The default unit is
5172	megabytes per second. The unit can be changed by specifying
5173	one of the following suffixes:
5174	<computeroutput>k</computeroutput> for kilobits per second,
5175	<computeroutput>m</computeroutput> for megabits per second,
5176	<computeroutput>g</computeroutput> for gigabits per second,
5177	<computeroutput>K</computeroutput> for kilobytes per second,
5178	<computeroutput>M</computeroutput> for megabytes per second,
5179	<computeroutput>G</computeroutput> for gigabytes per second.
5180	</para>
5181	</listitem>
5182	</varlistentry>
5183
5184	</variablelist>
5185
5186	<note>
5187	<para>
5188	The network bandwidth limits apply only to the traffic being
5189	sent by virtual machines. The traffic being received by VMs is
5190	unlimited.
5191	</para>
5192	</note>
5193
5194	<note>
5195	<para>
5196	To remove a bandwidth group it must not be referenced by any
5197	disks or adapters in the running VM.
5198	</para>
5199	</note>
5200
5201	</sect1>
5202
5203	<sect1 id="vboxmanage-showmediuminfo">
5204
5205	<title>VBoxManage showmediuminfo</title>
5206
5207	<para>
5208	This command shows information about a medium, notably its size,
5209	its size on disk, its type, and the virtual machines which use it.
5210	</para>
5211
5212	<note>
5213	<para>
5214	For compatibility with earlier versions of &product-name;, the
5215	<command>showvdiinfo</command> command is also supported and
5216	mapped internally to the <command>showmediuminfo</command>
5217	command.
5218	</para>
5219	</note>
5220
5221	<screen>VBoxManage showmediuminfo [disk\|dvd\|floppy] <uuid\|filename></screen>
5222
5223	<para>
5224	The medium must be specified either by its UUID, if the medium is
5225	registered, or by its filename. Registered images can be listed
5226	using <command>VBoxManage list hdds</command>, <command>VBoxManage
5227	list dvds</command>, or <command>VBoxManage list
5228	floppies</command>, as appropriate. See
5229	<xref linkend="vboxmanage-list" />.
5230	</para>
5231
5232	</sect1>
5233
5234	<sect1 id="vboxmanage-createmedium">
5235
5236	<title>VBoxManage createmedium</title>
5237
5238	<para>
5239	This command creates a new medium. The syntax is as follows:
5240	</para>
5241
5242	<screen>VBoxManage createmedium [disk\|dvd\|floppy] --filename <filename>
5243	[--size <megabytes>\|--sizebyte <bytes>]
5244	[--diffparent <uuid>\|<filename>
5245	[--format VDI\|VMDK\|VHD] (default: VDI)
5246	[--variant Standard,Fixed,Split2G,Stream,ESX]</screen>
5247
5248	<para>
5249	The parameters are as follows:
5250	</para>
5251
5252	<variablelist>
5253
5254	<varlistentry>
5255	<term>
5256	<computeroutput>--filename <filename></computeroutput>
5257	</term>
5258
5259	<listitem>
5260	<para>
5261	Specifies a file name <filename> as an absolute path
5262	on the host file system. Mandatory.
5263	</para>
5264	</listitem>
5265	</varlistentry>
5266
5267	<varlistentry>
5268	<term>
5269	<computeroutput>--size <megabytes></computeroutput>
5270	</term>
5271
5272	<listitem>
5273	<para>
5274	Specifies the image capacity, in 1 MB units. Optional.
5275	</para>
5276	</listitem>
5277	</varlistentry>
5278
5279	<varlistentry>
5280	<term>
5281	<computeroutput>--diffparent
5282	<uuid>\|<filename></computeroutput>
5283	</term>
5284
5285	<listitem>
5286	<para>
5287	Specifies the differencing image parent, either as a UUID or
5288	by the absolute pathname of the file on the host file
5289	system. Useful for sharing a base box disk image among
5290	several VMs.
5291	</para>
5292	</listitem>
5293	</varlistentry>
5294
5295	<varlistentry>
5296	<term>
5297	<computeroutput>--format VDI\|VMDK\|VHD</computeroutput>
5298	</term>
5299
5300	<listitem>
5301	<para>
5302	Specifies the file format for the output file. Available
5303	options are VDI, VMDK, VHD. The default format is VDI.
5304	Optional.
5305	</para>
5306	</listitem>
5307	</varlistentry>
5308
5309	<varlistentry>
5310	<term>
5311	<computeroutput>--variant</computeroutput>
5312	</term>
5313
5314	<listitem>
5315	<para>
5316	Specifies any required file format variants for the output
5317	file. This is a comma-separated list of variant flags.
5318	Options are Standard,Fixed,Split2G,Stream,ESX. Not all
5319	combinations are supported, and specifying mutually
5320	incompatible flags results in an error message. Optional.
5321	</para>
5322	</listitem>
5323	</varlistentry>
5324
5325	</variablelist>
5326
5327	<note>
5328	<para>
5329	For compatibility with earlier versions of &product-name;, the
5330	<command>createvdi</command> and <command>createhd</command>
5331	commands are also supported and mapped internally to the
5332	<command>createmedium</command> command.
5333	</para>
5334	</note>
5335
5336	</sect1>
5337
5338	<sect1 id="vboxmanage-modifyvdi">
5339
5340	<title>VBoxManage modifymedium</title>
5341
5342	<para>
5343	With the <command>modifymedium</command> command, you can change
5344	the characteristics of a disk image after it has been created.
5345	</para>
5346
5347	<screen>VBoxManage modifymedium [disk\|dvd\|floppy] <uuid\|filename>
5348	[--type normal\|writethrough\|immutable\|shareable\|
5349	readonly\|multiattach]
5350	[--autoreset on\|off]
5351	[--property <name=[value]>]
5352	[--compact]
5353	[--resize <megabytes>\|--resizebyte <bytes>]
5354	[--move <path>]
5355	[--setlocation <path>]</screen>
5356
5357	<note>
5358	<para>
5359	For compatibility with earlier versions of &product-name;, the
5360	<command>modifyvdi</command> and <command>modifyhd</command>
5361	commands are also supported and mapped internally to the
5362	<command>modifymedium</command> command.
5363	</para>
5364	</note>
5365
5366	<para>
5367	The disk image to modify must be specified either by its UUID, if
5368	the medium is registered, or by its filename. Registered images
5369	can be listed using <command>VBoxManage list hdds</command>, see
5370	<xref linkend="vboxmanage-list" />. A filename must be specified
5371	as a valid path, either as an absolute path or as a relative path
5372	starting from the current directory.
5373	</para>
5374
5375	<para>
5376	The following options are available:
5377	</para>
5378
5379	<itemizedlist>
5380
5381	<listitem>
5382	<para>
5383	With the <computeroutput>--type</computeroutput> argument, you
5384	can change the type of an existing image between the normal,
5385	immutable, write-through and other modes. See
5386	<xref
5387	linkend="hdimagewrites" />.
5388	</para>
5389	</listitem>
5390
5391	<listitem>
5392	<para>
5393	For immutable hard disks only, the <computeroutput>--autoreset
5394	on\|off</computeroutput> option determines whether the disk is
5395	automatically reset on every VM startup. See
5396	<xref linkend="hdimagewrites" />. By default, autoreset is on.
5397	</para>
5398	</listitem>
5399
5400	<listitem>
5401	<para>
5402	The <computeroutput>--compact</computeroutput> option can be
5403	used to compact disk images. Compacting removes blocks that
5404	only contains zeroes. Using this option will shrink a
5405	dynamically allocated image. It will reduce the
5406	<emphasis>physical</emphasis> size of the image without
5407	affecting the logical size of the virtual disk. Compaction
5408	works both for base images and for differencing images created
5409	as part of a snapshot.
5410	</para>
5411
5412	<para>
5413	For this operation to be effective, it is required that free
5414	space in the guest system first be zeroed out using a suitable
5415	software tool. For Windows guests, you can use the
5416	<command>sdelete</command> tool provided by Microsoft. Run
5417	<command>sdelete -z</command> in the guest to zero the free
5418	disk space, before compressing the virtual disk image. For
5419	Linux, use the <command>zerofree</command> utility which
5420	supports ext2/ext3 filesystems. For Mac OS X guests, use the
5421	<computeroutput>diskutil secureErase freespace 0
5422	/</computeroutput> command from an elevated Terminal.
5423	</para>
5424
5425	<para>
5426	Please note that compacting is currently only available for
5427	VDI images. A similar effect can be achieved by zeroing out
5428	free blocks and then cloning the disk to any other dynamically
5429	allocated format. You can use this workaround until compacting
5430	is also supported for disk formats other than VDI.
5431	</para>
5432	</listitem>
5433
5434	<listitem>
5435	<para>
5436	The <computeroutput>--resize x</computeroutput> option, where
5437	x is the desired new total space in megabytes enables you to
5438	change the capacity of an existing image. This adjusts the
5439	<emphasis>logical</emphasis> size of a virtual disk without
5440	affecting the physical size much.
5441	</para>
5442
5443	<para>
5444	This option currently works only for VDI and VHD formats, and
5445	only for the dynamically allocated variants. It can only be
5446	used to expand, but not shrink, the capacity. For example, if
5447	you originally created a 10 GB disk which is now full, you can
5448	use the <computeroutput>--resize 15360</computeroutput>
5449	command to change the capacity to 15 GB (15,360 MB) without
5450	having to create a new image and copy all data from within a
5451	virtual machine. Note however that this only changes the drive
5452	capacity. You will typically next need to use a partition
5453	management tool inside the guest to adjust the main partition
5454	to fill the drive.
5455	</para>
5456
5457	<para>
5458	The <computeroutput>--resizebyte x</computeroutput> option
5459	does almost the same thing, except that x is expressed in
5460	bytes instead of megabytes.
5461	</para>
5462	</listitem>
5463
5464	<listitem>
5465	<para>
5466	The <computeroutput>--move <path></computeroutput>
5467	option can be used to relocate a medium to a different
5468	location <path> on the host file system. The path can be
5469	either relative to the current directory or absolute.
5470	</para>
5471	</listitem>
5472
5473	<listitem>
5474	<para>
5475	The <computeroutput>--setlocation
5476	<path></computeroutput> option can be used to set the
5477	new location <path> of the medium on the host file
5478	system if the medium has been moved for any reasons. The path
5479	can be either relative to the current directory or absolute.
5480	</para>
5481
5482	<note>
5483	<para>
5484	The new location is used as is, without any sanity checks.
5485	The user is responsible for setting the correct path.
5486	</para>
5487	</note>
5488	</listitem>
5489
5490	</itemizedlist>
5491
5492	</sect1>
5493
5494	<sect1 id="vboxmanage-clonevdi">
5495
5496	<title>VBoxManage clonemedium</title>
5497
5498	<para>
5499	This command duplicates a virtual disk, DVD, or floppy medium to a
5500	new medium, usually an image file, with a new unique identifier
5501	(UUID). The new image can be transferred to another host system or
5502	reimported into &product-name; using the Virtual Media Manager.
5503	See <xref linkend="vdis" /> and <xref linkend="cloningvdis" />.
5504	The syntax is as follows:
5505	</para>
5506
5507	<screen>VBoxManage clonemedium [disk\|dvd\|floppy] <uuid\|inputfile> <uuid\|outputfile>
5508
5509	[--format VDI\|VMDK\|VHD\|RAW\|<other>]
5510	[--variant Standard,Fixed,Split2G,Stream,ESX]
5511	[--existing]</screen>
5512
5513	<para>
5514	The medium to clone as well as the target image must be described
5515	either by its UUIDs, if the mediums are registered, or by its
5516	filename. Registered images can be listed by <command>VBoxManage
5517	list hdds</command>. See <xref linkend="vboxmanage-list" />. A
5518	filename must be specified as valid path, either as an absolute
5519	path or as a relative path starting from the current directory.
5520	</para>
5521
5522	<para>
5523	The following options are available:
5524	</para>
5525
5526	<variablelist>
5527
5528	<varlistentry>
5529	<term>
5530	<computeroutput>--format</computeroutput>
5531	</term>
5532
5533	<listitem>
5534	<para>
5535	Set a file format for the output file different from the
5536	file format of the input file.
5537	</para>
5538	</listitem>
5539	</varlistentry>
5540
5541	<varlistentry>
5542	<term>
5543	<computeroutput>--variant</computeroutput>
5544	</term>
5545
5546	<listitem>
5547	<para>
5548	Set a file format variant for the output file. This is a
5549	comma-separated list of variant flags. Not all combinations
5550	are supported, and specifying inconsistent flags will result
5551	in an error message.
5552	</para>
5553	</listitem>
5554	</varlistentry>
5555
5556	<varlistentry>
5557	<term>
5558	<computeroutput>--existing</computeroutput>
5559	</term>
5560
5561	<listitem>
5562	<para>
5563	Perform the clone operation to an already existing
5564	destination medium. Only the portion of the source medium
5565	which fits into the destination medium is copied. This means
5566	if the destination medium is smaller than the source only a
5567	part of it is copied, and if the destination medium is
5568	larger than the source the remaining part of the destination
5569	medium is unchanged.
5570	</para>
5571	</listitem>
5572	</varlistentry>
5573
5574	</variablelist>
5575
5576	<note>
5577	<para>
5578	For compatibility with earlier versions of &product-name;, the
5579	<command>clonevdi</command> and <command>clonehd</command>
5580	commands are still supported and mapped internally to the
5581	<command>clonehd disk</command> command.
5582	</para>
5583	</note>
5584
5585	</sect1>
5586
5587	<sect1 id="vboxmanage-mediumproperty">
5588
5589	<title>VBoxManage mediumproperty</title>
5590
5591	<para>
5592	This command sets, gets, or deletes a medium property. The syntax
5593	is as follows:
5594	</para>
5595
5596	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] set <uuid\|filename>
5597	<property> <value></screen>
5598
5599	<itemizedlist>
5600
5601	<listitem>
5602	<para>
5603	Use <computeroutput><disk\|dvd\|floppy></computeroutput>
5604	to optionally specify the type of medium: disk (hard drive),
5605	dvd, or floppy.
5606	</para>
5607	</listitem>
5608
5609	<listitem>
5610	<para>
5611	Use <computeroutput><uuid\|filename></computeroutput> to
5612	supply either the UUID or absolute path of the medium or
5613	image.
5614	</para>
5615	</listitem>
5616
5617	<listitem>
5618	<para>
5619	Use <computeroutput><property></computeroutput> to
5620	supply the name of the property.
5621	</para>
5622	</listitem>
5623
5624	<listitem>
5625	<para>
5626	Use <computeroutput><value></computeroutput> to supply
5627	the property value.
5628	</para>
5629	</listitem>
5630
5631	</itemizedlist>
5632
5633	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] get <uuid\|filename>
5634	<property></screen>
5635
5636	<itemizedlist>
5637
5638	<listitem>
5639	<para>
5640	Use <computeroutput><disk\|dvd\|floppy></computeroutput>
5641	to optionally specify the type of medium: disk (hard drive),
5642	dvd, or floppy.
5643	</para>
5644	</listitem>
5645
5646	<listitem>
5647	<para>
5648	Use <computeroutput><uuid\|filename></computeroutput> to
5649	supply either the UUID or absolute path of the medium or
5650	image.
5651	</para>
5652	</listitem>
5653
5654	<listitem>
5655	<para>
5656	Use <computeroutput><property></computeroutput> to
5657	supply the name of the property.
5658	</para>
5659	</listitem>
5660
5661	</itemizedlist>
5662
5663	<screen>VBoxManage mediumproperty [disk\|dvd\|floppy] delete <uuid\|filename>
5664	<property></screen>
5665
5666	<itemizedlist>
5667
5668	<listitem>
5669	<para>
5670	Use <computeroutput><disk\|dvd\|floppy></computeroutput>
5671	to optionally specify the type of medium: disk (hard drive),
5672	dvd, or floppy.
5673	</para>
5674	</listitem>
5675
5676	<listitem>
5677	<para>
5678	Use <computeroutput><uuid\|filename></computeroutput> to
5679	supply either the UUID or absolute path of the medium or
5680	image.
5681	</para>
5682	</listitem>
5683
5684	<listitem>
5685	<para>
5686	Use <computeroutput><property></computeroutput> to
5687	supply the name of the property.
5688	</para>
5689	</listitem>
5690
5691	</itemizedlist>
5692
5693	</sect1>
5694
5695	<sect1 id="vboxmanage-encryptmedium">
5696
5697	<title>VBoxManage encryptmedium</title>
5698
5699	<para>
5700	This command is used to create a DEK encrypted medium or image.
5701	See <xref linkend="diskencryption-encryption" />.
5702	</para>
5703
5704	<para>
5705	The syntax is as follows:
5706	</para>
5707
5708	<screen>VBoxManage encryptmedium <uuid\|filename>
5709	[--newpassword <file\|->]
5710	[--oldpassword <file\|->]
5711	[--cipher <cipher id>]
5712	[--newpasswordid <password id>]</screen>
5713
5714	<itemizedlist>
5715
5716	<listitem>
5717	<para>
5718	Use <computeroutput><uuid\|filename></computeroutput> to
5719	supply the UUID or absolute path of the medium or image to be
5720	encrypted.
5721	</para>
5722	</listitem>
5723
5724	<listitem>
5725	<para>
5726	Use <computeroutput>--newpassword
5727	<file\|-></computeroutput> to supply a new encryption
5728	password. Either specify the absolute pathname of a password
5729	file on the host operating system, or
5730	<computeroutput>-</computeroutput> to prompt you for the
5731	password on the command line. Always use the
5732	<computeroutput>--newpasswordid</computeroutput> option with
5733	this option.
5734	</para>
5735	</listitem>
5736
5737	<listitem>
5738	<para>
5739	Use <computeroutput>--oldpassword
5740	<file\|-></computeroutput> to supply any old encryption
5741	password. Either specify the absolute pathname of a password
5742	file on the host operating system, or
5743	<computeroutput>-</computeroutput> to prompt you for the old
5744	password on the command line.
5745	</para>
5746
5747	<para>
5748	Use this option to gain access to an encrypted medium or image
5749	to either change its password using
5750	<computeroutput>--newpassword</computeroutput> or change its
5751	encryption using <computeroutput>--cipher</computeroutput>.
5752	</para>
5753	</listitem>
5754
5755	<listitem>
5756	<para>
5757	Use <computeroutput>--cipher <cipher></computeroutput>
5758	to specify the cipher to use for encryption. This can be
5759	either <computeroutput>AES-XTS128-PLAIN64</computeroutput> or
5760	<computeroutput>AES-XTS256-PLAIN64</computeroutput>.
5761	</para>
5762
5763	<para>
5764	Use this option to change any existing encryption on the
5765	medium or image, or to set up new encryption on it for the
5766	first time.
5767	</para>
5768	</listitem>
5769
5770	<listitem>
5771	<para>
5772	Use <computeroutput>--newpasswordid <password
5773	id></computeroutput> to supply the new password identifier.
5774	This can be chosen by the user, and is used for correct
5775	identification when supplying multiple passwords during VM
5776	startup.
5777	</para>
5778
5779	<para>
5780	If the user uses the same password when encrypting multiple
5781	images and also the same password identifier, the user needs
5782	to supply the password only once during VM startup.
5783	</para>
5784	</listitem>
5785
5786	</itemizedlist>
5787
5788	</sect1>
5789
5790	<sect1 id="vboxmanage-checkmediumpwd">
5791
5792	<title>VBoxManage checkmediumpwd</title>
5793
5794	<para>
5795	This command is used to check the current encryption password on a
5796	DEK encrypted medium or image. See
5797	<xref linkend="diskencryption-encryption" />.
5798	</para>
5799
5800	<para>
5801	The syntax is as follows:
5802	</para>
5803
5804	<screen>VBoxManage checkmediumpwd <uuid\|filename>
5805	<pwd file\|-></screen>
5806
5807	<itemizedlist>
5808
5809	<listitem>
5810	<para>
5811	Use <computeroutput><uuid\|filename></computeroutput> to
5812	supply the UUID or absolute path of the medium or image to be
5813	checked.
5814	</para>
5815	</listitem>
5816
5817	<listitem>
5818	<para>
5819	Use <computeroutput><pwd file\|-></computeroutput> to
5820	supply the password identifier to be checked. Either specify
5821	the absolute pathname of a password file on the host operating
5822	system, or <computeroutput>-</computeroutput> to prompt you
5823	for the password on the command line.
5824	</para>
5825	</listitem>
5826
5827	</itemizedlist>
5828
5829	</sect1>
5830
5831	<sect1 id="vboxmanage-convertfromraw">
5832
5833	<title>VBoxManage convertfromraw</title>
5834
5835	<para>
5836	This command converts a raw disk image to a &product-name; Disk
5837	Image (VDI) file. The syntax is as follows:
5838	</para>
5839
5840	<screen>VBoxManage convertfromraw <filename> <outputfile>
5841	[--format VDI\|VMDK\|VHD]
5842	[--variant Standard,Fixed,Split2G,Stream,ESX]
5843	[--uuid <uuid>]
5844	VBoxManage convertfromraw stdin <outputfile> <bytes>
5845	[--format VDI\|VMDK\|VHD]
5846	[--variant Standard,Fixed,Split2G,Stream,ESX]
5847	[--uuid <uuid>]</screen>
5848
5849	<para>
5850	The parameters are as follows:
5851	</para>
5852
5853	<variablelist>
5854
5855	<varlistentry>
5856	<term>
5857	<computeroutput>--bytes</computeroutput>
5858	</term>
5859
5860	<listitem>
5861	<para>
5862	The size of the image file, in bytes, provided through
5863	stdin.
5864	</para>
5865	</listitem>
5866	</varlistentry>
5867
5868	<varlistentry>
5869	<term>
5870	<computeroutput>--format</computeroutput>
5871	</term>
5872
5873	<listitem>
5874	<para>
5875	Select the disk image format to create. The default format
5876	is VDI. Other options are VMDK and VHD.
5877	</para>
5878	</listitem>
5879	</varlistentry>
5880
5881	<varlistentry>
5882	<term>
5883	<computeroutput>--variant</computeroutput>
5884	</term>
5885
5886	<listitem>
5887	<para>
5888	Choose a file format variant for the output file. This is a
5889	comma-separated list of variant flags. Not all combinations
5890	are supported, and specifying inconsistent flags will result
5891	in an error message.
5892	</para>
5893	</listitem>
5894	</varlistentry>
5895
5896	<varlistentry>
5897	<term>
5898	<computeroutput>--uuid</computeroutput>
5899	</term>
5900
5901	<listitem>
5902	<para>
5903	Specify the UUID of the output file.
5904	</para>
5905	</listitem>
5906	</varlistentry>
5907
5908	</variablelist>
5909
5910	<para>
5911	The <command>stdin</command> form of the command forces
5912	<command>VBoxManage</command> to read the content of the disk
5913	image from standard input. This useful when using the command in a
5914	pipe.
5915	</para>
5916
5917	<note>
5918	<para>
5919	For compatibility with earlier versions of &product-name;, the
5920	<command>convertdd</command> command is also supported and
5921	mapped internally to the <command>convertfromraw</command>
5922	command.
5923	</para>
5924	</note>
5925
5926	</sect1>
5927
5928	<sect1 id="vboxmanage-extradata">
5929
5930	<title>VBoxManage getextradata/setextradata</title>
5931
5932	<para>
5933	These commands enable you to attach and retrieve string data for a
5934	virtual machine or for a &product-name; configuration, by
5935	specifying <computeroutput>global</computeroutput> instead of a
5936	virtual machine name. You must specify a keyword as a text string
5937	to associate the data with, which you can later use to retrieve
5938	it. For example:
5939	</para>
5940
5941	<screen>VBoxManage setextradata Fedora5 installdate 2006.01.01
5942	VBoxManage setextradata SUSE10 installdate 2006.02.02</screen>
5943
5944	<para>
5945	This example would associate the string "2006.01.01" with the
5946	keyword installdate for the virtual machine Fedora5, and
5947	"2006.02.02" on the machine SUSE10. You could then retrieve the
5948	information as follows:
5949	</para>
5950
5951	<screen>VBoxManage getextradata Fedora5 installdate</screen>
5952
5953	<para>
5954	This would return the following:
5955	</para>
5956
5957	<screen>VirtualBox Command Line Management Interface Version <replaceable>version-number</replaceable>
5958	(C) 2005-2018 Oracle Corporation
5959	All rights reserved.
5960
5961	Value: 2006.01.01</screen>
5962
5963	<para>
5964	You could retrieve the information for all keywords as follows:
5965	</para>
5966
5967	<screen>VBoxManage getextradata Fedora5 enumerate</screen>
5968
5969	<para>
5970	To remove a keyword, the <command>setextradata</command> command
5971	must be run without specifying data, only the keyword. For
5972	example:
5973	</para>
5974
5975	<screen>VBoxManage setextradata Fedora5 installdate</screen>
5976
5977	</sect1>
5978
5979	<sect1 id="vboxmanage-setproperty">
5980
5981	<title>VBoxManage setproperty</title>
5982
5983	<para>
5984	This command is used to change global settings which affect the
5985	entire &product-name; installation. Some of these correspond to
5986	the settings in the <emphasis role="bold">Global
5987	Settings</emphasis> dialog in the graphical user interface. The
5988	following properties are available:
5989	</para>
5990
5991	<variablelist>
5992
5993	<varlistentry>
5994	<term>
5995	<computeroutput>machinefolder</computeroutput>
5996	</term>
5997
5998	<listitem>
5999	<para>
6000	Specifies the default folder in which virtual machine
6001	definitions are kept. See <xref linkend="vboxconfigdata" />.
6002	</para>
6003	</listitem>
6004	</varlistentry>
6005
6006	<varlistentry>
6007	<term>
6008	<computeroutput>hwvirtexclusive</computeroutput>
6009	</term>
6010
6011	<listitem>
6012	<para>
6013	Specifies whether &product-name; will make exclusive use of
6014	the hardware virtualization extensions (Intel VT-x or AMD-V)
6015	of the host system's processor. See
6016	<xref linkend="hwvirt" />. If you wish to share these
6017	extensions with other hypervisors running at the same time,
6018	you must disable this setting. Doing so has negative
6019	performance implications.
6020	</para>
6021	</listitem>
6022	</varlistentry>
6023
6024	<varlistentry>
6025	<term>
6026	<computeroutput>vrdeauthlibrary</computeroutput>
6027	</term>
6028
6029	<listitem>
6030	<para>
6031	Specifies which library to use when external authentication
6032	has been selected for a particular virtual machine. See
6033	<xref linkend="vbox-auth" />.
6034	</para>
6035	</listitem>
6036	</varlistentry>
6037
6038	<varlistentry>
6039	<term>
6040	<computeroutput>websrvauthlibrary</computeroutput>
6041	</term>
6042
6043	<listitem>
6044	<para>
6045	Specifies which library the web service uses to authenticate
6046	users. For details about the &product-name; web service, see
6047	the &product-name; SDK reference,
6048	<xref
6049	linkend="VirtualBoxAPI" />.
6050	</para>
6051	</listitem>
6052	</varlistentry>
6053
6054	<varlistentry>
6055	<term>
6056	<computeroutput>vrdeextpack</computeroutput>
6057	</term>
6058
6059	<listitem>
6060	<para>
6061	Specifies which library implements the VirtualBox Remote
6062	Desktop Extension.
6063	</para>
6064	</listitem>
6065	</varlistentry>
6066
6067	<varlistentry>
6068	<term>
6069	<computeroutput>loghistorycount</computeroutput>
6070	</term>
6071
6072	<listitem>
6073	<para>
6074	Selects how many rotated VM logs are retained.
6075	</para>
6076	</listitem>
6077	</varlistentry>
6078
6079	<varlistentry>
6080	<term>
6081	<computeroutput>autostartdbpath</computeroutput>
6082	</term>
6083
6084	<listitem>
6085	<para>
6086	Selects the path to the autostart database. See
6087	<xref linkend="autostart" />.
6088	</para>
6089	</listitem>
6090	</varlistentry>
6091
6092	<varlistentry>
6093	<term>
6094	<computeroutput>defaultfrontend</computeroutput>
6095	</term>
6096
6097	<listitem>
6098	<para>
6099	Selects the global default VM frontend setting. See
6100	<xref linkend="vboxmanage-startvm" />.
6101	</para>
6102	</listitem>
6103	</varlistentry>
6104
6105	<varlistentry>
6106	<term>
6107	<computeroutput>logginglevel</computeroutput>
6108	</term>
6109
6110	<listitem>
6111	<para>
6112	Configures the VBoxSVC release logging details. See
6113	<ulink url="http://www.virtualbox.org/wiki/VBoxLogging">http://www.virtualbox.org/wiki/VBoxLogging</ulink>.
6114	</para>
6115	</listitem>
6116	</varlistentry>
6117
6118	<varlistentry>
6119	<term>
6120	<computeroutput>proxymode</computeroutput>
6121	</term>
6122
6123	<listitem>
6124	<para>
6125	Configures the mode for an HTTP proxy server.
6126	</para>
6127	</listitem>
6128	</varlistentry>
6129
6130	<varlistentry>
6131	<term>
6132	<computeroutput>proxyurl</computeroutput>
6133	</term>
6134
6135	<listitem>
6136	<para>
6137	Configures the URL for an HTTP proxy server. Used when a
6138	manual proxy is configured using the
6139	<computeroutput>manual</computeroutput> setting of the
6140	<computeroutput>proxymode</computeroutput> property.
6141	</para>
6142	</listitem>
6143	</varlistentry>
6144
6145	</variablelist>
6146
6147	</sect1>
6148
6149	<sect1 id="vboxmanage-usbfilter">
6150
6151	<title>VBoxManage usbfilter add/modify/remove</title>
6152
6153	<screen>VBoxManage usbfilter add <index,0-N>
6154	--target <uuid\|vmname>global
6155	--name <string>
6156	--action ignore\|hold (global filters only)
6157	[--active yes\|no (yes)]
6158	[--vendorid <XXXX> (null)]
6159	[--productid <XXXX> (null)]
6160	[--revision <IIFF> (null)]
6161	[--manufacturer <string> (null)]
6162	[--product <string> (null)]
6163	[--remote yes\|no (null, VM filters only)]
6164	[--serialnumber <string> (null)]
6165	[--maskedinterfaces <XXXXXXXX>]
6166	</screen>
6167
6168	<screen>VBoxManage usbfilter modify <index,0-N>
6169	--target <uuid\|vmname>global
6170	[--name <string>]
6171	[--action ignore\|hold (global filters only)]
6172	[--active yes\|no]
6173	[--vendorid <XXXX>]
6174	[--productid <XXXX>]
6175	[--revision <IIFF>]
6176	[--manufacturer <string>]
6177	[--product <string>]
6178	[--remote yes\|no (null, VM filters only)]
6179	[--serialnumber <string>]
6180	[--maskedinterfaces <XXXXXXXX>]
6181	</screen>
6182
6183	<screen>VBoxManage usbfilter remove <index,0-N>
6184	--target <uuid\|vmname>global
6185	</screen>
6186
6187	<para>
6188	The <command>usbfilter</command> commands are used for working
6189	with USB filters in virtual machines, or global filters which
6190	affect the whole &product-name; setup. Global filters are applied
6191	before machine-specific filters, and may be used to prevent
6192	devices from being captured by any virtual machine. Global filters
6193	are always applied in a particular order, and only the first
6194	filter which fits a device is applied. For example, if the first
6195	global filter says to hold, or make available, a particular
6196	Kingston memory stick device and the second filter says to ignore
6197	all Kingston devices. That particular Kingston memory stick will
6198	be available to any machine with the appropriate filter, but no
6199	other Kingston device will.
6200	</para>
6201
6202	<para>
6203	When creating a USB filter using <command>usbfilter add</command>,
6204	you must supply three or four mandatory parameters. The index
6205	specifies the position in the list at which the filter should be
6206	placed. If there is already a filter at that position, then it and
6207	the following ones will be shifted back one place. Otherwise, the
6208	new filter will be added onto the end of the list. The
6209	<computeroutput>target</computeroutput> parameter selects the
6210	virtual machine that the filter should be attached to or use
6211	<computeroutput>global</computeroutput> to apply it to all virtual
6212	machines. <computeroutput>name</computeroutput> is a name for the
6213	new filter. For global filters,
6214	<computeroutput>action</computeroutput> says whether to allow VMs
6215	access to devices that fit the filter description (hold) or not to
6216	give them access (ignore). In addition, you should specify
6217	parameters to filter by. You can find the parameters for devices
6218	attached to your system using <command>VBoxManage list
6219	usbhost</command>. Finally, you can specify whether the filter
6220	should be active. For local filters, whether they are for local
6221	devices, remote devices over an RDP connection, or either.
6222	</para>
6223
6224	<para>
6225	When you modify a USB filter using <command>usbfilter
6226	modify</command>, you must specify the filter by index and by
6227	target, which is either a virtual machine or
6228	<computeroutput>global</computeroutput>. See the output of
6229	<command>VBoxManage list usbfilters</command> to find global
6230	filter indexes and <command>VBoxManage showvminfo</command> to
6231	find indexes for individual machines. The properties which can be
6232	changed are the same as for <command>usbfilter add</command>. To
6233	remove a filter, use <command>usbfilter remove</command> and
6234	specify the index and the target.
6235	</para>
6236
6237	<para>
6238	The following is a list of the additional <command>usbfilter
6239	add</command> and <command>usbfilter modify</command> options,
6240	with details of how to use them.
6241	</para>
6242
6243	<itemizedlist>
6244
6245	<listitem>
6246	<para>
6247	<computeroutput>--action ignore\|hold</computeroutput>:
6248	Specifies whether devices that fit the filter description are
6249	allowed access by machines (hold), or have access denied
6250	(ignore). Applies to global filters only.
6251	</para>
6252	</listitem>
6253
6254	<listitem>
6255	<para>
6256	<computeroutput>--active yes\|no</computeroutput>: Specifies
6257	whether the USB Filter is active or temporarily disabled. For
6258	<computeroutput>usbfilter create</computeroutput> the default
6259	is active.
6260	</para>
6261	</listitem>
6262
6263	<listitem>
6264	<para>
6265	<computeroutput>--vendorid <XXXX>\|""</computeroutput>:
6266	Specifies a vendor ID filter. The string representation for an
6267	exact match has the form XXXX, where X is the hexadecimal
6268	digit, including leading zeroes.
6269	</para>
6270	</listitem>
6271
6272	<listitem>
6273	<para>
6274	<computeroutput>--productid <XXXX>\|""</computeroutput>:
6275	Specifies a product ID filter. The string representation for
6276	an exact match has the form XXXX, where X is the hexadecimal
6277	digit, including leading zeroes.
6278	</para>
6279	</listitem>
6280
6281	<listitem>
6282	<para>
6283	<computeroutput>--revision <IIFF>\|""</computeroutput>:
6284	Specifies a revision ID filter. The string representation for
6285	an exact match has the form IIFF, where I is the decimal digit
6286	of the integer part of the revision, and F is the decimal
6287	digit of its fractional part, including leading and trailing
6288	zeros. Note that for interval filters, it is best to use the
6289	hexadecimal form, because the revision is stored as a 16-bit
6290	packed BCD value. Therefore, the expression int:0x0100-0x0199
6291	will match any revision from 1.0 to 1.99 inclusive.
6292	</para>
6293	</listitem>
6294
6295	<listitem>
6296	<para>
6297	<computeroutput>--manufacturer
6298	<string>\|""</computeroutput>: Specifies a manufacturer
6299	ID filter, as a string.
6300	</para>
6301	</listitem>
6302
6303	<listitem>
6304	<para>
6305	<computeroutput>--product <string>\|""</computeroutput>:
6306	Specifies a product ID filter, as a string.
6307	</para>
6308	</listitem>
6309
6310	<listitem>
6311	<para>
6312	<computeroutput>--remote yes\|no""</computeroutput>: Specifies
6313	a remote filter, indicating whether the device is physically
6314	connected to a remote VRDE client or to a local host machine.
6315	Applies to VM filters only.
6316	</para>
6317	</listitem>
6318
6319	<listitem>
6320	<para>
6321	<computeroutput>--serialnumber
6322	<string>\|""</computeroutput>: Specifies a serial number
6323	filter, as a string.
6324	</para>
6325	</listitem>
6326
6327	<listitem>
6328	<para>
6329	<computeroutput>--maskedinterfaces
6330	<XXXXXXXX></computeroutput>: Specifies a masked
6331	interface filter, for hiding one or more USB interfaces from
6332	the guest. The value is a bit mask where the set bits
6333	correspond to the USB interfaces that should be hidden, or
6334	masked off. This feature only works on Linux hosts.
6335	</para>
6336	</listitem>
6337
6338	</itemizedlist>
6339
6340	</sect1>
6341
6342	<sect1 id="vboxmanage-sharedfolder">
6343
6344	<title>VBoxManage sharedfolder add/remove</title>
6345
6346	<screen>
6347	VBoxManage sharedfolder add <uuid\|vmname>
6348	--name <name> --hostpath <hostpath>
6349	[--transient] [--readonly] [--automount]
6350	</screen>
6351
6352	<para>
6353	This command enables you to share folders on the host computer
6354	with guest operating systems. For this, the guest systems must
6355	have a version of the &product-name; Guest Additions installed
6356	which supports this functionality.
6357	</para>
6358
6359	<para>
6360	Parameters are as follows:
6361	</para>
6362
6363	<itemizedlist>
6364
6365	<listitem>
6366	<para>
6367	<computeroutput><uuid\|vmname></computeroutput>:
6368	Specifies the UUID or name of the VM whose guest operating
6369	system will be sharing folders with the host computer.
6370	Mandatory.
6371	</para>
6372	</listitem>
6373
6374	<listitem>
6375	<para>
6376	<computeroutput>--name <name></computeroutput>:
6377	Specifies the name of the share. Each share has a unique name
6378	within the namespace of the host operating system. Mandatory.
6379	</para>
6380	</listitem>
6381
6382	<listitem>
6383	<para>
6384	<computeroutput>-hostpath <hostpath></computeroutput>:
6385	Specifies the absolute path on the host operating system of
6386	the directory to be shared with the guest operating system.
6387	Mandatory.
6388	</para>
6389	</listitem>
6390
6391	<listitem>
6392	<para>
6393	<computeroutput>-transient</computeroutput>: Specifies that
6394	the share is transient, meaning that it can be added and
6395	removed at runtime and does not persist after the VM has
6396	stopped. Optional.
6397	</para>
6398	</listitem>
6399
6400	<listitem>
6401	<para>
6402	<computeroutput>-readonly</computeroutput>: Specifies that the
6403	share has only read-only access to files at the host path.
6404	</para>
6405
6406	<para>
6407	By default, shared folders have read/write access to the files
6408	on the host path. On Linux distributions, shared folders are
6409	mounted with 770 file permissions with root user and vboxsf as
6410	the group. Using this option the file permissions change to
6411	700. Optional.
6412	</para>
6413	</listitem>
6414
6415	<listitem>
6416	<para>
6417	<computeroutput>-automount</computeroutput>: Specifies that
6418	the share will be automatically mounted. On Linux
6419	distributions, this will be to either
6420	<computeroutput>/media/USER/sf_<name></computeroutput>
6421	or <computeroutput>/media/sf_<name></computeroutput>,
6422	where <name> is the share named. The actual location
6423	depends on the guest OS. Optional.
6424	</para>
6425	</listitem>
6426
6427	</itemizedlist>
6428
6429	<screen>
6430	VBoxManage sharedfolder remove <uuid\|vmname>
6431	--name <name> [--transient]
6432
6433	</screen>
6434
6435	<para>
6436	This command enables you to delete shared folders on the host
6437	computer shares with the guest operating systems. For this, the
6438	guest systems must have a version of the &product-name; Guest
6439	Additions installed which supports this functionality.
6440	</para>
6441
6442	<para>
6443	Parameters are as follows:
6444	</para>
6445
6446	<itemizedlist>
6447
6448	<listitem>
6449	<para>
6450	<computeroutput><uuid\|vmname></computeroutput>:
6451	Specifies the UUID or name of the VM whose guest operating
6452	system is sharing folders with the host computer. Mandatory.
6453	</para>
6454	</listitem>
6455
6456	<listitem>
6457	<para>
6458	<computeroutput>--name <name></computeroutput>:
6459	Specifies the name of the share to be removed. Each share has
6460	a unique name within the namespace of the host operating
6461	system. Mandatory.
6462	</para>
6463	</listitem>
6464
6465	<listitem>
6466	<para>
6467	<computeroutput>-transient</computeroutput>: Specifies that
6468	the share is transient, meaning that it can be added and
6469	removed at runtime and does not persist after the VM has
6470	stopped. Optional.
6471	</para>
6472	</listitem>
6473
6474	</itemizedlist>
6475
6476	<para>
6477	Shared folders are described in <xref linkend="sharedfolders" />.
6478	</para>
6479
6480	</sect1>
6481
6482	<sect1 id="vboxmanage-guestproperty">
6483
6484	<title>VBoxManage guestproperty</title>
6485
6486	<para>
6487	The <command>guestproperty</command> commands enable you to get or
6488	set properties of a running virtual machine. See
6489	<xref linkend="guestadd-guestprops" />. Guest properties are
6490	arbitrary keyword-value string pairs which can be written to and
6491	read from by either the guest or the host, so they can be used as
6492	a low-volume communication channel for strings, provided that a
6493	guest is running and has the Guest Additions installed. In
6494	addition, a number of values whose keywords begin with
6495	<computeroutput>/VirtualBox/</computeroutput>are automatically set
6496	and maintained by the Guest Additions.
6497	</para>
6498
6499	<para>
6500	The following subcommands are available, where
6501	<computeroutput><vm></computeroutput> can either be a VM
6502	name or a VM UUID, as with the other <command>VBoxManage</command>
6503	commands:
6504	</para>
6505
6506	<itemizedlist>
6507
6508	<listitem>
6509	<para>
6510	<computeroutput>enumerate <vm> [--patterns
6511	<pattern>]</computeroutput>: Lists all the guest
6512	properties that are available for the given VM, including the
6513	value. This list will be very limited if the guest's service
6514	process cannot be contacted, for example because the VM is not
6515	running or the Guest Additions are not installed.
6516	</para>
6517
6518	<para>
6519	If <computeroutput>--patterns <pattern></computeroutput>
6520	is specified, it acts as a filter to only list properties that
6521	match the given pattern. The pattern can contain the following
6522	wildcard characters:
6523	</para>
6524
6525	<itemizedlist>
6526
6527	<listitem>
6528	<para>
6529	<computeroutput>*</computeroutput> (asterisk): Represents
6530	any number of characters. For example,
6531	"<computeroutput>/VirtualBox*</computeroutput>" would
6532	match all properties beginning with "/VirtualBox".
6533	</para>
6534	</listitem>
6535
6536	<listitem>
6537	<para>
6538	<computeroutput>?</computeroutput> (question mark):
6539	Represents a single arbitrary character. For example,
6540	"<computeroutput>fo?</computeroutput>" would match both
6541	"foo" and "for".
6542	</para>
6543	</listitem>
6544
6545	<listitem>
6546	<para>
6547	<computeroutput>\|</computeroutput> (pipe symbol): Can be
6548	used to specify multiple alternative patterns. For
6549	example, "<computeroutput>s\|t</computeroutput>" would
6550	match anything starting with either "s" or "t".
6551	</para>
6552	</listitem>
6553
6554	</itemizedlist>
6555	</listitem>
6556
6557	<listitem>
6558	<para>
6559	<computeroutput>get <vm>
6560	<property></computeroutput>: Retrieves the value of a
6561	single property only. If the property cannot be found, for
6562	example because the guest is not running, the following
6563	message is shown:
6564	</para>
6565
6566	<screen>No value set!</screen>
6567	</listitem>
6568
6569	<listitem>
6570	<para>
6571	<computeroutput>set <vm> <property> [<value>
6572	[--flags <flags>]]</computeroutput>: Enables you to set
6573	a guest property by specifying the keyword and value. If
6574	<computeroutput><value></computeroutput> is omitted, the
6575	property is deleted. With
6576	<computeroutput>--flags</computeroutput>, you can specify
6577	additional behavior. You can combine several flags by
6578	separating them with commas.
6579	</para>
6580
6581	<itemizedlist>
6582
6583	<listitem>
6584	<para>
6585	<computeroutput>TRANSIENT</computeroutput>: The value will
6586	not be stored with the VM data when the VM exits.
6587	</para>
6588	</listitem>
6589
6590	<listitem>
6591	<para>
6592	<computeroutput>TRANSRESET</computeroutput>: The value
6593	will be deleted as soon as the VM restarts or exits.
6594	</para>
6595	</listitem>
6596
6597	<listitem>
6598	<para>
6599	<computeroutput>RDONLYGUEST</computeroutput>: The value
6600	can only be changed by the host, but the guest can only
6601	read it.
6602	</para>
6603	</listitem>
6604
6605	<listitem>
6606	<para>
6607	<computeroutput>RDONLYHOST</computeroutput>: The value can
6608	only be changed by the guest, but the host can only read
6609	it.
6610	</para>
6611	</listitem>
6612
6613	<listitem>
6614	<para>
6615	<computeroutput>READONLY</computeroutput>: The value
6616	cannot be changed at all.
6617	</para>
6618	</listitem>
6619
6620	</itemizedlist>
6621	</listitem>
6622
6623	<listitem>
6624	<para>
6625	<computeroutput>wait <vm> <pattern> --timeout
6626	<timeout></computeroutput>: Waits for a particular value
6627	described by the pattern string to change or to be deleted or
6628	created. The pattern rules are the same as for the
6629	<command>enumerate</command> subcommand.
6630	</para>
6631	</listitem>
6632
6633	<listitem>
6634	<para>
6635	<computeroutput>delete <vm>
6636	<property></computeroutput>: Deletes a guest property
6637	which has been set previously.
6638	</para>
6639	</listitem>
6640
6641	</itemizedlist>
6642
6643	</sect1>
6644
6645	<sect1 id="vboxmanage-guestcontrol">
6646
6647	<title>VBoxManage guestcontrol</title>
6648
6649	<para>
6650	The <command>guestcontrol</command> commands enable control of the
6651	guest from the host. See
6652	<xref
6653	linkend="guestadd-guestcontrol" /> for an introduction.
6654	</para>
6655
6656	<para>
6657	The <command>guestcontrol</command> command has two sets of
6658	subcommands. The first set requires guest credentials to be
6659	specified, the second does not.
6660	</para>
6661
6662	<para>
6663	The first set of subcommands is of the following form:
6664	</para>
6665
6666	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
6667	[--username <name> ]
6668	[--passwordfile <file> \| --password <password>]
6669	[--domain <domain> ]
6670	[-v\|--verbose] [-q\|quiet] ...
6671	</screen>
6672
6673	<para>
6674	The common options are as follows:
6675	</para>
6676
6677	<screen>
6678	[--username <name> ]
6679	[--passwordfile <file> \| --password <password>]
6680	[--domain <domain> ]
6681	[-v\|--verbose] [-q\|quiet]
6682	</screen>
6683
6684	<para>
6685	The common options for the first set of subcommands are explained
6686	in the following list.
6687	</para>
6688
6689	<variablelist>
6690
6691	<varlistentry>
6692	<term>
6693	<computeroutput><uuid\|vmname></computeroutput>
6694	</term>
6695
6696	<listitem>
6697	<para>
6698	Specifies the VM UUID or VM name. Mandatory.
6699	</para>
6700	</listitem>
6701	</varlistentry>
6702
6703	<varlistentry>
6704	<term>
6705	<computeroutput>--username <name></computeroutput>
6706	</term>
6707
6708	<listitem>
6709	<para>
6710	Specifies the user name on guest OS under which the process
6711	should run. This user name must already exist on the guest
6712	OS. If unspecified, the host user name is used. Optional
6713	</para>
6714	</listitem>
6715	</varlistentry>
6716
6717	<varlistentry>
6718	<term>
6719	<computeroutput>--passwordfile
6720	<file>\|--password</computeroutput>
6721	</term>
6722
6723	<listitem>
6724	<para>
6725	Specifies the absolute path on guest file system of password
6726	file containing the password for the specified user account
6727	or password for the specified user account. Optional. If
6728	both are omitted, empty password is assumed.
6729	</para>
6730	</listitem>
6731	</varlistentry>
6732
6733	<varlistentry>
6734	<term>
6735	<computeroutput>--domain <domain></computeroutput>
6736	</term>
6737
6738	<listitem>
6739	<para>
6740	User domain for Windows guests. Optional.
6741	</para>
6742	</listitem>
6743	</varlistentry>
6744
6745	<varlistentry>
6746	<term>
6747	<computeroutput>-v\|--verbose</computeroutput>
6748	</term>
6749
6750	<listitem>
6751	<para>
6752	Makes the subcommand execution more verbose. Optional
6753	</para>
6754	</listitem>
6755	</varlistentry>
6756
6757	<varlistentry>
6758	<term>
6759	<computeroutput>-q\|--quiet</computeroutput>
6760	</term>
6761
6762	<listitem>
6763	<para>
6764	Makes the subcommand execution quieter. Optional.
6765	</para>
6766	</listitem>
6767	</varlistentry>
6768
6769	</variablelist>
6770
6771	<para>
6772	The first set of subcommands are as follows:
6773	</para>
6774
6775	<itemizedlist>
6776
6777	<listitem>
6778	<para>
6779	<computeroutput>run</computeroutput>: Executes a guest
6780	program, forwarding stdout, stderr, and stdin to and from the
6781	host until it completes.
6782	</para>
6783
6784	<screen>VBoxManage guestcontrol <uuid\|vmname> run [common-options]
6785	--exe <path to executable> [--timeout <msec>]
6786	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
6787	[--ignore-operhaned-processes] [--profile]
6788	[--no-wait-stdout\|--wait-stdout]
6789	[--no-wait-stderr\|--wait-stderr]
6790	[--dos2unix] [--unix2dos]
6791	-- <program/arg0> [argument1] ... [argumentN]]
6792	</screen>
6793
6794	<variablelist>
6795
6796	<varlistentry>
6797	<term>
6798	<computeroutput><uuid\|vmname></computeroutput>
6799	</term>
6800
6801	<listitem>
6802	<para>
6803	Specifies the VM UUID or VM name. Mandatory.
6804	</para>
6805	</listitem>
6806	</varlistentry>
6807
6808	<varlistentry>
6809	<term>
6810	<computeroutput>--exe <path to
6811	executable></computeroutput>
6812	</term>
6813
6814	<listitem>
6815	<para>
6816	Specifies the absolute path of the executable on the
6817	guest OS file system. Mandatory. For example:
6818	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
6819	</para>
6820	</listitem>
6821	</varlistentry>
6822
6823	<varlistentry>
6824	<term>
6825	<computeroutput>--timeout <msec></computeroutput>
6826	</term>
6827
6828	<listitem>
6829	<para>
6830	Specifies the maximum time, in microseconds, that the
6831	executable can run, during which
6832	<command>VBoxManage</command> receives its output.
6833	Optional. If unspecified, <command>VBoxManage</command>
6834	waits indefinitely for the process to end, or an error
6835	occurs.
6836	</para>
6837	</listitem>
6838	</varlistentry>
6839
6840	<varlistentry>
6841	<term>
6842	<computeroutput>-E\|--putenv
6843	<NAME>=<VALUE></computeroutput>
6844	</term>
6845
6846	<listitem>
6847	<para>
6848	Sets, modifies, and unsets environment variables in the
6849	environment in which the program will run. Optional.
6850	</para>
6851
6852	<para>
6853	The guest process is created with the standard default
6854	guest OS environment. Use this option to modify that
6855	default environment. To set or modify a variable use:
6856	<computeroutput><NAME>=<VALUE></computeroutput>.
6857	To unset a variable use:
6858	<computeroutput><NAME>=</computeroutput>
6859	</para>
6860
6861	<para>
6862	Any spaces in names and values should be enclosed by
6863	quotes.
6864	</para>
6865
6866	<para>
6867	To set, modify, and unset multiple variables, use
6868	multiple instances of the
6869	<computeroutput>--E\|--putenv</computeroutput> option.
6870	</para>
6871	</listitem>
6872	</varlistentry>
6873
6874	<varlistentry>
6875	<term>
6876	<computeroutput>--unquoted-args</computeroutput>
6877	</term>
6878
6879	<listitem>
6880	<para>
6881	Disables escaped double quoting, such as \"fred\", on
6882	arguments passed to the executed program. Optional.
6883	</para>
6884	</listitem>
6885	</varlistentry>
6886
6887	<varlistentry>
6888	<term>
6889	<computeroutput>--ignore-operhaned-processes</computeroutput>
6890	</term>
6891
6892	<listitem>
6893	<para>
6894	Ignore orphaned processes. Not yet implemented.
6895	Optional.
6896	</para>
6897	</listitem>
6898	</varlistentry>
6899
6900	<varlistentry>
6901	<term>
6902	<computeroutput>--profile</computeroutput>
6903	</term>
6904
6905	<listitem>
6906	<para>
6907	Use Profile. Not yet implemented. Optional.
6908	</para>
6909	</listitem>
6910	</varlistentry>
6911
6912	<varlistentry>
6913	<term>
6914	<computeroutput>--no-wait-stdout\|--wait-stdout</computeroutput>
6915	</term>
6916
6917	<listitem>
6918	<para>
6919	Does not wait or waits until the guest process ends and
6920	receives its exit code and reason/flags. In the case of
6921	<computeroutput>--wait-stdout</computeroutput>,
6922	<command>VBoxManage</command> receives its stdout while
6923	the process runs. Optional.
6924	</para>
6925	</listitem>
6926	</varlistentry>
6927
6928	<varlistentry>
6929	<term>
6930	<computeroutput>--no-wait-stderr\|--wait-stderr</computeroutput>
6931	</term>
6932
6933	<listitem>
6934	<para>
6935	Does not wait or waits until the guest process ends and
6936	receives its exit code, error messages, and flags. In
6937	the case of
6938	<computeroutput>--wait-stderr</computeroutput>,
6939	<command>VBoxManage</command> receives its stderr while
6940	the process runs. Optional.
6941	</para>
6942	</listitem>
6943	</varlistentry>
6944
6945	<varlistentry>
6946	<term>
6947	<computeroutput>--dos2unix</computeroutput>
6948	</term>
6949
6950	<listitem>
6951	<para>
6952	Converts output from DOS/Windows guests to
6953	UNIX/Linux-compatible line endings, CR + LF to LF. Not
6954	yet implemented. Optional.
6955	</para>
6956	</listitem>
6957	</varlistentry>
6958
6959	<varlistentry>
6960	<term>
6961	<computeroutput>--unix2dos</computeroutput>
6962	</term>
6963
6964	<listitem>
6965	<para>
6966	Converts output from a UNIX/Linux guests to
6967	DOS/Windows-compatible line endings, LF to CR + LF. Not
6968	yet implemented. Optional.
6969	</para>
6970	</listitem>
6971	</varlistentry>
6972
6973	<varlistentry>
6974	<term>
6975	<computeroutput>[-- <program/arg0>
6976	[<argument1>] ...
6977	[<argumentN>]]</computeroutput>
6978	</term>
6979
6980	<listitem>
6981	<para>
6982	Specifies the program name, followed by one or more
6983	arguments to pass to the program. Optional.
6984	</para>
6985
6986	<para>
6987	Any spaces in arguments should be enclosed by quotes.
6988	</para>
6989	</listitem>
6990	</varlistentry>
6991
6992	</variablelist>
6993
6994	<note>
6995	<para>
6996	On Windows there are certain limitations for graphical
6997	applications. See <xref linkend="KnownIssues" />.
6998	</para>
6999	</note>
7000
7001	<para>
7002	Examples of using the <command>guestcontrol run</command>
7003	command are as follows:
7004	</para>
7005
7006	<screen>VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls"
7007	--username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen>
7008
7009	<screen>VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe"
7010	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen>
7011
7012	<para>
7013	Note that the double backslashes in the second example are
7014	only required on UNIX hosts.
7015	</para>
7016
7017	<note>
7018	<para>
7019	For certain commands a user name of an existing user account
7020	on the guest must be specified. Anonymous executions are not
7021	supported for security reasons. A user account password,
7022	however, is optional and depends on the guest's OS security
7023	policy or rules. If no password is specified for a given
7024	user name, an empty password will be used. On certain OSes
7025	like Windows the security policy may needs to be adjusted in
7026	order to allow user accounts with an empty password set.
7027	Also, global domain rules might apply and therefore cannot
7028	be changed.
7029	</para>
7030	</note>
7031
7032	<para>
7033	Starting at &product-name; 4.1.2 guest process execution by
7034	default is limited to serve up to five guest processes at a
7035	time. If a new guest process gets started which would exceed
7036	this limit, the oldest not running guest process will be
7037	discarded in order to be able to run that new process. Also,
7038	retrieving output from this old guest process will not be
7039	possible anymore then. If all five guest processes are still
7040	active and running, starting a new guest process will result
7041	in an appropriate error message.
7042	</para>
7043
7044	<para>
7045	To raise or lower the guest process execution limit, either
7046	use the guest property
7047	<computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
7048	or <command>VBoxService</command> command line by specifying
7049	<computeroutput>--control-procs-max-kept</computeroutput>
7050	needs to be modified. A restart of the guest OS is required
7051	afterwards. To serve unlimited guest processes, a value of
7052	<computeroutput>0</computeroutput> needs to be set, but this
7053	is not recommended.
7054	</para>
7055	</listitem>
7056
7057	<listitem>
7058	<para>
7059	<computeroutput>start</computeroutput>: Executes a guest
7060	program until it completes.
7061	</para>
7062
7063	<screen>VBoxManage guestcontrol <uuid\|vmname> start [common-options]
7064	[--exe <path to executable>] [--timeout <msec>]
7065	[-E\|--putenv <NAME>[=<VALUE>]] [--unquoted-args]
7066	[--ignore-operhaned-processes] [--profile]
7067	-- <program/arg0> [argument1] ... [argumentN]]
7068	</screen>
7069
7070	<para>
7071	Where the options are as follows:
7072	</para>
7073
7074	<variablelist>
7075
7076	<varlistentry>
7077	<term>
7078	<computeroutput><uuid\|vmname></computeroutput>
7079	</term>
7080
7081	<listitem>
7082	<para>
7083	Specifies the VM UUID or VM name. Mandatory.
7084	</para>
7085	</listitem>
7086	</varlistentry>
7087
7088	<varlistentry>
7089	<term>
7090	<computeroutput>--exe <path to
7091	executable></computeroutput>
7092	</term>
7093
7094	<listitem>
7095	<para>
7096	Specifies the absolute path of the executable on the
7097	guest OS file system. Mandatory. For example:
7098	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>
7099	</para>
7100	</listitem>
7101	</varlistentry>
7102
7103	<varlistentry>
7104	<term>
7105	<computeroutput>--timeout <msec></computeroutput>
7106	</term>
7107
7108	<listitem>
7109	<para>
7110	Specifies the maximum time, in microseconds, that the
7111	executable can run. Optional. If unspecified,
7112	<command>VBoxManage</command> waits indefinitely for the
7113	process to end, or an error occurs.
7114	</para>
7115	</listitem>
7116	</varlistentry>
7117
7118	<varlistentry>
7119	<term>
7120	<computeroutput>-E\|--putenv
7121	<NAME>=<VALUE></computeroutput>
7122	</term>
7123
7124	<listitem>
7125	<para>
7126	Sets, modifies, and unsets environment variables in the
7127	environment in which the program will run. Optional.
7128	</para>
7129
7130	<para>
7131	The guest process is created with the standard default
7132	guest OS environment. Use this option to modify that
7133	default environment. To set or modify a variable use:
7134	<computeroutput><NAME>=<VALUE></computeroutput>.
7135	To unset a variable use:
7136	<computeroutput><NAME>=</computeroutput>
7137	</para>
7138
7139	<para>
7140	Any spaces in names and values should be enclosed by
7141	quotes.
7142	</para>
7143
7144	<para>
7145	To set, modify, or unset multiple variables, use
7146	multiple instances of the
7147	<computeroutput>--E\|--putenv</computeroutput> option.
7148	</para>
7149	</listitem>
7150	</varlistentry>
7151
7152	<varlistentry>
7153	<term>
7154	<computeroutput>--unquoted-args</computeroutput>
7155	</term>
7156
7157	<listitem>
7158	<para>
7159	Disables escaped double quoting, such as \"fred\", on
7160	arguments passed to the executed program. Optional.
7161	</para>
7162	</listitem>
7163	</varlistentry>
7164
7165	<varlistentry>
7166	<term>
7167	<computeroutput>--ignore-operhaned-processes</computeroutput>
7168	</term>
7169
7170	<listitem>
7171	<para>
7172	Ignores orphaned processes. Not yet implemented.
7173	Optional.
7174	</para>
7175	</listitem>
7176	</varlistentry>
7177
7178	<varlistentry>
7179	<term>
7180	<computeroutput>--profile</computeroutput>
7181	</term>
7182
7183	<listitem>
7184	<para>
7185	Use a profile. Not yet implemented. Optional.
7186	</para>
7187	</listitem>
7188	</varlistentry>
7189
7190	<varlistentry>
7191	<term>
7192	<computeroutput>[-- <program/arg0>
7193	[<argument1>] ...
7194	[<argumentN>]]</computeroutput>
7195	</term>
7196
7197	<listitem>
7198	<para>
7199	Specifies the program name, followed by one or more
7200	arguments to pass to the program. Optional.
7201	</para>
7202
7203	<para>
7204	Any spaces in arguments should be enclosed by quotes.
7205	</para>
7206	</listitem>
7207	</varlistentry>
7208
7209	</variablelist>
7210
7211	<note>
7212	<para>
7213	On Windows there are certain limitations for graphical
7214	applications. See <xref linkend="KnownIssues" />.
7215	</para>
7216	</note>
7217
7218	<para>
7219	Examples of using the <command>guestcontrol start</command>
7220	command are as follows:
7221	</para>
7222
7223	<screen>VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls"
7224	--username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen>
7225
7226	<screen>VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe"
7227	--username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen>
7228
7229	<para>
7230	Note that the double backslashes in the second example are
7231	only required on UNIX hosts.
7232	</para>
7233
7234	<note>
7235	<para>
7236	For certain commands a user name of an existing user account
7237	on the guest must be specified. Anonymous executions are not
7238	supported for security reasons. A user account password,
7239	however, is optional and depends on the guest's OS security
7240	policy or rules. If no password is specified for a given
7241	user name, an empty password will be used. On certain OSes
7242	like Windows the security policy may needs to be adjusted in
7243	order to allow user accounts with an empty password set.
7244	Also, global domain rules might apply and therefore cannot
7245	be changed.
7246	</para>
7247	</note>
7248
7249	<para>
7250	Starting at &product-name; 4.1.2 guest process execution by
7251	default is limited to serve up to five guest processes at a
7252	time. If a new guest process gets started which would exceed
7253	this limit, the oldest not running guest process will be
7254	discarded in order to be able to run that new process. Also,
7255	retrieving output from this old guest process will not be
7256	possible anymore then. If all five guest processes are still
7257	active and running, starting a new guest process will result
7258	in an appropriate error message.
7259	</para>
7260
7261	<para>
7262	To raise or lower the guest process execution limit, either
7263	use the guest property
7264	<computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput>
7265	or <command>VBoxService</command> command line by specifying
7266	<computeroutput>--control-procs-max-kept</computeroutput>
7267	needs to be modified. A restart of the guest OS is required
7268	afterwards. To serve unlimited guest processes, a value of
7269	<computeroutput>0</computeroutput> needs to be set, but this
7270	is not recommended.
7271	</para>
7272	</listitem>
7273
7274	<listitem>
7275	<para>
7276	<computeroutput>copyfrom</computeroutput>: Copies files from
7277	the guest to the host file system. Only available with Guest
7278	Additions 4.0 or later installed.
7279	</para>
7280
7281	<screen>VBoxManage guestcontrol <uuid\|vmname> copyfrom [common-options]
7282	[--follow] [--R\|recursive]
7283	--target-directory <host-dst-dir>
7284	<guest-src0> [<guest-src1> [...]] </screen>
7285
7286	<para>
7287	Where the parameters are as follows:
7288	</para>
7289
7290	<variablelist>
7291
7292	<varlistentry>
7293	<term>
7294	<computeroutput><uid\|vmname></computeroutput>
7295	</term>
7296
7297	<listitem>
7298	<para>
7299	Specifies the VM UUID or VM name. Mandatory.
7300	</para>
7301	</listitem>
7302	</varlistentry>
7303
7304	<varlistentry>
7305	<term>
7306	<computeroutput>--follow</computeroutput>
7307	</term>
7308
7309	<listitem>
7310	<para>
7311	Enables symlink following on the guest file system.
7312	Optional.
7313	</para>
7314	</listitem>
7315	</varlistentry>
7316
7317	<varlistentry>
7318	<term>
7319	<computeroutput>-R\|--recursive</computeroutput>
7320	</term>
7321
7322	<listitem>
7323	<para>
7324	Enables recursive copying of files and directories from
7325	the specified guest file system directory. Optional.
7326	</para>
7327	</listitem>
7328	</varlistentry>
7329
7330	<varlistentry>
7331	<term>
7332	<computeroutput>--target-directory
7333	<host-dst-dir></computeroutput>
7334	</term>
7335
7336	<listitem>
7337	<para>
7338	Specifies the absolute path of the host file system
7339	destination directory. Mandatory. For example:
7340	<computeroutput>C:\Temp</computeroutput>.
7341	</para>
7342	</listitem>
7343	</varlistentry>
7344
7345	<varlistentry>
7346	<term>
7347	<computeroutput><guest-src0> [<guest-src1>
7348	[...]]</computeroutput>
7349	</term>
7350
7351	<listitem>
7352	<para>
7353	Specifies the absolute paths of guest file system files
7354	to be copied. Mandatory. For example:
7355	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
7356	Wildcards can be used in the expressions. For example:
7357	<computeroutput>C:\Windows\System\.dll</computeroutput>.
7358	</para>
7359	</listitem>
7360	</varlistentry>
7361
7362	</variablelist>
7363	</listitem>
7364
7365	<listitem>
7366	<para>
7367	<computeroutput>copyto</computeroutput>: Copies files from the
7368	host to the guest file system. Only available with Guest
7369	Additions 4.0 or later installed.
7370	</para>
7371
7372	<screen>VBoxManage guestcontrol <uuid\|vmname> copyto [common-options]
7373	[--follow] [--R\|recursive]
7374	--target-directory <guest-dst>
7375	<host-src0> [<host-src1> [...]] </screen>
7376
7377	<para>
7378	Where the parameters are as follows:
7379	</para>
7380
7381	<variablelist>
7382
7383	<varlistentry>
7384	<term>
7385	<computeroutput><uuid\|vmname></computeroutput>
7386	</term>
7387
7388	<listitem>
7389	<para>
7390	Specifies the VM UUID or VM name. Mandatory.
7391	</para>
7392	</listitem>
7393	</varlistentry>
7394
7395	<varlistentry>
7396	<term>
7397	<computeroutput>--follow</computeroutput>
7398	</term>
7399
7400	<listitem>
7401	<para>
7402	Enables symlink following on the host file system.
7403	Optional.
7404	</para>
7405	</listitem>
7406	</varlistentry>
7407
7408	<varlistentry>
7409	<term>
7410	<computeroutput>-R\|--recursive</computeroutput>
7411	</term>
7412
7413	<listitem>
7414	<para>
7415	Enables recursive copying of files and directories from
7416	the specified host file system directory. Optional.
7417	</para>
7418	</listitem>
7419	</varlistentry>
7420
7421	<varlistentry>
7422	<term>
7423	<computeroutput>--target-directory
7424	<guest-dst></computeroutput>
7425	</term>
7426
7427	<listitem>
7428	<para>
7429	Specifies the absolute path of the guest file system
7430	destination directory. Mandatory. For example:
7431	<computeroutput>C:\Temp</computeroutput>.
7432	</para>
7433	</listitem>
7434	</varlistentry>
7435
7436	<varlistentry>
7437	<term>
7438	<computeroutput><host-src0> [<host-src1>
7439	[...]]</computeroutput>
7440	</term>
7441
7442	<listitem>
7443	<para>
7444	Specifies the absolute paths of host file system files
7445	to be copied. Mandatory. For example:
7446	<computeroutput>C:\Windows\System32\calc.exe</computeroutput>.
7447	Wildcards can be used in the expressions. For example:
7448	<computeroutput>C:\Windows\System\.dll</computeroutput>.
7449	</para>
7450	</listitem>
7451	</varlistentry>
7452
7453	</variablelist>
7454	</listitem>
7455
7456	<listitem>
7457	<para>
7458	<computeroutput>md\|mkdir\|createdir\|createdirectory</computeroutput>:
7459	Creates one or more directories on the guest file system. Only
7460	available with Guest Additions 4.0 or later installed.
7461	</para>
7462
7463	<screen>VBoxManage guestcontrol <uuid\|vmname> md\|mkdir\|createdir\|createdirectory [common-options]
7464	[--parents] [--mode <mode>]
7465	<guest-dir0> [<guest-dir1> [...]] </screen>
7466
7467	<para>
7468	Where the parameters are as follows:
7469	</para>
7470
7471	<variablelist>
7472
7473	<varlistentry>
7474	<term>
7475	<computeroutput><uuid\|vmname></computeroutput>
7476	</term>
7477
7478	<listitem>
7479	<para>
7480	Specifies the VM UUID or VM name. Mandatory.
7481	</para>
7482	</listitem>
7483	</varlistentry>
7484
7485	<varlistentry>
7486	<term>
7487	<computeroutput>--parents</computeroutput>
7488	</term>
7489
7490	<listitem>
7491	<para>
7492	Creates any absent parent directories of the specified
7493	directory. Optional.
7494	</para>
7495
7496	<para>
7497	For example: If specified directory is
7498	<computeroutput>D:\Foo\Bar</computeroutput> and
7499	<computeroutput>D:\Foo</computeroutput> is absent, it
7500	will be created. In such a case, had the
7501	<computeroutput>--parents</computeroutput> option not
7502	been used, this command would have failed.
7503	</para>
7504	</listitem>
7505	</varlistentry>
7506
7507	<varlistentry>
7508	<term>
7509	<computeroutput>--mode <mode></computeroutput>
7510	</term>
7511
7512	<listitem>
7513	<para>
7514	Specifies the permission mode on the specified
7515	directories, and any parents, if the
7516	<computeroutput>--parents</computeroutput> option is
7517	used. Currently octal modes only, such as.
7518	<computeroutput>0755</computeroutput>, are supported.
7519	</para>
7520	</listitem>
7521	</varlistentry>
7522
7523	<varlistentry>
7524	<term>
7525	<computeroutput><guest-dir0> [<guest-dir1>
7526	[...]]</computeroutput>
7527	</term>
7528
7529	<listitem>
7530	<para>
7531	Specifies a list of absolute paths of directories to be
7532	created on guest file system. Mandatory. For example:
7533	<computeroutput>D:\Foo\Bar</computeroutput>.
7534	</para>
7535
7536	<para>
7537	All parent directories must already exist unless the
7538	switch <computeroutput>--parents</computeroutput> is
7539	used. For example, in the above example
7540	<computeroutput>D:\Foo</computeroutput>. The specified
7541	user must have sufficient rights to create the specified
7542	directories, and any parents that need to be created.
7543	</para>
7544	</listitem>
7545	</varlistentry>
7546
7547	</variablelist>
7548	</listitem>
7549
7550	<listitem>
7551	<para>
7552	<computeroutput>rmdir\|removedir\|removedirectory</computeroutput>:
7553	Deletes specified guest file system directories. Only
7554	available with installed Guest Additions 4.3.2 and later.
7555	</para>
7556
7557	<screen>VBoxManage guestcontrol <uuid\|vmname> rmdir\|removedir\|removedirectory [common-options]
7558	[--recursive\|-R]
7559	<guest-dir0> [<guest-dir1> [...]]
7560	</screen>
7561
7562	<para>
7563	Where the parameters are as follows:
7564	</para>
7565
7566	<variablelist>
7567
7568	<varlistentry>
7569	<term>
7570	<computeroutput><uuid\|vmname></computeroutput>
7571	</term>
7572
7573	<listitem>
7574	<para>
7575	Specifies the VM UUID or VM name. Mandatory.
7576	</para>
7577	</listitem>
7578	</varlistentry>
7579
7580	<varlistentry>
7581	<term>
7582	<computeroutput>--recursive</computeroutput>
7583	</term>
7584
7585	<listitem>
7586	<para>
7587	Recursively removes directories and contents. Optional.
7588	</para>
7589	</listitem>
7590	</varlistentry>
7591
7592	<varlistentry>
7593	<term>
7594	<computeroutput><guest-dir0> [<guest-dir1>
7595	[...]]</computeroutput>
7596	</term>
7597
7598	<listitem>
7599	<para>
7600	Specifies a list of the absolute paths of directories to
7601	be deleted on guest file system. Mandatory. Wildcards
7602	are allowed. For example:
7603	<computeroutput>D:\Foo\*Bar</computeroutput>. The
7604	specified user must have sufficient rights to delete the
7605	specified directories.
7606	</para>
7607	</listitem>
7608	</varlistentry>
7609
7610	</variablelist>
7611	</listitem>
7612
7613	<listitem>
7614	<para>
7615	<computeroutput>rm\|removefile</computeroutput>: Deletes
7616	specified files on the guest file system. Only available with
7617	installed Guest Additions 4.3.2 and later.
7618	</para>
7619
7620	<screen>VBoxManage guestcontrol <uuid\|vmname> rm\|removefile [common-options]
7621	[-f\|--force]
7622	<guest-file0> [<guest-file1> [...]] </screen>
7623
7624	<para>
7625	Where the parameters are as follows:
7626	</para>
7627
7628	<variablelist>
7629
7630	<varlistentry>
7631	<term>
7632	<computeroutput><uuid\|vmname></computeroutput>
7633	</term>
7634
7635	<listitem>
7636	<para>
7637	Specifies the VM UUID or VM name. Mandatory.
7638	</para>
7639	</listitem>
7640	</varlistentry>
7641
7642	<varlistentry>
7643	<term>
7644	<computeroutput>-f\|--force</computeroutput>
7645	</term>
7646
7647	<listitem>
7648	<para>
7649	Enforce operation and override any requests for
7650	confirmations. Optional.
7651	</para>
7652	</listitem>
7653	</varlistentry>
7654
7655	<varlistentry>
7656	<term>
7657	<computeroutput><guest-file0> [<guest-file1>
7658	[...]]</computeroutput>
7659	</term>
7660
7661	<listitem>
7662	<para>
7663	Specifies a list of absolute paths of files to be
7664	deleted on guest file system. Mandatory. Wildcards are
7665	allowed. For example:
7666	<computeroutput>D:\Foo\Bar\text*.txt</computeroutput>.
7667	The specified user should have sufficient rights to
7668	delete the specified files.
7669	</para>
7670	</listitem>
7671	</varlistentry>
7672
7673	</variablelist>
7674	</listitem>
7675
7676	<listitem>
7677	<para>
7678	<computeroutput>mv\|move\|ren\|rename</computeroutput>: Renames
7679	files and/or directories on the guest file system. Only
7680	available with installed Guest Additions 4.3.2 and later.
7681	</para>
7682
7683	<screen>VBoxManage guestcontrol <uuid\|vmname> mv\|move\|ren\|rename [common-options]
7684	<guest-source0> [<guest-source1> [...]] <guest-dest></screen>
7685
7686	<para>
7687	Where the parameters are as follows:
7688	</para>
7689
7690	<variablelist>
7691
7692	<varlistentry>
7693	<term>
7694	<computeroutput><uuid\|vmname></computeroutput>
7695	</term>
7696
7697	<listitem>
7698	<para>
7699	Specifies the VM UUID or VM name. Mandatory.
7700	</para>
7701	</listitem>
7702	</varlistentry>
7703
7704	<varlistentry>
7705	<term>
7706	<computeroutput><guest-source0>
7707	[<guest-source1> [...]]</computeroutput>
7708	</term>
7709
7710	<listitem>
7711	<para>
7712	Specifies absolute paths of files or a single directory
7713	to be moved and renamed on guest file system. Mandatory.
7714	Wildcards are allowed in file names. The specified user
7715	should have sufficient rights to access the specified
7716	files.
7717	</para>
7718	</listitem>
7719	</varlistentry>
7720
7721	<varlistentry>
7722	<term>
7723	<computeroutput><dest></computeroutput>
7724	</term>
7725
7726	<listitem>
7727	<para>
7728	Specifies the absolute path of the destination file or
7729	directory to which the files are to be moved. Mandatory.
7730	If only one file to be moved, <dest> can be file
7731	or directory, else it must be a directory. The specified
7732	user must have sufficient rights to access the
7733	destination file or directory.
7734	</para>
7735	</listitem>
7736	</varlistentry>
7737
7738	</variablelist>
7739	</listitem>
7740
7741	<listitem>
7742	<para>
7743	<computeroutput>mktemp\|createtemp\|createtemporary</computeroutput>:
7744	Creates a temporary file or directory on the guest file
7745	system, to assist subsequent copying of files from the host to
7746	the guest file systems. By default, the file or directory is
7747	created in the guest's platform specific temp directory. Not
7748	currently supported. Only available with installed Guest
7749	Additions 4.2 and later.
7750	</para>
7751
7752	<screen>VBoxManage guestcontrol <uuid\|vmname> mktemp\|createtemp\|createtemporary [common-options]
7753	[--directory] [--secure] [--mode <mode>] [--tmpdir <directory>]
7754	<template>
7755	</screen>
7756
7757	<para>
7758	The parameters are as follows:
7759	</para>
7760
7761	<variablelist>
7762
7763	<varlistentry>
7764	<term>
7765	<computeroutput><uuid\|vmname></computeroutput>
7766	</term>
7767
7768	<listitem>
7769	<para>
7770	Specifies the VM UUID or VM name. Mandatory.
7771	</para>
7772	</listitem>
7773	</varlistentry>
7774
7775	<varlistentry>
7776	<term>
7777	<computeroutput>--directory</computeroutput>
7778	</term>
7779
7780	<listitem>
7781	<para>
7782	Creates a temporary directory instead of a file,
7783	specified by the <template> parameter. Optional.
7784	</para>
7785	</listitem>
7786	</varlistentry>
7787
7788	<varlistentry>
7789	<term>
7790	<computeroutput>--secure</computeroutput>
7791	</term>
7792
7793	<listitem>
7794	<para>
7795	Enforces secure file and directory creation. Optional.
7796	The permission mode is set to
7797	<computeroutput>0755</computeroutput>. Operation fails
7798	if it cannot be performed securely.
7799	</para>
7800	</listitem>
7801	</varlistentry>
7802
7803	<varlistentry>
7804	<term>
7805	<computeroutput>--mode <mode></computeroutput>
7806	</term>
7807
7808	<listitem>
7809	<para>
7810	Specifies the permission mode of the specified
7811	directory. Optional. Currently only octal modes, such as
7812	<computeroutput>0755</computeroutput>, are supported.
7813	</para>
7814	</listitem>
7815	</varlistentry>
7816
7817	<varlistentry>
7818	<term>
7819	<computeroutput>--tmpdir
7820	<directory></computeroutput>
7821	</term>
7822
7823	<listitem>
7824	<para>
7825	Specifies the absolute path of the directory on the
7826	guest file system where the file or directory specified
7827	will be created. Optional. If unspecified, the
7828	platform-specific temp directory is used.
7829	</para>
7830	</listitem>
7831	</varlistentry>
7832
7833	<varlistentry>
7834	<term>
7835	<computeroutput><template></computeroutput>
7836	</term>
7837
7838	<listitem>
7839	<para>
7840	Specifies a file name without a directory path,
7841	containing at least one sequence of three consecutive X
7842	characters, or ending in X. Mandatory.
7843	</para>
7844	</listitem>
7845	</varlistentry>
7846
7847	</variablelist>
7848	</listitem>
7849
7850	<listitem>
7851	<para>
7852	<computeroutput>stat</computeroutput>: Displays file or file
7853	system statuses on the guest.
7854	</para>
7855
7856	<screen>VBoxManage guestcontrol <uuid\|vmname> stat [common-options]
7857	<file0> [<file1> [...]]</screen>
7858
7859	<para>
7860	Where the parameters are as follows:
7861	</para>
7862
7863	<variablelist>
7864
7865	<varlistentry>
7866	<term>
7867	<computeroutput><uuid\|vmname></computeroutput>
7868	</term>
7869
7870	<listitem>
7871	<para>
7872	Specifies the VM UUID or VM name. Mandatory.
7873	</para>
7874	</listitem>
7875	</varlistentry>
7876
7877	<varlistentry>
7878	<term>
7879	<computeroutput><file0> [<file1>
7880	[...]]</computeroutput>
7881	</term>
7882
7883	<listitem>
7884	<para>
7885	Specifies absolute paths of files or file systems on the
7886	guest file system. Mandatory. For example:
7887	<computeroutput>/home/foo/a.out</computeroutput>. The
7888	specified user should have sufficient rights to access
7889	the specified files or file systems.
7890	</para>
7891	</listitem>
7892	</varlistentry>
7893
7894	</variablelist>
7895	</listitem>
7896
7897	</itemizedlist>
7898
7899	<para>
7900	The second set of subcommands is of the form:
7901	</para>
7902
7903	<screen>VBoxManage guestcontrol <uuid\|vmname> <sub-command>
7904	[-v\|--verbose] [-q\|quiet] ...
7905	</screen>
7906
7907	<para>
7908	The common options are as follows:
7909	</para>
7910
7911	<screen>
7912	[-v\|--verbose] [-q\|--quiet]
7913	</screen>
7914
7915	<para>
7916	Details of the common options for the second set of subcommands
7917	are as follows:
7918	</para>
7919
7920	<variablelist>
7921
7922	<varlistentry>
7923	<term>
7924	<computeroutput>-v\|--verbose</computeroutput>
7925	</term>
7926
7927	<listitem>
7928	<para>
7929	Makes the subcommand execution more verbose. Optional.
7930	</para>
7931	</listitem>
7932	</varlistentry>
7933
7934	<varlistentry>
7935	<term>
7936	<computeroutput>-q\|--quiet</computeroutput>
7937	</term>
7938
7939	<listitem>
7940	<para>
7941	Makes the subcommand execution quieter. Optional.
7942	</para>
7943	</listitem>
7944	</varlistentry>
7945
7946	</variablelist>
7947
7948	<para>
7949	The second set of subcommands are as follows:
7950	</para>
7951
7952	<itemizedlist>
7953
7954	<listitem>
7955	<para>
7956	<computeroutput>list</computeroutput>: Lists guest control
7957	configuration and status data. For example: open guest
7958	sessions, guest processes, and files.
7959	</para>
7960
7961	<screen>VBoxManage guestcontrol <uuid\|vmname> list [common-opts]
7962	<all\|sessions\|processes\|files> </screen>
7963
7964	<para>
7965	Where the parameters are as follows:
7966	</para>
7967
7968	<variablelist>
7969
7970	<varlistentry>
7971	<term>
7972	<computeroutput><uuid\|vmname></computeroutput>
7973	</term>
7974
7975	<listitem>
7976	<para>
7977	Specifies the VM UUID or VM name. Mandatory.
7978	</para>
7979	</listitem>
7980	</varlistentry>
7981
7982	<varlistentry>
7983	<term>
7984	<computeroutput>all\|sessions\|processes\|files</computeroutput>
7985	</term>
7986
7987	<listitem>
7988	<para>
7989	Indicates whether to list all available data or guest
7990	sessions, processes or files. Mandatory.
7991	</para>
7992	</listitem>
7993	</varlistentry>
7994
7995	</variablelist>
7996	</listitem>
7997
7998	<listitem>
7999	<para>
8000	<computeroutput>closeprocess</computeroutput>: Terminates
8001	guest processes specified by PIDs running in a guest session,
8002	specified by the session ID or name.
8003	</para>
8004
8005	<screen>VBoxManage guestcontrol <uuid\|vmname> closeprocess [common-options]
8006	--session-id <ID> \| --session-name <name or pattern>
8007	<PID0> [<PID1> [...]] </screen>
8008
8009	<para>
8010	Where the parameters are as follows:
8011	</para>
8012
8013	<variablelist>
8014
8015	<varlistentry>
8016	<term>
8017	<computeroutput><uuid\|vmname></computeroutput>
8018	</term>
8019
8020	<listitem>
8021	<para>
8022	Specifies the VM UUID or VM name. Mandatory.
8023	</para>
8024	</listitem>
8025	</varlistentry>
8026
8027	<varlistentry>
8028	<term>
8029	<computeroutput>--session-id <ID></computeroutput>
8030	</term>
8031
8032	<listitem>
8033	<para>
8034	Specifies the guest session by its ID. Optional.
8035	</para>
8036	</listitem>
8037	</varlistentry>
8038
8039	<varlistentry>
8040	<term>
8041	<computeroutput>--session-name <name or
8042	pattern></computeroutput>
8043	</term>
8044
8045	<listitem>
8046	<para>
8047	Specifies the guest session by its name, or multiple
8048	sessions using a pattern containing wildcards. Optional.
8049	</para>
8050	</listitem>
8051	</varlistentry>
8052
8053	<varlistentry>
8054	<term>
8055	<computeroutput><PID0> [<PID1>
8056	[...]]</computeroutput>
8057	</term>
8058
8059	<listitem>
8060	<para>
8061	Specifies a list of process identifiers (PIDs) of guest
8062	processes to be terminated. Mandatory.
8063	</para>
8064	</listitem>
8065	</varlistentry>
8066
8067	</variablelist>
8068	</listitem>
8069
8070	<listitem>
8071	<para>
8072	<computeroutput>closesession</computeroutput>: Closes
8073	specified guest sessions, specified either by session ID or
8074	name.
8075	</para>
8076
8077	<screen>VBoxManage guestcontrol <uuid\|vmname> closesession [common-options]
8078	--session-id <ID> \| --session-name <name or pattern> \| --all </screen>
8079
8080	<para>
8081	Where the parameters are as follows:
8082	</para>
8083
8084	<variablelist>
8085
8086	<varlistentry>
8087	<term>
8088	<computeroutput><uuid\|vmname></computeroutput>
8089	</term>
8090
8091	<listitem>
8092	<para>
8093	Specifies the VM UUID or VM name. Mandatory.
8094	</para>
8095	</listitem>
8096	</varlistentry>
8097
8098	<varlistentry>
8099	<term>
8100	<computeroutput>--session-id <ID></computeroutput>
8101	</term>
8102
8103	<listitem>
8104	<para>
8105	Specifies the guest session to be closed by ID.
8106	Optional.
8107	</para>
8108	</listitem>
8109	</varlistentry>
8110
8111	<varlistentry>
8112	<term>
8113	<computeroutput>--session-name <name or
8114	pattern></computeroutput>
8115	</term>
8116
8117	<listitem>
8118	<para>
8119	Specifies the guest session to be closed by name.
8120	Optional. Multiple sessions can be specified by using a
8121	pattern containing wildcards.
8122	</para>
8123	</listitem>
8124	</varlistentry>
8125
8126	<varlistentry>
8127	<term>
8128	<computeroutput>--all</computeroutput>
8129	</term>
8130
8131	<listitem>
8132	<para>
8133	Close all guest sessions. Optional.
8134	</para>
8135	</listitem>
8136	</varlistentry>
8137
8138	</variablelist>
8139	</listitem>
8140
8141	<listitem>
8142	<para>
8143	<computeroutput>updatega\|updateadditions\|updateguestadditions</computeroutput>:
8144	Ugrades Guest Additions already installed on the guest. Only
8145	available for already installed Guest Additions 4.0 and later.
8146	</para>
8147
8148	<screen>VBoxManage guestcontrol <uuid\|vmname> updatega\|updateadditions\|updateguestadditions
8149	[common-options]
8150	[--source <New .ISO path>]
8151	[--wait-start]
8152	[-- <argument0> [<argument1> [...]]]</screen>
8153
8154	<para>
8155	Where the parameters are as follows:
8156	</para>
8157
8158	<variablelist>
8159
8160	<varlistentry>
8161	<term>
8162	<computeroutput><uuid\|vmname></computeroutput>
8163	</term>
8164
8165	<listitem>
8166	<para>
8167	Specifies the VM UUID or VM name. Mandatory.
8168	</para>
8169	</listitem>
8170	</varlistentry>
8171
8172	<varlistentry>
8173	<term>
8174	<computeroutput>--source</computeroutput> <New .ISO
8175	path>
8176	</term>
8177
8178	<listitem>
8179	<para>
8180	Specifies the absolute path on the guest file system of
8181	the .ISO file for the Guest Additions update. Mandatory.
8182	</para>
8183	</listitem>
8184	</varlistentry>
8185
8186	<varlistentry>
8187	<term>
8188	<computeroutput>--wait-start</computeroutput>
8189	</term>
8190
8191	<listitem>
8192	<para>
8193	Indicates that <command>VBoxManage</command> starts the
8194	usual updating process on the guest and then waits until
8195	the actual Guest Additions updating begins, at which
8196	point <command>VBoxManage</command> self-terminates.
8197	Optional.
8198	</para>
8199
8200	<para>
8201	Default behavior is that <command>VBoxManage</command>
8202	waits for completion of the Guest Additions update
8203	before terminating. Use of this option is sometimes
8204	necessary, as a running <command>VBoxManage</command>
8205	can affect the interaction between the installer and the
8206	guest OS.
8207	</para>
8208	</listitem>
8209	</varlistentry>
8210
8211	<varlistentry>
8212	<term>
8213	<computeroutput>[-- <argument0> [<argument1>
8214	[...]]]</computeroutput>
8215	</term>
8216
8217	<listitem>
8218	<para>
8219	Specifies optional command line arguments to be supplied
8220	to the Guest Additions updater. Useful for retrofitting
8221	features which are not currently installed.
8222	</para>
8223
8224	<para>
8225	Arguments containing spaces should be enclosed by
8226	quotes.
8227	</para>
8228	</listitem>
8229	</varlistentry>
8230
8231	</variablelist>
8232	</listitem>
8233
8234	<listitem>
8235	<para>
8236	<computeroutput>watch</computeroutput>: Prints current guest
8237	control activity.
8238	</para>
8239
8240	<screen>VBoxManage guestcontrol <uuid\|vmname> watch [common-options]
8241	</screen>
8242
8243	<para>
8244	Where the parameters are as follows:
8245	</para>
8246
8247	<variablelist>
8248
8249	<varlistentry>
8250	<term>
8251	<computeroutput><uuid\|vmname></computeroutput>
8252	</term>
8253
8254	<listitem>
8255	<para>
8256	Specifies the VM UUID or VM name. Mandatory.
8257	</para>
8258	</listitem>
8259	</varlistentry>
8260
8261	</variablelist>
8262	</listitem>
8263
8264	</itemizedlist>
8265
8266	</sect1>
8267
8268	<sect1 id="vboxmanage-metrics">
8269
8270	<title>VBoxManage metrics</title>
8271
8272	<para>
8273	This command supports monitoring the usage of system resources.
8274	Resources are represented by various metrics associated with the
8275	host system or a particular VM. For example, the host system has a
8276	<computeroutput>CPU/Load/User</computeroutput> metric that shows
8277	the percentage of time CPUs spend executing in user mode over a
8278	specific sampling period.
8279	</para>
8280
8281	<para>
8282	Metric data is collected and retained internally. It may be
8283	retrieved at any time with the <command>VBoxManage metrics
8284	query</command> subcommand. The data is available as long as the
8285	background <computeroutput>VBoxSVC</computeroutput> process is
8286	alive. That process terminates shortly after all VMs and frontends
8287	have been closed.
8288	</para>
8289
8290	<para>
8291	By default no metrics are collected at all. Metrics collection
8292	does not start until <command>VBoxManage metrics setup</command>
8293	is invoked with a proper sampling interval and the number of
8294	metrics to be retained. The interval is measured in seconds. For
8295	example, to enable collecting the host processor and memory usage
8296	metrics every second and keeping the five most current samples,
8297	the following command can be used:
8298	</para>
8299
8300	<screen>VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage</screen>
8301
8302	<para>
8303	Metric collection can only be enabled for started VMs. Collected
8304	data and collection settings for a particular VM will disappear as
8305	soon as it shuts down. Use the <command>VBoxManage metrics
8306	list</command> subcommand to see which metrics are currently
8307	available. You can also use the <option>--list</option> option
8308	with any subcommand that modifies metric settings to find out
8309	which metrics were affected.
8310	</para>
8311
8312	<para>
8313	Note that the <command>VBoxManage metrics setup</command>
8314	subcommand discards all samples that may have been previously
8315	collected for the specified set of objects and metrics.
8316	</para>
8317
8318	<para>
8319	To enable or disable metrics collection without discarding the
8320	data, <command>VBoxManage metrics enable</command> and
8321	<command>VBoxManage metrics disable</command> subcommands can be
8322	used. Note that these subcommands expect metrics as parameters,
8323	not submetrics such as <computeroutput>CPU/Load</computeroutput>
8324	or <computeroutput>RAM/Usage</computeroutput>. In other words
8325	enabling <computeroutput>CPU/Load/User</computeroutput> while
8326	disabling <computeroutput>CPU/Load/Kernel</computeroutput> is not
8327	supported.
8328	</para>
8329
8330	<para>
8331	The host and VMs have different sets of associated metrics.
8332	Available metrics can be listed with <command>VBoxManage metrics
8333	list</command> subcommand.
8334	</para>
8335
8336	<para>
8337	A complete metric name may include an aggregate function. The name
8338	has the following form:
8339	<computeroutput>Category/Metric[/SubMetric][:aggregate]</computeroutput>.
8340	For example, <computeroutput>RAM/Usage/Free:min</computeroutput>
8341	stands for the minimum amount of available memory over all
8342	retained data if applied to the host object.
8343	</para>
8344
8345	<para>
8346	Subcommands may apply to all objects and metrics or can be limited
8347	to one object and a list of metrics. If no objects or metrics are
8348	given in the parameters, the subcommands will apply to all
8349	available metrics of all objects. You may use an asterisk
8350	"<computeroutput>*</computeroutput>" to explicitly specify that
8351	the command should be applied to all objects or metrics. Use
8352	<computeroutput>host</computeroutput> as the object name to limit
8353	the scope of the command to host-related metrics. To limit the
8354	scope to a subset of metrics, use a metric list with names
8355	separated by commas.
8356	</para>
8357
8358	<para>
8359	For example, to query metric data on the CPU time spent in user
8360	and kernel modes by the virtual machine named
8361	<computeroutput>test</computeroutput>, use the following command:
8362	</para>
8363
8364	<screen>VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel</screen>
8365
8366	<para>
8367	The following list summarizes the available subcommands:
8368	</para>
8369
8370	<variablelist>
8371
8372	<varlistentry>
8373	<term>
8374	<computeroutput>list</computeroutput>
8375	</term>
8376
8377	<listitem>
8378	<para>
8379	Shows the parameters of the currently existing metrics. Note
8380	that VM-specific metrics are only available when a
8381	particular VM is running.
8382	</para>
8383	</listitem>
8384	</varlistentry>
8385
8386	<varlistentry>
8387	<term>
8388	<computeroutput>setup</computeroutput>
8389	</term>
8390
8391	<listitem>
8392	<para>
8393	Sets the interval between taking two samples of metric data
8394	and the number of samples retained internally. The retained
8395	data is available for displaying with the
8396	<command>query</command> subcommand. The
8397	<computeroutput>--list</computeroutput> option shows which
8398	metrics have been modified as the result of the command
8399	execution.
8400	</para>
8401	</listitem>
8402	</varlistentry>
8403
8404	<varlistentry>
8405	<term>
8406	<computeroutput>enable</computeroutput>
8407	</term>
8408
8409	<listitem>
8410	<para>
8411	Resumes data collection after it has been stopped with the
8412	<command>disable</command> subcommand. Note that specifying
8413	submetrics as parameters will not enable underlying metrics.
8414	Use <computeroutput>--list</computeroutput> to find out if
8415	the command worked as expected.
8416	</para>
8417	</listitem>
8418	</varlistentry>
8419
8420	<varlistentry>
8421	<term>
8422	<computeroutput>disable</computeroutput>
8423	</term>
8424
8425	<listitem>
8426	<para>
8427	Suspends data collection without affecting collection
8428	parameters or collected data. Note that specifying
8429	submetrics as parameters will not disable underlying
8430	metrics. Use <computeroutput>--list</computeroutput> to find
8431	out if the command worked as expected.
8432	</para>
8433	</listitem>
8434	</varlistentry>
8435
8436	<varlistentry>
8437	<term>
8438	<computeroutput>query</computeroutput>
8439	</term>
8440
8441	<listitem>
8442	<para>
8443	Retrieves and displays the currently retained metric data.
8444	</para>
8445
8446	<note>
8447	<para>
8448	The <command>query</command> subcommand does not remove or
8449	flush retained data. If you query often enough you will
8450	see how old samples are gradually being phased out by new
8451	samples.
8452	</para>
8453	</note>
8454	</listitem>
8455	</varlistentry>
8456
8457	<varlistentry>
8458	<term>
8459	<computeroutput>collect</computeroutput>
8460	</term>
8461
8462	<listitem>
8463	<para>
8464	Sets the interval between taking two samples of metric data
8465	and the number of samples retained internally. The collected
8466	data is displayed periodically until Ctrl+C is pressed,
8467	unless the <computeroutput>--detach</computeroutput> option
8468	is specified. With the
8469	<computeroutput>--detach</computeroutput> option, this
8470	subcommand operates the same way as
8471	<computeroutput>setup</computeroutput> does. The
8472	<computeroutput>--list</computeroutput> option shows which
8473	metrics match the specified filter.
8474	</para>
8475	</listitem>
8476	</varlistentry>
8477
8478	</variablelist>
8479
8480	</sect1>
8481
8482	<sect1 id="vboxmanage-natnetwork">
8483
8484	<title>VBoxManage natnetwork</title>
8485
8486	<para>
8487	NAT networks use the Network Address Translation (NAT) service,
8488	which works in a similar way to a home router. It groups systems
8489	using it into a network and prevents outside systems from directly
8490	accessing those inside, while letting systems inside communicate
8491	with each other and outside systems using TCP and UDP over IPv4
8492	and IPv6.
8493	</para>
8494
8495	<para>
8496	A NAT service is attached to an internal network. Virtual machines
8497	to make use of one should be attached to it. The name of an
8498	internal network is chosen when the NAT service is created, and
8499	the internal network will be created if it does not already exist.
8500	The following is an example command to create a NAT network:
8501	</para>
8502
8503	<screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen>
8504
8505	<para>
8506	Here, <computeroutput>natnet1</computeroutput> is the name of the
8507	internal network to be used and
8508	<computeroutput>192.168.15.0/24</computeroutput> is the network
8509	address and mask of the NAT service interface. By default, in this
8510	static configuration the gateway will be assigned the address
8511	192.168.15.1, the address after the interface address, though this
8512	is subject to change.
8513	</para>
8514
8515	<para>
8516	To add a DHCP server to the NAT network after creation, run the
8517	following command:
8518	</para>
8519
8520	<screen>VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen>
8521
8522	<para>
8523	The subcommands for <command>VBoxManage natnetwork</command> are
8524	as follows:
8525	</para>
8526
8527	<screen>VBoxManage natnetwork add --netname <name>
8528	[--network <network>]
8529	[--enable\|--disable]
8530	[--dhcp on\|off]
8531	[--port-forward-4 <rule>]
8532	[--loopback-4 <rule>]
8533	[--ipv6 on\|off]
8534	[--port-forward-6 <rule>]
8535	[--loopback-6 <rule>]
8536	</screen>
8537
8538	<para>
8539	<command>VBoxManage natnetwork add</command>: Creates a new
8540	internal network interface, and adds a NAT network service. This
8541	command is a prerequisite for enabling attachment of VMs to the
8542	NAT network. Parameters are as follows:
8543	</para>
8544
8545	<variablelist>
8546
8547	<varlistentry>
8548	<term>
8549	<computeroutput>--netname <name></computeroutput>
8550	</term>
8551
8552	<listitem>
8553	<para>
8554	Where <name> is the name of the new internal network
8555	interface on the host OS.
8556	</para>
8557	</listitem>
8558	</varlistentry>
8559
8560	<varlistentry>
8561	<term>
8562	<computeroutput>--network <network></computeroutput>
8563	</term>
8564
8565	<listitem>
8566	<para>
8567	Where <network> specifies the static or DHCP network
8568	address and mask of the NAT service interface. The default
8569	is a static network address.
8570	</para>
8571	</listitem>
8572	</varlistentry>
8573
8574	<varlistentry>
8575	<term>
8576	<computeroutput>--enable\|--disable</computeroutput>
8577	</term>
8578
8579	<listitem>
8580	<para>
8581	Enables and disables the NAT network service.
8582	</para>
8583	</listitem>
8584	</varlistentry>
8585
8586	<varlistentry>
8587	<term>
8588	<computeroutput>--dhcp on\|off</computeroutput>
8589	</term>
8590
8591	<listitem>
8592	<para>
8593	Enables and disables a DHCP server specified by
8594	<computeroutput>--netname</computeroutput>. Use of this
8595	option also indicates that it is a DHCP server.
8596	</para>
8597	</listitem>
8598	</varlistentry>
8599
8600	<varlistentry>
8601	<term>
8602	<computeroutput>--port-forward-4 <rule></computeroutput>
8603	</term>
8604
8605	<listitem>
8606	<para>
8607	Enables IPv4 port forwarding, with a rule specified by
8608	<rule>.
8609	</para>
8610	</listitem>
8611	</varlistentry>
8612
8613	<varlistentry>
8614	<term>
8615	<computeroutput>--loopback-4 <rule></computeroutput>
8616	</term>
8617
8618	<listitem>
8619	<para>
8620	Enables the IPv4 loopback interface, with a rule specified
8621	by <rule>.
8622	</para>
8623	</listitem>
8624	</varlistentry>
8625
8626	<varlistentry>
8627	<term>
8628	<computeroutput>--ipv6 on\|off</computeroutput>
8629	</term>
8630
8631	<listitem>
8632	<para>
8633	Enables and disables IPv6. The default setting is IPv4,
8634	disabling IPv6 enables IPv4.
8635	</para>
8636	</listitem>
8637	</varlistentry>
8638
8639	<varlistentry>
8640	<term>
8641	<computeroutput>--port-forward-6 <rule></computeroutput>
8642	</term>
8643
8644	<listitem>
8645	<para>
8646	Enables IPv6 port forwarding, with a rule specified by
8647	<rule>.
8648	</para>
8649	</listitem>
8650	</varlistentry>
8651
8652	<varlistentry>
8653	<term>
8654	<computeroutput>--loopback-6 <rule></computeroutput>
8655	</term>
8656
8657	<listitem>
8658	<para>
8659	Enables the IPv6 loopback interface, with a rule specified
8660	by <rule>.
8661	</para>
8662	</listitem>
8663	</varlistentry>
8664
8665	</variablelist>
8666
8667	<screen>VBoxManage natnetwork remove --netname <name> </screen>
8668
8669	<para>
8670	<command>VBoxManage natnetwork remove</command>: Removes a NAT
8671	network service. Parameters are as follows:
8672	</para>
8673
8674	<variablelist>
8675
8676	<varlistentry>
8677	<term>
8678	<computeroutput>--netname <name></computeroutput>
8679	</term>
8680
8681	<listitem>
8682	<para>
8683	Where <name> specifies an existing NAT network
8684	service. Does not remove any DHCP server enabled on the
8685	network.
8686	</para>
8687	</listitem>
8688	</varlistentry>
8689
8690	</variablelist>
8691
8692	<screen>VBoxManage natnetwork modify --netname <name>
8693	[--network <network>]
8694	[--enable\|--disable]
8695	[--dhcp on\|off]
8696	[--port-forward-4 <rule>]
8697	[--loopback-4 <rule>]
8698	[--ipv6 on\|off]
8699	[--port-forward-6 <rule>]
8700	[--loopback-6 <rule>]
8701	</screen>
8702
8703	<para>
8704	<command>VBoxManage natnetwork modify</command>: Modifies an
8705	existing NAT network service. Parameters are as follows:
8706	</para>
8707
8708	<variablelist>
8709
8710	<varlistentry>
8711	<term>
8712	<computeroutput>--netname <name></computeroutput>
8713	</term>
8714
8715	<listitem>
8716	<para>
8717	Where <name> specifies an existing NAT network
8718	service.
8719	</para>
8720	</listitem>
8721	</varlistentry>
8722
8723	<varlistentry>
8724	<term>
8725	<computeroutput>--network <network></computeroutput>
8726	</term>
8727
8728	<listitem>
8729	<para>
8730	Where <network> specifies the new static or DHCP
8731	network address and mask of the NAT service interface. The
8732	default is a static network address.
8733	</para>
8734	</listitem>
8735	</varlistentry>
8736
8737	<varlistentry>
8738	<term>
8739	<computeroutput>--enable\|--disable</computeroutput>
8740	</term>
8741
8742	<listitem>
8743	<para>
8744	Enables and disables the NAT network service.
8745	</para>
8746	</listitem>
8747	</varlistentry>
8748
8749	<varlistentry>
8750	<term>
8751	<computeroutput>--dhcp on\|off</computeroutput>
8752	</term>
8753
8754	<listitem>
8755	<para>
8756	Enables and disables a DHCP server. If a DHCP server is not
8757	present, using enable adds a new DHCP server.
8758	</para>
8759	</listitem>
8760	</varlistentry>
8761
8762	<varlistentry>
8763	<term>
8764	<computeroutput>--port-forward-4 <rule></computeroutput>
8765	</term>
8766
8767	<listitem>
8768	<para>
8769	Enables IPv4 port forwarding, with a rule specified by
8770	<rule>.
8771	</para>
8772	</listitem>
8773	</varlistentry>
8774
8775	<varlistentry>
8776	<term>
8777	<computeroutput>--loopback-4 <rule></computeroutput>
8778	</term>
8779
8780	<listitem>
8781	<para>
8782	Enables the IPv4 loopback interface, with a rule specified
8783	by <rule>.
8784	</para>
8785	</listitem>
8786	</varlistentry>
8787
8788	<varlistentry>
8789	<term>
8790	<computeroutput>--ipv6 on\|off</computeroutput>
8791	</term>
8792
8793	<listitem>
8794	<para>
8795	Enables and disables IPv6. The default setting is IPv4,
8796	disabling IPv6 enables IPv4.
8797	</para>
8798	</listitem>
8799	</varlistentry>
8800
8801	<varlistentry>
8802	<term>
8803	<computeroutput>--port-forward-6 <rule></computeroutput>
8804	</term>
8805
8806	<listitem>
8807	<para>
8808	Enables IPv6 port forwarding, with a rule specified by
8809	<rule>.
8810	</para>
8811	</listitem>
8812	</varlistentry>
8813
8814	<varlistentry>
8815	<term>
8816	<computeroutput>--loopback-6 <rule></computeroutput>
8817	</term>
8818
8819	<listitem>
8820	<para>
8821	Enables IPv6 loopback interface, with a rule specified by
8822	<rule>.
8823	</para>
8824	</listitem>
8825	</varlistentry>
8826
8827	</variablelist>
8828
8829	<screen>VBoxManage natnetwork start --netname <name>
8830	</screen>
8831
8832	<para>
8833	<command>VBoxManage natnetwork start</command>: Starts the
8834	specified NAT network service and any associated DHCP server.
8835	Parameters are as follows:
8836	</para>
8837
8838	<variablelist>
8839
8840	<varlistentry>
8841	<term>
8842	<computeroutput>--netname <name></computeroutput>
8843	</term>
8844
8845	<listitem>
8846	<para>
8847	Where <name> specifies an existing NAT network
8848	service.
8849	</para>
8850	</listitem>
8851	</varlistentry>
8852
8853	</variablelist>
8854
8855	<screen>VBoxManage natnetwork stop --netname <name>
8856	</screen>
8857
8858	<para>
8859	<command>VBoxManage natnetwork stop</command>: Stops the specified
8860	NAT network service and any DHCP server. Parameters are as
8861	follows:
8862	</para>
8863
8864	<variablelist>
8865
8866	<varlistentry>
8867	<term>
8868	<computeroutput>--netname <name></computeroutput>
8869	</term>
8870
8871	<listitem>
8872	<para>
8873	Where <name> specifies an existing NAT network
8874	service.
8875	</para>
8876	</listitem>
8877	</varlistentry>
8878
8879	</variablelist>
8880
8881	<screen>VBoxManage natnetwork list [<pattern>] </screen>
8882
8883	<para>
8884	<command>VBoxManage natnetwork list</command>: Lists all NAT
8885	network services, with optional filtering. Parameters are as
8886	follows:
8887	</para>
8888
8889	<variablelist>
8890
8891	<varlistentry>
8892	<term>
8893	<computeroutput>[<pattern>]</computeroutput>
8894	</term>
8895
8896	<listitem>
8897	<para>
8898	Where <pattern> is an optional filtering pattern.
8899	</para>
8900	</listitem>
8901	</varlistentry>
8902
8903	</variablelist>
8904
8905	</sect1>
8906
8907	<sect1 id="vboxmanage-hostonlyif">
8908
8909	<title>VBoxManage hostonlyif</title>
8910
8911	<para>
8912	The <command>hostonlyif</command> command enables you to change
8913	the IP configuration of a host-only network interface. For a
8914	description of host-only networking, see
8915	<xref linkend="network_hostonly" />. Each host-only interface is
8916	identified by a name and can either use the internal DHCP server
8917	or a manual IP configuration, both IP4 and IP6.
8918	</para>
8919
8920	<para>
8921	The following list summarizes the available subcommands:
8922	</para>
8923
8924	<variablelist>
8925
8926	<varlistentry>
8927	<term>
8928	<computeroutput>ipconfig "<name>"</computeroutput>
8929	</term>
8930
8931	<listitem>
8932	<para>
8933	Configures a host-only interface.
8934	</para>
8935	</listitem>
8936	</varlistentry>
8937
8938	<varlistentry>
8939	<term>
8940	<computeroutput>create</computeroutput>
8941	</term>
8942
8943	<listitem>
8944	<para>
8945	Creates a new vboxnet<N> interface on the host OS.
8946	This command is essential before you can attach VMs to a
8947	host-only network.
8948	</para>
8949	</listitem>
8950	</varlistentry>
8951
8952	<varlistentry>
8953	<term>
8954	<computeroutput>remove vboxnet<N></computeroutput>
8955	</term>
8956
8957	<listitem>
8958	<para>
8959	Removes a vboxnet<N> interface from the host OS.
8960	</para>
8961	</listitem>
8962	</varlistentry>
8963
8964	</variablelist>
8965
8966	</sect1>
8967
8968	<sect1 id="vboxmanage-dhcpserver">
8969
8970	<title>VBoxManage dhcpserver</title>
8971
8972	<para>
8973	The <command>dhcpserver</command> commands enable you to control
8974	the DHCP server that is built into &product-name;. You may find
8975	this useful when using internal or host-only networking.
8976	Theoretically, you can also enable it for a bridged network, but
8977	that may cause conflicts with other DHCP servers in your physical
8978	network.
8979	</para>
8980
8981	<para>
8982	Use the following command line options:
8983	</para>
8984
8985	<itemizedlist>
8986
8987	<listitem>
8988	<para>
8989	If you use internal networking for a virtual network adapter
8990	of a virtual machine, use <computeroutput>VBoxManage
8991	dhcpserver add --netname
8992	<network_name></computeroutput>, where
8993	<computeroutput><network_name></computeroutput> is the
8994	same network name you used with <computeroutput>VBoxManage
8995	modifyvm <vmname> --intnet<X>
8996	<network_name></computeroutput>.
8997	</para>
8998	</listitem>
8999
9000	<listitem>
9001	<para>
9002	If you use host-only networking for a virtual network adapter
9003	of a virtual machine, use <computeroutput>VBoxManage
9004	dhcpserver add --ifname
9005	<hostonly_if_name></computeroutput> instead, where
9006	<computeroutput><hostonly_if_name></computeroutput> is
9007	the same host-only interface name you used with
9008	<computeroutput>VBoxManage modifyvm <vmname>
9009	--hostonlyadapter<X>
9010	<hostonly_if_name></computeroutput>.
9011	</para>
9012
9013	<para>
9014	Alternatively, you can also use the <option>--netname</option>
9015	option as with internal networks if you know the host-only
9016	network's name. You can see the names with <command>VBoxManage
9017	list hostonlyifs</command>. See
9018	<xref linkend="vboxmanage-list" />.
9019	</para>
9020	</listitem>
9021
9022	</itemizedlist>
9023
9024	<para>
9025	The following additional parameters are required when first adding
9026	a DHCP server:
9027	</para>
9028
9029	<itemizedlist>
9030
9031	<listitem>
9032	<para>
9033	With <computeroutput>--ip</computeroutput>, specify the IP
9034	address of the DHCP server.
9035	</para>
9036	</listitem>
9037
9038	<listitem>
9039	<para>
9040	With <computeroutput>--netmask</computeroutput>, specify the
9041	netmask of the network.
9042	</para>
9043	</listitem>
9044
9045	<listitem>
9046	<para>
9047	With <computeroutput>--lowerip</computeroutput> and
9048	<computeroutput>--upperip</computeroutput>, you can specify
9049	the lowest and highest IP address that the DHCP server will
9050	assign to clients.
9051	</para>
9052	</listitem>
9053
9054	</itemizedlist>
9055
9056	<para>
9057	You can specify additional DHCP options with the
9058	<computeroutput>--options</computeroutput> command option. Use
9059	<computeroutput>--id</computeroutput> and
9060	<computeroutput>--value</computeroutput> to configure a number and
9061	string pair corresponding to the DHCP option. Use
9062	<computeroutput>--remove</computeroutput> to remove a DHCP option.
9063	</para>
9064
9065	<para>
9066	The <computeroutput>--vm</computeroutput> and
9067	<computeroutput>--nic</computeroutput> settings enable you to
9068	configure DHCP options for a specific network adapter used by the
9069	named VM.
9070	</para>
9071
9072	<para>
9073	Finally, you must specify
9074	<computeroutput>--enable</computeroutput> or the DHCP server will
9075	be created in the disabled state and will not be running.
9076	</para>
9077
9078	<para>
9079	After this, &product-name; will automatically start the DHCP
9080	server for the specified internal network or host-only network as
9081	soon as the first virtual machine which uses that network is
9082	started.
9083	</para>
9084
9085	<para>
9086	Use <command>VBoxManage dhcpserver remove</command> with the given
9087	<computeroutput>--netname <network_name></computeroutput> or
9088	<computeroutput>--ifname <hostonly_if_name></computeroutput>
9089	to remove the DHCP server for the specified internal network or
9090	host-only network.
9091	</para>
9092
9093	<para>
9094	To modify the settings of a DHCP server created using
9095	<command>VBoxManage dhcpserver add</command>, you can use
9096	<command>VBoxManage dhcpserver modify</command> for a given
9097	network or host-only interface name. This has the same parameters
9098	as <command>VBoxManage dhcpserver add</command>.
9099	</para>
9100
9101	</sect1>
9102
9103	<sect1 id="vboxmanage-usbdevsource">
9104
9105	<title>VBoxManage usbdevsource</title>
9106
9107	<para>
9108	The <command>usbdevsource</command> commands enable you to add and
9109	remove USB devices globally.
9110	</para>
9111
9112	<para>
9113	The following command adds a USB device.
9114	</para>
9115
9116	<screen>VBoxManage usbdevsource add <source name>
9117	--backend <backend>
9118	--address <address>
9119	</screen>
9120
9121	<para>
9122	Where the command line options are as follows:
9123	</para>
9124
9125	<itemizedlist>
9126
9127	<listitem>
9128	<para>
9129	<computeroutput><source name></computeroutput>:
9130	Specifies the ID of the source USB device to be added.
9131	Mandatory.
9132	</para>
9133	</listitem>
9134
9135	<listitem>
9136	<para>
9137	<computeroutput>--backend <backend></computeroutput>:
9138	Specifies the USB proxy service backend to use. Mandatory.
9139	</para>
9140	</listitem>
9141
9142	<listitem>
9143	<para>
9144	<computeroutput> --address <address></computeroutput>:
9145	Specifies the backend specific address. Mandatory.
9146	</para>
9147	</listitem>
9148
9149	</itemizedlist>
9150
9151	<para>
9152	The following command removes a USB device.
9153	</para>
9154
9155	<screen>VBoxManage usbdevsource remove <source name>
9156	</screen>
9157
9158	<para>
9159	Where the command line options are as follows:
9160	</para>
9161
9162	<itemizedlist>
9163
9164	<listitem>
9165	<para>
9166	<computeroutput><source name></computeroutput>:
9167	Specifies the ID of the source USB device to be removed.
9168	Mandatory.
9169	</para>
9170	</listitem>
9171
9172	</itemizedlist>
9173
9174	</sect1>
9175
9176	<xi:include href="user_man_VBoxManage-mediumio.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9177
9178	<xi:include href="user_man_VBoxManage-debugvm.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9179
9180	<xi:include href="user_man_VBoxManage-extpack.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9181
9182	<xi:include href="user_man_VBoxManage-unattended.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9183
9184	<xi:include href="user_man_VBoxManage-snapshot.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9185
9186	<xi:include href="user_man_VBoxManage-cloudprofile.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9187
9188	<xi:include href="user_man_VBoxManage-cloudlist.xml" xpointer="element(/1)" xmlns:xi="http://www.w3.org/2001/XInclude" />
9189
9190	</chapter>

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

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

Download in other formats: