summaryrefslogtreecommitdiffstats
path: root/doc/manual/en_US/man_VBoxManage-guestcontrol.xml
blob: c7cb63346f3f72f1c92f69642d9b7d5aced49852 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
<?xml version="1.0" encoding="UTF-8"?>
<!--
    manpage, user manual, usage: VBoxManage guestcontrol
-->
<!--
    Copyright (C) 2006-2022 Oracle and/or its affiliates.

    This file is part of VirtualBox base platform packages, as
    available from https://www.virtualbox.org.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation, in version 3 of the
    License.

    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, see <https://www.gnu.org/licenses>.

    SPDX-License-Identifier: GPL-3.0-only
-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
<!ENTITY % all.entities SYSTEM "all-entities.ent">
%all.entities;
]>
<refentry id="vboxmanage-guestcontrol" lang="en">
  <refentryinfo>
    <pubdate>$Date: 2023-01-05 14:44:46 +0100 (Thu, 05 Jan 2023) $</pubdate>
    <title>VBoxManage guestcontrol</title>
  </refentryinfo>

  <refmeta>
    <refentrytitle>VBoxManage-guestcontrol</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>VBoxManage-guestcontrol</refname>
    <refpurpose>control a virtual machine from the host system</refpurpose>
    <refclass>&product-name;</refclass>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-run">
<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">run</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <arg>--dos2unix</arg>
      <arg>--exe=<replaceable>filename</replaceable></arg>
      <arg>--ignore-orphaned-processes</arg>
      <group>
        <arg choice="plain">--no-wait-stderr</arg>
        <arg choice="plain">--wait-stderr</arg>
      </group>
      <group>
        <arg choice="plain">--no-wait-stdout</arg>
        <arg choice="plain">--wait-stdout</arg>
      </group>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--profile</arg>
      <arg>--putenv=<replaceable>var-name</replaceable>=[<replaceable>value</replaceable>]</arg>
      <arg>--quiet</arg>
      <arg>--timeout=<replaceable>msec</replaceable></arg>
      <arg>--unix2dos</arg>
      <arg>--unquoted-args</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req">-- <replaceable>program/arg0</replaceable> <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-start">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">start</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <arg>--exe=<replaceable>filename</replaceable></arg>
      <arg>--ignore-orphaned-processes</arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--profile</arg>
      <arg>--putenv=<replaceable>var-name</replaceable>=[<replaceable>value</replaceable>]</arg>
      <arg>--quiet</arg>
      <arg>--timeout=<replaceable>msec</replaceable></arg>
      <arg>--unquoted-args</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req">-- <replaceable>program/arg0</replaceable> <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-copyfrom">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">copyfrom</arg>
      <arg>--dereference</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--no-replace</arg>
      <arg>--recursive</arg>
      <arg>--target-directory=<replaceable>host-destination-dir</replaceable></arg>
      <arg>--update</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req"><replaceable>guest-source0</replaceable></arg>
      <arg choice="plain"><replaceable>guest-source1</replaceable> [...]</arg>
      <arg choice="req"><replaceable>host-destination</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-copyto">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">copyto</arg>
      <arg>--dereference</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--no-replace</arg>
      <arg>--recursive</arg>
      <arg>--target-directory=<replaceable>guest-destination-dir</replaceable></arg>
      <arg>--update</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req"><replaceable>host-source0</replaceable></arg>
      <arg choice="plain"><replaceable>host-source1</replaceable> [...]</arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mkdir">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">mkdir</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <arg>--mode=<replaceable>mode</replaceable></arg>
      <arg>--parents</arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-rmdir">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">rmdir</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--recursive</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-rm">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">rm</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <arg>--force</arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req" rep="repeat"><replaceable>guest-directory</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mv">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">mv</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req" rep="repeat"><replaceable>source</replaceable></arg>
      <arg choice="req"><replaceable>destination-directory</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-mktemp">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">mktemp</arg>
      <arg>--directory</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <arg>--mode=<replaceable>mode</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--secure</arg>
      <arg>--tmpdir=<replaceable>directory-name</replaceable></arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req"><replaceable>template-name</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-stat">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">stat</arg>
      <arg>--domain=<replaceable>domainname</replaceable></arg>
      <group>
        <arg choice="plain">--passwordfile=<replaceable>password-file</replaceable></arg>
        <arg choice="plain">--password=<replaceable>password</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--username=<replaceable>username</replaceable></arg>
      <arg>--verbose</arg>
      <arg choice="req"><replaceable>filename</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-list">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">list</arg>
      <group choice="req">
        <arg choice="plain">all</arg>
        <arg choice="plain">files</arg>
        <arg choice="plain">processes</arg>
        <arg choice="plain">sessions</arg>
      </group>
      <arg>--quiet</arg>
      <arg>--verbose</arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-closeprocess">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">closeprocess</arg>
      <group>
        <arg choice="plain">--session-id=<replaceable>ID</replaceable></arg>
        <arg choice="plain">--session-name=<replaceable>name-or-pattern</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--verbose</arg>
      <arg choice="req" rep="repeat"><replaceable>PID</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-closesession">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">closesession</arg>
      <group>
        <arg choice="plain">--all</arg>
        <arg choice="plain">--session-id=<replaceable>ID</replaceable></arg>
        <arg choice="plain">--session-name=<replaceable>name-or-pattern</replaceable></arg>
      </group>
      <arg>--quiet</arg>
      <arg>--verbose</arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-updatega">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">updatega</arg>
      <arg>--quiet</arg>
      <arg>--verbose</arg>
      <arg>--source=<replaceable>guest-additions.ISO</replaceable></arg>
      <arg>--wait-start</arg>
      <arg>-- <arg rep="repeat"><replaceable>argument</replaceable></arg></arg>
    </cmdsynopsis>

    <cmdsynopsis id="synopsis-vboxmanage-guestcontrol-watch">
      <command>VBoxManage guestcontrol</command>
      <group choice="req">
        <arg choice="plain"><replaceable>uuid</replaceable></arg>
        <arg choice="plain"><replaceable>vmname</replaceable></arg>
      </group>
      <arg choice="plain">watch</arg>
      <arg>--quiet</arg>
      <arg>--verbose</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      The <command>VBoxManage guestcontrol</command> command enables you
      to control a guest (VM) from the host system. See
      <xref linkend="guestadd-guestcontrol" />.
    </para>
    <refsect2>
      <title>Common Options and Operands</title>
      <para>
        The following options can be used by any of the
        <command>VBoxManage guestcontrol</command> subcommands:
      </para>
      <variablelist>
        <varlistentry>
          <term><replaceable>uuid</replaceable>|<replaceable>vmname</replaceable></term>
          <listitem><para>
              Specifies the Universally Unique Identifier (UUID) or name
              of the VM.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--quiet</option></term>
          <listitem><para>
              Specifies that the command produce quieter output.
            </para><para>
              The short form of this option is <option>-q</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--verbose</option></term>
          <listitem><para>
              Specifies that the command produce more detailed output.
            </para><para>
              The short form of this option is <option>-v</option>.
            </para></listitem>
        </varlistentry>
      </variablelist>
      <para>
        Some of the <command>VBoxManage guestcontrol</command>
        subcommands require that you provide guest credentials for
        authentication. The subcommands are:
        <command>copyfrom</command>, <command>copyto</command>,
        <command>mkdir</command>, <command>mktemp</command>,
        <command>mv</command>, <command>rmdir</command>,
        <command>rm</command>, <command>run</command>,
        <command>start</command>, and <command>stat</command>.
      </para>
      <para>
        While you cannot perform anonymous executions, a user account
        password is optional and depends on the guest's OS security
        policy. If a user account does not have an associated password,
        specify an empty password. On OSes such as Windows, you might
        need to adjust the security policy to permit user accounts with
        an empty password. In additional, global domain rules might
        apply and therefore cannot be changed.
      </para>
      <para>
        The following options are used for authentication on the guest
        VM:
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--domain=<replaceable>domainname</replaceable></option></term>
          <listitem><para>
              Specifies the user domain for Windows guest VMs.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--password=<replaceable>password</replaceable></option></term>
          <listitem><para>
              Specifies the password for the specified user. If you do
              not specify a password on the command line or if the
              password file is empty, the specified user needs to have
              an empty password.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--passwordfile=<replaceable>filename</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path to a file on the guest OS that
              contains the password for the specified user. If the
              password file is empty or if you do not specify a password
              on the command line, the specified user needs to have an
              empty password.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--username=<replaceable>username</replaceable></option></term>
          <listitem><para>
              Specifies an existing user on the guest OS that runs the
              process. If unspecified, the host user runs the process.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2>
      <title>Guest Process Restrictions</title>
      <para>
        By default, you can run up to five guest processes
        simultaneously. If a new guest process starts and would exceed
        this limit, the oldest not-running guest process is discarded to
        run the new process. You cannot retrieve output from a discarded
        guest process. If all five guest processes are active and
        running, attempting to start a new guest process fails.
      </para>
      <para>
        You can modify the guest process execution limit in two ways:
      </para>
      <itemizedlist>
        <listitem><para>
            Use the <command>VBoxManage setproperty</command> command to
            update the
            <literal>/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept</literal>
            guest property value.
          </para></listitem>
        <listitem><para>
            Use the <command>VBoxService</command> command and specify
            the
            <option>--control-procs-max-kept=<replaceable>value</replaceable></option>
            option.
          </para></listitem>
      </itemizedlist>
      <para>
        After you change the limit, you must restart the guest OS.
      </para>
      <para>
        You can serve an unlimited number guest processes by specifing a
        value of <literal>0</literal>, however this action is not
        recommended.
      </para>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-run">
      <title>Run a Command on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> run</command> command enables
        you to execute a program on the guest VM. Standard input,
        standard output, and standard error are redirected from the VM
        to the host system until the program completes.
      </para>
      <note>
        <para>
          The Windows OS imposes certain limitations for graphical
          applications. See <xref linkend="KnownIssues" />.
        </para>
      </note>
      <variablelist>
        <varlistentry>
          <term><option>--exe=<replaceable>path-to-executable</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path of the executable program to
              run on the guest VM. For example:
              <filename>C:\Windows\System32\calc.exe</filename>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--timeout=<replaceable>msec</replaceable></option></term>
          <listitem><para>
              Specifies the maximum amount of time, in milliseconds,
              that the program can run. While the program runs,
              <command>VBoxManage</command> receives its output.
            </para><para>
              If you do not specify a timeout value,
              <command>VBoxManage</command> waits indefinitely for the
              process to end, or for an error to occur.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option></term>
          <listitem><para>
              Sets, modifies, and unsets environment variables in the
              guest VM environment.
            </para><para>
              When you create a guest process, it runs with the default
              standard guest OS environment. Use this option to modify
              environment variables in that default environment.
            </para><para>
              Use the
              <option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option>
              option to set or modify the environment variable specified
              by <replaceable>NAME</replaceable>.
            </para><para>
              Use the
              <option>--putenv=<replaceable>NAME</replaceable>=[<replaceable>value</replaceable>]</option>
              option to unset the environment variable specified by
              <replaceable>NAME</replaceable>.
            </para><para>
              Ensure that any environment variable name or value that
              includes spaces is enclosed by quotes.
            </para><para>
              Specify a <option>--putenv</option> option for each
              environment variable that you want to modify.
            </para><para>
              The short form of this option is <option>-E</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--unquoted-args</option></term>
          <listitem><para>
              Disables the escaped double quoting of arguments that you
              pass to the program. For example,
              <literal>\"fred\"</literal>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--ignore-orphaned-processes</option></term>
          <listitem><para>
              Ignores orphaned processes. Not yet implemented.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--profile</option></term>
          <listitem><para>
              Uses a shell profile to specify the environment to use.
              Not yet implemented.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--no-wait-stdout</option></term>
          <listitem><para>
              Does not wait for the guest process to end or receive its
              exit code and any failure explanation.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--wait-stdout</option></term>
          <listitem><para>
              Waits for the guest process to end to receive its exit
              code and any failure explanation. The
              <command>VBoxManage</command> command receives the
              standard output of the guest process while the process
              runs.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--no-wait-stderr</option></term>
          <listitem><para>
              Does not wait for the guest process to end to receive its
              exit code, error messages, and flags.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--wait-stderr</option></term>
          <listitem><para>
              Waits for the guest process to end to receive its exit
              code, error messages, and flags. The
              <command>VBoxManage</command> command receives the
              standard error of the guest process while the process
              runs.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--dos2unix</option></term>
          <listitem><para>
              Transform DOS or Windows guest output to UNIX or Linux
              output. This transformation changes CR + LF line endings
              to LF. Not yet implemented.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--unix2dos</option></term>
          <listitem><para>
              Transform UNIX or Linux guest output to DOS or Windows
              output. This transformation changes LF line endings to CR
              + LF.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-- <replaceable>program/arg0</replaceable> [<replaceable>argument</replaceable>...]</option></term>
          <listitem><para>
              Specifies the name of the program and any arguments to
              pass to the program.
            </para><para>
              Ensure that any command argument that includes spaces is
              enclosed by quotes.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-start">
      <title>Start a Command on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> start</command> command
        enables you to execute a guest program until it completes.
      </para>
      <note>
        <para>
          The Windows OS imposes certain limitations for graphical
          applications. See <xref linkend="KnownIssues" />.
        </para>
      </note>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-copyfrom">
      <title>Copy a file from the guest to the host.</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> copyfrom</command> command
        enables you to copy a file from the guest VM to the host system.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--dereference</option></term>
          <listitem><para>
              Enables following of symbolic links on the guest file
              system.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--no-replace</option></term>
          <listitem><para>
              Only copies a file if it does not exist on the host yet.
            </para><para>
              The short form of this option is <option>-n</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--recursive</option></term>
          <listitem><para>
              Recursively copies files and directories from the
              specified guest directory to the host.
            </para><para>
              The short form of this option is <option>-R</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--target-directory=<replaceable>host-dst-dir</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path of the destination directory
              on the host system. For example,
              <filename>C:\Temp</filename>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--update</option></term>
          <listitem><para>
              Only copies a file if the guest file is newer than on the host.
            </para><para>
              The short form of this option is <option>-u</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>guest-source0</replaceable> [<replaceable>guest-source1</replaceable> [...]]</literal></term>
          <listitem><para>
              Specifies the absolute path of one or more files to copy
              from the guest VM. For example,
              <filename>C:\Windows\System32\calc.exe</filename>. You can
              use wildcards to specify multiple files. For example,
              <filename>C:\Windows\System*\*.dll</filename>.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-copyto">
      <title>Copy a file from the host to the guest.</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> copyto</command> command
        enables you to copy a file from the host system to the guest VM.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--dereference</option></term>
          <listitem><para>
              Enables following of symbolic links on the host system.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--no-replace</option></term>
          <listitem><para>
              Only copies a file if it does not exist on the guest yet.
            </para><para>
              The short form of this option is <option>-n</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--recursive</option></term>
          <listitem><para>
              Recursively copies files and directories from the
              specified host directory to the guest.
            </para><para>
              The short form of this option is <option>-R</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--target-directory=<replaceable>guest-dst-dir</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path of the destination directory
              on the guest. For example,
              <filename>/home/myuser/fromhost</filename>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--update</option></term>
          <listitem><para>
              Only copies a file if the host file is newer than on the guest.
            </para><para>
              The short form of this option is <option>-u</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>host-source0</replaceable> [<replaceable>host-source1</replaceable> [...]]</literal></term>
          <listitem><para>
              Specifies the absolute path of a file to
              copy from the host system. For example,
              <filename>C:\Windows\System32\calc.exe</filename>. You can
              use wildcards to specify multiple files. For example,
              <filename>C:\Windows\System*\*.dll</filename>.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-mkdir">
      <title>Create a directory on the guest.</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> mkdir</command> command
        enables you to create one or more directories on the guest VM.
      </para>
      <para>
        Alternate forms of this subcommand are <command>md</command>,
        <command>createdir</command>, and
        <command>createdirectory</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--parents</option></term>
          <listitem><para>
              Creates any of the missing parent directories of the
              specified directory.
            </para><para>
              For example, if you attempt to create the
              <filename>D:\Foo\Bar</filename> directory and the
              <filename>D:\Foo</filename> directory does not exist,
              using the <option>--parents</option> creates the missing
              <filename>D:\Foo</filename> directory. However, if you
              attempt to create the <filename>D:\Foo\Bar</filename> and
              do not specify the <option>--parents</option> option, the
              command fails.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--mode=<replaceable>mode</replaceable></option></term>
          <listitem><para>
              Specifies the permission mode to use for the specified
              directory. If you specify the <option>--parents</option>
              option, the mode is used for the associated parent
              directories, as well. <replaceable>mode</replaceable> is a
              four-digit octal mode such as <literal>0755</literal>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>guest-dir</replaceable> [<replaceable>guest-dir</replaceable>...]</literal></term>
          <listitem><para>
              Specifies an absolute path of one or more directories to
              create on the guest VM. For example,
              <filename>D:\Foo\Bar</filename>.
            </para><para>
              If all of the associated parent directories do not exist
              on the guest VM, you must specify the
              <option>--parents</option> option.
            </para><para>
              You must have sufficient rights on the guest VM to create
              the specified directory and its parent directories.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-rmdir">
      <title>Remove a directory from the guest.</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> rmdir</command> command
        enables you to delete the specified directory from the guest VM.
      </para>
      <para>
        Alternate forms of this subcommand are
        <command>removedir</command> and
        <command>removedirectory</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--recursive</option></term>
          <listitem><para>
              Recursively removes directories from the specified from
              the guest VM.
            </para><para>
              The short form of this option is <option>-R</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>guest-dir</replaceable> [<replaceable>guest-dir</replaceable>...]</literal></term>
          <listitem><para>
              Specifies an absolute path of one or more directories to
              remove from the guest VM. You can use wildcards to specify
              the directory names. For example,
              <filename>D:\Foo\*Bar</filename>.
            </para><para>
              You must have sufficient rights on the guest VM to remove
              the specified directory and its parent directories.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-rm">
      <title>Remove a file from the guest.</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> rm</command> command enables
        you to delete the specified files from the guest VM.
      </para>
      <para>
        The alternate form of this subcommand is
        <command>removefile</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--force</option></term>
          <listitem><para>
              Forces the operation and overrides any confirmation
              requests.
            </para><para>
              The short form of this option is <option>-f</option>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>guest-file</replaceable> [<replaceable>guest-file</replaceable>...]</literal></term>
          <listitem><para>
              Specifies an absolute path of one or more file to remove
              from the guest VM. You can use wildcards to specify the
              file names. For example,
              <filename>D:\Foo\Bar\text*.txt</filename>.
            </para><para>
              You must have sufficient rights on the guest VM to remove
              the specified file.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-mv">
      <title>Rename a file or Directory on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> mv</command> command enables
        you to rename files and directories on the guest VM.
      </para>
      <para>
        Alternate forms of this subcommand are <command>move</command>,
        <command>ren</command>, and <command>rename</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><literal><replaceable>guest-source</replaceable> [<replaceable>guest-source</replaceable>...]</literal></term>
          <listitem><para>
              Specifies an absolute path of a file or a single directory
              to move or rename on the guest VM. You can use wildcards
              to specify the file names.
            </para><para>
              You must have sufficient rights on the guest VM to access
              the specified file or directory.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><replaceable>dest</replaceable></term>
          <listitem><para>
              Specifies the absolute path of the renamed file or
              directory, or the destination directory to which to move
              the files. If you move only one file,
              <replaceable>dest</replaceable> can be a file or a
              directory, otherwise <replaceable>dest</replaceable> must
              be a directory.
            </para><para>
              You must have sufficient rights on the guest VM to access
              the destination file or directory.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-mktemp">
      <title>Create a Temporary File or Directory on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> mktemp</command> command
        enables you to create a temporary file or temporary directory on
        the guest VM. You can use this command to assist with the
        subsequent copying of files from the host system to the guest
        VM. By default, this command creates the file or directory in
        the guest VM's platform-specific <filename>temp</filename>
        directory.
      </para>
      <para>
        Alternate forms of this subcommand are
        <command>createtemp</command> and
        <command>createtemporary</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--directory</option></term>
          <listitem><para>
              Creates a temporary directory that is specified by the
              <replaceable>template</replaceable> operand.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--secure</option></term>
          <listitem><para>
              Enforces secure file and directory creation by setting the
              permission mode to <literal>0755</literal>. Any operation
              that cannot be performed securely fails.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--mode=<replaceable>mode</replaceable></option></term>
          <listitem><para>
              Specifies the permission mode to use for the specified
              directory. <replaceable>mode</replaceable> is a four-digit
              octal mode such as <literal>0755</literal>.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--tmpdir=<replaceable>directory</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path of the directory on the guest
              VM in which to create the specified file or directory. If
              unspecified, <replaceable>directory</replaceable> is the
              platform-specific <filename>temp</filename> directory.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><replaceable>template</replaceable></term>
          <listitem><para>
              Specifies a template file name for the temporary file,
              without a directory path. The template file name must
              contain at least one sequence of three consecutive X
              characters, or must end in X.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-stat">
      <title>Show a file or File System Status on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> stat</command> command enables
        you to show the status of files or file systems on the guest VM.
      </para>
      <variablelist>
        <varlistentry>
          <term><literal><replaceable>file</replaceable> [<replaceable>file</replaceable> ...]</literal></term>
          <listitem><para>
              Specifies an absolute path of a file or file system on the
              guest VM. For example,
              <filename>/home/foo/a.out</filename>.
            </para><para>
              You must have sufficient rights on the guest VM to access
              the specified files or file systems.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-list">
      <title>List the Configuration and Status Information for a Guest Virtual
        Machine</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> list</command> command enables
        you to list guest control configuration and status information.
        For example, the output shows open guest sessions, guest
        processes, and files.
      </para>
      <variablelist>
        <varlistentry>
          <term><literal>all</literal>|<literal>sessions</literal>|<literal>processes</literal>|<literal>files</literal></term>
          <listitem><para>
              Indicates the type of information to show.
              <literal>all</literal> shows all available data,
              <literal>sessions</literal> shows guest sessions,
              <literal>processes</literal> shows processes, and
              <literal>files</literal> shows files.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-closeprocess">
      <title>Terminate a Process in a guest Session</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> closeprocess</command> command
        enables you to terminate a guest process that runs in a guest
        session. Specify the process by using a process identifier (PID)
        and the session by using the session ID or name.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--session-id=<replaceable>ID</replaceable></option></term>
          <listitem><para>
              Specifies the ID of the guest session.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--session-name=<replaceable>name</replaceable>|<replaceable>pattern</replaceable></option></term>
          <listitem><para>
              Specifies the name of the guest session. Use a pattern
              that contains wildcards to specify multiple sessions.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><literal><replaceable>PID</replaceable> [<replaceable>PID</replaceable> ...]</literal></term>
          <listitem><para>
              Specifies the list of PIDs of guest processes to
              terminate.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-closesession">
      <title>Close a guest Session</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> closesession</command> command
        enables you to close a guest session. Specify the guest session
        either by session ID or by name.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--session-id=<replaceable>ID</replaceable></option></term>
          <listitem><para>
              Specifies the ID of the guest session.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--session-name=<replaceable>name</replaceable>|<replaceable>pattern</replaceable></option></term>
          <listitem><para>
              Specifies the name of the guest session. Use a pattern
              that contains wildcards to specify multiple sessions.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--all</option></term>
          <listitem><para>
              Closes all guest sessions.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-updatega">
      <title>Update the Guest Additions Software on the guest</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> updatega</command> command
        enables you to update the Guest Additions software installed in
        the specified guest VM.
      </para>
      <para>
        Alternate forms of this subcommand are
        <command>updateadditions</command> and
        <command>updateguestadditions</command>.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--source=<replaceable>new-iso-path</replaceable></option></term>
          <listitem><para>
              Specifies the absolute path of the Guest Additions update
              <filename>.ISO</filename> file on the guest VM.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--reboot</option></term>
          <listitem><para>
              Automatically reboots the guest after a successful Guest Additions
              update.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--timeout=<replaceable>ms</replaceable></option></term>
          <listitem><para>
              Sets the timeout (in ms) to wait for the overall Guest Additions update
              to complete. By default no timeout is being used.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--verify</option></term>
          <listitem><para>
              Verifies whether the Guest Additions were updated successfully after
              a successful installation. A guest reboot is mandatory.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--wait-ready</option></term>
          <listitem><para>
              Waits for the current Guest Additions being ready to handle the
              Guest Additions update.
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><option>--wait-start</option></term>
          <listitem><para>
              Starts the <command>VBoxManage</command> update process on
              the guest VM and then waits for the Guest Additions update
              to begin before terminating the
              <command>VBoxManage</command> process.
            </para><para>
              By default, the <command>VBoxManage</command> command
              waits for the Guest Additions update to complete before it
              terminates. Use this option when a running
              <command>VBoxManage</command> process affects the
              interaction between the installer and the guest OS.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-- <replaceable>argument</replaceable> [<replaceable>argument</replaceable> ...]</option></term>
          <listitem><para>
              Specifies optional command-line arguments to pass to the
              Guest Additions updater. You might use the
              <option>--</option> option to pass the appropriate updater
              arguments to retrofit features that are not yet installed.
            </para><para>
              Ensure that any command argument that includes spaces is
              enclosed by quotes.
            </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-waitrunlevel">
      <title>Wait for a guest run level</title>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> waitrunlevel</command> command
        enables you to wait for a guest run level being reached.
      </para>
      <variablelist>
        <varlistentry>
          <term><option>--timeout=<replaceable>ms</replaceable></option></term>
          <listitem><para>
              Sets the timeout (in ms) to wait for reaching the run level.
              By default no timeout is being used.
            </para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option><replaceable>system</replaceable>|<replaceable>userland</replaceable>|<replaceable>desktop</replaceable></option></term>
          <listitem><para>
            Specifies the run level to wait for.
          </para></listitem>
        </varlistentry>
      </variablelist>
    </refsect2>
    <refsect2 id="vboxmanage-guestcontrol-watch">
      <title>Show Current Guest Control Activity</title>
      <remark role="help-copy-synopsis"/>
      <para>
        The <command>VBoxManage guestcontrol
        <replaceable>vmname</replaceable> watch</command> command
        enables you to show current guest control activity.
      </para>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <remark role="help-scope" condition="GLOBAL"/>
    <para>
      The following <command>VBoxManage guestcontrol run</command>
      command executes the <command>ls -l /usr</command> command on the
      <literal>My OL VM</literal> Oracle Linux VM as the
      <literal>user1</literal> user.
    </para>
