Changeset 62199 in vbox for trunk/doc/manual
- Timestamp:
- Jul 12, 2016 1:51:37 PM (8 years ago)
- File:
-
- 1 edited
-
trunk/doc/manual/en_US/user_VBoxManage.xml (modified) (15 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/doc/manual/en_US/user_VBoxManage.xml
r61702 r62199 3139 3139 <title>VBoxManage guestcontrol</title> 3140 3140 3141 <para>The <computeroutput>guestcontrol</computeroutput> commands allow you3142 to control certain things inside aguest from the host. Please see <xref3141 <para>The <computeroutput>guestcontrol</computeroutput> commands enable 3142 control of the guest from the host. Please see <xref 3143 3143 linkend="guestadd-guestcontrol" /> for an introduction.</para> 3144 3144 3145 <para>There are two sets of subcommands here. The first set requires guest 3146 credentials to be specified, the second set does not.</para> 3147 3148 <para>The first set of subcommands are on the following form:</para> 3149 3145 <para>guestcontrol has two sets of subcommands. The first set requires guest 3146 credentials to be specified, the second does not.</para> 3147 3148 <para>The first set of subcommands are of the form:</para> 3150 3149 <screen>VBoxManage guestcontrol <uuid|vmname> <sub-command> 3151 [-v|--verbose] [-q|quiet] [--username <name>] [--domain <domain> ] 3152 [--passwordfile <file> | --password <password>] ... 3153 </screen> 3154 3155 <para>and the second set are on the following form:</para> 3156 3157 <screen>VBoxManage guestcontrol <uuid|vmname> <sub-command> 3150 [--username <name> ] 3151 [--passwordfile <file> | --password <password>] 3152 [--domain <domain> ] 3158 3153 [-v|--verbose] [-q|quiet] ... 3159 3154 </screen> 3160 3155 3161 <para>where the common parameters are: 3156 <para>The "common-options" are:</para> 3157 <screen> 3158 [--username <name> ] 3159 [--passwordfile <file> | --password <password>] 3160 [--domain <domain> ] 3161 [-v|--verbose] [-q|quiet] 3162 </screen> 3163 3164 <para>Where details of the common options for the first set of subcommands are: 3162 3165 <glosslist> 3163 <glossentry> 3164 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3165 <glossdef><para>The VM UUID or VM name. Mandatory.</para></glossdef> 3166 </glossentry> 3166 3167 <glossentry> 3168 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3169 <glossdef> 3170 <para>The VM UUID or VM name. Mandatory.</para> 3171 </glossdef> 3172 </glossentry> 3173 3167 3174 <glossentry> 3168 3175 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3169 <glossdef><para>Name of the user the process should run under. This 3170 user must exist on the guest OS. If not specified the host user 3171 name is used.</para> 3172 </glossdef> 3173 </glossentry> 3176 <glossdef><para>Specifies the user name on guest OS under which the process should run. This 3177 user name must already exist on the guest OS. If unspecified, the host user name is used. Optional</para> 3178 </glossdef> 3179 </glossentry> 3180 3181 <glossentry> 3182 <glossterm><computeroutput>--passwordfile <file>|--password</computeroutput></glossterm> 3183 <glossdef><para>Specifies the absolute path on guest file system of password file containing the 3184 password for the specified user account or password for the specified user account. Optional. 3185 If both are omitted, empty password is assumed.</para></glossdef> 3186 </glossentry> 3187 3174 3188 <glossentry> 3175 3189 <glossterm><computeroutput>--domain <domain></computeroutput></glossterm> 3176 <glossdef><para>User domain for windows guests, optional.</para></glossdef> 3177 </glossentry> 3178 <glossentry> 3179 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3180 <glossdef><para>Password of the specified user account to be read from 3181 the given file. If not given, an empty password is assumed.</para></glossdef> 3182 </glossentry> 3183 <glossentry> 3184 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3185 <glossdef><para>Password of the specified user account. If not given, 3186 an empty password is assumed.</para></glossdef> 3187 </glossentry> 3190 <glossdef><para>User domain for Windows guests. Optional.</para></glossdef> 3191 </glossentry> 3192 3188 3193 <glossentry> 3189 3194 <glossterm><computeroutput>-v|--verbose</computeroutput></glossterm> 3190 <glossdef><para>Makes the sub-command execution more noisy.</para></glossdef> 3191 </glossentry> 3195 <glossdef><para>Makes the subcommand execution more verbose. Optional</para></glossdef> 3196 </glossentry> 3197 3192 3198 <glossentry> 3193 3199 <glossterm><computeroutput>-q|--quiet</computeroutput></glossterm> 3194 <glossdef><para>Makes the sub -command execution more quiet.</para></glossdef>3200 <glossdef><para>Makes the subcommand execution quieter. Optional.</para></glossdef> 3195 3201 </glossentry> 3196 3202 </glosslist> 3197 3203 </para> 3198 3204 3199 <para>The first set of subcommands:<itemizedlist> 3200 <listitem> 3201 <para><emphasis role="bold"><computeroutput>run</computeroutput></emphasis>, 3202 allows you to execute a guest program waiting for it to complete and 3203 forwarding stdout, stderr and stdin to/from the host.</para> 3204 3205 <para>The first set of subcommands: <itemizedlist> 3206 <listitem> 3207 <para><emphasis role="bold"><computeroutput>run</computeroutput></emphasis> 3208 Executes a guest program - forwarding stdout, stderr and stdin to/from the host 3209 until it completes.</para> 3205 3210 <screen>VBoxManage guestcontrol <uuid|vmname> run [common-options] 3206 [--exe <path to executable>][--timeout <msec>]3207 3208 [--ignore-operhaned-processes] [--no-profile]3209 3210 3211 3211 --exe <path to executable> [--timeout <msec>] 3212 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 3213 [--ignore-operhaned-processes] [--profile] 3214 [--no-wait-stdout|--wait-stdout] 3215 [--no-wait-stderr|--wait-stderr] 3216 [--dos2unix] [--unix2dos] 3212 3217 -- <program/arg0> [argument1] ... [argumentN]] 3213 3218 </screen> 3214 3215 <para>where the options are: <glosslist> 3216 <glossentry> 3217 <glossterm><computeroutput>--exe "<path to program>"</computeroutput></glossterm> 3218 <glossdef><para>Guest path to the guest executable that should be executed. 3219 in the guest, e.g. 3220 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 3221 </glossdef> 3222 </glossentry> 3223 3224 <glossentry> 3225 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3226 3227 <glossdef> 3228 <para>Name of the user the process should run under. This 3229 user must exist on the guest OS.</para> 3230 </glossdef> 3231 </glossentry> 3232 3233 <glossentry> 3234 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3235 3236 <glossdef> 3237 <para>Password of the user account specified to be read from 3238 the given file. If not given, an empty password is 3239 assumed.</para> 3240 </glossdef> 3241 </glossentry> 3242 3243 <glossentry> 3244 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3245 3246 <glossdef> 3247 <para>Password of the user account specified with 3248 <computeroutput>--username</computeroutput>. If not given, 3249 an empty password is assumed.</para> 3219 <glosslist> 3220 <glossentry> 3221 <glossterm><computeroutput>--exe "<path to executable>"</computeroutput></glossterm> 3222 <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.: 3223 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>.</para> 3224 </glossdef> 3225 </glossentry> 3226 3227 <glossentry> 3228 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3229 <glossdef> 3230 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3231 </glossdef> 3232 </glossentry> 3233 3234 <glossentry> 3235 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 3236 <glossdef> 3237 <para>Specifies the maximum time (microseconds) that the executable can run, 3238 during which VBoxManage receives its output. Optional. 3239 If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para> 3240 </glossdef> 3241 </glossentry> 3242 3243 <glossentry> 3244 <glossterm><computeroutput>-E|--putenv "<NAME>=<VALUE>" 3245 </computeroutput></glossterm> 3246 <glossdef> 3247 <para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para> 3248 <para>The guest process is created with the standard default guest OS environment. 3249 Use this option to modify that default environment. To set/modify a variable use: 3250 <computeroutput><NAME>=<VALUE></computeroutput>. 3251 To unset a variable use: 3252 <computeroutput><NAME>=</computeroutput></para> 3253 <para>Any spaces in names/values should be enclosed by quotes. </para> 3254 <para>To set/modify/unset multiple variables, use multiple instances of the 3255 <computeroutput>--E|--putenv</computeroutput> option. </para> 3256 </glossdef> 3257 </glossentry> 3258 3259 <glossentry> 3260 <glossterm><computeroutput>--unquoted-args</computeroutput></glossterm> 3261 <glossdef> 3262 <para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para> 3263 </glossdef> 3264 </glossentry> 3265 3266 <glossentry> 3267 <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm> 3268 <glossdef> 3269 <para>Ignore orphaned processes. Not yet implemented. Optional.</para> 3270 </glossdef> 3271 </glossentry> 3272 3273 <glossentry> 3274 <glossterm><computeroutput>--profile</computeroutput></glossterm> 3275 <glossdef> 3276 <para>Use Profile. Not yet implemented. Optional.</para> 3277 </glossdef> 3278 </glossentry> 3279 3280 <glossentry> 3281 <glossterm><computeroutput>--no-wait-stdout|--wait-stdout</computeroutput></glossterm> 3282 <glossdef> 3283 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 3284 In the case of --wait-stdout - while the process runs, VBoxManage receives its stdout. Optional.</para> 3285 </glossdef> 3286 </glossentry> 3287 3288 <glossentry> 3289 <glossterm><computeroutput>>--no-wait-stderr|--wait-stderr</computeroutput></glossterm> 3290 <glossdef> 3291 <para>Does not wait/waits until the guest process ends and receives its exit code and reason/flags. 3292 In case of --wait-stderr - while the process runs, VBoxManage receives its stderr. Optional.</para> 3250 3293 </glossdef> 3251 3294 </glossentry> … … 3253 3296 <glossentry> 3254 3297 <glossterm><computeroutput>--dos2unix</computeroutput></glossterm> 3255 3256 3298 <glossdef><para> 3257 Converts output from DOS/Windows guests to UNIX-compatible 3258 line endings (CR + LF → LF). Not implemented yet.</para> 3259 </glossdef> 3260 </glossentry> 3261 3262 <glossentry> 3263 <glossterm><computeroutput>--environment 3264 "<NAME>=<VALUE>"</computeroutput></glossterm> 3265 3266 <glossdef> 3267 <para>One or more environment variables to be set or 3268 unset.</para> 3269 3270 <para>By default, the new process in the guest will be 3271 created with the standard environment of the guest OS. This 3272 option allows for modifying that environment. To set/modify 3273 a variable, a pair of 3274 <computeroutput>NAME=VALUE</computeroutput> must be 3275 specified; to unset a certain variable, the name with no 3276 value must set, e.g. 3277 <computeroutput>NAME=</computeroutput>.</para> 3278 3279 <para>Arguments containing spaces must be enclosed in 3280 quotation marks. More than one 3281 <computeroutput>--environment</computeroutput> at a time can 3282 be specified to keep the command line tidy.</para> 3283 </glossdef> 3284 </glossentry> 3285 3286 <glossentry> 3287 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 3288 3289 <glossdef> 3290 <para>Value (in milliseconds) that specifies the time how 3291 long the started process is allowed to run and how long 3292 VBoxManage waits for getting output from that process. If no 3293 timeout is specified, VBoxManage will wait forever until the 3294 started process ends or an error occured.</para> 3299 Converts output from DOS/Windows guests to UNIX/Linux-compatible line endings 3300 (CR + LF → LF). Not yet implemented. Optional.</para> 3295 3301 </glossdef> 3296 3302 </glossentry> … … 3298 3304 <glossentry> 3299 3305 <glossterm><computeroutput>--unix2dos</computeroutput></glossterm> 3300 3301 3306 <glossdef><para> 3302 Converts output from a UNIX/Linux guests to DOS-/Windows-compatible 3303 line endings (LF → CR + LF). Not implemented yet.</para></glossdef> 3304 </glossentry> 3305 3306 <glossentry> 3307 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3308 3309 <glossdef> 3310 <para>Tells VBoxManage to be more verbose.</para> 3311 </glossdef> 3312 </glossentry> 3313 3314 <glossentry> 3315 <glossterm><computeroutput>--wait-exit</computeroutput></glossterm> 3316 3317 <glossdef> 3318 <para>Waits until the process ends and outputs its 3319 exit code along with the exit reason/flags.</para> 3320 </glossdef> 3321 </glossentry> 3322 3323 <glossentry> 3324 <glossterm><computeroutput>--wait-stdout</computeroutput></glossterm> 3325 3326 <glossdef> 3327 <para>Waits until the process ends and outputs its 3328 exit code along with the exit reason/flags. While waiting 3329 VBoxManage retrieves the process output collected from stdout.</para> 3330 </glossdef> 3331 </glossentry> 3332 3333 <glossentry> 3334 <glossterm><computeroutput>--wait-stderr</computeroutput></glossterm> 3335 3336 <glossdef> 3337 <para>Waits until the process ends and outputs its 3338 exit code along with the exit reason/flags. While waiting 3339 VBoxManage retrieves the process output collected from stderr.</para> 3340 </glossdef> 3341 </glossentry> 3342 3343 <glossentry> 3344 <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm> 3345 3346 <glossdef> 3347 <para>One or more arguments to pass to the process being 3348 executed.</para> 3349 <para>Arguments containing spaces must be enclosed in 3350 quotation marks.</para> 3351 </glossdef> 3352 </glossentry> 3353 3354 </glosslist></para> 3307 Converts output from a UNIX/Linux guests to DOS/Windows-compatible 3308 line endings (LF → CR + LF). Not yet implemented. Optional.</para> 3309 </glossdef> 3310 </glossentry> 3311 3312 <glossentry> 3313 <glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm> 3314 <glossdef> 3315 <para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para> 3316 <para>Note: Any spaces in arguments should be enclosed by quotes.</para> 3317 </glossdef> 3318 </glossentry> 3319 </glosslist> 3355 3320 3356 3321 <para><note> … … 3390 3355 3391 3356 <listitem> 3357 <para><emphasis role="bold"><computeroutput>start</computeroutput></emphasis>, 3358 Executes a guest program until it completes.</para> 3359 <screen>VBoxManage guestcontrol <uuid|vmname> start [common-options] 3360 [--exe <path to executable>] [--timeout <msec>] 3361 [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] 3362 [--ignore-operhaned-processes] [--profile] 3363 -- <program/arg0> [argument1] ... [argumentN]] 3364 </screen> 3365 3366 <para>Where the options are: <glosslist> 3367 <glossentry> 3368 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3369 <glossdef> 3370 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3371 </glossdef> 3372 </glossentry> 3373 3374 <glossentry> 3375 <glossterm><computeroutput>--exe "<path to executable>"</computeroutput></glossterm> 3376 <glossdef><para>Specifies the absolute path of the executable on the guest OS file system. Mandatory. e.g.: 3377 <computeroutput>C:\Windows\System32\calc.exe</computeroutput></para> 3378 </glossdef> 3379 </glossentry> 3380 3381 <glossentry> 3382 <glossterm><computeroutput>--timeout <msec></computeroutput></glossterm> 3383 <glossdef> 3384 <para>Specifies the maximum time (microseconds) that the executable can run. Optional. 3385 If unspecified, VBoxManage waits indefinitely for the process to end, or an error occurs.</para> 3386 </glossdef> 3387 </glossentry> 3388 3389 <glossentry> 3390 <glossterm><computeroutput>-E|--putenv "<NAME>=<VALUE>" 3391 </computeroutput></glossterm> 3392 <glossdef> 3393 <para>Sets/modifies/unsets environment variable(s) in the environment in which the program will run. Optional.</para> 3394 <para>The guest process is created with the standard default guest OS environment. 3395 Use this option to modify that default environment. To set/modify a variable use: 3396 <computeroutput><NAME>=<VALUE></computeroutput>. 3397 To unset a variable use: 3398 <computeroutput><NAME>=</computeroutput></para> 3399 <para>Any spaces in names/values should be enclosed by quotes. </para> 3400 <para>To set/modify/unset multiple variables, use multiple instances of the 3401 <computeroutput>--E|--putenv</computeroutput> option. </para> 3402 </glossdef> 3403 </glossentry> 3404 3405 <glossentry> 3406 <glossterm><computeroutput>--unquoted-args</computeroutput></glossterm> 3407 <glossdef> 3408 <para>Disables escaped double quoting (e.g. \"fred\") on arguments passed to the executed program. Optional.</para> 3409 </glossdef> 3410 </glossentry> 3411 3412 <glossentry> 3413 <glossterm><computeroutput>--ignore-operhaned-processes</computeroutput></glossterm> 3414 <glossdef> 3415 <para>Ignores orphaned processes. Not implemented yet. Optional.</para> 3416 </glossdef> 3417 </glossentry> 3418 3419 <glossentry> 3420 <glossterm><computeroutput>--profile</computeroutput></glossterm> 3421 <glossdef> 3422 <para>Use a profile. Not implemented yet. Optional.</para> 3423 </glossdef> 3424 </glossentry> 3425 3426 <glossentry> 3427 <glossterm><computeroutput>[-- <program/arg0> [<argument1>] ... [<argumentN>]]</computeroutput></glossterm> 3428 <glossdef> 3429 <para>Specifies program name, followed by one or more arguments to pass to the program. Optional.</para> 3430 <para>Note: Any spaces in arguments should be enclosed by quotes.</para> 3431 </glossdef> 3432 </glossentry> 3433 </glosslist></para> 3434 3435 <para><note> 3436 <para>On Windows there are certain limitations for graphical 3437 applications; please see <xref linkend="KnownIssues" /> for more 3438 information.</para> 3439 </note> Examples: <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "/bin/ls" 3440 --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr</screen> <screen>VBoxManage --nologo guestcontrol "My VM" execute --image "c:\\windows\\system32\\ipconfig.exe" 3441 --username foo --passwordfile bar.txt --wait-exit --wait-stdout</screen> Note that 3442 the double backslashes in the second example are only required on 3443 Unix hosts.</para> 3444 3445 <para><note> 3446 <para>For certain commands a user name of an existing user account on the guest 3447 must be specified; anonymous executions are not supported for security reasons. A 3448 user account password, however, is optional and depends on the guest's OS security 3449 policy or rules. If no password is specified for a given user name, an empty password 3450 will be used. On certain OSes like Windows the security policy may needs to be adjusted 3451 in order to allow user accounts with an empty password set. Also, global domain rules might 3452 apply and therefore cannot be changed.</para> 3453 </note></para> 3454 3455 <para>Starting at VirtualBox 4.1.2 guest process execution by default is limited 3456 to serve up to 5 guest processes at a time. If a new guest process gets started 3457 which would exceed this limit, the oldest not running guest process will be discarded 3458 in order to be able to run that new process. Also, retrieving output from this 3459 old guest process will not be possible anymore then. If all 5 guest processes 3460 are still active and running, starting a new guest process will result in an 3461 appropriate error message.</para> 3462 3463 <para>To raise or lower the guest process execution limit, either the guest 3464 property <computeroutput>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</computeroutput> 3465 or VBoxService' command line by specifying <computeroutput>--control-procs-max-kept</computeroutput> 3466 needs to be modified. A restart of the guest OS is required afterwards. To serve unlimited 3467 guest processes, a value of <computeroutput>0</computeroutput> needs to be set (not recommended).</para> 3468 </listitem> 3469 3470 <listitem> 3471 <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis> 3472 This command enables copying of files from the guest to the host file system. 3473 (Note - only with Guest Additions 4.0 or later installed).</para> 3474 3475 <screen>VBoxManage guestcontrol <uuid|vmname> copyfrom [common-options] 3476 --target-directory <host-dst-dir> 3477 [--dryrun] [--follow] [--R|recursive] 3478 <guest-src0> [<guest-src1> [...]] </screen> 3479 3480 <para>Where the parameters are:<glosslist> 3481 <glossentry> 3482 <glossterm><computeroutput><uid|vmname></computeroutput></glossterm> 3483 <glossdef> 3484 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3485 </glossdef> 3486 </glossentry> 3487 3488 <glossentry> 3489 <glossterm><computeroutput>--target-directory <host-dst-dir></computeroutput></glossterm> 3490 <glossdef> 3491 <para>Specifies the absolute path of the host file system destination directory. Mandatory. e.g. 3492 <computeroutput>C:\Temp</computeroutput>.</para> 3493 </glossdef> 3494 </glossentry> 3495 3496 <glossentry> 3497 <glossterm><computeroutput>--dryrun</computeroutput></glossterm> 3498 <glossdef> 3499 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 3500 operation. Optional. </para> 3501 </glossdef> 3502 </glossentry> 3503 3504 <glossentry> 3505 <glossterm><computeroutput>--follow</computeroutput></glossterm> 3506 <glossdef> 3507 <para>Enables symlink following on the guest file system. Optional.</para> 3508 </glossdef> 3509 </glossentry> 3510 3511 <glossentry> 3512 <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm> 3513 <glossdef> 3514 <para>Enables recursive copying of files/directories from the specified guest file system 3515 directory. Optional.</para> 3516 </glossdef> 3517 </glossentry> 3518 3519 <glossentry> 3520 <glossterm><computeroutput><guest-src0> [<guest-src1> [...]]</computeroutput></glossterm> 3521 <glossdef> 3522 <para>Specifies the absolute path(s) of guest file system file(s) to be copied. Mandatory. e.g. 3523 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. 3524 Wildcards can be used in the expression(s), e.g. 3525 <computeroutput>C:\Windows\System*\*.dll</computeroutput>.</para> 3526 </glossdef> 3527 </glossentry> 3528 </glosslist> 3529 </para> 3530 </listitem> 3531 3532 <listitem> 3392 3533 <para><emphasis role="bold"><computeroutput>copyto</computeroutput></emphasis>, 3393 which allows copying 3394 files from the host to the guest (only with installed Guest 3395 Additions 4.0 and later).</para> 3396 3397 <screen>VBoxManage guestcontrol <uuid|vmname> copyto|cp 3398 <guest source> <host dest> --username <name> 3399 [--passwordfile <file> | --password <password>] 3400 [--dryrun] [--follow] [--recursive] [--verbose]</screen> 3401 3402 <para>where the parameters mean: <glosslist> 3403 <glossentry> 3404 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3405 3406 <glossdef> 3407 <para>The VM UUID or VM name. Mandatory.</para> 3408 </glossdef> 3409 </glossentry> 3410 3411 <glossentry> 3412 <glossterm><computeroutput>source on host</computeroutput></glossterm> 3413 3414 <glossdef> 3415 <para>Absolute path of source file(s) on host to copy over 3416 to the guest, e.g. 3534 Copies from the host to a guest file system. 3535 (Note - only with Guest Additions 4.0 or later installed).</para> 3536 3537 <screen>VBoxManage guestcontrol <uuid|vmname> copyto [common-options] 3538 --target-directory <guest-dst> 3539 [--dryrun] [--follow] [--R|recursive] 3540 <host-src0> [<host-src1> [...]] </screen> 3541 3542 <para>Where the parameters are:<glosslist> 3543 <glossentry> 3544 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3545 <glossdef> 3546 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3547 </glossdef> 3548 </glossentry> 3549 3550 <glossentry> 3551 <glossterm><computeroutput>--target-directory <guest-dst></computeroutput></glossterm> 3552 <glossdef> 3553 <para>Specifies the absolute path of the guest file system destination directory. Mandatory. e.g. 3554 <computeroutput>C:\Temp</computeroutput>.</para> 3555 </glossdef> 3556 </glossentry> 3557 3558 <glossentry> 3559 <glossterm><computeroutput>--dryrun</computeroutput></glossterm> 3560 <glossdef> 3561 <para>Instructs VBoxManage to perform a dry run instead of an actual file copying 3562 operation. Optional. </para> 3563 </glossdef> 3564 </glossentry> 3565 3566 <glossentry> 3567 <glossterm><computeroutput>--follow</computeroutput></glossterm> 3568 <glossdef> 3569 <para>Enables symlink following on the host file system. Optional.</para> 3570 </glossdef> 3571 </glossentry> 3572 3573 <glossentry> 3574 <glossterm><computeroutput>-R|--recursive</computeroutput></glossterm> 3575 <glossdef> 3576 <para>Enables recursive copying of files/directories from the specified host file system 3577 directory(ies). Optional.</para> 3578 </glossdef> 3579 </glossentry> 3580 3581 <glossentry> 3582 <glossterm><computeroutput><host-src0> [<host-src1> [...]]</computeroutput></glossterm> 3583 <glossdef> 3584 <para>Specifies the absolute path(s) of host file system file(s) to be copied. Mandatory. e.g. 3417 3585 <computeroutput>C:\Windows\System32\calc.exe</computeroutput>. 3418 This also can be a wildcard expression, e.g. 3419 <computeroutput>C:\Windows\System32\*.dll</computeroutput></para> 3420 </glossdef> 3421 </glossentry> 3422 3423 <glossentry> 3424 <glossterm><computeroutput>destination on guest</computeroutput></glossterm> 3425 3426 <glossdef> 3427 <para>Absolute destination path on the guest, e.g. 3428 <computeroutput>C:\Temp</computeroutput></para> 3429 </glossdef> 3430 </glossentry> 3431 3432 <glossentry> 3433 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3434 3435 <glossdef> 3436 <para>Name of the user the copy process should run under. 3437 This user must exist on the guest OS.</para> 3438 </glossdef> 3439 </glossentry> 3440 3441 <glossentry> 3442 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3443 3444 <glossdef> 3445 <para>Password of the user account specified to be read from 3446 the given file. If not given, an empty password is 3447 assumed.</para> 3448 </glossdef> 3449 </glossentry> 3450 3451 <glossentry> 3452 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3453 3454 <glossdef> 3455 <para>Password of the user account specified with 3456 <computeroutput>--username</computeroutput>. If not given, 3457 an empty password is assumed.</para> 3458 </glossdef> 3459 </glossentry> 3460 3461 <glossentry> 3462 <glossterm><computeroutput>--dryrun</computeroutput></glossterm> 3463 3464 <glossdef> 3465 <para>Tells VBoxManage to only perform a dry run instead of 3466 really copying files to the guest.</para> 3467 </glossdef> 3468 </glossentry> 3469 3470 <glossentry> 3471 <glossterm><computeroutput>--follow</computeroutput></glossterm> 3472 3473 <glossdef> 3474 <para>Enables following symlinks on the host's 3475 source.</para> 3586 Wildcards can be used in the expression(s), e.g. 3587 <computeroutput>C:\Windows\System*\*.dll</computeroutput>.</para> 3588 </glossdef> 3589 </glossentry> 3590 </glosslist> 3591 </para> 3592 </listitem> 3593 3594 <listitem> 3595 <para><emphasis role="bold"><computeroutput>md|mkdir|createdir|createdirectory</computeroutput></emphasis>, 3596 Creates one or more directory(ies) on the guest file system. 3597 (Note - only with Guest Additions 4.0 or later installed).</para> 3598 3599 <screen>VBoxManage guestcontrol <uuid|vmname> md|mkdir|createdir|createdirectory 3600 [common-options ] 3601 [--parents] [--mode <mode>] 3602 <guest directory> [...] </screen> 3603 3604 <para>Where the parameters are: <glosslist> 3605 <glossentry> 3606 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3607 <glossdef> 3608 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3609 </glossdef> 3610 </glossentry> 3611 <glossentry> 3612 <glossterm><computeroutput>--parents</computeroutput></glossterm> 3613 <glossdef> 3614 <para>Creates any absent parent directory(ies) of the specified directory. Optional.</para> 3615 <para>e.g. If specified directory is <computeroutput>D:\Foo\Bar</computeroutput> 3616 and <computeroutput>D:\Foo</computeroutput> is absent, it will 3617 be created. In such a case, had the <computeroutput>--parents</computeroutput> 3618 option not been used, this command would have failed.</para> 3619 </glossdef> 3620 </glossentry> 3621 3622 <glossentry> 3623 <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> 3624 <glossdef> 3625 <para>Specifies the permission mode on the specified directory(ies) (and any parents, 3626 where <computeroutput>--parents</computeroutput> option used). 3627 Currently octal modes (e.g. <computeroutput>0755</computeroutput>) only are 3628 supported.</para> 3629 </glossdef> 3630 </glossentry> 3631 3632 <glossentry> 3633 <glossterm><computeroutput><guest directory>... </computeroutput></glossterm> 3634 <glossdef> 3635 <para>Specifies list of absolute paths of directory(ies) to be created on 3636 guest file system. Mandatory. 3637 e.g. <computeroutput>D:\Foo\Bar</computeroutput> </para> 3638 <para>All parent directories must already exist 3639 unless switch <computeroutput>--parents</computeroutput> used. 3640 (e.g. in the above example <computeroutput>D:\Foo</computeroutput>). 3641 The specified user must have sufficient rights to create the 3642 specified directory(ies), and any parents that need 3643 to be created.</para> 3644 </glossdef> 3645 </glossentry> 3646 </glosslist> 3647 </para> 3648 </listitem> 3649 3650 <listitem> 3651 <para><emphasis role="bold"><computeroutput>rmdir|removedir|removedirectory</computeroutput></emphasis> 3652 Deletes specified guest file system directories. (Only with installed Guest Additions 4.3.2 and later).</para> 3653 3654 <screen>VBoxManage guestcontrol <uuid|vmname> removedirectory|removedir|rmdir [common-options] 3655 [--recursive|-R] 3656 <guest directory>... 3657 </screen> 3658 3659 <para>Where the parameters are: <glosslist> 3660 <glossentry> 3661 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3662 <glossdef> 3663 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3476 3664 </glossdef> 3477 3665 </glossentry> … … 3479 3667 <glossentry> 3480 3668 <glossterm><computeroutput>--recursive</computeroutput></glossterm> 3481 3482 <glossdef> 3483 <para>Recursively copies files/directories of the specified 3484 source.</para> 3485 </glossdef> 3486 </glossentry> 3487 3488 <glossentry> 3489 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3490 3491 <glossdef> 3492 <para>Tells VBoxManage to be more verbose.</para> 3493 </glossdef> 3494 </glossentry> 3495 3496 <glossentry> 3497 <glossterm><computeroutput>--flags <flags></computeroutput></glossterm> 3498 3499 <glossdef> 3500 <para>Additional flags to set. This is not used at the 3501 moment.</para> 3669 <glossdef> 3670 <para>Recursively removes directories and contents. Optional.</para> 3671 </glossdef> 3672 </glossentry> 3673 3674 <glossentry> 3675 <glossterm><computeroutput><guest directory>...</computeroutput></glossterm> 3676 <glossdef> 3677 <para>Specifies the absolute path(s) of directory(ies) to be deleted on 3678 guest file system. Mandatory. Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar</computeroutput>. 3679 The specified user must have sufficient rights to delete the 3680 specified directory(ies).</para> 3502 3681 </glossdef> 3503 3682 </glossentry> … … 3506 3685 3507 3686 <listitem> 3508 <para><emphasis role="bold"><computeroutput>copyfrom</computeroutput></emphasis>, 3509 which allows copying 3510 files from the guest to the host (only with installed Guest 3511 Additions 4.0 and later). It has the same parameters as 3512 <computeroutput>copyto</computeroutput> above.</para> 3513 </listitem> 3514 3515 <listitem> 3516 <para><emphasis role="bold"><computeroutput>createdirectory</computeroutput></emphasis>, 3517 which allows 3518 copying files from the host to the guest (only with installed Guest 3519 Additions 4.0 and later).</para> 3520 3521 <screen>VBoxManage guestcontrol <uuid|vmname> createdir[ectory]|mkdir|md 3522 <guest directory>... --username <name> 3523 [--passwordfile <file> | --password <password>] 3524 [--parents] [--mode <mode>] [--verbose]</screen> 3525 3526 <para>where the parameters mean: <glosslist> 3527 <glossentry> 3528 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3529 3530 <glossdef> 3531 <para>The VM UUID or VM name. Mandatory.</para> 3532 </glossdef> 3533 </glossentry> 3534 3535 <glossentry> 3536 <glossterm><computeroutput>directory to create on guest</computeroutput></glossterm> 3537 3538 <glossdef> 3539 <para>Absolute path of directory/directories to create on 3540 guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>. 3541 Parent directories need to exist (e.g. in this example 3542 <computeroutput>D:\Foo</computeroutput>) when switch 3543 <computeroutput>--parents</computeroutput> is omitted. The 3544 specified user must have appropriate rights to create the 3545 specified directory.</para> 3546 </glossdef> 3547 </glossentry> 3548 3549 <glossentry> 3550 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3551 3552 <glossdef> 3553 <para>Name of the user the copy process should run under. 3554 This user must exist on the guest OS.</para> 3555 </glossdef> 3556 </glossentry> 3557 3558 <glossentry> 3559 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3560 3561 <glossdef> 3562 <para>Password of the user account specified to be read from 3563 the given file. If not given, an empty password is 3564 assumed.</para> 3565 </glossdef> 3566 </glossentry> 3567 3568 <glossentry> 3569 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3570 3571 <glossdef> 3572 <para>Password of the user account specified with 3573 <computeroutput>--username</computeroutput>. If not given, 3574 an empty password is assumed.</para> 3575 </glossdef> 3576 </glossentry> 3577 3578 <glossentry> 3579 <glossterm><computeroutput>--parents</computeroutput></glossterm> 3580 3581 <glossdef> 3582 <para>Also creates not yet existing parent directories of 3583 the specified directory, e.g. if the directory 3584 <computeroutput>D:\Foo</computeroutput> of 3585 <computeroutput>D:\Foo\Bar</computeroutput> does not exist 3586 yet it will be created. Without specifying 3587 <computeroutput>--parent</computeroutput> the action would 3588 have failed.</para> 3687 <para><emphasis role="bold"><computeroutput>removefile|rm</computeroutput></emphasis> 3688 Deletes specified files on the guest file system. (Only with installed Guest 3689 Additions 4.3.2 and later).</para> 3690 3691 <screen>VBoxManage guestcontrol <uuid|vmname> removefile|rm [common-options] 3692 [-f|--force] 3693 <guest file>... </screen> 3694 3695 <para>Where the parameters are: <glosslist> 3696 <glossentry> 3697 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3698 <glossdef> 3699 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3700 </glossdef> 3701 </glossentry> 3702 3703 <glossentry> 3704 <glossterm><computeroutput>-f|--force</computeroutput></glossterm> 3705 <glossdef> 3706 <para>Enforce operation (override any requests for confirmations). Optional.</para> 3707 </glossdef> 3708 </glossentry> 3709 3710 <glossentry> 3711 <glossterm><computeroutput><guest file>...</computeroutput></glossterm> 3712 <glossdef> 3713 <para>Specifies absolute path(s) of file(s) to be deleted on guest file system. Mandatory. 3714 Wildcards are allowed. e.g. <computeroutput>D:\Foo\Bar\text.txt</computeroutput>. 3715 The specified user should have sufficient rights to delete the specified file(s).</para> 3716 </glossdef> 3717 </glossentry> 3718 </glosslist> 3719 </para> 3720 </listitem> 3721 3722 <listitem> 3723 <para><emphasis role="bold"><computeroutput>mv|move|ren|rename</computeroutput></emphasis> 3724 This subcommand renames file(s) and/or directory(ies) on the guest file system. (Only with installed Guest 3725 Additions 4.3.2 and later).</para> 3726 3727 <screen>VBoxManage guestcontrol <uuid|vmname> mv|move|ren|rename [common-options] 3728 <source>... <dest> </screen> 3729 3730 <para>Where the parameters are: <glosslist> 3731 <glossentry> 3732 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3733 <glossdef> 3734 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3735 </glossdef> 3736 </glossentry> 3737 3738 <glossentry> 3739 <glossterm><computeroutput><source>... </computeroutput></glossterm> 3740 <glossdef> 3741 <para>Specifies absolute path(s) of file(s) to be moved on guest file system. Mandatory. 3742 Wildcards are allowed. The specified user should have sufficient rights to 3743 access the specified file(s).</para> 3744 </glossdef> 3745 </glossentry> 3746 3747 <glossentry> 3748 <glossterm><computeroutput><dest></computeroutput></glossterm> 3749 <glossdef> 3750 <para>Specifies the absolute path of the destination file/directory(ies) to which the file(s) 3751 are to be moved. This can be a directory, or a file if only one file to be moved. Mandatory. 3752 The specified user must have sufficient rights to access the destination file/directory.</para> 3753 </glossdef> 3754 </glossentry> 3755 </glosslist></para> 3756 </listitem> 3757 3758 <listitem> 3759 <para><emphasis role="bold"><computeroutput>mktemp|createtemp|createtemporary</computeroutput></emphasis> 3760 Creates a temporary file/directory on the guest file system, to assist subsequent 3761 copying of files from the host to the guest file systems. By default, the file/directory 3762 is created in the guest's platform specific temp directory. Not currently supported. 3763 (Only with installed Guest Additions 4.2 and later).</para> 3764 3765 <screen>VBoxManage guestcontrol <uuid|vmname> mktemp|createtemp|createtemporary [common-options] 3766 [--directory] [--secure] [--mode <mode>] [--tmpdir <directory>] 3767 <template> 3768 </screen> 3769 3770 <para>The parameters are: <glosslist> 3771 <glossentry> 3772 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3773 <glossdef> 3774 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3775 </glossdef> 3776 </glossentry> 3777 3778 <glossentry> 3779 <glossterm><computeroutput>--directory</computeroutput></glossterm> 3780 <glossdef> 3781 <para>Creates a temporary directory instead of a file, specified by the <template> parameter. Optional.</para> 3782 </glossdef> 3783 </glossentry> 3784 3785 <glossentry> 3786 <glossterm><computeroutput>--secure</computeroutput></glossterm> 3787 <glossdef> 3788 <para> 3789 Enforces secure file/directory creation. Optional. The permission mode is set to 3790 <computeroutput>0755</computeroutput>. Operation fails if it cannot be performed securely. 3791 </para> 3792 </glossdef> 3793 </glossentry> 3794 3795 <glossentry> 3796 <glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm> 3797 <glossdef> 3798 <para> 3799 Specifies the absolute path of the directory on the guest file system into which the 3800 file/directory specified in will be created. Optional. 3801 If unspecified, the platform-specific temp directory is used. 3802 </para> 3589 3803 </glossdef> 3590 3804 </glossentry> … … 3592 3806 <glossentry> 3593 3807 <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> 3594 3595 <glossdef> 3596 <para>Sets the permission mode of the specified directory. 3597 Only octal modes (e.g. 3598 <computeroutput>0755</computeroutput>) are supported right 3599 now.</para> 3600 </glossdef> 3601 </glossentry> 3602 3603 <glossentry> 3604 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3605 3606 <glossdef> 3607 <para>Tells VBoxManage to be more verbose.</para> 3808 <glossdef> 3809 <para>Specifies the permission mode of the specified directory. Optional. 3810 Currently only octal modes (e.g. <computeroutput>0755</computeroutput>) 3811 are supported.</para> 3812 </glossdef> 3813 </glossentry> 3814 3815 <glossentry> 3816 <glossterm><computeroutput><template></computeroutput></glossterm> 3817 <glossdef> 3818 <para>Specifies a file name without a directory path, containing at least one sequence comprising 3819 three consecutive 'X' characters, or ending in 'X'. Mandatory. 3820 </para> 3608 3821 </glossdef> 3609 3822 </glossentry> … … 3612 3825 3613 3826 <listitem> 3614 <para><emphasis role="bold"><computeroutput>removedirectory</computeroutput></emphasis>, 3615 which allows deletion of guest directories (only with installed Guest 3616 Additions 4.3.2 and later).</para> 3617 3618 <screen>VBoxManage guestcontrol <uuid|vmname> removedir[ectory]|rmdir 3619 <guest directory>... --username <name> 3620 [--passwordfile <file> | --password <password>] 3621 [--recursive|-R|-r] [--verbose]</screen> 3622 3623 <para>where the parameters mean: <glosslist> 3624 <glossentry> 3625 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3626 3627 <glossdef> 3628 <para>The VM UUID or VM name. Mandatory.</para> 3629 </glossdef> 3630 </glossentry> 3631 3632 <glossentry> 3633 <glossterm><computeroutput>directory to remove on guest</computeroutput></glossterm> 3634 3635 <glossdef> 3636 <para>Absolute path of directory/directories to remove on 3637 guest, e.g. <computeroutput>D:\Foo\Bar</computeroutput>. The 3638 specified user must have appropriate rights to delete the 3639 specified guest directories.</para> 3640 </glossdef> 3641 </glossentry> 3642 3643 <glossentry> 3644 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3645 3646 <glossdef> 3647 <para>Name of the user the copy process should run under. 3648 This user must exist on the guest OS.</para> 3649 </glossdef> 3650 </glossentry> 3651 3652 <glossentry> 3653 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3654 3655 <glossdef> 3656 <para>Password of the user account specified to be read from 3657 the given file. If not given, an empty password is 3658 assumed.</para> 3659 </glossdef> 3660 </glossentry> 3661 3662 <glossentry> 3663 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3664 3665 <glossdef> 3666 <para>Password of the user account specified with 3667 <computeroutput>--username</computeroutput>. If not given, 3668 an empty password is assumed.</para> 3669 </glossdef> 3670 </glossentry> 3671 3672 <glossentry> 3673 <glossterm><computeroutput>--recursive</computeroutput></glossterm> 3674 3675 <glossdef> 3676 <para>Remove directories and their contents recursively.</para> 3677 </glossdef> 3678 </glossentry> 3679 3680 <glossentry> 3681 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3682 3683 <glossdef> 3684 <para>Tells VBoxManage to be more verbose.</para> 3827 <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>, 3828 Displays file or file system status(es) on the guest.</para> 3829 3830 <screen>VBoxManage guestcontrol <uuid|vmname> stat [common-options] 3831 <file1>[... filen] </screen> 3832 3833 <para>Where the parameters are: <glosslist> 3834 <glossentry> 3835 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3836 <glossdef> 3837 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3838 </glossdef> 3839 </glossentry> 3840 3841 <glossentry> 3842 <glossterm><computeroutput><file1>[... filen]</computeroutput></glossterm> 3843 <glossdef> 3844 <para>Specifies absolute path(s) of file(s) on guest file system. Mandatory. 3845 e.g. <computeroutput>/home/foo/a.out</computeroutput>. 3846 The specified user should have sufficient rights to access 3847 the specified file/file system(s).</para> 3685 3848 </glossdef> 3686 3849 </glossentry> 3687 3850 </glosslist></para> 3688 3851 </listitem> 3689 3690 <listitem> 3691 <para><emphasis role="bold"><computeroutput>removefile</computeroutput></emphasis>, 3692 which allows deletion of guest files (only with installed Guest 3693 Additions 4.3.2 and later).</para> 3694 3695 <screen>VBoxManage guestcontrol <uuid|vmname> removefile|rm 3696 <guest file>... --username <name> 3697 [--passwordfile <file> | --password <password>] 3698 [--verbose]</screen> 3699 3700 <para>where the parameters mean: <glosslist> 3701 <glossentry> 3702 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3703 3704 <glossdef> 3705 <para>The VM UUID or VM name. Mandatory.</para> 3706 </glossdef> 3707 </glossentry> 3708 3709 <glossentry> 3710 <glossterm><computeroutput>file to remove on guest</computeroutput></glossterm> 3711 3712 <glossdef> 3713 <para>Absolute path of a file/files to remove on 3714 guest, e.g. <computeroutput>D:\Foo\Bar\text.txt</computeroutput>. The 3715 specified user must have appropriate rights to delete the 3716 specified guest files.</para> 3717 </glossdef> 3718 </glossentry> 3719 3720 <glossentry> 3721 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3722 3723 <glossdef> 3724 <para>Name of the user the copy process should run under. 3725 This user must exist on the guest OS.</para> 3726 </glossdef> 3727 </glossentry> 3728 3729 <glossentry> 3730 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3731 3732 <glossdef> 3733 <para>Password of the user account specified to be read from 3734 the given file. If not given, an empty password is 3735 assumed.</para> 3736 </glossdef> 3737 </glossentry> 3738 3739 <glossentry> 3740 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3741 3742 <glossdef> 3743 <para>Password of the user account specified with 3744 <computeroutput>--username</computeroutput>. If not given, 3745 an empty password is assumed.</para> 3746 </glossdef> 3747 </glossentry> 3748 3749 <glossentry> 3750 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3751 3752 <glossdef> 3753 <para>Tells VBoxManage to be more verbose.</para> 3754 </glossdef> 3755 </glossentry> 3756 </glosslist></para> 3757 </listitem> 3758 3759 <listitem> 3760 <para><emphasis role="bold"><computeroutput>ren[ame]|mv</computeroutput></emphasis>, 3761 which allows renaming of guest files and/or directories (only with installed Guest 3762 Additions 4.3.2 and later).</para> 3763 3764 <screen>VBoxManage guestcontrol <uuid|vmname> ren[ame]|mv 3765 <source>... <dest> --username <name> 3766 [--passwordfile <file> | --password <password>] 3767 [--verbose]</screen> 3768 3769 <para>where the parameters mean: <glosslist> 3770 <glossentry> 3771 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3772 3773 <glossdef> 3774 <para>The VM UUID or VM name. Mandatory.</para> 3775 </glossdef> 3776 </glossentry> 3777 3778 <glossentry> 3779 <glossterm><computeroutput>source</computeroutput></glossterm> 3780 3781 <glossdef> 3782 <para>Absolute path of one or more source(s) to move to 3783 destination. If more than one source is specified, destination 3784 must be an existing directory on the guest. The specified user 3785 must have appropriate rights to access source and destination 3786 files and directories.</para> 3787 </glossdef> 3788 </glossentry> 3789 3790 <glossentry> 3791 <glossterm><computeroutput>dest</computeroutput></glossterm> 3792 3793 <glossdef> 3794 <para>Absolute path of the destination to move the source(s) 3795 to. This can be a directory or a file, depending if one or more 3796 sources have been specified. The specified user 3797 must have appropriate rights to access the destination 3798 file and directory.</para> 3799 </glossdef> 3800 </glossentry> 3801 3802 <glossentry> 3803 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3804 3805 <glossdef> 3806 <para>Name of the user the copy process should run under. 3807 This user must exist on the guest OS.</para> 3808 </glossdef> 3809 </glossentry> 3810 3811 <glossentry> 3812 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3813 3814 <glossdef> 3815 <para>Password of the user account specified to be read from 3816 the given file. If not given, an empty password is 3817 assumed.</para> 3818 </glossdef> 3819 </glossentry> 3820 3821 <glossentry> 3822 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3823 3824 <glossdef> 3825 <para>Password of the user account specified with 3826 <computeroutput>--username</computeroutput>. If not given, 3827 an empty password is assumed.</para> 3828 </glossdef> 3829 </glossentry> 3830 3831 <glossentry> 3832 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3833 3834 <glossdef> 3835 <para>Tells VBoxManage to be more verbose.</para> 3836 </glossdef> 3837 </glossentry> 3838 </glosslist></para> 3839 </listitem> 3840 3841 <listitem> 3842 <para><emphasis role="bold"><computeroutput>createtemporary</computeroutput></emphasis>, 3843 which allows 3844 copying files from the host to the guest (only with installed Guest 3845 Additions 4.2 and later).</para> 3846 3847 <screen>VBoxManage guestcontrol <uuid|vmname> createtemp[orary]|mktemp 3848 <template> --username <name> 3849 [--passwordfile <file> | --password <password>] 3850 [--directory] [--secure] [--tmpdir <directory>] 3851 [--domain <domain>] [--mode <mode>] [--verbose]</screen> 3852 3853 <para>where the parameters mean: <glosslist> 3854 <glossentry> 3855 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3856 3857 <glossdef> 3858 <para>The VM UUID or VM name. Mandatory.</para> 3859 </glossdef> 3860 </glossentry> 3861 3862 <glossentry> 3863 <glossterm><computeroutput>template</computeroutput></glossterm> 3864 3865 <glossdef> 3866 <para>A file name without a path and with at least three consecutive 'X' 3867 characters or ending in 'X' 3868 </para> 3869 </glossdef> 3870 </glossentry> 3871 3872 <glossentry> 3873 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 3874 3875 <glossdef> 3876 <para>Name of the user the copy process should run under. 3877 This user must exist on the guest OS.</para> 3878 </glossdef> 3879 </glossentry> 3880 3881 <glossentry> 3882 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 3883 3884 <glossdef> 3885 <para>Password of the user account specified to be read from 3886 the given file. If not given, an empty password is 3887 assumed.</para> 3888 </glossdef> 3889 </glossentry> 3890 3891 <glossentry> 3892 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 3893 3894 <glossdef> 3895 <para>Password of the user account specified with 3896 <computeroutput>--username</computeroutput>. If not given, 3897 an empty password is assumed.</para> 3898 </glossdef> 3899 </glossentry> 3900 3901 <glossentry> 3902 <glossterm><computeroutput>--directory</computeroutput></glossterm> 3903 3904 <glossdef> 3905 <para>Create a temporary directory instead of a file.</para> 3906 </glossdef> 3907 </glossentry> 3908 3909 <glossentry> 3910 <glossterm><computeroutput>--secure</computeroutput></glossterm> 3911 3912 <glossdef> 3913 <para> 3914 Secure creation. The file mode is fixed to 3915 <computeroutput>0755</computeroutput>. And the operation 3916 will fail if it cannot performed securely. 3917 </para> 3918 </glossdef> 3919 </glossentry> 3920 3921 <glossentry> 3922 <glossterm><computeroutput>--tmpdir <directory></computeroutput></glossterm> 3923 3924 <glossdef> 3925 <para> 3926 Directory where the file / directory is created. If not 3927 specified, the platform-specific temp directory is used. 3928 </para> 3929 </glossdef> 3930 </glossentry> 3931 3932 <glossentry> 3933 <glossterm><computeroutput>--mode <mode></computeroutput></glossterm> 3934 3935 <glossdef> 3936 <para>Sets the permission mode of the specified directory. 3937 Only octal modes (e.g. 3938 <computeroutput>0755</computeroutput>) are supported right 3939 now.</para> 3940 </glossdef> 3941 </glossentry> 3942 3943 <glossentry> 3944 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3945 3946 <glossdef> 3947 <para>Tells VBoxManage to be more verbose.</para> 3948 </glossdef> 3949 </glossentry> 3950 </glosslist></para> 3951 </listitem> 3952 3852 </itemizedlist> 3853 </para> 3854 3855 <para>The second set of subcommands are of the form:</para> 3856 <screen>VBoxManage guestcontrol <uuid|vmname> <sub-command> 3857 [-v|--verbose] [-q|quiet] ... 3858 </screen> 3859 3860 <para>The "common-options" are:</para> 3861 <screen> 3862 [-v|--verbose] [-q|--quiet] 3863 </screen> 3864 3865 <para>Where details of the common options for the second set of subcommands are: 3866 <glosslist> 3867 3868 <glossentry> 3869 <glossterm><computeroutput>-v|--verbose</computeroutput></glossterm> 3870 <glossdef><para>Makes the sub-command execution more verbose. Optional.</para></glossdef> 3871 </glossentry> 3872 3873 <glossentry> 3874 <glossterm><computeroutput>-q|--quiet</computeroutput></glossterm> 3875 <glossdef><para>Makes the sub-command execution quieter. Optional.</para></glossdef> 3876 </glossentry> 3877 </glosslist> 3878 </para> 3879 3880 <para>The second set of subcommands: <itemizedlist> 3953 3881 <listitem> 3954 3882 <para><emphasis role="bold"><computeroutput>list</computeroutput></emphasis>, 3955 which lists various guest control information such asopen guest sessions,3956 guest processes and guestfiles.</para>3957 3958 <screen>VBoxManage guestcontrol <uuid|vmname> list 3959 <all|sessions|processes|files> [--verbose]</screen>3960 3961 <para> where the parameters mean: <glosslist>3883 Lists guest control configuration and status data, e.g. open guest sessions, 3884 guest processes and files.</para> 3885 3886 <screen>VBoxManage guestcontrol <uuid|vmname> list [common-opts] 3887 <all|sessions|processes|files> </screen> 3888 3889 <para>Where the parameters are: <glosslist> 3962 3890 <glossentry> 3963 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 3964 3891 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 3965 3892 <glossdef> 3966 <para> The VM UUID or VM name. Mandatory.</para>3893 <para>Specifies the VM UUID or VM name. Mandatory.</para> 3967 3894 </glossdef> 3968 3895 </glossentry> 3969 3970 3896 <glossentry> 3971 3897 <glossterm><computeroutput>all|sessions|processes|files</computeroutput></glossterm> 3972 3973 3898 <glossdef> 3974 <para>Whether to list guest sessions, guest processes, guest files 3975 or all information available. Mandatory.</para> 3976 </glossdef> 3977 </glossentry> 3978 3979 <glossentry> 3980 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 3981 3982 <glossdef> 3983 <para>Tells VBoxManage to be more verbose.</para> 3899 <para>Indicates whether to list all available data or guest sessions, processes or files. 3900 Mandatory.</para> 3984 3901 </glossdef> 3985 3902 </glossentry> … … 3988 3905 3989 3906 <listitem> 3990 <para><emphasis role="bold"><computeroutput>process kill</computeroutput></emphasis>, 3991 which terminates specific guest processes of a guest session, based on either the 3992 session's ID or the session's name.</para> 3993 3994 <screen>VBoxManage guestcontrol <uuid|vmname> process kill 3995 --session-id <ID> 3996 | --session-name <name or pattern> 3997 [--verbose] 3998 <PID> ... <PID n></screen> 3999 4000 <para>where the parameters mean: <glosslist> 3907 <para><emphasis role="bold"><computeroutput>closeprocess</computeroutput></emphasis>, 3908 Terminates guest processes (specified by PID(s))running in guest session(s) 3909 specified by the session ID or name(s).</para> 3910 3911 <screen>VBoxManage guestcontrol <uuid|vmname> closeprocess [common-options] 3912 --session-id <ID> | --session-name <name or pattern> 3913 <PID1> [... <PID n>] </screen> 3914 3915 <para>Where the parameters are: <glosslist> 4001 3916 <glossentry> 4002 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4003 3917 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4004 3918 <glossdef> 4005 <para> The VM UUID or VM name. Mandatory.</para>3919 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4006 3920 </glossdef> 4007 3921 </glossentry> 4008 3922 4009 3923 <glossentry> 4010 <glossterm><computeroutput>--session-id</computeroutput></glossterm> 4011 3924 <glossterm><computeroutput>--session-id <ID></computeroutput></glossterm> 4012 3925 <glossdef> 4013 <para>Specifies the guest session to use by its ID.</para>3926 <para>Specifies the guest session by its ID. Optional.</para> 4014 3927 </glossdef> 4015 3928 </glossentry> … … 4017 3930 <glossentry> 4018 3931 <glossterm><computeroutput>--session-name</computeroutput></glossterm> 4019 4020 3932 <glossdef> 4021 <para>Specifies the guest session to use by its name. Multiple4022 sessions can be closed when specifying * or ? wildcards.</para>3933 <para>Specifies the guest session by its name, or multiple sessions 3934 using a pattern containing wildcards. Optional.</para> 4023 3935 </glossdef> 4024 3936 </glossentry> 4025 3937 4026 3938 <glossentry> 4027 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4028 3939 <glossterm><computeroutput><PID1> [... <PID n>]</computeroutput></glossterm> 4029 3940 <glossdef> 4030 <para>Tells VBoxManage to be more verbose.</para> 4031 </glossdef> 4032 </glossentry> 4033 4034 <glossentry> 4035 <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm> 4036 4037 <glossdef> 4038 <para>List of process identifiers (PIDs) to terminate.</para> 3941 <para>Specifies a list of process identifiers (PIDs) of guest processes to be terminated. Mandatory.</para> 4039 3942 </glossdef> 4040 3943 </glossentry> … … 4043 3946 4044 3947 <listitem> 4045 <para><emphasis role="bold"><computeroutput>[p[s]]kill</computeroutput></emphasis>, 4046 which terminates specific guest processes of a guest session, based on either the 4047 session's ID or the session's name.</para> 4048 4049 <screen>VBoxManage guestcontrol <uuid|vmname> process kill 3948 <para><emphasis role="bold"><computeroutput>closesession</computeroutput></emphasis>, 3949 Closes specified guest sessions, specified either by session ID or name.</para> 3950 3951 <screen>VBoxManage guestcontrol <uuid|vmname> closesession [common-options] 4050 3952 --session-id <ID> 4051 3953 | --session-name <name or pattern> 4052 [--verbose] 4053 <PID> ... <PID n></screen> 4054 4055 <para>where the parameters mean: <glosslist> 3954 | --all </screen> 3955 3956 <para>Where the parameters are: <glosslist> 4056 3957 <glossentry> 4057 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4058 3958 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4059 3959 <glossdef> 4060 <para> The VM UUID or VM name. Mandatory.</para>3960 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4061 3961 </glossdef> 4062 3962 </glossentry> … … 4064 3964 <glossentry> 4065 3965 <glossterm><computeroutput>--session-id</computeroutput></glossterm> 4066 4067 3966 <glossdef> 4068 <para>Specifies the guest session to use by its ID.</para>3967 <para>Specifies the guest session to be closed by ID. Optional.</para> 4069 3968 </glossdef> 4070 3969 </glossentry> 4071 3970 4072 <glossentry>3971 <glossentry> 4073 3972 <glossterm><computeroutput>--session-name</computeroutput></glossterm> 4074 4075 3973 <glossdef> 4076 <para>Specifies the guest session to use by its name. Multiple 4077 sessions can be closed when specifying * or ? wildcards.</para> 3974 <para>Specifies the guest session to be closed by name. Optional. 3975 Multiple sessions can be specified by using a pattern 3976 containing wildcards. </para> 4078 3977 </glossdef> 4079 3978 </glossentry> 4080 3979 4081 <glossentry> 4082 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4083 3980 <glossentry> 3981 <glossterm><computeroutput>--all</computeroutput></glossterm> 4084 3982 <glossdef> 4085 <para>Tells VBoxManage to be more verbose.</para> 4086 </glossdef> 4087 </glossentry> 4088 4089 <glossentry> 4090 <glossterm><computeroutput><PID> ... <PID n></computeroutput></glossterm> 4091 4092 <glossdef> 4093 <para>List of process identifiers (PIDs) to terminate.</para> 3983 <para>Close all guest sessions. Optional.</para> 4094 3984 </glossdef> 4095 3985 </glossentry> … … 4098 3988 4099 3989 <listitem> 4100 <para><emphasis role="bold"><computeroutput>session close</computeroutput></emphasis>, 4101 which closes specific guest sessions, based on either the session's ID or the 4102 session's name.</para> 4103 4104 <screen>VBoxManage guestcontrol <uuid|vmname> session close 4105 --session-id <ID> 4106 | --session-name <name or pattern> 4107 | --all 4108 [--verbose]</screen> 4109 4110 <para>where the parameters mean: <glosslist> 3990 <para><emphasis role="bold"><computeroutput>updatega|updateadditions|updateguestadditions</computeroutput></emphasis> 3991 Ugrades Guest Additions already installed on the guest. 3992 (Only already installed Guest Additions 4.0 and later).</para> 3993 3994 <screen>VBoxManage guestcontrol <uuid|vmname> updatega|updateadditions|updateguestadditions [common-options] 3995 [--source "<New .ISO path>"] 3996 [--wait-start] [-- [<argument1>] ... [<argumentN>]]</screen> 3997 3998 <para>Where the parameters are: <glosslist> 3999 <glossentry> 4000 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4001 <glossdef> 4002 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4003 </glossdef> 4004 </glossentry> 4005 4006 <glossentry> 4007 <glossterm><computeroutput>--source</computeroutput> "<New ISO path>"</glossterm> 4008 <glossdef> 4009 <para>Specifies the absolute path on guest file system of ISO file for Guest Additions update. Mandatory.</para> 4010 </glossdef> 4011 </glossentry> 4012 4013 <glossentry> 4014 <glossterm><computeroutput>--wait-start</computeroutput></glossterm> 4015 <glossdef> 4016 <para>Indicates that VBoxManage starts the usual updating process on the guest and then waits 4017 until the actual Guest Additions updating begins, at which point VBoxManage self-terminates. Optional.</para> 4018 <para>Default behavior is that VBoxManage waits for completion of the Guest Additions update before 4019 terminating. Use of this option is sometimes necessary, as a running VBoxManage 4020 can affect the interaction between the installer and the guest OS.</para> 4021 </glossdef> 4022 </glossentry> 4023 4024 <glossentry> 4025 <glossterm><computeroutput>[-- [<argument1>] ... [<argumentN>]]</computeroutput></glossterm> 4026 <glossdef> 4027 <para>Specifies optional command line arguments to be supplied to the Guest Additions 4028 updater. Useful for retrofitting features which are not currently installed.</para> 4029 <para>Arguments containing spaces should be enclosed by quotes.</para> 4030 </glossdef> 4031 </glossentry> 4032 </glosslist></para> 4033 </listitem> 4034 4035 <listitem> 4036 <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>, 4037 This subcommand prints current guest control activity.</para> 4038 4039 <screen>VBoxManage guestcontrol <uuid|vmname> watch [common-options] 4040 </screen> 4041 <para>Where the parameters are: <glosslist> 4111 4042 <glossentry> 4112 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4113 4043 <glossterm><computeroutput><uuid|vmname></computeroutput></glossterm> 4114 4044 <glossdef> 4115 <para>The VM UUID or VM name. Mandatory.</para> 4116 </glossdef> 4117 </glossentry> 4118 4119 <glossentry> 4120 <glossterm><computeroutput>--session-id</computeroutput></glossterm> 4121 4122 <glossdef> 4123 <para>Close a guest session specified by its ID.</para> 4124 </glossdef> 4125 </glossentry> 4126 4127 <glossentry> 4128 <glossterm><computeroutput>--session-name</computeroutput></glossterm> 4129 4130 <glossdef> 4131 <para>Close a guest session specified by its name. Multiple sessions 4132 can be closed when specifying * or ? wildcards.</para> 4133 </glossdef> 4134 </glossentry> 4135 4136 <glossentry> 4137 <glossterm><computeroutput>--all</computeroutput></glossterm> 4138 4139 <glossdef> 4140 <para>Close all guest sessions.</para> 4141 </glossdef> 4142 </glossentry> 4143 4144 <glossentry> 4145 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4146 4147 <glossdef> 4148 <para>Tells VBoxManage to be more verbose.</para> 4149 </glossdef> 4150 </glossentry> 4151 </glosslist></para> 4152 </listitem> 4153 4154 <listitem> 4155 <para><emphasis role="bold"><computeroutput>stat</computeroutput></emphasis>, 4156 which displays file 4157 or file system status on the guest.</para> 4158 4159 <screen>VBoxManage guestcontrol <uuid|vmname> stat 4160 <file>... --username <name> 4161 [--passwordfile <file> | --password <password>] 4162 [--verbose]</screen> 4163 4164 <para>where the parameters mean: <glosslist> 4165 <glossentry> 4166 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4167 4168 <glossdef> 4169 <para>The VM UUID or VM name. Mandatory.</para> 4170 </glossdef> 4171 </glossentry> 4172 4173 <glossentry> 4174 <glossterm><computeroutput>file element(s) to check on guest</computeroutput></glossterm> 4175 4176 <glossdef> 4177 <para>Absolute path of directory/directories to check on 4178 guest, e.g. <computeroutput>/home/foo/a.out</computeroutput>. 4179 The specified user must have appropriate rights to access 4180 the given file element(s).</para> 4181 </glossdef> 4182 </glossentry> 4183 4184 <glossentry> 4185 <glossterm><computeroutput>--username <name></computeroutput></glossterm> 4186 4187 <glossdef> 4188 <para>Name of the user the copy process should run under. 4189 This user must exist on the guest OS.</para> 4190 </glossdef> 4191 </glossentry> 4192 4193 <glossentry> 4194 <glossterm><computeroutput>--passwordfile <file></computeroutput></glossterm> 4195 4196 <glossdef> 4197 <para>Password of the user account specified to be read from 4198 the given file. If not given, an empty password is 4199 assumed.</para> 4200 </glossdef> 4201 </glossentry> 4202 4203 <glossentry> 4204 <glossterm><computeroutput>--password <password></computeroutput></glossterm> 4205 4206 <glossdef> 4207 <para>Password of the user account specified with 4208 <computeroutput>--username</computeroutput>. If not given, 4209 an empty password is assumed.</para> 4210 </glossdef> 4211 </glossentry> 4212 4213 <glossentry> 4214 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4215 4216 <glossdef> 4217 <para>Tells VBoxManage to be more verbose.</para> 4218 </glossdef> 4219 </glossentry> 4220 </glosslist></para> 4221 </listitem> 4222 4223 <listitem> 4224 <para><emphasis role="bold"><computeroutput>updateadditions</computeroutput></emphasis>, 4225 which allows 4226 for updating an already installed Guest Additions version on the 4227 guest (only already installed Guest Additions 4.0 and later).</para> 4228 4229 <screen>VBoxManage guestcontrol <uuid|vmname> updateadditions 4230 [--source "<guest additions .ISO file to use>"] [--verbose] 4231 [--wait-start] [-- [<argument1>] ... [<argumentN>]]</screen> 4232 4233 <para>where the parameters mean: <glosslist> 4234 <glossentry> 4235 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4236 4237 <glossdef> 4238 <para>The VM UUID or VM name. Mandatory.</para> 4239 </glossdef> 4240 </glossentry> 4241 4242 <glossentry> 4243 <glossterm><computeroutput>--source</computeroutput> "<guest additions .ISO file to 4244 use>"</glossterm> 4245 4246 <glossdef> 4247 <para>Full path to an alternative VirtualBox Guest Additions 4248 .ISO file to use for the Guest Additions update.</para> 4249 </glossdef> 4250 </glossentry> 4251 4252 <glossentry> 4253 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4254 4255 <glossdef> 4256 <para>Tells VBoxManage to be more verbose.</para> 4257 </glossdef> 4258 </glossentry> 4259 4260 <glossentry> 4261 <glossterm><computeroutput>--wait-start</computeroutput></glossterm> 4262 <glossdef> 4263 <para>Starts the regular updating process and waits until the 4264 actual Guest Additions update inside the guest was started. 4265 This can be necessary due to needed interaction with the 4266 guest OS during the installation phase.</para> 4267 <para>When omitting this flag VBoxManage will wait for the 4268 whole Guest Additions update to complete.</para> 4269 </glossdef> 4270 </glossentry> 4271 4272 <glossentry> 4273 <glossterm><computeroutput>[-- [<argument1s>] ... [<argumentNs>]]</computeroutput></glossterm> 4274 4275 <glossdef> 4276 <para>Optional command line arguments to use for the Guest Additions 4277 installer. Useful for retrofitting features which weren't installed 4278 before on the guest.</para> 4279 <para>Arguments containing spaces must be enclosed in 4280 quotation marks.</para> 4281 </glossdef> 4282 </glossentry> 4283 </glosslist></para> 4284 </listitem> 4285 <listitem> 4286 <para><emphasis role="bold"><computeroutput>watch</computeroutput></emphasis>, 4287 which prints current guest control activity.</para> 4288 4289 <screen>VBoxManage guestcontrol <uuid|vmname> watch 4290 [--verbose]</screen> 4291 4292 <para>where the parameters mean: <glosslist> 4293 <glossentry> 4294 <glossterm><computeroutput>uuid|vmname</computeroutput></glossterm> 4295 4296 <glossdef> 4297 <para>The VM UUID or VM name. Mandatory.</para> 4298 </glossdef> 4299 </glossentry> 4300 4301 <glossentry> 4302 <glossterm><computeroutput>--verbose</computeroutput></glossterm> 4303 4304 <glossdef> 4305 <para>Tells VBoxManage to be more verbose.</para> 4045 <para>Specifies the VM UUID or VM name. Mandatory.</para> 4306 4046 </glossdef> 4307 4047 </glossentry> … … 4466 4206 </sect1> 4467 4207 4208 <sect1 id="vboxmanage-natnetwork"> 4209 <title>VBoxManage natnetwork</title> 4210 4211 <para>NAT networks use the Network Address Translation (NAT) service - which works in a 4212 similar way to a home router. It groups systems using it into a network and prevents 4213 outside systems from directly accessing those inside, while letting systems inside communicate 4214 with each other and outside systems using TCP and UDP over IPv4 and IPv6.</para> 4215 4216 <para>A NAT service is attached to an internal network. Virtual machines to make use of one 4217 should be attached to it. The name of an internal network is chosen when the NAT service is 4218 created, and the internal network will be created if it does not already exist. 4219 An example command to create a NAT network:</para> 4220 4221 <screen>VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable</screen> 4222 4223 <para>Here, "natnet1" is the name of the internal network to be used and "192.168.15.0/24" is the 4224 network address and mask of the NAT service interface. By default, in this static configuration 4225 - the gateway will be assigned the address 192.168.15.1 (the address after the interface address), 4226 though this is subject to change.</para> 4227 4228 <para>To add a DHCP server to the NAT network after creation:</para> 4229 4230 <screen>VBoxManage natnetwork modify --netname natnet1 --dhcp on</screen> 4231 4232 <para>Below are the subcommands for <emphasis role="bold"><computeroutput>VBoxManage natnetwork </computeroutput></emphasis></para> 4233 4234 <screen>VBoxManage natnetwork add --netname <name> 4235 [--network <network>] 4236 [--enable|--disable] 4237 [--dhcp on|off] 4238 [--port-forward-4 <rule>] 4239 [--loopback-4 <rule>] 4240 [--ipv6 on|off] 4241 [--port-forward-6 <rule>] 4242 [--loopback-6 <rule>] 4243 </screen> 4244 4245 4246 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork add</computeroutput></emphasis> 4247 Creates a new internal network interface, and adds a NAT network service. This command is a 4248 prerequisite for enabling attachment of VMs to the NAT network. Parameters:</para> 4249 4250 <para> 4251 <glosslist> 4252 <glossentry> 4253 <glossterm><computeroutput>--netname <name></computeroutput></glossterm> 4254 <glossdef> 4255 <para>Where <name> is the name of the new internal network interface on the host OS. </para> 4256 </glossdef> 4257 </glossentry> 4258 <glossentry> 4259 <glossterm><computeroutput>--network <network></computeroutput></glossterm> 4260 <glossdef> 4261 <para>Where <network> specifies the static(default)/DHCP network address and mask of 4262 the NAT service interface.</para> 4263 </glossdef> 4264 </glossentry> 4265 <glossentry> 4266 <glossterm><computeroutput>--enable|--disable</computeroutput></glossterm> 4267 <glossdef> 4268 <para>Enables/disables the NAT network service.</para> 4269 </glossdef> 4270 </glossentry> 4271 <glossentry> 4272 <glossterm><computeroutput>--dhcp on|off</computeroutput></glossterm> 4273 <glossdef> 4274 <para>Enables/disables DHCP server specified by --netname; its use also indicates that it 4275 is a DHCP server.</para> 4276 </glossdef> 4277 </glossentry> 4278 <glossentry> 4279 <glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm> 4280 <glossdef> 4281 <para>Enables IPv4 port forwarding, rule specified by <rule>.</para> 4282 </glossdef> 4283 </glossentry> 4284 <glossentry> 4285 <glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm> 4286 <glossdef> 4287 <para>Enables IPv4 loopback interface, rule specified by <rule>.</para> 4288 </glossdef> 4289 </glossentry> 4290 <glossentry> 4291 <glossterm><computeroutput>--ipv6 on|off</computeroutput></glossterm> 4292 <glossdef> 4293 <para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para> 4294 </glossdef> 4295 </glossentry> 4296 <glossentry> 4297 <glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm> 4298 <glossdef> 4299 <para>Enables IPv6 port forwarding, rule specified by <rule>.</para> 4300 </glossdef> 4301 </glossentry> 4302 <glossentry> 4303 <glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm> 4304 <glossdef> 4305 <para>Enables IPv6 loopback interface, rule specified by <rule>.</para> 4306 </glossdef> 4307 </glossentry> 4308 </glosslist> 4309 </para> 4310 4311 <screen>VBoxManage natnetwork remove --netname <name> </screen> 4312 4313 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork remove</computeroutput></emphasis> 4314 Removes a NAT network service, parameters:</para> 4315 4316 <para> 4317 <glosslist> 4318 <glossentry> 4319 <glossterm><computeroutput>--netname <name></computeroutput></glossterm> 4320 <glossdef> 4321 <para>Where <name> specifies an existing NAT network service. 4322 Does not remove any DHCP server enabled on the network.</para> 4323 </glossdef> 4324 </glossentry> 4325 </glosslist> 4326 </para> 4327 4328 <screen>VBoxManage natnetwork modify --netname <name> 4329 [--network <network>] 4330 [--enable|--disable] 4331 [--dhcp on|off] 4332 [--port-forward-4 <rule>] 4333 [--loopback-4 <rule>] 4334 [--ipv6 on|off] 4335 [--port-forward-6 <rule>] 4336 [--loopback-6 <rule>] 4337 </screen> 4338 4339 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork modify</computeroutput></emphasis> 4340 Modifies an existing NAT network service, parameters:</para> 4341 4342 <para> 4343 <glosslist> 4344 <glossentry> 4345 <glossterm><computeroutput>--netname <name></computeroutput></glossterm> 4346 <glossdef> 4347 <para>Where <name> specifies an existing NAT network service.</para> 4348 </glossdef> 4349 </glossentry> 4350 <glossentry> 4351 <glossterm><computeroutput>--network <network></computeroutput></glossterm> 4352 <glossdef> 4353 <para>Where <network> specifies the new static(default)/DHCP network address and mask 4354 of the NAT service interface.</para> 4355 </glossdef> 4356 </glossentry> 4357 <glossentry> 4358 <glossterm><computeroutput>--enable|--disable</computeroutput></glossterm> 4359 <glossdef> 4360 <para>Enables/disables the NAT network service.</para> 4361 </glossdef> 4362 </glossentry> 4363 <glossentry> 4364 <glossterm><computeroutput>--dhcp on|off</computeroutput></glossterm> 4365 <glossdef> 4366 <para>Enables (and if absent, adds)/disables (if any) DHCP server.</para> 4367 </glossdef> 4368 </glossentry> 4369 <glossentry> 4370 <glossterm><computeroutput>--port-forward-4 <rule></computeroutput></glossterm> 4371 <glossdef> 4372 <para>Enables IPv4 port forwarding, rule specified by <rule>.</para> 4373 </glossdef> 4374 </glossentry> 4375 <glossentry> 4376 <glossterm><computeroutput>--loopback-4 <rule></computeroutput></glossterm> 4377 <glossdef> 4378 <para>Enables IPv4 loopback interface, rule specified by <rule>.</para> 4379 </glossdef> 4380 </glossentry> 4381 <glossentry> 4382 <glossterm><computeroutput>--ipv6 on|off</computeroutput></glossterm> 4383 <glossdef> 4384 <para>Enables/disables IPv6 (default is IPv4, disables gives IPv4).</para> 4385 </glossdef> 4386 </glossentry> 4387 <glossentry> 4388 <glossterm><computeroutput>--port-forward-6 <rule></computeroutput></glossterm> 4389 <glossdef> 4390 <para>Enables IPv6 port forwarding, rule specified by <rule>.</para> 4391 </glossdef> 4392 </glossentry> 4393 <glossentry> 4394 <glossterm><computeroutput>--loopback-6 <rule></computeroutput></glossterm> 4395 <glossdef> 4396 <para>Enables IPv6 loopback interface, rule specified by <rule>.</para> 4397 </glossdef> 4398 </glossentry> 4399 </glosslist> 4400 </para> 4401 4402 <screen>VBoxManage natnetwork start --netname <name> 4403 </screen> 4404 4405 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork start</computeroutput></emphasis> 4406 Starts specified NAT network service and any associated DHCP server, parameters:</para> 4407 4408 <para> 4409 <glosslist> 4410 <glossentry> 4411 <glossterm><computeroutput>--netname <name></computeroutput></glossterm> 4412 <glossdef> 4413 <para>Where <name> specifies an existing NAT network service.</para> 4414 </glossdef> 4415 </glossentry> 4416 </glosslist> 4417 </para> 4418 4419 <screen>VBoxManage natnetwork stop --netname <name> 4420 </screen> 4421 4422 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork stop</computeroutput></emphasis> 4423 Stops specified NAT network service and any DHCP server, parameters:</para> 4424 4425 <para> 4426 <glosslist> 4427 <glossentry> 4428 <glossterm><computeroutput>--netname <name></computeroutput></glossterm> 4429 <glossdef> 4430 <para>Where <name> specifies an existing NAT network service.</para> 4431 </glossdef> 4432 </glossentry> 4433 </glosslist> 4434 </para> 4435 4436 <screen>VBoxManage natnetwork list [<pattern>] </screen> 4437 4438 <para><emphasis role="bold"><computeroutput>VBoxManage natnetwork list</computeroutput></emphasis> 4439 Lists all NAT network services with optional filtering, parameters:</para> 4440 4441 <para> 4442 <glosslist> 4443 <glossentry> 4444 <glossterm><computeroutput>[<pattern>]</computeroutput></glossterm> 4445 <glossdef> 4446 <para>Where <pattern> is optional filtering pattern.</para> 4447 </glossdef> 4448 </glossentry> 4449 </glosslist> 4450 </para> 4451 </sect1> 4452 4468 4453 <sect1 id="vboxmanage-hostonlyif"> 4469 4454 <title>VBoxManage hostonlyif</title> … … 4487 4472 <glossterm><computeroutput>create</computeroutput></glossterm> 4488 4473 <glossdef> 4489 <para>C eates a new vboxnet<N> interface on the host OS.4474 <para>Creates a new vboxnet<N> interface on the host OS. 4490 4475 This command is essential before you can attach VMs to host-only network.</para> 4491 4476 </glossdef>
Note:
See TracChangeset
for help on using the changeset viewer.
