[82044] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
| 2 | <!--
|
---|
[87075] | 3 | manpage, user manual, usage: VBoxManage modifyvm
|
---|
[96300] | 4 | -->
|
---|
| 5 | <!--
|
---|
[98103] | 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
[82044] | 7 |
|
---|
[96407] | 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
|
---|
[96300] | 25 | -->
|
---|
[82044] | 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>
|
---|
[91204] | 33 | <pubdate>$Date: 2024-02-19 15:27:46 +0000 (Mon, 19 Feb 2024) $</pubdate>
|
---|
[82044] | 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>
|
---|
[93707] | 45 | <refclass>&product-name;</refclass>
|
---|
[82044] | 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>
|
---|
[99119] | 57 | <arg>--groups=<replaceable>group</replaceable><arg rep="repeat">,<replaceable>group</replaceable></arg></arg>
|
---|
[82044] | 58 | <arg>--description=<replaceable>description</replaceable></arg>
|
---|
[92534] | 59 | <arg>--os-type=<replaceable>OS-type</replaceable></arg>
|
---|
| 60 | <arg>--icon-file=<replaceable>filename</replaceable></arg>
|
---|
[82044] | 61 | <arg>--memory=<replaceable>size-in-MB</replaceable></arg>
|
---|
[92534] | 62 | <arg>--page-fusion=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 75 | <arg>--hardware-uuid=<replaceable>UUID</replaceable></arg>
|
---|
[82044] | 76 | <arg>--cpus=<replaceable>CPU-count</replaceable></arg>
|
---|
[92534] | 77 | <arg>--cpu-hotplug=<group choice="plain">
|
---|
[82044] | 78 | <arg choice="plain">on</arg>
|
---|
| 79 | <arg choice="plain">off</arg>
|
---|
| 80 | </group></arg>
|
---|
[92534] | 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>
|
---|
[101035] | 84 | <arg>--x86-pae=<group choice="plain">
|
---|
[82044] | 85 | <arg choice="plain">on</arg>
|
---|
| 86 | <arg choice="plain">off</arg>
|
---|
| 87 | </group></arg>
|
---|
[101035] | 88 | <arg>--x86-long-mode=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[101035] | 126 | <arg>--x86-hpet=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 134 | <arg>--triple-fault-reset=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[101035] | 142 | <arg>--x86-x2apic=<group choice="plain">
|
---|
[82044] | 143 | <arg choice="plain">on</arg>
|
---|
| 144 | <arg choice="plain">off</arg>
|
---|
| 145 | </group></arg>
|
---|
[92534] | 146 | <arg>--paravirt-provider=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[99192] | 154 | <arg>--paravirt-debug=<arg choice="plain"><replaceable>key</replaceable>=<replaceable>value</replaceable> [,<replaceable>key</replaceable>=<replaceable>value</replaceable>...]</arg></arg>
|
---|
[92534] | 155 | <arg>--nested-paging=<group choice="plain">
|
---|
[82044] | 156 | <arg choice="plain">on</arg>
|
---|
| 157 | <arg choice="plain">off</arg>
|
---|
| 158 | </group></arg>
|
---|
[92534] | 159 | <arg>--large-pages=<group choice="plain">
|
---|
[82044] | 160 | <arg choice="plain">on</arg>
|
---|
| 161 | <arg choice="plain">off</arg>
|
---|
| 162 | </group></arg>
|
---|
[101035] | 163 | <arg>--x86-vtx-vpid=<group choice="plain">
|
---|
[82044] | 164 | <arg choice="plain">on</arg>
|
---|
| 165 | <arg choice="plain">off</arg>
|
---|
| 166 | </group></arg>
|
---|
[101035] | 167 | <arg>--x86-vtx-ux=<group choice="plain">
|
---|
[82044] | 168 | <arg choice="plain">on</arg>
|
---|
| 169 | <arg choice="plain">off</arg>
|
---|
| 170 | </group></arg>
|
---|
[91204] | 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>
|
---|
[92534] | 179 | <arg>--accelerate-3d=<group choice="plain">
|
---|
[82044] | 180 | <arg choice="plain">on</arg>
|
---|
| 181 | <arg choice="plain">off</arg>
|
---|
| 182 | </group></arg>
|
---|
[92534] | 183 | <arg>--accelerate-2d-video=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[101125] | 190 | <arg choice="plain">armv8virtual</arg>
|
---|
[82044] | 191 | </group></arg>
|
---|
[90279] | 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>
|
---|
[91213] | 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>
|
---|
[99192] | 205 | <arg>--tpm-location=<replaceable>location</replaceable></arg>
|
---|
[101035] | 206 | <arg>--firmware-logo-fade-in=<group choice="plain">
|
---|
[82044] | 207 | <arg choice="plain">on</arg>
|
---|
| 208 | <arg choice="plain">off</arg>
|
---|
| 209 | </group></arg>
|
---|
[101035] | 210 | <arg>--firmware-logo-fade-out=<group choice="plain">
|
---|
[82044] | 211 | <arg choice="plain">on</arg>
|
---|
| 212 | <arg choice="plain">off</arg>
|
---|
| 213 | </group></arg>
|
---|
[101035] | 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">
|
---|
[82044] | 217 | <arg choice="plain">disabled</arg>
|
---|
| 218 | <arg choice="plain">menuonly</arg>
|
---|
| 219 | <arg choice="plain">messageandmenu</arg>
|
---|
| 220 | </group></arg>
|
---|
[101035] | 221 | <arg>--firmware-apic=<group choice="plain">
|
---|
[82044] | 222 | <arg choice="plain">disabled</arg>
|
---|
| 223 | <arg choice="plain">apic</arg>
|
---|
| 224 | <arg choice="plain">x2apic</arg>
|
---|
| 225 | </group></arg>
|
---|
[101035] | 226 | <arg>--firmware-system-time-offset=<replaceable>msec</replaceable></arg>
|
---|
| 227 | <arg>--firmware-pxe-debug=<group choice="plain">
|
---|
[82044] | 228 | <arg choice="plain">on</arg>
|
---|
| 229 | <arg choice="plain">off</arg>
|
---|
| 230 | </group></arg>
|
---|
[82198] | 231 | <arg>--system-uuid-le=<group choice="plain">
|
---|
| 232 | <arg choice="plain">on</arg>
|
---|
| 233 | <arg choice="plain">off</arg>
|
---|
| 234 | </group></arg>
|
---|
[82044] | 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>
|
---|
[92534] | 242 | <arg>--rtc-use-utc=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 252 | <arg>--snapshot-folder=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 262 | <arg>--guest-memory-balloon=<replaceable>size-in-MB</replaceable></arg>
|
---|
| 263 | <arg>--default-frontend=<group choice="plain">
|
---|
[82044] | 264 | <arg choice="plain">default</arg>
|
---|
| 265 | <arg choice="plain"><replaceable>name</replaceable></arg>
|
---|
| 266 | </group></arg>
|
---|
[91204] | 267 | <!-- There are currently undocumented options --iocache and
|
---|
| 268 | --iocachesize which are scheduled for removal. Not worth spending
|
---|
| 269 | time on documenting it. -->
|
---|
[82044] | 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>
|
---|
[103085] | 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>
|
---|
[82044] | 286 | </cmdsynopsis>
|
---|
[82057] | 287 |
|
---|
[82044] | 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>
|
---|
[91416] | 301 | <arg choice="plain">hostonlynet</arg>
|
---|
[82044] | 302 | <arg choice="plain">generic</arg>
|
---|
| 303 | <arg choice="plain">natnetwork</arg>
|
---|
[94070] | 304 | <arg choice="plain">cloud</arg>
|
---|
[82044] | 305 | </group></arg>
|
---|
[92534] | 306 | <arg>--nic-type<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 314 | <arg>--cable-connected<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 315 | <arg choice="plain">on</arg>
|
---|
| 316 | <arg choice="plain">off</arg>
|
---|
| 317 | </group></arg>
|
---|
[92534] | 318 | <arg>--nic-trace<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 319 | <arg choice="plain">on</arg>
|
---|
| 320 | <arg choice="plain">off</arg>
|
---|
| 321 | </group></arg>
|
---|
[92534] | 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">
|
---|
[82044] | 327 | <arg choice="plain">deny</arg>
|
---|
| 328 | <arg choice="plain">allow-vms</arg>
|
---|
| 329 | <arg choice="plain">allow-all</arg>
|
---|
| 330 | </group></arg>
|
---|
[92534] | 331 | <arg>--nic-bandwidth-group<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 332 | <arg choice="plain">none</arg>
|
---|
| 333 | <arg choice="plain"><replaceable>name</replaceable></arg>
|
---|
| 334 | </group></arg>
|
---|
[92534] | 335 | <arg>--bridge-adapter<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 336 | <arg choice="plain">none</arg>
|
---|
| 337 | <arg choice="plain"><replaceable>device-name</replaceable></arg>
|
---|
| 338 | </group></arg>
|
---|
[94070] | 339 | <arg>--cloud-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
|
---|
[92534] | 340 | <arg>--host-only-adapter<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 341 | <arg choice="plain">none</arg>
|
---|
| 342 | <arg choice="plain"><replaceable>device-name</replaceable></arg>
|
---|
| 343 | </group></arg>
|
---|
[92534] | 344 | <arg>--host-only-net<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
|
---|
[82044] | 345 | <arg>--intnet<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
|
---|
| 346 | <arg>--nat-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></arg>
|
---|
[92534] | 347 | <arg>--nic-generic-drv<replaceable>N</replaceable>=<replaceable>driver-name</replaceable></arg>
|
---|
| 348 | <arg>--mac-address<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 349 | <arg choice="plain">auto</arg>
|
---|
| 350 | <arg choice="plain"><replaceable>MAC-address</replaceable></arg>
|
---|
| 351 | </group></arg>
|
---|
| 352 | </cmdsynopsis>
|
---|
[82057] | 353 |
|
---|
[82044] | 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>
|
---|
[92534] | 360 | <arg>--nat-net<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 361 | <arg choice="plain"><replaceable>network</replaceable></arg>
|
---|
| 362 | <arg choice="plain">default</arg>
|
---|
| 363 | </group></arg>
|
---|
[92534] | 364 | <arg>--nat-pf<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 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">
|
---|
[82044] | 374 | <arg choice="plain">on</arg>
|
---|
| 375 | <arg choice="plain">off</arg>
|
---|
| 376 | </group></arg>
|
---|
[92534] | 377 | <arg>--nat-dns-proxy<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 378 | <arg choice="plain">on</arg>
|
---|
| 379 | <arg choice="plain">off</arg>
|
---|
| 380 | </group></arg>
|
---|
[92534] | 381 | <arg>--nat-dns-host-resolver<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 382 | <arg choice="plain">on</arg>
|
---|
| 383 | <arg choice="plain">off</arg>
|
---|
| 384 | </group></arg>
|
---|
[92534] | 385 | <arg>--nat-localhostreachable<replaceable>N</replaceable>=<group choice="plain">
|
---|
[92133] | 386 | <arg choice="plain">on</arg>
|
---|
| 387 | <arg choice="plain">off</arg>
|
---|
| 388 | </group></arg>
|
---|
[92534] | 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">
|
---|
[82044] | 391 | <arg choice="plain">default</arg>
|
---|
| 392 | <arg choice="plain">[log],[proxyonly],[sameports]</arg>
|
---|
| 393 | </group></arg>
|
---|
| 394 | </cmdsynopsis>
|
---|
[82057] | 395 |
|
---|
[82044] | 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>
|
---|
[95368] | 407 | <arg choice="plain">usbmtscreenpluspad</arg>
|
---|
[82044] | 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>
|
---|
[92534] | 417 | <arg>--uart-mode<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 426 | <arg>--uart-type<replaceable>N</replaceable>=<group choice="plain">
|
---|
[82044] | 427 | <arg choice="plain">16450</arg>
|
---|
| 428 | <arg choice="plain">16550A</arg>
|
---|
| 429 | <arg choice="plain">16750</arg>
|
---|
| 430 | </group></arg>
|
---|
[92534] | 431 | <arg>--lpt-mode<replaceable>N</replaceable>=<replaceable>device-name</replaceable></arg>
|
---|
[82044] | 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>
|
---|
[98032] | 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">
|
---|
[82044] | 448 | <arg choice="plain">none</arg>
|
---|
[96604] | 449 | <arg choice="plain">default</arg>
|
---|
[82044] | 450 | <arg choice="plain">null</arg>
|
---|
| 451 | <arg choice="plain">dsound</arg>
|
---|
[96604] | 452 | <arg choice="plain">was</arg>
|
---|
[82044] | 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>
|
---|
[98032] | 458 | <arg>--audio-enabled=<group choice="plain">
|
---|
| 459 | <arg choice="plain">on</arg>
|
---|
| 460 | <arg choice="plain">off</arg>
|
---|
[82044] | 461 | </group></arg>
|
---|
[92534] | 462 | <arg>--audio-in=<group choice="plain">
|
---|
[82044] | 463 | <arg choice="plain">on</arg>
|
---|
| 464 | <arg choice="plain">off</arg>
|
---|
| 465 | </group></arg>
|
---|
[92534] | 466 | <arg>--audio-out=<group choice="plain">
|
---|
[82044] | 467 | <arg choice="plain">on</arg>
|
---|
| 468 | <arg choice="plain">off</arg>
|
---|
| 469 | </group></arg>
|
---|
[91204] | 470 | <arg>--clipboard-mode=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[99959] | 476 | <arg>--clipboard-file-transfers=<group choice="plain">
|
---|
| 477 | <arg choice="plain">enabled</arg>
|
---|
| 478 | <arg choice="plain">disabled</arg>
|
---|
| 479 | </group></arg>
|
---|
[92534] | 480 | <arg>--drag-and-drop=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[92534] | 486 | <arg>--monitor-count=<replaceable>number</replaceable></arg>
|
---|
| 487 | <arg>--usb-ehci=<group choice="plain">
|
---|
[82044] | 488 | <arg choice="plain">on</arg>
|
---|
| 489 | <arg choice="plain">off</arg>
|
---|
| 490 | </group></arg>
|
---|
[92534] | 491 | <arg>--usb-ohci=<group choice="plain">
|
---|
[82044] | 492 | <arg choice="plain">on</arg>
|
---|
| 493 | <arg choice="plain">off</arg>
|
---|
| 494 | </group></arg>
|
---|
[92534] | 495 | <arg>--usb-xhci=<group choice="plain">
|
---|
[82044] | 496 | <arg choice="plain">on</arg>
|
---|
| 497 | <arg choice="plain">off</arg>
|
---|
| 498 | </group></arg>
|
---|
[92534] | 499 | <arg>--usb-rename=<replaceable>old-name</replaceable> <replaceable>new-name</replaceable></arg>
|
---|
[82044] | 500 | </cmdsynopsis>
|
---|
[82057] | 501 |
|
---|
[82044] | 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>
|
---|
[92534] | 512 | <arg>--recording-screens=<group choice="plain">
|
---|
[82044] | 513 | <arg choice="plain">all</arg>
|
---|
[93707] | 514 | <arg choice="plain">none</arg>
|
---|
| 515 | <arg choice="plain"><replaceable>screen-ID</replaceable>[,<replaceable>screen-ID</replaceable>...]</arg>
|
---|
[82044] | 516 | </group></arg>
|
---|
[92534] | 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>
|
---|
[93707] | 520 | <arg>--recording-opts= <arg choice="plain"><replaceable>key</replaceable>=<replaceable>value</replaceable>[,<replaceable>key</replaceable>=<replaceable>value</replaceable>...]</arg></arg>
|
---|
[92534] | 521 | <arg>--recording-video-fps=<replaceable>fps</replaceable></arg>
|
---|
| 522 | <arg>--recording-video-rate=<replaceable>rate</replaceable></arg>
|
---|
[99119] | 523 | <arg>--recording-video-res=<replaceable>width</replaceable> x <replaceable>height</replaceable></arg><!-- 'x' shouldn't need spaces around it... -->
|
---|
[82044] | 524 | </cmdsynopsis>
|
---|
[82057] | 525 |
|
---|
[82044] | 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>
|
---|
[99119] | 536 | <arg>--vrde-property=<replaceable>property-name</replaceable>=<arg><replaceable>property-value</replaceable></arg></arg>
|
---|
[92534] | 537 | <arg>--vrde-extpack=<group choice="plain">
|
---|
[82044] | 538 | <arg choice="plain">default</arg>
|
---|
| 539 | <arg choice="plain"><replaceable>name</replaceable></arg>
|
---|
| 540 | </group></arg>
|
---|
[92534] | 541 | <arg>--vrde-port=<replaceable>port</replaceable></arg>
|
---|
| 542 | <arg>--vrde-address=<replaceable>hostip</replaceable></arg>
|
---|
| 543 | <arg>--vrde-auth-type=<group choice="plain">
|
---|
[82044] | 544 | <arg choice="plain">null</arg>
|
---|
| 545 | <arg choice="plain">external</arg>
|
---|
| 546 | <arg choice="plain">guest</arg>
|
---|
| 547 | </group></arg>
|
---|
[92534] | 548 | <arg>--vrde-auth-library=<group choice="plain">
|
---|
[82044] | 549 | <arg choice="plain">default</arg>
|
---|
| 550 | <arg choice="plain"><replaceable>name</replaceable></arg>
|
---|
| 551 | </group></arg>
|
---|
[92534] | 552 | <arg>--vrde-multi-con=<group choice="plain">
|
---|
[82044] | 553 | <arg choice="plain">on</arg>
|
---|
| 554 | <arg choice="plain">off</arg>
|
---|
| 555 | </group></arg>
|
---|
[92534] | 556 | <arg>--vrde-reuse-con=<group choice="plain">
|
---|
[82044] | 557 | <arg choice="plain">on</arg>
|
---|
| 558 | <arg choice="plain">off</arg>
|
---|
| 559 | </group></arg>
|
---|
[92534] | 560 | <arg>--vrde-video-channel=<group choice="plain">
|
---|
[82044] | 561 | <arg choice="plain">on</arg>
|
---|
| 562 | <arg choice="plain">off</arg>
|
---|
| 563 | </group></arg>
|
---|
[92534] | 564 | <arg>--vrde-video-channel-quality=<replaceable>percent</replaceable></arg>
|
---|
[82044] | 565 | </cmdsynopsis>
|
---|
[82057] | 566 |
|
---|
[82044] | 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>
|
---|
[92534] | 577 | <arg>--teleporter-port=<replaceable>port</replaceable></arg>
|
---|
| 578 | <arg>--teleporter-address=<group choice="plain">
|
---|
[82044] | 579 | <arg choice="plain"><replaceable>address</replaceable></arg>
|
---|
| 580 | <arg choice="plain">empty</arg>
|
---|
| 581 | </group></arg>
|
---|
[92534] | 582 | <arg>--teleporter-password=<replaceable>password</replaceable></arg>
|
---|
| 583 | <arg>--teleporter-password-file=<group choice="plain">
|
---|
[82044] | 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>
|
---|
[91204] | 588 | <arg>--cpuid-set=<replaceable>leaf</replaceable><arg>:<replaceable>subleaf</replaceable></arg> <replaceable>eax</replaceable> <replaceable>ebx</replaceable> <replaceable>ecx</replaceable> <replaceable>edx</replaceable></arg>
|
---|
| 589 | <arg>--cpuid-remove=<replaceable>leaf</replaceable><arg>:<replaceable>subleaf</replaceable></arg></arg>
|
---|
[92534] | 590 | <arg>--cpuid-remove-all</arg>
|
---|
[82044] | 591 | </cmdsynopsis>
|
---|
[82057] | 592 |
|
---|
[82044] | 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>
|
---|
[82057] | 609 |
|
---|
[82044] | 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>
|
---|
[92534] | 616 | <arg>--usb-card-reader=<group choice="plain">
|
---|
[82044] | 617 | <arg choice="plain">on</arg>
|
---|
| 618 | <arg choice="plain">off</arg>
|
---|
| 619 | </group></arg>
|
---|
| 620 | </cmdsynopsis>
|
---|
[82057] | 621 |
|
---|
[82044] | 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>
|
---|
[91204] | 633 | <!-- There is a currently undocumented option --autostop-type.
|
---|
| 634 | Most autostart service implementations either ignore it or rely it is
|
---|
| 635 | left unchanged due to otherwise running into timeouts established by the
|
---|
| 636 | host OS, defeating the purpose. Not worth spending time on documenting
|
---|
| 637 | it unless this changes. -->
|
---|
[82044] | 638 | </cmdsynopsis>
|
---|
[91204] | 639 |
|
---|
[96888] | 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 |
|
---|
[91204] | 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>
|
---|
[92534] | 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>
|
---|
[91204] | 673 | </cmdsynopsis>
|
---|
[92538] | 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>
|
---|
[82044] | 685 | </refsynopsisdiv>
|
---|
| 686 |
|
---|
[99497] | 687 | <refsect1 id="vboxmanage-modifyvm-description">
|
---|
[82044] | 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
|
---|
[91204] | 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.
|
---|
[82044] | 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>
|
---|
[92534] | 753 | <term><option>--os-type=<replaceable>OS-type</replaceable></option></term>
|
---|
[82044] | 754 | <listitem><para>
|
---|
[91204] | 755 | Specifies the guest operating system (OS) information for
|
---|
| 756 | the VM. Use the <command>VBoxManage list ostypes</command>
|
---|
[82044] | 757 | command to view the OS type identifiers.
|
---|
| 758 | </para></listitem>
|
---|
| 759 | </varlistentry>
|
---|
| 760 | <varlistentry>
|
---|
[92534] | 761 | <term><option>--icon-file=<replaceable>filename</replaceable></option></term>
|
---|
[82044] | 762 | <listitem><para>
|
---|
[91204] | 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.
|
---|
[82044] | 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
|
---|
[97033] | 773 | <xref linkend="create-vm-wizard" />.
|
---|
[82044] | 774 | </para></listitem>
|
---|
| 775 | </varlistentry>
|
---|
| 776 | <varlistentry>
|
---|
[92534] | 777 | <term><option>--page-fusion=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 808 | <term><option>--hardware-uuid=<replaceable>uuid</replaceable></option></term>
|
---|
[82044] | 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
|
---|
[91204] | 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;.
|
---|
[82044] | 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>
|
---|
[92534] | 831 | <term><option>--cpu-hotplug=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 839 | <term><option>--plug-cpu=<replaceable>CPU-ID</replaceable></option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 852 | <term><option>--unplug-cpu=<replaceable>CPU-ID</replaceable></option></term>
|
---|
[82044] | 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>
|
---|
[93707] | 868 | <listitem>
|
---|
| 869 | <para>
|
---|
[82044] | 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.
|
---|
[93707] | 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>
|
---|
[82044] | 882 | </varlistentry>
|
---|
| 883 | <varlistentry>
|
---|
[101035] | 884 | <term><option>--x86-pae=on | off</option></term>
|
---|
[82044] | 885 | <listitem><para>
|
---|
| 886 | Enables or disables physical address extension (PAE). See
|
---|
| 887 | <xref linkend="settings-processor" />.
|
---|
| 888 | </para></listitem>
|
---|
| 889 | </varlistentry>
|
---|
| 890 | <varlistentry>
|
---|
[101035] | 891 | <term><option>--x86-long-mode=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[101035] | 964 | <term><option>--x86-hpet=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 982 | <term><option>--triple-fault-reset=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[91204] | 994 | Enables or disables APIC. With APIC, OSes can use
|
---|
[82044] | 995 | more than 16 interrupt requests (IRQs) to avoid IRQ
|
---|
[91204] | 996 | sharing and to improve reliability. APIC is enabled by
|
---|
[82044] | 997 | default. See <xref linkend="settings-motherboard" />.
|
---|
| 998 | </para></listitem>
|
---|
| 999 | </varlistentry>
|
---|
| 1000 | <varlistentry>
|
---|
[101035] | 1001 | <term><option>--x86-x2apic=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 1014 | <term><option>--paravirt-provider=none | default | legacy | minimal | hyperv | kvm</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 1049 | <term><option>--paravirt-debug=<replaceable>property</replaceable>=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 1057 | <term><option>--nested-paging=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[92534] | 1067 | <term><option>--large-pages=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[101035] | 1077 | <term><option>--x86-vtx-vpid=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[101035] | 1086 | <term><option>--x86-vtx-ux=on | off</option></term>
|
---|
[82044] | 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>
|
---|
[91204] | 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>
|
---|
[103454] | 1115 | <term><option>--accelerate-3d=on | off</option></term>
|
---|
[82044] | 1116 | <listitem><para>
|
---|
[91204] | 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.
|
---|
[82044] | 1120 | See <xref linkend="guestadd-3d" />.
|
---|
| 1121 | </para></listitem>
|
---|
| 1122 | </varlistentry>
|
---|
| 1123 | <varlistentry>
|
---|
[103454] | 1124 | <term><option>--accelerate-2d-video=on | off</option></term>
|
---|
[82044] | 1125 | <listitem><para>
|
---|
[91204] | 1126 | Enables or disables 2D video acceleration for the graphics
|
---|
| 1127 | adapter variants which support it. This option has an effect
|
---|
| 1128 | only when the Guest Additions are installed. See
|
---|
[82044] | 1129 | <xref linkend="guestadd-2d" />.
|
---|
| 1130 | </para></listitem>
|
---|
| 1131 | </varlistentry>
|
---|
| 1132 | <varlistentry>
|
---|
[101125] | 1133 | <term><option>--chipset=piix3 | ich9 | armv8virtual</option></term>
|
---|
[82044] | 1134 | <listitem><para>
|
---|
| 1135 | Specify the Intel chipset for &product-name; to emulate.
|
---|
[101125] | 1136 | For the x86 platform, the default value is the Intel PIIX3 chipset.
|
---|
[82044] | 1137 | (<literal>piix3</literal>).
|
---|
[101125] | 1138 | For the ARM platform, the default value is the ARMv8Virtual chipset.
|
---|
| 1139 | (<literal>armv8virtual</literal>).
|
---|
[82044] | 1140 | </para><para>
|
---|
| 1141 | Change this value only if you need to relax some of the
|
---|
| 1142 | chipset constraints. See
|
---|
| 1143 | <xref linkend="settings-motherboard" />.
|
---|
| 1144 | </para></listitem>
|
---|
| 1145 | </varlistentry>
|
---|
| 1146 | <varlistentry>
|
---|
[90279] | 1147 | <term><option>--iommu=none | automatic | amd | intel</option></term>
|
---|
| 1148 | <listitem><para>
|
---|
| 1149 | Specifies the IOMMU type for &product-name; to emulate.
|
---|
| 1150 | Both Intel and AMD IOMMU emulation currently require the
|
---|
| 1151 | use of the Intel ICH9 chipset (see
|
---|
| 1152 | <option>--chipset</option> option).
|
---|
| 1153 | </para><para>
|
---|
| 1154 | Valid values are as follows:
|
---|
| 1155 | </para><itemizedlist>
|
---|
| 1156 | <listitem><para>
|
---|
| 1157 | <literal>none</literal> – No IOMMU is present
|
---|
| 1158 | and is the default value.
|
---|
| 1159 | </para></listitem>
|
---|
| 1160 | <listitem><para>
|
---|
| 1161 | <literal>automatic</literal> – An IOMMU is
|
---|
| 1162 | present but its type is automatically chosen to match
|
---|
| 1163 | the host CPU vendor when the VM is powered on.
|
---|
| 1164 | </para></listitem>
|
---|
| 1165 | <listitem><para>
|
---|
| 1166 | <literal>amd</literal> – An AMD IOMMU is
|
---|
| 1167 | present.
|
---|
| 1168 | </para></listitem>
|
---|
| 1169 | <listitem><para>
|
---|
| 1170 | <literal>intel</literal> – An Intel IOMMU is
|
---|
| 1171 | present.
|
---|
| 1172 | </para></listitem>
|
---|
| 1173 | </itemizedlist></listitem>
|
---|
| 1174 | </varlistentry>
|
---|
| 1175 | <varlistentry>
|
---|
[91213] | 1176 | <term><option>--tpm-type=none | 1.2 | 2.0 | host | swtpm</option></term>
|
---|
| 1177 | <listitem><para>
|
---|
| 1178 | Specifies the TPM type for &product-name; to emulate.
|
---|
| 1179 | </para><para>
|
---|
| 1180 | Valid values are as follows:
|
---|
| 1181 | </para><itemizedlist>
|
---|
| 1182 | <listitem><para>
|
---|
| 1183 | <literal>none</literal> – No TPM is present
|
---|
| 1184 | and is the default value.
|
---|
| 1185 | </para></listitem>
|
---|
| 1186 | <listitem><para>
|
---|
| 1187 | <literal>1.2</literal> – A TPM conforming to the TCG specification
|
---|
| 1188 | version 1.2 is present.
|
---|
| 1189 | </para></listitem>
|
---|
| 1190 | <listitem><para>
|
---|
| 1191 | <literal>2.0</literal> – A TPM conforming to the TCG specification
|
---|
| 1192 | version 2.0 is present.
|
---|
| 1193 | </para></listitem>
|
---|
| 1194 | <listitem><para>
|
---|
| 1195 | <literal>host</literal> – The host TPM is passed through to the guest.
|
---|
| 1196 | May not be available on all supported host platforms.
|
---|
| 1197 | </para></listitem>
|
---|
| 1198 | <listitem><para>
|
---|
| 1199 | <literal>swtpm</literal> – The VM connects to an external TPM emulation
|
---|
| 1200 | compliant to swtpm. Requires to set the TPM location to connect to (see
|
---|
| 1201 | <option>--tpm-location</option> option).
|
---|
| 1202 | </para></listitem>
|
---|
| 1203 | </itemizedlist></listitem>
|
---|
| 1204 | </varlistentry>
|
---|
| 1205 | <varlistentry>
|
---|
[101035] | 1206 | <term><option>--firmware-logo-fade-in=on | off</option></term>
|
---|
[82044] | 1207 | <listitem><para>
|
---|
| 1208 | Specifies whether the BIOS logo fades in on VM startup. By
|
---|
| 1209 | default, an &product-name; logo is shown.
|
---|
| 1210 | </para></listitem>
|
---|
| 1211 | </varlistentry>
|
---|
| 1212 | <varlistentry>
|
---|
[101035] | 1213 | <term><option>--firmware-logo-fade-out=on | off</option></term>
|
---|
[82044] | 1214 | <listitem><para>
|
---|
| 1215 | Specifies whether the BIOS logo fades out on VM startup.
|
---|
| 1216 | </para></listitem>
|
---|
| 1217 | </varlistentry>
|
---|
| 1218 | <varlistentry>
|
---|
[101035] | 1219 | <term><option>--firmware-logo-display-time=<replaceable>msec</replaceable></option></term>
|
---|
[82044] | 1220 | <listitem><para>
|
---|
| 1221 | Specifies the amount of time in milliseconds that the BIOS
|
---|
| 1222 | logo is visible.
|
---|
| 1223 | </para></listitem>
|
---|
| 1224 | </varlistentry>
|
---|
| 1225 | <varlistentry>
|
---|
[101035] | 1226 | <term><option>--firmware-logo-image-path=<replaceable>pathname</replaceable></option></term>
|
---|
[82044] | 1227 | <listitem><para>
|
---|
| 1228 | Replaces the existing BIOS logo with a different image.
|
---|
[91204] | 1229 | The replacement image must be an uncompressed 16, 256 or 16M
|
---|
| 1230 | color bitmap file (BMP) that does not contain color space
|
---|
[82044] | 1231 | information (Windows 3.0 format). Also ensure that the
|
---|
| 1232 | image is no larger than 640 X 480 pixels.
|
---|
| 1233 | </para></listitem>
|
---|
| 1234 | </varlistentry>
|
---|
| 1235 | <varlistentry>
|
---|
[101035] | 1236 | <term><option>--firmware-boot-menu=disabled | menuonly | messageandmenu</option></term>
|
---|
[82044] | 1237 | <listitem><para>
|
---|
| 1238 | Specifies whether the BIOS permits you to select a
|
---|
| 1239 | temporary boot device. Valid values are:
|
---|
| 1240 | </para><itemizedlist>
|
---|
| 1241 | <listitem><para>
|
---|
| 1242 | <literal>disabled</literal> outputs the alternate boot
|
---|
| 1243 | device message and permits you to select a temporary
|
---|
| 1244 | boot device by pressing F12.
|
---|
| 1245 | </para></listitem>
|
---|
| 1246 | <listitem><para>
|
---|
| 1247 | <literal>menuonly</literal> suppresses the alternate
|
---|
| 1248 | boot device message, but permits you to select a
|
---|
| 1249 | temporary boot device by pressing F12.
|
---|
| 1250 | </para></listitem>
|
---|
| 1251 | <listitem><para>
|
---|
| 1252 | <literal>messageandmenu</literal> suppresses the
|
---|
| 1253 | alternate boot device message and prevents you from
|
---|
| 1254 | selecting a temporary boot device by pressing F12.
|
---|
| 1255 | </para></listitem>
|
---|
| 1256 | </itemizedlist></listitem>
|
---|
| 1257 | </varlistentry>
|
---|
| 1258 | <varlistentry>
|
---|
[101035] | 1259 | <term><option>--firmware-apic=x2apic | apic | disabled</option></term>
|
---|
[82044] | 1260 | <listitem><para>
|
---|
| 1261 | Specifies the APIC level of the firmware. Valid values
|
---|
| 1262 | are: <literal>x2apic</literal>, <literal>apic</literal>,
|
---|
| 1263 | and <literal>disabled</literal>. When the value is
|
---|
| 1264 | <literal>disabled</literal>, neither the
|
---|
| 1265 | <literal>apic</literal> nor the <literal>x2apic</literal>
|
---|
| 1266 | version of the firmware is used.
|
---|
| 1267 | </para><para>
|
---|
| 1268 | Note that if you specify the <literal>x2apic</literal>
|
---|
| 1269 | value and x2APIC is unsupported by the virtual CPU, the
|
---|
| 1270 | APIC level downgrades to <literal>apic</literal>, if
|
---|
| 1271 | supported. Otherwise, the APIC level downgrades to
|
---|
| 1272 | <literal>disabled</literal>. Similarly, if you specify the
|
---|
| 1273 | <literal>apic</literal> value and APIC is unsupported by
|
---|
| 1274 | the virtual CPU, the APIC level downgrades to
|
---|
| 1275 | <literal>disabled</literal>.
|
---|
| 1276 | </para></listitem>
|
---|
| 1277 | </varlistentry>
|
---|
| 1278 | <varlistentry>
|
---|
[101035] | 1279 | <term><option>--firmware-system-time-offset=<replaceable>msec</replaceable></option></term>
|
---|
[82044] | 1280 | <listitem><para>
|
---|
| 1281 | Specifies the time offset in milliseconds of the guest VM
|
---|
| 1282 | relative to the time on the host system. If the offset
|
---|
| 1283 | value is positive, the guest VM time runs ahead of the
|
---|
| 1284 | time on the host system.
|
---|
| 1285 | </para></listitem>
|
---|
| 1286 | </varlistentry>
|
---|
| 1287 | <varlistentry>
|
---|
[101035] | 1288 | <term><option>--firmware-pxe-debug=on | off</option></term>
|
---|
[82044] | 1289 | <listitem><para>
|
---|
[82198] | 1290 | Enables or disables additional debugging output when using
|
---|
[82044] | 1291 | the Intel PXE boot ROM. The debug output is written to the
|
---|
| 1292 | release log file. See
|
---|
| 1293 | <xref linkend="collect-debug-info" />.
|
---|
| 1294 | </para></listitem>
|
---|
| 1295 | </varlistentry>
|
---|
| 1296 | <varlistentry>
|
---|
[82198] | 1297 | <term><option>--system-uuid-le=on | off</option></term>
|
---|
| 1298 | <listitem><para>
|
---|
| 1299 | Enables or disables representing the system UUID in little
|
---|
| 1300 | endian form. The default value is <literal>on</literal> for
|
---|
| 1301 | new VMs. For old VMs the setting is <literal>off</literal> to
|
---|
| 1302 | keep the content of the DMI/SMBIOS table unchanged, which can
|
---|
| 1303 | be important for Windows license activation.
|
---|
| 1304 | </para></listitem>
|
---|
| 1305 | </varlistentry>
|
---|
| 1306 | <varlistentry>
|
---|
[82044] | 1307 | <term><option>--boot<replaceable>N</replaceable>=none | floppy | dvd | disk | net</option></term>
|
---|
| 1308 | <listitem><para>
|
---|
| 1309 | Enables you to specify the boot device order for the VM by
|
---|
| 1310 | assigning one of the device types to each of the four boot
|
---|
| 1311 | device slots that are represented by
|
---|
| 1312 | <replaceable>N</replaceable> in the option name.
|
---|
| 1313 | </para><para>
|
---|
| 1314 | A value of 1 for <replaceable>N</replaceable> represents
|
---|
| 1315 | the first boot device slot, and so on.
|
---|
| 1316 | </para><para>
|
---|
| 1317 | The device types are <literal>floppy</literal> for floppy
|
---|
| 1318 | disks, <literal>dvd</literal> for DVDs or CDs,
|
---|
| 1319 | <literal>disk</literal> for hard disks, and
|
---|
| 1320 | <literal>net</literal> for a network device. A value of
|
---|
| 1321 | <literal>none</literal> indicates that no boot device is
|
---|
| 1322 | associated with the specified slot.
|
---|
| 1323 | </para></listitem>
|
---|
| 1324 | </varlistentry>
|
---|
| 1325 | <varlistentry>
|
---|
[92534] | 1326 | <term><option>--rtc-use-utc=on | off</option></term>
|
---|
[82044] | 1327 | <listitem><para>
|
---|
| 1328 | Specifies whether the real-time clock (RTC) uses
|
---|
| 1329 | coordinated universal time (UTC). See
|
---|
| 1330 | <xref linkend="settings-motherboard" />.
|
---|
| 1331 | </para></listitem>
|
---|
| 1332 | </varlistentry>
|
---|
| 1333 | <varlistentry>
|
---|
| 1334 | <term><option>--graphicscontroller=none | vboxvga | vmsvga | vboxsvga</option></term>
|
---|
| 1335 | <listitem><para>
|
---|
| 1336 | Specifies the graphics controller type to use. See
|
---|
| 1337 | <xref linkend="settings-screen" />.
|
---|
| 1338 | </para></listitem>
|
---|
| 1339 | </varlistentry>
|
---|
| 1340 | <varlistentry>
|
---|
[92534] | 1341 | <term><option>--snapshot-folder=default | <replaceable>pathname</replaceable></option></term>
|
---|
[82044] | 1342 | <listitem><para>
|
---|
| 1343 | Specifies the name of the VM's snapshot storage folder. If
|
---|
| 1344 | you specify <literal>default</literal>, the folder name is
|
---|
| 1345 | <filename>Snapshots/</filename> in the machine folder.
|
---|
| 1346 | </para></listitem>
|
---|
| 1347 | </varlistentry>
|
---|
| 1348 | <varlistentry>
|
---|
| 1349 | <term><option>--firmware=bios | efi | efi32 | efi64</option></term>
|
---|
| 1350 | <listitem><para>
|
---|
| 1351 | Specifies the firmware used to boot the VM. Valid values
|
---|
| 1352 | are: <literal>bios</literal>, <literal>efi</literal>,
|
---|
| 1353 | <literal>efi32</literal>, or <literal>efi64</literal>. Use
|
---|
| 1354 | EFI values with care.
|
---|
| 1355 | </para><para>
|
---|
| 1356 | By default, BIOS firmware is used.
|
---|
| 1357 | </para></listitem>
|
---|
| 1358 | </varlistentry>
|
---|
| 1359 | <varlistentry>
|
---|
[92534] | 1360 | <term><option>--guest-memory-balloon=<replaceable>size</replaceable></option></term>
|
---|
[82044] | 1361 | <listitem><para>
|
---|
| 1362 | Specifies the size of the guest memory balloon. The guest
|
---|
| 1363 | memory balloon is the memory allocated by the Guest
|
---|
| 1364 | Additions from the guest OS and returned to the hypervisor
|
---|
| 1365 | for use by other VMs. Specify
|
---|
| 1366 | <replaceable>size</replaceable> in megabytes. The default
|
---|
| 1367 | value is <literal>0</literal> megabytes. See
|
---|
| 1368 | <xref linkend="guestadd-balloon" />.
|
---|
| 1369 | </para></listitem>
|
---|
| 1370 | </varlistentry>
|
---|
| 1371 | <varlistentry>
|
---|
[92534] | 1372 | <term><option>--default-frontend=default | <replaceable>name</replaceable></option></term>
|
---|
[82044] | 1373 | <listitem><para>
|
---|
| 1374 | Specifies the default frontend to use when starting the
|
---|
| 1375 | specified VM. If you specify <literal>default</literal>,
|
---|
| 1376 | the VM is shown in a window on the user's desktop. See
|
---|
| 1377 | <xref linkend="vboxmanage-startvm" />.
|
---|
| 1378 | </para></listitem>
|
---|
| 1379 | </varlistentry>
|
---|
| 1380 | <varlistentry>
|
---|
| 1381 | <term><option>--vm-process-priority=default | flat | low | normal | high</option></term>
|
---|
| 1382 | <listitem><para>
|
---|
| 1383 | Specifies the priority scheme of the VM process to use
|
---|
| 1384 | when starting the specified VM and while the VM runs.
|
---|
[89774] | 1385 | </para><para>
|
---|
| 1386 | The following valid values are:
|
---|
| 1387 | </para><itemizedlist>
|
---|
| 1388 | <listitem><para>
|
---|
| 1389 | <literal>default</literal> – Default process
|
---|
| 1390 | priority determined by the OS.
|
---|
| 1391 | </para></listitem>
|
---|
| 1392 | <listitem><para>
|
---|
| 1393 | <literal>flat</literal> – Assumes a scheduling
|
---|
| 1394 | policy which puts the process at the default priority
|
---|
| 1395 | and with all threads at the same priority.
|
---|
| 1396 | </para></listitem>
|
---|
| 1397 | <listitem><para>
|
---|
| 1398 | <literal>low</literal> – Assumes a scheduling
|
---|
| 1399 | policy which puts the process mostly below the default
|
---|
| 1400 | priority of the host OS.
|
---|
| 1401 | </para></listitem>
|
---|
| 1402 | <listitem><para>
|
---|
| 1403 | <literal>normal</literal> – Assume a scheduling
|
---|
| 1404 | policy which shares the CPU resources fairly with
|
---|
| 1405 | other processes running with the default priority of
|
---|
| 1406 | the host OS.
|
---|
| 1407 | </para></listitem>
|
---|
| 1408 | <listitem><para>
|
---|
| 1409 | <literal>high</literal> – Assumes a scheduling
|
---|
| 1410 | policy which puts the task above the default priority of
|
---|
| 1411 | the host OS. This policy might easily cause other tasks
|
---|
| 1412 | in the system to starve.
|
---|
| 1413 | </para></listitem>
|
---|
| 1414 | </itemizedlist></listitem>
|
---|
[82044] | 1415 | </varlistentry>
|
---|
| 1416 | </variablelist>
|
---|
| 1417 | </refsect2>
|
---|
| 1418 | <refsect2 id="vboxmanage-modifyvm-networking">
|
---|
| 1419 | <title>Networking Settings</title>
|
---|
| 1420 | <remark role="help-copy-synopsis"/>
|
---|
| 1421 | <para>
|
---|
| 1422 | The following options enable you to modify networking on your
|
---|
| 1423 | VM. With all these options, <replaceable>N</replaceable> is an
|
---|
| 1424 | integer greater than zero that represents the particular virtual
|
---|
| 1425 | network adapter to configure.
|
---|
| 1426 | </para>
|
---|
| 1427 | <variablelist>
|
---|
| 1428 | <varlistentry>
|
---|
| 1429 | <term><option>--nic<replaceable>N</replaceable>=none | null | nat | natnetwork | bridged | intnet | hostonly | generic</option></term>
|
---|
| 1430 | <listitem><para>
|
---|
| 1431 | Configures the network type used by each virtual network
|
---|
| 1432 | card in the VM.
|
---|
| 1433 | </para><para>
|
---|
| 1434 | The following valid values correspond to the modes
|
---|
| 1435 | described in <xref linkend="networkingmodes" />:
|
---|
| 1436 | </para><itemizedlist>
|
---|
| 1437 | <listitem><para>
|
---|
| 1438 | <literal>none</literal> – No networking present
|
---|
| 1439 | </para></listitem>
|
---|
| 1440 | <listitem><para>
|
---|
| 1441 | <literal>null</literal> – Not connected to the
|
---|
| 1442 | host system
|
---|
| 1443 | </para></listitem>
|
---|
| 1444 | <listitem><para>
|
---|
| 1445 | <literal>nat</literal> – Use network address
|
---|
| 1446 | translation (NAT)
|
---|
| 1447 | </para></listitem>
|
---|
| 1448 | <listitem><para>
|
---|
| 1449 | <literal>natnetwork</literal> – Use a NAT
|
---|
[91204] | 1450 | network
|
---|
[82044] | 1451 | </para></listitem>
|
---|
| 1452 | <listitem><para>
|
---|
| 1453 | <literal>bridged</literal> – Use bridged
|
---|
| 1454 | networking
|
---|
| 1455 | </para></listitem>
|
---|
| 1456 | <listitem><para>
|
---|
| 1457 | <literal>intnet</literal> – Use internal
|
---|
| 1458 | networking
|
---|
| 1459 | </para></listitem>
|
---|
| 1460 | <listitem><para>
|
---|
| 1461 | <literal>hostonly</literal> – Use host-only
|
---|
| 1462 | networking
|
---|
| 1463 | </para></listitem>
|
---|
| 1464 | <listitem><para>
|
---|
| 1465 | <literal>generic</literal> – Access rarely used
|
---|
| 1466 | sub-modes
|
---|
| 1467 | </para></listitem>
|
---|
| 1468 | </itemizedlist></listitem>
|
---|
| 1469 | </varlistentry>
|
---|
| 1470 | <varlistentry>
|
---|
[92534] | 1471 | <term><option>--nic-type<replaceable>N</replaceable>=Am79C970A | Am79C973 | 82540EM | 82543GC | 82545EM | virtio</option></term>
|
---|
[82044] | 1472 | <listitem><para>
|
---|
| 1473 | Identifies the type of networking hardware that
|
---|
| 1474 | &product-name; presents to the guest VM for the specified
|
---|
| 1475 | virtual network card. See <xref linkend="nichardware" />.
|
---|
| 1476 | </para><para>
|
---|
| 1477 | Valid values are as follows:
|
---|
| 1478 | </para><itemizedlist>
|
---|
| 1479 | <listitem><para>
|
---|
| 1480 | <literal>Am79C970A</literal> represents the AMD PCNet
|
---|
| 1481 | PCI II.
|
---|
| 1482 | </para></listitem>
|
---|
| 1483 | <listitem><para>
|
---|
| 1484 | <literal>Am79C973</literal> represents the AMD PCNet
|
---|
| 1485 | FAST III, which is the default value.
|
---|
| 1486 | </para></listitem>
|
---|
| 1487 | <listitem><para>
|
---|
| 1488 | <literal>82540EM</literal> represents the Intel
|
---|
| 1489 | PRO/1000 MT Desktop.
|
---|
| 1490 | </para></listitem>
|
---|
| 1491 | <listitem><para>
|
---|
| 1492 | <literal>82543GC</literal> represents the Intel
|
---|
| 1493 | PRO/1000 T Server.
|
---|
| 1494 | </para></listitem>
|
---|
| 1495 | <listitem><para>
|
---|
| 1496 | <literal>82545EM</literal> represents the Intel
|
---|
| 1497 | PRO/1000 MT Server.
|
---|
| 1498 | </para></listitem>
|
---|
| 1499 | <listitem><para>
|
---|
| 1500 | <literal>virtio</literal> represents a paravirtualized
|
---|
| 1501 | network adapter.
|
---|
| 1502 | </para></listitem>
|
---|
| 1503 | </itemizedlist></listitem>
|
---|
| 1504 | </varlistentry>
|
---|
| 1505 | <varlistentry>
|
---|
[92534] | 1506 | <term><option>--cable-connected<replaceable>N</replaceable>=on | off</option></term>
|
---|
[82044] | 1507 | <listitem><para>
|
---|
| 1508 | Temporarily disconnects a virtual network interface, as if
|
---|
| 1509 | you pull a network cable from a physical network card. You
|
---|
| 1510 | might use this option to reset certain software components
|
---|
| 1511 | in the VM.
|
---|
| 1512 | </para></listitem>
|
---|
| 1513 | </varlistentry>
|
---|
| 1514 | <varlistentry>
|
---|
[92534] | 1515 | <term><option>--nic-trace<replaceable>N</replaceable>=on | off</option></term>
|
---|
[82044] | 1516 | <listitem><para>
|
---|
| 1517 | Enables or disables network tracing for the specified
|
---|
| 1518 | virtual network card.
|
---|
| 1519 | </para></listitem>
|
---|
| 1520 | </varlistentry>
|
---|
| 1521 | <varlistentry>
|
---|
[92534] | 1522 | <term><option>--nic-trace-file<replaceable>N</replaceable>=<replaceable>filename</replaceable></option></term>
|
---|
[82044] | 1523 | <listitem><para>
|
---|
| 1524 | Specifies the absolute path of the file in which to write
|
---|
| 1525 | trace log information. Use this option if network tracing
|
---|
| 1526 | is enabled.
|
---|
| 1527 | </para></listitem>
|
---|
| 1528 | </varlistentry>
|
---|
| 1529 | <varlistentry>
|
---|
[92534] | 1530 | <term><option>--nic-property<replaceable>N</replaceable>=<replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 1531 | <listitem><para>
|
---|
| 1532 | Enables you to set property values and pass them to rarely
|
---|
| 1533 | used network backends. To use this option, you must also
|
---|
[92534] | 1534 | use the <option>--nic-generic-drv</option> option.
|
---|
[82044] | 1535 | </para><para>
|
---|
| 1536 | These properties are specific to the backend engine and
|
---|
| 1537 | differ between the UDP Tunnel and the VDE backend drivers.
|
---|
| 1538 | For property examples, see
|
---|
| 1539 | <xref linkend="network_udp_tunnel" />.
|
---|
| 1540 | </para></listitem>
|
---|
| 1541 | </varlistentry>
|
---|
| 1542 | <varlistentry>
|
---|
[92534] | 1543 | <term><option>--nic-speed<replaceable>N</replaceable>=<replaceable>kbps</replaceable></option></term>
|
---|
[82044] | 1544 | <listitem><para>
|
---|
| 1545 | Specifies the throughput rate in kilobits per second for
|
---|
| 1546 | rarely used networking sub-modes such as VDE network and
|
---|
| 1547 | UDP Tunnel. Use this option only if you used the
|
---|
| 1548 | <option>--nic</option> option to enable generic networking
|
---|
| 1549 | for the specified virtual network card.
|
---|
| 1550 | </para></listitem>
|
---|
| 1551 | </varlistentry>
|
---|
| 1552 | <varlistentry>
|
---|
[92534] | 1553 | <term><option>--nic-boot-prio<replaceable>N</replaceable>=<replaceable>priority</replaceable></option></term>
|
---|
[82044] | 1554 | <listitem><para>
|
---|
| 1555 | Assigns a priority to each NIC that determines the order
|
---|
| 1556 | in which that NIC is used to perform a PXE network boot.
|
---|
| 1557 | The priority value is an integer in the range from
|
---|
| 1558 | <literal>0</literal> to <literal>4</literal>. Priority
|
---|
| 1559 | <literal>0</literal>, which is the default value, is the
|
---|
| 1560 | lowest priority. Priority <literal>1</literal> is the
|
---|
| 1561 | highest priority, and priorities <literal>3</literal> and
|
---|
| 1562 | <literal>4</literal> are lower.
|
---|
| 1563 | </para><para>
|
---|
| 1564 | This option has an effect only when using the Intel PXE
|
---|
| 1565 | boot ROM.
|
---|
| 1566 | </para></listitem>
|
---|
| 1567 | </varlistentry>
|
---|
| 1568 | <varlistentry>
|
---|
[92534] | 1569 | <term><option>--nic-promisc<replaceable>N</replaceable>=deny | allow-vms | allow-all</option></term>
|
---|
[82044] | 1570 | <listitem><para>
|
---|
| 1571 | Enables you to specify whether to deny or allow
|
---|
| 1572 | promiscuous mode for the specified VM virtual network
|
---|
| 1573 | card. This option is relevant only for bridged networking.
|
---|
| 1574 | Valid values are as follows:
|
---|
| 1575 | </para><itemizedlist>
|
---|
| 1576 | <listitem><para>
|
---|
| 1577 | <literal>deny</literal> hides any traffic that is not
|
---|
| 1578 | intended for the VM. This is the default value.
|
---|
| 1579 | </para></listitem>
|
---|
| 1580 | <listitem><para>
|
---|
| 1581 | <literal>allow-vms</literal> hides all host traffic
|
---|
| 1582 | from the VM, but allows the VM to see traffic to and
|
---|
| 1583 | from other VMs.
|
---|
| 1584 | </para></listitem>
|
---|
| 1585 | <listitem><para>
|
---|
| 1586 | <literal>allow-all</literal> allows the VM to see all
|
---|
| 1587 | traffic.
|
---|
| 1588 | </para></listitem>
|
---|
| 1589 | </itemizedlist></listitem>
|
---|
| 1590 | </varlistentry>
|
---|
| 1591 | <varlistentry>
|
---|
[92534] | 1592 | <term><option>--nic-bandwidth-group<replaceable>N</replaceable>=none | <replaceable>name</replaceable></option></term>
|
---|
[82044] | 1593 | <listitem><para>
|
---|
| 1594 | Adds or removes a bandwidth group assignment to the
|
---|
| 1595 | specified virtual network interface. Valid values are as
|
---|
| 1596 | follows:
|
---|
| 1597 | </para><itemizedlist>
|
---|
| 1598 | <listitem><para>
|
---|
| 1599 | <literal>none</literal> removes any current bandwidth
|
---|
| 1600 | group assignment from the specified virtual network
|
---|
| 1601 | interface.
|
---|
| 1602 | </para></listitem>
|
---|
| 1603 | <listitem><para>
|
---|
| 1604 | <replaceable>name</replaceable> adds a bandwidth group
|
---|
| 1605 | assignment to the specified virtual network interface.
|
---|
| 1606 | </para></listitem>
|
---|
| 1607 | </itemizedlist><para>
|
---|
| 1608 | See <xref linkend="network_bandwidth_limit" />.
|
---|
| 1609 | </para></listitem>
|
---|
| 1610 | </varlistentry>
|
---|
| 1611 | <varlistentry>
|
---|
[92534] | 1612 | <term><option>--bridge-adapter<replaceable>N</replaceable>=none | <replaceable>device-name</replaceable></option></term>
|
---|
[82044] | 1613 | <listitem><para>
|
---|
| 1614 | Specifies the host interface to use for the specified
|
---|
| 1615 | virtual network interface. See
|
---|
| 1616 | <xref linkend="network_bridged" />. Use this option only
|
---|
| 1617 | if you used the <option>--nic</option> option to enable
|
---|
| 1618 | bridged networking for the specified virtual network card.
|
---|
| 1619 | </para></listitem>
|
---|
| 1620 | </varlistentry>
|
---|
| 1621 | <varlistentry>
|
---|
[92534] | 1622 | <term><option>--host-only-adapter<replaceable>N</replaceable>=none | <replaceable>device-name</replaceable></option></term>
|
---|
[82044] | 1623 | <listitem><para>
|
---|
| 1624 | Specifies which host-only networking interface to use for
|
---|
| 1625 | the specified virtual network interface. See
|
---|
| 1626 | <xref linkend="network_hostonly" />. Use this option only
|
---|
| 1627 | if you used the <option>--nic</option> option to enable
|
---|
| 1628 | host-only networking for the specified virtual network
|
---|
| 1629 | card.
|
---|
| 1630 | </para></listitem>
|
---|
| 1631 | </varlistentry>
|
---|
| 1632 | <varlistentry>
|
---|
| 1633 | <term><option>--intnet<replaceable>N</replaceable>=<replaceable>network-name</replaceable></option></term>
|
---|
| 1634 | <listitem><para>
|
---|
| 1635 | Specifies the name of the internal network. See
|
---|
| 1636 | <xref linkend="network_internal" />. Use this option only
|
---|
| 1637 | if you used the <option>--nic</option> option to enable
|
---|
| 1638 | internal networking for the specified virtual network
|
---|
| 1639 | card.
|
---|
| 1640 | </para></listitem>
|
---|
| 1641 | </varlistentry>
|
---|
| 1642 | <varlistentry>
|
---|
| 1643 | <term><option>--nat-network<replaceable>N</replaceable>=<replaceable>network-name</replaceable></option></term>
|
---|
| 1644 | <listitem><para>
|
---|
| 1645 | Specifies the name of the NAT network to which this
|
---|
| 1646 | adapter is connected. Use this option only if the
|
---|
| 1647 | networking type is <literal>natnetwork</literal>, not
|
---|
| 1648 | <literal>nat</literal>.
|
---|
| 1649 | </para></listitem>
|
---|
| 1650 | </varlistentry>
|
---|
| 1651 | <varlistentry>
|
---|
[92534] | 1652 | <term><option>--nic-generic-drv<replaceable>N</replaceable>=<replaceable>backend-driver</replaceable></option></term>
|
---|
[82044] | 1653 | <listitem><para>
|
---|
| 1654 | Enables you to access rarely used networking sub-modes,
|
---|
| 1655 | such as VDE networks and UDP Tunnel. Use this option only
|
---|
| 1656 | if you used the <option>--nic</option> option to enable
|
---|
| 1657 | generic networking for a virtual network card.
|
---|
| 1658 | </para></listitem>
|
---|
| 1659 | </varlistentry>
|
---|
| 1660 | <varlistentry>
|
---|
[92534] | 1661 | <term><option>--mac-address<replaceable>N</replaceable>=auto | <replaceable>MAC-address</replaceable></option></term>
|
---|
[82044] | 1662 | <listitem><para>
|
---|
| 1663 | Specifies the MAC address of the specified network adapter
|
---|
| 1664 | on the VM. By default, &product-name; assigns a random MAC
|
---|
| 1665 | address to each network adapter at VM creation.
|
---|
| 1666 | </para></listitem>
|
---|
| 1667 | </varlistentry>
|
---|
| 1668 | </variablelist>
|
---|
| 1669 | </refsect2>
|
---|
| 1670 | <refsect2 id="vboxmanage-modifyvm-networking-nat">
|
---|
| 1671 | <title>NAT Networking Settings</title>
|
---|
| 1672 | <remark role="help-copy-synopsis"/>
|
---|
| 1673 | <para>
|
---|
| 1674 | The following options use <replaceable>N</replaceable> to
|
---|
| 1675 | specify the particular virtual network adapter to modify.
|
---|
| 1676 | </para>
|
---|
| 1677 | <variablelist>
|
---|
| 1678 | <varlistentry>
|
---|
[92534] | 1679 | <term><option>--nat-net<replaceable>N</replaceable>=default | <replaceable>network</replaceable></option></term>
|
---|
[82044] | 1680 | <listitem><para>
|
---|
| 1681 | Specifies the IP address range to use for this network.
|
---|
| 1682 | See <xref linkend="changenat" />. Use this option only if
|
---|
| 1683 | the networking type is <literal>nat</literal>, not
|
---|
| 1684 | <literal>natnetwork</literal>.
|
---|
| 1685 | </para></listitem>
|
---|
| 1686 | </varlistentry>
|
---|
| 1687 | <varlistentry>
|
---|
[92534] | 1688 | <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>
|
---|
[82044] | 1689 | <listitem><para>
|
---|
| 1690 | Specifies the NAT port-forwarding rule to use. See
|
---|
| 1691 | <xref linkend="natforward" />.
|
---|
| 1692 | </para></listitem>
|
---|
| 1693 | </varlistentry>
|
---|
| 1694 | <varlistentry>
|
---|
[92534] | 1695 | <term><option>--nat-pf<replaceable>N</replaceable>=delete <replaceable>name</replaceable></option></term>
|
---|
[82044] | 1696 | <listitem><para>
|
---|
| 1697 | Specifies the NAT port-forwarding rule to delete. See
|
---|
| 1698 | <xref linkend="natforward" />.
|
---|
| 1699 | </para></listitem>
|
---|
| 1700 | </varlistentry>
|
---|
| 1701 | <varlistentry>
|
---|
[92534] | 1702 | <term><option>--nat-tftp-prefix<replaceable>N</replaceable>=<replaceable>prefix</replaceable></option></term>
|
---|
[82044] | 1703 | <listitem><para>
|
---|
| 1704 | Specifies a prefix to use for the built-in TFTP server.
|
---|
| 1705 | For example, you might use a prefix to indicate where the
|
---|
| 1706 | boot file is located. See <xref linkend="nat-tftp" /> and
|
---|
| 1707 | <xref linkend="nat-adv-tftp" />.
|
---|
| 1708 | </para></listitem>
|
---|
| 1709 | </varlistentry>
|
---|
| 1710 | <varlistentry>
|
---|
[92534] | 1711 | <term><option>--nat-tftp-file<replaceable>N</replaceable>=<replaceable>boot-file</replaceable></option></term>
|
---|
[82044] | 1712 | <listitem><para>
|
---|
| 1713 | Specifies the name of the TFT boot file. See
|
---|
| 1714 | <xref linkend="nat-adv-tftp" />.
|
---|
| 1715 | </para></listitem>
|
---|
| 1716 | </varlistentry>
|
---|
| 1717 | <varlistentry>
|
---|
[92534] | 1718 | <term><option>--nat-tftp-server<replaceable>N</replaceable>=<replaceable>tftp-server</replaceable></option></term>
|
---|
[82044] | 1719 | <listitem><para>
|
---|
| 1720 | Specifies the address of the TFTP server from which to
|
---|
| 1721 | boot. See <xref linkend="nat-adv-tftp" />.
|
---|
| 1722 | </para></listitem>
|
---|
| 1723 | </varlistentry>
|
---|
| 1724 | <varlistentry>
|
---|
[92534] | 1725 | <term><option>--nat-bind-ip<replaceable>N</replaceable>=<replaceable>IP-address</replaceable></option></term>
|
---|
[82044] | 1726 | <listitem><para>
|
---|
| 1727 | Specifies an alternate IP address to which the NAT engine
|
---|
| 1728 | binds. See <xref linkend="nat-adv-settings" />. By
|
---|
| 1729 | default, &product-name;'s NAT engine routes TCP/IP packets
|
---|
| 1730 | through the default interface assigned by the host's
|
---|
| 1731 | TCP/IP stack.
|
---|
| 1732 | </para></listitem>
|
---|
| 1733 | </varlistentry>
|
---|
| 1734 | <varlistentry>
|
---|
[92534] | 1735 | <term><option>--nat-dns-pass-domain<replaceable>N</replaceable>=on | off</option></term>
|
---|
[82044] | 1736 | <listitem><para>
|
---|
| 1737 | Specifies whether the built-in DHCP server passes the
|
---|
| 1738 | domain name for network name resolution.
|
---|
| 1739 | </para></listitem>
|
---|
| 1740 | </varlistentry>
|
---|
| 1741 | <varlistentry>
|
---|
[92534] | 1742 | <term><option>--nat-dns-proxy<replaceable>N</replaceable>=on | off</option></term>
|
---|
[82044] | 1743 | <listitem><para>
|
---|
| 1744 | Specifies whether the NAT engine is the proxy for all
|
---|
| 1745 | guest DNS requests to the host system's DNS servers. See
|
---|
| 1746 | <xref linkend="nat-adv-dns" />.
|
---|
| 1747 | </para></listitem>
|
---|
| 1748 | </varlistentry>
|
---|
| 1749 | <varlistentry>
|
---|
[92534] | 1750 | <term><option>--nat-dns-host-resolver<replaceable>N</replaceable>=on | off</option></term>
|
---|
[82044] | 1751 | <listitem><para>
|
---|
| 1752 | Specifies whether the NAT engine uses the host system's
|
---|
| 1753 | resolver mechanisms to handle DNS requests. See
|
---|
| 1754 | <xref linkend="nat-adv-dns" />.
|
---|
| 1755 | </para></listitem>
|
---|
| 1756 | </varlistentry>
|
---|
| 1757 | <varlistentry>
|
---|
[92534] | 1758 | <term><option>--nat-localhostreachable<replaceable>N</replaceable>=on | off</option></term>
|
---|
[92133] | 1759 | <listitem><para>
|
---|
| 1760 | Specifies whether the NAT engine allows traffic from the guest directed to
|
---|
| 1761 | 10.0.2.2 to pass to the host's loopback interface, i.e. localhost or 127.0.0.1.
|
---|
| 1762 | </para></listitem>
|
---|
| 1763 | </varlistentry>
|
---|
| 1764 | <varlistentry>
|
---|
[92534] | 1765 | <term><option>--nat-settings<replaceable>N</replaceable>=[<replaceable>mtu</replaceable>],[<replaceable>socksnd</replaceable>],[<replaceable>sockrcv</replaceable>],[<replaceable>tcpsnd</replaceable>],[<replaceable>tcprcv</replaceable>]</option></term>
|
---|
[82044] | 1766 | <listitem><para>
|
---|
| 1767 | Specifies values for tuning NAT performance. See
|
---|
| 1768 | <xref linkend="nat-adv-settings" />.
|
---|
| 1769 | </para></listitem>
|
---|
| 1770 | </varlistentry>
|
---|
| 1771 | <varlistentry>
|
---|
[92534] | 1772 | <term><option>--nat-alias-mode<replaceable>N</replaceable>=default | [log],[proxyonly],[sameports]</option></term>
|
---|
[82044] | 1773 | <listitem><para>
|
---|
| 1774 | Specifies the behavior of the NAT engine core as follows:
|
---|
| 1775 | </para><itemizedlist>
|
---|
| 1776 | <listitem><para>
|
---|
| 1777 | <literal>log</literal> enables logging
|
---|
| 1778 | </para></listitem>
|
---|
| 1779 | <listitem><para>
|
---|
| 1780 | <literal>proxyonly</literal> switches off aliasing
|
---|
| 1781 | mode and makes NAT transparent
|
---|
| 1782 | </para></listitem>
|
---|
| 1783 | <listitem><para>
|
---|
| 1784 | <literal>sameports</literal> enforces that the NAT
|
---|
| 1785 | engine sends packets through the same port on which
|
---|
| 1786 | they originated
|
---|
| 1787 | </para></listitem>
|
---|
| 1788 | <listitem><para>
|
---|
| 1789 | <literal>default</literal> disables all aliasing modes
|
---|
| 1790 | </para></listitem>
|
---|
| 1791 | </itemizedlist><para>
|
---|
| 1792 | For more information, see
|
---|
| 1793 | <xref linkend="nat-adv-alias" />.
|
---|
| 1794 | </para></listitem>
|
---|
| 1795 | </varlistentry>
|
---|
| 1796 | </variablelist>
|
---|
| 1797 | </refsect2>
|
---|
| 1798 | <refsect2 id="vboxmanage-modifyvm-other-hardware">
|
---|
| 1799 | <title>Other Hardware Settings</title>
|
---|
| 1800 | <remark role="help-copy-synopsis"/>
|
---|
| 1801 | <para>
|
---|
| 1802 | The following options enable you to configure other hardware,
|
---|
| 1803 | such as the serial port, monitor, audio device, USB ports, and
|
---|
| 1804 | the clipboard, and drag-and-drop features.
|
---|
| 1805 | </para>
|
---|
| 1806 | <variablelist>
|
---|
| 1807 | <varlistentry>
|
---|
[95368] | 1808 | <term><option>--mouse=ps2 | usb | usbtablet | usbmultitouch | usbmtscreenpluspad</option></term>
|
---|
[82044] | 1809 | <listitem><para>
|
---|
| 1810 | Specifies the mode of the mouse to use in the VM. Valid
|
---|
| 1811 | values are: <literal>ps2</literal>,
|
---|
[95368] | 1812 | <literal>usb</literal>, <literal>usbtablet</literal>,
|
---|
| 1813 | <literal>usbmultitouch</literal> and
|
---|
| 1814 | <literal>usbmtscreenpluspad</literal>.
|
---|
[82044] | 1815 | </para></listitem>
|
---|
| 1816 | </varlistentry>
|
---|
| 1817 | <varlistentry>
|
---|
| 1818 | <term><option>--keyboard=ps2 | usb</option></term>
|
---|
| 1819 | <listitem><para>
|
---|
| 1820 | Specifies the mode of the keyboard to use in the VM. Valid
|
---|
| 1821 | values are: <literal>ps2</literal> and
|
---|
| 1822 | <literal>usb</literal>.
|
---|
| 1823 | </para></listitem>
|
---|
| 1824 | </varlistentry>
|
---|
| 1825 | <varlistentry>
|
---|
| 1826 | <term><option>--uart<replaceable>N</replaceable>=off | <replaceable>I/O-base</replaceable> <replaceable>IRQ</replaceable></option></term>
|
---|
| 1827 | <listitem><para>
|
---|
| 1828 | Configures virtual serial ports for the VM.
|
---|
| 1829 | <replaceable>N</replaceable> represents the serial port to
|
---|
| 1830 | modify. Valid values are <literal>off</literal> to disable
|
---|
| 1831 | the port or an I/O base address and IRQ. For information
|
---|
| 1832 | about the traditional COM port I/O base address and IRQ
|
---|
| 1833 | values, see <xref linkend="serialports" />.
|
---|
| 1834 | </para></listitem>
|
---|
| 1835 | </varlistentry>
|
---|
| 1836 | <varlistentry>
|
---|
[92534] | 1837 | <term><option>--uart-mode<replaceable>N</replaceable>=<replaceable>mode</replaceable></option></term>
|
---|
[82044] | 1838 | <listitem><para>
|
---|
| 1839 | Specifies how &product-name; connects the specified
|
---|
| 1840 | virtual serial port to the host system that runs the VM.
|
---|
| 1841 | See <xref linkend="serialports" />.
|
---|
| 1842 | </para><para>
|
---|
| 1843 | Ensure that you first configure the virtual serial port by
|
---|
| 1844 | using the
|
---|
| 1845 | <option>--uart<replaceable>N</replaceable></option>
|
---|
| 1846 | option.
|
---|
| 1847 | </para><para>
|
---|
| 1848 | Specify one of the following connection modes for each
|
---|
| 1849 | port:
|
---|
| 1850 | </para><itemizedlist>
|
---|
| 1851 | <listitem><para>
|
---|
| 1852 | <literal>disconnected</literal> indicates that even
|
---|
| 1853 | though the serial port is shown to the guest VM, it is
|
---|
| 1854 | not connected. This state is like a physical COM port
|
---|
| 1855 | without a cable attached.
|
---|
| 1856 | </para></listitem>
|
---|
| 1857 | <listitem><para>
|
---|
| 1858 | <literal>server</literal>
|
---|
| 1859 | <replaceable>pipe-name</replaceable> creates the
|
---|
| 1860 | specified named pipe or local domain socket on the
|
---|
| 1861 | host system and connects the virtual serial device to
|
---|
| 1862 | it.
|
---|
| 1863 | </para><para>
|
---|
| 1864 | On a Windows host system,
|
---|
| 1865 | <replaceable>pipe-name</replaceable> is a named pipe
|
---|
| 1866 | that has a name that uses the following form:
|
---|
[93477] | 1867 | <literal>\\.\pipe\<replaceable>pipe-name</replaceable></literal>.
|
---|
[82044] | 1868 | </para><para>
|
---|
| 1869 | On a Linux host system,
|
---|
| 1870 | <replaceable>pipe-name</replaceable> is a local domain
|
---|
| 1871 | socket.
|
---|
| 1872 | </para></listitem>
|
---|
| 1873 | <listitem><para>
|
---|
| 1874 | <literal>client</literal>
|
---|
| 1875 | <replaceable>pipe-name</replaceable> connects the
|
---|
| 1876 | virtual serial device to the specified named pipe or
|
---|
| 1877 | local domain socket.
|
---|
| 1878 | </para><para>
|
---|
| 1879 | Note that the named pipe or local domain socket must
|
---|
| 1880 | already exist.
|
---|
| 1881 | </para></listitem>
|
---|
| 1882 | <listitem><para>
|
---|
| 1883 | <literal>tcpserver</literal>
|
---|
| 1884 | <replaceable>port</replaceable> creates a TCP socket
|
---|
| 1885 | with the specified TCP port on the host system and
|
---|
| 1886 | connects the virtual serial device to it.
|
---|
| 1887 | </para><para>
|
---|
| 1888 | For UNIX-like systems, use ports over 1024 for
|
---|
| 1889 | non-root users.
|
---|
| 1890 | </para></listitem>
|
---|
| 1891 | <listitem><para>
|
---|
| 1892 | <literal>tcpclient</literal>
|
---|
| 1893 | <replaceable>hostname</replaceable>:<replaceable>port</replaceable>
|
---|
| 1894 | connects the virtual serial device to the TCP socket.
|
---|
| 1895 | </para><para>
|
---|
| 1896 | Note that the TCP socket must already exist.
|
---|
| 1897 | </para></listitem>
|
---|
| 1898 | <listitem><para>
|
---|
| 1899 | <literal>file</literal>
|
---|
| 1900 | <replaceable>filename</replaceable> redirects the
|
---|
| 1901 | serial port output to the specified raw file. Ensure
|
---|
| 1902 | that <replaceable>filename</replaceable> is the
|
---|
[91204] | 1903 | absolute path of the file on the host system.
|
---|
[82044] | 1904 | </para></listitem>
|
---|
| 1905 | <listitem><para>
|
---|
| 1906 | <replaceable>device-name</replaceable>: specifies the
|
---|
| 1907 | device name of a physical hardware serial port on the
|
---|
| 1908 | specified host system to which the virtual serial port
|
---|
| 1909 | connects.
|
---|
| 1910 | </para><para>
|
---|
| 1911 | Use this mode to connect a physical serial port to a
|
---|
| 1912 | VM.
|
---|
| 1913 | </para><para>
|
---|
| 1914 | On a Windows host system, the device name is a COM
|
---|
| 1915 | port such as <literal>COM1</literal>. On a Linux host
|
---|
| 1916 | system, the device name is similar to
|
---|
| 1917 | <filename>/dev/ttyS0</filename>.
|
---|
| 1918 | </para></listitem>
|
---|
| 1919 | </itemizedlist></listitem>
|
---|
| 1920 | </varlistentry>
|
---|
| 1921 | <varlistentry>
|
---|
[92534] | 1922 | <term><option>--uart-type<replaceable>N</replaceable>=<replaceable>UART-type</replaceable></option></term>
|
---|
[82044] | 1923 | <listitem><para>
|
---|
| 1924 | Configures the UART type for the specified virtual serial
|
---|
| 1925 | port (<replaceable>N</replaceable>). Valid values are
|
---|
| 1926 | <literal>16450</literal>, <literal>16550A</literal>, and
|
---|
| 1927 | <literal>16750</literal>. The default value is
|
---|
| 1928 | <literal>16550A</literal>.
|
---|
| 1929 | </para></listitem>
|
---|
| 1930 | </varlistentry>
|
---|
| 1931 | <varlistentry>
|
---|
[92534] | 1932 | <term><option>--lpt-mode<replaceable>N</replaceable>=<replaceable>device-name</replaceable></option></term>
|
---|
[82044] | 1933 | <listitem><para>
|
---|
| 1934 | Specifies the device name of the parallel port to use.
|
---|
| 1935 | </para><para>
|
---|
| 1936 | For a Windows host system, use a device name such as
|
---|
| 1937 | <command>lpt1</command>. For a Linux host system, use a
|
---|
| 1938 | device name such as <filename>/dev/lp0</filename>.
|
---|
| 1939 | </para></listitem>
|
---|
| 1940 | </varlistentry>
|
---|
| 1941 | <varlistentry>
|
---|
| 1942 | <term><option>--lpt<replaceable>N</replaceable>=<replaceable>I/O-base</replaceable> <replaceable>IRQ</replaceable></option></term>
|
---|
| 1943 | <listitem><para>
|
---|
| 1944 | Specifies the I/O base address and IRQ of the parallel
|
---|
[91204] | 1945 | port.
|
---|
[82044] | 1946 | </para><para>
|
---|
| 1947 | You can view the I/O base address and IRQ that the VM uses
|
---|
| 1948 | for the parallel port in the Device Manager.
|
---|
| 1949 | </para></listitem>
|
---|
| 1950 | </varlistentry>
|
---|
| 1951 | <varlistentry>
|
---|
[92534] | 1952 | <term><option>--audio-controller=<replaceable>controller-type</replaceable></option></term>
|
---|
[82044] | 1953 | <listitem><para>
|
---|
| 1954 | Specifies the audio controller to be used with the VM.
|
---|
| 1955 | Valid audio controller type values are:
|
---|
| 1956 | <literal>ac97</literal>, <literal>hda</literal>, and
|
---|
| 1957 | <literal>sb16</literal>.
|
---|
| 1958 | </para></listitem>
|
---|
| 1959 | </varlistentry>
|
---|
| 1960 | <varlistentry>
|
---|
[92534] | 1961 | <term><option>--audio-codec=<replaceable>codec-type</replaceable></option></term>
|
---|
[82044] | 1962 | <listitem><para>
|
---|
| 1963 | Specifies the audio codec to be used with the VM. Valid
|
---|
| 1964 | audio codec type values are: <literal>stac9700</literal>,
|
---|
| 1965 | <literal>ad1980</literal>, <literal>stac9221</literal>,
|
---|
| 1966 | and <literal>sb16</literal>.
|
---|
| 1967 | </para></listitem>
|
---|
| 1968 | </varlistentry>
|
---|
| 1969 | <varlistentry>
|
---|
[98032] | 1970 | <term><option>--audio-driver=<replaceable>type</replaceable></option></term>
|
---|
| 1971 | <listitem><para>
|
---|
| 1972 | Specifies whether which audio driver (backend) to use.
|
---|
| 1973 | <literal>none</literal>, <literal>default</literal>,
|
---|
| 1974 | <literal>null</literal>, <literal>dsound</literal>,
|
---|
| 1975 | <literal>was</literal>, <literal>oss</literal>,
|
---|
| 1976 | <literal>alsa</literal>, <literal>pulse</literal>, and
|
---|
| 1977 | <literal>coreaudio</literal>.
|
---|
| 1978 | </para><para>
|
---|
| 1979 | Note that the audio driver are dependent on the host
|
---|
| 1980 | operating system. Use the <command>VBoxManage
|
---|
| 1981 | modifyvm</command> command usage output to determine the
|
---|
| 1982 | supported audio types for your host system.
|
---|
| 1983 | </para>
|
---|
| 1984 | <para>
|
---|
| 1985 | For maximum interoperability between hosts, the default
|
---|
| 1986 | audio driver can be used. The VM will then automatically select
|
---|
| 1987 | the most appropriate audio driver for the current host available.
|
---|
| 1988 | </para></listitem>
|
---|
| 1989 | </varlistentry>
|
---|
| 1990 | <varlistentry>
|
---|
| 1991 | <term><option>--audio-enabled=on|off</option></term>
|
---|
| 1992 | <listitem><para>
|
---|
| 1993 | Specifies whether to enable or disable audio for the VM.
|
---|
| 1994 | </para>
|
---|
| 1995 | <para>
|
---|
| 1996 | This option has precedence over the --audio-on and --audio-off
|
---|
| 1997 | options, i.e. turning off audio via this option will turn off
|
---|
| 1998 | both, input and output, audio.
|
---|
| 1999 | </para></listitem>
|
---|
| 2000 | </varlistentry>
|
---|
| 2001 | <varlistentry>
|
---|
[92534] | 2002 | <term><option>--audio-in=on|off</option></term>
|
---|
[82044] | 2003 | <listitem><para>
|
---|
| 2004 | Specifies whether to enable or disable audio capture from
|
---|
| 2005 | the host system.
|
---|
| 2006 | </para></listitem>
|
---|
| 2007 | </varlistentry>
|
---|
| 2008 | <varlistentry>
|
---|
[92534] | 2009 | <term><option>--audio-out=on|off</option></term>
|
---|
[82044] | 2010 | <listitem><para>
|
---|
| 2011 | Specifies whether to enable or disable audio playback from
|
---|
| 2012 | the guest VM.
|
---|
| 2013 | </para></listitem>
|
---|
| 2014 | </varlistentry>
|
---|
| 2015 | <varlistentry>
|
---|
[91204] | 2016 | <term><option>--clipboard-mode=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2017 | <listitem><para>
|
---|
| 2018 | Specifies how to share the guest VM or host system OS's
|
---|
| 2019 | clipboard with the host system or guest VM, respectively.
|
---|
| 2020 | Valid values are: <literal>disabled</literal>,
|
---|
| 2021 | <literal>hosttoguest</literal>,
|
---|
| 2022 | <literal>guesttohost</literal>, and
|
---|
| 2023 | <literal>bidirectional</literal>. See
|
---|
| 2024 | <xref linkend="generalsettings" />.
|
---|
| 2025 | </para><para>
|
---|
| 2026 | The clipboard feature is available only if you have the
|
---|
| 2027 | Guest Additions be installed in the VM.
|
---|
| 2028 | </para></listitem>
|
---|
| 2029 | </varlistentry>
|
---|
| 2030 | <varlistentry>
|
---|
[99959] | 2031 | <term><option>--clipboard-file-transfers=<replaceable>value</replaceable></option></term>
|
---|
| 2032 | <listitem><para>
|
---|
| 2033 | Specifies whether file transfers via clipboard between
|
---|
| 2034 | the guest VM and the host are enabled or not.
|
---|
| 2035 | Valid values are: <literal>disabled</literal>,
|
---|
| 2036 | <literal>enabled</literal>. Depends on the current
|
---|
| 2037 | clipboard mode being set.
|
---|
| 2038 | </para><para>
|
---|
| 2039 | This clipboard file transfer feature is available only if you have the
|
---|
| 2040 | Guest Additions be installed in the VM.
|
---|
| 2041 | </para></listitem>
|
---|
| 2042 | </varlistentry>
|
---|
| 2043 | <varlistentry>
|
---|
[92534] | 2044 | <term><option>--drag-and-drop=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2045 | <listitem><para>
|
---|
| 2046 | Specifies how to use the drag and drop feature between the
|
---|
| 2047 | host system and the VM. Valid values are:
|
---|
| 2048 | <literal>disabled</literal>,
|
---|
| 2049 | <literal>hosttoguest</literal>,
|
---|
| 2050 | <literal>guesttohost</literal>, and
|
---|
| 2051 | <literal>bidirectional</literal>. See
|
---|
| 2052 | <xref linkend="guestadd-dnd" />.
|
---|
| 2053 | </para><para>
|
---|
| 2054 | The drag and drop feature is available only if you have
|
---|
| 2055 | the Guest Additions be installed in the VM.
|
---|
| 2056 | </para></listitem>
|
---|
| 2057 | </varlistentry>
|
---|
| 2058 | <varlistentry>
|
---|
[92534] | 2059 | <term><option>--monitor-count=<replaceable>count</replaceable></option></term>
|
---|
[82044] | 2060 | <listitem><para>
|
---|
| 2061 | Enables you to configure multiple monitors. See
|
---|
| 2062 | <xref linkend="settings-display" />.
|
---|
| 2063 | </para></listitem>
|
---|
| 2064 | </varlistentry>
|
---|
| 2065 | <varlistentry>
|
---|
[92534] | 2066 | <term><option>--usb-ohci=on | off</option></term>
|
---|
[82044] | 2067 | <listitem><para>
|
---|
| 2068 | Enables or disables the VM's virtual USB 1.1 controller.
|
---|
| 2069 | See <xref linkend="settings-usb" />.
|
---|
| 2070 | </para></listitem>
|
---|
| 2071 | </varlistentry>
|
---|
| 2072 | <varlistentry>
|
---|
[92534] | 2073 | <term><option>--usb-ehci=on | off</option></term>
|
---|
[82044] | 2074 | <listitem><para>
|
---|
| 2075 | Enables or disables the VM's virtual USB 2.0 controller.
|
---|
| 2076 | See <xref linkend="settings-usb" />.
|
---|
| 2077 | </para></listitem>
|
---|
| 2078 | </varlistentry>
|
---|
| 2079 | <varlistentry>
|
---|
[92534] | 2080 | <term><option>--usb-xhci=on | off</option></term>
|
---|
[82044] | 2081 | <listitem><para>
|
---|
| 2082 | Enables or disables the VM's virtual USB 3.0 controller.
|
---|
[91204] | 2083 | This is the most efficient option if the VM supports it.
|
---|
[82044] | 2084 | See <xref linkend="settings-usb" />.
|
---|
| 2085 | </para></listitem>
|
---|
| 2086 | </varlistentry>
|
---|
| 2087 | <varlistentry>
|
---|
[92534] | 2088 | <term><option>--usb-rename=<replaceable>old-name</replaceable> <replaceable>new-name</replaceable></option></term>
|
---|
[82044] | 2089 | <listitem><para>
|
---|
| 2090 | Rename's the VM's virtual USB controller from
|
---|
| 2091 | <replaceable>old-name</replaceable> to
|
---|
| 2092 | <replaceable>new-name</replaceable>.
|
---|
| 2093 | </para></listitem>
|
---|
| 2094 | </varlistentry>
|
---|
| 2095 | </variablelist>
|
---|
| 2096 | </refsect2>
|
---|
| 2097 | <refsect2 id="vboxmanage-modifyvm-recording">
|
---|
| 2098 | <title>Recording Settings</title>
|
---|
| 2099 | <remark role="help-copy-synopsis"/>
|
---|
| 2100 | <para>
|
---|
| 2101 | The following options enable you to modify settings for video
|
---|
| 2102 | recording, audio recording, or both.
|
---|
| 2103 | </para>
|
---|
| 2104 | <variablelist>
|
---|
| 2105 | <varlistentry>
|
---|
| 2106 | <term><option>--recording=on | off</option></term>
|
---|
| 2107 | <listitem><para>
|
---|
| 2108 | Enables or disables the recording of a VM session into a
|
---|
| 2109 | WebM or VP8 file. When set to <literal>on</literal>,
|
---|
| 2110 | recording begins when the VM session starts.
|
---|
| 2111 | </para></listitem>
|
---|
| 2112 | </varlistentry>
|
---|
| 2113 | <varlistentry>
|
---|
[93707] | 2114 | <term><option>--recording-screens=all | none | <replaceable>screen-ID</replaceable>[,<replaceable>screen-ID</replaceable>...</option></term>
|
---|
[82044] | 2115 | <listitem><para>
|
---|
| 2116 | Enables you to specify the VM screens to record. The
|
---|
| 2117 | recording for each screen is output to its own file. Valid
|
---|
| 2118 | values are: <literal>all</literal>, which records all
|
---|
[93707] | 2119 | screens, <literal>none</literal>, which records no
|
---|
[82044] | 2120 | screens, or one or more specified screens.
|
---|
| 2121 | </para></listitem>
|
---|
| 2122 | </varlistentry>
|
---|
| 2123 | <varlistentry>
|
---|
[92534] | 2124 | <term><option>--recording-file=<replaceable>filename</replaceable></option></term>
|
---|
[82044] | 2125 | <listitem><para>
|
---|
| 2126 | Specifies the name of the file in which to save the
|
---|
| 2127 | recording.
|
---|
| 2128 | </para></listitem>
|
---|
| 2129 | </varlistentry>
|
---|
| 2130 | <varlistentry>
|
---|
[92534] | 2131 | <term><option>--recording-max-size=<replaceable>MB</replaceable></option></term>
|
---|
[82044] | 2132 | <listitem><para>
|
---|
| 2133 | Specifies the maximum size of the recorded video file in
|
---|
| 2134 | megabytes. When the file reaches the specified size,
|
---|
| 2135 | recording stops. If the value is <literal>0</literal>,
|
---|
| 2136 | recording continues until you manually stop recording.
|
---|
| 2137 | </para></listitem>
|
---|
| 2138 | </varlistentry>
|
---|
| 2139 | <varlistentry>
|
---|
[92534] | 2140 | <term><option>--recording-max-time=<replaceable>seconds</replaceable></option></term>
|
---|
[82044] | 2141 | <listitem><para>
|
---|
| 2142 | Specifies the maximum amount of time to record in seconds.
|
---|
| 2143 | When the specified time elapses, recording stops. If the
|
---|
| 2144 | value is <literal>0</literal>, recording continues until
|
---|
| 2145 | you manually stop recording.
|
---|
| 2146 | </para></listitem>
|
---|
| 2147 | </varlistentry>
|
---|
| 2148 | <varlistentry>
|
---|
[92534] | 2149 | <term><option>--recording-opts=<replaceable>keyword</replaceable>=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2150 | <listitem><para>
|
---|
| 2151 | Specifies additional video-recording properties as a
|
---|
| 2152 | comma-separated property keyword-value list. For example,
|
---|
| 2153 | <literal>foo=bar,a=b</literal>.
|
---|
| 2154 | </para><para>
|
---|
| 2155 | Only use this option if you are an advanced user. For
|
---|
| 2156 | information about keywords, see the <citetitle>Oracle VM
|
---|
| 2157 | VirtualBox Programming Guide and Reference</citetitle>.
|
---|
| 2158 | </para></listitem>
|
---|
| 2159 | </varlistentry>
|
---|
| 2160 | <varlistentry>
|
---|
[92534] | 2161 | <term><option>--recording-video-fps=<replaceable>fps</replaceable></option></term>
|
---|
[82044] | 2162 | <listitem><para>
|
---|
| 2163 | Specifies the maximum number of video frames per second
|
---|
| 2164 | (FPS) to record. The recording ignores any frames that
|
---|
| 2165 | have a higher frequency. When you increase the FPS, fewer
|
---|
| 2166 | frames are ignored but the recording and the size of the
|
---|
| 2167 | recording file increases.
|
---|
| 2168 | </para></listitem>
|
---|
| 2169 | </varlistentry>
|
---|
| 2170 | <varlistentry>
|
---|
[92534] | 2171 | <term><option>--recording-video-rate=<replaceable>bit-rate</replaceable></option></term>
|
---|
[82044] | 2172 | <listitem><para>
|
---|
| 2173 | Specifies the bit rate of the video in kilobits per
|
---|
| 2174 | second. When you increase the bit rate, the recording
|
---|
| 2175 | appearance improves and the size of the recording file
|
---|
| 2176 | increases.
|
---|
| 2177 | </para></listitem>
|
---|
| 2178 | </varlistentry>
|
---|
| 2179 | <varlistentry>
|
---|
[92534] | 2180 | <term><option>--recording-video-res=<replaceable>width</replaceable>x<replaceable>height</replaceable></option></term>
|
---|
[82044] | 2181 | <listitem><para>
|
---|
| 2182 | Specifies the video resolution (width and height) of the
|
---|
| 2183 | recorded video in pixels.
|
---|
| 2184 | </para></listitem>
|
---|
| 2185 | </varlistentry>
|
---|
| 2186 | </variablelist>
|
---|
| 2187 | </refsect2>
|
---|
| 2188 | <refsect2 id="vboxmanage-modifyvm-vrde">
|
---|
| 2189 | <title>Remote Machine Settings</title>
|
---|
| 2190 | <remark role="help-copy-synopsis"/>
|
---|
| 2191 | <para>
|
---|
| 2192 | The following options enable you to modify the VirtualBox Remote
|
---|
| 2193 | Desktop Extension (VRDE) behavior.
|
---|
| 2194 | </para>
|
---|
| 2195 | <variablelist>
|
---|
| 2196 | <varlistentry>
|
---|
| 2197 | <term><option>--vrde=on | off</option></term>
|
---|
| 2198 | <listitem><para>
|
---|
| 2199 | Enables or disables the VRDE server.
|
---|
| 2200 | </para></listitem>
|
---|
| 2201 | </varlistentry>
|
---|
| 2202 | <varlistentry>
|
---|
[92534] | 2203 | <term><option>--vrde-property=TCP/Ports=<replaceable>port</replaceable></option></term>
|
---|
[82044] | 2204 | <listitem><para>
|
---|
| 2205 | <replaceable>port</replaceable> is the port or port range
|
---|
| 2206 | to which the VRDE server binds. The
|
---|
| 2207 | <literal>default</literal> or <literal>0</literal> value
|
---|
| 2208 | uses port <literal>3389</literal>, which is the standard
|
---|
| 2209 | RDP port.
|
---|
| 2210 | </para><para>
|
---|
[92534] | 2211 | Also see the <option>--vrde-port</option> option
|
---|
[82044] | 2212 | description.
|
---|
| 2213 | </para></listitem>
|
---|
| 2214 | </varlistentry>
|
---|
| 2215 | <varlistentry>
|
---|
[92534] | 2216 | <term><option>--vrde-property=TCP/Address=<replaceable>IP-address</replaceable></option></term>
|
---|
[82044] | 2217 | <listitem><para>
|
---|
| 2218 | <replaceable>IP-address</replaceable> is the IP address of
|
---|
| 2219 | the host network interface to which the VRDE server binds.
|
---|
| 2220 | When specified, the server accepts connections only on the
|
---|
| 2221 | host network interface at that IP address.
|
---|
| 2222 | </para><para>
|
---|
[92534] | 2223 | Also see the <option>--vrde-address</option> option
|
---|
[82044] | 2224 | description.
|
---|
| 2225 | </para></listitem>
|
---|
| 2226 | </varlistentry>
|
---|
| 2227 | <varlistentry>
|
---|
[92534] | 2228 | <term><option>--vrde-property=VideoChannel/Enabled=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2229 | <listitem><para>
|
---|
| 2230 | Specifies whether the VRDP video channel is on or off.
|
---|
| 2231 | <literal>1</literal> means <literal>on</literal> and
|
---|
| 2232 | <literal>0</literal> means <literal>off</literal>. See
|
---|
| 2233 | <xref linkend="vrde-videochannel" />.
|
---|
| 2234 | </para></listitem>
|
---|
| 2235 | </varlistentry>
|
---|
| 2236 | <varlistentry>
|
---|
[92534] | 2237 | <term><option>--vrde-property=Quality=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2238 | <listitem><para>
|
---|
| 2239 | Specifies a value between 10% and 100%, inclusive, that
|
---|
| 2240 | represents the JPEG compression level on the VRDE server
|
---|
| 2241 | video channel. A lower value produces lower JPEG quality
|
---|
| 2242 | but higher compression. See
|
---|
| 2243 | <xref linkend="vrde-videochannel" />.
|
---|
| 2244 | </para></listitem>
|
---|
| 2245 | </varlistentry>
|
---|
| 2246 | <varlistentry>
|
---|
[92534] | 2247 | <term><option>--vrde-property=DownscaleProtection=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2248 | <listitem><para>
|
---|
| 2249 | Enables or disables the video downscale protection
|
---|
| 2250 | feature. Valid values are <literal>1</literal> to enable
|
---|
| 2251 | the feature and <literal>0</literal> to disable the
|
---|
| 2252 | feature.
|
---|
| 2253 | </para><para>
|
---|
| 2254 | When this feature is enabled, &product-name; determines
|
---|
| 2255 | whether to display the video:
|
---|
| 2256 | </para><itemizedlist>
|
---|
| 2257 | <listitem><para>
|
---|
| 2258 | When the video size equals the size of the shadow
|
---|
| 2259 | buffer, the video is considered to be full screen and
|
---|
| 2260 | is displayed.
|
---|
| 2261 | </para></listitem>
|
---|
| 2262 | <listitem><para>
|
---|
| 2263 | When the video size is between full screen and the
|
---|
| 2264 | downscale threshold, the video is not displayed. Such
|
---|
| 2265 | a video might be an application window, which is
|
---|
| 2266 | unreadable when downscaled.
|
---|
| 2267 | </para></listitem>
|
---|
| 2268 | </itemizedlist><para>
|
---|
| 2269 | When this feature is disabled, an attempt is always made
|
---|
| 2270 | to display a video.
|
---|
| 2271 | </para></listitem>
|
---|
| 2272 | </varlistentry>
|
---|
| 2273 | <varlistentry>
|
---|
[92534] | 2274 | <term><option>--vrde-property=Client/DisableDisplay=1</option></term>
|
---|
[82044] | 2275 | <listitem><para>
|
---|
| 2276 | Disables the display VRDE server feature.
|
---|
| 2277 | </para><para>
|
---|
[93737] | 2278 | To reenable a feature, assign an empty value. For example,
|
---|
[82044] | 2279 | to reenable the display feature, specify the
|
---|
| 2280 | <command>VBoxManage modifyvm
|
---|
[92534] | 2281 | --vrde-property=Client/DisableDisplay=</command> command.
|
---|
[82044] | 2282 | See <xref linkend="vrde-customization" />.
|
---|
| 2283 | </para></listitem>
|
---|
| 2284 | </varlistentry>
|
---|
| 2285 | <varlistentry>
|
---|
[92534] | 2286 | <term><option>--vrde-property=DisableInput=1</option></term>
|
---|
[82044] | 2287 | <listitem><para>
|
---|
| 2288 | Disables the input VRDE server feature.
|
---|
| 2289 | </para></listitem>
|
---|
| 2290 | </varlistentry>
|
---|
| 2291 | <varlistentry>
|
---|
[92534] | 2292 | <term><option>--vrde-property=DisableAudio=1</option></term>
|
---|
[82044] | 2293 | <listitem><para>
|
---|
| 2294 | Disables the audio VRDE server feature.
|
---|
| 2295 | </para></listitem>
|
---|
| 2296 | </varlistentry>
|
---|
| 2297 | <varlistentry>
|
---|
[92534] | 2298 | <term><option>--vrde-property=DisableUSB=1</option></term>
|
---|
[82044] | 2299 | <listitem><para>
|
---|
| 2300 | Disables the USB VRDE server feature.
|
---|
| 2301 | </para></listitem>
|
---|
| 2302 | </varlistentry>
|
---|
| 2303 | <varlistentry>
|
---|
[92534] | 2304 | <term><option>--vrde-property=Client/DisableClipboard=1</option></term>
|
---|
[82044] | 2305 | <listitem><para>
|
---|
| 2306 | Disables the clipboard VRDE server feature. To reenable
|
---|
[93737] | 2307 | the feature, assign an empty value. See
|
---|
[82044] | 2308 | <xref linkend="vrde-customization" />.
|
---|
| 2309 | </para></listitem>
|
---|
| 2310 | </varlistentry>
|
---|
| 2311 | <varlistentry>
|
---|
[92534] | 2312 | <term><option>--vrde-property=DisableUpstreamAudio=1</option></term>
|
---|
[82044] | 2313 | <listitem><para>
|
---|
| 2314 | Disables the upstream audio VRDE server feature. To
|
---|
[93737] | 2315 | reenable the feature, assign an empty value. See
|
---|
[82044] | 2316 | <xref linkend="vrde-customization" />.
|
---|
| 2317 | </para></listitem>
|
---|
| 2318 | </varlistentry>
|
---|
| 2319 | <varlistentry>
|
---|
[92534] | 2320 | <term><option>--vrde-property=Client/DisableRDPDR=1</option></term>
|
---|
[82044] | 2321 | <listitem><para>
|
---|
| 2322 | Disables the RDP device redirection for smart cards VRDE
|
---|
[93737] | 2323 | server feature. To reenable this feature, assign an empty
|
---|
[82044] | 2324 | value.
|
---|
| 2325 | </para></listitem>
|
---|
| 2326 | </varlistentry>
|
---|
| 2327 | <varlistentry>
|
---|
[92534] | 2328 | <term><option>--vrde-property=H3DRedirect/Enabled=1</option></term>
|
---|
[82044] | 2329 | <listitem><para>
|
---|
| 2330 | Enables the 3D redirection VRDE server feature. To disable
|
---|
[93737] | 2331 | this feature, assign an empty value.
|
---|
[82044] | 2332 | </para></listitem>
|
---|
| 2333 | </varlistentry>
|
---|
| 2334 | <varlistentry>
|
---|
[92534] | 2335 | <term><option>--vrde-property=Security/Method=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2336 | <listitem><para>
|
---|
| 2337 | Specifies the following information that is required for a
|
---|
| 2338 | connection:
|
---|
| 2339 | </para><itemizedlist>
|
---|
| 2340 | <listitem><para>
|
---|
| 2341 | <literal>Negotiate</literal> indicates that both
|
---|
| 2342 | Enhanced (TLS) and Standard RDP Security connections
|
---|
| 2343 | are permitted. The security method is negotiated with
|
---|
| 2344 | the client. This is the default value.
|
---|
| 2345 | </para></listitem>
|
---|
| 2346 | <listitem><para>
|
---|
| 2347 | <literal>RDP</literal> indicates that only Standard
|
---|
| 2348 | RDP Security is accepted.
|
---|
| 2349 | </para></listitem>
|
---|
| 2350 | <listitem><para>
|
---|
| 2351 | <literal>TLS</literal> indicates that only Enhanced
|
---|
| 2352 | RDP Security is accepted. The client must support TLS.
|
---|
| 2353 | </para></listitem>
|
---|
| 2354 | </itemizedlist><para>
|
---|
| 2355 | See <xref linkend="vrde-crypt" />.
|
---|
| 2356 | </para></listitem>
|
---|
| 2357 | </varlistentry>
|
---|
| 2358 | <varlistentry>
|
---|
[92534] | 2359 | <term><option>--vrde-property=ServerCertificate=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2360 | <listitem><para>
|
---|
| 2361 | Specifies the absolute path to the server certificate. See
|
---|
| 2362 | <xref linkend="vrde-crypt" />.
|
---|
| 2363 | </para></listitem>
|
---|
| 2364 | </varlistentry>
|
---|
| 2365 | <varlistentry>
|
---|
[92534] | 2366 | <term><option>--vrde-property=ServerPrivateKey=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2367 | <listitem><para>
|
---|
| 2368 | Specifies the absolute path to the server private key. See
|
---|
| 2369 | <xref linkend="vrde-crypt" />.
|
---|
| 2370 | </para></listitem>
|
---|
| 2371 | </varlistentry>
|
---|
| 2372 | <varlistentry>
|
---|
[92534] | 2373 | <term><option>--vrde-property=CACertificate=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2374 | <listitem><para>
|
---|
| 2375 | Specifies the absolute path to the CA self-signed
|
---|
| 2376 | certificate. See <xref linkend="vrde-crypt" />.
|
---|
| 2377 | </para></listitem>
|
---|
| 2378 | </varlistentry>
|
---|
| 2379 | <varlistentry>
|
---|
[92534] | 2380 | <term><option>--vrde-property Audio/RateCorrectionMode=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2381 | <listitem><para>
|
---|
| 2382 | Specifies the audio connection mode or the path to the
|
---|
| 2383 | audio log file. Valid values are as follows:
|
---|
| 2384 | </para><itemizedlist>
|
---|
| 2385 | <listitem><para>
|
---|
| 2386 | <literal>VRDP_AUDIO_MODE_VOID</literal> is no mode.
|
---|
| 2387 | Use this value to unset any set audio mode.
|
---|
| 2388 | </para></listitem>
|
---|
| 2389 | <listitem><para>
|
---|
| 2390 | <literal>VRDP_AUDIO_MODE_RC</literal> is the rate
|
---|
| 2391 | correction mode.
|
---|
| 2392 | </para></listitem>
|
---|
| 2393 | <listitem><para>
|
---|
| 2394 | <literal>VRDP_AUDIO_MODE_LPF</literal> is the low pass
|
---|
| 2395 | filter mode.
|
---|
| 2396 | </para></listitem>
|
---|
| 2397 | <listitem><para>
|
---|
| 2398 | <literal>VRDP_AUDIO_MODE_CS</literal> is the client
|
---|
| 2399 | sync sync mode to prevent an underflow or overflow of
|
---|
| 2400 | the client queue.
|
---|
| 2401 | </para></listitem>
|
---|
| 2402 | </itemizedlist></listitem>
|
---|
| 2403 | </varlistentry>
|
---|
| 2404 | <varlistentry>
|
---|
[92534] | 2405 | <term><option>--vrde-property=LogPath=<replaceable>value</replaceable></option></term>
|
---|
[82044] | 2406 | <listitem><para>
|
---|
| 2407 | Specifies the absolute path to the audio log file.
|
---|
| 2408 | </para></listitem>
|
---|
| 2409 | </varlistentry>
|
---|
| 2410 | <varlistentry>
|
---|
[92534] | 2411 | <term><option>--vrde-extpack=default | <replaceable>name</replaceable></option></term>
|
---|
[82044] | 2412 | <listitem><para>
|
---|
| 2413 | Specifies the library to use to access the VM remotely.
|
---|
| 2414 | The <literal>default</literal> value uses the RDP code
|
---|
| 2415 | that is part of the &product-name; Extension Pack.
|
---|
| 2416 | </para><para>
|
---|
| 2417 | To use the VRDE module in VNC, specify
|
---|
| 2418 | <literal>VNC</literal>. See
|
---|
| 2419 | <xref linkend="otherextpacks"/>.
|
---|
| 2420 | </para></listitem>
|
---|
| 2421 | </varlistentry>
|
---|
| 2422 | <varlistentry>
|
---|
[92534] | 2423 | <term><option>--vrde-port=default | <replaceable>port</replaceable></option></term>
|
---|
[82044] | 2424 | <listitem><para>
|
---|
| 2425 | <replaceable>port</replaceable> is the port or port range
|
---|
| 2426 | to which the VRDE server binds. The
|
---|
| 2427 | <literal>default</literal> or <literal>0</literal> value
|
---|
| 2428 | uses port <literal>3389</literal>, which is the standard
|
---|
| 2429 | RDP port.
|
---|
| 2430 | </para><para>
|
---|
| 2431 | You can specify a comma-separated list of ports or port
|
---|
| 2432 | ranges of ports. Use a dash between two port numbers to
|
---|
| 2433 | specify a port range. The VRDE server binds to only one of
|
---|
| 2434 | the available ports from the list. Only one machine can
|
---|
| 2435 | use a given port at a time. For example, the
|
---|
[92534] | 2436 | <option>--vrde-port=5000,5010-5012</option> option
|
---|
[82044] | 2437 | specifies that server can bind to one of following ports:
|
---|
| 2438 | <literal>5000</literal>, <literal>5010</literal>,
|
---|
| 2439 | <literal>5011</literal>, or <literal>5012</literal>.
|
---|
| 2440 | </para></listitem>
|
---|
| 2441 | </varlistentry>
|
---|
| 2442 | <varlistentry>
|
---|
[92534] | 2443 | <term><option>--vrde-address=<replaceable>IP-address</replaceable></option></term>
|
---|
[82044] | 2444 | <listitem><para>
|
---|
| 2445 | Specifies the IP address of the host network interface to
|
---|
| 2446 | which the VRDE server binds. If you specify an IP address,
|
---|
| 2447 | the server accepts connections only on the specified host
|
---|
| 2448 | network interface.
|
---|
| 2449 | </para><para>
|
---|
| 2450 | Use this option to specify whether the VRDP server should
|
---|
| 2451 | accept IPv4, IPv6, or both type of connections:
|
---|
| 2452 | </para><itemizedlist>
|
---|
| 2453 | <listitem><para>
|
---|
| 2454 | <emphasis role="bold">Only IPv4:</emphasis> Use the
|
---|
[92534] | 2455 | <option>--vrde-address="0.0.0.0"</option> option.
|
---|
[82044] | 2456 | </para></listitem>
|
---|
| 2457 | <listitem><para>
|
---|
| 2458 | <emphasis role="bold">Only IPv6:</emphasis> Use the
|
---|
[92534] | 2459 | <option>--vrde-address="::"</option> option.
|
---|
[82044] | 2460 | </para></listitem>
|
---|
| 2461 | <listitem><para>
|
---|
| 2462 | <emphasis role="bold">Both IPv6 and IPv4:</emphasis>
|
---|
[93713] | 2463 | Use the <option>--vrde-address=""</option>
|
---|
[82044] | 2464 | option. This is the default value.
|
---|
| 2465 | </para></listitem>
|
---|
| 2466 | </itemizedlist></listitem>
|
---|
| 2467 | </varlistentry>
|
---|
| 2468 | <varlistentry>
|
---|
[92534] | 2469 | <term><option>--vrde-auth-type=null | external | guest</option></term>
|
---|
[82044] | 2470 | <listitem><para>
|
---|
| 2471 | Specify whether to use authorization and how to perform
|
---|
| 2472 | authorization. See <xref linkend="vbox-auth" />. Valid
|
---|
| 2473 | values are as follows:
|
---|
| 2474 | </para><itemizedlist>
|
---|
| 2475 | <listitem><para>
|
---|
| 2476 | <literal>null</literal> provides no authentication.
|
---|
| 2477 | </para></listitem>
|
---|
| 2478 | <listitem><para>
|
---|
| 2479 | <literal>external</literal> provides external
|
---|
| 2480 | authentication through an authentication library.
|
---|
| 2481 | </para></listitem>
|
---|
| 2482 | <listitem><para>
|
---|
| 2483 | <literal>guest</literal> performs authentication by
|
---|
| 2484 | using guest user accounts. This unsupported method
|
---|
| 2485 | requires that you install the Guest Additions on the
|
---|
| 2486 | VM.
|
---|
| 2487 | </para></listitem>
|
---|
| 2488 | </itemizedlist></listitem>
|
---|
| 2489 | </varlistentry>
|
---|
| 2490 | <varlistentry>
|
---|
[92534] | 2491 | <term><option>--vrde-auth-library=default | <replaceable>name</replaceable></option></term>
|
---|
[82044] | 2492 | <listitem><para>
|
---|
| 2493 | Specifies the library to use for RDP authentication. The
|
---|
| 2494 | default library for external authentication is
|
---|
| 2495 | <filename>VBoxAuth</filename>. See
|
---|
| 2496 | <xref linkend="vbox-auth" />.
|
---|
| 2497 | </para></listitem>
|
---|
| 2498 | </varlistentry>
|
---|
| 2499 | <varlistentry>
|
---|
[92534] | 2500 | <term><option>--vrde-multi-con=on | off</option></term>
|
---|
[82044] | 2501 | <listitem><para>
|
---|
| 2502 | Enables or disables the multiple connections VRDE server
|
---|
| 2503 | feature, if supported. See
|
---|
| 2504 | <xref linkend="vrde-multiconnection" />.
|
---|
| 2505 | </para></listitem>
|
---|
| 2506 | </varlistentry>
|
---|
| 2507 | <varlistentry>
|
---|
[92534] | 2508 | <term><option>--vrde-reuse-con=on | off</option></term>
|
---|
[82044] | 2509 | <listitem><para>
|
---|
| 2510 | Specifies how the VRDE server behaves when multiple
|
---|
| 2511 | connections are disabled. When the value is
|
---|
| 2512 | <literal>on</literal>, the server permits a new client to
|
---|
| 2513 | connect and drops the existing connection. When the value
|
---|
| 2514 | is <literal>off</literal>, a new connection is not
|
---|
| 2515 | accepted if a client is already connected to the server.
|
---|
| 2516 | This is the default value.
|
---|
| 2517 | </para></listitem>
|
---|
| 2518 | </varlistentry>
|
---|
| 2519 | <varlistentry>
|
---|
[92534] | 2520 | <term><option>--vrde-video-channel=on | off</option></term>
|
---|
[82044] | 2521 | <listitem><para>
|
---|
| 2522 | Enables video redirection if supported by the VRDE server.
|
---|
| 2523 | See <xref linkend="vrde-videochannel" />.
|
---|
| 2524 | </para></listitem>
|
---|
| 2525 | </varlistentry>
|
---|
| 2526 | <varlistentry>
|
---|
[92534] | 2527 | <term><option>--vrde-video-channel-quality=<replaceable>percent</replaceable></option></term>
|
---|
[82044] | 2528 | <listitem><para>
|
---|
| 2529 | Specifies the image quality for video redirection as a
|
---|
| 2530 | value from 10 to 100 percent. The percentage represents
|
---|
| 2531 | the JPEG compression level where a lower number diminishes
|
---|
| 2532 | quality and provides higher compression. See
|
---|
| 2533 | <xref linkend="vrde-videochannel" />.
|
---|
| 2534 | </para></listitem>
|
---|
| 2535 | </varlistentry>
|
---|
| 2536 | </variablelist>
|
---|
| 2537 | </refsect2>
|
---|
| 2538 | <refsect2 id="vboxmanage-modifyvm-teleport">
|
---|
| 2539 | <title>Teleporting Settings</title>
|
---|
| 2540 | <remark role="help-copy-synopsis"/>
|
---|
| 2541 | <para>
|
---|
| 2542 | The following options enable you to configure a machine as a
|
---|
[98047] | 2543 | teleporting target. See <xref linkend="teleporting" /> and the
|
---|
[98048] | 2544 | teleporting related entries in <xref linkend="pot-insecure" />.
|
---|
[82044] | 2545 | </para>
|
---|
| 2546 | <variablelist>
|
---|
| 2547 | <varlistentry>
|
---|
| 2548 | <term><option>--teleporter=on | off</option></term>
|
---|
| 2549 | <listitem><para>
|
---|
| 2550 | Enables or disables the teleporter. When enabled, a
|
---|
| 2551 | machine starts up and waits to receive a teleporting
|
---|
| 2552 | request from the network instead of booting normally.
|
---|
| 2553 | </para><para>
|
---|
| 2554 | Teleporting requests are received on the port and address
|
---|
| 2555 | specified using the following parameters.
|
---|
| 2556 | </para></listitem>
|
---|
| 2557 | </varlistentry>
|
---|
| 2558 | <varlistentry>
|
---|
[92534] | 2559 | <term><option>--teleporter-port=<replaceable>port</replaceable></option></term>
|
---|
[82044] | 2560 | <listitem><para>
|
---|
| 2561 | Specifies the port on which the VM listens to receive a
|
---|
| 2562 | teleporting request from another VM.
|
---|
| 2563 | <replaceable>port</replaceable> is any free TCP/IP port
|
---|
| 2564 | number, such as <literal>6000</literal>. You must also
|
---|
| 2565 | specify the <option>--teleporter</option> option.
|
---|
| 2566 | </para></listitem>
|
---|
| 2567 | </varlistentry>
|
---|
| 2568 | <varlistentry>
|
---|
[92534] | 2569 | <term><option>--teleporter-address=<replaceable>IP-address</replaceable></option></term>
|
---|
[82044] | 2570 | <listitem><para>
|
---|
| 2571 | Specifies the IP address on which the VM listens to
|
---|
| 2572 | receive a teleporting request from another VM.
|
---|
| 2573 | <replaceable>IP-address</replaceable> is any IP address or
|
---|
| 2574 | host name and specifies the TCP/IP socket on which to
|
---|
| 2575 | bind. The default IP address is
|
---|
| 2576 | <literal>0.0.0.0</literal>, which represents any IP
|
---|
| 2577 | address. You must also specify the
|
---|
| 2578 | <option>--teleporter</option> option.
|
---|
| 2579 | </para></listitem>
|
---|
| 2580 | </varlistentry>
|
---|
| 2581 | <varlistentry>
|
---|
[92534] | 2582 | <term><option>--teleporter-password=<replaceable>password</replaceable></option></term>
|
---|
[82044] | 2583 | <listitem><para>
|
---|
| 2584 | Specifies the password to use for authentication. When
|
---|
| 2585 | specified, the teleporting request only succeeds if the
|
---|
| 2586 | password on the source machine is the same password as the
|
---|
| 2587 | one you specify.
|
---|
| 2588 | </para></listitem>
|
---|
| 2589 | </varlistentry>
|
---|
| 2590 | <varlistentry>
|
---|
[92534] | 2591 | <term><option>--teleporter-password-file=<replaceable>filename</replaceable></option></term>
|
---|
[82044] | 2592 | <listitem><para>
|
---|
| 2593 | Specifies a file that contains the password to use for
|
---|
| 2594 | authentication. When specified, the teleporting request
|
---|
| 2595 | only succeeds if the password on the source machine is the
|
---|
| 2596 | same password as the one you specify in the password file.
|
---|
| 2597 | A value of <literal>stdin</literal> reads the password
|
---|
| 2598 | from standard input.
|
---|
| 2599 | </para></listitem>
|
---|
| 2600 | </varlistentry>
|
---|
| 2601 | <varlistentry>
|
---|
[91204] | 2602 | <term><option>--cpuid-portability-level=<replaceable>level</replaceable></option></term>
|
---|
| 2603 | <listitem>
|
---|
| 2604 | <para>
|
---|
[82044] | 2605 | Restricts the virtual CPU capabilities that &product-name;
|
---|
[91204] | 2606 | presents to the guest OS by using portability rules. Higher
|
---|
| 2607 | integer values designate more restrictive behavior. The
|
---|
| 2608 | default level of <literal>0</literal> indicates that all
|
---|
| 2609 | virtualized features supported by the host are made available
|
---|
| 2610 | to the guest. The value <literal>3</literal> supresses most
|
---|
| 2611 | features. Values of <literal>1</literal> and <literal>2</literal>
|
---|
| 2612 | represent restrictions in between. The behavior may change
|
---|
| 2613 | depending on the product version.
|
---|
| 2614 | </para></listitem>
|
---|
| 2615 | </varlistentry>
|
---|
| 2616 | <varlistentry>
|
---|
| 2617 | <term><option>--cpuid-set=<replaceable>leaf</replaceable>[:<replaceable>subleaf</replaceable>]
|
---|
| 2618 | <replaceable>eax</replaceable> <replaceable>ebx</replaceable> <replaceable>ecx</replaceable> <replaceable>edx</replaceable></option></term>
|
---|
| 2619 | <listitem>
|
---|
| 2620 | <para>
|
---|
| 2621 | Advanced users can use this setting before a teleporting
|
---|
| 2622 | operation (in fact before starting the VM) to restrict the
|
---|
| 2623 | virtual CPU capabilities that &product-name; presents to
|
---|
| 2624 | the guest operating system. This must be run on both the
|
---|
| 2625 | source and the target machines involved in teleporting and
|
---|
| 2626 | will then modify what the guest sees when it executes the
|
---|
| 2627 | CPUID machine instruction. This might help with misbehaving
|
---|
| 2628 | applications that wrongly assume that certain CPU
|
---|
| 2629 | capabilities are present. The meaning of the parameters
|
---|
| 2630 | is hardware dependent. Refer to the AMD or Intel processor
|
---|
| 2631 | documentation.
|
---|
[82044] | 2632 | </para><para>
|
---|
[91204] | 2633 | The values of <replaceable>leaf</replaceable>,
|
---|
| 2634 | <replaceable>subleaf</replaceable> (optional),
|
---|
| 2635 | <replaceable>eax</replaceable>, <replaceable>ebx</replaceable>,
|
---|
| 2636 | <replaceable>ecx</replaceable> and <replaceable>edx</replaceable>
|
---|
| 2637 | are integers given in hexadecimal format, i.e. using a radix
|
---|
| 2638 | (base) of 16 without requiring any prefix.
|
---|
[82044] | 2639 | </para></listitem>
|
---|
| 2640 | </varlistentry>
|
---|
[91204] | 2641 | <varlistentry>
|
---|
| 2642 | <term><option>--cpuid-remove=<replaceable>leaf</replaceable>[:<replaceable>subleaf</replaceable>]</option></term>
|
---|
| 2643 | <listitem>
|
---|
| 2644 | <para>
|
---|
| 2645 | Removes an adjustment established with <option>--cpuid-set</option>.
|
---|
| 2646 | </para></listitem>
|
---|
| 2647 | </varlistentry>
|
---|
| 2648 | <varlistentry>
|
---|
[92534] | 2649 | <term><option>--cpuid-remove-all</option></term>
|
---|
[91204] | 2650 | <listitem>
|
---|
| 2651 | <para>
|
---|
| 2652 | Removes all adjustments established with <option>--cpuid-set</option>.
|
---|
| 2653 | </para></listitem>
|
---|
| 2654 | </varlistentry>
|
---|
[82044] | 2655 | </variablelist>
|
---|
| 2656 | </refsect2>
|
---|
| 2657 | <refsect2 id="vboxmanage-modifyvm-debugging">
|
---|
| 2658 | <title>Debugging Settings</title>
|
---|
| 2659 | <remark role="help-copy-synopsis"/>
|
---|
| 2660 | <para>
|
---|
| 2661 | Only use the following options to perform low-level VM
|
---|
| 2662 | debugging. These options are for advanced users only.
|
---|
| 2663 | </para>
|
---|
| 2664 | <variablelist>
|
---|
| 2665 | <varlistentry>
|
---|
| 2666 | <term><option>--tracing-enabled=on | off</option></term>
|
---|
| 2667 | <listitem><para>
|
---|
| 2668 | Enables or disables the trace buffer. Note that when
|
---|
| 2669 | specified, the trace buffer consumes some memory and adds
|
---|
| 2670 | overhead.
|
---|
| 2671 | </para></listitem>
|
---|
| 2672 | </varlistentry>
|
---|
| 2673 | <varlistentry>
|
---|
| 2674 | <term><option>--tracing-config=<replaceable>config-string</replaceable></option></term>
|
---|
| 2675 | <listitem><para>
|
---|
| 2676 | Enables a tracing configuration that defines which group
|
---|
| 2677 | of trace points are enabled.
|
---|
| 2678 | </para></listitem>
|
---|
| 2679 | </varlistentry>
|
---|
| 2680 | <varlistentry>
|
---|
| 2681 | <term><option>--tracing-allow-vm-access=on | off</option></term>
|
---|
| 2682 | <listitem><para>
|
---|
| 2683 | Enables or disables VM access to the trace buffer. The
|
---|
| 2684 | default value is <literal>off</literal>, which disables
|
---|
| 2685 | access.
|
---|
| 2686 | </para></listitem>
|
---|
| 2687 | </varlistentry>
|
---|
| 2688 | </variablelist>
|
---|
| 2689 | </refsect2>
|
---|
| 2690 | <refsect2 id="vboxmanage-modifyvm-usbcardreader">
|
---|
| 2691 | <title>USB Card Reader Settings</title>
|
---|
| 2692 | <remark role="help-copy-synopsis"/>
|
---|
| 2693 | <para>
|
---|
| 2694 | The following options specify the access to a USB Card Reader by
|
---|
| 2695 | the guest environment. A USB card reader can access data on
|
---|
| 2696 | memory cards, such as CompactFlash (CF), Secure Digital (SD),
|
---|
| 2697 | and MultiMediaCard (MMC).
|
---|
| 2698 | </para>
|
---|
| 2699 | <variablelist>
|
---|
| 2700 | <varlistentry>
|
---|
[92534] | 2701 | <term><option>--usb-card-reader=on | off</option></term>
|
---|
[82044] | 2702 | <listitem><para>
|
---|
| 2703 | Enables or disables the USB card reader interface.
|
---|
| 2704 | </para></listitem>
|
---|
| 2705 | </varlistentry>
|
---|
| 2706 | </variablelist>
|
---|
| 2707 | </refsect2>
|
---|
| 2708 | <refsect2 id="vboxmanage-modifyvm-autostart">
|
---|
| 2709 | <title>Autostarting VMs During Host System Boot</title>
|
---|
| 2710 | <para>
|
---|
| 2711 | The following options enable you to configure the VM autostart
|
---|
| 2712 | feature, which automatically starts the VM at host system
|
---|
| 2713 | boot-up. You must do some host system configuration before you
|
---|
| 2714 | can use this feature. See <xref linkend="autostart" />.
|
---|
| 2715 | </para>
|
---|
| 2716 | <remark role="help-copy-synopsis"/>
|
---|
| 2717 | <variablelist>
|
---|
| 2718 | <varlistentry>
|
---|
| 2719 | <term><option>--autostart-enabled=on | off</option></term>
|
---|
| 2720 | <listitem><para>
|
---|
| 2721 | Enables or disables VM autostart at host system boot-up
|
---|
| 2722 | for the specified users.
|
---|
| 2723 | </para></listitem>
|
---|
| 2724 | </varlistentry>
|
---|
| 2725 | <varlistentry>
|
---|
| 2726 | <term><option>--autostart-delay=<replaceable>seconds</replaceable></option></term>
|
---|
| 2727 | <listitem><para>
|
---|
| 2728 | Specifies the number of seconds after host system boot-up
|
---|
| 2729 | to autostart the VM.
|
---|
| 2730 | </para></listitem>
|
---|
| 2731 | </varlistentry>
|
---|
| 2732 | </variablelist>
|
---|
| 2733 | </refsect2>
|
---|
[96888] | 2734 | <refsect2 id="vboxmanage-modifyvm-guest-debug">
|
---|
| 2735 | <title>Guest Debugging</title>
|
---|
| 2736 | <para>
|
---|
| 2737 | These options are for configuring the VMM for guest debugging.
|
---|
| 2738 | </para>
|
---|
| 2739 | <remark role="help-copy-synopsis"/>
|
---|
| 2740 | <variablelist>
|
---|
| 2741 | <varlistentry>
|
---|
| 2742 | <term><option>--guest-debug-provider=none | native | gdb | kd</option></term>
|
---|
| 2743 | <listitem><para>Selects the given debug stub provider. </para></listitem>
|
---|
| 2744 | </varlistentry>
|
---|
| 2745 | <varlistentry>
|
---|
| 2746 | <term><option>--guest-debug-io-provider=none | tcp | udp | ipc</option></term>
|
---|
| 2747 | <listitem><para>Selects the given I/O transport backend for the selected provider.</para></listitem>
|
---|
| 2748 | </varlistentry>
|
---|
| 2749 | <varlistentry>
|
---|
| 2750 | <term><option>--guest-debug-address=<replaceable>IP-Address</replaceable> | <replaceable>path</replaceable></option></term>
|
---|
| 2751 | <listitem><para>Sets the path the debugger is accessible under, depends on the selected I/O transport.</para></listitem>
|
---|
| 2752 | </varlistentry>
|
---|
| 2753 | <varlistentry>
|
---|
| 2754 | <term><option>--guest-debug-port=<replaceable>port</replaceable></option></term>
|
---|
| 2755 | <listitem><para>Sets the port the debugger is accessible under, depends on the selected I/O transport.</para></listitem>
|
---|
| 2756 | </varlistentry>
|
---|
| 2757 | </variablelist>
|
---|
| 2758 | </refsect2>
|
---|
[91204] | 2759 | <refsect2 id="vboxmanage-modifyvm-pcipassthrough">
|
---|
| 2760 | <title>PCI Passthrough Settings</title>
|
---|
| 2761 | <para>
|
---|
| 2762 | The following options enable you to configure the PCI passthrough
|
---|
| 2763 | feature, which currently is not available in &product-name;. It is
|
---|
| 2764 | planned to bring this functionality back in the future.
|
---|
| 2765 | </para>
|
---|
| 2766 | <remark role="help-copy-synopsis"/>
|
---|
| 2767 | <variablelist>
|
---|
| 2768 | <varlistentry>
|
---|
[92534] | 2769 | <term><option>--pci-attach=<replaceable>host-PCI-address</replaceable>[@<replaceable>guest-PCI-bus-address</replaceable>]</option></term>
|
---|
[91204] | 2770 | <listitem><para>
|
---|
| 2771 | Attaches the specified PCI network controller on the host
|
---|
| 2772 | to the guest VM. You can optionally specify the PCI bus on
|
---|
| 2773 | the guest VM on which to attach the controller.
|
---|
| 2774 | <!-- See <xref linkend="pcipassthrough" />. -->
|
---|
| 2775 | </para></listitem>
|
---|
| 2776 | </varlistentry>
|
---|
| 2777 | <varlistentry>
|
---|
[92534] | 2778 | <term><option>--pci-detach=<replaceable>host-PCI-address</replaceable></option></term>
|
---|
[91204] | 2779 | <listitem><para>
|
---|
| 2780 | Detaches the specified PCI network controller from the
|
---|
| 2781 | attached PCI bus on the guest VM.
|
---|
| 2782 | <!-- See <xref linkend="pcipassthrough" />. -->
|
---|
| 2783 | </para></listitem>
|
---|
| 2784 | </varlistentry>
|
---|
| 2785 | </variablelist>
|
---|
| 2786 | </refsect2>
|
---|
[92538] | 2787 | <refsect2 id="vboxmanage-modifyvm-testing">
|
---|
| 2788 | <title>Testing (ValidationKit / Bootsector)</title>
|
---|
| 2789 | <para>
|
---|
| 2790 | These options are for configuring the testing functionality of the VMM
|
---|
| 2791 | device and almost exclusively used by the bootsector testcases in the
|
---|
| 2792 | ValidationKit.
|
---|
| 2793 | </para>
|
---|
| 2794 | <remark role="help-copy-synopsis"/>
|
---|
| 2795 | <variablelist>
|
---|
| 2796 | <varlistentry>
|
---|
| 2797 | <term><option>--testing-enabled=on | off</option></term>
|
---|
| 2798 | <listitem><para>Enabled the testing functionality of the VMMDev. See VMMDevTesting.h for details. </para></listitem>
|
---|
| 2799 | </varlistentry>
|
---|
| 2800 | <varlistentry>
|
---|
| 2801 | <term><option>--testing-mmio=on | off</option></term>
|
---|
| 2802 | <listitem><para>Enabled the MMIO region of the VMMDev testing feature.</para></listitem>
|
---|
| 2803 | </varlistentry>
|
---|
| 2804 | <varlistentry>
|
---|
| 2805 | <term><option>--testing-cfg-dword<replaceable>idx</replaceable>=<replaceable>value</replaceable></option></term>
|
---|
| 2806 | <listitem><para>
|
---|
| 2807 | This sets one of the 10 dword configuration values. The
|
---|
| 2808 | <replaceable>idx</replaceable> must be in the range 0 thru 9.
|
---|
| 2809 | The <replaceable>value</replaceable> is limited to 32 bits (dword).
|
---|
| 2810 | </para></listitem>
|
---|
| 2811 | </varlistentry>
|
---|
| 2812 | </variablelist>
|
---|
| 2813 | </refsect2>
|
---|
| 2814 |
|
---|
[82044] | 2815 | </refsect1>
|
---|
| 2816 |
|
---|
[99497] | 2817 | <refsect1 id="vboxmanage-modifyvm-examples">
|
---|
[82044] | 2818 | <title>Examples</title>
|
---|
| 2819 | <remark role="help-scope" condition="GLOBAL" />
|
---|
| 2820 | <para>
|
---|
| 2821 | The following command changes the description for the
|
---|
| 2822 | <filename>ol7</filename> VM.
|
---|
| 2823 | </para>
|
---|
| 2824 | <screen>$ VBoxManage modifyvm ol7 --description "Oracle Linux 7 with UEK4"</screen>
|
---|
| 2825 | <para>
|
---|
| 2826 | The following command enables VirtualBox Remote Display Protocol
|
---|
| 2827 | (VRDP) support for the <filename>ol7</filename> VM.
|
---|
| 2828 | </para>
|
---|
| 2829 | <screen>$ VBoxManage modifyvm ol7 --vrde on</screen>
|
---|
| 2830 | </refsect1>
|
---|
| 2831 |
|
---|
[99497] | 2832 | <refsect1 id="vboxmanage-modifyvm-see-also">
|
---|
[82044] | 2833 | <title>See Also</title>
|
---|
| 2834 | <para>
|
---|
[92538] | 2835 | <xref linkend="vboxmanage-showvminfo" />,
|
---|
[82044] | 2836 | <xref linkend="vboxmanage-controlvm" />,
|
---|
| 2837 | <xref linkend="vboxmanage-createvm" />,
|
---|
| 2838 | <xref linkend="vboxmanage-startvm" />
|
---|
[92538] | 2839 | <xref linkend="vboxmanage-list" />
|
---|
[82044] | 2840 | </para>
|
---|
| 2841 | </refsect1>
|
---|
| 2842 | </refentry>
|
---|