<screen>
$ VBoxManage --nologo guestcontrol "My OL VM" run --exe "/bin/ls" \
--username user1 --passwordfile pw.txt --wait-stdout -- -l /usr
</screen>
    <para>
      The <option>--exe</option> option specifies the absolute path of
      the command to run in the guest VM, <filename>/bin/ls</filename>.
      Use the <option>--</option> option to pass any arguments that
      follow it to the <command>ls</command> command.
    </para>
    <para>
      Use the <option>--username</option> option to specify the user
      name, <literal>user1</literal> and use the
      <option>--passwordfile</option> option to specify the name of a
      file that includes the password for the <literal>user1</literal>
      user, <filename>pw.txt</filename>.
    </para>
    <para>
      The <option>--wait-stdout</option> option waits for the
      <command>ls</command> guest process to complete before providing
      the exit code and the command output. The
      <option>--nologo</option> option suppresses the output of the logo
      information.
    </para>
    <para>
      The following <command>VBoxManage guestcontrol run</command>
      command executes the <command>ipconfig</command> command on the
      <literal>My Win VM</literal> Windows VM as the
      <literal>user1</literal> user. Standard input, standard output,
      and standard error are redirected from the VM to the host system
      until the program completes.
    </para>
<screen>
$ VBoxManage --nologo guestcontrol "My Win VM" run \
--exe "c:\\windows\\system32\\ipconfig.exe" \
--username user1 --passwordfile pw.txt --wait-stdout
</screen>
    <para>
      The <option>--exe</option> specifies the absolute path of command
      to run in the guest VM,
      <filename>c:\windows\system32\ipconfig.exe</filename>. The double
      backslashes shown in this example are required only on UNIX host
      systems.
    </para>
    <para>
      Use the <option>--username</option> option to specify the user
      name, <literal>user1</literal> and use the
      <option>--passwordfile</option> option to specify the name of a
      file that includes the password for the <literal>user1</literal>
      user, <filename>pw.txt</filename>.
    </para>
    <para>
      The <option>--wait-stdout</option> option waits for the
      <command>ls</command> guest process to complete before providing
      the exit code and the command output. The
      <option>--nologo</option> option to suppress the output of the
      logo information.
    </para>
    <para>
      The following <command>VBoxManage guestcontrol start</command>
      command executes the <command>ls -l /usr</command> command on the
      <literal>My OL VM</literal> Oracle Linux VM until the program
      completes.
    </para>
<screen>
$ VBoxManage --nologo guestcontrol "My Win VM" start \
--exe "c:\\windows\\system32\\ipconfig.exe" \
--username user1 --passwordfile pw.txt --wait-stdout
</screen>
  </refsect1>
</refentry>