man_VBoxManage-modifyvm.xml@ 108883

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

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

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

Download in other formats: