man_VBoxManage-modifyvm.xml@ 107760

Last change on this file since 107760 was 107267, checked in by vboxsync, 2 months ago
Main/API,UI: bugref:10810 Based on Brent's patch, added UsbNet support into Main API and UI
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 132.1 KB

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

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

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

Download in other formats: