man_VBoxManage-modifyvm.xml@ 107861

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

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

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

Download in other formats: