man_VBoxManage-modifyvm.xml@ 109119

Last change on this file since 109119 was 108973, checked in by vboxsync, 4 weeks ago
Main: bugref:10877 Add GIC ITS setting to the VM configuration and API.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 130.1 KB

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

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

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

Download in other formats: