man_VBoxManage-modifyvm.xml@ 102792

Last change on this file since 102792 was 101125, checked in by vboxsync, 17 months ago
FE/VBoxManage: Added armv8virtual chipset handling. bugref:10384.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 131.6 KB

Line
1	<?xml version="1.0" encoding="UTF-8"?>
2	<!--
3	manpage, user manual, usage: VBoxManage modifyvm
4	-->
5	<!--
6	Copyright (C) 2006-2023 Oracle and/or its affiliates.
7
8	This file is part of VirtualBox base platform packages, as
9	available from https://www.virtualbox.org.
10
11	This program is free software; you can redistribute it and/or
12	modify it under the terms of the GNU General Public License
13	as published by the Free Software Foundation, in version 3 of the
14	License.
15
16	This program is distributed in the hope that it will be useful, but
17	WITHOUT ANY WARRANTY; without even the implied warranty of
18	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19	General Public License for more details.
20
21	You should have received a copy of the GNU General Public License
22	along with this program; if not, see <https://www.gnu.org/licenses>.
23
24	SPDX-License-Identifier: GPL-3.0-only
25	-->
26	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
27	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
28	<!ENTITY % all.entities SYSTEM "all-entities.ent">
29	%all.entities;
30	]>
31	<refentry id="vboxmanage-modifyvm" lang="en">
32	<refentryinfo>
33	<pubdate>$Date: 2023-09-15 12:47:48 +0000 (Fri, 15 Sep 2023) $</pubdate>
34	<title>VBoxManage modifyvm</title>
35	</refentryinfo>
36
37	<refmeta>
38	<refentrytitle>VBoxManage-modifyvm</refentrytitle>
39	<manvolnum>1</manvolnum>
40	</refmeta>
41
42	<refnamediv>
43	<refname>VBoxManage-modifyvm</refname>
44	<refpurpose>Change settings for a virtual machine that is stopped</refpurpose>
45	<refclass>&product-name;</refclass>
46	</refnamediv>
47
48	<refsynopsisdiv>
49	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-general">
50	<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
51	<command>VBoxManage modifyvm</command>
52	<group choice="req">
53	<arg choice="plain"><replaceable>uuid</replaceable></arg>
54	<arg choice="plain"><replaceable>vmname</replaceable></arg>
55	</group>
56	<arg>--name=<replaceable>name</replaceable></arg>
57	<arg>--groups=<replaceable>group</replaceable><arg rep="repeat">,<replaceable>group</replaceable></arg></arg>
58	<arg>--description=<replaceable>description</replaceable></arg>
59	<arg>--os-type=<replaceable>OS-type</replaceable></arg>
60	<arg>--icon-file=<replaceable>filename</replaceable></arg>
61	<arg>--memory=<replaceable>size-in-MB</replaceable></arg>
62	<arg>--page-fusion=<group choice="plain">
63	<arg choice="plain">on</arg>
64	<arg choice="plain">off</arg>
65	</group></arg>
66	<arg>--vram=<replaceable>size-in-MB</replaceable></arg>
67	<arg>--acpi=<group choice="plain">
68	<arg choice="plain">on</arg>
69	<arg choice="plain">off</arg>
70	</group></arg>
71	<arg>--ioapic=<group choice="plain">
72	<arg choice="plain">on</arg>
73	<arg choice="plain">off</arg>
74	</group></arg>
75	<arg>--hardware-uuid=<replaceable>UUID</replaceable></arg>
76	<arg>--cpus=<replaceable>CPU-count</replaceable></arg>
77	<arg>--cpu-hotplug=<group choice="plain">
78	<arg choice="plain">on</arg>
79	<arg choice="plain">off</arg>
80	</group></arg>
81	<arg>--plug-cpu=<replaceable>CPU-ID</replaceable></arg>
82	<arg>--unplug-cpu=<replaceable>CPU-ID</replaceable></arg>
83	<arg>--cpu-execution-cap=<replaceable>number</replaceable></arg>
84	<arg>--x86-pae=<group choice="plain">
85	<arg choice="plain">on</arg>
86	<arg choice="plain">off</arg>
87	</group></arg>
88	<arg>--x86-long-mode=<group choice="plain">
89	<arg choice="plain">on</arg>
90	<arg choice="plain">off</arg>
91	</group></arg>
92	<arg>--ibpb-on-vm-exit=<group choice="plain">
93	<arg choice="plain">on</arg>
94	<arg choice="plain">off</arg>
95	</group></arg>
96	<arg>--ibpb-on-vm-entry=<group choice="plain">
97	<arg choice="plain">on</arg>
98	<arg choice="plain">off</arg>
99	</group></arg>
100	<arg>--spec-ctrl=<group choice="plain">
101	<arg choice="plain">on</arg>
102	<arg choice="plain">off</arg>
103	</group></arg>
104	<arg>--l1d-flush-on-sched=<group choice="plain">
105	<arg choice="plain">on</arg>
106	<arg choice="plain">off</arg>
107	</group></arg>
108	<arg>--l1d-flush-on-vm-entry=<group choice="plain">
109	<arg choice="plain">on</arg>
110	<arg choice="plain">off</arg>
111	</group></arg>
112	<arg>--mds-clear-on-sched=<group choice="plain">
113	<arg choice="plain">on</arg>
114	<arg choice="plain">off</arg>
115	</group></arg>
116	<arg>--mds-clear-on-vm-entry=<group choice="plain">
117	<arg choice="plain">on</arg>
118	<arg choice="plain">off</arg>
119	</group></arg>
120	<arg>--cpu-profile=<group choice="plain">
121	<arg choice="plain">host</arg>
122	<arg choice="plain">Intel 8086</arg>
123	<arg choice="plain">Intel 80286</arg>
124	<arg choice="plain">Intel 80386</arg>
125	</group></arg>
126	<arg>--x86-hpet=<group choice="plain">
127	<arg choice="plain">on</arg>
128	<arg choice="plain">off</arg>
129	</group></arg>
130	<arg>--hwvirtex=<group choice="plain">
131	<arg choice="plain">on</arg>
132	<arg choice="plain">off</arg>
133	</group></arg>
134	<arg>--triple-fault-reset=<group choice="plain">
135	<arg choice="plain">on</arg>
136	<arg choice="plain">off</arg>
137	</group></arg>
138	<arg>--apic=<group choice="plain">
139	<arg choice="plain">on</arg>
140	<arg choice="plain">off</arg>
141	</group></arg>
142	<arg>--x86-x2apic=<group choice="plain">
143	<arg choice="plain">on</arg>
144	<arg choice="plain">off</arg>
145	</group></arg>
146	<arg>--paravirt-provider=<group choice="plain">
147	<arg choice="plain">none</arg>
148	<arg choice="plain">default</arg>
149	<arg choice="plain">legacy</arg>
150	<arg choice="plain">minimal</arg>
151	<arg choice="plain">hyperv</arg>
152	<arg choice="plain">kvm</arg>
153	</group></arg>
154	<arg>--paravirt-debug=<arg choice="plain"><replaceable>key</replaceable>=<replaceable>value</replaceable> [,<replaceable>key</replaceable>=<replaceable>value</replaceable>...]</arg></arg>
155	<arg>--nested-paging=<group choice="plain">
156	<arg choice="plain">on</arg>
157	<arg choice="plain">off</arg>
158	</group></arg>
159	<arg>--large-pages=<group choice="plain">
160	<arg choice="plain">on</arg>
161	<arg choice="plain">off</arg>
162	</group></arg>
163	<arg>--x86-vtx-vpid=<group choice="plain">
164	<arg choice="plain">on</arg>
165	<arg choice="plain">off</arg>
166	</group></arg>
167	<arg>--x86-vtx-ux=<group choice="plain">
168	<arg choice="plain">on</arg>
169	<arg choice="plain">off</arg>
170	</group></arg>
171	<arg>--nested-hw-virt=<group choice="plain">
172	<arg choice="plain">on</arg>
173	<arg choice="plain">off</arg>
174	</group></arg>
175	<arg>--virt-vmsave-vmload=<group choice="plain">
176	<arg choice="plain">on</arg>
177	<arg choice="plain">off</arg>
178	</group></arg>
179	<arg>--accelerate-3d=<group choice="plain">
180	<arg choice="plain">on</arg>
181	<arg choice="plain">off</arg>
182	</group></arg>
183	<arg>--accelerate-2d-video=<group choice="plain">
184	<arg choice="plain">on</arg>
185	<arg choice="plain">off</arg>
186	</group></arg>
187	<arg>--chipset=<group choice="plain">
188	<arg choice="plain">ich9</arg>
189	<arg choice="plain">piix3</arg>
190	<arg choice="plain">armv8virtual</arg>
191	</group></arg>
192	<arg>--iommu=<group choice="plain">
193	<arg choice="plain">none</arg>
194	<arg choice="plain">automatic</arg>
195	<arg choice="plain">amd</arg>
196	<arg choice="plain">intel</arg>
197	</group></arg>
198	<arg>--tpm-type=<group choice="plain">
199	<arg choice="plain">none</arg>
200	<arg choice="plain">1.2</arg>
201	<arg choice="plain">2.0</arg>
202	<arg choice="plain">host</arg>
203	<arg choice="plain">swtpm</arg>
204	</group></arg>
205	<arg>--tpm-location=<replaceable>location</replaceable></arg>
206	<arg>--firmware-logo-fade-in=<group choice="plain">
207	<arg choice="plain">on</arg>
208	<arg choice="plain">off</arg>
209	</group></arg>
210	<arg>--firmware-logo-fade-out=<group choice="plain">
211	<arg choice="plain">on</arg>
212	<arg choice="plain">off</arg>
213	</group></arg>
214	<arg>--firmware-logo-display-time=<replaceable>msec</replaceable></arg>
215	<arg>--firmware-logo-image-path=<replaceable>pathname</replaceable></arg>
216	<arg>--firmware-boot-menu=<group choice="plain">
217	<arg choice="plain">disabled</arg>
218	<arg choice="plain">menuonly</arg>
219	<arg choice="plain">messageandmenu</arg>
220	</group></arg>
221	<arg>--firmware-apic=<group choice="plain">
222	<arg choice="plain">disabled</arg>
223	<arg choice="plain">apic</arg>
224	<arg choice="plain">x2apic</arg>
225	</group></arg>
226	<arg>--firmware-system-time-offset=<replaceable>msec</replaceable></arg>
227	<arg>--firmware-pxe-debug=<group choice="plain">
228	<arg choice="plain">on</arg>
229	<arg choice="plain">off</arg>
230	</group></arg>
231	<arg>--system-uuid-le=<group choice="plain">
232	<arg choice="plain">on</arg>
233	<arg choice="plain">off</arg>
234	</group></arg>
235	<arg>--boot<replaceable>X</replaceable>=<group choice="plain">
236	<arg choice="plain">none</arg>
237	<arg choice="plain">floppy</arg>
238	<arg choice="plain">dvd</arg>
239	<arg choice="plain">disk</arg>
240	<arg choice="plain">net</arg>
241	</group></arg>
242	<arg>--rtc-use-utc=<group choice="plain">
243	<arg choice="plain">on</arg>
244	<arg choice="plain">off</arg>
245	</group></arg>
246	<arg>--graphicscontroller=<group choice="plain">
247	<arg choice="plain">none</arg>
248	<arg choice="plain">vboxvga</arg>
249	<arg choice="plain">vmsvga</arg>
250	<arg choice="plain">vboxsvga</arg>
251	</group></arg>
252	<arg>--snapshot-folder=<group choice="plain">
253	<arg choice="plain">default</arg>
254	<arg choice="plain"><replaceable>pathname</replaceable></arg>
255	</group></arg>
256	<arg>--firmware=<group choice="plain">
257	<arg choice="plain">bios</arg>
258	<arg choice="plain">efi</arg>
259	<arg choice="plain">efi32</arg>
260	<arg choice="plain">efi64</arg>
261	</group></arg>
262	<arg>--guest-memory-balloon=<replaceable>size-in-MB</replaceable></arg>
263	<arg>--default-frontend=<group choice="plain">
264	<arg choice="plain">default</arg>
265	<arg choice="plain"><replaceable>name</replaceable></arg>
266	</group></arg>
267	<!-- There are currently undocumented options --iocache and
268	--iocachesize which are scheduled for removal. Not worth spending
269	time on documenting it. -->
270	<arg>--vm-process-priority=<group choice="plain">
271	<arg choice="plain">default</arg>
272	<arg choice="plain">flat</arg>
273	<arg choice="plain">low</arg>
274	<arg choice="plain">normal</arg>
275	<arg choice="plain">high</arg>
276	</group></arg>
277	</cmdsynopsis>
278
279	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-networking">
280	<command>VBoxManage modifyvm</command>
281	<group choice="req">
282	<arg choice="plain"><replaceable>uuid</replaceable></arg>
283	<arg choice="plain"><replaceable>vmname</replaceable></arg>
284	</group>
285	<arg>--nic<replaceable>N</replaceable>=<group choice="plain">
286	<arg choice="plain">none</arg>
287	<arg choice="plain">null</arg>
288	<arg choice="plain">nat</arg>
289	<arg choice="plain">bridged</arg>
290	<arg choice="plain">intnet</arg>
291	<arg choice="plain">hostonly</arg>
292	<arg choice="plain">hostonlynet</arg>
293	<arg choice="plain">generic</arg>
294	<arg choice="plain">natnetwork</arg>
295	<arg choice="plain">cloud</arg>
296	</group></arg>
297	<arg>--nic-type<replaceable>N</replaceable>=<group choice="plain">
298	<arg choice="plain">Am79C970A</arg>
299	<arg choice="plain">Am79C973</arg>
300	<arg choice="plain">82540EM</arg>
301	<arg choice="plain">82543GC</arg>
302	<arg choice="plain">82545EM</arg>
303	<arg choice="plain">virtio</arg>
304	</group></arg>
305	<arg>--cable-connected<replaceable>N</replaceable>=<group choice="plain">
306	<arg choice="plain">on</arg>
307	<arg choice="plain">off</arg>
308	</group></arg>
309	<arg>--nic-trace<replaceable>N</replaceable>=<group choice="plain">
310	<arg choice="plain">on</arg>
311	<arg choice="plain">off</arg>
312	</group></arg>
313	<arg>--nic-trace-file<replaceable>N</replaceable>=<replaceable>filename</replaceable></arg>
314	<arg>--nic-property<replaceable>N</replaceable>=<replaceable>name</replaceable>= <arg><replaceable>value</replaceable></arg></arg>
315	<arg>--nic-speed<replaceable>N</replaceable>=<replaceable>kbps</replaceable></arg>
316	<arg>--nic-boot-prio<replaceable>N</replaceable>=<replaceable>priority</replaceable></arg>
317	<arg>--nic-promisc<replaceable>N</replaceable>=<group choice="plain">
318	<arg choice="plain">deny</arg>
319	<arg choice="plain">allow-vms</arg>
320	<arg choice="plain">allow-all</arg>
321	</group></arg>
322	<arg>--nic-bandwidth-group<replaceable>N</replaceable>=<group choice="plain">
323	<arg choice="plain">none</arg>
324	<arg choice="plain"><replaceable>name</replaceable></arg>
325	</group></arg>
326	<arg>--bridge-adapter<replaceable>N</replaceable>=<group choice="plain">
327	<arg choice="plain">none</arg>
328	<arg choice="plain"><replaceable>device-name</replaceable></arg>
329	</group></arg>
330	<arg>--cloud-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
331	<arg>--host-only-adapter<replaceable>N</replaceable>=<group choice="plain">
332	<arg choice="plain">none</arg>
333	<arg choice="plain"><replaceable>device-name</replaceable></arg>
334	</group></arg>
335	<arg>--host-only-net<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
336	<arg>--intnet<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
337	<arg>--nat-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
338	<arg>--nic-generic-drv<replaceable>N</replaceable>=<replaceable>driver-name</replaceable></arg>
339	<arg>--mac-address<replaceable>N</replaceable>=<group choice="plain">
340	<arg choice="plain">auto</arg>
341	<arg choice="plain"><replaceable>MAC-address</replaceable></arg>
342	</group></arg>
343	</cmdsynopsis>
344
345	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-networking-nat">
346	<command>VBoxManage modifyvm</command>
347	<group choice="req">
348	<arg choice="plain"><replaceable>uuid</replaceable></arg>
349	<arg choice="plain"><replaceable>vmname</replaceable></arg>
350	</group>
351	<arg>--nat-net<replaceable>N</replaceable>=<group choice="plain">
352	<arg choice="plain"><replaceable>network</replaceable></arg>
353	<arg choice="plain">default</arg>
354	</group></arg>
355	<arg>--nat-pf<replaceable>N</replaceable>=<group choice="plain">
356	<arg choice="plain">[<replaceable>rule-name</replaceable>],tcp</arg>
357	<arg choice="plain">udp,[<replaceable>host-IP</replaceable>],<replaceable>hostport</replaceable>,[<replaceable>guest-IP</replaceable>],<replaceable>guestport</replaceable></arg>
358	</group></arg>
359	<arg>--nat-pf<replaceable>N</replaceable>=delete=<replaceable>rule-name</replaceable></arg>
360	<arg>--nat-tftp-prefix<replaceable>N</replaceable>=<replaceable>prefix</replaceable></arg>
361	<arg>--nat-tftp-file<replaceable>N</replaceable>=<replaceable>filename</replaceable></arg>
362	<arg>--nat-tftp-server<replaceable>N</replaceable>=<replaceable>IP-address</replaceable></arg>
363	<arg>--nat-bind-ip<replaceable>N</replaceable>=<replaceable>IP-address</replaceable></arg>
364	<arg>--nat-dns-pass-domain<replaceable>N</replaceable>=<group choice="plain">
365	<arg choice="plain">on</arg>
366	<arg choice="plain">off</arg>
367	</group></arg>
368	<arg>--nat-dns-proxy<replaceable>N</replaceable>=<group choice="plain">
369	<arg choice="plain">on</arg>
370	<arg choice="plain">off</arg>
371	</group></arg>
372	<arg>--nat-dns-host-resolver<replaceable>N</replaceable>=<group choice="plain">
373	<arg choice="plain">on</arg>
374	<arg choice="plain">off</arg>
375	</group></arg>
376	<arg>--nat-localhostreachable<replaceable>N</replaceable>=<group choice="plain">
377	<arg choice="plain">on</arg>
378	<arg choice="plain">off</arg>
379	</group></arg>
380	<arg>--nat-settings<replaceable>N</replaceable>=[<replaceable>mtu</replaceable>],[<replaceable>socksnd</replaceable>],[<replaceable>sockrcv</replaceable>],[<replaceable>tcpsnd</replaceable>],[<replaceable>tcprcv</replaceable>]</arg>
381	<arg>--nat-alias-mode<replaceable>N</replaceable>=<group choice="plain">
382	<arg choice="plain">default</arg>
383	<arg choice="plain">[log],[proxyonly],[sameports]</arg>
384	</group></arg>
385	</cmdsynopsis>
386
387	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-other-hardware">
388	<command>VBoxManage modifyvm</command>
389	<group choice="req">
390	<arg choice="plain"><replaceable>uuid</replaceable></arg>
391	<arg choice="plain"><replaceable>vmname</replaceable></arg>
392	</group>
393	<arg>--mouse=<group choice="plain">
394	<arg choice="plain">ps2</arg>
395	<arg choice="plain">usb</arg>
396	<arg choice="plain">usbtablet</arg>
397	<arg choice="plain">usbmultitouch</arg>
398	<arg choice="plain">usbmtscreenpluspad</arg>
399	</group></arg>
400	<arg>--keyboard=<group choice="plain">
401	<arg choice="plain">ps2</arg>
402	<arg choice="plain">usb</arg>
403	</group></arg>
404	<arg>--uart<replaceable>N</replaceable>=<group choice="plain">
405	<arg choice="plain">off</arg>
406	<arg choice="plain"><replaceable>IO-base</replaceable> <replaceable>IRQ</replaceable></arg>
407	</group></arg>
408	<arg>--uart-mode<replaceable>N</replaceable>=<group choice="plain">
409	<arg choice="plain">disconnected</arg>
410	<arg choice="plain">server <replaceable>pipe</replaceable></arg>
411	<arg choice="plain">client <replaceable>pipe</replaceable></arg>
412	<arg choice="plain">tcpserver <replaceable>port</replaceable></arg>
413	<arg choice="plain">tcpclient <replaceable>hostname</replaceable>:<replaceable>port</replaceable></arg>
414	<arg choice="plain">file <replaceable>filename</replaceable></arg>
415	<arg choice="plain"><replaceable>device-name</replaceable></arg>
416	</group></arg>
417	<arg>--uart-type<replaceable>N</replaceable>=<group choice="plain">
418	<arg choice="plain">16450</arg>
419	<arg choice="plain">16550A</arg>
420	<arg choice="plain">16750</arg>
421	</group></arg>
422	<arg>--lpt-mode<replaceable>N</replaceable>=<replaceable>device-name</replaceable></arg>
423	<arg>--lpt<replaceable>N</replaceable>=<group choice="plain">
424	<arg choice="plain">off</arg>
425	<arg choice="plain"><replaceable>IO-base</replaceable> <replaceable>IRQ</replaceable></arg>
426	</group></arg>
427	<arg>--audio-controller=<group choice="plain">
428	<arg choice="plain">ac97</arg>
429	<arg choice="plain">hda</arg>
430	<arg choice="plain">sb16</arg>
431	</group></arg>
432	<arg>--audio-codec=<group choice="plain">
433	<arg choice="plain">stac9700</arg>
434	<arg choice="plain">ad1980</arg>
435	<arg choice="plain">stac9221</arg>
436	<arg choice="plain">sb16</arg>
437	</group></arg>
438	<arg>--audio-driver=<group choice="plain">
439	<arg choice="plain">none</arg>
440	<arg choice="plain">default</arg>
441	<arg choice="plain">null</arg>
442	<arg choice="plain">dsound</arg>
443	<arg choice="plain">was</arg>
444	<arg choice="plain">oss</arg>
445	<arg choice="plain">alsa</arg>
446	<arg choice="plain">pulse</arg>
447	<arg choice="plain">coreaudio</arg>
448	</group></arg>
449	<arg>--audio-enabled=<group choice="plain">
450	<arg choice="plain">on</arg>
451	<arg choice="plain">off</arg>
452	</group></arg>
453	<arg>--audio-in=<group choice="plain">
454	<arg choice="plain">on</arg>
455	<arg choice="plain">off</arg>
456	</group></arg>
457	<arg>--audio-out=<group choice="plain">
458	<arg choice="plain">on</arg>
459	<arg choice="plain">off</arg>
460	</group></arg>
461	<arg>--clipboard-mode=<group choice="plain">
462	<arg choice="plain">disabled</arg>
463	<arg choice="plain">hosttoguest</arg>
464	<arg choice="plain">guesttohost</arg>
465	<arg choice="plain">bidirectional</arg>
466	</group></arg>
467	<arg>--clipboard-file-transfers=<group choice="plain">
468	<arg choice="plain">enabled</arg>
469	<arg choice="plain">disabled</arg>
470	</group></arg>
471	<arg>--drag-and-drop=<group choice="plain">
472	<arg choice="plain">disabled</arg>
473	<arg choice="plain">hosttoguest</arg>
474	<arg choice="plain">guesttohost</arg>
475	<arg choice="plain">bidirectional</arg>
476	</group></arg>
477	<arg>--monitor-count=<replaceable>number</replaceable></arg>
478	<arg>--usb-ehci=<group choice="plain">
479	<arg choice="plain">on</arg>
480	<arg choice="plain">off</arg>
481	</group></arg>
482	<arg>--usb-ohci=<group choice="plain">
483	<arg choice="plain">on</arg>
484	<arg choice="plain">off</arg>
485	</group></arg>
486	<arg>--usb-xhci=<group choice="plain">
487	<arg choice="plain">on</arg>
488	<arg choice="plain">off</arg>
489	</group></arg>
490	<arg>--usb-rename=<replaceable>old-name</replaceable> <replaceable>new-name</replaceable></arg>
491	</cmdsynopsis>
492
493	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-recording">
494	<command>VBoxManage modifyvm</command>
495	<group choice="req">
496	<arg choice="plain"><replaceable>uuid</replaceable></arg>
497	<arg choice="plain"><replaceable>vmname</replaceable></arg>
498	</group>
499	<arg>--recording=<group choice="plain">
500	<arg choice="plain">on</arg>
501	<arg choice="plain">off</arg>
502	</group></arg>
503	<arg>--recording-screens=<group choice="plain">
504	<arg choice="plain">all</arg>
505	<arg choice="plain">none</arg>
506	<arg choice="plain"><replaceable>screen-ID</replaceable>[,<replaceable>screen-ID</replaceable>...]</arg>
507	</group></arg>
508	<arg>--recording-file=<replaceable>filename</replaceable></arg>
509	<arg>--recording-max-size=<replaceable>MB</replaceable></arg>
510	<arg>--recording-max-time=<replaceable>msec</replaceable></arg>
511	<arg>--recording-opts= <arg choice="plain"><replaceable>key</replaceable>=<replaceable>value</replaceable>[,<replaceable>key</replaceable>=<replaceable>value</replaceable>...]</arg></arg>
512	<arg>--recording-video-fps=<replaceable>fps</replaceable></arg>
513	<arg>--recording-video-rate=<replaceable>rate</replaceable></arg>
514	<arg>--recording-video-res=<replaceable>width</replaceable> x <replaceable>height</replaceable></arg><!-- 'x' shouldn't need spaces around it... -->
515	</cmdsynopsis>
516
517	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-vrde">
518	<command>VBoxManage modifyvm</command>
519	<group choice="req">
520	<arg choice="plain"><replaceable>uuid</replaceable></arg>
521	<arg choice="plain"><replaceable>vmname</replaceable></arg>
522	</group>
523	<arg>--vrde=<group choice="plain">
524	<arg choice="plain">on</arg>
525	<arg choice="plain">off</arg>
526	</group></arg>
527	<arg>--vrde-property=<replaceable>property-name</replaceable>=<arg><replaceable>property-value</replaceable></arg></arg>
528	<arg>--vrde-extpack=<group choice="plain">
529	<arg choice="plain">default</arg>
530	<arg choice="plain"><replaceable>name</replaceable></arg>
531	</group></arg>
532	<arg>--vrde-port=<replaceable>port</replaceable></arg>
533	<arg>--vrde-address=<replaceable>hostip</replaceable></arg>
534	<arg>--vrde-auth-type=<group choice="plain">
535	<arg choice="plain">null</arg>
536	<arg choice="plain">external</arg>
537	<arg choice="plain">guest</arg>
538	</group></arg>
539	<arg>--vrde-auth-library=<group choice="plain">
540	<arg choice="plain">default</arg>
541	<arg choice="plain"><replaceable>name</replaceable></arg>
542	</group></arg>
543	<arg>--vrde-multi-con=<group choice="plain">
544	<arg choice="plain">on</arg>
545	<arg choice="plain">off</arg>
546	</group></arg>
547	<arg>--vrde-reuse-con=<group choice="plain">
548	<arg choice="plain">on</arg>
549	<arg choice="plain">off</arg>
550	</group></arg>
551	<arg>--vrde-video-channel=<group choice="plain">
552	<arg choice="plain">on</arg>
553	<arg choice="plain">off</arg>
554	</group></arg>
555	<arg>--vrde-video-channel-quality=<replaceable>percent</replaceable></arg>
556	</cmdsynopsis>
557
558	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-teleport">
559	<command>VBoxManage modifyvm</command>
560	<group choice="req">
561	<arg choice="plain"><replaceable>uuid</replaceable></arg>
562	<arg choice="plain"><replaceable>vmname</replaceable></arg>
563	</group>
564	<arg>--teleporter=<group choice="plain">
565	<arg choice="plain">on</arg>
566	<arg choice="plain">off</arg>
567	</group></arg>
568	<arg>--teleporter-port=<replaceable>port</replaceable></arg>
569	<arg>--teleporter-address=<group choice="plain">
570	<arg choice="plain"><replaceable>address</replaceable></arg>
571	<arg choice="plain">empty</arg>
572	</group></arg>
573	<arg>--teleporter-password=<replaceable>password</replaceable></arg>
574	<arg>--teleporter-password-file=<group choice="plain">
575	<arg choice="plain"><replaceable>filename</replaceable></arg>
576	<arg choice="plain">stdin</arg>
577	</group></arg>
578	<arg>--cpuid-portability-level=<replaceable>level</replaceable></arg>
579	<arg>--cpuid-set=<replaceable>leaf</replaceable><arg>:<replaceable>subleaf</replaceable></arg> <replaceable>eax</replaceable> <replaceable>ebx</replaceable> <replaceable>ecx</replaceable> <replaceable>edx</replaceable></arg>
580	<arg>--cpuid-remove=<replaceable>leaf</replaceable><arg>:<replaceable>subleaf</replaceable></arg></arg>
581	<arg>--cpuid-remove-all</arg>
582	</cmdsynopsis>
583
584	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-debugging">
585	<command>VBoxManage modifyvm</command>
586	<group choice="req">
587	<arg choice="plain"><replaceable>uuid</replaceable></arg>
588	<arg choice="plain"><replaceable>vmname</replaceable></arg>
589	</group>
590	<arg>--tracing-enabled=<group choice="plain">
591	<arg choice="plain">on</arg>
592	<arg choice="plain">off</arg>
593	</group></arg>
594	<arg>--tracing-config=<replaceable>string</replaceable></arg>
595	<arg>--tracing-allow-vm-access=<group choice="plain">
596	<arg choice="plain">on</arg>
597	<arg choice="plain">off</arg>
598	</group></arg>
599	</cmdsynopsis>
600
601	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-usbcardreader">
602	<command>VBoxManage modifyvm</command>
603	<group choice="req">
604	<arg choice="plain"><replaceable>uuid</replaceable></arg>
605	<arg choice="plain"><replaceable>vmname</replaceable></arg>
606	</group>
607	<arg>--usb-card-reader=<group choice="plain">
608	<arg choice="plain">on</arg>
609	<arg choice="plain">off</arg>
610	</group></arg>
611	</cmdsynopsis>
612
613	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-autostart">
614	<command>VBoxManage modifyvm</command>
615	<group choice="req">
616	<arg choice="plain"><replaceable>uuid</replaceable></arg>
617	<arg choice="plain"><replaceable>vmname</replaceable></arg>
618	</group>
619	<arg>--autostart-enabled=<group choice="plain">
620	<arg choice="plain">on</arg>
621	<arg choice="plain">off</arg>
622	</group></arg>
623	<arg>--autostart-delay=<replaceable>seconds</replaceable></arg>
624	<!-- There is a currently undocumented option --autostop-type.
625	Most autostart service implementations either ignore it or rely it is
626	left unchanged due to otherwise running into timeouts established by the
627	host OS, defeating the purpose. Not worth spending time on documenting
628	it unless this changes. -->
629	</cmdsynopsis>
630
631	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-guest-debug">
632	<command>VBoxManage modifyvm</command>
633	<group choice="req">
634	<arg choice="plain"><replaceable>uuid</replaceable></arg>
635	<arg choice="plain"><replaceable>vmname</replaceable></arg>
636	</group>
637	<arg>--guest-debug-provider=<group choice="plain">
638	<arg choice="plain">none</arg>
639	<arg choice="plain">native</arg>
640	<arg choice="plain">gdb</arg>
641	<arg choice="plain">kd</arg>
642	</group></arg>
643	<arg>--guest-debug-io-provider=<group choice="plain">
644	<arg choice="plain">none</arg>
645	<arg choice="plain">tcp</arg>
646	<arg choice="plain">udp</arg>
647	<arg choice="plain">ipc</arg>
648	</group></arg>
649	<arg>--guest-debug-address=<group choice="plain">
650	<arg choice="plain"><replaceable>IP-Address</replaceable></arg>
651	<arg choice="plain"><replaceable>path</replaceable></arg>
652	</group></arg>
653	<arg>--guest-debug-port=<replaceable>port</replaceable></arg>
654	</cmdsynopsis>
655
656	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-pcipassthrough">
657	<command>VBoxManage modifyvm</command>
658	<group choice="req">
659	<arg choice="plain"><replaceable>uuid</replaceable></arg>
660	<arg choice="plain"><replaceable>vmname</replaceable></arg>
661	</group>
662	<arg>--pci-attach=<replaceable>host-PCI-address</replaceable><arg>@<replaceable>guest-PCI-bus-address</replaceable></arg></arg>
663	<arg>--pci-detach=<replaceable>host-PCI-address</replaceable></arg>
664	</cmdsynopsis>
665
666	<cmdsynopsis id="synopsis-vboxmanage-modifyvm-testing">
667	<command>VBoxManage modifyvm</command>
668	<group choice="req">
669	<arg choice="plain"><replaceable>uuid</replaceable></arg>
670	<arg choice="plain"><replaceable>vmname</replaceable></arg>
671	</group>
672	<arg>--testing-enabled=<group choice="plain"><arg choice="plain">on</arg><arg choice="plain">off</arg></group></arg>
673	<arg>--testing-mmio=<group choice="plain"><arg choice="plain">on</arg><arg choice="plain">off</arg></group></arg>
674	<arg>--testing-cfg-dword<replaceable>idx</replaceable>=<replaceable>value</replaceable></arg>
675	</cmdsynopsis>
676	</refsynopsisdiv>
677
678	<refsect1 id="vboxmanage-modifyvm-description">
679	<title>Description</title>
680	<para>
681	The <command>VBoxManage modifyvm</command> command enables you to
682	change the properties of a registered virtual machine (VM) that is
683	not running.
684	</para>
685	<para>
686	Most of these properties correspond to the VM settings that are
687	shown in each VM's <emphasis role="bold">Settings</emphasis>
688	dialog in the VirtualBox Manager. See
689	<xref linkend="BasicConcepts" />. However, some settings can only
690	be viewed and managed with the <command>VBoxManage</command>
691	command.
692	</para>
693	<para>
694	You can use the <command>VBoxManage modifyvm</command> command to
695	change VM settings only when the VM is powered off. The VM cannot
696	be running or in saved state when you use this command.
697	</para>
698	<para>
699	You can use the <command>VBoxManage controlvm</command> command to
700	dynamically change some VM machine settings while the VM is
701	running. See <xref linkend="vboxmanage-controlvm" />.
702	</para>
703	<refsect2 id="vboxmanage-modifyvm-general">
704	<title>General Settings</title>
705	<remark role="help-copy-synopsis"/>
706	<para>
707	The following options enable you to modify general information
708	about your VM.
709	</para>
710	<para>
711	The <command>VBoxManage modifyvm</command> command supports the
712	following options:
713	</para>
714	<variablelist>
715	<varlistentry>
716	<term><option>--name=<replaceable>vmname</replaceable></option></term>
717	<listitem><para>
718	Changes the name of the VM and its related internal VM
719	files. See <xref linkend="vboxmanage-createvm"/>.
720	</para></listitem>
721	</varlistentry>
722	<varlistentry>
723	<term><option>--groups=<replaceable>group</replaceable></option></term>
724	<listitem><para>
725	Changes the group membership of a VM. Group names always
726	begin with a slash character (<literal>/</literal>) and
727	can be nested. By default, VMs are members of the
728	<literal>/</literal> group. A VM can be member of multiple
729	groups, but its primary group determines the directory
730	structure where the internal VM files are placed by default.
731	</para></listitem>
732	</varlistentry>
733	<varlistentry>
734	<term><option>--description=<replaceable>desc</replaceable></option></term>
735	<listitem><para>
736	Changes the optional VM description. Use a description to
737	record details about the VM in a meaningful way. The GUI
738	interprets HTML markup while the <command>VBoxManage
739	modifyvm</command> command enables you include arbitrary
740	strings that can contain multiple lines.
741	</para></listitem>
742	</varlistentry>
743	<varlistentry>
744	<term><option>--os-type=<replaceable>OS-type</replaceable></option></term>
745	<listitem><para>
746	Specifies the guest operating system (OS) information for
747	the VM. Use the <command>VBoxManage list ostypes</command>
748	command to view the OS type identifiers.
749	</para></listitem>
750	</varlistentry>
751	<varlistentry>
752	<term><option>--icon-file=<replaceable>filename</replaceable></option></term>
753	<listitem><para>
754	Specifies the path to the VM icon file in PNG format
755	on the host system. The icon is shown in the VM manager
756	UI and when running the VM with UI.
757	</para></listitem>
758	</varlistentry>
759	<varlistentry>
760	<term><option>--memory=<replaceable>size</replaceable></option></term>
761	<listitem><para>
762	Specifies the amount of host system RAM to allocate to the
763	VM. The size is in MB. See
764	<xref linkend="create-vm-wizard" />.
765	</para></listitem>
766	</varlistentry>
767	<varlistentry>
768	<term><option>--page-fusion=on \| off</option></term>
769	<listitem><para>
770	Enables or disables the Page Fusion feature, which is
771	disabled by default. Use the Page Fusion feature to
772	minimize the memory duplication between VMs that have
773	similar configurations and that run on the same host
774	system. See <xref linkend="guestadd-pagefusion" />.
775	</para></listitem>
776	</varlistentry>
777	<varlistentry>
778	<term><option>--vram=<replaceable>size</replaceable></option></term>
779	<listitem><para>
780	Specifies the amount of RAM to allocate to the virtual
781	graphics card. See <xref linkend="settings-display" />.
782	</para></listitem>
783	</varlistentry>
784	<varlistentry>
785	<term><option>--acpi=on \| off</option></term>
786	<listitem><para>
787	Determines whether the VM has ACPI support. See
788	<xref linkend="settings-motherboard" />.
789	</para></listitem>
790	</varlistentry>
791	<varlistentry>
792	<term><option>--ioapic=on \| off</option></term>
793	<listitem><para>
794	Determines whether the VM has I/O APIC support. See
795	<xref linkend="settings-motherboard" />.
796	</para></listitem>
797	</varlistentry>
798	<varlistentry>
799	<term><option>--hardware-uuid=<replaceable>uuid</replaceable></option></term>
800	<listitem><para>
801	Specifies the Universally Unique Identifier (UUID) to
802	present to the guest VM in memory tables (DMI/SMBIOS),
803	hardware, and VM properties. By default this hardware UUID
804	is the same as the VM UUID. Cloning a VM and the teleporting
805	feature automatically preserve the hardware UUID value.
806	Likewise for Virtual Appliance export and import, but only
807	if both operations are done by &product-name;.
808	</para></listitem>
809	</varlistentry>
810	<varlistentry>
811	<term><option>--cpus=<replaceable>CPU-count</replaceable></option></term>
812	<listitem><para>
813	Specifies the number of virtual CPUs to assign to the VM.
814	See <xref linkend="settings-processor" />.
815	</para><para>
816	If CPU hot-plugging is enabled, this option specifies the
817	maximum number of virtual CPUs that can be plugged into
818	the VMs.
819	</para></listitem>
820	</varlistentry>
821	<varlistentry>
822	<term><option>--cpu-hotplug=on \| off</option></term>
823	<listitem><para>
824	Enables or disables CPU hot-plugging. When enabled, you
825	can dynamically add virtual CPUs to a VM or remove virtual
826	CPUs from a VM. See <xref linkend="cpuhotplug" />.
827	</para></listitem>
828	</varlistentry>
829	<varlistentry>
830	<term><option>--plug-cpu=<replaceable>CPU-ID</replaceable></option></term>
831	<listitem><para>
832	Adds a virtual CPU to the VM.
833	<replaceable>CPU-ID</replaceable> is the index of the
834	virtual CPU to add. A valid index value is a number from
835	<literal>0</literal> to the maximum number of CPUs that
836	you configured by using the <option>--cpus</option>
837	option.
838	</para><para>
839	Only use this option if CPU hot-plugging is enabled.
840	</para></listitem>
841	</varlistentry>
842	<varlistentry>
843	<term><option>--unplug-cpu=<replaceable>CPU-ID</replaceable></option></term>
844	<listitem><para>
845	Removes a virtual CPU from the VM.
846	<replaceable>CPU-ID</replaceable> is the index of the
847	virtual CPU to remove. A valid index value is a number
848	from <literal>1</literal> to the maximum number of CPUs
849	that you configured by using the <option>--cpus</option>
850	option.
851	</para><para>
852	Only use this option if CPU hot-plugging is enabled.
853	</para><para>
854	Note that you cannot remove CPU 0.
855	</para></listitem>
856	</varlistentry>
857	<varlistentry>
858	<term><option>--cpuexectioncap=<replaceable>percentage</replaceable></option></term>
859	<listitem>
860	<para>
861	Specifies how much CPU time a virtual CPU can use. A valid
862	value is from <literal>1</literal> to
863	<literal>100</literal>. A value of 50 indicates that a
864	single virtual CPU can use up to 50% of a single host CPU.
865	</para>
866	<para>
867	Use this feature with caution, it can have unexpected results
868	including timekeeping problems and lower performance than
869	specified. If you want to limit the resource usage of a VM
870	it is more reliable to pick an appropriate number of VCPUs.
871	</para>
872	</listitem>
873	</varlistentry>
874	<varlistentry>
875	<term><option>--x86-pae=on \| off</option></term>
876	<listitem><para>
877	Enables or disables physical address extension (PAE). See
878	<xref linkend="settings-processor" />.
879	</para></listitem>
880	</varlistentry>
881	<varlistentry>
882	<term><option>--x86-long-mode=on \| off</option></term>
883	<listitem><para>
884	Enables or disables long mode. See
885	<xref linkend="settings-processor" />.
886	</para></listitem>
887	</varlistentry>
888	<varlistentry>
889	<term><option>--ibpb-on-vm-exit=on \| off</option></term>
890	<listitem><para>
891	Enables use of Indirect Branch Prediction Barrier (IBPB)
892	on every VM exit.
893	</para></listitem>
894	</varlistentry>
895	<varlistentry>
896	<term><option>--ibpb-on-vm-entry=on \| off</option></term>
897	<listitem><para>
898	Enables use of Indirect Branch Prediction Barrier (IBPB)
899	on every VM entry.
900	</para></listitem>
901	</varlistentry>
902	<varlistentry>
903	<term><option>--spec-ctrl=on \| off</option></term>
904	<listitem><para>
905	Enables or disables the exposure of speculation control
906	interfaces to the guest VM. These interfaces must be
907	available on the host system.
908	</para><para>
909	Depending on the host CPU and the workload, enabling
910	speculation control might significantly reduce
911	performance.
912	</para></listitem>
913	</varlistentry>
914	<varlistentry>
915	<term><option>--l1d-flush-on-sched=on \| off</option></term>
916	<listitem><para>
917	Enables or disables level 1 data cache flushing when a
918	thread is scheduled to execute guest code. See
919	<xref linkend="sec-rec-cve-2018-3646" />.
920	</para></listitem>
921	</varlistentry>
922	<varlistentry>
923	<term><option>--l1d-flush-on-vm-entry=on \| off</option></term>
924	<listitem><para>
925	Enables or disables level 1 data cache flushing on every
926	VM entry. See <xref linkend="sec-rec-cve-2018-3646" />.
927	</para></listitem>
928	</varlistentry>
929	<varlistentry>
930	<term><option>--mds-clear-on-sched=on \| off</option></term>
931	<listitem><para>
932	Enables CPU buffer clearing when a thread is scheduled to
933	execute guest code. See
934	<xref linkend="sec-rec-cve-2018-12126-et-al" />.
935	</para></listitem>
936	</varlistentry>
937	<varlistentry>
938	<term><option>--mds-clear-on-vm-entry=on \| off</option></term>
939	<listitem><para>
940	Enables CPU buffer clearing on every VM entry. See
941	<xref linkend="sec-rec-cve-2018-12126-et-al" />.
942	</para></listitem>
943	</varlistentry>
944	<varlistentry>
945	<term><option>--cpu-profile=host \| Intel 8086 \| Intel 80286 \| Intel 80386</option></term>
946	<listitem><para>
947	Specifies the profile to use for guest CPU emulation.
948	Specify a value that is based on the host system CPU
949	(<literal>host</literal>) or one of the following older
950	Intel micro-architectures: <literal>8086</literal>,
951	<literal>80286</literal>, or <literal>80386</literal>.
952	</para></listitem>
953	</varlistentry>
954	<varlistentry>
955	<term><option>--x86-hpet=on \| off</option></term>
956	<listitem><para>
957	Enables or disables a High Precision Event Timer (HPET)
958	that can replace a legacy system timer. This feature is
959	disabled by default. Note HPET is supported on Windows
960	versions starting with Vista.
961	</para></listitem>
962	</varlistentry>
963	<varlistentry>
964	<term><option>--hwvirtex=on \| off</option></term>
965	<listitem><para>
966	Enables or disables the use of hardware virtualization
967	extensions in the processor of the host system. Such
968	extensions are Intel VT-x or AMD-V. See
969	<xref linkend="hwvirt" />.
970	</para></listitem>
971	</varlistentry>
972	<varlistentry>
973	<term><option>--triple-fault-reset=on \| off</option></term>
974	<listitem><para>
975	Enables or disables the resetting of the guest VM instead
976	of triggering a Guru Meditation. Some guest VMs raise a
977	triple fault to reset the CPU, so sometimes resetting the
978	guest VM is the best outcome. This option only applies to
979	guests that do not use symmetric multiprocessing (SMP).
980	</para></listitem>
981	</varlistentry>
982	<varlistentry>
983	<term><option>--apic=on \| off</option></term>
984	<listitem><para>
985	Enables or disables APIC. With APIC, OSes can use
986	more than 16 interrupt requests (IRQs) to avoid IRQ
987	sharing and to improve reliability. APIC is enabled by
988	default. See <xref linkend="settings-motherboard" />.
989	</para></listitem>
990	</varlistentry>
991	<varlistentry>
992	<term><option>--x86-x2apic=on \| off</option></term>
993	<listitem><para>
994	Enables or disables the CPU x2APIC feature. CPU x2APIC
995	enables an OS to run more efficiently on high core count
996	configurations and to optimize interrupt distribution in
997	virtualized environments. This feature is enabled by
998	default.
999	</para><para>
1000	Disable this feature when the OS that runs on a host
1001	system or a guest VM is incompatible with CPU x2APIC.
1002	</para></listitem>
1003	</varlistentry>
1004	<varlistentry>
1005	<term><option>--paravirt-provider=none \| default \| legacy \| minimal \| hyperv \| kvm</option></term>
1006	<listitem><para>
1007	Specifies one of the following paravirtualization
1008	interfaces to provide to the guest OS:
1009	</para><itemizedlist>
1010	<listitem><para>
1011	<literal>none</literal> does not expose any
1012	paravirtualization interface.
1013	</para></listitem>
1014	<listitem><para>
1015	<literal>default</literal> selects the appropriate
1016	interface based on the guest OS type when starting the
1017	VM. This is the default value used when creating new
1018	VMs.
1019	</para></listitem>
1020	<listitem><para>
1021	<literal>legacy</literal> selects a paravirtual
1022	interface for VMs that were created by older
1023	&product-name; versions.
1024	</para></listitem>
1025	<listitem><para>
1026	<literal>minimal</literal> is required for Mac OS X
1027	guest VMs.
1028	</para></listitem>
1029	<listitem><para>
1030	<literal>kvm</literal> is recommended for Linux guest
1031	VMs. See <xref linkend="gimproviders" />.
1032	</para></listitem>
1033	<listitem><para>
1034	<literal>hyperv</literal> is recommended for Windows
1035	guest VMs. See <xref linkend="gimproviders" />.
1036	</para></listitem>
1037	</itemizedlist></listitem>
1038	</varlistentry>
1039	<varlistentry>
1040	<term><option>--paravirt-debug=<replaceable>property</replaceable>=<replaceable>value</replaceable></option></term>
1041	<listitem><para>
1042	Specifies debugging properties that are specific to the
1043	paravirtualization provider configured for the specified
1044	VM. See <xref linkend="gimdebug" />.
1045	</para></listitem>
1046	</varlistentry>
1047	<varlistentry>
1048	<term><option>--nested-paging=on \| off</option></term>
1049	<listitem><para>
1050	Enables or disables the nested paging feature in the
1051	processor of the host system. This option is available
1052	only when hardware virtualization is enabled. See
1053	<xref linkend="hwvirt" /> and
1054	<xref linkend="sec-rec-cve-2018-3646" />.
1055	</para></listitem>
1056	</varlistentry>
1057	<varlistentry>
1058	<term><option>--large-pages=on \| off</option></term>
1059	<listitem><para>
1060	Enables or disables the hypervisor's use of large pages,
1061	which can improve performance by up to 5%. The use of
1062	large pages reduces TLB use and overhead. This option is
1063	available only when both hardware virtualization and
1064	nested paging are enabled.
1065	</para></listitem>
1066	</varlistentry>
1067	<varlistentry>
1068	<term><option>--x86-vtx-vpid=on \| off</option></term>
1069	<listitem><para>
1070	Enables or disables the use of the tagged TLB (VPID)
1071	feature in the processor of your host system. See
1072	<xref linkend="hwvirt" />. This option is available only
1073	when hardware virtualization is enabled on Intel VT-x.
1074	</para></listitem>
1075	</varlistentry>
1076	<varlistentry>
1077	<term><option>--x86-vtx-ux=on \| off</option></term>
1078	<listitem><para>
1079	Enables or disables the use of unrestricted guest mode for
1080	executing the guest VM. This option is available only when
1081	hardware virtualization is enabled on Intel VT-x.
1082	</para></listitem>
1083	</varlistentry>
1084	<varlistentry>
1085	<term><option>--nested-hw-virt=on \| off</option></term>
1086	<listitem><para>
1087	Enables or disables nested virtualization. Enabling makes
1088	hardware virtualization features available to the VM. See
1089	<xref linkend="nested-virt" />.
1090	</para></listitem>
1091	</varlistentry>
1092	<varlistentry>
1093	<term><option>--virt-vmsave-vmload=on \| off</option></term>
1094	<listitem><para>
1095	If hardware virtualization is enabled and the host has an
1096	AMD CPU, this setting enables or disables the use of the
1097	virtualized vmsave/vmload host feature while executing the
1098	VM. It is enabled by default. It is recommended to leave it
1099	enabled as it has a drastic impact on performance while
1100	executing nested VMs when using the nested hardware
1101	virtualization feature.
1102	<xref linkend="nested-virt" />.
1103	</para></listitem>
1104	</varlistentry>
1105	<varlistentry>
1106	<term><option>--accelerated3d=on \| off</option></term>
1107	<listitem><para>
1108	Enables or disables hardware 3D acceleration for the
1109	graphics adapter variants which support it. This option
1110	has an effect only when the Guest Additions are installed.
1111	See <xref linkend="guestadd-3d" />.
1112	</para></listitem>
1113	</varlistentry>
1114	<varlistentry>
1115	<term><option>--accelerated2dvideo=on \| off</option></term>
1116	<listitem><para>
1117	Enables or disables 2D video acceleration for the graphics
1118	adapter variants which support it. This option has an effect
1119	only when the Guest Additions are installed. See
1120	<xref linkend="guestadd-2d" />.
1121	</para></listitem>
1122	</varlistentry>
1123	<varlistentry>
1124	<term><option>--chipset=piix3 \| ich9 \| armv8virtual</option></term>
1125	<listitem><para>
1126	Specify the Intel chipset for &product-name; to emulate.
1127	For the x86 platform, the default value is the Intel PIIX3 chipset.
1128	(<literal>piix3</literal>).
1129	For the ARM platform, the default value is the ARMv8Virtual chipset.
1130	(<literal>armv8virtual</literal>).
1131	</para><para>
1132	Change this value only if you need to relax some of the
1133	chipset constraints. See
1134	<xref linkend="settings-motherboard" />.
1135	</para></listitem>
1136	</varlistentry>
1137	<varlistentry>
1138	<term><option>--iommu=none \| automatic \| amd \| intel</option></term>
1139	<listitem><para>
1140	Specifies the IOMMU type for &product-name; to emulate.
1141	Both Intel and AMD IOMMU emulation currently require the
1142	use of the Intel ICH9 chipset (see
1143	<option>--chipset</option> option).
1144	</para><para>
1145	Valid values are as follows:
1146	</para><itemizedlist>
1147	<listitem><para>
1148	<literal>none</literal> – No IOMMU is present
1149	and is the default value.
1150	</para></listitem>
1151	<listitem><para>
1152	<literal>automatic</literal> – An IOMMU is
1153	present but its type is automatically chosen to match
1154	the host CPU vendor when the VM is powered on.
1155	</para></listitem>
1156	<listitem><para>
1157	<literal>amd</literal> – An AMD IOMMU is
1158	present.
1159	</para></listitem>
1160	<listitem><para>
1161	<literal>intel</literal> – An Intel IOMMU is
1162	present.
1163	</para></listitem>
1164	</itemizedlist></listitem>
1165	</varlistentry>
1166	<varlistentry>
1167	<term><option>--tpm-type=none \| 1.2 \| 2.0 \| host \| swtpm</option></term>
1168	<listitem><para>
1169	Specifies the TPM type for &product-name; to emulate.
1170	</para><para>
1171	Valid values are as follows:
1172	</para><itemizedlist>
1173	<listitem><para>
1174	<literal>none</literal> – No TPM is present
1175	and is the default value.
1176	</para></listitem>
1177	<listitem><para>
1178	<literal>1.2</literal> – A TPM conforming to the TCG specification
1179	version 1.2 is present.
1180	</para></listitem>
1181	<listitem><para>
1182	<literal>2.0</literal> – A TPM conforming to the TCG specification
1183	version 2.0 is present.
1184	</para></listitem>
1185	<listitem><para>
1186	<literal>host</literal> – The host TPM is passed through to the guest.
1187	May not be available on all supported host platforms.
1188	</para></listitem>
1189	<listitem><para>
1190	<literal>swtpm</literal> – The VM connects to an external TPM emulation
1191	compliant to swtpm. Requires to set the TPM location to connect to (see
1192	<option>--tpm-location</option> option).
1193	</para></listitem>
1194	</itemizedlist></listitem>
1195	</varlistentry>
1196	<varlistentry>
1197	<term><option>--firmware-logo-fade-in=on \| off</option></term>
1198	<listitem><para>
1199	Specifies whether the BIOS logo fades in on VM startup. By
1200	default, an &product-name; logo is shown.
1201	</para></listitem>
1202	</varlistentry>
1203	<varlistentry>
1204	<term><option>--firmware-logo-fade-out=on \| off</option></term>
1205	<listitem><para>
1206	Specifies whether the BIOS logo fades out on VM startup.
1207	</para></listitem>
1208	</varlistentry>
1209	<varlistentry>
1210	<term><option>--firmware-logo-display-time=<replaceable>msec</replaceable></option></term>
1211	<listitem><para>
1212	Specifies the amount of time in milliseconds that the BIOS
1213	logo is visible.
1214	</para></listitem>
1215	</varlistentry>
1216	<varlistentry>
1217	<term><option>--firmware-logo-image-path=<replaceable>pathname</replaceable></option></term>
1218	<listitem><para>
1219	Replaces the existing BIOS logo with a different image.
1220	The replacement image must be an uncompressed 16, 256 or 16M
1221	color bitmap file (BMP) that does not contain color space
1222	information (Windows 3.0 format). Also ensure that the
1223	image is no larger than 640 X 480 pixels.
1224	</para></listitem>
1225	</varlistentry>
1226	<varlistentry>
1227	<term><option>--firmware-boot-menu=disabled \| menuonly \| messageandmenu</option></term>
1228	<listitem><para>
1229	Specifies whether the BIOS permits you to select a
1230	temporary boot device. Valid values are:
1231	</para><itemizedlist>
1232	<listitem><para>
1233	<literal>disabled</literal> outputs the alternate boot
1234	device message and permits you to select a temporary
1235	boot device by pressing F12.
1236	</para></listitem>
1237	<listitem><para>
1238	<literal>menuonly</literal> suppresses the alternate
1239	boot device message, but permits you to select a
1240	temporary boot device by pressing F12.
1241	</para></listitem>
1242	<listitem><para>
1243	<literal>messageandmenu</literal> suppresses the
1244	alternate boot device message and prevents you from
1245	selecting a temporary boot device by pressing F12.
1246	</para></listitem>
1247	</itemizedlist></listitem>
1248	</varlistentry>
1249	<varlistentry>
1250	<term><option>--firmware-apic=x2apic \| apic \| disabled</option></term>
1251	<listitem><para>
1252	Specifies the APIC level of the firmware. Valid values
1253	are: <literal>x2apic</literal>, <literal>apic</literal>,
1254	and <literal>disabled</literal>. When the value is
1255	<literal>disabled</literal>, neither the
1256	<literal>apic</literal> nor the <literal>x2apic</literal>
1257	version of the firmware is used.
1258	</para><para>
1259	Note that if you specify the <literal>x2apic</literal>
1260	value and x2APIC is unsupported by the virtual CPU, the
1261	APIC level downgrades to <literal>apic</literal>, if
1262	supported. Otherwise, the APIC level downgrades to
1263	<literal>disabled</literal>. Similarly, if you specify the
1264	<literal>apic</literal> value and APIC is unsupported by
1265	the virtual CPU, the APIC level downgrades to
1266	<literal>disabled</literal>.
1267	</para></listitem>
1268	</varlistentry>
1269	<varlistentry>
1270	<term><option>--firmware-system-time-offset=<replaceable>msec</replaceable></option></term>
1271	<listitem><para>
1272	Specifies the time offset in milliseconds of the guest VM
1273	relative to the time on the host system. If the offset
1274	value is positive, the guest VM time runs ahead of the
1275	time on the host system.
1276	</para></listitem>
1277	</varlistentry>
1278	<varlistentry>
1279	<term><option>--firmware-pxe-debug=on \| off</option></term>
1280	<listitem><para>
1281	Enables or disables additional debugging output when using
1282	the Intel PXE boot ROM. The debug output is written to the
1283	release log file. See
1284	<xref linkend="collect-debug-info" />.
1285	</para></listitem>
1286	</varlistentry>
1287	<varlistentry>
1288	<term><option>--system-uuid-le=on \| off</option></term>
1289	<listitem><para>
1290	Enables or disables representing the system UUID in little
1291	endian form. The default value is <literal>on</literal> for
1292	new VMs. For old VMs the setting is <literal>off</literal> to
1293	keep the content of the DMI/SMBIOS table unchanged, which can
1294	be important for Windows license activation.
1295	</para></listitem>
1296	</varlistentry>
1297	<varlistentry>
1298	<term><option>--boot<replaceable>N</replaceable>=none \| floppy \| dvd \| disk \| net</option></term>
1299	<listitem><para>
1300	Enables you to specify the boot device order for the VM by
1301	assigning one of the device types to each of the four boot
1302	device slots that are represented by
1303	<replaceable>N</replaceable> in the option name.
1304	</para><para>
1305	A value of 1 for <replaceable>N</replaceable> represents
1306	the first boot device slot, and so on.
1307	</para><para>
1308	The device types are <literal>floppy</literal> for floppy
1309	disks, <literal>dvd</literal> for DVDs or CDs,
1310	<literal>disk</literal> for hard disks, and
1311	<literal>net</literal> for a network device. A value of
1312	<literal>none</literal> indicates that no boot device is
1313	associated with the specified slot.
1314	</para></listitem>
1315	</varlistentry>
1316	<varlistentry>
1317	<term><option>--rtc-use-utc=on \| off</option></term>
1318	<listitem><para>
1319	Specifies whether the real-time clock (RTC) uses
1320	coordinated universal time (UTC). See
1321	<xref linkend="settings-motherboard" />.
1322	</para></listitem>
1323	</varlistentry>
1324	<varlistentry>
1325	<term><option>--graphicscontroller=none \| vboxvga \| vmsvga \| vboxsvga</option></term>
1326	<listitem><para>
1327	Specifies the graphics controller type to use. See
1328	<xref linkend="settings-screen" />.
1329	</para></listitem>
1330	</varlistentry>
1331	<varlistentry>
1332	<term><option>--snapshot-folder=default \| <replaceable>pathname</replaceable></option></term>
1333	<listitem><para>
1334	Specifies the name of the VM's snapshot storage folder. If
1335	you specify <literal>default</literal>, the folder name is
1336	<filename>Snapshots/</filename> in the machine folder.
1337	</para></listitem>
1338	</varlistentry>
1339	<varlistentry>
1340	<term><option>--firmware=bios \| efi \| efi32 \| efi64</option></term>
1341	<listitem><para>
1342	Specifies the firmware used to boot the VM. Valid values
1343	are: <literal>bios</literal>, <literal>efi</literal>,
1344	<literal>efi32</literal>, or <literal>efi64</literal>. Use
1345	EFI values with care.
1346	</para><para>
1347	By default, BIOS firmware is used.
1348	</para></listitem>
1349	</varlistentry>
1350	<varlistentry>
1351	<term><option>--guest-memory-balloon=<replaceable>size</replaceable></option></term>
1352	<listitem><para>
1353	Specifies the size of the guest memory balloon. The guest
1354	memory balloon is the memory allocated by the Guest
1355	Additions from the guest OS and returned to the hypervisor
1356	for use by other VMs. Specify
1357	<replaceable>size</replaceable> in megabytes. The default
1358	value is <literal>0</literal> megabytes. See
1359	<xref linkend="guestadd-balloon" />.
1360	</para></listitem>
1361	</varlistentry>
1362	<varlistentry>
1363	<term><option>--default-frontend=default \| <replaceable>name</replaceable></option></term>
1364	<listitem><para>
1365	Specifies the default frontend to use when starting the
1366	specified VM. If you specify <literal>default</literal>,
1367	the VM is shown in a window on the user's desktop. See
1368	<xref linkend="vboxmanage-startvm" />.
1369	</para></listitem>
1370	</varlistentry>
1371	<varlistentry>
1372	<term><option>--vm-process-priority=default \| flat \| low \| normal \| high</option></term>
1373	<listitem><para>
1374	Specifies the priority scheme of the VM process to use
1375	when starting the specified VM and while the VM runs.
1376	</para><para>
1377	The following valid values are:
1378	</para><itemizedlist>
1379	<listitem><para>
1380	<literal>default</literal> – Default process
1381	priority determined by the OS.
1382	</para></listitem>
1383	<listitem><para>
1384	<literal>flat</literal> – Assumes a scheduling
1385	policy which puts the process at the default priority
1386	and with all threads at the same priority.
1387	</para></listitem>
1388	<listitem><para>
1389	<literal>low</literal> – Assumes a scheduling
1390	policy which puts the process mostly below the default
1391	priority of the host OS.
1392	</para></listitem>
1393	<listitem><para>
1394	<literal>normal</literal> – Assume a scheduling
1395	policy which shares the CPU resources fairly with
1396	other processes running with the default priority of
1397	the host OS.
1398	</para></listitem>
1399	<listitem><para>
1400	<literal>high</literal> – Assumes a scheduling
1401	policy which puts the task above the default priority of
1402	the host OS. This policy might easily cause other tasks
1403	in the system to starve.
1404	</para></listitem>
1405	</itemizedlist></listitem>
1406	</varlistentry>
1407	</variablelist>
1408	</refsect2>
1409	<refsect2 id="vboxmanage-modifyvm-networking">
1410	<title>Networking Settings</title>
1411	<remark role="help-copy-synopsis"/>
1412	<para>
1413	The following options enable you to modify networking on your
1414	VM. With all these options, <replaceable>N</replaceable> is an
1415	integer greater than zero that represents the particular virtual
1416	network adapter to configure.
1417	</para>
1418	<variablelist>
1419	<varlistentry>
1420	<term><option>--nic<replaceable>N</replaceable>=none \| null \| nat \| natnetwork \| bridged \| intnet \| hostonly \| generic</option></term>
1421	<listitem><para>
1422	Configures the network type used by each virtual network
1423	card in the VM.
1424	</para><para>
1425	The following valid values correspond to the modes
1426	described in <xref linkend="networkingmodes" />:
1427	</para><itemizedlist>
1428	<listitem><para>
1429	<literal>none</literal> – No networking present
1430	</para></listitem>
1431	<listitem><para>
1432	<literal>null</literal> – Not connected to the
1433	host system
1434	</para></listitem>
1435	<listitem><para>
1436	<literal>nat</literal> – Use network address
1437	translation (NAT)
1438	</para></listitem>
1439	<listitem><para>
1440	<literal>natnetwork</literal> – Use a NAT
1441	network
1442	</para></listitem>
1443	<listitem><para>
1444	<literal>bridged</literal> – Use bridged
1445	networking
1446	</para></listitem>
1447	<listitem><para>
1448	<literal>intnet</literal> – Use internal
1449	networking
1450	</para></listitem>
1451	<listitem><para>
1452	<literal>hostonly</literal> – Use host-only
1453	networking
1454	</para></listitem>
1455	<listitem><para>
1456	<literal>generic</literal> – Access rarely used
1457	sub-modes
1458	</para></listitem>
1459	</itemizedlist></listitem>
1460	</varlistentry>
1461	<varlistentry>
1462	<term><option>--nic-type<replaceable>N</replaceable>=Am79C970A \| Am79C973 \| 82540EM \| 82543GC \| 82545EM \| virtio</option></term>
1463	<listitem><para>
1464	Identifies the type of networking hardware that
1465	&product-name; presents to the guest VM for the specified
1466	virtual network card. See <xref linkend="nichardware" />.
1467	</para><para>
1468	Valid values are as follows:
1469	</para><itemizedlist>
1470	<listitem><para>
1471	<literal>Am79C970A</literal> represents the AMD PCNet
1472	PCI II.
1473	</para></listitem>
1474	<listitem><para>
1475	<literal>Am79C973</literal> represents the AMD PCNet
1476	FAST III, which is the default value.
1477	</para></listitem>
1478	<listitem><para>
1479	<literal>82540EM</literal> represents the Intel
1480	PRO/1000 MT Desktop.
1481	</para></listitem>
1482	<listitem><para>
1483	<literal>82543GC</literal> represents the Intel
1484	PRO/1000 T Server.
1485	</para></listitem>
1486	<listitem><para>
1487	<literal>82545EM</literal> represents the Intel
1488	PRO/1000 MT Server.
1489	</para></listitem>
1490	<listitem><para>
1491	<literal>virtio</literal> represents a paravirtualized
1492	network adapter.
1493	</para></listitem>
1494	</itemizedlist></listitem>
1495	</varlistentry>
1496	<varlistentry>
1497	<term><option>--cable-connected<replaceable>N</replaceable>=on \| off</option></term>
1498	<listitem><para>
1499	Temporarily disconnects a virtual network interface, as if
1500	you pull a network cable from a physical network card. You
1501	might use this option to reset certain software components
1502	in the VM.
1503	</para></listitem>
1504	</varlistentry>
1505	<varlistentry>
1506	<term><option>--nic-trace<replaceable>N</replaceable>=on \| off</option></term>
1507	<listitem><para>
1508	Enables or disables network tracing for the specified
1509	virtual network card.
1510	</para></listitem>
1511	</varlistentry>
1512	<varlistentry>
1513	<term><option>--nic-trace-file<replaceable>N</replaceable>=<replaceable>filename</replaceable></option></term>
1514	<listitem><para>
1515	Specifies the absolute path of the file in which to write
1516	trace log information. Use this option if network tracing
1517	is enabled.
1518	</para></listitem>
1519	</varlistentry>
1520	<varlistentry>
1521	<term><option>--nic-property<replaceable>N</replaceable>=<replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
1522	<listitem><para>
1523	Enables you to set property values and pass them to rarely
1524	used network backends. To use this option, you must also
1525	use the <option>--nic-generic-drv</option> option.
1526	</para><para>
1527	These properties are specific to the backend engine and
1528	differ between the UDP Tunnel and the VDE backend drivers.
1529	For property examples, see
1530	<xref linkend="network_udp_tunnel" />.
1531	</para></listitem>
1532	</varlistentry>
1533	<varlistentry>
1534	<term><option>--nic-speed<replaceable>N</replaceable>=<replaceable>kbps</replaceable></option></term>
1535	<listitem><para>
1536	Specifies the throughput rate in kilobits per second for
1537	rarely used networking sub-modes such as VDE network and
1538	UDP Tunnel. Use this option only if you used the
1539	<option>--nic</option> option to enable generic networking
1540	for the specified virtual network card.
1541	</para></listitem>
1542	</varlistentry>
1543	<varlistentry>
1544	<term><option>--nic-boot-prio<replaceable>N</replaceable>=<replaceable>priority</replaceable></option></term>
1545	<listitem><para>
1546	Assigns a priority to each NIC that determines the order
1547	in which that NIC is used to perform a PXE network boot.
1548	The priority value is an integer in the range from
1549	<literal>0</literal> to <literal>4</literal>. Priority
1550	<literal>0</literal>, which is the default value, is the
1551	lowest priority. Priority <literal>1</literal> is the
1552	highest priority, and priorities <literal>3</literal> and
1553	<literal>4</literal> are lower.
1554	</para><para>
1555	This option has an effect only when using the Intel PXE
1556	boot ROM.
1557	</para></listitem>
1558	</varlistentry>
1559	<varlistentry>
1560	<term><option>--nic-promisc<replaceable>N</replaceable>=deny \| allow-vms \| allow-all</option></term>
1561	<listitem><para>
1562	Enables you to specify whether to deny or allow
1563	promiscuous mode for the specified VM virtual network
1564	card. This option is relevant only for bridged networking.
1565	Valid values are as follows:
1566	</para><itemizedlist>
1567	<listitem><para>
1568	<literal>deny</literal> hides any traffic that is not
1569	intended for the VM. This is the default value.
1570	</para></listitem>
1571	<listitem><para>
1572	<literal>allow-vms</literal> hides all host traffic
1573	from the VM, but allows the VM to see traffic to and
1574	from other VMs.
1575	</para></listitem>
1576	<listitem><para>
1577	<literal>allow-all</literal> allows the VM to see all
1578	traffic.
1579	</para></listitem>
1580	</itemizedlist></listitem>
1581	</varlistentry>
1582	<varlistentry>
1583	<term><option>--nic-bandwidth-group<replaceable>N</replaceable>=none \| <replaceable>name</replaceable></option></term>
1584	<listitem><para>
1585	Adds or removes a bandwidth group assignment to the
1586	specified virtual network interface. Valid values are as
1587	follows:
1588	</para><itemizedlist>
1589	<listitem><para>
1590	<literal>none</literal> removes any current bandwidth
1591	group assignment from the specified virtual network
1592	interface.
1593	</para></listitem>
1594	<listitem><para>
1595	<replaceable>name</replaceable> adds a bandwidth group
1596	assignment to the specified virtual network interface.
1597	</para></listitem>
1598	</itemizedlist><para>
1599	See <xref linkend="network_bandwidth_limit" />.
1600	</para></listitem>
1601	</varlistentry>
1602	<varlistentry>
1603	<term><option>--bridge-adapter<replaceable>N</replaceable>=none \| <replaceable>device-name</replaceable></option></term>
1604	<listitem><para>
1605	Specifies the host interface to use for the specified
1606	virtual network interface. See
1607	<xref linkend="network_bridged" />. Use this option only
1608	if you used the <option>--nic</option> option to enable
1609	bridged networking for the specified virtual network card.
1610	</para></listitem>
1611	</varlistentry>
1612	<varlistentry>
1613	<term><option>--host-only-adapter<replaceable>N</replaceable>=none \| <replaceable>device-name</replaceable></option></term>
1614	<listitem><para>
1615	Specifies which host-only networking interface to use for
1616	the specified virtual network interface. See
1617	<xref linkend="network_hostonly" />. Use this option only
1618	if you used the <option>--nic</option> option to enable
1619	host-only networking for the specified virtual network
1620	card.
1621	</para></listitem>
1622	</varlistentry>
1623	<varlistentry>
1624	<term><option>--intnet<replaceable>N</replaceable>=<replaceable>network-name</replaceable></option></term>
1625	<listitem><para>
1626	Specifies the name of the internal network. See
1627	<xref linkend="network_internal" />. Use this option only
1628	if you used the <option>--nic</option> option to enable
1629	internal networking for the specified virtual network
1630	card.
1631	</para></listitem>
1632	</varlistentry>
1633	<varlistentry>
1634	<term><option>--nat-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></option></term>
1635	<listitem><para>
1636	Specifies the name of the NAT network to which this
1637	adapter is connected. Use this option only if the
1638	networking type is <literal>natnetwork</literal>, not
1639	<literal>nat</literal>.
1640	</para></listitem>
1641	</varlistentry>
1642	<varlistentry>
1643	<term><option>--nic-generic-drv<replaceable>N</replaceable>=<replaceable>backend-driver</replaceable></option></term>
1644	<listitem><para>
1645	Enables you to access rarely used networking sub-modes,
1646	such as VDE networks and UDP Tunnel. Use this option only
1647	if you used the <option>--nic</option> option to enable
1648	generic networking for a virtual network card.
1649	</para></listitem>
1650	</varlistentry>
1651	<varlistentry>
1652	<term><option>--mac-address<replaceable>N</replaceable>=auto \| <replaceable>MAC-address</replaceable></option></term>
1653	<listitem><para>
1654	Specifies the MAC address of the specified network adapter
1655	on the VM. By default, &product-name; assigns a random MAC
1656	address to each network adapter at VM creation.
1657	</para></listitem>
1658	</varlistentry>
1659	</variablelist>
1660	</refsect2>
1661	<refsect2 id="vboxmanage-modifyvm-networking-nat">
1662	<title>NAT Networking Settings</title>
1663	<remark role="help-copy-synopsis"/>
1664	<para>
1665	The following options use <replaceable>N</replaceable> to
1666	specify the particular virtual network adapter to modify.
1667	</para>
1668	<variablelist>
1669	<varlistentry>
1670	<term><option>--nat-net<replaceable>N</replaceable>=default \| <replaceable>network</replaceable></option></term>
1671	<listitem><para>
1672	Specifies the IP address range to use for this network.
1673	See <xref linkend="changenat" />. Use this option only if
1674	the networking type is <literal>nat</literal>, not
1675	<literal>natnetwork</literal>.
1676	</para></listitem>
1677	</varlistentry>
1678	<varlistentry>
1679	<term><option>--nat-pf<replaceable>N</replaceable>=[<replaceable>name</replaceable>],tcp \| udp,[<replaceable>host-IP</replaceable>],<replaceable>hostport</replaceable>,[<replaceable>guest-IP</replaceable>],<replaceable>guestport</replaceable></option></term>
1680	<listitem><para>
1681	Specifies the NAT port-forwarding rule to use. See
1682	<xref linkend="natforward" />.
1683	</para></listitem>
1684	</varlistentry>
1685	<varlistentry>
1686	<term><option>--nat-pf<replaceable>N</replaceable>=delete <replaceable>name</replaceable></option></term>
1687	<listitem><para>
1688	Specifies the NAT port-forwarding rule to delete. See
1689	<xref linkend="natforward" />.
1690	</para></listitem>
1691	</varlistentry>
1692	<varlistentry>
1693	<term><option>--nat-tftp-prefix<replaceable>N</replaceable>=<replaceable>prefix</replaceable></option></term>
1694	<listitem><para>
1695	Specifies a prefix to use for the built-in TFTP server.
1696	For example, you might use a prefix to indicate where the
1697	boot file is located. See <xref linkend="nat-tftp" /> and
1698	<xref linkend="nat-adv-tftp" />.
1699	</para></listitem>
1700	</varlistentry>
1701	<varlistentry>
1702	<term><option>--nat-tftp-file<replaceable>N</replaceable>=<replaceable>boot-file</replaceable></option></term>
1703	<listitem><para>
1704	Specifies the name of the TFT boot file. See
1705	<xref linkend="nat-adv-tftp" />.
1706	</para></listitem>
1707	</varlistentry>
1708	<varlistentry>
1709	<term><option>--nat-tftp-server<replaceable>N</replaceable>=<replaceable>tftp-server</replaceable></option></term>
1710	<listitem><para>
1711	Specifies the address of the TFTP server from which to
1712	boot. See <xref linkend="nat-adv-tftp" />.
1713	</para></listitem>
1714	</varlistentry>
1715	<varlistentry>
1716	<term><option>--nat-bind-ip<replaceable>N</replaceable>=<replaceable>IP-address</replaceable></option></term>
1717	<listitem><para>
1718	Specifies an alternate IP address to which the NAT engine
1719	binds. See <xref linkend="nat-adv-settings" />. By
1720	default, &product-name;'s NAT engine routes TCP/IP packets
1721	through the default interface assigned by the host's
1722	TCP/IP stack.
1723	</para></listitem>
1724	</varlistentry>
1725	<varlistentry>
1726	<term><option>--nat-dns-pass-domain<replaceable>N</replaceable>=on \| off</option></term>
1727	<listitem><para>
1728	Specifies whether the built-in DHCP server passes the
1729	domain name for network name resolution.
1730	</para></listitem>
1731	</varlistentry>
1732	<varlistentry>
1733	<term><option>--nat-dns-proxy<replaceable>N</replaceable>=on \| off</option></term>
1734	<listitem><para>
1735	Specifies whether the NAT engine is the proxy for all
1736	guest DNS requests to the host system's DNS servers. See
1737	<xref linkend="nat-adv-dns" />.
1738	</para></listitem>
1739	</varlistentry>
1740	<varlistentry>
1741	<term><option>--nat-dns-host-resolver<replaceable>N</replaceable>=on \| off</option></term>
1742	<listitem><para>
1743	Specifies whether the NAT engine uses the host system's
1744	resolver mechanisms to handle DNS requests. See
1745	<xref linkend="nat-adv-dns" />.
1746	</para></listitem>
1747	</varlistentry>
1748	<varlistentry>
1749	<term><option>--nat-localhostreachable<replaceable>N</replaceable>=on \| off</option></term>
1750	<listitem><para>
1751	Specifies whether the NAT engine allows traffic from the guest directed to
1752	10.0.2.2 to pass to the host's loopback interface, i.e. localhost or 127.0.0.1.
1753	</para></listitem>
1754	</varlistentry>
1755	<varlistentry>
1756	<term><option>--nat-settings<replaceable>N</replaceable>=[<replaceable>mtu</replaceable>],[<replaceable>socksnd</replaceable>],[<replaceable>sockrcv</replaceable>],[<replaceable>tcpsnd</replaceable>],[<replaceable>tcprcv</replaceable>]</option></term>
1757	<listitem><para>
1758	Specifies values for tuning NAT performance. See
1759	<xref linkend="nat-adv-settings" />.
1760	</para></listitem>
1761	</varlistentry>
1762	<varlistentry>
1763	<term><option>--nat-alias-mode<replaceable>N</replaceable>=default \| [log],[proxyonly],[sameports]</option></term>
1764	<listitem><para>
1765	Specifies the behavior of the NAT engine core as follows:
1766	</para><itemizedlist>
1767	<listitem><para>
1768	<literal>log</literal> enables logging
1769	</para></listitem>
1770	<listitem><para>
1771	<literal>proxyonly</literal> switches off aliasing
1772	mode and makes NAT transparent
1773	</para></listitem>
1774	<listitem><para>
1775	<literal>sameports</literal> enforces that the NAT
1776	engine sends packets through the same port on which
1777	they originated
1778	</para></listitem>
1779	<listitem><para>
1780	<literal>default</literal> disables all aliasing modes
1781	</para></listitem>
1782	</itemizedlist><para>
1783	For more information, see
1784	<xref linkend="nat-adv-alias" />.
1785	</para></listitem>
1786	</varlistentry>
1787	</variablelist>
1788	</refsect2>
1789	<refsect2 id="vboxmanage-modifyvm-other-hardware">
1790	<title>Other Hardware Settings</title>
1791	<remark role="help-copy-synopsis"/>
1792	<para>
1793	The following options enable you to configure other hardware,
1794	such as the serial port, monitor, audio device, USB ports, and
1795	the clipboard, and drag-and-drop features.
1796	</para>
1797	<variablelist>
1798	<varlistentry>
1799	<term><option>--mouse=ps2 \| usb \| usbtablet \| usbmultitouch \| usbmtscreenpluspad</option></term>
1800	<listitem><para>
1801	Specifies the mode of the mouse to use in the VM. Valid
1802	values are: <literal>ps2</literal>,
1803	<literal>usb</literal>, <literal>usbtablet</literal>,
1804	<literal>usbmultitouch</literal> and
1805	<literal>usbmtscreenpluspad</literal>.
1806	</para></listitem>
1807	</varlistentry>
1808	<varlistentry>
1809	<term><option>--keyboard=ps2 \| usb</option></term>
1810	<listitem><para>
1811	Specifies the mode of the keyboard to use in the VM. Valid
1812	values are: <literal>ps2</literal> and
1813	<literal>usb</literal>.
1814	</para></listitem>
1815	</varlistentry>
1816	<varlistentry>
1817	<term><option>--uart<replaceable>N</replaceable>=off \| <replaceable>I/O-base</replaceable> <replaceable>IRQ</replaceable></option></term>
1818	<listitem><para>
1819	Configures virtual serial ports for the VM.
1820	<replaceable>N</replaceable> represents the serial port to
1821	modify. Valid values are <literal>off</literal> to disable
1822	the port or an I/O base address and IRQ. For information
1823	about the traditional COM port I/O base address and IRQ
1824	values, see <xref linkend="serialports" />.
1825	</para></listitem>
1826	</varlistentry>
1827	<varlistentry>
1828	<term><option>--uart-mode<replaceable>N</replaceable>=<replaceable>mode</replaceable></option></term>
1829	<listitem><para>
1830	Specifies how &product-name; connects the specified
1831	virtual serial port to the host system that runs the VM.
1832	See <xref linkend="serialports" />.
1833	</para><para>
1834	Ensure that you first configure the virtual serial port by
1835	using the
1836	<option>--uart<replaceable>N</replaceable></option>
1837	option.
1838	</para><para>
1839	Specify one of the following connection modes for each
1840	port:
1841	</para><itemizedlist>
1842	<listitem><para>
1843	<literal>disconnected</literal> indicates that even
1844	though the serial port is shown to the guest VM, it is
1845	not connected. This state is like a physical COM port
1846	without a cable attached.
1847	</para></listitem>
1848	<listitem><para>
1849	<literal>server</literal>
1850	<replaceable>pipe-name</replaceable> creates the
1851	specified named pipe or local domain socket on the
1852	host system and connects the virtual serial device to
1853	it.
1854	</para><para>
1855	On a Windows host system,
1856	<replaceable>pipe-name</replaceable> is a named pipe
1857	that has a name that uses the following form:
1858	<literal>\\.\pipe\<replaceable>pipe-name</replaceable></literal>.
1859	</para><para>
1860	On a Linux host system,
1861	<replaceable>pipe-name</replaceable> is a local domain
1862	socket.
1863	</para></listitem>
1864	<listitem><para>
1865	<literal>client</literal>
1866	<replaceable>pipe-name</replaceable> connects the
1867	virtual serial device to the specified named pipe or
1868	local domain socket.
1869	</para><para>
1870	Note that the named pipe or local domain socket must
1871	already exist.
1872	</para></listitem>
1873	<listitem><para>
1874	<literal>tcpserver</literal>
1875	<replaceable>port</replaceable> creates a TCP socket
1876	with the specified TCP port on the host system and
1877	connects the virtual serial device to it.
1878	</para><para>
1879	For UNIX-like systems, use ports over 1024 for
1880	non-root users.
1881	</para></listitem>
1882	<listitem><para>
1883	<literal>tcpclient</literal>
1884	<replaceable>hostname</replaceable>:<replaceable>port</replaceable>
1885	connects the virtual serial device to the TCP socket.
1886	</para><para>
1887	Note that the TCP socket must already exist.
1888	</para></listitem>
1889	<listitem><para>
1890	<literal>file</literal>
1891	<replaceable>filename</replaceable> redirects the
1892	serial port output to the specified raw file. Ensure
1893	that <replaceable>filename</replaceable> is the
1894	absolute path of the file on the host system.
1895	</para></listitem>
1896	<listitem><para>
1897	<replaceable>device-name</replaceable>: specifies the
1898	device name of a physical hardware serial port on the
1899	specified host system to which the virtual serial port
1900	connects.
1901	</para><para>
1902	Use this mode to connect a physical serial port to a
1903	VM.
1904	</para><para>
1905	On a Windows host system, the device name is a COM
1906	port such as <literal>COM1</literal>. On a Linux host
1907	system, the device name is similar to
1908	<filename>/dev/ttyS0</filename>.
1909	</para></listitem>
1910	</itemizedlist></listitem>
1911	</varlistentry>
1912	<varlistentry>
1913	<term><option>--uart-type<replaceable>N</replaceable>=<replaceable>UART-type</replaceable></option></term>
1914	<listitem><para>
1915	Configures the UART type for the specified virtual serial
1916	port (<replaceable>N</replaceable>). Valid values are
1917	<literal>16450</literal>, <literal>16550A</literal>, and
1918	<literal>16750</literal>. The default value is
1919	<literal>16550A</literal>.
1920	</para></listitem>
1921	</varlistentry>
1922	<varlistentry>
1923	<term><option>--lpt-mode<replaceable>N</replaceable>=<replaceable>device-name</replaceable></option></term>
1924	<listitem><para>
1925	Specifies the device name of the parallel port to use.
1926	</para><para>
1927	For a Windows host system, use a device name such as
1928	<command>lpt1</command>. For a Linux host system, use a
1929	device name such as <filename>/dev/lp0</filename>.
1930	</para></listitem>
1931	</varlistentry>
1932	<varlistentry>
1933	<term><option>--lpt<replaceable>N</replaceable>=<replaceable>I/O-base</replaceable> <replaceable>IRQ</replaceable></option></term>
1934	<listitem><para>
1935	Specifies the I/O base address and IRQ of the parallel
1936	port.
1937	</para><para>
1938	You can view the I/O base address and IRQ that the VM uses
1939	for the parallel port in the Device Manager.
1940	</para></listitem>
1941	</varlistentry>
1942	<varlistentry>
1943	<term><option>--audio-controller=<replaceable>controller-type</replaceable></option></term>
1944	<listitem><para>
1945	Specifies the audio controller to be used with the VM.
1946	Valid audio controller type values are:
1947	<literal>ac97</literal>, <literal>hda</literal>, and
1948	<literal>sb16</literal>.
1949	</para></listitem>
1950	</varlistentry>
1951	<varlistentry>
1952	<term><option>--audio-codec=<replaceable>codec-type</replaceable></option></term>
1953	<listitem><para>
1954	Specifies the audio codec to be used with the VM. Valid
1955	audio codec type values are: <literal>stac9700</literal>,
1956	<literal>ad1980</literal>, <literal>stac9221</literal>,
1957	and <literal>sb16</literal>.
1958	</para></listitem>
1959	</varlistentry>
1960	<varlistentry>
1961	<term><option>--audio-driver=<replaceable>type</replaceable></option></term>
1962	<listitem><para>
1963	Specifies whether which audio driver (backend) to use.
1964	<literal>none</literal>, <literal>default</literal>,
1965	<literal>null</literal>, <literal>dsound</literal>,
1966	<literal>was</literal>, <literal>oss</literal>,
1967	<literal>alsa</literal>, <literal>pulse</literal>, and
1968	<literal>coreaudio</literal>.
1969	</para><para>
1970	Note that the audio driver are dependent on the host
1971	operating system. Use the <command>VBoxManage
1972	modifyvm</command> command usage output to determine the
1973	supported audio types for your host system.
1974	</para>
1975	<para>
1976	For maximum interoperability between hosts, the default
1977	audio driver can be used. The VM will then automatically select
1978	the most appropriate audio driver for the current host available.
1979	</para></listitem>
1980	</varlistentry>
1981	<varlistentry>
1982	<term><option>--audio-enabled=on\|off</option></term>
1983	<listitem><para>
1984	Specifies whether to enable or disable audio for the VM.
1985	</para>
1986	<para>
1987	This option has precedence over the --audio-on and --audio-off
1988	options, i.e. turning off audio via this option will turn off
1989	both, input and output, audio.
1990	</para></listitem>
1991	</varlistentry>
1992	<varlistentry>
1993	<term><option>--audio-in=on\|off</option></term>
1994	<listitem><para>
1995	Specifies whether to enable or disable audio capture from
1996	the host system.
1997	</para></listitem>
1998	</varlistentry>
1999	<varlistentry>
2000	<term><option>--audio-out=on\|off</option></term>
2001	<listitem><para>
2002	Specifies whether to enable or disable audio playback from
2003	the guest VM.
2004	</para></listitem>
2005	</varlistentry>
2006	<varlistentry>
2007	<term><option>--clipboard-mode=<replaceable>value</replaceable></option></term>
2008	<listitem><para>
2009	Specifies how to share the guest VM or host system OS's
2010	clipboard with the host system or guest VM, respectively.
2011	Valid values are: <literal>disabled</literal>,
2012	<literal>hosttoguest</literal>,
2013	<literal>guesttohost</literal>, and
2014	<literal>bidirectional</literal>. See
2015	<xref linkend="generalsettings" />.
2016	</para><para>
2017	The clipboard feature is available only if you have the
2018	Guest Additions be installed in the VM.
2019	</para></listitem>
2020	</varlistentry>
2021	<varlistentry>
2022	<term><option>--clipboard-file-transfers=<replaceable>value</replaceable></option></term>
2023	<listitem><para>
2024	Specifies whether file transfers via clipboard between
2025	the guest VM and the host are enabled or not.
2026	Valid values are: <literal>disabled</literal>,
2027	<literal>enabled</literal>. Depends on the current
2028	clipboard mode being set.
2029	</para><para>
2030	This clipboard file transfer feature is available only if you have the
2031	Guest Additions be installed in the VM.
2032	</para></listitem>
2033	</varlistentry>
2034	<varlistentry>
2035	<term><option>--drag-and-drop=<replaceable>value</replaceable></option></term>
2036	<listitem><para>
2037	Specifies how to use the drag and drop feature between the
2038	host system and the VM. Valid values are:
2039	<literal>disabled</literal>,
2040	<literal>hosttoguest</literal>,
2041	<literal>guesttohost</literal>, and
2042	<literal>bidirectional</literal>. See
2043	<xref linkend="guestadd-dnd" />.
2044	</para><para>
2045	The drag and drop feature is available only if you have
2046	the Guest Additions be installed in the VM.
2047	</para></listitem>
2048	</varlistentry>
2049	<varlistentry>
2050	<term><option>--monitor-count=<replaceable>count</replaceable></option></term>
2051	<listitem><para>
2052	Enables you to configure multiple monitors. See
2053	<xref linkend="settings-display" />.
2054	</para></listitem>
2055	</varlistentry>
2056	<varlistentry>
2057	<term><option>--usb-ohci=on \| off</option></term>
2058	<listitem><para>
2059	Enables or disables the VM's virtual USB 1.1 controller.
2060	See <xref linkend="settings-usb" />.
2061	</para></listitem>
2062	</varlistentry>
2063	<varlistentry>
2064	<term><option>--usb-ehci=on \| off</option></term>
2065	<listitem><para>
2066	Enables or disables the VM's virtual USB 2.0 controller.
2067	See <xref linkend="settings-usb" />.
2068	</para></listitem>
2069	</varlistentry>
2070	<varlistentry>
2071	<term><option>--usb-xhci=on \| off</option></term>
2072	<listitem><para>
2073	Enables or disables the VM's virtual USB 3.0 controller.
2074	This is the most efficient option if the VM supports it.
2075	See <xref linkend="settings-usb" />.
2076	</para></listitem>
2077	</varlistentry>
2078	<varlistentry>
2079	<term><option>--usb-rename=<replaceable>old-name</replaceable> <replaceable>new-name</replaceable></option></term>
2080	<listitem><para>
2081	Rename's the VM's virtual USB controller from
2082	<replaceable>old-name</replaceable> to
2083	<replaceable>new-name</replaceable>.
2084	</para></listitem>
2085	</varlistentry>
2086	</variablelist>
2087	</refsect2>
2088	<refsect2 id="vboxmanage-modifyvm-recording">
2089	<title>Recording Settings</title>
2090	<remark role="help-copy-synopsis"/>
2091	<para>
2092	The following options enable you to modify settings for video
2093	recording, audio recording, or both.
2094	</para>
2095	<variablelist>
2096	<varlistentry>
2097	<term><option>--recording=on \| off</option></term>
2098	<listitem><para>
2099	Enables or disables the recording of a VM session into a
2100	WebM or VP8 file. When set to <literal>on</literal>,
2101	recording begins when the VM session starts.
2102	</para></listitem>
2103	</varlistentry>
2104	<varlistentry>
2105	<term><option>--recording-screens=all \| none \| <replaceable>screen-ID</replaceable>[,<replaceable>screen-ID</replaceable>...</option></term>
2106	<listitem><para>
2107	Enables you to specify the VM screens to record. The
2108	recording for each screen is output to its own file. Valid
2109	values are: <literal>all</literal>, which records all
2110	screens, <literal>none</literal>, which records no
2111	screens, or one or more specified screens.
2112	</para></listitem>
2113	</varlistentry>
2114	<varlistentry>
2115	<term><option>--recording-file=<replaceable>filename</replaceable></option></term>
2116	<listitem><para>
2117	Specifies the name of the file in which to save the
2118	recording.
2119	</para></listitem>
2120	</varlistentry>
2121	<varlistentry>
2122	<term><option>--recording-max-size=<replaceable>MB</replaceable></option></term>
2123	<listitem><para>
2124	Specifies the maximum size of the recorded video file in
2125	megabytes. When the file reaches the specified size,
2126	recording stops. If the value is <literal>0</literal>,
2127	recording continues until you manually stop recording.
2128	</para></listitem>
2129	</varlistentry>
2130	<varlistentry>
2131	<term><option>--recording-max-time=<replaceable>seconds</replaceable></option></term>
2132	<listitem><para>
2133	Specifies the maximum amount of time to record in seconds.
2134	When the specified time elapses, recording stops. If the
2135	value is <literal>0</literal>, recording continues until
2136	you manually stop recording.
2137	</para></listitem>
2138	</varlistentry>
2139	<varlistentry>
2140	<term><option>--recording-opts=<replaceable>keyword</replaceable>=<replaceable>value</replaceable></option></term>
2141	<listitem><para>
2142	Specifies additional video-recording properties as a
2143	comma-separated property keyword-value list. For example,
2144	<literal>foo=bar,a=b</literal>.
2145	</para><para>
2146	Only use this option if you are an advanced user. For
2147	information about keywords, see the <citetitle>Oracle VM
2148	VirtualBox Programming Guide and Reference</citetitle>.
2149	</para></listitem>
2150	</varlistentry>
2151	<varlistentry>
2152	<term><option>--recording-video-fps=<replaceable>fps</replaceable></option></term>
2153	<listitem><para>
2154	Specifies the maximum number of video frames per second
2155	(FPS) to record. The recording ignores any frames that
2156	have a higher frequency. When you increase the FPS, fewer
2157	frames are ignored but the recording and the size of the
2158	recording file increases.
2159	</para></listitem>
2160	</varlistentry>
2161	<varlistentry>
2162	<term><option>--recording-video-rate=<replaceable>bit-rate</replaceable></option></term>
2163	<listitem><para>
2164	Specifies the bit rate of the video in kilobits per
2165	second. When you increase the bit rate, the recording
2166	appearance improves and the size of the recording file
2167	increases.
2168	</para></listitem>
2169	</varlistentry>
2170	<varlistentry>
2171	<term><option>--recording-video-res=<replaceable>width</replaceable>x<replaceable>height</replaceable></option></term>
2172	<listitem><para>
2173	Specifies the video resolution (width and height) of the
2174	recorded video in pixels.
2175	</para></listitem>
2176	</varlistentry>
2177	</variablelist>
2178	</refsect2>
2179	<refsect2 id="vboxmanage-modifyvm-vrde">
2180	<title>Remote Machine Settings</title>
2181	<remark role="help-copy-synopsis"/>
2182	<para>
2183	The following options enable you to modify the VirtualBox Remote
2184	Desktop Extension (VRDE) behavior.
2185	</para>
2186	<variablelist>
2187	<varlistentry>
2188	<term><option>--vrde=on \| off</option></term>
2189	<listitem><para>
2190	Enables or disables the VRDE server.
2191	</para></listitem>
2192	</varlistentry>
2193	<varlistentry>
2194	<term><option>--vrde-property=TCP/Ports=<replaceable>port</replaceable></option></term>
2195	<listitem><para>
2196	<replaceable>port</replaceable> is the port or port range
2197	to which the VRDE server binds. The
2198	<literal>default</literal> or <literal>0</literal> value
2199	uses port <literal>3389</literal>, which is the standard
2200	RDP port.
2201	</para><para>
2202	Also see the <option>--vrde-port</option> option
2203	description.
2204	</para></listitem>
2205	</varlistentry>
2206	<varlistentry>
2207	<term><option>--vrde-property=TCP/Address=<replaceable>IP-address</replaceable></option></term>
2208	<listitem><para>
2209	<replaceable>IP-address</replaceable> is the IP address of
2210	the host network interface to which the VRDE server binds.
2211	When specified, the server accepts connections only on the
2212	host network interface at that IP address.
2213	</para><para>
2214	Also see the <option>--vrde-address</option> option
2215	description.
2216	</para></listitem>
2217	</varlistentry>
2218	<varlistentry>
2219	<term><option>--vrde-property=VideoChannel/Enabled=<replaceable>value</replaceable></option></term>
2220	<listitem><para>
2221	Specifies whether the VRDP video channel is on or off.
2222	<literal>1</literal> means <literal>on</literal> and
2223	<literal>0</literal> means <literal>off</literal>. See
2224	<xref linkend="vrde-videochannel" />.
2225	</para></listitem>
2226	</varlistentry>
2227	<varlistentry>
2228	<term><option>--vrde-property=Quality=<replaceable>value</replaceable></option></term>
2229	<listitem><para>
2230	Specifies a value between 10% and 100%, inclusive, that
2231	represents the JPEG compression level on the VRDE server
2232	video channel. A lower value produces lower JPEG quality
2233	but higher compression. See
2234	<xref linkend="vrde-videochannel" />.
2235	</para></listitem>
2236	</varlistentry>
2237	<varlistentry>
2238	<term><option>--vrde-property=DownscaleProtection=<replaceable>value</replaceable></option></term>
2239	<listitem><para>
2240	Enables or disables the video downscale protection
2241	feature. Valid values are <literal>1</literal> to enable
2242	the feature and <literal>0</literal> to disable the
2243	feature.
2244	</para><para>
2245	When this feature is enabled, &product-name; determines
2246	whether to display the video:
2247	</para><itemizedlist>
2248	<listitem><para>
2249	When the video size equals the size of the shadow
2250	buffer, the video is considered to be full screen and
2251	is displayed.
2252	</para></listitem>
2253	<listitem><para>
2254	When the video size is between full screen and the
2255	downscale threshold, the video is not displayed. Such
2256	a video might be an application window, which is
2257	unreadable when downscaled.
2258	</para></listitem>
2259	</itemizedlist><para>
2260	When this feature is disabled, an attempt is always made
2261	to display a video.
2262	</para></listitem>
2263	</varlistentry>
2264	<varlistentry>
2265	<term><option>--vrde-property=Client/DisableDisplay=1</option></term>
2266	<listitem><para>
2267	Disables the display VRDE server feature.
2268	</para><para>
2269	To reenable a feature, assign an empty value. For example,
2270	to reenable the display feature, specify the
2271	<command>VBoxManage modifyvm
2272	--vrde-property=Client/DisableDisplay=</command> command.
2273	See <xref linkend="vrde-customization" />.
2274	</para></listitem>
2275	</varlistentry>
2276	<varlistentry>
2277	<term><option>--vrde-property=DisableInput=1</option></term>
2278	<listitem><para>
2279	Disables the input VRDE server feature.
2280	</para></listitem>
2281	</varlistentry>
2282	<varlistentry>
2283	<term><option>--vrde-property=DisableAudio=1</option></term>
2284	<listitem><para>
2285	Disables the audio VRDE server feature.
2286	</para></listitem>
2287	</varlistentry>
2288	<varlistentry>
2289	<term><option>--vrde-property=DisableUSB=1</option></term>
2290	<listitem><para>
2291	Disables the USB VRDE server feature.
2292	</para></listitem>
2293	</varlistentry>
2294	<varlistentry>
2295	<term><option>--vrde-property=Client/DisableClipboard=1</option></term>
2296	<listitem><para>
2297	Disables the clipboard VRDE server feature. To reenable
2298	the feature, assign an empty value. See
2299	<xref linkend="vrde-customization" />.
2300	</para></listitem>
2301	</varlistentry>
2302	<varlistentry>
2303	<term><option>--vrde-property=DisableUpstreamAudio=1</option></term>
2304	<listitem><para>
2305	Disables the upstream audio VRDE server feature. To
2306	reenable the feature, assign an empty value. See
2307	<xref linkend="vrde-customization" />.
2308	</para></listitem>
2309	</varlistentry>
2310	<varlistentry>
2311	<term><option>--vrde-property=Client/DisableRDPDR=1</option></term>
2312	<listitem><para>
2313	Disables the RDP device redirection for smart cards VRDE
2314	server feature. To reenable this feature, assign an empty
2315	value.
2316	</para></listitem>
2317	</varlistentry>
2318	<varlistentry>
2319	<term><option>--vrde-property=H3DRedirect/Enabled=1</option></term>
2320	<listitem><para>
2321	Enables the 3D redirection VRDE server feature. To disable
2322	this feature, assign an empty value.
2323	</para></listitem>
2324	</varlistentry>
2325	<varlistentry>
2326	<term><option>--vrde-property=Security/Method=<replaceable>value</replaceable></option></term>
2327	<listitem><para>
2328	Specifies the following information that is required for a
2329	connection:
2330	</para><itemizedlist>
2331	<listitem><para>
2332	<literal>Negotiate</literal> indicates that both
2333	Enhanced (TLS) and Standard RDP Security connections
2334	are permitted. The security method is negotiated with
2335	the client. This is the default value.
2336	</para></listitem>
2337	<listitem><para>
2338	<literal>RDP</literal> indicates that only Standard
2339	RDP Security is accepted.
2340	</para></listitem>
2341	<listitem><para>
2342	<literal>TLS</literal> indicates that only Enhanced
2343	RDP Security is accepted. The client must support TLS.
2344	</para></listitem>
2345	</itemizedlist><para>
2346	See <xref linkend="vrde-crypt" />.
2347	</para></listitem>
2348	</varlistentry>
2349	<varlistentry>
2350	<term><option>--vrde-property=ServerCertificate=<replaceable>value</replaceable></option></term>
2351	<listitem><para>
2352	Specifies the absolute path to the server certificate. See
2353	<xref linkend="vrde-crypt" />.
2354	</para></listitem>
2355	</varlistentry>
2356	<varlistentry>
2357	<term><option>--vrde-property=ServerPrivateKey=<replaceable>value</replaceable></option></term>
2358	<listitem><para>
2359	Specifies the absolute path to the server private key. See
2360	<xref linkend="vrde-crypt" />.
2361	</para></listitem>
2362	</varlistentry>
2363	<varlistentry>
2364	<term><option>--vrde-property=CACertificate=<replaceable>value</replaceable></option></term>
2365	<listitem><para>
2366	Specifies the absolute path to the CA self-signed
2367	certificate. See <xref linkend="vrde-crypt" />.
2368	</para></listitem>
2369	</varlistentry>
2370	<varlistentry>
2371	<term><option>--vrde-property Audio/RateCorrectionMode=<replaceable>value</replaceable></option></term>
2372	<listitem><para>
2373	Specifies the audio connection mode or the path to the
2374	audio log file. Valid values are as follows:
2375	</para><itemizedlist>
2376	<listitem><para>
2377	<literal>VRDP_AUDIO_MODE_VOID</literal> is no mode.
2378	Use this value to unset any set audio mode.
2379	</para></listitem>
2380	<listitem><para>
2381	<literal>VRDP_AUDIO_MODE_RC</literal> is the rate
2382	correction mode.
2383	</para></listitem>
2384	<listitem><para>
2385	<literal>VRDP_AUDIO_MODE_LPF</literal> is the low pass
2386	filter mode.
2387	</para></listitem>
2388	<listitem><para>
2389	<literal>VRDP_AUDIO_MODE_CS</literal> is the client
2390	sync sync mode to prevent an underflow or overflow of
2391	the client queue.
2392	</para></listitem>
2393	</itemizedlist></listitem>
2394	</varlistentry>
2395	<varlistentry>
2396	<term><option>--vrde-property=LogPath=<replaceable>value</replaceable></option></term>
2397	<listitem><para>
2398	Specifies the absolute path to the audio log file.
2399	</para></listitem>
2400	</varlistentry>
2401	<varlistentry>
2402	<term><option>--vrde-extpack=default \| <replaceable>name</replaceable></option></term>
2403	<listitem><para>
2404	Specifies the library to use to access the VM remotely.
2405	The <literal>default</literal> value uses the RDP code
2406	that is part of the &product-name; Extension Pack.
2407	</para><para>
2408	To use the VRDE module in VNC, specify
2409	<literal>VNC</literal>. See
2410	<xref linkend="otherextpacks"/>.
2411	</para></listitem>
2412	</varlistentry>
2413	<varlistentry>
2414	<term><option>--vrde-port=default \| <replaceable>port</replaceable></option></term>
2415	<listitem><para>
2416	<replaceable>port</replaceable> is the port or port range
2417	to which the VRDE server binds. The
2418	<literal>default</literal> or <literal>0</literal> value
2419	uses port <literal>3389</literal>, which is the standard
2420	RDP port.
2421	</para><para>
2422	You can specify a comma-separated list of ports or port
2423	ranges of ports. Use a dash between two port numbers to
2424	specify a port range. The VRDE server binds to only one of
2425	the available ports from the list. Only one machine can
2426	use a given port at a time. For example, the
2427	<option>--vrde-port=5000,5010-5012</option> option
2428	specifies that server can bind to one of following ports:
2429	<literal>5000</literal>, <literal>5010</literal>,
2430	<literal>5011</literal>, or <literal>5012</literal>.
2431	</para></listitem>
2432	</varlistentry>
2433	<varlistentry>
2434	<term><option>--vrde-address=<replaceable>IP-address</replaceable></option></term>
2435	<listitem><para>
2436	Specifies the IP address of the host network interface to
2437	which the VRDE server binds. If you specify an IP address,
2438	the server accepts connections only on the specified host
2439	network interface.
2440	</para><para>
2441	Use this option to specify whether the VRDP server should
2442	accept IPv4, IPv6, or both type of connections:
2443	</para><itemizedlist>
2444	<listitem><para>
2445	<emphasis role="bold">Only IPv4:</emphasis> Use the
2446	<option>--vrde-address="0.0.0.0"</option> option.
2447	</para></listitem>
2448	<listitem><para>
2449	<emphasis role="bold">Only IPv6:</emphasis> Use the
2450	<option>--vrde-address="::"</option> option.
2451	</para></listitem>
2452	<listitem><para>
2453	<emphasis role="bold">Both IPv6 and IPv4:</emphasis>
2454	Use the <option>--vrde-address=""</option>
2455	option. This is the default value.
2456	</para></listitem>
2457	</itemizedlist></listitem>
2458	</varlistentry>
2459	<varlistentry>
2460	<term><option>--vrde-auth-type=null \| external \| guest</option></term>
2461	<listitem><para>
2462	Specify whether to use authorization and how to perform
2463	authorization. See <xref linkend="vbox-auth" />. Valid
2464	values are as follows:
2465	</para><itemizedlist>
2466	<listitem><para>
2467	<literal>null</literal> provides no authentication.
2468	</para></listitem>
2469	<listitem><para>
2470	<literal>external</literal> provides external
2471	authentication through an authentication library.
2472	</para></listitem>
2473	<listitem><para>
2474	<literal>guest</literal> performs authentication by
2475	using guest user accounts. This unsupported method
2476	requires that you install the Guest Additions on the
2477	VM.
2478	</para></listitem>
2479	</itemizedlist></listitem>
2480	</varlistentry>
2481	<varlistentry>
2482	<term><option>--vrde-auth-library=default \| <replaceable>name</replaceable></option></term>
2483	<listitem><para>
2484	Specifies the library to use for RDP authentication. The
2485	default library for external authentication is
2486	<filename>VBoxAuth</filename>. See
2487	<xref linkend="vbox-auth" />.
2488	</para></listitem>
2489	</varlistentry>
2490	<varlistentry>
2491	<term><option>--vrde-multi-con=on \| off</option></term>
2492	<listitem><para>
2493	Enables or disables the multiple connections VRDE server
2494	feature, if supported. See
2495	<xref linkend="vrde-multiconnection" />.
2496	</para></listitem>
2497	</varlistentry>
2498	<varlistentry>
2499	<term><option>--vrde-reuse-con=on \| off</option></term>
2500	<listitem><para>
2501	Specifies how the VRDE server behaves when multiple
2502	connections are disabled. When the value is
2503	<literal>on</literal>, the server permits a new client to
2504	connect and drops the existing connection. When the value
2505	is <literal>off</literal>, a new connection is not
2506	accepted if a client is already connected to the server.
2507	This is the default value.
2508	</para></listitem>
2509	</varlistentry>
2510	<varlistentry>
2511	<term><option>--vrde-video-channel=on \| off</option></term>
2512	<listitem><para>
2513	Enables video redirection if supported by the VRDE server.
2514	See <xref linkend="vrde-videochannel" />.
2515	</para></listitem>
2516	</varlistentry>
2517	<varlistentry>
2518	<term><option>--vrde-video-channel-quality=<replaceable>percent</replaceable></option></term>
2519	<listitem><para>
2520	Specifies the image quality for video redirection as a
2521	value from 10 to 100 percent. The percentage represents
2522	the JPEG compression level where a lower number diminishes
2523	quality and provides higher compression. See
2524	<xref linkend="vrde-videochannel" />.
2525	</para></listitem>
2526	</varlistentry>
2527	</variablelist>
2528	</refsect2>
2529	<refsect2 id="vboxmanage-modifyvm-teleport">
2530	<title>Teleporting Settings</title>
2531	<remark role="help-copy-synopsis"/>
2532	<para>
2533	The following options enable you to configure a machine as a
2534	teleporting target. See <xref linkend="teleporting" /> and the
2535	teleporting related entries in <xref linkend="pot-insecure" />.
2536	</para>
2537	<variablelist>
2538	<varlistentry>
2539	<term><option>--teleporter=on \| off</option></term>
2540	<listitem><para>
2541	Enables or disables the teleporter. When enabled, a
2542	machine starts up and waits to receive a teleporting
2543	request from the network instead of booting normally.
2544	</para><para>
2545	Teleporting requests are received on the port and address
2546	specified using the following parameters.
2547	</para></listitem>
2548	</varlistentry>
2549	<varlistentry>
2550	<term><option>--teleporter-port=<replaceable>port</replaceable></option></term>
2551	<listitem><para>
2552	Specifies the port on which the VM listens to receive a
2553	teleporting request from another VM.
2554	<replaceable>port</replaceable> is any free TCP/IP port
2555	number, such as <literal>6000</literal>. You must also
2556	specify the <option>--teleporter</option> option.
2557	</para></listitem>
2558	</varlistentry>
2559	<varlistentry>
2560	<term><option>--teleporter-address=<replaceable>IP-address</replaceable></option></term>
2561	<listitem><para>
2562	Specifies the IP address on which the VM listens to
2563	receive a teleporting request from another VM.
2564	<replaceable>IP-address</replaceable> is any IP address or
2565	host name and specifies the TCP/IP socket on which to
2566	bind. The default IP address is
2567	<literal>0.0.0.0</literal>, which represents any IP
2568	address. You must also specify the
2569	<option>--teleporter</option> option.
2570	</para></listitem>
2571	</varlistentry>
2572	<varlistentry>
2573	<term><option>--teleporter-password=<replaceable>password</replaceable></option></term>
2574	<listitem><para>
2575	Specifies the password to use for authentication. When
2576	specified, the teleporting request only succeeds if the
2577	password on the source machine is the same password as the
2578	one you specify.
2579	</para></listitem>
2580	</varlistentry>
2581	<varlistentry>
2582	<term><option>--teleporter-password-file=<replaceable>filename</replaceable></option></term>
2583	<listitem><para>
2584	Specifies a file that contains the password to use for
2585	authentication. When specified, the teleporting request
2586	only succeeds if the password on the source machine is the
2587	same password as the one you specify in the password file.
2588	A value of <literal>stdin</literal> reads the password
2589	from standard input.
2590	</para></listitem>
2591	</varlistentry>
2592	<varlistentry>
2593	<term><option>--cpuid-portability-level=<replaceable>level</replaceable></option></term>
2594	<listitem>
2595	<para>
2596	Restricts the virtual CPU capabilities that &product-name;
2597	presents to the guest OS by using portability rules. Higher
2598	integer values designate more restrictive behavior. The
2599	default level of <literal>0</literal> indicates that all
2600	virtualized features supported by the host are made available
2601	to the guest. The value <literal>3</literal> supresses most
2602	features. Values of <literal>1</literal> and <literal>2</literal>
2603	represent restrictions in between. The behavior may change
2604	depending on the product version.
2605	</para></listitem>
2606	</varlistentry>
2607	<varlistentry>
2608	<term><option>--cpuid-set=<replaceable>leaf</replaceable>[:<replaceable>subleaf</replaceable>]
2609	<replaceable>eax</replaceable> <replaceable>ebx</replaceable> <replaceable>ecx</replaceable> <replaceable>edx</replaceable></option></term>
2610	<listitem>
2611	<para>
2612	Advanced users can use this setting before a teleporting
2613	operation (in fact before starting the VM) to restrict the
2614	virtual CPU capabilities that &product-name; presents to
2615	the guest operating system. This must be run on both the
2616	source and the target machines involved in teleporting and
2617	will then modify what the guest sees when it executes the
2618	CPUID machine instruction. This might help with misbehaving
2619	applications that wrongly assume that certain CPU
2620	capabilities are present. The meaning of the parameters
2621	is hardware dependent. Refer to the AMD or Intel processor
2622	documentation.
2623	</para><para>
2624	The values of <replaceable>leaf</replaceable>,
2625	<replaceable>subleaf</replaceable> (optional),
2626	<replaceable>eax</replaceable>, <replaceable>ebx</replaceable>,
2627	<replaceable>ecx</replaceable> and <replaceable>edx</replaceable>
2628	are integers given in hexadecimal format, i.e. using a radix
2629	(base) of 16 without requiring any prefix.
2630	</para></listitem>
2631	</varlistentry>
2632	<varlistentry>
2633	<term><option>--cpuid-remove=<replaceable>leaf</replaceable>[:<replaceable>subleaf</replaceable>]</option></term>
2634	<listitem>
2635	<para>
2636	Removes an adjustment established with <option>--cpuid-set</option>.
2637	</para></listitem>
2638	</varlistentry>
2639	<varlistentry>
2640	<term><option>--cpuid-remove-all</option></term>
2641	<listitem>
2642	<para>
2643	Removes all adjustments established with <option>--cpuid-set</option>.
2644	</para></listitem>
2645	</varlistentry>
2646	</variablelist>
2647	</refsect2>
2648	<refsect2 id="vboxmanage-modifyvm-debugging">
2649	<title>Debugging Settings</title>
2650	<remark role="help-copy-synopsis"/>
2651	<para>
2652	Only use the following options to perform low-level VM
2653	debugging. These options are for advanced users only.
2654	</para>
2655	<variablelist>
2656	<varlistentry>
2657	<term><option>--tracing-enabled=on \| off</option></term>
2658	<listitem><para>
2659	Enables or disables the trace buffer. Note that when
2660	specified, the trace buffer consumes some memory and adds
2661	overhead.
2662	</para></listitem>
2663	</varlistentry>
2664	<varlistentry>
2665	<term><option>--tracing-config=<replaceable>config-string</replaceable></option></term>
2666	<listitem><para>
2667	Enables a tracing configuration that defines which group
2668	of trace points are enabled.
2669	</para></listitem>
2670	</varlistentry>
2671	<varlistentry>
2672	<term><option>--tracing-allow-vm-access=on \| off</option></term>
2673	<listitem><para>
2674	Enables or disables VM access to the trace buffer. The
2675	default value is <literal>off</literal>, which disables
2676	access.
2677	</para></listitem>
2678	</varlistentry>
2679	</variablelist>
2680	</refsect2>
2681	<refsect2 id="vboxmanage-modifyvm-usbcardreader">
2682	<title>USB Card Reader Settings</title>
2683	<remark role="help-copy-synopsis"/>
2684	<para>
2685	The following options specify the access to a USB Card Reader by
2686	the guest environment. A USB card reader can access data on
2687	memory cards, such as CompactFlash (CF), Secure Digital (SD),
2688	and MultiMediaCard (MMC).
2689	</para>
2690	<variablelist>
2691	<varlistentry>
2692	<term><option>--usb-card-reader=on \| off</option></term>
2693	<listitem><para>
2694	Enables or disables the USB card reader interface.
2695	</para></listitem>
2696	</varlistentry>
2697	</variablelist>
2698	</refsect2>
2699	<refsect2 id="vboxmanage-modifyvm-autostart">
2700	<title>Autostarting VMs During Host System Boot</title>
2701	<para>
2702	The following options enable you to configure the VM autostart
2703	feature, which automatically starts the VM at host system
2704	boot-up. You must do some host system configuration before you
2705	can use this feature. See <xref linkend="autostart" />.
2706	</para>
2707	<remark role="help-copy-synopsis"/>
2708	<variablelist>
2709	<varlistentry>
2710	<term><option>--autostart-enabled=on \| off</option></term>
2711	<listitem><para>
2712	Enables or disables VM autostart at host system boot-up
2713	for the specified users.
2714	</para></listitem>
2715	</varlistentry>
2716	<varlistentry>
2717	<term><option>--autostart-delay=<replaceable>seconds</replaceable></option></term>
2718	<listitem><para>
2719	Specifies the number of seconds after host system boot-up
2720	to autostart the VM.
2721	</para></listitem>
2722	</varlistentry>
2723	</variablelist>
2724	</refsect2>
2725	<refsect2 id="vboxmanage-modifyvm-guest-debug">
2726	<title>Guest Debugging</title>
2727	<para>
2728	These options are for configuring the VMM for guest debugging.
2729	</para>
2730	<remark role="help-copy-synopsis"/>
2731	<variablelist>
2732	<varlistentry>
2733	<term><option>--guest-debug-provider=none \| native \| gdb \| kd</option></term>
2734	<listitem><para>Selects the given debug stub provider. </para></listitem>
2735	</varlistentry>
2736	<varlistentry>
2737	<term><option>--guest-debug-io-provider=none \| tcp \| udp \| ipc</option></term>
2738	<listitem><para>Selects the given I/O transport backend for the selected provider.</para></listitem>
2739	</varlistentry>
2740	<varlistentry>
2741	<term><option>--guest-debug-address=<replaceable>IP-Address</replaceable> \| <replaceable>path</replaceable></option></term>
2742	<listitem><para>Sets the path the debugger is accessible under, depends on the selected I/O transport.</para></listitem>
2743	</varlistentry>
2744	<varlistentry>
2745	<term><option>--guest-debug-port=<replaceable>port</replaceable></option></term>
2746	<listitem><para>Sets the port the debugger is accessible under, depends on the selected I/O transport.</para></listitem>
2747	</varlistentry>
2748	</variablelist>
2749	</refsect2>
2750	<refsect2 id="vboxmanage-modifyvm-pcipassthrough">
2751	<title>PCI Passthrough Settings</title>
2752	<para>
2753	The following options enable you to configure the PCI passthrough
2754	feature, which currently is not available in &product-name;. It is
2755	planned to bring this functionality back in the future.
2756	</para>
2757	<remark role="help-copy-synopsis"/>
2758	<variablelist>
2759	<varlistentry>
2760	<term><option>--pci-attach=<replaceable>host-PCI-address</replaceable>[@<replaceable>guest-PCI-bus-address</replaceable>]</option></term>
2761	<listitem><para>
2762	Attaches the specified PCI network controller on the host
2763	to the guest VM. You can optionally specify the PCI bus on
2764	the guest VM on which to attach the controller.
2765	<!-- See <xref linkend="pcipassthrough" />. -->
2766	</para></listitem>
2767	</varlistentry>
2768	<varlistentry>
2769	<term><option>--pci-detach=<replaceable>host-PCI-address</replaceable></option></term>
2770	<listitem><para>
2771	Detaches the specified PCI network controller from the
2772	attached PCI bus on the guest VM.
2773	<!-- See <xref linkend="pcipassthrough" />. -->
2774	</para></listitem>
2775	</varlistentry>
2776	</variablelist>
2777	</refsect2>
2778	<refsect2 id="vboxmanage-modifyvm-testing">
2779	<title>Testing (ValidationKit / Bootsector)</title>
2780	<para>
2781	These options are for configuring the testing functionality of the VMM
2782	device and almost exclusively used by the bootsector testcases in the
2783	ValidationKit.
2784	</para>
2785	<remark role="help-copy-synopsis"/>
2786	<variablelist>
2787	<varlistentry>
2788	<term><option>--testing-enabled=on \| off</option></term>
2789	<listitem><para>Enabled the testing functionality of the VMMDev. See VMMDevTesting.h for details. </para></listitem>
2790	</varlistentry>
2791	<varlistentry>
2792	<term><option>--testing-mmio=on \| off</option></term>
2793	<listitem><para>Enabled the MMIO region of the VMMDev testing feature.</para></listitem>
2794	</varlistentry>
2795	<varlistentry>
2796	<term><option>--testing-cfg-dword<replaceable>idx</replaceable>=<replaceable>value</replaceable></option></term>
2797	<listitem><para>
2798	This sets one of the 10 dword configuration values. The
2799	<replaceable>idx</replaceable> must be in the range 0 thru 9.
2800	The <replaceable>value</replaceable> is limited to 32 bits (dword).
2801	</para></listitem>
2802	</varlistentry>
2803	</variablelist>
2804	</refsect2>
2805
2806	</refsect1>
2807
2808	<refsect1 id="vboxmanage-modifyvm-examples">
2809	<title>Examples</title>
2810	<remark role="help-scope" condition="GLOBAL" />
2811	<para>
2812	The following command changes the description for the
2813	<filename>ol7</filename> VM.
2814	</para>
2815	<screen>$ VBoxManage modifyvm ol7 --description "Oracle Linux 7 with UEK4"</screen>
2816	<para>
2817	The following command enables VirtualBox Remote Display Protocol
2818	(VRDP) support for the <filename>ol7</filename> VM.
2819	</para>
2820	<screen>$ VBoxManage modifyvm ol7 --vrde on</screen>
2821	</refsect1>
2822
2823	<refsect1 id="vboxmanage-modifyvm-see-also">
2824	<title>See Also</title>
2825	<para>
2826	<xref linkend="vboxmanage-showvminfo" />,
2827	<xref linkend="vboxmanage-controlvm" />,
2828	<xref linkend="vboxmanage-createvm" />,
2829	<xref linkend="vboxmanage-startvm" />
2830	<xref linkend="vboxmanage-list" />
2831	</para>
2832	</refsect1>
2833	</refentry>

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

source: vbox/trunk/doc/manual/en_US/man_VBoxManage-modifyvm.xml@ 102792

Download in other formats: