| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage controlvm
|
|---|
| 4 | -->
|
|---|
| 5 | <!--
|
|---|
| 6 | Copyright (C) 2006-2022 Oracle and/or its affiliates.
|
|---|
| 7 |
|
|---|
| 8 | This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | available from https://www.virtualbox.org.
|
|---|
| 10 |
|
|---|
| 11 | This program is free software; you can redistribute it and/or
|
|---|
| 12 | modify it under the terms of the GNU General Public License
|
|---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | License.
|
|---|
| 15 |
|
|---|
| 16 | This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | General Public License for more details.
|
|---|
| 20 |
|
|---|
| 21 | You should have received a copy of the GNU General Public License
|
|---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 |
|
|---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 25 | -->
|
|---|
| 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
|---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
|---|
| 29 | %all.entities;
|
|---|
| 30 | ]>
|
|---|
| 31 | <refentry id="vboxmanage-controlvm" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2022-08-22 17:43:14 +0000 (Mon, 22 Aug 2022) $</pubdate>
|
|---|
| 34 | <title>VBoxManage controlvm</title>
|
|---|
| 35 | </refentryinfo>
|
|---|
| 36 |
|
|---|
| 37 | <refmeta>
|
|---|
| 38 | <refentrytitle>VBoxManage-controlvm</refentrytitle>
|
|---|
| 39 | <manvolnum>1</manvolnum>
|
|---|
| 40 | </refmeta>
|
|---|
| 41 |
|
|---|
| 42 | <refnamediv>
|
|---|
| 43 | <refname>VBoxManage-controlvm</refname>
|
|---|
| 44 | <refpurpose>change state and settings for a running virtual machine</refpurpose>
|
|---|
| 45 | <refclass>&product-name;</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-pause">
|
|---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 51 | <command>VBoxManage controlvm</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 choice="plain">pause</arg>
|
|---|
| 57 | </cmdsynopsis>
|
|---|
| 58 |
|
|---|
| 59 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-resume">
|
|---|
| 60 | <command>VBoxManage controlvm</command>
|
|---|
| 61 | <group choice="req">
|
|---|
| 62 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 63 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 64 | </group>
|
|---|
| 65 | <arg choice="plain">resume</arg>
|
|---|
| 66 | </cmdsynopsis>
|
|---|
| 67 |
|
|---|
| 68 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-reset">
|
|---|
| 69 | <command>VBoxManage controlvm</command>
|
|---|
| 70 | <group choice="req">
|
|---|
| 71 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 72 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 73 | </group>
|
|---|
| 74 | <arg choice="plain">reset</arg>
|
|---|
| 75 | </cmdsynopsis>
|
|---|
| 76 |
|
|---|
| 77 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-poweroff">
|
|---|
| 78 | <command>VBoxManage controlvm</command>
|
|---|
| 79 | <group choice="req">
|
|---|
| 80 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 81 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 82 | </group>
|
|---|
| 83 | <arg choice="plain">poweroff</arg>
|
|---|
| 84 | </cmdsynopsis>
|
|---|
| 85 |
|
|---|
| 86 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-savestate">
|
|---|
| 87 | <command>VBoxManage controlvm</command>
|
|---|
| 88 | <group choice="req">
|
|---|
| 89 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 90 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 91 | </group>
|
|---|
| 92 | <arg choice="plain">savestate</arg>
|
|---|
| 93 | </cmdsynopsis>
|
|---|
| 94 |
|
|---|
| 95 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-acpipowerbutton">
|
|---|
| 96 | <command>VBoxManage controlvm</command>
|
|---|
| 97 | <group choice="req">
|
|---|
| 98 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 99 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 100 | </group>
|
|---|
| 101 | <arg choice="plain">acpipowerbutton</arg>
|
|---|
| 102 | </cmdsynopsis>
|
|---|
| 103 |
|
|---|
| 104 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-acpisleepbutton">
|
|---|
| 105 | <command>VBoxManage controlvm</command>
|
|---|
| 106 | <group choice="req">
|
|---|
| 107 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 108 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 109 | </group>
|
|---|
| 110 | <arg choice="plain">acpisleepbutton</arg>
|
|---|
| 111 | </cmdsynopsis>
|
|---|
| 112 |
|
|---|
| 113 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-reboot">
|
|---|
| 114 | <command>VBoxManage controlvm</command>
|
|---|
| 115 | <group choice="req">
|
|---|
| 116 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 117 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 118 | </group>
|
|---|
| 119 | <arg choice="plain">reboot</arg>
|
|---|
| 120 | </cmdsynopsis>
|
|---|
| 121 |
|
|---|
| 122 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-shutdown">
|
|---|
| 123 | <command>VBoxManage controlvm</command>
|
|---|
| 124 | <group choice="req">
|
|---|
| 125 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 126 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 127 | </group>
|
|---|
| 128 | <arg choice="plain">shutdown</arg>
|
|---|
| 129 | <arg choice="opt">--force</arg>
|
|---|
| 130 | </cmdsynopsis>
|
|---|
| 131 |
|
|---|
| 132 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-keyboardputscancode">
|
|---|
| 133 | <command>VBoxManage controlvm</command>
|
|---|
| 134 | <group choice="req">
|
|---|
| 135 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 136 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 137 | </group>
|
|---|
| 138 | <arg choice="plain">keyboardputscancode</arg>
|
|---|
| 139 | <arg choice="req"><replaceable>hex</replaceable></arg>
|
|---|
| 140 | <arg rep="repeat"><replaceable>hex</replaceable></arg>
|
|---|
| 141 | </cmdsynopsis>
|
|---|
| 142 |
|
|---|
| 143 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-keyboardputstring">
|
|---|
| 144 | <command>VBoxManage controlvm</command>
|
|---|
| 145 | <group choice="req">
|
|---|
| 146 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 147 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 148 | </group>
|
|---|
| 149 | <arg choice="plain">keyboardputstring</arg>
|
|---|
| 150 | <arg choice="req"><replaceable>string</replaceable></arg>
|
|---|
| 151 | <arg rep="repeat"><replaceable>string</replaceable></arg>
|
|---|
| 152 | </cmdsynopsis>
|
|---|
| 153 |
|
|---|
| 154 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-keyboardputfile">
|
|---|
| 155 | <command>VBoxManage controlvm</command>
|
|---|
| 156 | <group choice="req">
|
|---|
| 157 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 158 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 159 | </group>
|
|---|
| 160 | <arg choice="plain">keyboardputfile</arg>
|
|---|
| 161 | <arg choice="req"><replaceable>filename</replaceable></arg>
|
|---|
| 162 | </cmdsynopsis>
|
|---|
| 163 |
|
|---|
| 164 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-setlinkstate">
|
|---|
| 165 | <command>VBoxManage controlvm</command>
|
|---|
| 166 | <group choice="req">
|
|---|
| 167 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 168 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 169 | </group>
|
|---|
| 170 | <arg choice="plain">setlinkstate<replaceable>N</replaceable></arg>
|
|---|
| 171 | <group choice="req">
|
|---|
| 172 | <arg choice="plain">on</arg>
|
|---|
| 173 | <arg choice="plain">off</arg>
|
|---|
| 174 | </group>
|
|---|
| 175 | </cmdsynopsis>
|
|---|
| 176 |
|
|---|
| 177 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-nic">
|
|---|
| 178 | <command>VBoxManage controlvm</command>
|
|---|
| 179 | <group choice="req">
|
|---|
| 180 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 181 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 182 | </group>
|
|---|
| 183 | <arg choice="plain">nic<replaceable>N</replaceable></arg>
|
|---|
| 184 | <group choice="req">
|
|---|
| 185 | <arg choice="plain">null</arg>
|
|---|
| 186 | <arg choice="plain">nat</arg>
|
|---|
| 187 | <arg choice="plain">bridged</arg>
|
|---|
| 188 | <arg choice="plain">intnet</arg>
|
|---|
| 189 | <arg choice="plain">hostonly</arg>
|
|---|
| 190 | <arg choice="plain">generic</arg>
|
|---|
| 191 | <arg choice="plain">natnetwork</arg>
|
|---|
| 192 | </group>
|
|---|
| 193 | <arg><replaceable>device-name</replaceable></arg>
|
|---|
| 194 | </cmdsynopsis>
|
|---|
| 195 |
|
|---|
| 196 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-nictrace">
|
|---|
| 197 | <command>VBoxManage controlvm</command>
|
|---|
| 198 | <group choice="req">
|
|---|
| 199 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 200 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 201 | </group>
|
|---|
| 202 | <arg choice="plain">nictrace<replaceable>N</replaceable></arg>
|
|---|
| 203 | <group choice="req">
|
|---|
| 204 | <arg choice="plain">on</arg>
|
|---|
| 205 | <arg choice="plain">off</arg>
|
|---|
| 206 | </group>
|
|---|
| 207 | </cmdsynopsis>
|
|---|
| 208 |
|
|---|
| 209 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-nictracefile">
|
|---|
| 210 | <command>VBoxManage controlvm</command>
|
|---|
| 211 | <group choice="req">
|
|---|
| 212 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 213 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 214 | </group>
|
|---|
| 215 | <arg choice="plain">nictracefile<replaceable>N</replaceable></arg>
|
|---|
| 216 | <arg choice="req"><replaceable>filename</replaceable></arg>
|
|---|
| 217 | </cmdsynopsis>
|
|---|
| 218 |
|
|---|
| 219 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-nicproperty">
|
|---|
| 220 | <command>VBoxManage controlvm</command>
|
|---|
| 221 | <group choice="req">
|
|---|
| 222 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 223 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 224 | </group>
|
|---|
| 225 | <arg choice="plain">nicproperty<replaceable>N</replaceable></arg>
|
|---|
| 226 | <arg choice="req"><replaceable>prop-name</replaceable>=<replaceable>prop-value</replaceable></arg>
|
|---|
| 227 | </cmdsynopsis>
|
|---|
| 228 |
|
|---|
| 229 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-nicpromisc">
|
|---|
| 230 | <command>VBoxManage controlvm</command>
|
|---|
| 231 | <group choice="req">
|
|---|
| 232 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 233 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 234 | </group>
|
|---|
| 235 | <arg choice="plain">nicpromisc<replaceable>N</replaceable></arg>
|
|---|
| 236 | <group choice="req">
|
|---|
| 237 | <arg choice="plain">deny</arg>
|
|---|
| 238 | <arg choice="plain">allow-vms</arg>
|
|---|
| 239 | <arg choice="plain">allow-all</arg>
|
|---|
| 240 | </group>
|
|---|
| 241 | </cmdsynopsis>
|
|---|
| 242 |
|
|---|
| 243 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-natpf">
|
|---|
| 244 | <command>VBoxManage controlvm</command>
|
|---|
| 245 | <group choice="req">
|
|---|
| 246 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 247 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 248 | </group>
|
|---|
| 249 | <arg choice="plain">natpf<replaceable>N</replaceable></arg>
|
|---|
| 250 | <group choice="req">
|
|---|
| 251 | <arg choice="plain">[<replaceable>rulename</replaceable>]<arg choice="plain">,tcp</arg></arg>
|
|---|
| 252 | <arg choice="plain">udp,<arg><replaceable>host-IP</replaceable></arg>,<arg choice="plain"><replaceable>hostport</replaceable>,</arg><arg><replaceable>guest-IP</replaceable></arg>,<arg choice="plain"><replaceable>guestport</replaceable></arg></arg>
|
|---|
| 253 | </group>
|
|---|
| 254 | </cmdsynopsis>
|
|---|
| 255 |
|
|---|
| 256 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-natpf-delete">
|
|---|
| 257 | <command>VBoxManage controlvm</command>
|
|---|
| 258 | <group choice="req">
|
|---|
| 259 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 260 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 261 | </group>
|
|---|
| 262 | <arg choice="plain">natpf<replaceable>N</replaceable> delete</arg>
|
|---|
| 263 |
|
|---|
| 264 | <arg choice="req"><replaceable>rulename</replaceable></arg>
|
|---|
| 265 | </cmdsynopsis>
|
|---|
| 266 |
|
|---|
| 267 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-guestmemoryballoon">
|
|---|
| 268 | <command>VBoxManage controlvm</command>
|
|---|
| 269 | <group choice="req">
|
|---|
| 270 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 271 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 272 | </group>
|
|---|
| 273 | <arg choice="plain">guestmemoryballoon</arg>
|
|---|
| 274 | <arg choice="req"><replaceable>balloon-size</replaceable></arg>
|
|---|
| 275 | </cmdsynopsis>
|
|---|
| 276 |
|
|---|
| 277 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-usbattach">
|
|---|
| 278 | <command>VBoxManage controlvm</command>
|
|---|
| 279 | <group choice="req">
|
|---|
| 280 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 281 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 282 | </group>
|
|---|
| 283 | <arg choice="plain">usbattach</arg>
|
|---|
| 284 | <group choice="req">
|
|---|
| 285 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 286 | <arg choice="plain"><replaceable>address</replaceable></arg>
|
|---|
| 287 | </group>
|
|---|
| 288 | <arg>--capturefile=<replaceable>filename</replaceable></arg>
|
|---|
| 289 | </cmdsynopsis>
|
|---|
| 290 |
|
|---|
| 291 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-usbdetach">
|
|---|
| 292 | <command>VBoxManage controlvm</command>
|
|---|
| 293 | <group choice="req">
|
|---|
| 294 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 295 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 296 | </group>
|
|---|
| 297 | <arg choice="plain">usbdetach</arg>
|
|---|
| 298 | <group choice="req">
|
|---|
| 299 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 300 | <arg choice="plain"><replaceable>address</replaceable></arg>
|
|---|
| 301 | </group>
|
|---|
| 302 | </cmdsynopsis>
|
|---|
| 303 |
|
|---|
| 304 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-audioin">
|
|---|
| 305 | <command>VBoxManage controlvm</command>
|
|---|
| 306 | <group choice="req">
|
|---|
| 307 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 308 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 309 | </group>
|
|---|
| 310 | <arg choice="plain">audioin</arg>
|
|---|
| 311 | <group choice="req">
|
|---|
| 312 | <arg choice="plain">on</arg>
|
|---|
| 313 | <arg choice="plain">off</arg>
|
|---|
| 314 | </group>
|
|---|
| 315 | </cmdsynopsis>
|
|---|
| 316 |
|
|---|
| 317 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-audioout">
|
|---|
| 318 | <command>VBoxManage controlvm</command>
|
|---|
| 319 | <group choice="req">
|
|---|
| 320 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 321 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 322 | </group>
|
|---|
| 323 | <arg choice="plain">audioout</arg>
|
|---|
| 324 | <group choice="req">
|
|---|
| 325 | <arg choice="plain">on</arg>
|
|---|
| 326 | <arg choice="plain">off</arg>
|
|---|
| 327 | </group>
|
|---|
| 328 | </cmdsynopsis>
|
|---|
| 329 |
|
|---|
| 330 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-clipboard-mode">
|
|---|
| 331 | <command>VBoxManage controlvm</command>
|
|---|
| 332 | <group choice="req">
|
|---|
| 333 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 334 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 335 | </group>
|
|---|
| 336 | <arg choice="plain">clipboard mode</arg>
|
|---|
| 337 | <group choice="req">
|
|---|
| 338 | <arg choice="plain">disabled</arg>
|
|---|
| 339 | <arg choice="plain">hosttoguest</arg>
|
|---|
| 340 | <arg choice="plain">guesttohost</arg>
|
|---|
| 341 | <arg choice="plain">bidirectional</arg>
|
|---|
| 342 | </group>
|
|---|
| 343 | </cmdsynopsis>
|
|---|
| 344 |
|
|---|
| 345 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-clipboard-filetransfers">
|
|---|
| 346 | <command>VBoxManage controlvm</command>
|
|---|
| 347 | <group choice="req">
|
|---|
| 348 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 349 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 350 | </group>
|
|---|
| 351 | <arg choice="plain">clipboard filetransfers</arg>
|
|---|
| 352 | <group choice="req">
|
|---|
| 353 | <arg choice="plain">on</arg>
|
|---|
| 354 | <arg choice="plain">off</arg>
|
|---|
| 355 | </group>
|
|---|
| 356 | </cmdsynopsis>
|
|---|
| 357 |
|
|---|
| 358 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-draganddrop">
|
|---|
| 359 | <command>VBoxManage controlvm</command>
|
|---|
| 360 | <group choice="req">
|
|---|
| 361 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 362 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 363 | </group>
|
|---|
| 364 | <arg choice="plain">draganddrop</arg>
|
|---|
| 365 | <group choice="req">
|
|---|
| 366 | <arg choice="plain">disabled</arg>
|
|---|
| 367 | <arg choice="plain">hosttoguest</arg>
|
|---|
| 368 | <arg choice="plain">guesttohost</arg>
|
|---|
| 369 | <arg choice="plain">bidirectional</arg>
|
|---|
| 370 | </group>
|
|---|
| 371 | </cmdsynopsis>
|
|---|
| 372 |
|
|---|
| 373 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-vrde">
|
|---|
| 374 | <command>VBoxManage controlvm</command>
|
|---|
| 375 | <group choice="req">
|
|---|
| 376 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 377 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 378 | </group>
|
|---|
| 379 | <arg choice="plain">vrde</arg>
|
|---|
| 380 | <group choice="req">
|
|---|
| 381 | <arg choice="plain">on</arg>
|
|---|
| 382 | <arg choice="plain">off</arg>
|
|---|
| 383 | </group>
|
|---|
| 384 | </cmdsynopsis>
|
|---|
| 385 |
|
|---|
| 386 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-vrdeport">
|
|---|
| 387 | <command>VBoxManage controlvm</command>
|
|---|
| 388 | <group choice="req">
|
|---|
| 389 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 390 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 391 | </group>
|
|---|
| 392 | <arg choice="plain">vrdeport</arg>
|
|---|
| 393 | <arg choice="req"><replaceable>port</replaceable></arg>
|
|---|
| 394 | </cmdsynopsis>
|
|---|
| 395 |
|
|---|
| 396 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-vrdeproperty">
|
|---|
| 397 | <command>VBoxManage controlvm</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 choice="plain">vrdeproperty</arg>
|
|---|
| 403 | <arg choice="req"><replaceable>prop-name</replaceable>=<replaceable>prop-value</replaceable></arg>
|
|---|
| 404 | </cmdsynopsis>
|
|---|
| 405 |
|
|---|
| 406 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-vrdevideochannelquality">
|
|---|
| 407 | <command>VBoxManage controlvm</command>
|
|---|
| 408 | <group choice="req">
|
|---|
| 409 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 410 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 411 | </group>
|
|---|
| 412 | <arg choice="plain">vrdevideochannelquality</arg>
|
|---|
| 413 | <arg choice="req"><replaceable>percentage</replaceable></arg>
|
|---|
| 414 | </cmdsynopsis>
|
|---|
| 415 |
|
|---|
| 416 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-setvideomodehint">
|
|---|
| 417 | <command>VBoxManage controlvm</command>
|
|---|
| 418 | <group choice="req">
|
|---|
| 419 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 420 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 421 | </group>
|
|---|
| 422 | <arg choice="plain">setvideomodehint</arg>
|
|---|
| 423 | <arg choice="req"><replaceable>xres</replaceable></arg>
|
|---|
| 424 | <arg choice="req"><replaceable>yres</replaceable></arg>
|
|---|
| 425 | <arg choice="req"><replaceable>bpp</replaceable></arg>
|
|---|
| 426 | <arg><arg><replaceable>display</replaceable></arg><group>
|
|---|
| 427 | <arg choice="plain">enabled:yes | no</arg>
|
|---|
| 428 | <arg><replaceable>x-origin</replaceable> <replaceable>y-origin</replaceable></arg>
|
|---|
| 429 | </group></arg>
|
|---|
| 430 | </cmdsynopsis>
|
|---|
| 431 |
|
|---|
| 432 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-setscreenlayout">
|
|---|
| 433 | <command>VBoxManage controlvm</command>
|
|---|
| 434 | <group choice="req">
|
|---|
| 435 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 436 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 437 | </group>
|
|---|
| 438 | <arg choice="plain">setscreenlayout</arg>
|
|---|
| 439 | <arg choice="req"><replaceable>display</replaceable></arg>
|
|---|
| 440 | <group choice="req">
|
|---|
| 441 | <arg choice="plain">on</arg>
|
|---|
| 442 | <arg choice="plain">primary <replaceable>x-origin</replaceable> <replaceable>y-origin</replaceable> <replaceable>x-resolution</replaceable> <replaceable>y-resolution</replaceable> <replaceable>bpp</replaceable></arg>
|
|---|
| 443 | <arg choice="plain">off</arg>
|
|---|
| 444 | </group>
|
|---|
| 445 | </cmdsynopsis>
|
|---|
| 446 |
|
|---|
| 447 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-screenshotpng">
|
|---|
| 448 | <command>VBoxManage controlvm</command>
|
|---|
| 449 | <group choice="req">
|
|---|
| 450 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 451 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 452 | </group>
|
|---|
| 453 | <arg choice="plain">screenshotpng</arg>
|
|---|
| 454 | <arg choice="req"><replaceable>filename</replaceable></arg>
|
|---|
| 455 | <arg><replaceable>display</replaceable></arg>
|
|---|
| 456 | </cmdsynopsis>
|
|---|
| 457 |
|
|---|
| 458 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording">
|
|---|
| 459 | <command>VBoxManage controlvm</command>
|
|---|
| 460 | <group choice="req">
|
|---|
| 461 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 462 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 463 | </group>
|
|---|
| 464 | <arg choice="plain">recording</arg>
|
|---|
| 465 | <group choice="req">
|
|---|
| 466 | <arg choice="plain">on</arg>
|
|---|
| 467 | <arg choice="plain">off</arg>
|
|---|
| 468 | </group>
|
|---|
| 469 | </cmdsynopsis>
|
|---|
| 470 |
|
|---|
| 471 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-screens">
|
|---|
| 472 | <command>VBoxManage controlvm</command>
|
|---|
| 473 | <group choice="req">
|
|---|
| 474 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 475 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 476 | </group>
|
|---|
| 477 | <arg choice="plain">recording screens</arg>
|
|---|
| 478 | <group choice="req">
|
|---|
| 479 | <arg choice="plain">all</arg>
|
|---|
| 480 | <arg choice="plain">none</arg>
|
|---|
| 481 | <arg choice="plain"><replaceable>screen-ID</replaceable>[,<replaceable>screen-ID</replaceable>...]</arg>
|
|---|
| 482 | </group>
|
|---|
| 483 | </cmdsynopsis>
|
|---|
| 484 |
|
|---|
| 485 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-filename">
|
|---|
| 486 | <command>VBoxManage controlvm</command>
|
|---|
| 487 | <group choice="req">
|
|---|
| 488 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 489 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 490 | </group>
|
|---|
| 491 | <arg choice="plain">recording filename</arg>
|
|---|
| 492 | <arg choice="req">filename</arg>
|
|---|
| 493 | </cmdsynopsis>
|
|---|
| 494 |
|
|---|
| 495 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-videores">
|
|---|
| 496 | <command>VBoxManage controlvm</command>
|
|---|
| 497 | <group choice="req">
|
|---|
| 498 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 499 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 500 | </group>
|
|---|
| 501 | <arg choice="plain">recording videores</arg>
|
|---|
| 502 | <arg choice="req"><replaceable>width</replaceable>x<replaceable>height</replaceable></arg>
|
|---|
| 503 | </cmdsynopsis>
|
|---|
| 504 |
|
|---|
| 505 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-videorate">
|
|---|
| 506 | <command>VBoxManage controlvm</command>
|
|---|
| 507 | <group choice="req">
|
|---|
| 508 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 509 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 510 | </group>
|
|---|
| 511 | <arg choice="plain">recording videorate</arg>
|
|---|
| 512 | <arg choice="req"><replaceable>rate</replaceable></arg>
|
|---|
| 513 | </cmdsynopsis>
|
|---|
| 514 |
|
|---|
| 515 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-videofps">
|
|---|
| 516 | <command>VBoxManage controlvm</command>
|
|---|
| 517 | <group choice="req">
|
|---|
| 518 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 519 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 520 | </group>
|
|---|
| 521 | <arg choice="plain">recording videofps</arg>
|
|---|
| 522 | <arg choice="req"><replaceable>fps</replaceable></arg>
|
|---|
| 523 | </cmdsynopsis>
|
|---|
| 524 |
|
|---|
| 525 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-maxtime">
|
|---|
| 526 | <command>VBoxManage controlvm</command>
|
|---|
| 527 | <group choice="req">
|
|---|
| 528 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 529 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 530 | </group>
|
|---|
| 531 | <arg choice="plain">recording maxtime</arg>
|
|---|
| 532 | <arg choice="req"><replaceable>sec</replaceable></arg>
|
|---|
| 533 | </cmdsynopsis>
|
|---|
| 534 |
|
|---|
| 535 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-maxfilesize">
|
|---|
| 536 | <command>VBoxManage controlvm</command>
|
|---|
| 537 | <group choice="req">
|
|---|
| 538 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 539 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 540 | </group>
|
|---|
| 541 | <arg choice="plain">recording maxfilesize</arg>
|
|---|
| 542 | <arg choice="req"><replaceable>MB</replaceable></arg>
|
|---|
| 543 | </cmdsynopsis>
|
|---|
| 544 |
|
|---|
| 545 | <!--
|
|---|
| 546 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-recording-opts">
|
|---|
| 547 | <command>VBoxManage controlvm</command>
|
|---|
| 548 | <group choice="req">
|
|---|
| 549 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 550 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 551 | </group>
|
|---|
| 552 | <arg choice="plain">recording opts</arg>
|
|---|
| 553 | <arg choice="req"><replaceable>key</replaceable>=<arg><replaceable>value</replaceable></arg></arg>
|
|---|
| 554 | </cmdsynopsis>
|
|---|
| 555 | -->
|
|---|
| 556 |
|
|---|
| 557 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-setcredentials">
|
|---|
| 558 | <command>VBoxManage controlvm</command>
|
|---|
| 559 | <group choice="req">
|
|---|
| 560 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 561 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 562 | </group>
|
|---|
| 563 | <arg choice="plain">setcredentials</arg>
|
|---|
| 564 | <arg choice="req"><replaceable>username</replaceable></arg>
|
|---|
| 565 | <arg choice="plain">--passwordfile=<group choice="req">
|
|---|
| 566 | <arg choice="plain"><replaceable>filename</replaceable></arg>
|
|---|
| 567 | <arg choice="plain"><replaceable>password</replaceable></arg>
|
|---|
| 568 | </group></arg>
|
|---|
| 569 | <arg choice="req"><replaceable>domain-name</replaceable></arg>
|
|---|
| 570 | <arg choice="plain">--allowlocallogon=<group choice="req">
|
|---|
| 571 | <arg choice="plain">yes</arg>
|
|---|
| 572 | <arg choice="plain">no</arg>
|
|---|
| 573 | </group></arg>
|
|---|
| 574 | </cmdsynopsis>
|
|---|
| 575 |
|
|---|
| 576 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-teleport">
|
|---|
| 577 | <command>VBoxManage controlvm</command>
|
|---|
| 578 | <group choice="req">
|
|---|
| 579 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 580 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 581 | </group>
|
|---|
| 582 | <arg choice="plain">teleport</arg>
|
|---|
| 583 | <arg choice="req">--host=<replaceable>host-name</replaceable></arg>
|
|---|
| 584 | <arg choice="req">--port=<replaceable>port-name</replaceable></arg>
|
|---|
| 585 | <arg>--maxdowntime=<replaceable>msec</replaceable></arg>
|
|---|
| 586 | <group>
|
|---|
| 587 | <arg choice="plain">--passwordfile=<replaceable>filename</replaceable></arg>
|
|---|
| 588 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 589 | </group>
|
|---|
| 590 | </cmdsynopsis>
|
|---|
| 591 |
|
|---|
| 592 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-plugcpu">
|
|---|
| 593 | <command>VBoxManage controlvm</command>
|
|---|
| 594 | <group choice="req">
|
|---|
| 595 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 596 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 597 | </group>
|
|---|
| 598 | <arg choice="plain">plugcpu</arg>
|
|---|
| 599 | <arg choice="req"><replaceable>ID</replaceable></arg>
|
|---|
| 600 | </cmdsynopsis>
|
|---|
| 601 |
|
|---|
| 602 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-unplugcpu">
|
|---|
| 603 | <command>VBoxManage controlvm</command>
|
|---|
| 604 | <group choice="req">
|
|---|
| 605 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 606 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 607 | </group>
|
|---|
| 608 | <arg choice="plain">unplugcpu</arg>
|
|---|
| 609 | <arg choice="req"><replaceable>ID</replaceable></arg>
|
|---|
| 610 | </cmdsynopsis>
|
|---|
| 611 |
|
|---|
| 612 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-cpuexecutioncap">
|
|---|
| 613 | <command>VBoxManage controlvm</command>
|
|---|
| 614 | <group choice="req">
|
|---|
| 615 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 616 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 617 | </group>
|
|---|
| 618 | <arg choice="plain">cpuexecutioncap</arg>
|
|---|
| 619 | <arg choice="req"><replaceable>num</replaceable></arg>
|
|---|
| 620 | </cmdsynopsis>
|
|---|
| 621 |
|
|---|
| 622 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-vm-process-priority">
|
|---|
| 623 | <command>VBoxManage controlvm</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 choice="plain">vm-process-priority</arg>
|
|---|
| 629 | <group choice="req">
|
|---|
| 630 | <arg choice="plain">default</arg>
|
|---|
| 631 | <arg choice="plain">flat</arg>
|
|---|
| 632 | <arg choice="plain">low</arg>
|
|---|
| 633 | <arg choice="plain">normal</arg>
|
|---|
| 634 | <arg choice="plain">high</arg>
|
|---|
| 635 | </group>
|
|---|
| 636 | </cmdsynopsis>
|
|---|
| 637 |
|
|---|
| 638 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-webcam-attach">
|
|---|
| 639 | <command>VBoxManage controlvm</command>
|
|---|
| 640 | <group choice="req">
|
|---|
| 641 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 642 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 643 | </group>
|
|---|
| 644 | <arg choice="plain">webcam attach</arg>
|
|---|
| 645 | <arg><replaceable>pathname</replaceable><arg><replaceable>settings</replaceable></arg></arg>
|
|---|
| 646 | </cmdsynopsis>
|
|---|
| 647 |
|
|---|
| 648 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-webcam-detach">
|
|---|
| 649 | <command>VBoxManage controlvm</command>
|
|---|
| 650 | <group choice="req">
|
|---|
| 651 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 652 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 653 | </group>
|
|---|
| 654 | <arg choice="plain">webcam detach</arg>
|
|---|
| 655 | <arg><replaceable>pathname</replaceable></arg>
|
|---|
| 656 | </cmdsynopsis>
|
|---|
| 657 |
|
|---|
| 658 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-webcam-list">
|
|---|
| 659 | <command>VBoxManage controlvm</command>
|
|---|
| 660 | <group choice="req">
|
|---|
| 661 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 662 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 663 | </group>
|
|---|
| 664 | <arg choice="plain">webcam list</arg>
|
|---|
| 665 | </cmdsynopsis>
|
|---|
| 666 |
|
|---|
| 667 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-addencpassword">
|
|---|
| 668 | <command>VBoxManage controlvm</command>
|
|---|
| 669 | <group choice="req">
|
|---|
| 670 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 671 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 672 | </group>
|
|---|
| 673 | <arg choice="plain">addencpassword</arg>
|
|---|
| 674 | <arg choice="req"><replaceable>ID</replaceable></arg>
|
|---|
| 675 | <group choice="req">
|
|---|
| 676 | <arg choice="plain"><replaceable>password-file</replaceable></arg>
|
|---|
| 677 | <arg choice="plain">-</arg>
|
|---|
| 678 | </group>
|
|---|
| 679 | <arg>--removeonsuspend=<group choice="plain">
|
|---|
| 680 | <arg choice="plain">yes</arg>
|
|---|
| 681 | <arg choice="plain">no</arg>
|
|---|
| 682 | </group></arg>
|
|---|
| 683 | </cmdsynopsis>
|
|---|
| 684 |
|
|---|
| 685 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-removeencpassword">
|
|---|
| 686 | <command>VBoxManage controlvm</command>
|
|---|
| 687 | <group choice="req">
|
|---|
| 688 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 689 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 690 | </group>
|
|---|
| 691 | <arg choice="plain">removeencpassword</arg>
|
|---|
| 692 | <arg choice="req"><replaceable>ID</replaceable></arg>
|
|---|
| 693 | </cmdsynopsis>
|
|---|
| 694 |
|
|---|
| 695 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-removeallencpasswords">
|
|---|
| 696 | <command>VBoxManage controlvm</command>
|
|---|
| 697 | <group choice="req">
|
|---|
| 698 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 699 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 700 | </group>
|
|---|
| 701 | <arg choice="plain">removeallencpasswords</arg>
|
|---|
| 702 | </cmdsynopsis>
|
|---|
| 703 |
|
|---|
| 704 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-changeuartmode">
|
|---|
| 705 | <command>VBoxManage controlvm</command>
|
|---|
| 706 | <group choice="req">
|
|---|
| 707 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 708 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 709 | </group>
|
|---|
| 710 | <arg choice="plain">changeuartmode<replaceable>N</replaceable></arg>
|
|---|
| 711 | <group choice="plain">
|
|---|
| 712 | <arg choice="plain">disconnected</arg>
|
|---|
| 713 | <arg choice="plain">server <replaceable>pipe-name</replaceable></arg>
|
|---|
| 714 | <arg choice="plain">client <replaceable>pipe-name</replaceable></arg>
|
|---|
| 715 | <arg choice="plain">tcpserver <replaceable>port</replaceable></arg>
|
|---|
| 716 | <arg choice="plain">tcpclient <replaceable>hostname</replaceable>:<replaceable>port</replaceable></arg>
|
|---|
| 717 | <arg choice="plain">file <replaceable>filename</replaceable></arg>
|
|---|
| 718 | <arg choice="plain"><replaceable>device-name</replaceable></arg>
|
|---|
| 719 | </group>
|
|---|
| 720 | </cmdsynopsis>
|
|---|
| 721 |
|
|---|
| 722 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-autostart-enabled">
|
|---|
| 723 | <command>VBoxManage controlvm</command>
|
|---|
| 724 | <group choice="req">
|
|---|
| 725 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 726 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 727 | </group>
|
|---|
| 728 | <arg choice="plain">autostart-enabled<replaceable>N</replaceable></arg>
|
|---|
| 729 | <group choice="plain">
|
|---|
| 730 | <arg choice="plain">on</arg>
|
|---|
| 731 | <arg choice="plain">off</arg>
|
|---|
| 732 | </group>
|
|---|
| 733 | </cmdsynopsis>
|
|---|
| 734 |
|
|---|
| 735 | <cmdsynopsis id="synopsis-vboxmanage-controlvm-autostart-delay">
|
|---|
| 736 | <command>VBoxManage controlvm</command>
|
|---|
| 737 | <group choice="req">
|
|---|
| 738 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 739 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 740 | </group>
|
|---|
| 741 | <arg choice="plain">autostart-delay<replaceable>seconds</replaceable></arg>
|
|---|
| 742 | </cmdsynopsis>
|
|---|
| 743 | </refsynopsisdiv>
|
|---|
| 744 |
|
|---|
| 745 | <refsect1>
|
|---|
| 746 | <title>Description</title>
|
|---|
| 747 | <para>
|
|---|
| 748 | The <command>VBoxManage controlvm</command> command enables you to
|
|---|
| 749 | change the state of a running virtual machine (VM). The following
|
|---|
| 750 | sections describe the subcommands that you can use:
|
|---|
| 751 | </para>
|
|---|
| 752 | <refsect2 id="vboxmanage-controlvm-pause">
|
|---|
| 753 | <title>Pause a Virtual Machine</title>
|
|---|
| 754 | <remark role="help-copy-synopsis"/>
|
|---|
| 755 | <para>
|
|---|
| 756 | The <command>VBoxManage controlvm
|
|---|
| 757 | <replaceable>vmname</replaceable> pause</command> command
|
|---|
| 758 | temporarily stops the execution of a VM. When paused, the VM's
|
|---|
| 759 | state is not permanently changed.
|
|---|
| 760 | </para>
|
|---|
| 761 | <para>
|
|---|
| 762 | The VM window appears as gray and the title bar of the window
|
|---|
| 763 | indicates that the VM is currently Paused. This action is
|
|---|
| 764 | equivalent to selecting <emphasis role="bold">Pause</emphasis>
|
|---|
| 765 | from the <emphasis role="bold">Machine</emphasis> menu of the
|
|---|
| 766 | GUI.
|
|---|
| 767 | </para>
|
|---|
| 768 | </refsect2>
|
|---|
| 769 | <refsect2 id="vboxmanage-controlvm-resume">
|
|---|
| 770 | <title>Resume a Paused Virtual Machine</title>
|
|---|
| 771 | <remark role="help-copy-synopsis"/>
|
|---|
| 772 | <para>
|
|---|
| 773 | The <command>VBoxManage controlvm
|
|---|
| 774 | <replaceable>vmname</replaceable> resume</command> command
|
|---|
| 775 | restarts the execution of a paused VM. This action is equivalent
|
|---|
| 776 | to selecting <emphasis role="bold">Resume</emphasis> from the
|
|---|
| 777 | <emphasis role="bold">Machine</emphasis> menu of the GUI.
|
|---|
| 778 | </para>
|
|---|
| 779 | </refsect2>
|
|---|
| 780 | <refsect2 id="vboxmanage-controlvm-reset">
|
|---|
| 781 | <title>Reset a Virtual Machine</title>
|
|---|
| 782 | <remark role="help-copy-synopsis"/>
|
|---|
| 783 | <para>
|
|---|
| 784 | The <command>VBoxManage controlvm
|
|---|
| 785 | <replaceable>vmname</replaceable> reset</command> command
|
|---|
| 786 | performs a cold reset the VM. This command has the same effect
|
|---|
| 787 | on a VM as pressing the Reset button on a physical computer.
|
|---|
| 788 | </para>
|
|---|
| 789 | <para>
|
|---|
| 790 | The cold reboot immediately restarts and reboots the guest
|
|---|
| 791 | operating system (OS). The state of the VM is not saved prior to
|
|---|
| 792 | the reset, so data might be lost. This action is equivalent to
|
|---|
| 793 | selecting <emphasis role="bold">Reset</emphasis> from the
|
|---|
| 794 | <emphasis role="bold">Machine</emphasis> menu of the GUI.
|
|---|
| 795 | </para>
|
|---|
| 796 | </refsect2>
|
|---|
| 797 | <refsect2 id="vboxmanage-controlvm-poweroff">
|
|---|
| 798 | <title>Power Off a Virtual Machine</title>
|
|---|
| 799 | <remark role="help-copy-synopsis"/>
|
|---|
| 800 | <para>
|
|---|
| 801 | The <command>VBoxManage controlvm
|
|---|
| 802 | <replaceable>vmname</replaceable> poweroff</command> command
|
|---|
| 803 | powers off the VM. This command has the same effect on a VM as
|
|---|
| 804 | pulling the power cable on a physical computer.
|
|---|
| 805 | </para>
|
|---|
| 806 | <para>
|
|---|
| 807 | The state of the VM is not saved prior to poweroff, so data
|
|---|
| 808 | might be lost. This action is equivalent to selecting
|
|---|
| 809 | <emphasis role="bold">Close</emphasis> from the
|
|---|
| 810 | <emphasis role="bold">Machine</emphasis> menu of the GUI or to
|
|---|
| 811 | clicking the VM window's Close button, and then selecting
|
|---|
| 812 | <emphasis role="bold">Power Off the Machine</emphasis>.
|
|---|
| 813 | </para>
|
|---|
| 814 | <para>
|
|---|
| 815 | When in the powered off state, you can restart the VM. See
|
|---|
| 816 | <xref linkend="vboxmanage-startvm" />.
|
|---|
| 817 | </para>
|
|---|
| 818 | </refsect2>
|
|---|
| 819 | <refsect2 id="vboxmanage-controlvm-savestate">
|
|---|
| 820 | <title>Save the State of a Virtual Machine</title>
|
|---|
| 821 | <remark role="help-copy-synopsis"/>
|
|---|
| 822 | <para>
|
|---|
| 823 | The <command>VBoxManage controlvm
|
|---|
| 824 | <replaceable>vmname</replaceable> savestate</command> command
|
|---|
| 825 | saves the current state of the VM to disk and then stops the VM.
|
|---|
| 826 | </para>
|
|---|
| 827 | <para>
|
|---|
| 828 | This action is equivalent to selecting
|
|---|
| 829 | <emphasis role="bold">Close</emphasis> from the
|
|---|
| 830 | <emphasis role="bold">Machine</emphasis> menu of the GUI or to
|
|---|
| 831 | clicking the VM window's Close button, and then selecting
|
|---|
| 832 | <emphasis role="bold">Save the Machine State</emphasis>.
|
|---|
| 833 | </para>
|
|---|
| 834 | <para>
|
|---|
| 835 | When in the saved state, you can restart the VM. It will continue
|
|---|
| 836 | exactly in the state you saved.
|
|---|
| 837 | </para>
|
|---|
| 838 | </refsect2>
|
|---|
| 839 | <refsect2 id="vboxmanage-controlvm-acpipowerbutton">
|
|---|
| 840 | <title>Send an APCI Shutdown Signal to a Virtual Machine</title>
|
|---|
| 841 | <remark role="help-copy-synopsis"/>
|
|---|
| 842 | <para>
|
|---|
| 843 | The <command>VBoxManage controlvm
|
|---|
| 844 | <replaceable>vmname</replaceable> acpipowerbutton</command>
|
|---|
| 845 | command sends an ACPI shutdown signal to the VM. This command
|
|---|
| 846 | has the same effect on a VM as pressing the Power button on a
|
|---|
| 847 | physical computer.
|
|---|
| 848 | </para>
|
|---|
| 849 | <para>
|
|---|
| 850 | So long as the VM runs a guest OS that provides appropriately
|
|---|
| 851 | configured ACPI support, this command triggers an operating
|
|---|
| 852 | system shutdown from within the VM.
|
|---|
| 853 | </para>
|
|---|
| 854 | </refsect2>
|
|---|
| 855 | <refsect2 id="vboxmanage-controlvm-acpisleepbutton">
|
|---|
| 856 | <title>Send an APCI Sleep Signal to a Virtual Machine</title>
|
|---|
| 857 | <remark role="help-copy-synopsis"/>
|
|---|
| 858 | <para>
|
|---|
| 859 | The <command>VBoxManage controlvm
|
|---|
| 860 | <replaceable>vmname</replaceable> acpisleepbutton</command>
|
|---|
| 861 | command sends an ACPI sleep signal to the VM.
|
|---|
| 862 | </para>
|
|---|
| 863 | <para>
|
|---|
| 864 | So long as the VM runs a guest OS that provides appropriately
|
|---|
| 865 | configured ACPI support, this command triggers a sleep mechanism
|
|---|
| 866 | from within the VM.
|
|---|
| 867 | </para>
|
|---|
| 868 | </refsect2>
|
|---|
| 869 | <refsect2 id="vboxmanage-controlvm-reboot">
|
|---|
| 870 | <title>Reboot the guest OS</title>
|
|---|
| 871 | <remark role="help-copy-synopsis"/>
|
|---|
| 872 | <para>
|
|---|
| 873 | The <command>VBoxManage controlvm
|
|---|
| 874 | <replaceable>vmname</replaceable> reboot</command>
|
|---|
| 875 | command asks the guest OS to reboot itself.
|
|---|
| 876 | </para>
|
|---|
| 877 | <para>
|
|---|
| 878 | This commands requires Guest Additions to be installed in the VM.
|
|---|
| 879 | </para>
|
|---|
| 880 | </refsect2>
|
|---|
| 881 | <refsect2 id="vboxmanage-controlvm-shutdown">
|
|---|
| 882 | <title>Shut down the guest OS</title>
|
|---|
| 883 | <remark role="help-copy-synopsis"/>
|
|---|
| 884 | <para>
|
|---|
| 885 | The <command>VBoxManage controlvm
|
|---|
| 886 | <replaceable>vmname</replaceable> shutdown</command>
|
|---|
| 887 | command asks the guest OS to halt + shutdown, optionally forcing
|
|---|
| 888 | the shutdown.
|
|---|
| 889 | </para>
|
|---|
| 890 | <para>
|
|---|
| 891 | This commands requires Guest Additions to be installed in the VM.
|
|---|
| 892 | </para>
|
|---|
| 893 | </refsect2>
|
|---|
| 894 | <refsect2 id="vboxmanage-controlvm-keyboardputscancode">
|
|---|
| 895 | <title>Send Keyboard Scancodes to a Virtual Machine</title>
|
|---|
| 896 | <remark role="help-copy-synopsis"/>
|
|---|
| 897 | <para>
|
|---|
| 898 | The <command>VBoxManage controlvm
|
|---|
| 899 | <replaceable>vmname</replaceable> keyboardputscancode</command>
|
|---|
| 900 | command sends keyboard scancode commands to the VM.
|
|---|
| 901 | </para>
|
|---|
| 902 | <para>
|
|---|
| 903 | For information about keyboard scancodes, see
|
|---|
| 904 | <ulink url="http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html" />.
|
|---|
| 905 | </para>
|
|---|
| 906 | </refsect2>
|
|---|
| 907 | <refsect2 id="vboxmanage-controlvm-keyboardputstring">
|
|---|
| 908 | <title>Send Keyboard Strings to a Virtual Machine</title>
|
|---|
| 909 | <remark role="help-copy-synopsis"/>
|
|---|
| 910 | <para>
|
|---|
| 911 | The <command>VBoxManage controlvm
|
|---|
| 912 | <replaceable>vmname</replaceable> keyboardputstring</command>
|
|---|
| 913 | command sends keyboard strings to the VM.
|
|---|
| 914 | </para>
|
|---|
| 915 | </refsect2>
|
|---|
| 916 | <refsect2 id="vboxmanage-controlvm-keyboardputfile">
|
|---|
| 917 | <title>Send a File to a Virtual Machine</title>
|
|---|
| 918 | <remark role="help-copy-synopsis"/>
|
|---|
| 919 | <para>
|
|---|
| 920 | The <command>VBoxManage controlvm
|
|---|
| 921 | <replaceable>vmname</replaceable> keyboardputfile</command>
|
|---|
| 922 | command sends a file to the VM.
|
|---|
| 923 | </para>
|
|---|
| 924 | </refsect2>
|
|---|
| 925 | <refsect2 id="vboxmanage-controlvm-setlinkstate">
|
|---|
| 926 | <title>Set the Link State for a Virtual Machine</title>
|
|---|
| 927 | <remark role="help-copy-synopsis"/>
|
|---|
| 928 | <para>
|
|---|
| 929 | <command>VBoxManage controlvm <replaceable>vmname</replaceable>
|
|---|
| 930 | setlinkstate<replaceable>N</replaceable></command> command
|
|---|
| 931 | enables you to connect or disconnect the virtual network cable
|
|---|
| 932 | from the network interface instance
|
|---|
| 933 | (<replaceable>N</replaceable>). Valid values are
|
|---|
| 934 | <literal>on</literal> and <literal>off</literal>. The default
|
|---|
| 935 | value is <literal>on</literal>.
|
|---|
| 936 | </para>
|
|---|
| 937 | </refsect2>
|
|---|
| 938 | <refsect2 id="vboxmanage-controlvm-nic">
|
|---|
| 939 | <title>Set the Type of Networking to Use for a Virtual Machine</title>
|
|---|
| 940 | <remark role="help-copy-synopsis"/>
|
|---|
| 941 | <para>
|
|---|
| 942 | The <command>VBoxManage controlvm
|
|---|
| 943 | <replaceable>vmname</replaceable>
|
|---|
| 944 | nic<replaceable>N</replaceable></command> command specifies the
|
|---|
| 945 | type of networking to use on the specified VM's virtual network
|
|---|
| 946 | card. <replaceable>N</replaceable> numbering begins with
|
|---|
| 947 | <literal>1</literal>.
|
|---|
| 948 | </para>
|
|---|
| 949 | <para>
|
|---|
| 950 | The following valid network types are also described in
|
|---|
| 951 | <xref linkend="networkingmodes" />:
|
|---|
| 952 | </para>
|
|---|
| 953 | <itemizedlist>
|
|---|
| 954 | <listitem><para>
|
|---|
| 955 | <literal>null</literal> specifies that the VM is is not
|
|---|
| 956 | connected to the host system.
|
|---|
| 957 | </para></listitem>
|
|---|
| 958 | <listitem><para>
|
|---|
| 959 | <literal>nat</literal> specifies that the VM uses network
|
|---|
| 960 | address translation (NAT).
|
|---|
| 961 | </para></listitem>
|
|---|
| 962 | <listitem><para>
|
|---|
| 963 | <literal>bridged</literal> specifies that the VM uses
|
|---|
| 964 | bridged networking.
|
|---|
| 965 | </para></listitem>
|
|---|
| 966 | <listitem><para>
|
|---|
| 967 | <literal>intnet</literal> specifies that the VM communicates
|
|---|
| 968 | with other VMs by using internal networking.
|
|---|
| 969 | </para></listitem>
|
|---|
| 970 | <listitem><para>
|
|---|
| 971 | <literal>hostonly</literal> specifies that the VM uses
|
|---|
| 972 | host-only networking.
|
|---|
| 973 | </para></listitem>
|
|---|
| 974 | <listitem><para>
|
|---|
| 975 | <literal>natnetwork</literal> specifies that the VM uses NAT
|
|---|
| 976 | networking.
|
|---|
| 977 | </para></listitem>
|
|---|
| 978 | <listitem><para>
|
|---|
| 979 | <literal>generic</literal> specifies that the VM has access
|
|---|
| 980 | to rarely used submodes
|
|---|
| 981 | </para></listitem>
|
|---|
| 982 | </itemizedlist>
|
|---|
| 983 | </refsect2>
|
|---|
| 984 | <refsect2 id="vboxmanage-controlvm-nictrace">
|
|---|
| 985 | <title>Trace the Network Traffic of a Virtual Machine</title>
|
|---|
| 986 | <remark role="help-copy-synopsis"/>
|
|---|
| 987 | <para>
|
|---|
| 988 | The <command>VBoxManage controlvm
|
|---|
| 989 | <replaceable>vmname</replaceable>
|
|---|
| 990 | nictrace<replaceable>N</replaceable></command> command enables
|
|---|
| 991 | you to trace the network traffic on the specified virtual
|
|---|
| 992 | network card (<replaceable>N</replaceable>).
|
|---|
| 993 | <replaceable>N</replaceable> numbering begins with
|
|---|
| 994 | <literal>1</literal>. Valid values are <literal>on</literal> and
|
|---|
| 995 | <literal>off</literal>. The default value is
|
|---|
| 996 | <literal>off</literal>.
|
|---|
| 997 | </para>
|
|---|
| 998 | <para>
|
|---|
| 999 | If you did not configure a file name for the trace file then
|
|---|
| 1000 | a default one is used, placing it in the VM subdirectory.
|
|---|
| 1001 | </para>
|
|---|
| 1002 | </refsect2>
|
|---|
| 1003 | <refsect2 id="vboxmanage-controlvm-nictracefile">
|
|---|
| 1004 | <title>Specify the Network Traffic Trace Log File for a Virtual Machine</title>
|
|---|
| 1005 | <remark role="help-copy-synopsis"/>
|
|---|
| 1006 | <para>
|
|---|
| 1007 | The <command>VBoxManage controlvm
|
|---|
| 1008 | <replaceable>vmname</replaceable>
|
|---|
| 1009 | nictracefile<replaceable>N</replaceable></command> command
|
|---|
| 1010 | enables you to specify the name of the network traffic trace log
|
|---|
| 1011 | file for the specified virtual network card
|
|---|
| 1012 | (<replaceable>N</replaceable>). <replaceable>N</replaceable>
|
|---|
| 1013 | numbering begins with <literal>1</literal>.
|
|---|
| 1014 | </para>
|
|---|
| 1015 | </refsect2>
|
|---|
| 1016 | <refsect2 id="vboxmanage-controlvm-nicpromisc">
|
|---|
| 1017 | <title>Specify the Promiscuous Mode to Use for a Virtual Machine</title>
|
|---|
| 1018 | <remark role="help-copy-synopsis"/>
|
|---|
| 1019 | <para>
|
|---|
| 1020 | The <command>VBoxManage controlvm
|
|---|
| 1021 | <replaceable>vmname</replaceable>
|
|---|
| 1022 | nicpromisc<replaceable>N</replaceable></command> command enables
|
|---|
| 1023 | you to specify how to handle promiscuous mode for a bridged
|
|---|
| 1024 | network. The default value of <literal>deny</literal> hides any
|
|---|
| 1025 | traffic that is not intended for this VM. The
|
|---|
| 1026 | <literal>allow-vms</literal> value hides all host traffic from
|
|---|
| 1027 | this VM but enables the VM to see traffic to and from other VMs.
|
|---|
| 1028 | The <literal>allow-all</literal> value removes this restriction
|
|---|
| 1029 | completely.
|
|---|
| 1030 | </para>
|
|---|
| 1031 | </refsect2>
|
|---|
| 1032 | <refsect2 id="vboxmanage-controlvm-nicproperty">
|
|---|
| 1033 | <title>Specify the Network Backend Property Values for a Virtual Machine</title>
|
|---|
| 1034 | <remark role="help-copy-synopsis"/>
|
|---|
| 1035 | <para>
|
|---|
| 1036 | The <command>VBoxManage controlvm
|
|---|
| 1037 | <replaceable>vmname</replaceable>
|
|---|
| 1038 | nicproperty<replaceable>N</replaceable>
|
|---|
| 1039 | <replaceable>prop-name</replaceable>=<replaceable>prop-value</replaceable></command>
|
|---|
| 1040 | command, in combination with <literal>nicgenericdrv</literal>,
|
|---|
| 1041 | enables you to pass property values to rarely-used network
|
|---|
| 1042 | backends.
|
|---|
| 1043 | </para>
|
|---|
| 1044 | <para>
|
|---|
| 1045 | Those properties are backend engine-specific, and are different
|
|---|
| 1046 | between UDP Tunnel and the VDE backend drivers. See
|
|---|
| 1047 | <xref linkend="network_udp_tunnel" />.
|
|---|
| 1048 | </para>
|
|---|
| 1049 | </refsect2>
|
|---|
| 1050 | <refsect2 id="vboxmanage-controlvm-natpf">
|
|---|
| 1051 | <title>Specify a NAT Port Forwarding Rule for a Virtual Machine</title>
|
|---|
| 1052 | <remark role="help-copy-synopsis"/>
|
|---|
| 1053 | <para>
|
|---|
| 1054 | The <command>VBoxManage controlvm
|
|---|
| 1055 | <replaceable>vmname</replaceable>
|
|---|
| 1056 | natpf<replaceable>N</replaceable></command> command specifies a
|
|---|
| 1057 | NAT port-forwarding rule. See <xref linkend="natforward"/>.
|
|---|
| 1058 | </para>
|
|---|
| 1059 | </refsect2>
|
|---|
| 1060 | <refsect2 id="vboxmanage-controlvm-natpf-delete">
|
|---|
| 1061 | <title>Delete a NAT Port Forwarding Rule for a Virtual Machine</title>
|
|---|
| 1062 | <remark role="help-copy-synopsis"/>
|
|---|
| 1063 | <para>
|
|---|
| 1064 | The <command>VBoxManage controlvm
|
|---|
| 1065 | <replaceable>vmname</replaceable>
|
|---|
| 1066 | natpf<replaceable>N</replaceable> delete</command> command deletes
|
|---|
| 1067 | the specified NAT port-forwarding rule. See
|
|---|
| 1068 | <xref linkend="natforward"/>.
|
|---|
| 1069 | </para>
|
|---|
| 1070 | </refsect2>
|
|---|
| 1071 | <refsect2 id="vboxmanage-controlvm-guestmemoryballoon">
|
|---|
| 1072 | <title>Change Size of a Virtual Machine's Guest Memory Balloon</title>
|
|---|
| 1073 | <remark role="help-copy-synopsis"/>
|
|---|
| 1074 | <para>
|
|---|
| 1075 | The <command>VBoxManage controlvm
|
|---|
| 1076 | <replaceable>vmname</replaceable> guestmemoryballoon</command>
|
|---|
| 1077 | command changes the size of the guest memory balloon. The guest
|
|---|
| 1078 | memory balloon is the memory allocated by the &product-name;
|
|---|
| 1079 | Guest Additions from the guest OS and returned to the hypervisor
|
|---|
| 1080 | for reuse by other VMs. The value you specify is in megabytes.
|
|---|
| 1081 | See <xref linkend="guestadd-balloon" />.
|
|---|
| 1082 | </para>
|
|---|
| 1083 | </refsect2>
|
|---|
| 1084 | <refsect2 id="vboxmanage-controlvm-usbattach">
|
|---|
| 1085 | <title>Make a Host System USB Device Visible to a Virtual Machine</title>
|
|---|
| 1086 | <remark role="help-copy-synopsis"/>
|
|---|
| 1087 | <para>
|
|---|
| 1088 | The <command>VBoxManage controlvm
|
|---|
| 1089 | <replaceable>vmname</replaceable> usbattach</command> command
|
|---|
| 1090 | dynamically attaches a host USB device to the VM, which makes it
|
|---|
| 1091 | visible. You do not need to create a filter.
|
|---|
| 1092 | </para>
|
|---|
| 1093 | <para>
|
|---|
| 1094 | Specify a USB device by its Universally Unique Identifier (UUID)
|
|---|
| 1095 | or by its address on the host system. Use the
|
|---|
| 1096 | <command>VBoxManage list usbhost</command> command to obtain
|
|---|
| 1097 | information about USB devices on the host system.
|
|---|
| 1098 | </para>
|
|---|
| 1099 | <para>
|
|---|
| 1100 | Use the <option>--capturefile</option> option to specify the
|
|---|
| 1101 | absolute path of a file in which to write logging data.
|
|---|
| 1102 | </para>
|
|---|
| 1103 | </refsect2>
|
|---|
| 1104 | <refsect2 id="vboxmanage-controlvm-usbdetach">
|
|---|
| 1105 | <title>Make a Host System USB Device Invisible to a Virtual Machine</title>
|
|---|
| 1106 | <remark role="help-copy-synopsis"/>
|
|---|
| 1107 | <para>
|
|---|
| 1108 | The <command>VBoxManage controlvm
|
|---|
| 1109 | <replaceable>vmname</replaceable> usbdetach</command> command
|
|---|
| 1110 | dynamically detaches a host USB device from the VM, which makes
|
|---|
| 1111 | it invisible. You do not need to create a filter.
|
|---|
| 1112 | </para>
|
|---|
| 1113 | <para>
|
|---|
| 1114 | Specify a USB device by its UUID or by its address on the host
|
|---|
| 1115 | system. Use the <command>VBoxManage list usbhost</command>
|
|---|
| 1116 | command to obtain information about USB devices on the host
|
|---|
| 1117 | system.
|
|---|
| 1118 | </para>
|
|---|
| 1119 | </refsect2>
|
|---|
| 1120 | <refsect2 id="vboxmanage-controlvm-audioin">
|
|---|
| 1121 | <title>Enable or Disable Audio Capture From the Host System</title>
|
|---|
| 1122 | <remark role="help-copy-synopsis"/>
|
|---|
| 1123 | <para>
|
|---|
| 1124 | The <command>VBoxManage controlvm
|
|---|
| 1125 | <replaceable>vmname</replaceable> audioin</command> command
|
|---|
| 1126 | specifies whether to enable or disable audio capture from the
|
|---|
| 1127 | host system. Valid values are <literal>on</literal>, which
|
|---|
| 1128 | enables audio capture and <literal>off</literal>, which disables
|
|---|
| 1129 | audio capture. The default value is <literal>off</literal>.
|
|---|
| 1130 | </para>
|
|---|
| 1131 | </refsect2>
|
|---|
| 1132 | <refsect2 id="vboxmanage-controlvm-audioout">
|
|---|
| 1133 | <title>Enable or Disable Audio Playback From a Virtual Machine</title>
|
|---|
| 1134 | <remark role="help-copy-synopsis"/>
|
|---|
| 1135 | <para>
|
|---|
| 1136 | The <command>VBoxManage controlvm
|
|---|
| 1137 | <replaceable>vmname</replaceable> audioout</command> command
|
|---|
| 1138 | specifies whether to enable or disable audio playback from the
|
|---|
| 1139 | guest VM. Valid values are <literal>on</literal>, which enables
|
|---|
| 1140 | audio playback and <literal>off</literal>, which disables audio
|
|---|
| 1141 | playback. The default value is <literal>off</literal>.
|
|---|
| 1142 | </para>
|
|---|
| 1143 | </refsect2>
|
|---|
| 1144 | <refsect2 id="vboxmanage-controlvm-clipboard-mode">
|
|---|
| 1145 | <title>Specify How to Share the Host OS or Guest OS Clipboard</title>
|
|---|
| 1146 | <remark role="help-copy-synopsis"/>
|
|---|
| 1147 | <para>
|
|---|
| 1148 | The <command>VBoxManage controlvm
|
|---|
| 1149 | <replaceable>vmname</replaceable> clipboard mode</command> command
|
|---|
| 1150 | specifies how to share the guest or host OS's clipboard with the
|
|---|
| 1151 | host system or VM. Valid values are <literal>disabled</literal>,
|
|---|
| 1152 | <literal>hosttoguest</literal>, <literal>guesttohost</literal>,
|
|---|
| 1153 | and <literal>bidirectional</literal>. The default value is
|
|---|
| 1154 | <literal>disabled</literal>. See
|
|---|
| 1155 | <xref linkend="generalsettings" />.
|
|---|
| 1156 | </para>
|
|---|
| 1157 | <para>
|
|---|
| 1158 | This feature requires that the &product-name; Guest Additions
|
|---|
| 1159 | are installed in the VM.
|
|---|
| 1160 | </para>
|
|---|
| 1161 | </refsect2>
|
|---|
| 1162 |
|
|---|
| 1163 | <refsect2 id="vboxmanage-controlvm-clipboard-filetransfers">
|
|---|
| 1164 | <title>Specify If Files Can Be Transferred Through the Clipboard</title>
|
|---|
| 1165 | <remark role="help-copy-synopsis"/>
|
|---|
| 1166 | <para>
|
|---|
| 1167 | The <command>VBoxManage controlvm
|
|---|
| 1168 | <replaceable>vmname</replaceable> clipboard filetransfers</command>
|
|---|
| 1169 | command specifies if it is possible to transfer files through the
|
|---|
| 1170 | clipboard between the host and VM, in the direction which is allowed.
|
|---|
| 1171 | Valid values are <literal>off</literal> and <literal>on</literal>.
|
|---|
| 1172 | The default value is <literal>off</literal>.
|
|---|
| 1173 | </para>
|
|---|
| 1174 | <para>
|
|---|
| 1175 | This feature requires that the &product-name; Guest Additions
|
|---|
| 1176 | are installed in the VM.
|
|---|
| 1177 | </para>
|
|---|
| 1178 | </refsect2>
|
|---|
| 1179 |
|
|---|
| 1180 | <refsect2 id="vboxmanage-controlvm-draganddrop">
|
|---|
| 1181 | <title>Set the Drag and Drop Mode Between the Host System and a Virtual Machine</title>
|
|---|
| 1182 | <remark role="help-copy-synopsis"/>
|
|---|
| 1183 | <para>
|
|---|
| 1184 | The <command>VBoxManage controlvm
|
|---|
| 1185 | <replaceable>vmname</replaceable> draganddrop</command> command
|
|---|
| 1186 | specifies the current drag and drop mode to use between the host
|
|---|
| 1187 | system and the VM. Valid values are <literal>disabled</literal>,
|
|---|
| 1188 | <literal>hosttoguest</literal>, <literal>guesttohost</literal>,
|
|---|
| 1189 | and <literal>bidirectional</literal>. The default value is
|
|---|
| 1190 | <literal>disabled</literal>. See
|
|---|
| 1191 | <xref linkend="guestadd-dnd" />.
|
|---|
| 1192 | </para>
|
|---|
| 1193 | <para>
|
|---|
| 1194 | This feature requires that the &product-name; Guest Additions
|
|---|
| 1195 | are installed in the VM.
|
|---|
| 1196 | </para>
|
|---|
| 1197 | </refsect2>
|
|---|
| 1198 | <refsect2 id="vboxmanage-controlvm-vrde">
|
|---|
| 1199 | <title>Enable or Disable the VRDE Server</title>
|
|---|
| 1200 | <remark role="help-copy-synopsis"/>
|
|---|
| 1201 | <para>
|
|---|
| 1202 | The <command>VBoxManage controlvm
|
|---|
| 1203 | <replaceable>vmname</replaceable> vrde</command> command enables
|
|---|
| 1204 | or disables the VirtualBox Remote Desktop Extension (VRDE)
|
|---|
| 1205 | server, if installed. Valid values are <literal>on</literal> and
|
|---|
| 1206 | <literal>off</literal>. The default value is
|
|---|
| 1207 | <literal>off</literal>.
|
|---|
| 1208 | </para>
|
|---|
| 1209 | </refsect2>
|
|---|
| 1210 | <refsect2 id="vboxmanage-controlvm-vrdeport">
|
|---|
| 1211 | <title>Specify VRDE Server Ports</title>
|
|---|
| 1212 | <remark role="help-copy-synopsis"/>
|
|---|
| 1213 | <para>
|
|---|
| 1214 | The <command>VBoxManage controlvm
|
|---|
| 1215 | <replaceable>vmname</replaceable> vrdeport</command> command
|
|---|
| 1216 | specifies the port or range of ports to which the VRDE server
|
|---|
| 1217 | can bind. The default value is <literal>default</literal> or
|
|---|
| 1218 | <literal>0</literal>, which is the standard RDP port,
|
|---|
| 1219 | <literal>3389</literal>.
|
|---|
| 1220 | </para>
|
|---|
| 1221 | <para>
|
|---|
| 1222 | Also see the <option>--vrde-port</option> option description in
|
|---|
| 1223 | <xref linkend="vboxmanage-modifyvm-vrde" />.
|
|---|
| 1224 | </para>
|
|---|
| 1225 | </refsect2>
|
|---|
| 1226 | <refsect2 id="vboxmanage-controlvm-vrdeproperty">
|
|---|
| 1227 | <title>Specify VRDE Server Port Numbers and IP Addresses</title>
|
|---|
| 1228 | <remark role="help-copy-synopsis"/>
|
|---|
| 1229 | <para>
|
|---|
| 1230 | The <command>VBoxManage controlvm
|
|---|
| 1231 | <replaceable>vmname</replaceable> vrdeproperty</command> command
|
|---|
| 1232 | specifies the port numbers and IP address on the VM to which the
|
|---|
| 1233 | VRDE server can bind.
|
|---|
| 1234 | </para>
|
|---|
| 1235 | <itemizedlist>
|
|---|
| 1236 | <listitem><para>
|
|---|
| 1237 | <literal>TCP/Ports</literal> specifies a port or a range of
|
|---|
| 1238 | ports to which the VRDE server can bind. The default value
|
|---|
| 1239 | is <literal>default</literal> or <literal>0</literal>, which
|
|---|
| 1240 | is the standard RDP port, <literal>3389</literal>.
|
|---|
| 1241 | </para><para>
|
|---|
| 1242 | Also see the <option>--vrde-port</option> option description
|
|---|
| 1243 | in <xref linkend="vboxmanage-modifyvm-vrde" />.
|
|---|
| 1244 | </para></listitem>
|
|---|
| 1245 | <listitem><para>
|
|---|
| 1246 | <literal>TCP/Address</literal> specifies the IP address of
|
|---|
| 1247 | the host network interface to which the VRDE server binds.
|
|---|
| 1248 | When specified, the server accepts to connect only on the
|
|---|
| 1249 | specified host network interface.
|
|---|
| 1250 | </para><para>
|
|---|
| 1251 | Also see the <option>--vrde-address</option> option
|
|---|
| 1252 | description in <xref linkend="vboxmanage-modifyvm-vrde" />.
|
|---|
| 1253 | </para></listitem>
|
|---|
| 1254 | <listitem><para>
|
|---|
| 1255 | <literal>VideoChannel/Enabled</literal> specifies whether to
|
|---|
| 1256 | enable the VirtualBox Remote Desktop Protocol (VRDP) video
|
|---|
| 1257 | channel. Valid values are <literal>1</literal> to enable the
|
|---|
| 1258 | video channel and <literal>0</literal> to disable the video
|
|---|
| 1259 | channel. The default value is <literal>off</literal>. See
|
|---|
| 1260 | <xref linkend="vrde-videochannel" />.
|
|---|
| 1261 | </para></listitem>
|
|---|
| 1262 | <listitem><para>
|
|---|
| 1263 | <literal>VideoChannel/Quality</literal> specifies the JPEG
|
|---|
| 1264 | compression level on the VRDE server video channel. Valid
|
|---|
| 1265 | values are between 10% and 100%, inclusive. Lower values
|
|---|
| 1266 | mean lower quality but higher compression. The default value
|
|---|
| 1267 | is <literal>100</literal>. See
|
|---|
| 1268 | <xref linkend="vrde-videochannel" />.
|
|---|
| 1269 | </para></listitem>
|
|---|
| 1270 | <listitem><para>
|
|---|
| 1271 | <literal>VideoChannel/DownscaleProtection</literal>
|
|---|
| 1272 | specifies whether to enable the video channel downscale
|
|---|
| 1273 | protection feature. Specify <literal>1</literal> to enable
|
|---|
| 1274 | the feature. This feature is disabled by default.
|
|---|
| 1275 | </para><para>
|
|---|
| 1276 | When enabled, if the video's size equals the shadow buffer
|
|---|
| 1277 | size, the video is shown in full-screen mode. If the video's
|
|---|
| 1278 | size is between full-screen mode and the downscale
|
|---|
| 1279 | threshold, the video is not shown as it might be an
|
|---|
| 1280 | application window that is unreadable when downscaled. When
|
|---|
| 1281 | disabled, the downscale protection feature always attempts
|
|---|
| 1282 | to show videos.
|
|---|
| 1283 | </para></listitem>
|
|---|
| 1284 | <listitem><para>
|
|---|
| 1285 | <literal>Client/DisableDisplay</literal> specifies whether
|
|---|
| 1286 | to disable the VRDE server display feature. Valid values are
|
|---|
| 1287 | <literal>1</literal> to disable the feature and an empty
|
|---|
| 1288 | string (<literal>""</literal>) to enable the feature.
|
|---|
| 1289 | The default value is an empty string. See
|
|---|
| 1290 | <xref linkend="vrde-customization"/>.
|
|---|
| 1291 | </para></listitem>
|
|---|
| 1292 | <listitem><para>
|
|---|
| 1293 | <literal>Client/DisableInput</literal> specifies whether to
|
|---|
| 1294 | disable the VRDE server input feature. Valid values are
|
|---|
| 1295 | <literal>1</literal> to disable the feature and an empty
|
|---|
| 1296 | string (<literal>""</literal>) to enable the feature.
|
|---|
| 1297 | The default value is <literal>1</literal>. See
|
|---|
| 1298 | <xref linkend="vrde-customization"/>.
|
|---|
| 1299 | </para></listitem>
|
|---|
| 1300 | <listitem><para>
|
|---|
| 1301 | <literal>Client/DisableAudio</literal> specifies whether to
|
|---|
| 1302 | disable the VRDE server audio feature. Valid values are
|
|---|
| 1303 | <literal>1</literal> to disable the feature and an empty
|
|---|
| 1304 | string (<literal>""</literal>) to enable the feature.
|
|---|
| 1305 | The default value is <literal>1</literal>. See
|
|---|
| 1306 | <xref linkend="vrde-customization"/>.
|
|---|
| 1307 | </para></listitem>
|
|---|
| 1308 | <listitem><para>
|
|---|
| 1309 | <literal>Client/DisableUSB</literal> specifies whether to
|
|---|
| 1310 | disable the VRDE server USB feature. Valid values are
|
|---|
| 1311 | <literal>1</literal> to disable the feature and an empty
|
|---|
| 1312 | string (<literal>""</literal>) to enable the feature.
|
|---|
| 1313 | The default value is <literal>1</literal>. See
|
|---|
| 1314 | <xref linkend="vrde-customization"/>.
|
|---|
| 1315 | </para></listitem>
|
|---|
| 1316 | <listitem><para>
|
|---|
| 1317 | <literal>Client/DisableClipboard</literal> specifies whether
|
|---|
| 1318 | to disable the VRDE clipboard feature. Valid values are
|
|---|
| 1319 | <literal>1</literal> to disable the feature and an empty
|
|---|
| 1320 | string (<literal>""</literal>) to enable the feature.
|
|---|
| 1321 | To reenable the feature, use
|
|---|
| 1322 | <literal>Client/DisableClipboard=</literal>. The default
|
|---|
| 1323 | value is <literal>1</literal>. See
|
|---|
| 1324 | <xref linkend="vrde-customization"/>.
|
|---|
| 1325 | </para></listitem>
|
|---|
| 1326 | <listitem><para>
|
|---|
| 1327 | <literal>Client/DisableUpstreamAudio</literal> specifies
|
|---|
| 1328 | whether to disable the VRDE upstream audio feature. Valid
|
|---|
| 1329 | values are <literal>1</literal> to disable the feature and
|
|---|
| 1330 | an empty string (<literal>""</literal>) to enable the
|
|---|
| 1331 | feature. To reenable the feature, use
|
|---|
| 1332 | <literal>Client/DisableUpstreamAudio=</literal>. The default
|
|---|
| 1333 | value is <literal>1</literal>. See
|
|---|
| 1334 | <xref linkend="vrde-customization"/>.
|
|---|
| 1335 | </para></listitem>
|
|---|
| 1336 | <listitem><para>
|
|---|
| 1337 | <literal>Client/DisableRDPDR</literal> specifies whether to
|
|---|
| 1338 | disable the RDP Device Redirection For Smart Cards feature
|
|---|
| 1339 | on the VRDE server. Valid values are <literal>1</literal> to
|
|---|
| 1340 | disable the feature and an empty string
|
|---|
| 1341 | (<literal>""</literal>) to enable the feature.
|
|---|
| 1342 | The default value is <literal>1</literal>. See
|
|---|
| 1343 | <xref linkend="vrde-customization"/>.
|
|---|
| 1344 | </para></listitem>
|
|---|
| 1345 | <listitem><para>
|
|---|
| 1346 | <literal>H3DRedirect/Enabled</literal> specifies whether to
|
|---|
| 1347 | enable the VRDE server 3D redirection feature. Valid values
|
|---|
| 1348 | are <literal>1</literal> to enable the feature and an empty
|
|---|
| 1349 | string (<literal>""</literal>) to disable the feature.
|
|---|
| 1350 | See <xref linkend="vrde-customization"/>.
|
|---|
| 1351 | </para></listitem>
|
|---|
| 1352 | <listitem><para>
|
|---|
| 1353 | <literal>Security/Method</literal> specifies the security
|
|---|
| 1354 | method to use for a connection. See
|
|---|
| 1355 | <xref linkend="vrde-crypt" />.
|
|---|
| 1356 | </para><itemizedlist>
|
|---|
| 1357 | <listitem><para>
|
|---|
| 1358 | <literal>Negotiate</literal> accepts both enhanced (TLS)
|
|---|
| 1359 | and standard RDP security connections. The security
|
|---|
| 1360 | method is negotiated with the client. This is the
|
|---|
| 1361 | default value.
|
|---|
| 1362 | </para></listitem>
|
|---|
| 1363 | <listitem><para>
|
|---|
| 1364 | <literal>RDP</literal> accepts only standard RDP
|
|---|
| 1365 | security connections.
|
|---|
| 1366 | </para></listitem>
|
|---|
| 1367 | <listitem><para>
|
|---|
| 1368 | <literal>TLS</literal> accepts only enhanced RDP
|
|---|
| 1369 | security connections. The client must support TLS.
|
|---|
| 1370 | </para></listitem>
|
|---|
| 1371 | </itemizedlist></listitem>
|
|---|
| 1372 | <listitem><para>
|
|---|
| 1373 | <literal>Security/ServerCertificate</literal> specifies the
|
|---|
| 1374 | absolute path of the server certificate to use for a
|
|---|
| 1375 | connection. See <xref linkend="vrde-crypt" />.
|
|---|
| 1376 | </para></listitem>
|
|---|
| 1377 | <listitem><para>
|
|---|
| 1378 | <literal>Security/ServerPrivateKey</literal> specifies the
|
|---|
| 1379 | absolute path of the server private key. See
|
|---|
| 1380 | <xref linkend="vrde-crypt" />.
|
|---|
| 1381 | </para></listitem>
|
|---|
| 1382 | <listitem><para>
|
|---|
| 1383 | <literal>Security/CACertificate</literal> specifies the
|
|---|
| 1384 | absolute path of the CA self-signed certificate. See
|
|---|
| 1385 | <xref linkend="vrde-crypt" />.
|
|---|
| 1386 | </para></listitem>
|
|---|
| 1387 | <listitem><para>
|
|---|
| 1388 | <literal>Audio/RateCorrectionMode</literal> specifies the
|
|---|
| 1389 | rate correction mode to use.
|
|---|
| 1390 | </para><itemizedlist>
|
|---|
| 1391 | <listitem><para>
|
|---|
| 1392 | <literal>VRDP_AUDIO_MODE_VOID</literal> indicates that
|
|---|
| 1393 | no mode is specified. Use this value to unset any audio
|
|---|
| 1394 | mode that is already set.
|
|---|
| 1395 | </para></listitem>
|
|---|
| 1396 | <listitem><para>
|
|---|
| 1397 | <literal>VRDP_AUDIO_MODE_RC</literal> specifies to use
|
|---|
| 1398 | the rate correction mode.
|
|---|
| 1399 | </para></listitem>
|
|---|
| 1400 | <listitem><para>
|
|---|
| 1401 | <literal>VRDP_AUDIO_MODE_LPF</literal> specifies to use
|
|---|
| 1402 | the low pass filter mode.
|
|---|
| 1403 | </para></listitem>
|
|---|
| 1404 | <listitem><para>
|
|---|
| 1405 | <literal>VRDP_AUDIO_MODE_CS</literal> specifies to use
|
|---|
| 1406 | the client sync mode to prevent underflow or overflow of
|
|---|
| 1407 | the client queue.
|
|---|
| 1408 | </para></listitem>
|
|---|
| 1409 | </itemizedlist></listitem>
|
|---|
| 1410 | <listitem><para>
|
|---|
| 1411 | <literal>Audio/LogPath</literal> specifies the absolute path
|
|---|
| 1412 | of the audio log file.
|
|---|
| 1413 | </para></listitem>
|
|---|
| 1414 | </itemizedlist>
|
|---|
| 1415 | </refsect2>
|
|---|
| 1416 | <refsect2 id="vboxmanage-controlvm-vrdevideochannelquality">
|
|---|
| 1417 | <title>Specify the Image Quality for VRDP Video Redirection</title>
|
|---|
| 1418 | <remark role="help-copy-synopsis"/>
|
|---|
| 1419 | <para>
|
|---|
| 1420 | The <command>VBoxManage controlvm
|
|---|
| 1421 | <replaceable>vmname</replaceable>
|
|---|
| 1422 | vrdevideochannelquality</command> command sets the image
|
|---|
| 1423 | quality, as a JPEG compression level value, for video
|
|---|
| 1424 | redirection. Valid values are between 10% and 100%, inclusive.
|
|---|
| 1425 | Lower values mean lower quality but higher compression. See
|
|---|
| 1426 | <xref linkend="vrde-videochannel" />.
|
|---|
| 1427 | </para>
|
|---|
| 1428 | </refsect2>
|
|---|
| 1429 | <refsect2 id="vboxmanage-controlvm-setvideomodehint">
|
|---|
| 1430 | <title>Specify the Video Mode for the Guest VM</title>
|
|---|
| 1431 | <remark role="help-copy-synopsis"/>
|
|---|
| 1432 | <para>
|
|---|
| 1433 | The <command>VBoxManage controlvm
|
|---|
| 1434 | <replaceable>vmname</replaceable> setvideomodehint</command>
|
|---|
| 1435 | command specifies the video mode for the guest VM to use. You
|
|---|
| 1436 | must have the &product-name; Guest Additions installed. Note
|
|---|
| 1437 | that this feature does not work for all guest systems.
|
|---|
| 1438 | </para>
|
|---|
| 1439 | </refsect2>
|
|---|
| 1440 | <refsect2 id="vboxmanage-controlvm-setscreenlayout">
|
|---|
| 1441 | <title>Specify the Screen Layout for a Display on the Guest VM</title>
|
|---|
| 1442 | <remark role="help-copy-synopsis"/>
|
|---|
| 1443 | <para>
|
|---|
| 1444 | The <command>VBoxManage controlvm
|
|---|
| 1445 | <replaceable>vmname</replaceable> setscreenlayout</command>
|
|---|
| 1446 | command can be used to configure multiscreen displays. The
|
|---|
| 1447 | specified screen on the guest VM can be enabled or disabled, or
|
|---|
| 1448 | a custom screen layout can be configured.
|
|---|
| 1449 | </para>
|
|---|
| 1450 | </refsect2>
|
|---|
| 1451 | <refsect2 id="vboxmanage-controlvm-screenshotpng">
|
|---|
| 1452 | <title>Take a Screen Shot of the Virtual Machine Display</title>
|
|---|
| 1453 | <remark role="help-copy-synopsis"/>
|
|---|
| 1454 | <para>
|
|---|
| 1455 | The <command>VBoxManage controlvm
|
|---|
| 1456 | <replaceable>vmname</replaceable> screenshotpng</command>
|
|---|
| 1457 | command takes a screenshot of the guest display and saves it as
|
|---|
| 1458 | PNG in the specified file.
|
|---|
| 1459 | </para>
|
|---|
| 1460 | <itemizedlist>
|
|---|
| 1461 | <listitem><para>
|
|---|
| 1462 | <replaceable>filename</replaceable> specifies the name of
|
|---|
| 1463 | the PNG file to create.
|
|---|
| 1464 | </para></listitem>
|
|---|
| 1465 | <listitem><para>
|
|---|
| 1466 | <replaceable>display</replaceable> specifies the display
|
|---|
| 1467 | number for the screen shot. For a single monitor guest
|
|---|
| 1468 | display, this is <literal>0</literal>.
|
|---|
| 1469 | </para></listitem>
|
|---|
| 1470 | </itemizedlist>
|
|---|
| 1471 | </refsect2>
|
|---|
| 1472 | <refsect2 id="vboxmanage-controlvm-recording">
|
|---|
| 1473 | <title>Enable or Disable the Recording of a Virtual Machine Session</title>
|
|---|
| 1474 | <remark role="help-copy-synopsis"/>
|
|---|
| 1475 | <para>
|
|---|
| 1476 | The <command>VBoxManage controlvm
|
|---|
| 1477 | <replaceable>vmname</replaceable> recording</command> command
|
|---|
| 1478 | enables or disables the recording of a VM session into a
|
|---|
| 1479 | WebM/VP8 file. Valid values are <literal>on</literal>, which
|
|---|
| 1480 | begins recording when the VM session starts and
|
|---|
| 1481 | <literal>off</literal>, which disables recording. The default
|
|---|
| 1482 | value is <literal>off</literal>.
|
|---|
| 1483 | </para>
|
|---|
| 1484 | </refsect2>
|
|---|
| 1485 | <refsect2 id="vboxmanage-controlvm-recording-screens">
|
|---|
| 1486 | <title>Specify the Virtual Machine Screens to Record</title>
|
|---|
| 1487 | <remark role="help-copy-synopsis"/>
|
|---|
| 1488 | <para>
|
|---|
| 1489 | The <command>VBoxManage controlvm
|
|---|
| 1490 | <replaceable>vmname</replaceable> recording screens</command>
|
|---|
| 1491 | command enables you to specify which VM screens to record. The
|
|---|
| 1492 | recording for each screen that you specify is saved to its own
|
|---|
| 1493 | file in the machine folder. You cannot modify this setting while
|
|---|
| 1494 | recording is enabled.
|
|---|
| 1495 | </para>
|
|---|
| 1496 | <itemizedlist>
|
|---|
| 1497 | <listitem><para>
|
|---|
| 1498 | <literal>all</literal> specifies that you record all VM
|
|---|
| 1499 | screens.
|
|---|
| 1500 | </para></listitem>
|
|---|
| 1501 | <listitem><para>
|
|---|
| 1502 | <literal>none</literal> specifies that you do not record any
|
|---|
| 1503 | VM screens.
|
|---|
| 1504 | </para></listitem>
|
|---|
| 1505 | <listitem><para>
|
|---|
| 1506 | <replaceable>screen-ID</replaceable> specifies one or more
|
|---|
| 1507 | VM screens to record.
|
|---|
| 1508 | </para></listitem>
|
|---|
| 1509 | </itemizedlist>
|
|---|
| 1510 | </refsect2>
|
|---|
| 1511 | <refsect2 id="vboxmanage-controlvm-recording-filename">
|
|---|
| 1512 | <title>Specify the File in Which to Save Virtual Machine Recording</title>
|
|---|
| 1513 | <remark role="help-copy-synopsis"/>
|
|---|
| 1514 | <para>
|
|---|
| 1515 | The <command>VBoxManage controlvm
|
|---|
| 1516 | <replaceable>vmname</replaceable> recording filename</command>
|
|---|
| 1517 | command specifies the file in which to save the recording. You
|
|---|
| 1518 | cannot modify this setting while recording is enabled.
|
|---|
| 1519 | </para>
|
|---|
| 1520 | <para>
|
|---|
| 1521 | The default setting is to store a recording in the machine
|
|---|
| 1522 | folder, using the VM name as the file name, with a
|
|---|
| 1523 | <filename>webm</filename> file name extension.
|
|---|
| 1524 | </para>
|
|---|
| 1525 | </refsect2>
|
|---|
| 1526 | <refsect2 id="vboxmanage-controlvm-recording-videores">
|
|---|
| 1527 | <title>Specify the Resolution of the Recorded Video</title>
|
|---|
| 1528 | <remark role="help-copy-synopsis"/>
|
|---|
| 1529 | <para>
|
|---|
| 1530 | <command>VBoxManage controlvm <replaceable>vmname</replaceable>
|
|---|
| 1531 | recording videores</command> command specifies the resolution of
|
|---|
| 1532 | the recorded video in pixels. You cannot modify this setting
|
|---|
| 1533 | while recording is enabled.
|
|---|
| 1534 | </para>
|
|---|
| 1535 | <para>
|
|---|
| 1536 | Use the Settings tool to view the video recording settings,
|
|---|
| 1537 | which are based on the resolution (frame size). See the Frame
|
|---|
| 1538 | Size field on the Recording tab of the Display page to view the
|
|---|
| 1539 | default value.
|
|---|
| 1540 | </para>
|
|---|
| 1541 | <para>
|
|---|
| 1542 | Specify the resolution as
|
|---|
| 1543 | <replaceable>width</replaceable><literal>x</literal><replaceable>height</replaceable>:
|
|---|
| 1544 | </para>
|
|---|
| 1545 | <itemizedlist>
|
|---|
| 1546 | <listitem><para>
|
|---|
| 1547 | <replaceable>width</replaceable> specifies the width in
|
|---|
| 1548 | pixels.
|
|---|
| 1549 | </para></listitem>
|
|---|
| 1550 | <listitem><para>
|
|---|
| 1551 | <replaceable>height</replaceable> specifies the height in
|
|---|
| 1552 | pixels.
|
|---|
| 1553 | </para></listitem>
|
|---|
| 1554 | </itemizedlist>
|
|---|
| 1555 | </refsect2>
|
|---|
| 1556 | <refsect2 id="vboxmanage-controlvm-recording-videorate">
|
|---|
| 1557 | <title>Specify the Bit Rate of the Video</title>
|
|---|
| 1558 | <remark role="help-copy-synopsis"/>
|
|---|
| 1559 | <!-- @todo r=andy Clarify rate. -->
|
|---|
| 1560 | <para>
|
|---|
| 1561 | The <command>VBoxManage controlvm
|
|---|
| 1562 | <replaceable>vmname</replaceable> recording videorate</command>
|
|---|
| 1563 | command specifies the bit rate,
|
|---|
| 1564 | <replaceable>bit-rate</replaceable>, of the video in kilobits
|
|---|
| 1565 | per second. Increasing this value improves the appearance of the
|
|---|
| 1566 | video at the cost of an increased file size. You cannot modify
|
|---|
| 1567 | this setting while recording is enabled.
|
|---|
| 1568 | </para>
|
|---|
| 1569 | <para>
|
|---|
| 1570 | Use the Settings tool to view the video recording settings,
|
|---|
| 1571 | which are based on the frame size. See the Video Quality field
|
|---|
| 1572 | on the Recording tab of the Display page to view the default
|
|---|
| 1573 | value.
|
|---|
| 1574 | </para>
|
|---|
| 1575 | </refsect2>
|
|---|
| 1576 | <refsect2 id="vboxmanage-controlvm-recording-videofps">
|
|---|
| 1577 | <title>Specify the Maximum Frequency of the Video</title>
|
|---|
| 1578 | <remark role="help-copy-synopsis"/>
|
|---|
| 1579 | <para>
|
|---|
| 1580 | The <command>VBoxManage controlvm
|
|---|
| 1581 | <replaceable>vmname</replaceable> recording videofps</command>
|
|---|
| 1582 | command specifies the maximum frequency of the video to record.
|
|---|
| 1583 | Video frequency is measured in frames per second (FPS). The
|
|---|
| 1584 | recording skips any frames that have a frequency higher than the
|
|---|
| 1585 | specified maximum. Increasing the frequency reduces the number
|
|---|
| 1586 | of skipped frames and increases the file size. You cannot modify
|
|---|
| 1587 | this setting while recording is enabled.
|
|---|
| 1588 | </para>
|
|---|
| 1589 | <para>
|
|---|
| 1590 | Use the Settings tool to view the video recording settings,
|
|---|
| 1591 | which are based on the frame size. See the Frame Rate field on
|
|---|
| 1592 | the Recording tab of the Display page to view the default value.
|
|---|
| 1593 | </para>
|
|---|
| 1594 | </refsect2>
|
|---|
| 1595 | <refsect2 id="vboxmanage-controlvm-recording-maxtime">
|
|---|
| 1596 | <title>Specify the Maximum Amount of Time to Record Video</title>
|
|---|
| 1597 | <remark role="help-copy-synopsis"/>
|
|---|
| 1598 | <!-- @todo r=andy Clarify time format. -->
|
|---|
| 1599 | <para>
|
|---|
| 1600 | The <command>VBoxManage controlvm
|
|---|
| 1601 | <replaceable>vmname</replaceable> recording maxtime</command>
|
|---|
| 1602 | command specifies the maximum amount time to record in seconds.
|
|---|
| 1603 | The recording stops after the specified number of seconds
|
|---|
| 1604 | elapses. If this value is zero, the recording continues until
|
|---|
| 1605 | you stop the recording.
|
|---|
| 1606 | </para>
|
|---|
| 1607 | </refsect2>
|
|---|
| 1608 | <refsect2 id="vboxmanage-controlvm-recording-maxfilesize">
|
|---|
| 1609 | <title>Specify the Maximum Size of the Recorded Video</title>
|
|---|
| 1610 | <remark role="help-copy-synopsis"/>
|
|---|
| 1611 | <para>
|
|---|
| 1612 | The <command>VBoxManage controlvm
|
|---|
| 1613 | <replaceable>vmname</replaceable> recording
|
|---|
| 1614 | maxfilesize</command> command specifies the maximum size of the
|
|---|
| 1615 | recorded video file in megabytes. The recording stops when the
|
|---|
| 1616 | file reaches the specified size. If this value is zero, the
|
|---|
| 1617 | recording continues until you stop the recording. You cannot
|
|---|
| 1618 | modify this setting while recording is enabled.
|
|---|
| 1619 | </para>
|
|---|
| 1620 | </refsect2>
|
|---|
| 1621 | <!--
|
|---|
| 1622 | <refsect2 id="vboxmanage-controlvm-recording-opts">
|
|---|
| 1623 | <title>Specify Custom Options for Recording Video and/or Audio</title>
|
|---|
| 1624 | <remark role="help-copy-synopsis"/>
|
|---|
| 1625 | <para>
|
|---|
| 1626 | The <command>VBoxManage controlvm
|
|---|
| 1627 | <replaceable>vmname</replaceable> recording
|
|---|
| 1628 | opts</command> command specifies additional recording options
|
|---|
| 1629 | in a comma-separated keyword-value format. For example,
|
|---|
| 1630 | <computeroutput>foo=bar,a=b</computeroutput>. You cannot
|
|---|
| 1631 | modify this setting while recording is enabled.
|
|---|
| 1632 | </para>
|
|---|
| 1633 | <para>
|
|---|
| 1634 | Use this option if you are an advanced user only. For
|
|---|
| 1635 | information about keywords, see <emphasis>&product-name;
|
|---|
| 1636 | Programming Guide and Reference</emphasis>.
|
|---|
| 1637 | </para>
|
|---|
| 1638 | </refsect2>
|
|---|
| 1639 | -->
|
|---|
| 1640 | <refsect2 id="vboxmanage-controlvm-setcredentials">
|
|---|
| 1641 | <title>Specify Credentials for Remote Logins on Windows Virtual Machines</title>
|
|---|
| 1642 | <remark role="help-copy-synopsis"/>
|
|---|
| 1643 | <para>
|
|---|
| 1644 | The <command>setcredentials</command> command enables you to
|
|---|
| 1645 | specify the credentials for remotely logging in to Windows VMs.
|
|---|
| 1646 | See <xref linkend="autologon" />.
|
|---|
| 1647 | </para>
|
|---|
| 1648 | <itemizedlist>
|
|---|
| 1649 | <listitem><para>
|
|---|
| 1650 | <replaceable>username</replaceable> specifies the user name
|
|---|
| 1651 | with which to log in to the Windows VM.
|
|---|
| 1652 | </para></listitem>
|
|---|
| 1653 | <listitem><para>
|
|---|
| 1654 | <option>--passwordfile=<replaceable>filename</replaceable></option>
|
|---|
| 1655 | specifies the file from which to obtain the password for
|
|---|
| 1656 | <replaceable>username</replaceable>.
|
|---|
| 1657 | </para><para>
|
|---|
| 1658 | The <option>--passwordfile</option> is mutually exclusive
|
|---|
| 1659 | with the <option>--password</option> option.
|
|---|
| 1660 | </para></listitem>
|
|---|
| 1661 | <listitem><para>
|
|---|
| 1662 | <option>--password=<replaceable>password</replaceable></option>
|
|---|
| 1663 | specifies the password for
|
|---|
| 1664 | <replaceable>username</replaceable>.
|
|---|
| 1665 | </para><remark>
|
|---|
| 1666 | This design does not conform to Oracle's security
|
|---|
| 1667 | guidelines. You should not be able to specify a password on
|
|---|
| 1668 | the command line because the password can be seen in a
|
|---|
| 1669 | process listing.
|
|---|
| 1670 | </remark><para>
|
|---|
| 1671 | The <option>--password</option> is mutually exclusive with
|
|---|
| 1672 | the <option>--passwordfile</option> option.
|
|---|
| 1673 | </para></listitem>
|
|---|
| 1674 | <listitem><para>
|
|---|
| 1675 | <option>--allowlocallogin</option> specifies whether to
|
|---|
| 1676 | enable or disable local logins. Valid values are
|
|---|
| 1677 | <literal>on</literal> to enable local logins and
|
|---|
| 1678 | <literal>off</literal> to disable local logins.
|
|---|
| 1679 | </para></listitem>
|
|---|
| 1680 | </itemizedlist>
|
|---|
| 1681 | </refsect2>
|
|---|
| 1682 | <refsect2 id="vboxmanage-controlvm-teleport">
|
|---|
| 1683 | <title>Configure a Virtual Machine Target for Teleporting</title>
|
|---|
| 1684 | <remark role="help-copy-synopsis"/>
|
|---|
| 1685 | <para>
|
|---|
| 1686 | The <command>VBoxManage controlvm
|
|---|
| 1687 | <replaceable>vmname</replaceable> teleport</command> command
|
|---|
| 1688 | initiates a teleporting operation between the specified VM and
|
|---|
| 1689 | the specified host system. See <xref linkend="teleporting" />.
|
|---|
| 1690 | </para>
|
|---|
| 1691 | <para>
|
|---|
| 1692 | If you specify a password, it must match the password you
|
|---|
| 1693 | specified when you issued the <command>VBoxManage
|
|---|
| 1694 | modifyvm</command> command for the target machine.
|
|---|
| 1695 | </para>
|
|---|
| 1696 | <variablelist>
|
|---|
| 1697 | <varlistentry>
|
|---|
| 1698 | <term><option>--host=<replaceable>hostname</replaceable></option></term>
|
|---|
| 1699 | <listitem><para>
|
|---|
| 1700 | Specifies the name of the VM.
|
|---|
| 1701 | </para></listitem>
|
|---|
| 1702 | </varlistentry>
|
|---|
| 1703 | <varlistentry>
|
|---|
| 1704 | <term><option>--port=<replaceable>port</replaceable></option></term>
|
|---|
| 1705 | <listitem><para>
|
|---|
| 1706 | Specifies the port on the VM that should listen for a
|
|---|
| 1707 | teleporting request from other VMs. The port number can be
|
|---|
| 1708 | any free TCP/IP port number, such as
|
|---|
| 1709 | <literal>6000</literal>.
|
|---|
| 1710 | </para></listitem>
|
|---|
| 1711 | </varlistentry>
|
|---|
| 1712 | <varlistentry>
|
|---|
| 1713 | <term><option>--maxdowntime=<replaceable>msec</replaceable></option></term>
|
|---|
| 1714 | <listitem><para>
|
|---|
| 1715 | Specifies the maximum downtime, in milliseconds, for the
|
|---|
| 1716 | teleporting target VM.
|
|---|
| 1717 | </para></listitem>
|
|---|
| 1718 | </varlistentry>
|
|---|
| 1719 | <varlistentry>
|
|---|
| 1720 | <term><option>--password=<replaceable>password</replaceable></option></term>
|
|---|
| 1721 | <listitem><para>
|
|---|
| 1722 | Specifies the password that the source machine uses for
|
|---|
| 1723 | the teleporting request. The request succeeds only if the
|
|---|
| 1724 | source machine specifies the same password.
|
|---|
| 1725 | </para><remark>
|
|---|
| 1726 | This design does not conform to Oracle's security
|
|---|
| 1727 | guidelines. You should not be able to specify a password
|
|---|
| 1728 | on the command line because the password can be seen in a
|
|---|
| 1729 | process listing.
|
|---|
| 1730 | </remark><para>
|
|---|
| 1731 | The <option>--password</option> is mutually exclusive with
|
|---|
| 1732 | the <option>--passwordfile</option> option.
|
|---|
| 1733 | </para></listitem>
|
|---|
| 1734 | </varlistentry>
|
|---|
| 1735 | <varlistentry>
|
|---|
| 1736 | <term><option>--passwordfile=<replaceable>filename</replaceable></option></term>
|
|---|
| 1737 | <listitem><para>
|
|---|
| 1738 | Specifies the file from which to obtain the password that
|
|---|
| 1739 | the source machine uses for the teleporting request. The
|
|---|
| 1740 | request succeeds only if the source machine specifies the
|
|---|
| 1741 | same password.
|
|---|
| 1742 | </para><para>
|
|---|
| 1743 | When you specify a file name of <literal>stdin</literal>,
|
|---|
| 1744 | you can read the password from standard input.
|
|---|
| 1745 | </para><para>
|
|---|
| 1746 | The <option>--passwordfile</option> is mutually exclusive
|
|---|
| 1747 | with the <option>--password</option> option.
|
|---|
| 1748 | </para></listitem>
|
|---|
| 1749 | </varlistentry>
|
|---|
| 1750 | </variablelist>
|
|---|
| 1751 | </refsect2>
|
|---|
| 1752 | <refsect2 id="vboxmanage-controlvm-plugcpu">
|
|---|
| 1753 | <title>Add a Virtual CPU to a Virtual Machine</title>
|
|---|
| 1754 | <remark role="help-copy-synopsis"/>
|
|---|
| 1755 | <para>
|
|---|
| 1756 | The <command>VBoxManage controlvm
|
|---|
| 1757 | <replaceable>vmname</replaceable> plugcpu</command> command adds
|
|---|
| 1758 | a virtual CPU to the specified VM if CPU hot-plugging is
|
|---|
| 1759 | enabled. <replaceable>ID</replaceable> specifies the index of
|
|---|
| 1760 | the virtual CPU to be added and must be a number from 0 to the
|
|---|
| 1761 | maximum number of CPUs configured.
|
|---|
| 1762 | </para>
|
|---|
| 1763 | </refsect2>
|
|---|
| 1764 | <refsect2 id="vboxmanage-controlvm-unplugcpu">
|
|---|
| 1765 | <title>Remove a Virtual CPU From a Virtual Machine</title>
|
|---|
| 1766 | <remark role="help-copy-synopsis"/>
|
|---|
| 1767 | <para>
|
|---|
| 1768 | The <command>VBoxManage controlvm
|
|---|
| 1769 | <replaceable>vmname</replaceable> unplugcpu</command> command
|
|---|
| 1770 | removes a virtual CPU from the specified VM if CPU hot-plugging
|
|---|
| 1771 | is enabled. <replaceable>ID</replaceable> specifies the index of
|
|---|
| 1772 | the virtual CPU to be removed and must be a number from 0 to the
|
|---|
| 1773 | maximum number of CPUs configured. You cannot remove CPU 0.
|
|---|
| 1774 | </para>
|
|---|
| 1775 | </refsect2>
|
|---|
| 1776 | <refsect2 id="vboxmanage-controlvm-cpuexecutioncap">
|
|---|
| 1777 | <title>Set the Maximum Amount of Physical CPU Time Used by a Virtual CPU</title>
|
|---|
| 1778 | <remark role="help-copy-synopsis"/>
|
|---|
| 1779 | <para>
|
|---|
| 1780 | The <command>VBoxManage controlvm
|
|---|
| 1781 | <replaceable>vmname</replaceable> cpuexecutioncap</command>
|
|---|
| 1782 | command specifies how the maximum amount of physical CPU time
|
|---|
| 1783 | used by a virtual CPU. Valid values are a percentage between
|
|---|
| 1784 | <literal>1</literal> and <literal>100</literal>. A value of
|
|---|
| 1785 | <literal>50</literal> specifies that a single virtual CPU can
|
|---|
| 1786 | use up to 50% of a physical CPU. The default value is
|
|---|
| 1787 | <literal>100</literal>.
|
|---|
| 1788 | </para>
|
|---|
| 1789 | <para>
|
|---|
| 1790 | Use this feature with caution, it can have unexpected results
|
|---|
| 1791 | including timekeeping problems and lower performance than
|
|---|
| 1792 | specified. If you want to limit the resource usage of a VM
|
|---|
| 1793 | it is more reliable to pick an appropriate number of VCPUs.
|
|---|
| 1794 | </para>
|
|---|
| 1795 | </refsect2>
|
|---|
| 1796 | <refsect2 id="vboxmanage-controlvm-vm-process-priority">
|
|---|
| 1797 | <title>Change the Priority of a VM Process</title>
|
|---|
| 1798 | <remark role="help-copy-synopsis"/>
|
|---|
| 1799 | <para>
|
|---|
| 1800 | The <command>VBoxManage controlvm
|
|---|
| 1801 | <replaceable>vmname</replaceable> vm-process-priority</command>
|
|---|
| 1802 | command specifies the priority scheme of the VM process to use
|
|---|
| 1803 | when starting the specified VM and while the VM runs.
|
|---|
| 1804 | </para>
|
|---|
| 1805 | <para>
|
|---|
| 1806 | Valid values are:
|
|---|
| 1807 | </para>
|
|---|
| 1808 | <itemizedlist>
|
|---|
| 1809 | <listitem><para>
|
|---|
| 1810 | <literal>default</literal> – Default process
|
|---|
| 1811 | priority determined by the OS.
|
|---|
| 1812 | </para></listitem>
|
|---|
| 1813 | <listitem><para>
|
|---|
| 1814 | <literal>flat</literal> – Assumes a scheduling
|
|---|
| 1815 | policy which puts the process at the default priority
|
|---|
| 1816 | and with all threads at the same priority.
|
|---|
| 1817 | </para></listitem>
|
|---|
| 1818 | <listitem><para>
|
|---|
| 1819 | <literal>low</literal> – Assumes a scheduling
|
|---|
| 1820 | policy which puts the process mostly below the default
|
|---|
| 1821 | priority of the host OS.
|
|---|
| 1822 | </para></listitem>
|
|---|
| 1823 | <listitem><para>
|
|---|
| 1824 | <literal>normal</literal> – Assume a scheduling
|
|---|
| 1825 | policy which shares the CPU resources fairly with
|
|---|
| 1826 | other processes running with the default priority of
|
|---|
| 1827 | the host OS.
|
|---|
| 1828 | </para></listitem>
|
|---|
| 1829 | <listitem><para>
|
|---|
| 1830 | <literal>high</literal> – Assumes a scheduling
|
|---|
| 1831 | policy which puts the task above the default priority of
|
|---|
| 1832 | the host OS. This policy might easily cause other tasks
|
|---|
| 1833 | in the system to starve.
|
|---|
| 1834 | </para></listitem>
|
|---|
| 1835 | </itemizedlist>
|
|---|
| 1836 | </refsect2>
|
|---|
| 1837 | <refsect2 id="vboxmanage-controlvm-webcam-attach">
|
|---|
| 1838 | <title>Attach a Webcam to a Virtual Machine</title>
|
|---|
| 1839 | <remark role="help-copy-synopsis"/>
|
|---|
| 1840 | <para>
|
|---|
| 1841 | The <command>VBoxManage controlvm
|
|---|
| 1842 | <replaceable>vmname</replaceable> webcam attach</command>
|
|---|
| 1843 | command attaches a webcam to a running VM. Specify the webcam as
|
|---|
| 1844 | the absolute path of the webcam on the host OS or as an alias.
|
|---|
| 1845 | Use the <command>VBoxManage list webcams</command> command to
|
|---|
| 1846 | obtain the webcam alias.
|
|---|
| 1847 | </para>
|
|---|
| 1848 | <para>
|
|---|
| 1849 | Note that the <literal>.0</literal> alias is the default video
|
|---|
| 1850 | input device on the host OS. <literal>.1</literal> is the first
|
|---|
| 1851 | video input device, <literal>.2</literal> is the second video
|
|---|
| 1852 | input device, and so on. The order of the devices is specific to
|
|---|
| 1853 | the host system.
|
|---|
| 1854 | </para>
|
|---|
| 1855 | <para>
|
|---|
| 1856 | You can specify optional settings in the form of
|
|---|
| 1857 | semi-colon-separated (<literal>;</literal>) name-value pairs.
|
|---|
| 1858 | These properties enable you to configure the emulated webcam
|
|---|
| 1859 | device.
|
|---|
| 1860 | </para>
|
|---|
| 1861 | <para>
|
|---|
| 1862 | The following settings are supported:
|
|---|
| 1863 | </para>
|
|---|
| 1864 | <variablelist>
|
|---|
| 1865 | <varlistentry>
|
|---|
| 1866 | <term><literal>MaxFramerate</literal></term>
|
|---|
| 1867 | <listitem><para>
|
|---|
| 1868 | Specifies the highest rate at which to send video frames
|
|---|
| 1869 | to the VM. The rate is in frames per second. Higher frame
|
|---|
| 1870 | rates increase CPU load, so you can use this setting to
|
|---|
| 1871 | reduce CPU load. The default value is <literal>no maximum
|
|---|
| 1872 | limit</literal>. This value enables the VM to use any
|
|---|
| 1873 | frame rate supported by the webcam.
|
|---|
| 1874 | </para></listitem>
|
|---|
| 1875 | </varlistentry>
|
|---|
| 1876 | <varlistentry>
|
|---|
| 1877 | <term><literal>MaxPayloadTransferSize</literal></term>
|
|---|
| 1878 | <listitem><para>
|
|---|
| 1879 | Specifies the maximum number of bytes that the VM receives
|
|---|
| 1880 | from the emulated webcam in one buffer. The default
|
|---|
| 1881 | setting is <literal>3060</literal> bytes, which is used by
|
|---|
| 1882 | some webcams. If the VM is able to use larger buffers,
|
|---|
| 1883 | higher values might reduce CPU load slightly. Note that
|
|---|
| 1884 | some guest OSes might not suppport higher
|
|---|
| 1885 | <literal>MaxPayloadTransferSize</literal> values.
|
|---|
| 1886 | </para></listitem>
|
|---|
| 1887 | </varlistentry>
|
|---|
| 1888 | </variablelist>
|
|---|
| 1889 | </refsect2>
|
|---|
| 1890 | <refsect2 id="vboxmanage-controlvm-webcam-detach">
|
|---|
| 1891 | <title>Detach a Webcam From a Virtual Machine</title>
|
|---|
| 1892 | <remark role="help-copy-synopsis"/>
|
|---|
| 1893 | <para>
|
|---|
| 1894 | The <command>VBoxManage controlvm
|
|---|
| 1895 | <replaceable>vmname</replaceable> webcam detach</command>
|
|---|
| 1896 | command detaches a webcam from a running VM. Specify the webcam
|
|---|
| 1897 | as the absolute path of the webcam on the host OS or as an
|
|---|
| 1898 | alias. Use the <command>VBoxManage list webcams</command> to
|
|---|
| 1899 | obtain the webcam alias.
|
|---|
| 1900 | </para>
|
|---|
| 1901 | <para>
|
|---|
| 1902 | When a webcam device is detached from the host, the host OS
|
|---|
| 1903 | determines how the emulated webcam behaves.
|
|---|
| 1904 | </para>
|
|---|
| 1905 | <itemizedlist>
|
|---|
| 1906 | <listitem><para>
|
|---|
| 1907 | <emphasis role="bold">Windows hosts:</emphasis> The emulated
|
|---|
| 1908 | webcam device is detached from the VM automatically.
|
|---|
| 1909 | </para></listitem>
|
|---|
| 1910 | <listitem><para>
|
|---|
| 1911 | <emphasis role="bold">Mac OS X hosts that run at least OS X
|
|---|
| 1912 | 10.7:</emphasis> The emulated webcam device remains attached
|
|---|
| 1913 | to the VM and you must detach it manually by using the
|
|---|
| 1914 | <command>VBoxManage controlvm webcam detach</command>
|
|---|
| 1915 | command.
|
|---|
| 1916 | </para></listitem>
|
|---|
| 1917 | <listitem><para>
|
|---|
| 1918 | <emphasis role="bold">Linux hosts:</emphasis> The emulated
|
|---|
| 1919 | webcam device is detached from the VM automatically only if
|
|---|
| 1920 | the webcam is actively streaming video. If the emulated
|
|---|
| 1921 | webcam is inactive, manually detach it by using the
|
|---|
| 1922 | <command>VBoxManage controlvm
|
|---|
| 1923 | <replaceable>vmname</replaceable> webcam detach</command>
|
|---|
| 1924 | command.
|
|---|
| 1925 | </para></listitem>
|
|---|
| 1926 | </itemizedlist>
|
|---|
| 1927 | </refsect2>
|
|---|
| 1928 | <refsect2 id="vboxmanage-controlvm-webcam-list">
|
|---|
| 1929 | <title>List the Webcams Attached to a Virtual Machine</title>
|
|---|
| 1930 | <remark role="help-copy-synopsis"/>
|
|---|
| 1931 | <para>
|
|---|
| 1932 | The <command>VBoxManage controlvm
|
|---|
| 1933 | <replaceable>vmname</replaceable> webcam list</command> command
|
|---|
| 1934 | lists webcams that are attached to the running VM. The output
|
|---|
| 1935 | shows a list of absolute paths or aliases that attached the
|
|---|
| 1936 | webcams to the VM by using the <command>VBoxManage controlvm
|
|---|
| 1937 | <replaceable>vmname</replaceable> webcam attach</command>
|
|---|
| 1938 | command.
|
|---|
| 1939 | </para>
|
|---|
| 1940 | </refsect2>
|
|---|
| 1941 | <refsect2 id="vboxmanage-controlvm-addencpassword">
|
|---|
| 1942 | <title>Set an Encryption Password for a Virtual Machine</title>
|
|---|
| 1943 | <remark role="help-copy-synopsis"/>
|
|---|
| 1944 | <para>
|
|---|
| 1945 | The <command>VBoxManage controlvm
|
|---|
| 1946 | <replaceable>vmname</replaceable> addencpassword</command>
|
|---|
| 1947 | command provides the <replaceable>vmname</replaceable> encrypted
|
|---|
| 1948 | VM with the encryption password to enable a headless start.
|
|---|
| 1949 | Specify the absolute path of a password file on the host system.
|
|---|
| 1950 | If <replaceable>filename</replaceable> is <literal>-</literal>,
|
|---|
| 1951 | <command>VBoxManage</command> prompts for the encryption
|
|---|
| 1952 | password.
|
|---|
| 1953 | </para>
|
|---|
| 1954 | <para>
|
|---|
| 1955 | Use the <option>--removeonsuspend</option> option to specify
|
|---|
| 1956 | whether to save the passsword or clear it from VM memory when
|
|---|
| 1957 | the VM is suspended.
|
|---|
| 1958 | </para>
|
|---|
| 1959 | <para>
|
|---|
| 1960 | If the VM is suspended and the password is cleared, use the
|
|---|
| 1961 | <command>VBoxManage controlvm <replaceable>vmname</replaceable>
|
|---|
| 1962 | addencpassword</command> to provide the password to resume
|
|---|
| 1963 | execution on the VM. Use this feature when you do not want to
|
|---|
| 1964 | store the password in VM memory while the VM is suspended by a
|
|---|
| 1965 | host suspend event.
|
|---|
| 1966 | </para>
|
|---|
| 1967 | <note>
|
|---|
| 1968 | <para>
|
|---|
| 1969 | You can encrypt data stored on hard disk images used by the
|
|---|
| 1970 | VM. &product-name; uses the AES algorithm in XTS mode and
|
|---|
| 1971 | supports 128-bit or 256-bit data encryption keys (DEK). The
|
|---|
| 1972 | encrypted DEK is stored in the medium properties and is
|
|---|
| 1973 | decrypted during VM startup when you provide the encryption
|
|---|
| 1974 | password.
|
|---|
| 1975 | </para>
|
|---|
| 1976 | </note>
|
|---|
| 1977 | <para>
|
|---|
| 1978 | Use the <command>VBoxManage encryptmedium</command> command to
|
|---|
| 1979 | create a DEK encrypted medium. See
|
|---|
| 1980 | <xref linkend="diskencryption-encryption" />.
|
|---|
| 1981 | </para>
|
|---|
| 1982 | <para>
|
|---|
| 1983 | The &product-name; GUI prompts you for the encryption password
|
|---|
| 1984 | when you start an encrypted VM.
|
|---|
| 1985 | </para>
|
|---|
| 1986 | <para>
|
|---|
| 1987 | Use the following command to perform a headless start of an
|
|---|
| 1988 | encrypted VM:
|
|---|
| 1989 | </para>
|
|---|
| 1990 | <screen>
|
|---|
| 1991 | $ VBoxManage startvm <replaceable>vmname</replaceable> --type headless
|
|---|
| 1992 | </screen>
|
|---|
| 1993 | <para>
|
|---|
| 1994 | Then, use the following command to provide the encryption
|
|---|
| 1995 | password:
|
|---|
| 1996 | </para>
|
|---|
| 1997 | <screen>
|
|---|
| 1998 | $ VBoxManage <replaceable>vmname</replaceable> controlvm addencpassword <replaceable>vmname</replaceable> -
|
|---|
| 1999 | Password: <replaceable>encryption-password</replaceable>
|
|---|
| 2000 | </screen>
|
|---|
| 2001 | </refsect2>
|
|---|
| 2002 | <refsect2 id="vboxmanage-controlvm-removeencpassword">
|
|---|
| 2003 | <title>Disable an Encryption Password for a Virtual Machine</title>
|
|---|
| 2004 | <remark role="help-copy-synopsis"/>
|
|---|
| 2005 | <para>
|
|---|
| 2006 | The <command>VBoxManage controlvm
|
|---|
| 2007 | <replaceable>vmname</replaceable> removeencpassword</command>
|
|---|
| 2008 | command disables a specific encryption password for all
|
|---|
| 2009 | encrypted media attached to the VM.
|
|---|
| 2010 | </para>
|
|---|
| 2011 | <para>
|
|---|
| 2012 | <replaceable>ID</replaceable> is the password identifier for the
|
|---|
| 2013 | encryption password that you want to disable.
|
|---|
| 2014 | </para>
|
|---|
| 2015 | </refsect2>
|
|---|
| 2016 | <refsect2 id="vboxmanage-controlvm-removeallencpasswords">
|
|---|
| 2017 | <title>Disable All Encryption Passwords for a Virtual Machine</title>
|
|---|
| 2018 | <remark role="help-copy-synopsis"/>
|
|---|
| 2019 | <para>
|
|---|
| 2020 | The <command>VBoxManage controlvm
|
|---|
| 2021 | <replaceable>vmname</replaceable>
|
|---|
| 2022 | removeallencpasswords</command> command disables all encryption
|
|---|
| 2023 | passwords for all encrypted media attached to the VM.
|
|---|
| 2024 | </para>
|
|---|
| 2025 | </refsect2>
|
|---|
| 2026 | <refsect2 id="vboxmanage-controlvm-changeuartmode">
|
|---|
| 2027 | <title>Change the Connection Mode for a Virtual Serial Port on a Virtual
|
|---|
| 2028 | Machine</title>
|
|---|
| 2029 | <remark role="help-copy-synopsis"/>
|
|---|
| 2030 | <para>
|
|---|
| 2031 | The <command>VBoxManage controlvm
|
|---|
| 2032 | <replaceable>vmname</replaceable> changeuartmode</command>
|
|---|
| 2033 | command changes the connection mode for the specified virtual
|
|---|
| 2034 | serial port. Valid serial port values are integers that start
|
|---|
| 2035 | from <literal>1</literal>.
|
|---|
| 2036 | </para>
|
|---|
| 2037 | <variablelist>
|
|---|
| 2038 | <varlistentry>
|
|---|
| 2039 | <term>disconnected</term>
|
|---|
| 2040 | <listitem><para>
|
|---|
| 2041 | Disconnects the device.
|
|---|
| 2042 | </para></listitem>
|
|---|
| 2043 | </varlistentry>
|
|---|
| 2044 | <varlistentry>
|
|---|
| 2045 | <term>server <replaceable>pipe-name</replaceable></term>
|
|---|
| 2046 | <listitem><para>
|
|---|
| 2047 | Specifies the pipe name of the server.
|
|---|
| 2048 | </para></listitem>
|
|---|
| 2049 | </varlistentry>
|
|---|
| 2050 | <varlistentry>
|
|---|
| 2051 | <term>client <replaceable>pipe-name</replaceable></term>
|
|---|
| 2052 | <listitem><para>
|
|---|
| 2053 | Specifies the pipe name of the client.
|
|---|
| 2054 | </para></listitem>
|
|---|
| 2055 | </varlistentry>
|
|---|
| 2056 | <varlistentry>
|
|---|
| 2057 | <term>tcpserver <replaceable>port</replaceable></term>
|
|---|
| 2058 | <listitem><para>
|
|---|
| 2059 | Specifies the port number of the TCP server.
|
|---|
| 2060 | </para></listitem>
|
|---|
| 2061 | </varlistentry>
|
|---|
| 2062 | <varlistentry>
|
|---|
| 2063 | <term>tcpclient <replaceable>hostname</replaceable>:<replaceable>port</replaceable></term>
|
|---|
| 2064 | <listitem><para>
|
|---|
| 2065 | Specifies the host name and port number of the TCP client.
|
|---|
| 2066 | </para></listitem>
|
|---|
| 2067 | </varlistentry>
|
|---|
| 2068 | <varlistentry>
|
|---|
| 2069 | <term>file <replaceable>filename</replaceable></term>
|
|---|
| 2070 | <listitem><para>
|
|---|
| 2071 | Specifies the name of the file.
|
|---|
| 2072 | </para></listitem>
|
|---|
| 2073 | </varlistentry>
|
|---|
| 2074 | <varlistentry>
|
|---|
| 2075 | <term><replaceable>device-name</replaceable></term>
|
|---|
| 2076 | <listitem><para>
|
|---|
| 2077 | Specifies the name of the device.
|
|---|
| 2078 | </para></listitem>
|
|---|
| 2079 | </varlistentry>
|
|---|
| 2080 | </variablelist>
|
|---|
| 2081 | </refsect2>
|
|---|
| 2082 | <refsect2 id="vboxmanage-controlvm-autostart-enabled">
|
|---|
| 2083 | <title>Enabling autostart the VM during host system boot</title>
|
|---|
| 2084 | <remark role="help-copy-synopsis"/>
|
|---|
| 2085 | <para>
|
|---|
| 2086 | The <command>VBoxManage controlvm
|
|---|
| 2087 | <replaceable>vmname</replaceable> autostart-enabled</command>
|
|---|
| 2088 | command specifies whether to enable or disable automatically
|
|---|
| 2089 | start the VM at host system boot-up. You must do some host
|
|---|
| 2090 | system configuration before you can use this feature.
|
|---|
| 2091 | See <xref linkend="autostart" />. Valid values are
|
|---|
| 2092 | <literal>on</literal>, which enables autostart feature for
|
|---|
| 2093 | the VM and <literal>off</literal>, which disables it. The
|
|---|
| 2094 | default value is <literal>off</literal>.
|
|---|
| 2095 | </para>
|
|---|
| 2096 | </refsect2>
|
|---|
| 2097 | <refsect2 id="vboxmanage-controlvm-autostart-delay">
|
|---|
| 2098 | <title>Setting the delay of starting the VM on host system boot</title>
|
|---|
| 2099 | <remark role="help-copy-synopsis"/>
|
|---|
| 2100 | <para>
|
|---|
| 2101 | The <command>VBoxManage controlvm
|
|---|
| 2102 | <replaceable>vmname</replaceable> autostart-delay</command>
|
|---|
| 2103 | command specifies the delay in seconds before the VM starts
|
|---|
| 2104 | on host system boot-up. See <xref linkend="autostart" />.
|
|---|
| 2105 | </para>
|
|---|
| 2106 | </refsect2>
|
|---|
| 2107 | </refsect1>
|
|---|
| 2108 |
|
|---|
| 2109 | <refsect1>
|
|---|
| 2110 | <title>Examples</title>
|
|---|
| 2111 | <remark role="help-scope" condition="GLOBAL" />
|
|---|
| 2112 | <para>
|
|---|
| 2113 | The following command temporarily stops the execution of the
|
|---|
| 2114 | <filename>ol7</filename> VM.
|
|---|
| 2115 | </para>
|
|---|
| 2116 | <screen>$ VBoxManage controlvm ol7 pause</screen>
|
|---|
| 2117 | <para>
|
|---|
| 2118 | The following command configures shared clipboard operation for
|
|---|
| 2119 | the <filename>ol7</filename> VM. Copying of clipboard data is
|
|---|
| 2120 | allowed in both directions between the host and guest.
|
|---|
| 2121 | </para>
|
|---|
| 2122 | <screen>$ VBoxManage controlvm ol7 clipboard mode bidirectional</screen>
|
|---|
| 2123 | </refsect1>
|
|---|
| 2124 |
|
|---|
| 2125 | <refsect1>
|
|---|
| 2126 | <title>See Also</title>
|
|---|
| 2127 | <para>
|
|---|
| 2128 | <xref linkend="vboxmanage-list" />,
|
|---|
| 2129 | <xref linkend="vboxmanage-modifyvm" />,
|
|---|
| 2130 | <xref linkend="vboxmanage-startvm" />
|
|---|
| 2131 | </para>
|
|---|
| 2132 | </refsect1>
|
|---|
| 2133 | </refentry>
|
|---|
