| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage guestcontrol
|
|---|
| 4 | -->
|
|---|
| 5 | <!--
|
|---|
| 6 | Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|---|
| 7 |
|
|---|
| 8 | This file is part of VirtualBox base platform packages, as
|
|---|
| 9 | available from https://www.virtualbox.org.
|
|---|
| 10 |
|
|---|
| 11 | This program is free software; you can redistribute it and/or
|
|---|
| 12 | modify it under the terms of the GNU General Public License
|
|---|
| 13 | as published by the Free Software Foundation, in version 3 of the
|
|---|
| 14 | License.
|
|---|
| 15 |
|
|---|
| 16 | This program is distributed in the hope that it will be useful, but
|
|---|
| 17 | WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 19 | General Public License for more details.
|
|---|
| 20 |
|
|---|
| 21 | You should have received a copy of the GNU General Public License
|
|---|
| 22 | along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 23 |
|
|---|
| 24 | SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 25 | -->
|
|---|
| 26 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 27 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
|---|
| 28 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
|---|
| 29 | %all.entities;
|
|---|
| 30 | ]>
|
|---|
| 31 | <refentry id="vboxmanage-guestcontrol" lang="en">
|
|---|
| 32 | <refentryinfo>
|
|---|
| 33 | <pubdate>$Date: 2023-03-22 17:30:14 +0000 (Wed, 22 Mar 2023) $</pubdate>
|
|---|
| 34 | <title>VBoxManage guestcontrol</title>
|
|---|
| 35 | </refentryinfo>
|
|---|
| 36 |
|
|---|
| 37 | <refmeta>
|
|---|
| 38 | <refentrytitle>VBoxManage-guestcontrol</refentrytitle>
|
|---|
| 39 | <manvolnum>1</manvolnum>
|
|---|
| 40 | </refmeta>
|
|---|
| 41 |
|
|---|
| 42 | <refnamediv>
|
|---|
| 43 | <refname>VBoxManage-guestcontrol</refname>
|
|---|
| 44 | <refpurpose>control a virtual machine from the host system</refpurpose>
|
|---|
| 45 | <refclass>&product-name;</refclass>
|
|---|
| 46 | </refnamediv>
|
|---|
| 47 |
|
|---|
| 48 | <refsynopsisdiv>
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-run">
|
|---|
| 50 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 51 | <command>VBoxManage guestcontrol</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">run</arg>
|
|---|
| 57 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 58 | <arg>--dos2unix</arg>
|
|---|
| 59 | <arg>--exe=<replaceable>filename</replaceable></arg>
|
|---|
| 60 | <arg>--ignore-orphaned-processes</arg>
|
|---|
| 61 | <group>
|
|---|
| 62 | <arg choice="plain">--no-wait-stderr</arg>
|
|---|
| 63 | <arg choice="plain">--wait-stderr</arg>
|
|---|
| 64 | </group>
|
|---|
| 65 | <group>
|
|---|
| 66 | <arg choice="plain">--no-wait-stdout</arg>
|
|---|
| 67 | <arg choice="plain">--wait-stdout</arg>
|
|---|
| 68 | </group>
|
|---|
| 69 | <group>
|
|---|
| 70 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 71 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 72 | </group>
|
|---|
| 73 | <arg>--profile</arg>
|
|---|
| 74 | <arg>--putenv=<replaceable>var-name</replaceable>=[<replaceable>value</replaceable>]</arg>
|
|---|
| 75 | <arg>--quiet</arg>
|
|---|
| 76 | <arg>--timeout=<replaceable>msec</replaceable></arg>
|
|---|
| 77 | <arg>--unix2dos</arg>
|
|---|
| 78 | <arg>--unquoted-args</arg>
|
|---|
| 79 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 80 | <arg>--cwd=<replaceable>directory</replaceable></arg>
|
|---|
| 81 | <arg>--verbose</arg>
|
|---|
| 82 | <arg choice="req">-- <replaceable>program/arg0</replaceable> <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
|
|---|
| 83 | </cmdsynopsis>
|
|---|
| 84 |
|
|---|
| 85 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-start">
|
|---|
| 86 | <command>VBoxManage guestcontrol</command>
|
|---|
| 87 | <group choice="req">
|
|---|
| 88 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 89 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 90 | </group>
|
|---|
| 91 | <arg choice="plain">start</arg>
|
|---|
| 92 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 93 | <arg>--exe=<replaceable>filename</replaceable></arg>
|
|---|
| 94 | <arg>--ignore-orphaned-processes</arg>
|
|---|
| 95 | <group>
|
|---|
| 96 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 97 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 98 | </group>
|
|---|
| 99 | <arg>--profile</arg>
|
|---|
| 100 | <arg>--putenv=<replaceable>var-name</replaceable>=[<replaceable>value</replaceable>]</arg>
|
|---|
| 101 | <arg>--quiet</arg>
|
|---|
| 102 | <arg>--timeout=<replaceable>msec</replaceable></arg>
|
|---|
| 103 | <arg>--unquoted-args</arg>
|
|---|
| 104 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 105 | <arg>--cwd=<replaceable>directory</replaceable></arg>
|
|---|
| 106 | <arg>--verbose</arg>
|
|---|
| 107 | <arg choice="req">-- <replaceable>program/arg0</replaceable> <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
|
|---|
| 108 | </cmdsynopsis>
|
|---|
| 109 |
|
|---|
| 110 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-copyfrom">
|
|---|
| 111 | <command>VBoxManage guestcontrol</command>
|
|---|
| 112 | <group choice="req">
|
|---|
| 113 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 114 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 115 | </group>
|
|---|
| 116 | <arg choice="plain">copyfrom</arg>
|
|---|
| 117 | <arg>--dereference</arg>
|
|---|
| 118 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 119 | <group>
|
|---|
| 120 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 121 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 122 | </group>
|
|---|
| 123 | <arg>--quiet</arg>
|
|---|
| 124 | <arg>--no-replace</arg>
|
|---|
| 125 | <arg>--recursive</arg>
|
|---|
| 126 | <arg>--target-directory=<replaceable>host-destination-dir</replaceable></arg>
|
|---|
| 127 | <arg>--update</arg>
|
|---|
| 128 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 129 | <arg>--verbose</arg>
|
|---|
| 130 | <arg choice="req"><replaceable>guest-source0</replaceable></arg>
|
|---|
| 131 | <arg choice="plain"><replaceable>guest-source1</replaceable> [...]</arg>
|
|---|
| 132 | <arg choice="req"><replaceable>host-destination</replaceable></arg>
|
|---|
| 133 | </cmdsynopsis>
|
|---|
| 134 |
|
|---|
| 135 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-copyto">
|
|---|
| 136 | <command>VBoxManage guestcontrol</command>
|
|---|
| 137 | <group choice="req">
|
|---|
| 138 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 139 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 140 | </group>
|
|---|
| 141 | <arg choice="plain">copyto</arg>
|
|---|
| 142 | <arg>--dereference</arg>
|
|---|
| 143 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 144 | <group>
|
|---|
| 145 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 146 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 147 | </group>
|
|---|
| 148 | <arg>--quiet</arg>
|
|---|
| 149 | <arg>--no-replace</arg>
|
|---|
| 150 | <arg>--recursive</arg>
|
|---|
| 151 | <arg>--target-directory=<replaceable>guest-destination-dir</replaceable></arg>
|
|---|
| 152 | <arg>--update</arg>
|
|---|
| 153 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 154 | <arg>--verbose</arg>
|
|---|
| 155 | <arg choice="req"><replaceable>host-source0</replaceable></arg>
|
|---|
| 156 | <arg choice="plain"><replaceable>host-source1</replaceable> [...]</arg>
|
|---|
| 157 | </cmdsynopsis>
|
|---|
| 158 |
|
|---|
| 159 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mkdir">
|
|---|
| 160 | <command>VBoxManage guestcontrol</command>
|
|---|
| 161 | <group choice="req">
|
|---|
| 162 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 163 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 164 | </group>
|
|---|
| 165 | <arg choice="plain">mkdir</arg>
|
|---|
| 166 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 167 | <arg>--mode=<replaceable>mode</replaceable></arg>
|
|---|
| 168 | <arg>--parents</arg>
|
|---|
| 169 | <group>
|
|---|
| 170 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 171 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 172 | </group>
|
|---|
| 173 | <arg>--quiet</arg>
|
|---|
| 174 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 175 | <arg>--verbose</arg>
|
|---|
| 176 | <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
|
|---|
| 177 | </cmdsynopsis>
|
|---|
| 178 |
|
|---|
| 179 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-rmdir">
|
|---|
| 180 | <command>VBoxManage guestcontrol</command>
|
|---|
| 181 | <group choice="req">
|
|---|
| 182 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 183 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 184 | </group>
|
|---|
| 185 | <arg choice="plain">rmdir</arg>
|
|---|
| 186 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 187 | <group>
|
|---|
| 188 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 189 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 190 | </group>
|
|---|
| 191 | <arg>--quiet</arg>
|
|---|
| 192 | <arg>--recursive</arg>
|
|---|
| 193 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 194 | <arg>--verbose</arg>
|
|---|
| 195 | <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
|
|---|
| 196 | </cmdsynopsis>
|
|---|
| 197 |
|
|---|
| 198 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-rm">
|
|---|
| 199 | <command>VBoxManage guestcontrol</command>
|
|---|
| 200 | <group choice="req">
|
|---|
| 201 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 202 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 203 | </group>
|
|---|
| 204 | <arg choice="plain">rm</arg>
|
|---|
| 205 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 206 | <arg>--force</arg>
|
|---|
| 207 | <group>
|
|---|
| 208 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 209 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 210 | </group>
|
|---|
| 211 | <arg>--quiet</arg>
|
|---|
| 212 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 213 | <arg>--verbose</arg>
|
|---|
| 214 | <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
|
|---|
| 215 | </cmdsynopsis>
|
|---|
| 216 |
|
|---|
| 217 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mv">
|
|---|
| 218 | <command>VBoxManage guestcontrol</command>
|
|---|
| 219 | <group choice="req">
|
|---|
| 220 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 221 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 222 | </group>
|
|---|
| 223 | <arg choice="plain">mv</arg>
|
|---|
| 224 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 225 | <group>
|
|---|
| 226 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 227 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 228 | </group>
|
|---|
| 229 | <arg>--quiet</arg>
|
|---|
| 230 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 231 | <arg>--verbose</arg>
|
|---|
| 232 | <arg choice="req" rep="repeat"><replaceable>source</replaceable></arg>
|
|---|
| 233 | <arg choice="req"><replaceable>destination-directory</replaceable></arg>
|
|---|
| 234 | </cmdsynopsis>
|
|---|
| 235 |
|
|---|
| 236 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mktemp">
|
|---|
| 237 | <command>VBoxManage guestcontrol</command>
|
|---|
| 238 | <group choice="req">
|
|---|
| 239 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 240 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 241 | </group>
|
|---|
| 242 | <arg choice="plain">mktemp</arg>
|
|---|
| 243 | <arg>--directory</arg>
|
|---|
| 244 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 245 | <arg>--mode=<replaceable>mode</replaceable></arg>
|
|---|
| 246 | <group>
|
|---|
| 247 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 248 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 249 | </group>
|
|---|
| 250 | <arg>--quiet</arg>
|
|---|
| 251 | <arg>--secure</arg>
|
|---|
| 252 | <arg>--tmpdir=<replaceable>directory-name</replaceable></arg>
|
|---|
| 253 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 254 | <arg>--verbose</arg>
|
|---|
| 255 | <arg choice="req"><replaceable>template-name</replaceable></arg>
|
|---|
| 256 | </cmdsynopsis>
|
|---|
| 257 |
|
|---|
| 258 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-stat">
|
|---|
| 259 | <command>VBoxManage guestcontrol</command>
|
|---|
| 260 | <group choice="req">
|
|---|
| 261 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 262 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 263 | </group>
|
|---|
| 264 | <arg choice="plain">stat</arg>
|
|---|
| 265 | <arg>--domain=<replaceable>domainname</replaceable></arg>
|
|---|
| 266 | <group>
|
|---|
| 267 | <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
|
|---|
| 268 | <arg choice="plain">--password=<replaceable>password</replaceable></arg>
|
|---|
| 269 | </group>
|
|---|
| 270 | <arg>--quiet</arg>
|
|---|
| 271 | <arg>--username=<replaceable>username</replaceable></arg>
|
|---|
| 272 | <arg>--verbose</arg>
|
|---|
| 273 | <arg choice="req"><replaceable>filename</replaceable></arg>
|
|---|
| 274 | </cmdsynopsis>
|
|---|
| 275 |
|
|---|
| 276 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-list">
|
|---|
| 277 | <command>VBoxManage guestcontrol</command>
|
|---|
| 278 | <group choice="req">
|
|---|
| 279 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 280 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 281 | </group>
|
|---|
| 282 | <arg choice="plain">list</arg>
|
|---|
| 283 | <group choice="req">
|
|---|
| 284 | <arg choice="plain">all</arg>
|
|---|
| 285 | <arg choice="plain">files</arg>
|
|---|
| 286 | <arg choice="plain">processes</arg>
|
|---|
| 287 | <arg choice="plain">sessions</arg>
|
|---|
| 288 | </group>
|
|---|
| 289 | <arg>--quiet</arg>
|
|---|
| 290 | <arg>--verbose</arg>
|
|---|
| 291 | </cmdsynopsis>
|
|---|
| 292 |
|
|---|
| 293 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-closeprocess">
|
|---|
| 294 | <command>VBoxManage guestcontrol</command>
|
|---|
| 295 | <group choice="req">
|
|---|
| 296 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 297 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 298 | </group>
|
|---|
| 299 | <arg choice="plain">closeprocess</arg>
|
|---|
| 300 | <group>
|
|---|
| 301 | <arg choice="plain">--session-id=<replaceable>ID</replaceable></arg>
|
|---|
| 302 | <arg choice="plain">--session-name=<replaceable>name-or-pattern</replaceable></arg>
|
|---|
| 303 | </group>
|
|---|
| 304 | <arg>--quiet</arg>
|
|---|
| 305 | <arg>--verbose</arg>
|
|---|
| 306 | <arg choice="req" rep="repeat"><replaceable>PID</replaceable></arg>
|
|---|
| 307 | </cmdsynopsis>
|
|---|
| 308 |
|
|---|
| 309 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-closesession">
|
|---|
| 310 | <command>VBoxManage guestcontrol</command>
|
|---|
| 311 | <group choice="req">
|
|---|
| 312 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 313 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 314 | </group>
|
|---|
| 315 | <arg choice="plain">closesession</arg>
|
|---|
| 316 | <group>
|
|---|
| 317 | <arg choice="plain">--all</arg>
|
|---|
| 318 | <arg choice="plain">--session-id=<replaceable>ID</replaceable></arg>
|
|---|
| 319 | <arg choice="plain">--session-name=<replaceable>name-or-pattern</replaceable></arg>
|
|---|
| 320 | </group>
|
|---|
| 321 | <arg>--quiet</arg>
|
|---|
| 322 | <arg>--verbose</arg>
|
|---|
| 323 | </cmdsynopsis>
|
|---|
| 324 |
|
|---|
| 325 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-updatega">
|
|---|
| 326 | <command>VBoxManage guestcontrol</command>
|
|---|
| 327 | <group choice="req">
|
|---|
| 328 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 329 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 330 | </group>
|
|---|
| 331 | <arg choice="plain">updatega</arg>
|
|---|
| 332 | <arg>--quiet</arg>
|
|---|
| 333 | <arg>--verbose</arg>
|
|---|
| 334 | <arg>--source=<replaceable>guest-additions.ISO</replaceable></arg>
|
|---|
| 335 | <arg>--wait-start</arg>
|
|---|
| 336 | <arg>-- <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
|
|---|
| 337 | </cmdsynopsis>
|
|---|
| 338 |
|
|---|
| 339 | <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-watch">
|
|---|
| 340 | <command>VBoxManage guestcontrol</command>
|
|---|
| 341 | <group choice="req">
|
|---|
| 342 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 343 | <arg choice="plain"><replaceable>vmname</replaceable></arg>
|
|---|
| 344 | </group>
|
|---|
| 345 | <arg choice="plain">watch</arg>
|
|---|
| 346 | <arg>--quiet</arg>
|
|---|
| 347 | <arg>--verbose</arg>
|
|---|
| 348 | </cmdsynopsis>
|
|---|
| 349 | </refsynopsisdiv>
|
|---|
| 350 |
|
|---|
| 351 | <refsect1>
|
|---|
| 352 | <title>Description</title>
|
|---|
| 353 | <para>
|
|---|
| 354 | The <command>VBoxManage guestcontrol</command> command enables you
|
|---|
| 355 | to control a guest (VM) from the host system. See
|
|---|
| 356 | <xref linkend="guestadd-guestcontrol" />.
|
|---|
| 357 | </para>
|
|---|
| 358 | <refsect2>
|
|---|
| 359 | <title>Common Options and Operands</title>
|
|---|
| 360 | <para>
|
|---|
| 361 | The following options can be used by any of the
|
|---|
| 362 | <command>VBoxManage guestcontrol</command> subcommands:
|
|---|
| 363 | </para>
|
|---|
| 364 | <variablelist>
|
|---|
| 365 | <varlistentry>
|
|---|
| 366 | <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
|
|---|
| 367 | <listitem><para>
|
|---|
| 368 | Specifies the Universally Unique Identifier (UUID) or name
|
|---|
| 369 | of the VM.
|
|---|
| 370 | </para></listitem>
|
|---|
| 371 | </varlistentry>
|
|---|
| 372 | <varlistentry>
|
|---|
| 373 | <term><option>--quiet</option></term>
|
|---|
| 374 | <listitem><para>
|
|---|
| 375 | Specifies that the command produce quieter output.
|
|---|
| 376 | </para><para>
|
|---|
| 377 | The short form of this option is <option>-q</option>.
|
|---|
| 378 | </para></listitem>
|
|---|
| 379 | </varlistentry>
|
|---|
| 380 | <varlistentry>
|
|---|
| 381 | <term><option>--verbose</option></term>
|
|---|
| 382 | <listitem><para>
|
|---|
| 383 | Specifies that the command produce more detailed output.
|
|---|
| 384 | </para><para>
|
|---|
| 385 | The short form of this option is <option>-v</option>.
|
|---|
| 386 | </para></listitem>
|
|---|
| 387 | </varlistentry>
|
|---|
| 388 | </variablelist>
|
|---|
| 389 | <para>
|
|---|
| 390 | Some of the <command>VBoxManage guestcontrol</command>
|
|---|
| 391 | subcommands require that you provide guest credentials for
|
|---|
| 392 | authentication. The subcommands are:
|
|---|
| 393 | <command>copyfrom</command>, <command>copyto</command>,
|
|---|
| 394 | <command>mkdir</command>, <command>mktemp</command>,
|
|---|
| 395 | <command>mv</command>, <command>rmdir</command>,
|
|---|
| 396 | <command>rm</command>, <command>run</command>,
|
|---|
| 397 | <command>start</command>, and <command>stat</command>.
|
|---|
| 398 | </para>
|
|---|
| 399 | <para>
|
|---|
| 400 | While you cannot perform anonymous executions, a user account
|
|---|
| 401 | password is optional and depends on the guest's OS security
|
|---|
| 402 | policy. If a user account does not have an associated password,
|
|---|
| 403 | specify an empty password. On OSes such as Windows, you might
|
|---|
| 404 | need to adjust the security policy to permit user accounts with
|
|---|
| 405 | an empty password. In additional, global domain rules might
|
|---|
| 406 | apply and therefore cannot be changed.
|
|---|
| 407 | </para>
|
|---|
| 408 | <para>
|
|---|
| 409 | The following options are used for authentication on the guest
|
|---|
| 410 | VM:
|
|---|
| 411 | </para>
|
|---|
| 412 | <variablelist>
|
|---|
| 413 | <varlistentry>
|
|---|
| 414 | <term><option>--domain=<replaceable>domainname</replaceable></option></term>
|
|---|
| 415 | <listitem><para>
|
|---|
| 416 | Specifies the user domain for Windows guest VMs.
|
|---|
| 417 | </para></listitem>
|
|---|
| 418 | </varlistentry>
|
|---|
| 419 | <varlistentry>
|
|---|
| 420 | <term><option>--password=<replaceable>password</replaceable></option></term>
|
|---|
| 421 | <listitem><para>
|
|---|
| 422 | Specifies the password for the specified user. If you do
|
|---|
| 423 | not specify a password on the command line or if the
|
|---|
| 424 | password file is empty, the specified user needs to have
|
|---|
| 425 | an empty password.
|
|---|
| 426 | </para></listitem>
|
|---|
| 427 | </varlistentry>
|
|---|
| 428 | <varlistentry>
|
|---|
| 429 | <term><option>--passwordfile=<replaceable>filename</replaceable></option></term>
|
|---|
| 430 | <listitem><para>
|
|---|
| 431 | Specifies the absolute path to a file on the guest OS that
|
|---|
| 432 | contains the password for the specified user. If the
|
|---|
| 433 | password file is empty or if you do not specify a password
|
|---|
| 434 | on the command line, the specified user needs to have an
|
|---|
| 435 | empty password.
|
|---|
| 436 | </para></listitem>
|
|---|
| 437 | </varlistentry>
|
|---|
| 438 | <varlistentry>
|
|---|
| 439 | <term><option>--username=<replaceable>username</replaceable></option></term>
|
|---|
| 440 | <listitem><para>
|
|---|
| 441 | Specifies an existing user on the guest OS that runs the
|
|---|
| 442 | process. If unspecified, the host user runs the process.
|
|---|
| 443 | </para></listitem>
|
|---|
| 444 | </varlistentry>
|
|---|
| 445 | </variablelist>
|
|---|
| 446 | </refsect2>
|
|---|
| 447 | <refsect2>
|
|---|
| 448 | <title>Guest Process Restrictions</title>
|
|---|
| 449 | <para>
|
|---|
| 450 | By default, you can run up to five guest processes
|
|---|
| 451 | simultaneously. If a new guest process starts and would exceed
|
|---|
| 452 | this limit, the oldest not-running guest process is discarded to
|
|---|
| 453 | run the new process. You cannot retrieve output from a discarded
|
|---|
| 454 | guest process. If all five guest processes are active and
|
|---|
| 455 | running, attempting to start a new guest process fails.
|
|---|
| 456 | </para>
|
|---|
| 457 | <para>
|
|---|
| 458 | You can modify the guest process execution limit in two ways:
|
|---|
| 459 | </para>
|
|---|
| 460 | <itemizedlist>
|
|---|
| 461 | <listitem><para>
|
|---|
| 462 | Use the <command>VBoxManage setproperty</command> command to
|
|---|
| 463 | update the
|
|---|
| 464 | <literal>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</literal>
|
|---|
| 465 | guest property value.
|
|---|
| 466 | </para></listitem>
|
|---|
| 467 | <listitem><para>
|
|---|
| 468 | Use the <command>VBoxService</command> command and specify
|
|---|
| 469 | the
|
|---|
| 470 | <option>--control-procs-max-kept=<replaceable>value</replaceable></option>
|
|---|
| 471 | option.
|
|---|
| 472 | </para></listitem>
|
|---|
| 473 | </itemizedlist>
|
|---|
| 474 | <para>
|
|---|
| 475 | After you change the limit, you must restart the guest OS.
|
|---|
| 476 | </para>
|
|---|
| 477 | <para>
|
|---|
| 478 | You can serve an unlimited number guest processes by specifing a
|
|---|
| 479 | value of <literal>0</literal>, however this action is not
|
|---|
| 480 | recommended.
|
|---|
| 481 | </para>
|
|---|
| 482 | </refsect2>
|
|---|
| 483 | <refsect2 id="vboxmanage-guestcontrol-run">
|
|---|
| 484 | <title>Run a Command on the guest</title>
|
|---|
| 485 | <remark role="help-copy-synopsis"/>
|
|---|
| 486 | <para>
|
|---|
| 487 | The <command>VBoxManage guestcontrol
|
|---|
| 488 | <replaceable>vmname</replaceable> run</command> command enables
|
|---|
| 489 | you to execute a program on the guest VM. Standard input,
|
|---|
| 490 | standard output, and standard error are redirected from the VM
|
|---|
| 491 | to the host system until the program completes.
|
|---|
| 492 | </para>
|
|---|
| 493 | <note>
|
|---|
| 494 | <para>
|
|---|
| 495 | The Windows OS imposes certain limitations for graphical
|
|---|
| 496 | applications. See <xref linkend="KnownIssues" />.
|
|---|
| 497 | </para>
|
|---|
| 498 | </note>
|
|---|
| 499 | <variablelist>
|
|---|
| 500 | <varlistentry>
|
|---|
| 501 | <term><option>--exe=<replaceable>path-to-executable</replaceable></option></term>
|
|---|
| 502 | <listitem><para>
|
|---|
| 503 | Specifies the absolute path of the executable program to
|
|---|
| 504 | run on the guest VM. For example:
|
|---|
| 505 | <filename>C:\Windows\System32\calc.exe</filename>.
|
|---|
| 506 | </para></listitem>
|
|---|
| 507 | </varlistentry>
|
|---|
| 508 | <varlistentry>
|
|---|
| 509 | <term><option>--cwd=<replaceable>path-to-directory</replaceable></option></term>
|
|---|
| 510 | <listitem><para>
|
|---|
| 511 | Specifies the absolute path of a directory in which
|
|---|
| 512 | to start the program. Optional. The directory must
|
|---|
| 513 | exist and be accessible to the guest user. For example:
|
|---|
| 514 | <filename>C:\Users\production\work_area</filename>.
|
|---|
| 515 | </para><para>
|
|---|
| 516 | The short form of this option is <option>-C</option>.
|
|---|
| 517 | </para></listitem>
|
|---|
| 518 | </varlistentry>
|
|---|
| 519 | <varlistentry>
|
|---|
| 520 | <term><option>--timeout=<replaceable>msec</replaceable></option></term>
|
|---|
| 521 | <listitem><para>
|
|---|
| 522 | Specifies the maximum amount of time, in milliseconds,
|
|---|
| 523 | that the program can run. While the program runs,
|
|---|
| 524 | <command>VBoxManage</command> receives its output.
|
|---|
| 525 | </para><para>
|
|---|
| 526 | If you do not specify a timeout value,
|
|---|
| 527 | <command>VBoxManage</command> waits indefinitely for the
|
|---|
| 528 | process to end, or for an error to occur.
|
|---|
| 529 | </para></listitem>
|
|---|
| 530 | </varlistentry>
|
|---|
| 531 | <varlistentry>
|
|---|
| 532 | <term><option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option></term>
|
|---|
| 533 | <listitem><para>
|
|---|
| 534 | Sets, modifies, and unsets environment variables in the
|
|---|
| 535 | guest VM environment.
|
|---|
| 536 | </para><para>
|
|---|
| 537 | When you create a guest process, it runs with the default
|
|---|
| 538 | standard guest OS environment. Use this option to modify
|
|---|
| 539 | environment variables in that default environment.
|
|---|
| 540 | </para><para>
|
|---|
| 541 | Use the
|
|---|
| 542 | <option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option>
|
|---|
| 543 | option to set or modify the environment variable specified
|
|---|
| 544 | by <replaceable>NAME</replaceable>.
|
|---|
| 545 | </para><para>
|
|---|
| 546 | Use the
|
|---|
| 547 | <option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option>
|
|---|
| 548 | option to unset the environment variable specified by
|
|---|
| 549 | <replaceable>NAME</replaceable>.
|
|---|
| 550 | </para><para>
|
|---|
| 551 | Ensure that any environment variable name or value that
|
|---|
| 552 | includes spaces is enclosed by quotes.
|
|---|
| 553 | </para><para>
|
|---|
| 554 | Specify a <option>--putenv</option> option for each
|
|---|
| 555 | environment variable that you want to modify.
|
|---|
| 556 | </para><para>
|
|---|
| 557 | The short form of this option is <option>-E</option>.
|
|---|
| 558 | </para></listitem>
|
|---|
| 559 | </varlistentry>
|
|---|
| 560 | <varlistentry>
|
|---|
| 561 | <term><option>--unquoted-args</option></term>
|
|---|
| 562 | <listitem><para>
|
|---|
| 563 | Disables the escaped double quoting of arguments that you
|
|---|
| 564 | pass to the program. For example,
|
|---|
| 565 | <literal>\"fred\"</literal>.
|
|---|
| 566 | </para></listitem>
|
|---|
| 567 | </varlistentry>
|
|---|
| 568 | <varlistentry>
|
|---|
| 569 | <term><option>--ignore-orphaned-processes</option></term>
|
|---|
| 570 | <listitem><para>
|
|---|
| 571 | Ignores orphaned processes. Not yet implemented.
|
|---|
| 572 | </para></listitem>
|
|---|
| 573 | </varlistentry>
|
|---|
| 574 | <varlistentry>
|
|---|
| 575 | <term><option>--profile</option></term>
|
|---|
| 576 | <listitem><para>
|
|---|
| 577 | Uses a shell profile to specify the environment to use.
|
|---|
| 578 | Not yet implemented.
|
|---|
| 579 | </para></listitem>
|
|---|
| 580 | </varlistentry>
|
|---|
| 581 | <varlistentry>
|
|---|
| 582 | <term><option>--no-wait-stdout</option></term>
|
|---|
| 583 | <listitem><para>
|
|---|
| 584 | Does not wait for the guest process to end or receive its
|
|---|
| 585 | exit code and any failure explanation.
|
|---|
| 586 | </para></listitem>
|
|---|
| 587 | </varlistentry>
|
|---|
| 588 | <varlistentry>
|
|---|
| 589 | <term><option>--wait-stdout</option></term>
|
|---|
| 590 | <listitem><para>
|
|---|
| 591 | Waits for the guest process to end to receive its exit
|
|---|
| 592 | code and any failure explanation. The
|
|---|
| 593 | <command>VBoxManage</command> command receives the
|
|---|
| 594 | standard output of the guest process while the process
|
|---|
| 595 | runs.
|
|---|
| 596 | </para></listitem>
|
|---|
| 597 | </varlistentry>
|
|---|
| 598 | <varlistentry>
|
|---|
| 599 | <term><option>--no-wait-stderr</option></term>
|
|---|
| 600 | <listitem><para>
|
|---|
| 601 | Does not wait for the guest process to end to receive its
|
|---|
| 602 | exit code, error messages, and flags.
|
|---|
| 603 | </para></listitem>
|
|---|
| 604 | </varlistentry>
|
|---|
| 605 | <varlistentry>
|
|---|
| 606 | <term><option>--wait-stderr</option></term>
|
|---|
| 607 | <listitem><para>
|
|---|
| 608 | Waits for the guest process to end to receive its exit
|
|---|
| 609 | code, error messages, and flags. The
|
|---|
| 610 | <command>VBoxManage</command> command receives the
|
|---|
| 611 | standard error of the guest process while the process
|
|---|
| 612 | runs.
|
|---|
| 613 | </para></listitem>
|
|---|
| 614 | </varlistentry>
|
|---|
| 615 | <varlistentry>
|
|---|
| 616 | <term><option>--dos2unix</option></term>
|
|---|
| 617 | <listitem><para>
|
|---|
| 618 | Transform DOS or Windows guest output to UNIX or Linux
|
|---|
| 619 | output. This transformation changes CR + LF line endings
|
|---|
| 620 | to LF. Not yet implemented.
|
|---|
| 621 | </para></listitem>
|
|---|
| 622 | </varlistentry>
|
|---|
| 623 | <varlistentry>
|
|---|
| 624 | <term><option>--unix2dos</option></term>
|
|---|
| 625 | <listitem><para>
|
|---|
| 626 | Transform UNIX or Linux guest output to DOS or Windows
|
|---|
| 627 | output. This transformation changes LF line endings to CR
|
|---|
| 628 | + LF.
|
|---|
| 629 | </para></listitem>
|
|---|
| 630 | </varlistentry>
|
|---|
| 631 | <varlistentry>
|
|---|
| 632 | <term><option>-- <replaceable>program/arg0</replaceable> [<replaceable>argument</replaceable>...]</option></term>
|
|---|
| 633 | <listitem><para>
|
|---|
| 634 | Specifies the name of the program and any arguments to
|
|---|
| 635 | pass to the program.
|
|---|
| 636 | </para><para>
|
|---|
| 637 | Ensure that any command argument that includes spaces is
|
|---|
| 638 | enclosed by quotes.
|
|---|
| 639 | </para></listitem>
|
|---|
| 640 | </varlistentry>
|
|---|
| 641 | </variablelist>
|
|---|
| 642 | </refsect2>
|
|---|
| 643 | <refsect2 id="vboxmanage-guestcontrol-start">
|
|---|
| 644 | <title>Start a Command on the guest</title>
|
|---|
| 645 | <remark role="help-copy-synopsis"/>
|
|---|
| 646 | <para>
|
|---|
| 647 | The <command>VBoxManage guestcontrol
|
|---|
| 648 | <replaceable>vmname</replaceable> start</command> command
|
|---|
| 649 | enables you to execute a guest program until it completes.
|
|---|
| 650 | </para>
|
|---|
| 651 | <note>
|
|---|
| 652 | <para>
|
|---|
| 653 | The Windows OS imposes certain limitations for graphical
|
|---|
| 654 | applications. See <xref linkend="KnownIssues" />.
|
|---|
| 655 | </para>
|
|---|
| 656 | </note>
|
|---|
| 657 | </refsect2>
|
|---|
| 658 | <refsect2 id="vboxmanage-guestcontrol-copyfrom">
|
|---|
| 659 | <title>Copy a file from the guest to the host.</title>
|
|---|
| 660 | <remark role="help-copy-synopsis"/>
|
|---|
| 661 | <para>
|
|---|
| 662 | The <command>VBoxManage guestcontrol
|
|---|
| 663 | <replaceable>vmname</replaceable> copyfrom</command> command
|
|---|
| 664 | enables you to copy a file from the guest VM to the host system.
|
|---|
| 665 | </para>
|
|---|
| 666 | <variablelist>
|
|---|
| 667 | <varlistentry>
|
|---|
| 668 | <term><option>--dereference</option></term>
|
|---|
| 669 | <listitem><para>
|
|---|
| 670 | Enables following of symbolic links on the guest file
|
|---|
| 671 | system.
|
|---|
| 672 | </para></listitem>
|
|---|
| 673 | </varlistentry>
|
|---|
| 674 | <varlistentry>
|
|---|
| 675 | <term><option>--no-replace</option></term>
|
|---|
| 676 | <listitem><para>
|
|---|
| 677 | Only copies a file if it does not exist on the host yet.
|
|---|
| 678 | </para><para>
|
|---|
| 679 | The short form of this option is <option>-n</option>.
|
|---|
| 680 | </para></listitem>
|
|---|
| 681 | </varlistentry>
|
|---|
| 682 | <varlistentry>
|
|---|
| 683 | <term><option>--recursive</option></term>
|
|---|
| 684 | <listitem><para>
|
|---|
| 685 | Recursively copies files and directories from the
|
|---|
| 686 | specified guest directory to the host.
|
|---|
| 687 | </para><para>
|
|---|
| 688 | The short form of this option is <option>-R</option>.
|
|---|
| 689 | </para></listitem>
|
|---|
| 690 | </varlistentry>
|
|---|
| 691 | <varlistentry>
|
|---|
| 692 | <term><option>--target-directory=<replaceable>host-dst-dir</replaceable></option></term>
|
|---|
| 693 | <listitem><para>
|
|---|
| 694 | Specifies the absolute path of the destination directory
|
|---|
| 695 | on the host system. For example,
|
|---|
| 696 | <filename>C:\Temp</filename>.
|
|---|
| 697 | </para></listitem>
|
|---|
| 698 | </varlistentry>
|
|---|
| 699 | <varlistentry>
|
|---|
| 700 | <term><option>--update</option></term>
|
|---|
| 701 | <listitem><para>
|
|---|
| 702 | Only copies a file if the guest file is newer than on the host.
|
|---|
| 703 | </para><para>
|
|---|
| 704 | The short form of this option is <option>-u</option>.
|
|---|
| 705 | </para></listitem>
|
|---|
| 706 | </varlistentry>
|
|---|
| 707 | <varlistentry>
|
|---|
| 708 | <term><literal><replaceable>guest-source0</replaceable> [<replaceable>guest-source1</replaceable> [...]]</literal></term>
|
|---|
| 709 | <listitem><para>
|
|---|
| 710 | Specifies the absolute path of one or more files to copy
|
|---|
| 711 | from the guest VM. For example,
|
|---|
| 712 | <filename>C:\Windows\System32\calc.exe</filename>. You can
|
|---|
| 713 | use wildcards to specify multiple files. For example,
|
|---|
| 714 | <filename>C:\Windows\System*\*.dll</filename>.
|
|---|
| 715 | </para></listitem>
|
|---|
| 716 | </varlistentry>
|
|---|
| 717 | </variablelist>
|
|---|
| 718 | </refsect2>
|
|---|
| 719 | <refsect2 id="vboxmanage-guestcontrol-copyto">
|
|---|
| 720 | <title>Copy a file from the host to the guest.</title>
|
|---|
| 721 | <remark role="help-copy-synopsis"/>
|
|---|
| 722 | <para>
|
|---|
| 723 | The <command>VBoxManage guestcontrol
|
|---|
| 724 | <replaceable>vmname</replaceable> copyto</command> command
|
|---|
| 725 | enables you to copy a file from the host system to the guest VM.
|
|---|
| 726 | </para>
|
|---|
| 727 | <variablelist>
|
|---|
| 728 | <varlistentry>
|
|---|
| 729 | <term><option>--dereference</option></term>
|
|---|
| 730 | <listitem><para>
|
|---|
| 731 | Enables following of symbolic links on the host system.
|
|---|
| 732 | </para></listitem>
|
|---|
| 733 | </varlistentry>
|
|---|
| 734 | <varlistentry>
|
|---|
| 735 | <term><option>--no-replace</option></term>
|
|---|
| 736 | <listitem><para>
|
|---|
| 737 | Only copies a file if it does not exist on the guest yet.
|
|---|
| 738 | </para><para>
|
|---|
| 739 | The short form of this option is <option>-n</option>.
|
|---|
| 740 | </para></listitem>
|
|---|
| 741 | </varlistentry>
|
|---|
| 742 | <varlistentry>
|
|---|
| 743 | <term><option>--recursive</option></term>
|
|---|
| 744 | <listitem><para>
|
|---|
| 745 | Recursively copies files and directories from the
|
|---|
| 746 | specified host directory to the guest.
|
|---|
| 747 | </para><para>
|
|---|
| 748 | The short form of this option is <option>-R</option>.
|
|---|
| 749 | </para></listitem>
|
|---|
| 750 | </varlistentry>
|
|---|
| 751 | <varlistentry>
|
|---|
| 752 | <term><option>--target-directory=<replaceable>guest-dst-dir</replaceable></option></term>
|
|---|
| 753 | <listitem><para>
|
|---|
| 754 | Specifies the absolute path of the destination directory
|
|---|
| 755 | on the guest. For example,
|
|---|
| 756 | <filename>/home/myuser/fromhost</filename>.
|
|---|
| 757 | </para></listitem>
|
|---|
| 758 | </varlistentry>
|
|---|
| 759 | <varlistentry>
|
|---|
| 760 | <term><option>--update</option></term>
|
|---|
| 761 | <listitem><para>
|
|---|
| 762 | Only copies a file if the host file is newer than on the guest.
|
|---|
| 763 | </para><para>
|
|---|
| 764 | The short form of this option is <option>-u</option>.
|
|---|
| 765 | </para></listitem>
|
|---|
| 766 | </varlistentry>
|
|---|
| 767 | <varlistentry>
|
|---|
| 768 | <term><literal><replaceable>host-source0</replaceable> [<replaceable>host-source1</replaceable> [...]]</literal></term>
|
|---|
| 769 | <listitem><para>
|
|---|
| 770 | Specifies the absolute path of a file to
|
|---|
| 771 | copy from the host system. For example,
|
|---|
| 772 | <filename>C:\Windows\System32\calc.exe</filename>. You can
|
|---|
| 773 | use wildcards to specify multiple files. For example,
|
|---|
| 774 | <filename>C:\Windows\System*\*.dll</filename>.
|
|---|
| 775 | </para></listitem>
|
|---|
| 776 | </varlistentry>
|
|---|
| 777 | </variablelist>
|
|---|
| 778 | </refsect2>
|
|---|
| 779 | <refsect2 id="vboxmanage-guestcontrol-mkdir">
|
|---|
| 780 | <title>Create a directory on the guest.</title>
|
|---|
| 781 | <remark role="help-copy-synopsis"/>
|
|---|
| 782 | <para>
|
|---|
| 783 | The <command>VBoxManage guestcontrol
|
|---|
| 784 | <replaceable>vmname</replaceable> mkdir</command> command
|
|---|
| 785 | enables you to create one or more directories on the guest VM.
|
|---|
| 786 | </para>
|
|---|
| 787 | <para>
|
|---|
| 788 | Alternate forms of this subcommand are <command>md</command>,
|
|---|
| 789 | <command>createdir</command>, and
|
|---|
| 790 | <command>createdirectory</command>.
|
|---|
| 791 | </para>
|
|---|
| 792 | <variablelist>
|
|---|
| 793 | <varlistentry>
|
|---|
| 794 | <term><option>--parents</option></term>
|
|---|
| 795 | <listitem><para>
|
|---|
| 796 | Creates any of the missing parent directories of the
|
|---|
| 797 | specified directory.
|
|---|
| 798 | </para><para>
|
|---|
| 799 | For example, if you attempt to create the
|
|---|
| 800 | <filename>D:\Foo\Bar</filename> directory and the
|
|---|
| 801 | <filename>D:\Foo</filename> directory does not exist,
|
|---|
| 802 | using the <option>--parents</option> creates the missing
|
|---|
| 803 | <filename>D:\Foo</filename> directory. However, if you
|
|---|
| 804 | attempt to create the <filename>D:\Foo\Bar</filename> and
|
|---|
| 805 | do not specify the <option>--parents</option> option, the
|
|---|
| 806 | command fails.
|
|---|
| 807 | </para></listitem>
|
|---|
| 808 | </varlistentry>
|
|---|
| 809 | <varlistentry>
|
|---|
| 810 | <term><option>--mode=<replaceable>mode</replaceable></option></term>
|
|---|
| 811 | <listitem><para>
|
|---|
| 812 | Specifies the permission mode to use for the specified
|
|---|
| 813 | directory. If you specify the <option>--parents</option>
|
|---|
| 814 | option, the mode is used for the associated parent
|
|---|
| 815 | directories, as well. <replaceable>mode</replaceable> is a
|
|---|
| 816 | four-digit octal mode such as <literal>0755</literal>.
|
|---|
| 817 | </para></listitem>
|
|---|
| 818 | </varlistentry>
|
|---|
| 819 | <varlistentry>
|
|---|
| 820 | <term><literal><replaceable>guest-dir</replaceable> [<replaceable>guest-dir</replaceable>...]</literal></term>
|
|---|
| 821 | <listitem><para>
|
|---|
| 822 | Specifies an absolute path of one or more directories to
|
|---|
| 823 | create on the guest VM. For example,
|
|---|
| 824 | <filename>D:\Foo\Bar</filename>.
|
|---|
| 825 | </para><para>
|
|---|
| 826 | If all of the associated parent directories do not exist
|
|---|
| 827 | on the guest VM, you must specify the
|
|---|
| 828 | <option>--parents</option> option.
|
|---|
| 829 | </para><para>
|
|---|
| 830 | You must have sufficient rights on the guest VM to create
|
|---|
| 831 | the specified directory and its parent directories.
|
|---|
| 832 | </para></listitem>
|
|---|
| 833 | </varlistentry>
|
|---|
| 834 | </variablelist>
|
|---|
| 835 | </refsect2>
|
|---|
| 836 | <refsect2 id="vboxmanage-guestcontrol-rmdir">
|
|---|
| 837 | <title>Remove a directory from the guest.</title>
|
|---|
| 838 | <remark role="help-copy-synopsis"/>
|
|---|
| 839 | <para>
|
|---|
| 840 | The <command>VBoxManage guestcontrol
|
|---|
| 841 | <replaceable>vmname</replaceable> rmdir</command> command
|
|---|
| 842 | enables you to delete the specified directory from the guest VM.
|
|---|
| 843 | </para>
|
|---|
| 844 | <para>
|
|---|
| 845 | Alternate forms of this subcommand are
|
|---|
| 846 | <command>removedir</command> and
|
|---|
| 847 | <command>removedirectory</command>.
|
|---|
| 848 | </para>
|
|---|
| 849 | <variablelist>
|
|---|
| 850 | <varlistentry>
|
|---|
| 851 | <term><option>--recursive</option></term>
|
|---|
| 852 | <listitem><para>
|
|---|
| 853 | Recursively removes directories from the specified from
|
|---|
| 854 | the guest VM.
|
|---|
| 855 | </para><para>
|
|---|
| 856 | The short form of this option is <option>-R</option>.
|
|---|
| 857 | </para></listitem>
|
|---|
| 858 | </varlistentry>
|
|---|
| 859 | <varlistentry>
|
|---|
| 860 | <term><literal><replaceable>guest-dir</replaceable> [<replaceable>guest-dir</replaceable>...]</literal></term>
|
|---|
| 861 | <listitem><para>
|
|---|
| 862 | Specifies an absolute path of one or more directories to
|
|---|
| 863 | remove from the guest VM. You can use wildcards to specify
|
|---|
| 864 | the directory names. For example,
|
|---|
| 865 | <filename>D:\Foo\*Bar</filename>.
|
|---|
| 866 | </para><para>
|
|---|
| 867 | You must have sufficient rights on the guest VM to remove
|
|---|
| 868 | the specified directory and its parent directories.
|
|---|
| 869 | </para></listitem>
|
|---|
| 870 | </varlistentry>
|
|---|
| 871 | </variablelist>
|
|---|
| 872 | </refsect2>
|
|---|
| 873 | <refsect2 id="vboxmanage-guestcontrol-rm">
|
|---|
| 874 | <title>Remove a file from the guest.</title>
|
|---|
| 875 | <remark role="help-copy-synopsis"/>
|
|---|
| 876 | <para>
|
|---|
| 877 | The <command>VBoxManage guestcontrol
|
|---|
| 878 | <replaceable>vmname</replaceable> rm</command> command enables
|
|---|
| 879 | you to delete the specified files from the guest VM.
|
|---|
| 880 | </para>
|
|---|
| 881 | <para>
|
|---|
| 882 | The alternate form of this subcommand is
|
|---|
| 883 | <command>removefile</command>.
|
|---|
| 884 | </para>
|
|---|
| 885 | <variablelist>
|
|---|
| 886 | <varlistentry>
|
|---|
| 887 | <term><option>--force</option></term>
|
|---|
| 888 | <listitem><para>
|
|---|
| 889 | Forces the operation and overrides any confirmation
|
|---|
| 890 | requests.
|
|---|
| 891 | </para><para>
|
|---|
| 892 | The short form of this option is <option>-f</option>.
|
|---|
| 893 | </para></listitem>
|
|---|
| 894 | </varlistentry>
|
|---|
| 895 | <varlistentry>
|
|---|
| 896 | <term><literal><replaceable>guest-file</replaceable> [<replaceable>guest-file</replaceable>...]</literal></term>
|
|---|
| 897 | <listitem><para>
|
|---|
| 898 | Specifies an absolute path of one or more file to remove
|
|---|
| 899 | from the guest VM. You can use wildcards to specify the
|
|---|
| 900 | file names. For example,
|
|---|
| 901 | <filename>D:\Foo\Bar\text*.txt</filename>.
|
|---|
| 902 | </para><para>
|
|---|
| 903 | You must have sufficient rights on the guest VM to remove
|
|---|
| 904 | the specified file.
|
|---|
| 905 | </para></listitem>
|
|---|
| 906 | </varlistentry>
|
|---|
| 907 | </variablelist>
|
|---|
| 908 | </refsect2>
|
|---|
| 909 | <refsect2 id="vboxmanage-guestcontrol-mv">
|
|---|
| 910 | <title>Rename a file or Directory on the guest</title>
|
|---|
| 911 | <remark role="help-copy-synopsis"/>
|
|---|
| 912 | <para>
|
|---|
| 913 | The <command>VBoxManage guestcontrol
|
|---|
| 914 | <replaceable>vmname</replaceable> mv</command> command enables
|
|---|
| 915 | you to rename files and directories on the guest VM.
|
|---|
| 916 | </para>
|
|---|
| 917 | <para>
|
|---|
| 918 | Alternate forms of this subcommand are <command>move</command>,
|
|---|
| 919 | <command>ren</command>, and <command>rename</command>.
|
|---|
| 920 | </para>
|
|---|
| 921 | <variablelist>
|
|---|
| 922 | <varlistentry>
|
|---|
| 923 | <term><literal><replaceable>guest-source</replaceable> [<replaceable>guest-source</replaceable>...]</literal></term>
|
|---|
| 924 | <listitem><para>
|
|---|
| 925 | Specifies an absolute path of a file or a single directory
|
|---|
| 926 | to move or rename on the guest VM. You can use wildcards
|
|---|
| 927 | to specify the file names.
|
|---|
| 928 | </para><para>
|
|---|
| 929 | You must have sufficient rights on the guest VM to access
|
|---|
| 930 | the specified file or directory.
|
|---|
| 931 | </para></listitem>
|
|---|
| 932 | </varlistentry>
|
|---|
| 933 | <varlistentry>
|
|---|
| 934 | <term><replaceable>dest</replaceable></term>
|
|---|
| 935 | <listitem><para>
|
|---|
| 936 | Specifies the absolute path of the renamed file or
|
|---|
| 937 | directory, or the destination directory to which to move
|
|---|
| 938 | the files. If you move only one file,
|
|---|
| 939 | <replaceable>dest</replaceable> can be a file or a
|
|---|
| 940 | directory, otherwise <replaceable>dest</replaceable> must
|
|---|
| 941 | be a directory.
|
|---|
| 942 | </para><para>
|
|---|
| 943 | You must have sufficient rights on the guest VM to access
|
|---|
| 944 | the destination file or directory.
|
|---|
| 945 | </para></listitem>
|
|---|
| 946 | </varlistentry>
|
|---|
| 947 | </variablelist>
|
|---|
| 948 | </refsect2>
|
|---|
| 949 | <refsect2 id="vboxmanage-guestcontrol-mktemp">
|
|---|
| 950 | <title>Create a Temporary File or Directory on the guest</title>
|
|---|
| 951 | <remark role="help-copy-synopsis"/>
|
|---|
| 952 | <para>
|
|---|
| 953 | The <command>VBoxManage guestcontrol
|
|---|
| 954 | <replaceable>vmname</replaceable> mktemp</command> command
|
|---|
| 955 | enables you to create a temporary file or temporary directory on
|
|---|
| 956 | the guest VM. You can use this command to assist with the
|
|---|
| 957 | subsequent copying of files from the host system to the guest
|
|---|
| 958 | VM. By default, this command creates the file or directory in
|
|---|
| 959 | the guest VM's platform-specific <filename>temp</filename>
|
|---|
| 960 | directory.
|
|---|
| 961 | </para>
|
|---|
| 962 | <para>
|
|---|
| 963 | Alternate forms of this subcommand are
|
|---|
| 964 | <command>createtemp</command> and
|
|---|
| 965 | <command>createtemporary</command>.
|
|---|
| 966 | </para>
|
|---|
| 967 | <variablelist>
|
|---|
| 968 | <varlistentry>
|
|---|
| 969 | <term><option>--directory</option></term>
|
|---|
| 970 | <listitem><para>
|
|---|
| 971 | Creates a temporary directory that is specified by the
|
|---|
| 972 | <replaceable>template</replaceable> operand.
|
|---|
| 973 | </para></listitem>
|
|---|
| 974 | </varlistentry>
|
|---|
| 975 | <varlistentry>
|
|---|
| 976 | <term><option>--secure</option></term>
|
|---|
| 977 | <listitem><para>
|
|---|
| 978 | Enforces secure file and directory creation by setting the
|
|---|
| 979 | permission mode to <literal>0755</literal>. Any operation
|
|---|
| 980 | that cannot be performed securely fails.
|
|---|
| 981 | </para></listitem>
|
|---|
| 982 | </varlistentry>
|
|---|
| 983 | <varlistentry>
|
|---|
| 984 | <term><option>--mode=<replaceable>mode</replaceable></option></term>
|
|---|
| 985 | <listitem><para>
|
|---|
| 986 | Specifies the permission mode to use for the specified
|
|---|
| 987 | directory. <replaceable>mode</replaceable> is a four-digit
|
|---|
| 988 | octal mode such as <literal>0755</literal>.
|
|---|
| 989 | </para></listitem>
|
|---|
| 990 | </varlistentry>
|
|---|
| 991 | <varlistentry>
|
|---|
| 992 | <term><option>--tmpdir=<replaceable>directory</replaceable></option></term>
|
|---|
| 993 | <listitem><para>
|
|---|
| 994 | Specifies the absolute path of the directory on the guest
|
|---|
| 995 | VM in which to create the specified file or directory. If
|
|---|
| 996 | unspecified, <replaceable>directory</replaceable> is the
|
|---|
| 997 | platform-specific <filename>temp</filename> directory.
|
|---|
| 998 | </para></listitem>
|
|---|
| 999 | </varlistentry>
|
|---|
| 1000 | <varlistentry>
|
|---|
| 1001 | <term><replaceable>template</replaceable></term>
|
|---|
| 1002 | <listitem><para>
|
|---|
| 1003 | Specifies a template file name for the temporary file,
|
|---|
| 1004 | without a directory path. The template file name must
|
|---|
| 1005 | contain at least one sequence of three consecutive X
|
|---|
| 1006 | characters, or must end in X.
|
|---|
| 1007 | </para></listitem>
|
|---|
| 1008 | </varlistentry>
|
|---|
| 1009 | </variablelist>
|
|---|
| 1010 | </refsect2>
|
|---|
| 1011 | <refsect2 id="vboxmanage-guestcontrol-stat">
|
|---|
| 1012 | <title>Show a file or File System Status on the guest</title>
|
|---|
| 1013 | <remark role="help-copy-synopsis"/>
|
|---|
| 1014 | <para>
|
|---|
| 1015 | The <command>VBoxManage guestcontrol
|
|---|
| 1016 | <replaceable>vmname</replaceable> stat</command> command enables
|
|---|
| 1017 | you to show the status of files or file systems on the guest VM.
|
|---|
| 1018 | </para>
|
|---|
| 1019 | <variablelist>
|
|---|
| 1020 | <varlistentry>
|
|---|
| 1021 | <term><literal><replaceable>file</replaceable> [<replaceable>file</replaceable> ...]</literal></term>
|
|---|
| 1022 | <listitem><para>
|
|---|
| 1023 | Specifies an absolute path of a file or file system on the
|
|---|
| 1024 | guest VM. For example,
|
|---|
| 1025 | <filename>/home/foo/a.out</filename>.
|
|---|
| 1026 | </para><para>
|
|---|
| 1027 | You must have sufficient rights on the guest VM to access
|
|---|
| 1028 | the specified files or file systems.
|
|---|
| 1029 | </para></listitem>
|
|---|
| 1030 | </varlistentry>
|
|---|
| 1031 | </variablelist>
|
|---|
| 1032 | </refsect2>
|
|---|
| 1033 | <refsect2 id="vboxmanage-guestcontrol-list">
|
|---|
| 1034 | <title>List the Configuration and Status Information for a Guest Virtual
|
|---|
| 1035 | Machine</title>
|
|---|
| 1036 | <remark role="help-copy-synopsis"/>
|
|---|
| 1037 | <para>
|
|---|
| 1038 | The <command>VBoxManage guestcontrol
|
|---|
| 1039 | <replaceable>vmname</replaceable> list</command> command enables
|
|---|
| 1040 | you to list guest control configuration and status information.
|
|---|
| 1041 | For example, the output shows open guest sessions, guest
|
|---|
| 1042 | processes, and files.
|
|---|
| 1043 | </para>
|
|---|
| 1044 | <variablelist>
|
|---|
| 1045 | <varlistentry>
|
|---|
| 1046 | <term><literal>all</literal>|<literal>sessions</literal>|<literal>processes</literal>|<literal>files</literal></term>
|
|---|
| 1047 | <listitem><para>
|
|---|
| 1048 | Indicates the type of information to show.
|
|---|
| 1049 | <literal>all</literal> shows all available data,
|
|---|
| 1050 | <literal>sessions</literal> shows guest sessions,
|
|---|
| 1051 | <literal>processes</literal> shows processes, and
|
|---|
| 1052 | <literal>files</literal> shows files.
|
|---|
| 1053 | </para></listitem>
|
|---|
| 1054 | </varlistentry>
|
|---|
| 1055 | </variablelist>
|
|---|
| 1056 | </refsect2>
|
|---|
| 1057 | <refsect2 id="vboxmanage-guestcontrol-closeprocess">
|
|---|
| 1058 | <title>Terminate a Process in a guest Session</title>
|
|---|
| 1059 | <remark role="help-copy-synopsis"/>
|
|---|
| 1060 | <para>
|
|---|
| 1061 | The <command>VBoxManage guestcontrol
|
|---|
| 1062 | <replaceable>vmname</replaceable> closeprocess</command> command
|
|---|
| 1063 | enables you to terminate a guest process that runs in a guest
|
|---|
| 1064 | session. Specify the process by using a process identifier (PID)
|
|---|
| 1065 | and the session by using the session ID or name.
|
|---|
| 1066 | </para>
|
|---|
| 1067 | <variablelist>
|
|---|
| 1068 | <varlistentry>
|
|---|
| 1069 | <term><option>--session-id=<replaceable>ID</replaceable></option></term>
|
|---|
| 1070 | <listitem><para>
|
|---|
| 1071 | Specifies the ID of the guest session.
|
|---|
| 1072 | </para></listitem>
|
|---|
| 1073 | </varlistentry>
|
|---|
| 1074 | <varlistentry>
|
|---|
| 1075 | <term><option>--session-name=<replaceable>name</replaceable>|<replaceable>pattern</replaceable></option></term>
|
|---|
| 1076 | <listitem><para>
|
|---|
| 1077 | Specifies the name of the guest session. Use a pattern
|
|---|
| 1078 | that contains wildcards to specify multiple sessions.
|
|---|
| 1079 | </para></listitem>
|
|---|
| 1080 | </varlistentry>
|
|---|
| 1081 | <varlistentry>
|
|---|
| 1082 | <term><literal><replaceable>PID</replaceable> [<replaceable>PID</replaceable> ...]</literal></term>
|
|---|
| 1083 | <listitem><para>
|
|---|
| 1084 | Specifies the list of PIDs of guest processes to
|
|---|
| 1085 | terminate.
|
|---|
| 1086 | </para></listitem>
|
|---|
| 1087 | </varlistentry>
|
|---|
| 1088 | </variablelist>
|
|---|
| 1089 | </refsect2>
|
|---|
| 1090 | <refsect2 id="vboxmanage-guestcontrol-closesession">
|
|---|
| 1091 | <title>Close a guest Session</title>
|
|---|
| 1092 | <remark role="help-copy-synopsis"/>
|
|---|
| 1093 | <para>
|
|---|
| 1094 | The <command>VBoxManage guestcontrol
|
|---|
| 1095 | <replaceable>vmname</replaceable> closesession</command> command
|
|---|
| 1096 | enables you to close a guest session. Specify the guest session
|
|---|
| 1097 | either by session ID or by name.
|
|---|
| 1098 | </para>
|
|---|
| 1099 | <variablelist>
|
|---|
| 1100 | <varlistentry>
|
|---|
| 1101 | <term><option>--session-id=<replaceable>ID</replaceable></option></term>
|
|---|
| 1102 | <listitem><para>
|
|---|
| 1103 | Specifies the ID of the guest session.
|
|---|
| 1104 | </para></listitem>
|
|---|
| 1105 | </varlistentry>
|
|---|
| 1106 | <varlistentry>
|
|---|
| 1107 | <term><option>--session-name=<replaceable>name</replaceable>|<replaceable>pattern</replaceable></option></term>
|
|---|
| 1108 | <listitem><para>
|
|---|
| 1109 | Specifies the name of the guest session. Use a pattern
|
|---|
| 1110 | that contains wildcards to specify multiple sessions.
|
|---|
| 1111 | </para></listitem>
|
|---|
| 1112 | </varlistentry>
|
|---|
| 1113 | <varlistentry>
|
|---|
| 1114 | <term><option>--all</option></term>
|
|---|
| 1115 | <listitem><para>
|
|---|
| 1116 | Closes all guest sessions.
|
|---|
| 1117 | </para></listitem>
|
|---|
| 1118 | </varlistentry>
|
|---|
| 1119 | </variablelist>
|
|---|
| 1120 | </refsect2>
|
|---|
| 1121 | <refsect2 id="vboxmanage-guestcontrol-updatega">
|
|---|
| 1122 | <title>Update the Guest Additions Software on the guest</title>
|
|---|
| 1123 | <remark role="help-copy-synopsis"/>
|
|---|
| 1124 | <para>
|
|---|
| 1125 | The <command>VBoxManage guestcontrol
|
|---|
| 1126 | <replaceable>vmname</replaceable> updatega</command> command
|
|---|
| 1127 | enables you to update the Guest Additions software installed in
|
|---|
| 1128 | the specified guest VM.
|
|---|
| 1129 | </para>
|
|---|
| 1130 | <para>
|
|---|
| 1131 | Alternate forms of this subcommand are
|
|---|
| 1132 | <command>updateadditions</command> and
|
|---|
| 1133 | <command>updateguestadditions</command>.
|
|---|
| 1134 | </para>
|
|---|
| 1135 | <variablelist>
|
|---|
| 1136 | <varlistentry>
|
|---|
| 1137 | <term><option>--source=<replaceable>new-iso-path</replaceable></option></term>
|
|---|
| 1138 | <listitem><para>
|
|---|
| 1139 | Specifies the absolute path of the Guest Additions update
|
|---|
| 1140 | <filename>.ISO</filename> file on the guest VM.
|
|---|
| 1141 | </para></listitem>
|
|---|
| 1142 | </varlistentry>
|
|---|
| 1143 | <varlistentry>
|
|---|
| 1144 | <term><option>--reboot</option></term>
|
|---|
| 1145 | <listitem><para>
|
|---|
| 1146 | Automatically reboots the guest after a successful Guest Additions
|
|---|
| 1147 | update.
|
|---|
| 1148 | </para></listitem>
|
|---|
| 1149 | </varlistentry>
|
|---|
| 1150 | <varlistentry>
|
|---|
| 1151 | <term><option>--timeout=<replaceable>ms</replaceable></option></term>
|
|---|
| 1152 | <listitem><para>
|
|---|
| 1153 | Sets the timeout (in ms) to wait for the overall Guest Additions update
|
|---|
| 1154 | to complete. By default no timeout is being used.
|
|---|
| 1155 | </para></listitem>
|
|---|
| 1156 | </varlistentry>
|
|---|
| 1157 | <varlistentry>
|
|---|
| 1158 | <term><option>--verify</option></term>
|
|---|
| 1159 | <listitem><para>
|
|---|
| 1160 | Verifies whether the Guest Additions were updated successfully after
|
|---|
| 1161 | a successful installation. A guest reboot is mandatory.
|
|---|
| 1162 | </para></listitem>
|
|---|
| 1163 | </varlistentry>
|
|---|
| 1164 | <varlistentry>
|
|---|
| 1165 | <term><option>--wait-ready</option></term>
|
|---|
| 1166 | <listitem><para>
|
|---|
| 1167 | Waits for the current Guest Additions being ready to handle the
|
|---|
| 1168 | Guest Additions update.
|
|---|
| 1169 | </para>
|
|---|
| 1170 | </listitem>
|
|---|
| 1171 | </varlistentry>
|
|---|
| 1172 | <varlistentry>
|
|---|
| 1173 | <term><option>--wait-start</option></term>
|
|---|
| 1174 | <listitem><para>
|
|---|
| 1175 | Starts the <command>VBoxManage</command> update process on
|
|---|
| 1176 | the guest VM and then waits for the Guest Additions update
|
|---|
| 1177 | to begin before terminating the
|
|---|
| 1178 | <command>VBoxManage</command> process.
|
|---|
| 1179 | </para><para>
|
|---|
| 1180 | By default, the <command>VBoxManage</command> command
|
|---|
| 1181 | waits for the Guest Additions update to complete before it
|
|---|
| 1182 | terminates. Use this option when a running
|
|---|
| 1183 | <command>VBoxManage</command> process affects the
|
|---|
| 1184 | interaction between the installer and the guest OS.
|
|---|
| 1185 | </para></listitem>
|
|---|
| 1186 | </varlistentry>
|
|---|
| 1187 | <varlistentry>
|
|---|
| 1188 | <term><option>-- <replaceable>argument</replaceable> [<replaceable>argument</replaceable> ...]</option></term>
|
|---|
| 1189 | <listitem><para>
|
|---|
| 1190 | Specifies optional command-line arguments to pass to the
|
|---|
| 1191 | Guest Additions updater. You might use the
|
|---|
| 1192 | <option>--</option> option to pass the appropriate updater
|
|---|
| 1193 | arguments to retrofit features that are not yet installed.
|
|---|
| 1194 | </para><para>
|
|---|
| 1195 | Ensure that any command argument that includes spaces is
|
|---|
| 1196 | enclosed by quotes.
|
|---|
| 1197 | </para></listitem>
|
|---|
| 1198 | </varlistentry>
|
|---|
| 1199 | </variablelist>
|
|---|
| 1200 | </refsect2>
|
|---|
| 1201 | <refsect2 id="vboxmanage-guestcontrol-waitrunlevel">
|
|---|
| 1202 | <title>Wait for a guest run level</title>
|
|---|
| 1203 | <para>
|
|---|
| 1204 | The <command>VBoxManage guestcontrol
|
|---|
| 1205 | <replaceable>vmname</replaceable> waitrunlevel</command> command
|
|---|
| 1206 | enables you to wait for a guest run level being reached.
|
|---|
| 1207 | </para>
|
|---|
| 1208 | <variablelist>
|
|---|
| 1209 | <varlistentry>
|
|---|
| 1210 | <term><option>--timeout=<replaceable>ms</replaceable></option></term>
|
|---|
| 1211 | <listitem><para>
|
|---|
| 1212 | Sets the timeout (in ms) to wait for reaching the run level.
|
|---|
| 1213 | By default no timeout is being used.
|
|---|
| 1214 | </para></listitem>
|
|---|
| 1215 | </varlistentry>
|
|---|
| 1216 | <varlistentry>
|
|---|
| 1217 | <term><option><replaceable>system</replaceable>|<replaceable>userland</replaceable>|<replaceable>desktop</replaceable></option></term>
|
|---|
| 1218 | <listitem><para>
|
|---|
| 1219 | Specifies the run level to wait for.
|
|---|
| 1220 | </para></listitem>
|
|---|
| 1221 | </varlistentry>
|
|---|
| 1222 | </variablelist>
|
|---|
| 1223 | </refsect2>
|
|---|
| 1224 | <refsect2 id="vboxmanage-guestcontrol-watch">
|
|---|
| 1225 | <title>Show Current Guest Control Activity</title>
|
|---|
| 1226 | <remark role="help-copy-synopsis"/>
|
|---|
| 1227 | <para>
|
|---|
| 1228 | The <command>VBoxManage guestcontrol
|
|---|
| 1229 | <replaceable>vmname</replaceable> watch</command> command
|
|---|
| 1230 | enables you to show current guest control activity.
|
|---|
| 1231 | </para>
|
|---|
| 1232 | </refsect2>
|
|---|
| 1233 | </refsect1>
|
|---|
| 1234 |
|
|---|
| 1235 | <refsect1>
|
|---|
| 1236 | <title>Examples</title>
|
|---|
| 1237 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 1238 | <para>
|
|---|
| 1239 | The following <command>VBoxManage guestcontrol run</command>
|
|---|
| 1240 | command executes the <command>ls -l /usr</command> command on the
|
|---|
| 1241 | <literal>My OL VM</literal> Oracle Linux VM as the
|
|---|
| 1242 | <literal>user1</literal> user.
|
|---|
| 1243 | </para>
|
|---|
| 1244 | <screen>
|
|---|
| 1245 | $ VBoxManage --nologo guestcontrol "My OL VM" run --exe "/bin/ls" \
|
|---|
| 1246 | --username user1 --passwordfile pw.txt --wait-stdout -- -l /usr
|
|---|
| 1247 | </screen>
|
|---|
| 1248 | <para>
|
|---|
| 1249 | The <option>--exe</option> option specifies the absolute path of
|
|---|
| 1250 | the command to run in the guest VM, <filename>/bin/ls</filename>.
|
|---|
| 1251 | Use the <option>--</option> option to pass any arguments that
|
|---|
| 1252 | follow it to the <command>ls</command> command.
|
|---|
| 1253 | </para>
|
|---|
| 1254 | <para>
|
|---|
| 1255 | Use the <option>--username</option> option to specify the user
|
|---|
| 1256 | name, <literal>user1</literal> and use the
|
|---|
| 1257 | <option>--passwordfile</option> option to specify the name of a
|
|---|
| 1258 | file that includes the password for the <literal>user1</literal>
|
|---|
| 1259 | user, <filename>pw.txt</filename>.
|
|---|
| 1260 | </para>
|
|---|
| 1261 | <para>
|
|---|
| 1262 | The <option>--wait-stdout</option> option waits for the
|
|---|
| 1263 | <command>ls</command> guest process to complete before providing
|
|---|
| 1264 | the exit code and the command output. The
|
|---|
| 1265 | <option>--nologo</option> option suppresses the output of the logo
|
|---|
| 1266 | information.
|
|---|
| 1267 | </para>
|
|---|
| 1268 | <para>
|
|---|
| 1269 | The following <command>VBoxManage guestcontrol run</command>
|
|---|
| 1270 | command executes the <command>ipconfig</command> command on the
|
|---|
| 1271 | <literal>My Win VM</literal> Windows VM as the
|
|---|
| 1272 | <literal>user1</literal> user. Standard input, standard output,
|
|---|
| 1273 | and standard error are redirected from the VM to the host system
|
|---|
| 1274 | until the program completes.
|
|---|
| 1275 | </para>
|
|---|
| 1276 | <screen>
|
|---|
| 1277 | $ VBoxManage --nologo guestcontrol "My Win VM" run \
|
|---|
| 1278 | --exe "c:\\windows\\system32\\ipconfig.exe" \
|
|---|
| 1279 | --username user1 --passwordfile pw.txt --wait-stdout
|
|---|
| 1280 | </screen>
|
|---|
| 1281 | <para>
|
|---|
| 1282 | The <option>--exe</option> specifies the absolute path of command
|
|---|
| 1283 | to run in the guest VM,
|
|---|
| 1284 | <filename>c:\windows\system32\ipconfig.exe</filename>. The double
|
|---|
| 1285 | backslashes shown in this example are required only on UNIX host
|
|---|
| 1286 | systems.
|
|---|
| 1287 | </para>
|
|---|
| 1288 | <para>
|
|---|
| 1289 | Use the <option>--username</option> option to specify the user
|
|---|
| 1290 | name, <literal>user1</literal> and use the
|
|---|
| 1291 | <option>--passwordfile</option> option to specify the name of a
|
|---|
| 1292 | file that includes the password for the <literal>user1</literal>
|
|---|
| 1293 | user, <filename>pw.txt</filename>.
|
|---|
| 1294 | </para>
|
|---|
| 1295 | <para>
|
|---|
| 1296 | The <option>--wait-stdout</option> option waits for the
|
|---|
| 1297 | <command>ls</command> guest process to complete before providing
|
|---|
| 1298 | the exit code and the command output. The
|
|---|
| 1299 | <option>--nologo</option> option to suppress the output of the
|
|---|
| 1300 | logo information.
|
|---|
| 1301 | </para>
|
|---|
| 1302 | <para>
|
|---|
| 1303 | The following <command>VBoxManage guestcontrol start</command>
|
|---|
| 1304 | command executes the <command>ls -l /usr</command> command on the
|
|---|
| 1305 | <literal>My OL VM</literal> Oracle Linux VM until the program
|
|---|
| 1306 | completes.
|
|---|
| 1307 | </para>
|
|---|
| 1308 | <screen>
|
|---|
| 1309 | $ VBoxManage --nologo guestcontrol "My Win VM" start \
|
|---|
| 1310 | --exe "c:\\windows\\system32\\ipconfig.exe" \
|
|---|
| 1311 | --username user1 --passwordfile pw.txt
|
|---|
| 1312 | </screen>
|
|---|
| 1313 | </refsect1>
|
|---|
| 1314 | </refentry>
|
|---|
