man_VBoxManage-modifyvm.xml@ 99959

Last change on this file since 99959 was 99959, checked in by vboxsync, 20 months ago
Shared Clipboard/VBoxManage: Docs. bugref:9437
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 131.3 KB

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

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

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

Download in other formats: