man_VBoxManage-modifyvm.xml@ 82044

最後變更在這個檔案從82044是 82044,由 vboxsync 提交於 5 年前
doc/manual: Add all new manpages (the new VBoxManage ones are not yet used, it needs reviewing and proper integrating), and integrate the one for VBoxManage and vboximg-mount.
屬性 svn:eol-style 設為 `native` 屬性 svn:keywords 設為 `Author Date Id Revision`
檔案大小: 113.5 KB

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

注意: 瀏覽 TracBrowser 來幫助您使用儲存庫瀏覽器

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

以其他格式下載: