VirtualBox

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

Last change on this file since 105893 was 105893, checked in by vboxsync, 3 months ago

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette