man_VBoxManage-modifyvm.xml@ 87049

Last change on this file since 87049 was 82969, checked in by vboxsync, 5 years ago
Copyright year updates - manual ones.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 114.1 KB

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

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

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

Download in other formats: