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
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (C) 2006-2023 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 chapter 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;
]>
<chapter id="Introduction">
<title>First Steps</title>
<para>
Welcome to &product-name;.
</para>
<para>
&product-name; is a cross-platform virtualization application. What
does that mean? For one thing, it installs on your existing Intel or
AMD-based computers, whether they are running Windows, macOS, Linux,
or Oracle Solaris operating systems (OSes). Secondly, it extends the
capabilities of your existing computer so that it can run multiple
OSes, inside multiple virtual machines, at the same time. As an
example, you can run Windows and Linux on your Mac, run Windows
Server on your Linux server, run Linux on your Windows PC, and so
on, all alongside your existing applications. You can install and
run as many virtual machines as you like. The only practical limits
are disk space and memory.
</para>
<para>
&product-name; is deceptively simple yet also very powerful. It can
run everywhere from small embedded systems or desktop class machines
all the way up to datacenter deployments and even Cloud
environments.
</para>
<para>
The following screenshot shows how &product-name;, installed on an
Apple Mac computer, is running Windows Server 2016 in a virtual
machine window.
</para>
<figure id="fig-win2016-intro">
<title>Windows Server 2016 Virtual Machine, Displayed on a macOS Host</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/vm-vista-running.png"
width="14cm" />
</imageobject>
</mediaobject>
</figure>
<para>
In this User Manual, we will begin simply with a quick introduction
to virtualization and how to get your first virtual machine running
with the easy-to-use &product-name; graphical user interface.
Subsequent chapters will go into much more detail covering more
powerful tools and features, but fortunately, it is not necessary to
read the entire User Manual before you can use &product-name;.
</para>
<para>
You can find a summary of &product-name;'s capabilities in
<xref linkend="features-overview" />. For existing &product-name;
users who just want to find out what is new in this release, see the
<xref linkend="ChangeLog"/>.
</para>
<sect1 id="virt-why-useful">
<title>Why is Virtualization Useful?</title>
<para>
The techniques and features that &product-name; provides are
useful in the following scenarios:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Running multiple operating systems
simultaneously.</emphasis> &product-name; enables you to run
more than one OS at a time. This way, you can run software
written for one OS on another, such as Windows software on
Linux or a Mac, without having to reboot to use it. Since you
can configure what kinds of <emphasis>virtual</emphasis>
hardware should be presented to each such OS, you can install
an old OS such as DOS or OS/2 even if your real computer's
hardware is no longer supported by that OS.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Easier software
installations.</emphasis> Software vendors can use virtual
machines to ship entire software configurations. For example,
installing a complete mail server solution on a real machine
can be a tedious task. With &product-name;, such a complex
setup, often called an <emphasis>appliance</emphasis>, can be
packed into a virtual machine. Installing and running a mail
server becomes as easy as importing such an appliance into
&product-name;.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Testing and disaster
recovery.</emphasis> Once installed, a virtual machine and its
virtual hard disks can be considered a
<emphasis>container</emphasis> that can be arbitrarily frozen,
woken up, copied, backed up, and transported between hosts.
</para>
<para>
Using virtual machines enables you to build and test a
multi-node networked service, for example. Issues with
networking, operating system, and software configuration can
be investigated easily.
</para>
<para>
In addition to that, with the use of another &product-name;
feature called <emphasis>snapshots</emphasis>, one can save a
particular state of a virtual machine and revert back to that
state, if necessary. This way, one can freely experiment with
a computing environment. If something goes wrong, such as
problems after installing software or infecting the guest with
a virus, you can easily switch back to a previous snapshot and
avoid the need of frequent backups and restores.
</para>
<para>
Any number of snapshots can be created, allowing you to travel
back and forward in virtual machine time. You can delete
snapshots while a VM is running to reclaim disk space.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Infrastructure consolidation.</emphasis>
Virtualization can significantly reduce hardware and
electricity costs. Most of the time, computers today only use
a fraction of their potential power and run with low average
system loads. A lot of hardware resources as well as
electricity is thereby wasted. So, instead of running many
such physical computers that are only partially used, one can
pack many virtual machines onto a few powerful hosts and
balance the loads between them.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="virtintro">
<title>Some Terminology</title>
<para>
When dealing with virtualization, and also for understanding the
following chapters of this documentation, it helps to acquaint
oneself with a bit of crucial terminology, especially the
following terms:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Host operating system (host
OS).</emphasis> This is the OS of the physical computer on
which &product-name; was installed. There are versions of
&product-name; for Windows, macOS, Linux, and Oracle Solaris
hosts. See <xref linkend="hostossupport" />.
</para>
<para>
Most of the time, this manual discusses all &product-name;
versions together. There may be platform-specific differences
which we will point out where appropriate.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Guest operating system (guest
OS).</emphasis> This is the OS that is running inside the
virtual machine. Theoretically, &product-name; can run any x86
OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to
achieve near-native performance of the guest code on your
machine, we had to go through a lot of optimizations that are
specific to certain OSes. So while your favorite OS
<emphasis>may</emphasis> run as a guest, we officially support
and optimize for a select few, which include the most common
OSes.
</para>
<para>
See <xref linkend="guestossupport" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Virtual machine (VM).</emphasis> This is
the special environment that &product-name; creates for your
guest OS while it is running. In other words, you run your
guest OS <emphasis>in</emphasis> a VM. Normally, a VM is shown
as a window on your computer's desktop. Depending on which of
the various frontends of &product-name; you use, the VM might
be shown in full screen mode or remotely on another computer.
</para>
<para>
Internally, &product-name; treats a VM as a set of parameters
that specify its behavior. Some parameters describe hardware
settings, such as the amount of memory and number of CPUs
assigned. Other parameters describe the state information,
such as whether the VM is running or saved.
</para>
<para>
You can view these VM settings in &vbox-mgr;, in the
<emphasis role="bold">Settings</emphasis> window, and by
running the <command>VBoxManage</command> command. See
<xref linkend="vboxmanage" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Guest Additions.</emphasis> This refers
to special software packages which are shipped with
&product-name; but designed to be installed
<emphasis>inside</emphasis> a VM to improve performance of the
guest OS and to add extra features. See
<xref linkend="guestadditions" />.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="features-overview">
<title>Features Overview</title>
<para>
The following is a brief outline of &product-name;'s main
features:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Portability.</emphasis> &product-name;
runs on a large number of 64-bit host operating systems. See
<xref linkend="hostossupport" />.
</para>
<para>
&product-name; is a so-called <emphasis>hosted</emphasis>
hypervisor, sometimes referred to as a <emphasis>type
2</emphasis> hypervisor. Whereas a
<emphasis>bare-metal</emphasis> or <emphasis>type 1</emphasis>
hypervisor runs directly on the hardware, &product-name;
requires an existing OS to be installed. It can thus run
alongside existing applications on that host.
</para>
<para>
To a very large degree, &product-name; is functionally
identical on all of the host platforms, and the same file and
image formats are used. This enables you to run virtual
machines created on one host on another host with a different
host OS. For example, you can create a virtual machine on
Windows and then run it on Linux.
</para>
<para>
In addition, virtual machines can easily be imported and
exported using the Open Virtualization Format (OVF), an
industry standard created for this purpose. You can even
import OVFs that were created with a different virtualization
software. See <xref linkend="ovf" />.
</para>
<para>
For users of &oci; the functionality extends to exporting and
importing virtual machines to and from the cloud. This
simplifies development of applications and deployment to the
production environment. See
<xref linkend="cloud-export-oci"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Guest Additions: shared folders,
seamless windows, 3D virtualization.</emphasis> The
&product-name; Guest Additions are software packages which can
be installed <emphasis>inside</emphasis> of supported guest
systems to improve their performance and to provide additional
integration and communication with the host system. After
installing the Guest Additions, a virtual machine will support
automatic adjustment of video resolutions, seamless windows,
accelerated 3D graphics and more. See
<xref linkend="guestadditions" />.
</para>
<para>
In particular, Guest Additions provide for <emphasis>shared
folders</emphasis>, which let you access files on the host
system from within a guest machine. See
<xref linkend="sharedfolders" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Comprehensive hardware
support.</emphasis> Among other features, &product-name;
supports the following:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Guest multiprocessing
(SMP).</emphasis> &product-name; can present up to 32
virtual CPUs to each virtual machine, irrespective of how
many CPU cores are physically present on your host.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">USB device support.</emphasis>
&product-name; implements a virtual USB controller and
enables you to connect arbitrary USB devices to your
virtual machines without having to install device-specific
drivers on the host. USB support is not limited to certain
device categories. See <xref linkend="settings-usb" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Hardware compatibility.</emphasis>
&product-name; virtualizes a vast array of virtual
devices, among them many devices that are typically
provided by other virtualization platforms. That includes
IDE, SCSI, and SATA hard disk controllers, several virtual
network cards and sound cards, virtual serial
ports and an Input/Output Advanced Programmable Interrupt
Controller (I/O APIC), which is found in many computer
systems. This enables easy cloning of disk images from
real machines and importing of third-party virtual
machines into &product-name;.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Full ACPI support.</emphasis> The
Advanced Configuration and Power Interface (ACPI) is fully
supported by &product-name;. This enables easy cloning of
disk images from real machines or third-party virtual
machines into &product-name;. With its unique
<emphasis>ACPI power status support</emphasis>,
&product-name; can even report to ACPI-aware guest OSes
the power status of the host. For mobile systems running
on battery, the guest can thus enable energy saving and
notify the user of the remaining power, for example in
full screen modes.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Multiscreen resolutions.</emphasis>
&product-name; virtual machines support screen resolutions
many times that of a physical screen, allowing them to be
spread over a large number of screens attached to the host
system.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Built-in iSCSI support.</emphasis>
This unique feature enables you to connect a virtual
machine directly to an iSCSI storage server without going
through the host system. The VM accesses the iSCSI target
directly without the extra overhead that is required for
virtualizing hard disks in container files. See
<xref linkend="storage-iscsi" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">PXE Network boot.</emphasis> The
integrated virtual network cards of &product-name; fully
support remote booting using the Preboot Execution
Environment (PXE).
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Multigeneration branched
snapshots.</emphasis> &product-name; can save arbitrary
snapshots of the state of the virtual machine. You can go back
in time and revert the virtual machine to any such snapshot
and start an alternative VM configuration from there,
effectively creating a whole snapshot tree. See
<xref linkend="snapshots" />. You can create and delete
snapshots while the virtual machine is running.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">VM groups.</emphasis> &product-name;
provides a groups feature that enables the user to organize
and control virtual machines collectively, as well as
individually. In addition to basic groups, it is also possible
for any VM to be in more than one group, and for groups to be
nested in a hierarchy. This means you can have groups of
groups. In general, the operations that can be performed on
groups are the same as those that can be applied to individual
VMs: Start, Pause, Reset, Close (Save state, Send Shutdown,
Poweroff), Discard Saved State, Show in File System, Sort.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Clean architecture and unprecedented
modularity.</emphasis> &product-name; has an extremely modular
design with well-defined internal programming interfaces and a
clean separation of client and server code. This makes it easy
to control it from several interfaces at once. For example,
you can start a VM simply by clicking on a button in the
&product-name; graphical user interface and then control that
machine from the command line, or even remotely. See
<xref linkend="frontends" />.
</para>
<para>
Due to its modular architecture, &product-name; can also
expose its full functionality and configurability through a
comprehensive <emphasis role="bold">software development kit
(SDK),</emphasis> which enables integration of &product-name;
with other software systems. See
<xref linkend="VirtualBoxAPI" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Remote machine display.</emphasis> The
VirtualBox Remote Desktop Extension (VRDE) enables
high-performance remote access to any running virtual machine.
This extension supports the Remote Desktop Protocol (RDP)
originally built into Microsoft Windows, with special
additions for full client USB support.
</para>
<para>
The VRDE does not rely on the RDP server that is built into
Microsoft Windows. Instead, the VRDE is plugged directly into
the virtualization layer. As a result, it works with guest
OSes other than Windows, even in text mode, and does not
require application support in the virtual machine either. The
VRDE is described in detail in <xref linkend="vrde" />.
</para>
<para>
On top of this special capacity, &product-name; offers you
more unique features:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Extensible RDP
authentication.</emphasis> &product-name; already supports
Winlogon on Windows and PAM on Linux for RDP
authentication. In addition, it includes an easy-to-use
SDK which enables you to create arbitrary interfaces for
other methods of authentication. See
<xref linkend="vbox-auth" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">USB over RDP.</emphasis> Using RDP
virtual channel support, &product-name; also enables you
to connect arbitrary USB devices locally to a virtual
machine which is running remotely on an &product-name; RDP
server. See <xref linkend="usb-over-rdp" />.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="hostossupport">
<title>Supported Host Operating Systems</title>
<para>
Currently, &product-name; runs on the following host OSes:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Windows hosts (64-bit):</emphasis>
</para>
<itemizedlist>
<listitem>
<para>
Windows 8.1
</para>
</listitem>
<listitem>
<para>
Windows 10
</para>
</listitem>
<listitem>
<para>
Windows 11 21H2
</para>
</listitem>
<listitem>
<para>
Windows Server 2012
</para>
</listitem>
<listitem>
<para>
Windows Server 2012 R2
</para>
</listitem>
<listitem>
<para>
Windows Server 2016
</para>
</listitem>
<listitem>
<para>
Windows Server 2019
</para>
</listitem>
<listitem>
<para>
Windows Server 2022
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">macOS hosts (64-bit):</emphasis>
</para>
<itemizedlist>
<listitem>
<para>
10.15 (Catalina)
</para>
</listitem>
<listitem>
<para>
11 (Big Sur)
</para>
</listitem>
<listitem>
<para>
12 (Monterey)
</para>
</listitem>
</itemizedlist>
<para>
Intel hardware is required. See also
<xref linkend="KnownIssues" />.
</para>
<para>
An installer package is available for macOS/Arm64, for systems
using an Apple silicon CPU. With this package, you can run
some guest operating systems for Intel x86/x64 CPUs in an
emulation.
</para>
<para>
The macOS/Arm64 installer package for Apple silicon platform
is available as a Developer Preview release. This package
represents a work in progress project and the performance is
very modest.
</para>
<note>
<para>
Developer Preview is a public release for developers, which
provides early access to unsupported software release and
features.
</para>
</note>
</listitem>
<listitem>
<para>
<emphasis role="bold">Linux hosts (64-bit).</emphasis>
Includes the following:
</para>
<itemizedlist>
<listitem>
<para>
Ubuntu 18.04 LTS, 20.04 LTS and 22.04
</para>
</listitem>
<listitem>
<para>
Debian GNU/Linux 10 ("Buster") and 11 ("Bullseye")
</para>
</listitem>
<listitem>
<para>
Oracle Linux 7, 8 and 9
</para>
</listitem>
<listitem>
<para>
CentOS/Red Hat Enterprise Linux 7, 8 and 9
</para>
</listitem>
<listitem>
<para>
Fedora 35 and 36
</para>
</listitem>
<listitem>
<para>
Gentoo Linux
</para>
</listitem>
<listitem>
<para>
SUSE Linux Enterprise server 12 and 15
</para>
</listitem>
<listitem>
<para>
openSUSE Leap 15.3
</para>
</listitem>
</itemizedlist>
<para>
It should be possible to use &product-name; on most systems
based on Linux kernel 2.6, 3.x, 4.x or 5.x using either the
&product-name; installer or by doing a manual installation.
See <xref linkend="install-linux-host" />. However, the
formally tested and supported Linux distributions are those
for which we offer a dedicated package.
</para>
<para>
Note that Linux 2.4-based host OSes are no longer supported.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Oracle Solaris hosts (64-bit
only).</emphasis> The following versions are supported with
the restrictions listed in <xref linkend="KnownIssues" />:
</para>
<itemizedlist>
<listitem>
<para>
Oracle Solaris 11.4
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Note that any feature which is marked as
<emphasis>experimental</emphasis> is not supported. Feedback and
suggestions about such features are welcome.
</para>
<sect2 id="hostcpurequirements">
<title>Host CPU Requirements</title>
<para>
SSE2 (Streaming SIMD Extensions 2) support is required for host
CPUs.
</para>
</sect2>
</sect1>
<sect1 id="intro-installing">
<title>Installing &product-name; and Extension Packs</title>
<para>
&product-name; comes in many different packages, and installation
depends on your host OS. If you have installed software before,
installation should be straightforward. On each host platform,
&product-name; uses the installation method that is most common
and easy to use. If you run into trouble or have special
requirements, see <xref linkend="installation" /> for details
about the various installation methods.
</para>
<para>
&product-name; is split into the following components:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Base package.</emphasis> The base
package consists of all open source components and is licensed
under the GNU General Public License V3.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Extension packs.</emphasis> Additional
extension packs can be downloaded which extend the
functionality of the &product-name; base package. Currently,
Oracle provides a single extension pack, available from:
<ulink url="http://www.virtualbox.org" />. The extension pack
provides the following added functionality:
</para>
<itemizedlist>
<listitem>
<para>
VirtualBox Remote Desktop Protocol (VRDP) support. See
<xref linkend="vrde" />.
</para>
</listitem>
<listitem>
<para>
Host webcam passthrough. See
<xref linkend="webcam-passthrough" />.
</para>
</listitem>
<listitem>
<para>
Intel PXE boot ROM.
</para>
</listitem>
<!-- <listitem>
<para>
Experimental support for PCI passthrough on Linux hosts.
See <xref linkend="pcipassthrough" />.
</para>
</listitem>-->
<listitem>
<para>
Disk image encryption with AES algorithm. See
<xref linkend="diskencryption" />.
</para>
</listitem>
<listitem>
<para>
Cloud integration features. See
<xref linkend="cloud-integration"/>.
</para>
</listitem>
</itemizedlist>
<para>
For details of how to install an extension pack, see
<xref linkend="install-ext-pack"/>.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="intro-starting">
<title>Starting &product-name;</title>
<para>
After installation, you can start &product-name; as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Windows hosts.</emphasis> In the
<emphasis role="bold">Programs</emphasis> menu, click on the
item in the <emphasis role="bold">VirtualBox</emphasis> group.
On some Windows platforms, you can also enter
<command>VirtualBox</command> in the search box of the
<emphasis role="bold">Start</emphasis> menu.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">macOS hosts.</emphasis> In the Finder,
double-click on the
<emphasis role="bold">VirtualBox</emphasis> item in the
Applications folder. You may want to drag this item onto your
Dock.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Linux or Oracle Solaris
hosts</emphasis>. Depending on your desktop environment, an
&product-name; item may have been placed in either the System
or System Tools group of your
<emphasis role="bold">Applications</emphasis> menu.
Alternatively, you can enter <command>VirtualBox</command> in
a terminal window.
</para>
</listitem>
</itemizedlist>
<para>
When you start &product-name;, the &vbox-mgr; interface is shown.
See <xref linkend="gui-virtualboxmanager"/>.
</para>
</sect1>
<sect1 id="gui-virtualboxmanager">
<title>&vbox-mgr;</title>
<para>
&vbox-mgr; is the user interface for &product-name;. You can use
&vbox-mgr; to create, configure, and manage your virtual machines.
</para>
<para>
This section describes the main features of the &vbox-mgr; user
interface. Subsequent sections and chapters describe how to use
&vbox-mgr; to perform tasks in &product-name;.
</para>
<para>
When you start &product-name;, the
<emphasis role="bold">&vbox-mgr;</emphasis> window is displayed.
</para>
<para>
<xref linkend="fig-vbox-manager-initial"/> shows &vbox-mgr; the
first time you start &product-name;, before you have created any
virtual machines.
</para>
<figure id="fig-vbox-manager-initial">
<title>&vbox-mgr;, Showing Welcome Screen After Initial Startup</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/virtualbox-main-empty.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
<xref linkend="fig-vbox-manager-populated"/> shows how &vbox-mgr;
might look after you have created some virtual machines.
</para>
<figure id="fig-vbox-manager-populated">
<title>&vbox-mgr; Window, After Creating Virtual Machines</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/virtualbox-main.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The main components of the &vbox-mgr; window are as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">The machine list.</emphasis> The left
pane of the <emphasis role="bold">VirtualBox
Manager</emphasis> window lists all your virtual machines. If
you have not yet created any virtual machines, this list is
empty. See <xref linkend="gui-machine-list"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">The Details pane.</emphasis> The pane on
the right displays the properties of the currently selected
virtual machine. If you do not have any machines yet, the pane
displays a welcome message.
</para>
<para>
The toolbar buttons on the Details pane can be used to create
and work with virtual machines. See
<xref linkend="gui-details"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Help Viewer.</emphasis> A window that
displays context-sensitive help topics for &vbox-mgr; tasks.
See <xref linkend="help-viewer"/>.
</para>
</listitem>
</itemizedlist>
<sect2 id="gui-machine-list">
<title>The Machine List</title>
<para>
The list of virtual machines in the left pane is called the
<emphasis>machine list</emphasis>.
</para>
<para>
The following methods can be used to control and configure
virtual machines in the machine list:
</para>
<itemizedlist>
<listitem>
<para>
Right-click on the virtual machine name, to display menu
options.
</para>
</listitem>
<listitem>
<para>
Click on the Machine Tools menu, to the right of the virtual
machine name. See <xref linkend="gui-tools-machine"/>.
</para>
</listitem>
<listitem>
<para>
Click a button in the toolbar in the Details pane. See
<xref linkend="gui-details"/>.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="gui-details">
<title>The Details Pane</title>
<para>
The Details pane shows configuration information for a virtual
machine that is selected in the machine list. The pane also
includes a toolbar for performing tasks.
</para>
<figure id="fig-vbox-details-pane">
<title>&vbox-mgr; Details Pane, Including Toolbar</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/details-pane.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The Details pane includes the following:
</para>
<simplesect id="gui-details-toolbar">
<title>&vbox-mgr; Toolbar</title>
<para>
A toolbar at the top of the Details pane contains buttons that
enable you to configure the selected virtual machine, or to
create a new virtual machine.
</para>
<para>
The toolbar includes the following buttons:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">New.</emphasis> Creates a new
virtual machine, and adds it to the machine list.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Add.</emphasis> Adds an existing
virtual machine to the machine list.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Settings.</emphasis> Displays the
<emphasis role="bold">Settings</emphasis> window for the
virtual machine, enabling you to make configuration
changes.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Discard.</emphasis> For a running
virtual machine, discards the saved state for the virtual
machine and closes it down.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Show/Start.</emphasis> For a running
virtual machine, <emphasis role="bold">Show</emphasis>
displays the virtual machine window. For a stopped virtual
machine, <emphasis role="bold">Start</emphasis> displays
options for powering up the virtual machine.
</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect id="gui-details-settings">
<title>Settings</title>
<para>
A summary of settings is shown for the virtual machine.
</para>
<para>
You can change some virtual machine settings, by clicking on
the setting in the Details pane.
</para>
<note>
<para>
If a virtual machine is running, some settings cannot be
altered. You must stop the virtual machine first in order to
change the setting.
</para>
</note>
<para>
Virtual machine settings can also be changed using the
<emphasis role="bold">Settings</emphasis> button on the
&vbox-mgr; toolbar.
</para>
<para>
The virtual machine settings on the Details pane are organized
in sections that correspond to those used in the
<emphasis role="bold">Settings</emphasis> window. See
<xref linkend="BasicConcepts"/>.
</para>
<para>
Click the arrow icon to hide or show each section.
</para>
</simplesect>
<simplesect id="gui-details-preview">
<title>Preview Window</title>
<para>
The virtual machine display is shown in a small window.
</para>
<para>
You can use the Preview window to check if your virtual
machine has finished booting up.
</para>
<para>
Click the arrow icon to hide or show the Preview window.
</para>
</simplesect>
<simplesect id="gui-notification-center">
<title>Notification Center</title>
<para>
Notification messages may be shown in a sliding panel on the
right of the Details pane, called the
<emphasis role="bold">Notification Center</emphasis>. Click
the warning triangle to show the notification messages.
</para>
<para>
Most system messages that do not require user interaction are
displayed in the Notification Center, including task failure
alerts.
</para>
<para>
The progress of some tasks can be observed and stopped using
the Notification Center.
</para>
</simplesect>
</sect2>
<sect2 id="gui-tools">
<title>&vbox-mgr; Tools</title>
<para>
&vbox-mgr; provides two types of user tools, to enable you to
perform common tasks easily.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Global Tools.</emphasis> These tools
apply to <emphasis>all</emphasis> virtual machines. See
<xref linkend="gui-tools-global"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Machine Tools.</emphasis> These tools
apply to a <emphasis>specific</emphasis> virtual machine.
See <xref linkend="gui-tools-machine"/>.
</para>
</listitem>
</itemizedlist>
<simplesect id="gui-tools-global">
<title>Global Tools</title>
<para>
In the left pane of the &vbox-mgr; window, click the
<emphasis role="bold">Menu</emphasis> icon in the
<emphasis role="bold">Tools</emphasis> banner located above
the machine list. The <emphasis role="bold">Global
Tools</emphasis> menu is displayed.
</para>
<figure id="fig-global-tools-menu">
<title>Global Tools Menu</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/global-tools-menu.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
A drop-down list enables you to select from the following
global tools:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Welcome.</emphasis> Displays the
&vbox-mgr; welcome message. The &vbox-mgr; toolbar is also
included, to enable you to get started with using
&product-name;. See
<xref linkend="fig-vbox-manager-initial"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Extensions.</emphasis> Displays the
<emphasis role="bold">Extension Pack Manager</emphasis>
tool. This tool is used to install and uninstall
&product-name; Extension Packs. See
<xref linkend="install-ext-pack-manager"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Media.</emphasis> Displays the
<emphasis role="bold">Virtual Media Manager</emphasis>
tool. This tool is used to manage the disk images used by
&product-name;. See
<xref linkend="virtual-media-manager"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Network.</emphasis> Displays the
<emphasis role="bold">Network Manager</emphasis> tool.
This tool is used to create and configure some types of
networks used by &product-name;. See
<xref linkend="network-manager"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Cloud.</emphasis> Displays the
<emphasis role="bold">Cloud Profile Editor</emphasis>
tool. This tool is used to configure connections to a
cloud service, such as &oci;. See
<xref linkend="cloud-using-cloud-profile-manager"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Activities.</emphasis> Displays the
<emphasis role="bold">VM Activity Overview</emphasis>
tool. This tool is used to monitor performance and
resource usage of virtual machines. See
<xref linkend="vm-info"/>.
</para>
</listitem>
</itemizedlist>
<para>
The <emphasis role="bold">Pin</emphasis> icon is used to keep
the <emphasis role="bold">Tools</emphasis> banner visible as
you scroll down the entries in the machine list.
</para>
</simplesect>
<simplesect id="gui-tools-machine">
<title>Machine Tools</title>
<para>
In the machine list in the left pane of the &vbox-mgr; window,
select a virtual machine.
</para>
<para>
Click the <emphasis role="bold">Menu</emphasis> icon to the
right of the virtual machine name. The
<emphasis role="bold">Machine Tools</emphasis> menu is
displayed.
</para>
<figure id="fig-machine-tools-menu">
<title>Machine Tools Menu</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/machine-tools-menu.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
A drop-down list enables you to select from the following
machine tools:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Details.</emphasis> Displays the
Details pane for the selected virtual machine. See
<xref linkend="gui-details"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Snapshots.</emphasis> Displays the
<emphasis role="bold">Snapshots</emphasis> tool. This tool
enables you to view and manage snapshots for the virtual
machine. See <xref linkend="snapshots"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Logs.</emphasis> Displays the
<emphasis role="bold">Log Viewer</emphasis> tool. This
tool enables you to view and search system logs for the
virtual machine. See <xref linkend="log-viewer"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Activity.</emphasis> Displays the
<emphasis role="bold">VM Activity</emphasis> page of the
<emphasis role="bold">Session Information</emphasis>
dialog. This dialog enables you to view and analyze
performance metrics for the virtual machine. See
<xref linkend="vm-info"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">File Manager.</emphasis> Displays
the <emphasis role="bold">Guest Control File
Manager</emphasis> tool. This tool enables you to manage
files on the guest system. See
<xref linkend="guestadd-gc-file-manager"/>.
</para>
</listitem>
</itemizedlist>
</simplesect>
</sect2>
<sect2 id="help-viewer">
<title>Help Viewer</title>
<para>
The Help Viewer is a window that displays context-sensitive help
to assist you in completing common &vbox-mgr; tasks. You can
display the Help Viewer in the following ways:
</para>
<itemizedlist>
<listitem>
<para>
In a &vbox-mgr; wizard or dialog, click
<emphasis role="bold">Help</emphasis> to display the
relevant help topic.
</para>
</listitem>
<listitem>
<para>
In &vbox-mgr; or from a guest VM, do either of the
following:
</para>
<itemizedlist>
<listitem>
<para>
Select the <emphasis role="bold">Help</emphasis>,
<emphasis role="bold">Contents</emphasis> menu option.
</para>
</listitem>
<listitem>
<para>
Press the <emphasis role="bold">F1</emphasis> button.
</para>
<para>
The keyboard shortcut used to access the Help Viewer can
be configured in the
<emphasis role="bold">Preferences</emphasis> window.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
The Help Viewer has the following features:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Navigation tools.</emphasis> The left
hand pane contains the following navigation tools:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Contents.</emphasis> Displays the
help topic location in the &product-name; documentation.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Search.</emphasis> Enables you to
search the documentation for help topics.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Bookmarks.</emphasis> Enables you
to bookmark useful help topics.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Tabbed browsing.</emphasis> Help
topics that you have visited are displayed in tabs in the
main window pane.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Zoomable topics.</emphasis> Zoom
controls enable you to enlarge help topic details.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Printing.</emphasis> Help topics can
be printed to PDF file or to a local printer.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="vboxmanager-wizards">
<title>About &vbox-mgr; Wizards</title>
<para>
&vbox-mgr; includes wizards that enable you to complete tasks
easily. Examples of such tasks are when you create a new virtual
machine or use the cloud integration features of &product-name;.
</para>
<para>
To display a help topic for the wizard, click the
<emphasis role="bold">Help</emphasis> button.
</para>
<para>
Some wizards can be displayed in either of the following modes:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Guided mode.</emphasis> This is the
default display mode. Wizards are shown in the conventional
manner, using a series of pages with descriptions to guide
the user through the steps for a task.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"><emphasis role="bold">Expert
mode.</emphasis></emphasis> This display mode is designed
for more advanced users of &product-name;. All settings are
displayed on a single page, enabling quicker completion of
tasks.
</para>
</listitem>
</itemizedlist>
<para>
Click the button at the bottom of the wizard window to switch
between Guided mode and Expert mode.
</para>
</sect2>
</sect1>
<sect1 id="create-vm-wizard">
<title>Creating Your First Virtual Machine</title>
<para>
Click <emphasis role="bold">New</emphasis> in the VirtualBox
Manager window. The <emphasis role="bold">Create Virtual
Machine</emphasis> wizard is shown, to guide you through the
required steps for setting up a new virtual machine (VM).
</para>
<para>
The <emphasis role="bold">Create Virtual Machine</emphasis> wizard
pages are described in the following sections.
</para>
<sect2 id="create-vm-wizard-name-os">
<title>Create Virtual Machine Wizard: Name and Operating System</title>
<figure id="fig-create-vm-name">
<title>Creating a Virtual Machine: Name and Operating System</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/create-vm-1.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
Use this page to specify a name and operating system (OS) for
the virtual machine and to change the storage location used for
VMs.
</para>
<para>
You can also choose to disable the unattended guest operating
system install feature. See also
<xref linkend="create-vm-wizard-unattended-install"/>.
</para>
<para>
The following fields are available on this wizard page:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Name.</emphasis> A name for the new
VM. The name you enter is shown in the machine list of
&vbox-mgr; and is also used for the virtual machine's files
on disk.
</para>
<para>
Be sure to assign each VM an informative name that describes
the OS and software running on the VM. For example, a name
such as <literal>Windows 10 with Visio</literal>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Folder.</emphasis> The location where
VMs are stored on your computer, called the
<emphasis>machine folder</emphasis>. The default folder
location is shown.
</para>
<para>
Ensure that the folder location has enough free space,
especially if you intend to use the snapshots feature. See
also <xref linkend="vboxconfigdata-machine-folder"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">ISO Image.</emphasis> Select an ISO
image file. The image file can be used to install an OS on
the new virtual machine or it can be attached to a DVD drive
on the new virtual machine.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Type and Version.</emphasis> These
fields are used to select the OS that you want to install on
the new virtual machine.
</para>
<para>
The supported OSes are grouped into types. If you want to
install something very unusual that is not listed, select
the <emphasis role="bold">Other</emphasis> type. Depending
on your selection, &product-name; will enable or disable
certain VM settings that your guest OS may require. This is
particularly important for 64-bit guests. See
<xref linkend="intro-64bitguests" />. It is therefore
recommended to always set this field to the correct value.
</para>
<para>
If an ISO image is selected and &product-name; detects the
operating system for the ISO, the
<emphasis role="bold">Type</emphasis> and
<emphasis role="bold">Version</emphasis> fields are
populated automatically and are disabled.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Skip Unattended
Installation.</emphasis> Disables unattended guest OS
installation, even if an ISO image is selected that supports
unattended installation. In that case, the selected ISO
image is mounted automatically on the DVD drive of the new
virtual machine and user interaction is required to complete
the OS installation.
</para>
<para>
The unattended installation step in the wizard is skipped.
</para>
<note>
<para>
This option is disabled if you do not select an
installation medium in the <emphasis role="bold">ISO
Image</emphasis> field.
</para>
</note>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Next</emphasis> to go to the next
wizard page.
</para>
</sect2>
<sect2 id="create-vm-wizard-unattended-install">
<title>(Optional) Create Virtual Machine Wizard: Unattended Guest OS Install</title>
<para>
Unattended guest OS installation enables you to install the OS
on a virtual machine automatically.
</para>
<note>
<para>
This page is optional. It is not displayed if you have
selected the <emphasis role="bold">Skip Unattended
Installation</emphasis> option on the initial wizard page.
</para>
</note>
<para>
Use this page to set up the required parameters for unattended
guest OS installation and to configure automatic installation of
the &product-name; Guest Additions. See also
<xref linkend="create-vm-wizard-unattended-examples"/> for some
typical scenarios when using automated installation.
</para>
<figure id="fig-create-vm-unattended-install">
<title>Creating a Virtual Machine: Unattended Guest OS Installation</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/create-vm-2.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The following fields are available on this wizard page:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Username and Password.</emphasis>
Enter the credentials for a default user on the guest OS.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Guest Additions.</emphasis> Enables
automatic installation of the Guest Additions, following
installation of the guest OS. Use the drop-down list to
select the location of the ISO image file for the Guest
Additions.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Additional Options.</emphasis> The
following options enable you to perform extra configuration
of the guest OS:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Product Key.</emphasis> For
Windows guests only. Enter the product key required for
Windows installation.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Hostname.</emphasis> Host name for
the guest. By default, this is the same as the VM name.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Domain Name.</emphasis> Domain
name for the guest.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Install in Background.</emphasis>
Enable headless mode for the VM, where a graphical user
interface is not shown.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Next</emphasis> to go to the next
wizard page.
</para>
</sect2>
<sect2 id="create-vm-wizard-hardware">
<title>Create Virtual Machine Wizard: Hardware</title>
<para>
Use this page to configure hardware settings for the virtual
machine.
</para>
<figure id="fig-create-vm-hardware">
<title>Creating a Virtual Machine: Hardware</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/create-vm-3.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The following fields are available on this wizard page:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Base Memory.</emphasis> Select the
amount of RAM that &product-name; should allocate every time
the virtual machine is started. The amount of memory
selected here will be taken away from your host machine and
presented to the guest OS, which will report this size as
the virtual machines installed RAM.
</para>
<caution>
<para>
Choose this setting carefully. The memory you give to the
VM will not be available to your host OS while the VM is
running, so do not specify more than you can spare.
</para>
<para>
For example, if your host machine has 4 GB of RAM and you
enter 2048 MB as the amount of RAM for a particular
virtual machine, you will only have 2 GB left for all the
other software on your host while the VM is running. If
you run two VMs at the same time, even more memory will be
allocated for the second VM, which may not even be able to
start if that memory is not available.
</para>
<para>
On the other hand, you should specify as much as your
guest OS and your applications will require to run
properly. A guest OS may require at least 1 or 2 GB of
memory to install and boot up. For best performance, more
memory than that may be required.
</para>
</caution>
<para>
Always ensure that the host OS has enough RAM remaining. If
insufficient RAM remains, the system might excessively swap
memory to the hard disk, which effectively brings the host
system to a standstill.
</para>
<para>
As with other <emphasis role="bold">Create Virtual
Machine</emphasis> wizard settings, you can change this
setting later, after you have created the VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Processor(s).</emphasis> Select the
number of virtual processors to assign to the VM.
</para>
<para>
It is not advised to assign more than half of the total
processor threads from the host machine.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Enable EFI.</emphasis> Enables
Extensible Firware Interface (EFI) booting for the guest OS.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Next</emphasis> to go to the next
wizard page.
</para>
</sect2>
<sect2 id="create-vm-wizard-virtual-hard-disk">
<title>Create Virtual Machine Wizard: Virtual Hard Disk</title>
<para>
Use this page to specify a virtual hard disk for the virtual
machine.
</para>
<para>
There are many ways in which &product-name; can provide hard
disk space to a VM, see <xref linkend="storage" />. The most
common way is to use a large image file on your physical hard
disk, whose contents &product-name; presents to your VM as if it
were a complete hard disk. This file then represents an entire
hard disk, so you can even copy it to another host and use it
with another &product-name; installation.
</para>
<figure id="fig-create-vm-hard-disk">
<title>Creating a New Virtual Machine: Virtual Hard Disk</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/create-vm-4.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The following fields are available on this wizard page:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Create a Virtual Hard Disk
Now</emphasis>. Creates a new empty virtual hard disk image,
located in the VM's machine folder.
</para>
<para>
Enter the following settings:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Disk Size</emphasis>. Use the
slider to select a maximum size for the hard disk in the
new VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Pre-Allocate Full Size.</emphasis>
This setting determines the type of image file used for
the disk image. Select this setting to use a
<emphasis>fixed-size file</emphasis> for the disk image.
Deselect this setting to use a <emphasis>dynamically
allocated file</emphasis> for the disk image.
</para>
<para>
The different types of image file behave as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Dynamically allocated
file.</emphasis> This type of image file only grows
in size when the guest actually stores data on its
virtual hard disk. Therefore, this file is small
initially. As the drive is filled with data, the
file grows to the specified size.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Fixed-size file.</emphasis>
This type of image file immediately occupies the
file specified, even if only a fraction of that
virtual hard disk space is actually in use. While
occupying much more space, a fixed-size file incurs
less overhead and is therefore slightly faster than
a dynamically allocated file.
</para>
</listitem>
</itemizedlist>
<para>
For more details about the differences, see
<xref linkend="vdidetails" />.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Use an Existing Hard Disk
File.</emphasis> Enables you to select an
<emphasis>existing</emphasis> disk image file to use with
the new VM.
</para>
<para>
The drop-down list presented in the window lists all disk
images which are known by &product-name;. These disk images
are currently attached to a virtual machine, or have been
attached to a virtual machine.
</para>
<para>
Alternatively, click on the small folder icon next to the
drop-down list. In the <emphasis role="bold">Hard Disk
Selector</emphasis> window that is displayed, click
<emphasis role="bold">Add</emphasis> to select a disk image
file on your host disk.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Do Not Add a Virtual Hard
Disk.</emphasis> The new VM is created without a hard disk.
</para>
</listitem>
</itemizedlist>
<para>
To prevent your physical hard disk on the host OS from filling
up, &product-name; limits the size of the image file. But the
image file must be large enough to hold the contents of the
guest OS and the applications you want to install. For a Windows
or Linux guest, you will probably need several gigabytes for any
serious use. The limit of the image file size can be changed
later, see <xref linkend="vboxmanage-modifymedium"/>.
</para>
<note>
<para>
You can skip attaching a virtual hard disk file to the new
virtual machine you are creating. But you will then need to
attach an hard disk later on, in order to install a guest
operating system.
</para>
</note>
<para>
After having selected or created your image file, click
<emphasis role="bold">Next</emphasis> to go to the next wizard
page.
</para>
</sect2>
<sect2 id="create-vm-wizard-summary">
<title>Create Virtual Machine Wizard: Summary</title>
<para>
This page displays a summary of the configuration for the
virtual machine.
</para>
<para>
If you are not happy with any of the settings, use the
<emphasis role="bold">Back</emphasis> button to return to the
corresponding page and modify the setting.
</para>
<para>
Click <emphasis role="bold">Finish</emphasis> to create your new
virtual machine. The virtual machine is displayed in the machine
list on the left side of the &vbox-mgr; window, with the name
that you entered on the first page of the wizard.
</para>
</sect2>
<sect2 id="create-vm-wizard-unattended-examples">
<title>Some Examples of Unattended Installation</title>
<para>
To configure unattended installation, you typically just need to
specify an ISO image in the <emphasis role="bold">Create Virtual
Machine</emphasis> wizard. &product-name; then detects the OS
type and the unattended installation process is done
automatically when the wizard is completed. However, in some
situations the installation may need be completed manually.
</para>
<para>
The following list describes some common scenarios for
unattended installation:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">OS type is detected
automatically.</emphasis> The following outcomes are
possible:
</para>
<itemizedlist>
<listitem>
<para>
If unattended installation is supported for the selected
ISO, the guest OS is installed automatically. No user
input is required.
</para>
</listitem>
<listitem>
<para>
If unattended installation is not supported for the
selected ISO, the ISO image is inserted automatically
into the DVD drive of the new VM. The guest OS
installation must then be completed manually.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">OS type is not detected
automatically.</emphasis> You must configure
<emphasis role="bold">Type</emphasis> and
<emphasis role="bold">Version</emphasis> settings in the
wizard.
</para>
<para>
The ISO image is inserted automatically into the DVD drive
of the new VM. The guest OS installation must then be
completed manually.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Unattended Installation is
disabled.</emphasis> Users can disable unattended
installation, by selecting the <emphasis role="bold">Skip
Unattended Installation</emphasis> check box on the initial
wizard page.
</para>
<para>
The ISO image is inserted automatically into the DVD drive
of the new VM. The guest OS installation must then be
completed manually.
</para>
</listitem>
</itemizedlist>
<para>
See also <xref linkend="basic-unattended"/> for details of how
to perform unattended installation from the command line.
</para>
</sect2>
</sect1>
<sect1 id="intro-running">
<title>Running Your Virtual Machine</title>
<para>
To start a virtual machine, you have the following options:
</para>
<itemizedlist>
<listitem>
<para>
Double-click on the VM's entry in the machine list in
&vbox-mgr;.
</para>
</listitem>
<listitem>
<para>
Select the VM's entry in the machine list in &vbox-mgr;, and
click <emphasis role="bold">Start</emphasis> in the toolbar
the top of the window.
</para>
</listitem>
<listitem>
<para>
Go to the <filename>VirtualBox VMs</filename> folder in your
system user's home directory. Find the subdirectory of the
machine you want to start and double-click on the machine
settings file. This file has a <filename>.vbox</filename> file
extension.
</para>
</listitem>
</itemizedlist>
<para>
Starting a virtual machine displays a new window, and the virtual
machine which you selected will boot up. Everything which would
normally be seen on the virtual system's monitor is shown in the
window. See <xref linkend="fig-win2016-intro"/>.
</para>
<para>
In general, you can use the virtual machine as you would use a
real computer. The following topics describe a few points to note
when running a VM.
</para>
<sect2 id="intro-starting-vm-first-time">
<title>Starting a New VM for the First Time</title>
<para>
When you start a VM for the first time the OS installation
process is started automatically, using the ISO image file
specified in the <emphasis role="bold">Create Virtual
Machine</emphasis> wizard.
</para>
<para>
Follow the onscreen instructions to install your OS.
</para>
<!-- <para>
If you have physical CD or DVD media from which you want to
install your guest OS, such as a Windows installation CD or DVD,
put the media into your host's CD or DVD drive.
</para>
<para>
If you have downloaded installation media from the Internet in
the form of an ISO image file such as with a Linux distribution,
you could burn this file to an empty CD or DVD and proceed as
described above. With &product-name; however, you can skip this
step and mount the ISO file directly. &product-name; will then
present this file as a CD or DVD-ROM drive to the virtual
machine, much like it does with virtual hard disk images.
</para>-->
</sect2>
<sect2 id="keyb_mouse_normal">
<title>Capturing and Releasing Keyboard and Mouse</title>
<para>
&product-name; provides a virtual USB tablet device to new
virtual machines through which mouse events are communicated to
the guest OS. If you are running a modern guest OS that can
handle such devices, mouse support may work out of the box
without the mouse being <emphasis>captured</emphasis> as
described below. See <xref linkend="settings-motherboard" />.
</para>
<para>
Otherwise, if the virtual machine detects only standard PS/2
mouse and keyboard devices, since the OS in the virtual machine
does not know that it is not running on a real computer, it
expects to have exclusive control over your keyboard and mouse.
But unless you are running the VM in full screen mode, your VM
needs to share keyboard and mouse with other applications and
possibly other VMs on your host.
</para>
<para>
After installing a guest OS and before you install the Guest
Additions, described in <xref linkend="guestadditions"/>, either
your VM or the rest of your computer can
<emphasis>own</emphasis> the keyboard and the mouse. Both cannot
own the keyboard and mouse at the same time. You will see a
<emphasis>second</emphasis> mouse pointer which is always
confined to the limits of the VM window. You activate the VM by
clicking inside it.
</para>
<para>
To return ownership of keyboard and mouse to your host OS,
&product-name; reserves a special key on your keyboard: the
<emphasis>Host key</emphasis>. By default, this is the
<emphasis>right Ctrl key</emphasis> on your keyboard. On a Mac
host, the default Host key is the left Command key. You can
change this default using the Preferences window. See
<xref linkend="preferences" />. The current setting for the Host
key is always displayed at the bottom right of your VM window.
</para>
<figure id="fig-host-key">
<title>Host Key Setting on the Virtual Machine Taskbar</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/vm-hostkey.png"
width="7cm" />
</imageobject>
</mediaobject>
</figure>
<para>
This means the following:
</para>
<itemizedlist>
<listitem>
<para>
Your <emphasis role="bold">keyboard</emphasis> is owned by
the VM if the VM window on your host desktop has the
keyboard focus. If you have many windows open in your guest
OS, the window that has the focus in your VM is used. This
means that if you want to enter text within your VM, click
on the title bar of your VM window first.
</para>
<para>
To release keyboard ownership, press the Host key. As
explained above, this is typically the right Ctrl key.
</para>
<para>
Note that while the VM owns the keyboard, some key
sequences, such as Alt+Tab, will no longer be seen by the
host, but will go to the guest instead. After you press the
Host key to reenable the host keyboard, all key presses will
go through the host again, so that sequences such as Alt+Tab
will no longer reach the guest. For technical reasons it may
not be possible for the VM to get all keyboard input even
when it does own the keyboard. Examples of this are the
Ctrl+Alt+Del sequence on Windows hosts or single keys
grabbed by other applications on X11 hosts such as the GNOME
desktop Locate Pointer feature.
</para>
</listitem>
<listitem>
<para>
Your <emphasis role="bold">mouse</emphasis> is owned by the
VM only after you have clicked in the VM window. The host
mouse pointer will disappear, and your mouse will drive the
guest's pointer instead of your normal mouse pointer.
</para>
<para>
Note that mouse ownership is independent of that of the
keyboard. Even after you have clicked on a titlebar to be
able to enter text into the VM window, your mouse is not
necessarily owned by the VM yet.
</para>
<para>
To release ownership of your mouse by the VM, press the Host
key.
</para>
</listitem>
</itemizedlist>
<para>
As this behavior is inconvenient, &product-name; provides a set
of tools and device drivers for guest systems called the
&product-name; Guest Additions. These tools make VM keyboard and
mouse operations much more seamless. Most importantly, the Guest
Additions suppress the second "guest" mouse pointer and make
your host mouse pointer work directly in the guest. See
<xref linkend="guestadditions" />.
</para>
</sect2>
<sect2 id="specialcharacters">
<title>Typing Special Characters</title>
<para>
Some OSes expect certain key combinations to initiate certain
procedures. The key combinations that you type into a VM might
target the host OS, the &product-name; software, or the guest
OS. The recipient of these keypresses depends on a number of
factors, including the key combination itself.
</para>
<itemizedlist>
<listitem>
<para>
Host OSes reserve certain key combinations for themselves.
For example, you cannot use the
<emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination
to reboot the guest OS in your VM, because this key
combination is reserved by the host OS. Even though both
Windows and Linux OSes can intercept this key combination,
the host OS is rebooted automatically.
</para>
<para>
On Linux and Oracle Solaris hosts, which use the X Window
System, the key combination
<emphasis role="bold">Ctrl+Alt+Backspace</emphasis> normally
resets the X server and restarts the entire graphical user
interface. As the X server intercepts this combination,
pressing it will usually restart your
<emphasis>host</emphasis> graphical user interface and kill
all running programs, including &product-name;, in the
process.
</para>
<para>
On Linux hosts supporting virtual terminals, the key
combination <emphasis role="bold">Ctrl+Alt+Fx</emphasis>,
where Fx is one of the function keys from F1 to F12,
normally enables you to switch between virtual terminals. As
with <emphasis role="bold">Ctrl+Alt+Delete</emphasis>, these
combinations are intercepted by the host OS and therefore
always switch terminals on the <emphasis>host</emphasis>.
</para>
<para>
If, instead, you want to send these key combinations to the
<emphasis>guest</emphasis> OS in the virtual machine, you
will need to use one of the following methods:
</para>
<itemizedlist>
<listitem>
<para>
Use the items in the
<emphasis role="bold">Input</emphasis>,
<emphasis role="bold">Keyboard</emphasis> menu of the
virtual machine window. This menu includes the settings
<emphasis role="bold">Insert Ctrl+Alt+Delete</emphasis>
and <emphasis role="bold">Insert
Ctrl+Alt+Backspace</emphasis>. However, the latter
setting affects only Linux guests or Oracle Solaris
guests.
</para>
<para>
This menu also includes an option for inserting the Host
key combination.
</para>
</listitem>
<listitem>
<para>
Use special key combinations with the Host key, which is
normally the right Control key. &product-name; then
translates the following key combinations for the VM:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Host key + Del</emphasis>
sends <emphasis role="bold">Ctrl+Alt+Del</emphasis>
to reboot the guest OS.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Host key +
Backspace</emphasis> sends
<emphasis role="bold">Ctrl+Alt+Backspace</emphasis>
to restart the graphical user interface of a Linux
or Oracle Solaris guest.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Host key + Function
key</emphasis>. For example, use this key
combination to simulate
<emphasis role="bold">Ctrl+Alt+Fx</emphasis> to
switch between virtual terminals in a Linux guest.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
For some other keyboard combinations such as
<emphasis role="bold">Alt+Tab</emphasis> to switch between
open windows, &product-name; enables you to configure
whether these combinations will affect the host or the
guest, if a virtual machine currently has the focus. This is
a global setting for all virtual machines and can be found
under <emphasis role="bold">File</emphasis>,
<emphasis role="bold">Preferences</emphasis>,
<emphasis role="bold">Input</emphasis>.
</para>
</listitem>
<listitem>
<para>
A soft keyboard can be used to input key combinations in the
guest. See <xref linkend="soft-keyb"/>.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="intro-removable-media-changing">
<title>Changing Removable Media</title>
<para>
While a virtual machine is running, you can change removable
media in the <emphasis role="bold">Devices</emphasis> menu of
the VM's window. Here you can select in detail what
&product-name; presents to your VM as a CD, DVD, or floppy
drive.
</para>
<para>
The settings are the same as those available for the VM in the
<emphasis role="bold">Settings</emphasis> window of &vbox-mgr;.
But as the <emphasis role="bold">Settings</emphasis> window is
disabled while the VM is in the Running or Saved state, the
<emphasis role="bold">Devices</emphasis> menu saves you from
having to shut down and restart the VM every time you want to
change media.
</para>
<para>
Using the <emphasis role="bold">Devices</emphasis> menu, you can
attach the host drive to the guest or select a floppy or DVD
image, as described in <xref linkend="settings-storage" />.
</para>
<para>
The <emphasis role="bold">Devices</emphasis> menu also includes
an option for creating a virtual ISO (VISO) from selected files
on the host.
</para>
</sect2>
<sect2 id="intro-resize-window">
<title>Resizing the Machine's Window</title>
<para>
You can resize the VM's window while that VM is running. When
you do, the window is scaled as follows:
</para>
<itemizedlist>
<listitem>
<para>
If you have <emphasis role="bold">scaled mode</emphasis>
enabled, then the virtual machine's screen will be scaled to
the size of the window. This can be useful if you have many
machines running and want to have a look at one of them
while it is running in the background. Alternatively, it
might be useful to enlarge a window if the VM's output
screen is very small, for example because you are running an
old OS in it.
</para>
<para>
To enable scaled mode, press <emphasis role="bold">Host key
+ C</emphasis>, or select <emphasis role="bold">Scaled
Mode</emphasis> from the
<emphasis role="bold">View</emphasis> menu in the VM window.
To leave scaled mode, press <emphasis role="bold">Host key +
C </emphasis>again.
</para>
<para>
The aspect ratio of the guest screen is preserved when
resizing the window. To ignore the aspect ratio, press
<emphasis role="bold">Shift</emphasis> during the resize
operation.
</para>
<para>
See <xref linkend="KnownIssues" /> for additional remarks.
</para>
</listitem>
<listitem>
<para>
If you have the Guest Additions installed and they support
automatic <emphasis role="bold">resizing</emphasis>, the
Guest Additions will automatically adjust the screen
resolution of the guest OS. For example, if you are running
a Windows guest with a resolution of 1024x768 pixels and you
then resize the VM window to make it 100 pixels wider, the
Guest Additions will change the Windows display resolution
to 1124x768.
</para>
<para>
See <xref linkend="guestadditions" />.
</para>
</listitem>
<listitem>
<para>
Otherwise, if the window is bigger than the VM's screen, the
screen will be centered. If it is smaller, then scroll bars
will be added to the machine window.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="intro-save-machine-state">
<title>Saving the State of the Machine</title>
<para>
When you click on the <emphasis role="bold">Close</emphasis>
button of your virtual machine window, at the top right of the
window, just like you would close any other window on your
system, &product-name; asks you whether you want to save or
power off the VM. As a shortcut, you can also press
<emphasis role="bold">Host key + Q</emphasis>.
</para>
<figure id="fig-vm-close">
<title>Closing Down a Virtual Machine</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/vm-close.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The difference between the three options is crucial. They mean
the following:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Save the machine state:</emphasis>
With this option, &product-name;
<emphasis>freezes</emphasis> the virtual machine by
completely saving its state to your local disk.
</para>
<para>
When you start the VM again later, you will find that the VM
continues exactly where it was left off. All your programs
will still be open, and your computer resumes operation.
Saving the state of a virtual machine is thus in some ways
similar to suspending a laptop computer by closing its lid.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Send the shutdown signal.</emphasis>
This will send an ACPI shutdown signal to the virtual
machine, which has the same effect as if you had pressed the
power button on a real computer. This should trigger a
proper shutdown mechanism from within the VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Power off the machine:</emphasis> With
this option, &product-name; also stops running the virtual
machine, but <emphasis>without</emphasis> saving its state.
</para>
<warning>
<para>
This is equivalent to pulling the power plug on a real
computer without shutting it down properly. If you start
the machine again after powering it off, your OS will have
to reboot completely and may begin a lengthy check of its
virtual system disks. As a result, this should not
normally be done, since it can potentially cause data loss
or an inconsistent state of the guest system on disk.
</para>
</warning>
<para>
As an exception, if your virtual machine has any snapshots,
see <xref linkend="snapshots"/>, you can use this option to
quickly <emphasis role="bold">restore the current
snapshot</emphasis> of the virtual machine. In that case,
powering off the machine will discard the current state and
any changes made since the previous snapshot was taken will
be lost.
</para>
</listitem>
</itemizedlist>
<para>
The <emphasis role="bold">Discard</emphasis> button in the
&vbox-mgr; window discards a virtual machine's saved state. This
has the same effect as powering it off, and the same warnings
apply.
</para>
</sect2>
</sect1>
<sect1 id="gui-vmgroups">
<title>Using VM Groups</title>
<para>
VM groups are groups of VMs that you can create as and when
required. You can manage and perform functions on them
collectively, as well as individually.
</para>
<para>
The following figure shows VM groups displayed in VirtualBox
Manager.
</para>
<figure id="fig-vm-groups">
<title>Groups of Virtual Machines</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/vm-groups.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The following features are available for groups:
</para>
<itemizedlist>
<listitem>
<para>
Create a group using &vbox-mgr;. Do one of the following:
</para>
<itemizedlist>
<listitem>
<para>
Drag a VM on top of another VM.
</para>
</listitem>
<listitem>
<para>
Select multiple VMs and select
<emphasis role="bold">Group</emphasis> from the
right-click menu.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Create and manage a group using the command line. Do one of
the following:
</para>
<itemizedlist>
<listitem>
<para>
Create a group and assign a VM. For example:
</para>
<screen>VBoxManage modifyvm "vm01" --groups "/TestGroup"</screen>
<para>
This command creates a group <literal>TestGroup</literal>
and attaches the VM <literal>vm01</literal> to that group.
</para>
</listitem>
<listitem>
<para>
Detach a VM from the group, and delete the group if empty.
For example:
</para>
<screen>VBoxManage modifyvm "vm01" --groups ""</screen>
<para>
This command detaches all groups from the VM
<literal>vm01</literal> and deletes the empty group.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Create multiple groups. For example:
</para>
<screen>VBoxManage modifyvm "vm01" --groups "/TestGroup,/TestGroup2"</screen>
<para>
This command creates the groups <literal>TestGroup</literal>
and <literal>TestGroup2</literal>, if they do not exist, and
attaches the VM <literal>vm01</literal> to both of them.
</para>
</listitem>
<listitem>
<para>
Create nested groups, having a group hierarchy. For example:
</para>
<screen>VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2"</screen>
<para>
This command attaches the VM <literal>vm01</literal> to the
subgroup <literal>TestGroup2</literal> of the
<literal>TestGroup</literal> group.
</para>
</listitem>
<listitem>
<para>
Use &vbox-mgr; menu options to control and manage all the VMs
in a group. For example:
<emphasis role="bold">Start</emphasis>,
<emphasis role="bold">Pause</emphasis>,
<emphasis role="bold">Reset</emphasis>,
<emphasis role="bold">Close</emphasis> (save state, send
shutdown signal, poweroff), <emphasis role="bold">Discard
Saved State</emphasis>, <emphasis role="bold">Show in
Explorer</emphasis>, <emphasis role="bold">Sort</emphasis>.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="snapshots">
<title>Snapshots</title>
<para>
With snapshots, you can save a particular state of a virtual
machine for later use. At any later time, you can revert to that
state, even though you may have changed the VM considerably since
then. A snapshot of a virtual machine is thus similar to a machine
in Saved state, but there can be many of them, and these saved
states are preserved.
</para>
<para>
To see the snapshots of a virtual machine, click on the machine
name in &vbox-mgr;. In the machine tools menu for the VM, click
<emphasis role="bold">Snapshots</emphasis>. The Snapshots tool is
displayed.
</para>
<figure id="fig-snapshots-tool">
<title>Snapshots Tool, Showing Snapshot Properties</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/snapshots-1.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
If you select multiple VMs in the machine list, all snapshots are
listed for each VM.
</para>
<para>
Until you take a snapshot of the virtual machine, the list of
snapshots will be empty, except for the
<emphasis role="bold">Current State</emphasis> item. This item
represents the current point in the lifetime of the virtual
machine.
</para>
<para>
The Snapshots window includes a toolbar, enabling you to perform
the following snapshot operations:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Take.</emphasis> Takes a snapshot of the
selected VM. See
<xref linkend="snapshots-take-restore-delete"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Delete.</emphasis> Removes a snapshot
from the list of snapshots. See
<xref linkend="snapshots-take-restore-delete"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Restore.</emphasis> Restores the VM
state to be the same as the selected snapshot. See
<xref linkend="snapshots-take-restore-delete"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Properties.</emphasis> Displays the
properties for the selected snapshot. The
<emphasis role="bold">Attributes</emphasis> tab is used to
specify a Name and Description for the snapshot. The
<emphasis role="bold">Information</emphasis> tab shows VM
settings for the snapshot.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Clone.</emphasis> Displays the
<emphasis role="bold">Clone Virtual Machine</emphasis> wizard.
This enables you to create a clone of the VM, based on the
selected snapshot.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Settings.</emphasis> Available for the
Current State snapshot only. Displays the
<emphasis role="bold">Settings</emphasis> window for the VM,
enabling you to make configuration changes.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Discard.</emphasis> For a running VM,
discards the saved state for the VM and closes it down.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Start.</emphasis> Start the VM. This
operation is available for the <emphasis role="bold">Current
State</emphasis> item.
</para>
</listitem>
</itemizedlist>
<sect2 id="snapshots-take-restore-delete">
<title>Taking, Restoring, and Deleting Snapshots</title>
<para>
There are three operations related to snapshots, as follows:
</para>
<orderedlist>
<listitem>
<para>
<emphasis role="bold">Take a snapshot.</emphasis> This makes
a copy of the machine's current state, to which you can go
back at any given time later.
</para>
<itemizedlist>
<listitem>
<para>
If your VM is running:
</para>
<para>
Select <emphasis role="bold">Take Snapshot</emphasis>
from the <emphasis role="bold">Machine</emphasis> menu
in the VM window.
</para>
<para>
The VM is paused while the snapshot is being created.
After snapshot creation, the VM continues to run as
normal.
</para>
</listitem>
<listitem>
<para>
If your VM is in either the Saved or the Powered Off
state, as displayed next to the VM name in the machine
list:
</para>
<para>
Display the Snapshots window and do one of the
following:
</para>
<itemizedlist>
<listitem>
<para>
Click <emphasis role="bold">Take</emphasis> in the
Snapshots window toolbar.
</para>
</listitem>
<listitem>
<para>
Right-click on the <emphasis role="bold">Current
State </emphasis>item in the list and select
<emphasis role="bold">Take</emphasis>.
</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>
A dialog is displayed, prompting you for a snapshot name.
This name is purely for reference purposes, to help you
remember the state of the snapshot. For example, a useful
name would be "Fresh installation from scratch, no Guest
Additions", or "Service Pack 3 just installed". You can also
add a longer text description in the
<emphasis role="bold">Snapshot Description</emphasis> field.
</para>
<para>
Your new snapshot will then appear in the snapshots list.
Underneath your new snapshot, you will see an item called
<emphasis role="bold">Current State</emphasis>, signifying
that the current state of your VM is a variation based on
the snapshot you took earlier. If you later take another
snapshot, you will see that they are displayed in sequence,
and that each subsequent snapshot is derived from an earlier
one.
</para>
<figure id="fig-snapshots-list">
<title>Snapshots List For a Virtual Machine</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/snapshots-2.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
&product-name; imposes no limits on the number of snapshots
you can take. The only practical limitation is disk space on
your host. Each snapshot stores the state of the virtual
machine and thus occupies some disk space. See
<xref linkend="snapshots-contents"/> for details on what is
stored in a snapshot.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Restore a snapshot.</emphasis> In the
Snapshots window, select the snapshot you have taken and
click <emphasis role="bold">Restore</emphasis> in the
toolbar. By restoring a snapshot, you go back or forward in
time. The current state of the machine is lost, and the
machine is restored to the exact state it was in when the
snapshot was taken.
</para>
<note>
<para>
Restoring a snapshot will affect the virtual hard drives
that are connected to your VM, as the entire state of the
virtual hard drive will be reverted as well. This means
also that all files that have been created since the
snapshot and all other file changes <emphasis>will be
lost. </emphasis>In order to prevent such data loss while
still making use of the snapshot feature, it is possible
to add a second hard drive in
<emphasis>write-through</emphasis> mode using the
<command>VBoxManage</command> interface and use it to
store your data. As write-through hard drives are
<emphasis>not</emphasis> included in snapshots, they
remain unaltered when a machine is reverted. See
<xref linkend="hdimagewrites" />.
</para>
</note>
<para>
To avoid losing the current state when restoring a snapshot,
you can create a new snapshot before the restore operation.
</para>
<para>
By restoring an earlier snapshot and taking more snapshots
from there, it is even possible to create a kind of
alternate reality and to switch between these different
histories of the virtual machine. This can result in a whole
tree of virtual machine snapshots.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Delete a snapshot.</emphasis> This
does not affect the state of the virtual machine, but only
releases the files on disk that &product-name; used to store
the snapshot data, thus freeing disk space. To delete a
snapshot, select the snapshot name in the Snapshots window
and click <emphasis role="bold">Delete</emphasis> in the
toolbar. Snapshots can be deleted even while a machine is
running.
</para>
<note>
<para>
Whereas taking and restoring snapshots are fairly quick
operations, deleting a snapshot can take a considerable
amount of time since large amounts of data may need to be
copied between several disk image files. Temporary disk
files may also need large amounts of disk space while the
operation is in progress.
</para>
</note>
<para>
There are some situations which cannot be handled while a VM
is running, and you will get an appropriate message that you
need to perform this snapshot deletion when the VM is shut
down.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="snapshots-contents">
<title>Snapshot Contents</title>
<para>
Think of a snapshot as a point in time that you have preserved.
More formally, a snapshot consists of the following:
</para>
<itemizedlist>
<listitem>
<para>
The snapshot contains a complete copy of the VM settings,
including the hardware configuration, so that when you
restore a snapshot, the VM settings are restored as well.
For example, if you changed the hard disk configuration or
the VM's system settings, that change is undone when you
restore the snapshot.
</para>
<para>
The copy of the settings is stored in the machine
configuration, an XML text file, and thus occupies very
little space.
</para>
</listitem>
<listitem>
<para>
The complete state of all the virtual disks attached to the
machine is preserved. Going back to a snapshot means that
all changes that had been made to the machine's disks, file
by file and bit by bit, will be undone as well. Files that
were since created will disappear, files that were deleted
will be restored, changes to files will be reverted.
</para>
<para>
Strictly speaking, this is only true for virtual hard disks
in "normal" mode. You can configure disks to behave
differently with snapshots, see
<xref linkend="hdimagewrites" />. In technical terms, it is
not the virtual disk itself that is restored when a snapshot
is restored. Instead, when a snapshot is taken,
&product-name; creates differencing images which contain
only the changes since the snapshot were taken. When the
snapshot is restored, &product-name; throws away that
differencing image, thus going back to the previous state.
This is both faster and uses less disk space. For the
details, which can be complex, see
<xref linkend="diffimages" />.
</para>
<para>
Creating the differencing image as such does not occupy much
space on the host disk initially, since the differencing
image will initially be empty and grow dynamically later
with each write operation to the disk. The longer you use
the machine after having created the snapshot, however, the
more the differencing image will grow in size.
</para>
</listitem>
<listitem>
<para>
If you took a snapshot while the machine was running, the
memory state of the machine is also saved in the snapshot.
This is in the same way that memory can be saved when you
close a VM window. When you restore such a snapshot,
execution resumes at exactly the point when the snapshot was
taken.
</para>
<para>
The memory state file can be as large as the memory size of
the VM and will therefore occupy considerable disk space.
</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="configbasics">
<title>Virtual Machine Configuration</title>
<para>
When you select a virtual machine from the list in the VirtualBox
Manager window, you will see a summary of that machine's settings
on the right.
</para>
<para>
Clicking on <emphasis role="bold">Settings</emphasis> displays a
window, where you can configure many of the properties of the
selected VM. But be careful when changing VM settings. It is
possible to change all VM settings after installing a guest OS,
but certain changes might prevent a guest OS from functioning
correctly if done after installation.
</para>
<note>
<para>
The <emphasis role="bold">Settings</emphasis> button is disabled
while a VM is either in the Running or Saved state. This is
because the <emphasis role="bold">Settings</emphasis> window
enables you to change fundamental characteristics of the virtual
machine that is created for your guest OS. For example, the
guest OS may not perform well if half of its memory is taken
away. As a result, if the
<emphasis role="bold">Settings</emphasis> button is disabled,
shut down the current VM first.
</para>
</note>
<para>
&product-name; provides a wide range of parameters that can be
changed for a virtual machine. The various settings that can be
changed in the <emphasis role="bold">Settings</emphasis> window
are described in detail in <xref linkend="BasicConcepts" />. Even
more parameters are available when using the
<command>VBoxManage</command> command line interface. See
<xref linkend="vboxmanage" />.
</para>
</sect1>
<sect1 id="intro-removing">
<title>Removing and Moving Virtual Machines</title>
<para>
You can remove a VM from &product-name; or move the VM and its
associated files, such as disk images, to another location on the
host.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Removing a VM.</emphasis> To remove a
VM, right-click on the VM in the &vbox-mgr; machine list and
select <emphasis role="bold">Remove</emphasis>.
</para>
<para>
The confirmation dialog enables you to specify whether to only
remove the VM from the list of machines or to remove the files
associated with the VM.
</para>
<para>
Note that the <emphasis role="bold">Remove</emphasis> menu
item is disabled while a VM is running.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Moving a VM.</emphasis> To move a VM to
a new location on the host, right-click on the VM in the
&vbox-mgr;'s machine list and select
<emphasis role="bold">Move</emphasis>.
</para>
<para>
The file dialog prompts you to specify a new location for the
VM.
</para>
<para>
When you move a VM, &product-name; configuration files are
updated automatically to use the new location on the host.
</para>
<para>
Note that the <emphasis role="bold">Move</emphasis> menu item
is disabled while a VM is running.
</para>
<para>
You can also use the <command>VBoxManage movevm</command>
command to move a VM. See <xref linkend="vboxmanage-movevm"/>.
</para>
</listitem>
</itemizedlist>
<para>
For information about removing or moving a disk image file from
&product-name;, see <xref linkend="virtual-media-manager"/>.
</para>
</sect1>
<sect1 id="clone">
<title>Cloning Virtual Machines</title>
<para>
You can create a full copy or a linked copy of an existing VM.
This copy is called a <emphasis>clone</emphasis>. You might use a
cloned VM to experiment with a VM configuration, to test different
guest OS levels, or to back up a VM.
</para>
<para>
The <emphasis role="bold">Clone Virtual Machine</emphasis> wizard
guides you through the cloning process.
</para>
<para>
You can start the Clone Virtual Machine wizard in one of the
following ways:
</para>
<itemizedlist>
<listitem>
<para>
Click the VM name in the machine list and then select
<emphasis role="bold">Clone</emphasis> from the
<emphasis role="bold">Machine</emphasis> menu.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Clone</emphasis> in the
<emphasis role="bold">Snapshots</emphasis> window for the
selected VM.
</para>
</listitem>
</itemizedlist>
<note>
<para>
The <emphasis role="bold">Clone</emphasis> menu item is disabled
while a virtual machine is running.
</para>
</note>
<para>
The <emphasis role="bold">New Machine Name and Path</emphasis>
page is displayed.
</para>
<figure id="fig-clone-wizard-name-path">
<title>Clone Virtual Machine Wizard: New Machine Name and Path</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/clone-vm-1.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The following clone options are available:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Name:</emphasis> A name for the cloned
machine.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Path:</emphasis> Choose a location for
the cloned virtual machine, otherwise &product-name; uses the
default machines folder.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">MAC Address Policy:</emphasis> Specifies
whether to retain network card MAC addresses when cloning the
VM.
</para>
<para>
For example, the <emphasis role="bold">Generate New MAC
Addresses For All Network Adapters</emphasis> value assigns a
new MAC address to each network card during cloning. This is
the default setting. This is the best option when both the
source VM and the cloned VM must operate on the same network.
Other values enable you to retain the existing MAC addresses
in the cloned VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Keep Disk Names:</emphasis> Retains the
disk image names when cloning the VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Keep Hardware UUIDs:</emphasis> Retains
the hardware universally unique identifiers (UUIDs) when
cloning the VM.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Next</emphasis>. The
<emphasis role="bold">Clone Type</emphasis> page is displayed.
</para>
<figure id="fig-clone-wizard-clone-type">
<title>Clone Virtual Machine Wizard: Clone Type</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/clone-vm-2.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The <emphasis role="bold">Clone Type</emphasis> option specifies
whether to create a clone that is linked to the source VM or to
create a fully independent clone:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Full Clone:</emphasis> Copies all
dependent disk images to the new VM folder. A full clone can
operate fully without the source VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Linked Clone:</emphasis> Creates new
differencing disk images based on the source VM disk images.
If you select the current state of the source VM as the clone
point, &product-name; creates a new snapshot.
</para>
</listitem>
</itemizedlist>
<para>
(Optional) Click <emphasis role="bold">Next</emphasis>. The
<emphasis role="bold">Snapshots</emphasis> page is displayed.
</para>
<note>
<para>
The Snapshots page is only displayed for machines that have
snapshots and the selected clone type is
<emphasis role="bold">Full Clone</emphasis>.
</para>
</note>
<figure id="fig-clone-wizard-snapshots">
<title>Clone Virtual Machine Wizard: Snapshots</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/clone-vm-3.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
You use this page to select which parts of the snapshot tree to
include in the clone. The available options are as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Current Machine State:</emphasis> Clones
the current state of the VM. Snapshots are not included.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Everything:</emphasis> Clones the
current machine state and all its snapshots.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Finish</emphasis> to start the clone
operation.
</para>
<para>
The duration of the clone operation depends on the size and number
of attached disk images. In addition, the clone operation saves
all the differencing disk images of a snapshot.
</para>
<para>
You can also use the <command>VBoxManage clonevm</command> command
to clone a VM. See <xref linkend="vboxmanage-clonevm" />.
</para>
</sect1>
<sect1 id="ovf">
<title>Importing and Exporting Virtual Machines</title>
<para>
&product-name; can import and export virtual machines in the
following formats:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Open Virtualization Format
(OVF).</emphasis> This is the industry-standard format. See
<xref linkend="ovf-about"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Cloud service formats.</emphasis> Export
to and import from cloud services such as &oci; is supported.
See <xref linkend="cloud-integration"/>.
</para>
</listitem>
</itemizedlist>
<sect2 id="ovf-about">
<title>About the OVF Format</title>
<para>
OVF is a cross-platform standard supported by many
virtualization products which enables the creation of ready-made
virtual machines that can then be imported into a hypervisor
such as &product-name;. &product-name; makes OVF import and
export easy to do, using &vbox-mgr; or the command-line
interface.
</para>
<para>
Using OVF enables packaging of <emphasis>virtual
appliances</emphasis>. These are disk images, together with
configuration settings that can be distributed easily. This way
one can offer complete ready-to-use software packages, including
OSes with applications, that need no configuration or
installation except for importing into &product-name;.
</para>
<note>
<para>
The OVF standard is complex, and support in &product-name; is
an ongoing process. In particular, no guarantee is made that
&product-name; supports all appliances created by other
virtualization software. For a list of known limitations, see
<xref linkend="KnownIssues" />.
</para>
</note>
<para>
Appliances in OVF format can appear in the following variants:
</para>
<itemizedlist>
<listitem>
<para>
They can come in several files, as one or several disk
images, typically in the widely-used VMDK format. See
<xref linkend="vdidetails" />. They also include a textual
description file in an XML dialect with an
<filename>.ovf</filename> extension. These files must then
reside in the same directory for &product-name; to be able
to import them.
</para>
</listitem>
<listitem>
<para>
Alternatively, the above files can be packed together into a
single archive file, typically with an
<filename>.ova</filename> extension. Such archive files use
a variant of the TAR archive format and can therefore be
unpacked outside of &product-name; with any utility that can
unpack standard TAR files.
</para>
</listitem>
</itemizedlist>
<note>
<para>
OVF cannot describe snapshots that were taken for a virtual
machine. As a result, when you export a virtual machine that
has snapshots, only the current state of the machine will be
exported. The disk images in the export will have a
<emphasis>flattened</emphasis> state identical to the current
state of the virtual machine.
</para>
</note>
</sect2>
<sect2 id="ovf-import-appliance">
<title>Importing an Appliance in OVF Format</title>
<para>
The following steps show how to import an appliance in OVF
format.
</para>
<orderedlist>
<listitem>
<para>
Double-click on the OVF or OVA file.
</para>
<para>
&product-name; creates file type associations automatically
for any OVF and OVA files on your host OS.
</para>
<para>
The <emphasis role="bold">Appliance Settings</emphasis> page
of the <emphasis role="bold">Import Virtual
Appliance</emphasis> wizard is shown.
</para>
<figure id="fig-import-appliance">
<title>Import Virtual Appliance Wizard: Appliance Settings</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/ovf-import.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
</listitem>
<listitem>
<para>
The <emphasis role="bold">Appliance Settings</emphasis> page
shows the VMs described in the OVF or OVA file and enables
you to change the VM settings.
</para>
<para>
By default, membership of VM groups is preserved on import
for VMs that were initially exported from &product-name;.
You can change this behavior by using the
<emphasis role="bold">Primary Group</emphasis> setting for
the VM.
</para>
<para>
The following global settings apply to all of the VMs that
you import:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Base Folder:</emphasis> Specifies
the directory on the host in which to store the imported
VMs.
</para>
<para>
If an appliance has multiple VMs, you can specify a
different directory for each VM by editing the
<emphasis role="bold">Base Folder</emphasis> setting for
the VM.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">MAC Address Policy:</emphasis>
Reinitializes the MAC addresses of network cards in your
VMs prior to import, by default. You can override the
default behavior and preserve the MAC addresses on
import.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Import Hard Drives as
VDI:</emphasis> Imports hard drives in the VDI format
rather than in the default VMDK format.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Finish</emphasis> to import the
appliance.
</para>
<para>
&product-name; copies the disk images and creates local VMs
with the settings described on the
<emphasis role="bold">Appliance Settings</emphasis> page.
The imported VMs are shown in the list of VMs in VirtualBox
Manager.
</para>
<para>
Because disk images are large, the VMDK images that are
included with virtual appliances are shipped in a compressed
format that cannot be used directly by VMs. So, the images
are first unpacked and copied, which might take several
minutes.
</para>
</listitem>
</orderedlist>
<para>
You can use the <command>VBoxManage import</command> command to
import an appliance. See <xref linkend="vboxmanage-import" />.
</para>
</sect2>
<sect2 id="ovf-export-appliance">
<title>Exporting an Appliance in OVF Format</title>
<para>
The following steps show how to export an appliance in OVF
format.
</para>
<orderedlist>
<listitem>
<para>
Select <emphasis role="bold">File</emphasis>,
<emphasis role="bold"> Export Appliance</emphasis> to
display the <emphasis role="bold">Export Virtual
Appliance</emphasis> wizard.
</para>
<para>
On the initial <emphasis role="bold">Virtual
Machines</emphasis> page, you can combine several VMs into
an OVF appliance.
</para>
<para>
Select one or more VMs to export, and click
<emphasis role="bold">Next</emphasis>.
</para>
</listitem>
<listitem>
<para>
The <emphasis role="bold">Format Settings</emphasis> page
enables you to configure the following settings:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Format:</emphasis> Selects the
<emphasis role="bold">Open Virtualization
Format</emphasis> value for the output files.
</para>
<para>
The <emphasis role="bold">&oci;</emphasis> value exports
the appliance to &oci;. See
<xref linkend="cloud-export-oci"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">File:</emphasis> Selects the
location in which to store the exported files.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">MAC Address Policy:</emphasis>
Specifies whether to retain or reassign network card MAC
addresses on export.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Write Manifest File:</emphasis>
Enables you to include a manifest file in the exported
archive file.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Include ISO Image
Files:</emphasis> Enables you to include ISO image files
in the exported archive file.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Next</emphasis> to show the
<emphasis role="bold">Appliance Settings</emphasis> page.
</para>
<para>
You can edit settings for the virtual appliance. For
example, you can change the name of the virtual appliance or
add product information, such as vendor details or license
text.
</para>
<para>
Double-click the appropriate field to change its value.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Finish</emphasis> to begin the
export process. Note that this operation might take several
minutes.
</para>
</listitem>
</orderedlist>
<para>
You can use the <command>VBoxManage export</command> command to
export an appliance. See <xref linkend="vboxmanage-export" />.
</para>
</sect2>
</sect1>
<sect1 id="cloud-integration">
<title>Integrating with &oci;</title>
<para>
This section describes how to use the features of &product-name;
to integrate with &oci;.
</para>
<para>
Integrating with &oci; involves the following steps:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Prepare for &oci;
Integration.</emphasis> Before using &product-name; with &oci;
there are some initial configuration steps you may need to do.
See <xref linkend="cloud-integration-steps"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Use &product-name; with
&oci;.</emphasis> <xref linkend="cloud-vbox-oci-tasks"/>
describes how you can use &product-name; with &oci;.
</para>
</listitem>
</itemizedlist>
<sect2 id="cloud-integration-steps">
<title>Preparing for &oci; Integration</title>
<para>
Perform the following configuration steps before using
&product-name; to integrate with your &oci; account.
</para>
<orderedlist>
<listitem>
<para>
<emphasis role="bold">Install the Extension Pack.</emphasis>
Cloud integration features are only available when you
install the &product-name; Extension Pack. See
<xref linkend="intro-installing"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Create a key pair.</emphasis> Generate
an API signing key pair that is used for API requests to
&oci;. See <xref linkend="cloud-create-api-keypair"/>.
</para>
<para>
Upload the public key of the key pair from your client
device to the cloud service. See
<xref linkend="cloud-upload-public-key"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Create a cloud profile.</emphasis> The
cloud profile contains resource identifiers for your cloud
account, such as your user OCID, and details of your key
pair. See <xref linkend="cloud-create-cloud-profile"/>.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="cloud-create-api-keypair">
<title>Creating an API Signing Key Pair</title>
<para></para>
<para>
To use the cloud integration features of &product-name;, you
must generate an API signing key pair that is used for API
requests to &oci;.
</para>
<para>
Your API requests are signed with your private key, and &oci;
uses the public key to verify the authenticity of the request.
You must upload the public key to the &oci; Console.
</para>
<note>
<para>
This key pair is not the same SSH key that you use to access
compute instances on &oci;.
</para>
</note>
<orderedlist>
<listitem>
<para>
(Optional) Create a <filename>.oci</filename> directory to
store the key pair.
</para>
<screen>$ mkdir ~/.oci</screen>
<para>
The key pair is usually installed in the
<filename>.oci</filename> folder in your home directory. For
example, <filename>~/.oci</filename> on a Linux system.
</para>
</listitem>
<listitem>
<para>
Generate the private key.
</para>
<para>
Use the <command>openssl</command> command.
</para>
<itemizedlist>
<listitem>
<para>
To generate a private key with a passphrase:
</para>
<screen>$ openssl genrsa -out ~/.oci/oci_api_key.pem -aes128 2048 </screen>
</listitem>
<listitem>
<para>
To generate a private key without a passphrase:
</para>
<screen>$ openssl genrsa -out ~/.oci/oci_api_key.pem 2048</screen>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Change permissions for the private key.
</para>
<screen>$ chmod 600 ~/.oci/oci_api_key.pem</screen>
<para>
Generate the public key.
</para>
<screen>$ openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem</screen>
</listitem>
</orderedlist>
</sect2>
<sect2 id="cloud-upload-public-key">
<title>Uploading the Public Key to &oci;</title>
<para>
Use the following steps to upload your public key to &oci;.
</para>
<orderedlist>
<listitem>
<para>
Log in to the &oci; Console.
</para>
</listitem>
<listitem>
<para>
Display the <emphasis role="bold">User Settings</emphasis>
page.
</para>
<para>
Click <emphasis role="bold">Profile</emphasis>,
<emphasis role="bold">User Settings</emphasis>.
</para>
</listitem>
<listitem>
<para>
Display your current API signing keys.
</para>
<para>
Click <emphasis role="bold">Resources</emphasis>,
<emphasis role="bold">API Keys</emphasis>.
</para>
</listitem>
<listitem>
<para>
Upload the public key.
</para>
<para>
Click <emphasis role="bold">Add Public Key</emphasis>.
</para>
<para>
The <emphasis role="bold">Add Public Key</emphasis> dialog
is displayed.
</para>
<figure id="fig-upload-key-oci">
<title>Upload Public Key Dialog in &oci; Console</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/upload-key.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
Select one of the following options:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Choose Public Key File.</emphasis>
This option enables you to browse to the public key file
on your local hard disk.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Paste Public Keys.</emphasis> This
option enables you to paste the contents of the public
key file into the window in the dialog box.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Add</emphasis> to upload the
public key.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="cloud-create-cloud-profile">
<title>Creating a Cloud Profile</title>
<para>
&product-name; uses a <emphasis>cloud profile</emphasis> to
connect to &oci;. A cloud profile is a text file that contains
details of your key files and Oracle Cloud Identifier (OCID)
resource identifiers for your cloud account, such as the
following:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Fingerprint of the public
key.</emphasis> To obtain the fingerprint, you can use the
<command>openssl</command> command:
</para>
<screen>$ openssl rsa -pubout -outform DER -in ~/.oci/oci_api_key.pem | openssl md5 -c</screen>
</listitem>
<listitem>
<para>
<emphasis role="bold">Location of the private key on the
client device.</emphasis> Specify the full path to the
private key.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">(Optional) Passphrase for the private
key.</emphasis> This is only required if the key is
encrypted.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Region</emphasis>. Shown on the &oci;
Console. Click
<emphasis role="bold">Administration</emphasis>,
<emphasis role="bold">Tenancy Details</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Tenancy OCID.</emphasis> Shown on the
&oci; Console. Click
<emphasis role="bold">Administration</emphasis>,
<emphasis role="bold">Tenancy Details</emphasis>.
</para>
<para>
A link enables you to copy the Tenancy OCID.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Compartment OCID.</emphasis> Shown on
the &oci; Console. Click
<emphasis role="bold">Identity</emphasis>,
<emphasis role="bold">Compartments</emphasis>.
</para>
<para>
A link enables you to copy the Compartment OCID.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">User OCID.</emphasis> Shown on the
&oci; Console. Click
<emphasis role="bold">Profile</emphasis>,
<emphasis role="bold">User Settings</emphasis>.
</para>
<para>
A link enables you to copy the User OCID.
</para>
</listitem>
</itemizedlist>
<para>
You can create a cloud profile in the following ways:
</para>
<itemizedlist>
<listitem>
<para>
Automatically, by using the <emphasis role="bold">Cloud
Profile Manager</emphasis>. See
<xref linkend="cloud-using-cloud-profile-manager"/>.
</para>
<para>
The Cloud Profile Manager is a &vbox-mgr; tool that enables
you to create, edit, and manage cloud profiles for your
cloud service accounts.
</para>
</listitem>
<listitem>
<para>
Automatically, by using the <command>VBoxManage
cloudprofile</command> command. See
<xref linkend="vboxmanage-cloudprofile"/>.
</para>
</listitem>
<listitem>
<para>
Manually, by creating an <filename>oci_config</filename>
file in your &product-name; global configuration directory.
For example, this is
<filename>$HOME/.config/VirtualBox/oci_config</filename> on
a Linux host.
</para>
</listitem>
<listitem>
<para>
Manually, by creating a <filename>config</filename> file in
your &oci; configuration directory. For example, this is
<filename>$HOME/.oci/config</filename> on a Linux host.
</para>
<para>
This is the same file that is used by the &oci; command line
interface.
</para>
<para>
&product-name; automatically uses the
<filename>config</filename> file if no cloud profile file is
present in your global configuration directory.
Alternatively, you can import this file manually into the
Cloud Profile Manager.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="cloud-using-cloud-profile-manager">
<title>Using the Cloud Profile Manager</title>
<para>
This section describes how to use the Cloud Profile Manager to
create a cloud profile.
</para>
<para>
To open the Cloud Profile Manager click
<emphasis role="bold">File</emphasis>,
<emphasis role="bold">Cloud Profile Manager</emphasis> in
&vbox-mgr;.
</para>
<figure id="fig-cloud-profile-manager">
<title>The Cloud Profile Manager</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/cloud-profile-manager.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
You can use the Cloud Profile Manager in the following ways:
</para>
<itemizedlist>
<listitem>
<para>
To create a new cloud profile automatically
</para>
</listitem>
<listitem>
<para>
To create a cloud profile by importing settings from your
&oci; configuration file.
</para>
</listitem>
</itemizedlist>
<para>
Perform the following steps to create a new cloud profile
automatically, using the Cloud Profile Manager:
</para>
<orderedlist>
<listitem>
<para>
Click the <emphasis role="bold">Add</emphasis> icon and
specify a <emphasis role="bold">Name</emphasis> for the
profile.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Properties</emphasis> and
specify the following property values for the profile:
</para>
<itemizedlist>
<listitem>
<para>
Compartment OCID
</para>
</listitem>
<listitem>
<para>
Fingerprint of the public key
</para>
</listitem>
<listitem>
<para>
Location of the private key on the client device
</para>
</listitem>
<!-- <listitem>
<para>
(Optional) Passphrase for the private key, if the key is
encrypted
</para>
</listitem>-->
<listitem>
<para>
Region OCID
</para>
</listitem>
<listitem>
<para>
Tenancy OCID
</para>
</listitem>
<listitem>
<para>
User OCID
</para>
</listitem>
</itemizedlist>
<para>
Some of these are settings for your &oci; account, which you
can view from the &oci; Console.
</para>
</listitem>
<listitem>
<para>
(Optional) If you are using the cloud profile to connect to
cloud virtual machines, select the
<emphasis role="bold">Show VMs</emphasis> check box.
</para>
<para>
This creates a new subgroup of the
<emphasis role="bold">OCI</emphasis> group in &vbox-mgr;.
See <xref linkend="cloud-vm-oci-group"/>.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Apply</emphasis> to save your
changes.
</para>
<para>
The cloud profile settings are saved to the
<filename>oci_config</filename> file in your &product-name;
global settings directory.
</para>
</listitem>
</orderedlist>
<para>
Perform the following steps to import an existing &oci;
configuration file into the Cloud Profile Manager:
</para>
<orderedlist>
<listitem>
<para>
Ensure that a <filename>config</filename> file is present in
your &oci; configuration directory. For example, this is
<filename>$HOME/.oci/config</filename> on a Linux host.
</para>
</listitem>
<listitem>
<para>
Click the <emphasis role="bold">Import</emphasis> icon to
open a dialog that prompts you to import cloud profiles from
external files.
</para>
<warning>
<para>
This action overwrites any cloud profiles that are in your
&product-name; global settings directory.
</para>
</warning>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Import</emphasis>.
</para>
<para>
Your cloud profile settings are saved to the
<filename>oci_config</filename> file in your &product-name;
global settings directory.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Properties</emphasis> to show
the cloud profile settings.
</para>
<para>
Double-click on the appropriate field to change the value.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Apply</emphasis> to save your
changes.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="cloud-vbox-oci-tasks">
<title>Using &product-name; With &oci;</title>
<para>
This section describes how you can use &product-name; with &oci;
to do the following tasks:
</para>
<itemizedlist>
<listitem>
<para>
Create, add, and manage &oci; cloud instances using
&vbox-mgr;. See <xref linkend="cloud-vm"/>.
</para>
</listitem>
<listitem>
<para>
Export an &product-name; VM to &oci;. See
<xref linkend="cloud-export-oci"/>.
</para>
</listitem>
<listitem>
<para>
Import a cloud instance into &product-name;. See
<xref linkend="cloud-import-oci"/>.
</para>
</listitem>
<listitem>
<para>
Connect from a local VM to an &oci; cloud subnet. See
<xref linkend="cloud-using-cloud-networks"/>.
</para>
</listitem>
<listitem>
<para>
Use the <command>VBoxManage</command> commands to integrate
with &oci; and perform cloud operations. See
<xref linkend="cloud-using-cli"/>.
</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="cloud-vm">
<title>Using Cloud Virtual Machines</title>
<para>
A cloud virtual machine (<emphasis>cloud VM</emphasis>) is a
type of VM that represents an instance on a cloud service. Cloud
VMs are shown in the machine list in &vbox-mgr;, in the same way
as local VMs are.
</para>
<para>
By using cloud VMs you can create, manage, and control your
&oci; instances from &vbox-mgr;.
</para>
<note>
<para>
Cloud VMs do not install, export, or import instances to the
&product-name; host. All operations are done remotely on the
cloud service.
</para>
</note>
<figure id="fig-cloud-vm-overview">
<title>Cloud VMs, Shown in &vbox-mgr;</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/cloudvm-overview.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
Cloud VMs can be used to do the following tasks in &oci;:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Create a new &oci;
instance.</emphasis> See <xref linkend="cloud-vm-new"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold"> Use an existing &oci;
instance.</emphasis> See <xref linkend="cloud-vm-add"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Configure an &oci;
instance.</emphasis> You can change settings for the
instance, such as display name and shape. See
<xref linkend="cloud-vm-settings"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Control an &oci; instance.</emphasis>
Stop, start, and terminate the instance. See
<xref linkend="cloud-vm-control"/>
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Create a console connection to an
&oci; instance</emphasis>. See
<xref linkend="cloud-vm-instance-console"/>.
</para>
</listitem>
</itemizedlist>
<sect3 id="cloud-vm-oci-group">
<title>About the OCI VM Group</title>
<para>
All cloud VMs are shown in the machine list in &vbox-mgr;, in
a special VM group called
<emphasis role="bold">OCI</emphasis>.
</para>
<para>
Cloud VMs are further grouped according to the cloud profile
used to connect to them. The cloud profile identifies the user
and compartment for the cloud VM and includes details of the
key pair used to connect to cloud instances. See
<xref linkend="cloud-create-cloud-profile"/>.
</para>
<figure id="fig-cloud-vm-oci-group">
<title>OCI Group, Containing Cloud VMs</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/cloudvm-oci-group.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
All cloud profiles registered with &product-name; are listed
automatically in the OCI group.
</para>
<para>
To enable or disable listing of cloud VMs in &vbox-mgr; for a
specific cloud profile, do the following:
</para>
<para>
Display the <emphasis role="bold">Cloud Profile
Manager</emphasis> and select or deselect the
<emphasis role="bold">List VMs</emphasis> check box for each
cloud profile.
</para>
</sect3>
<sect3 id="cloud-vm-new">
<title>Creating a New Cloud VM</title>
<para>
When you create a new cloud VM, a <emphasis>new</emphasis>
&oci; instance is created and associated with the cloud VM.
</para>
<para>
Perform the following steps to create a new cloud VM:
</para>
<orderedlist>
<listitem>
<para>
Click on a cloud profile in the
<emphasis role="bold">OCI</emphasis> group.
</para>
<para>
The cloud VMs for the selected cloud profile are
displayed.
</para>
</listitem>
<listitem>
<para>
Select <emphasis role="bold">Group</emphasis>,
<emphasis role="bold">New Machine</emphasis>.
</para>
<para>
The <emphasis role="bold">Create Cloud Virtual
Machine</emphasis> wizard is displayed.
</para>
<figure id="fig-cloudvm-new">
<title>Create Cloud Virtual Machine Wizard</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/cloudvm-new.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
</listitem>
<listitem>
<para>
On the initial page, configure the following settings for
the new cloud VM:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Location:</emphasis> The cloud
service provider that will host the new instance.
Select <emphasis role="bold">&oci;</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Profile:</emphasis> The cloud
profile used to connect to the new instance. Select
from the available cloud profiles.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Source:</emphasis> The image
that the new instance is based on. Choose from the
available images and boot volumes.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Next</emphasis> to display the
<emphasis role="bold">Cloud Virtual Machine
Settings</emphasis> page.
</para>
<para>
You can use this page to change the default settings for
the new &oci; instance, such as the display name, shape,
and networking configuration.
</para>
<para>
To add an SSH key to the instance, click the
<emphasis role="bold">SSH Authorised Keys</emphasis> field
and paste the public key into the displayed dialog.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Finish</emphasis> to create a
new &oci; instance using the selected image or boot
volume. The new instance is started automatically.
</para>
<para>
The new cloud VM is shown in the
<emphasis role="bold">OCI</emphasis> group in &vbox-mgr;.
</para>
</listitem>
</orderedlist>
</sect3>
<sect3 id="cloud-vm-add">
<title>Adding a Cloud VM</title>
<para>
When you add a cloud VM, an <emphasis>existing</emphasis>
&oci; instance is associated with the cloud VM. You can only
add one cloud VM for each instance.
</para>
<para>
Perform the following steps to add a cloud VM:
</para>
<orderedlist>
<listitem>
<para>
Click on a cloud profile in the
<emphasis role="bold">OCI</emphasis> group.
</para>
<para>
The cloud VMs for the selected cloud profile are
displayed.
</para>
</listitem>
<listitem>
<para>
Select <emphasis role="bold">Group</emphasis>,
<emphasis role="bold">Add Machine</emphasis>.
</para>
<para>
The <emphasis role="bold">Add Cloud Virtual
Machine</emphasis> wizard is displayed.
</para>
<figure id="fig-cloudvm-add">
<title>Add Cloud Virtual Machine Wizard</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/cloudvm-add.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
</listitem>
<listitem>
<para>
Configure the following settings:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Source:</emphasis> The cloud
service provider that hosts the instance used for the
cloud VM. Select
<emphasis role="bold">&oci;</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Profile:</emphasis> The cloud
profile used to connect to the running instance.
Select from the available cloud profiles.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Instances:</emphasis> The
instance to use for the cloud VM. Choose from the
available instances on your cloud service.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Finish</emphasis> to add a
cloud VM based on the selected instance.
</para>
<para>
A cloud VM with the same name as the instance is added to
the <emphasis role="bold">OCI</emphasis> group in
&vbox-mgr;.
</para>
</listitem>
<listitem>
<para>
(Optional) To change the display name for the instance,
click <emphasis role="bold">Settings</emphasis> and edit
the <emphasis role="bold">Display Name</emphasis> field.
</para>
<para>
The cloud VM name in &vbox-mgr; is updated automatically.
</para>
</listitem>
</orderedlist>
</sect3>
<sect3 id="cloud-vm-settings">
<title>Changing Settings for a Cloud VM</title>
<para>
Select the cloud VM in &vbox-mgr; and click
<emphasis role="bold">Settings</emphasis>.
</para>
<itemizedlist>
<listitem>
<para>
For a <emphasis>new</emphasis> cloud VM, you can change
many settings for the &oci; instance, such as the display
name, shape, and disk size.
</para>
</listitem>
<listitem>
<para>
When you <emphasis>add</emphasis> a cloud VM based on an
existing &oci; instance you can only change the display
name.
</para>
</listitem>
</itemizedlist>
</sect3>
<sect3 id="cloud-vm-control">
<title>Controlling a Cloud VM</title>
<para>
You can use &vbox-mgr; to control a cloud VM as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Start.</emphasis> Use the
<emphasis role="bold">Start</emphasis> button in the
&vbox-mgr; toolbar.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Stop.</emphasis> Right-click on the
cloud VM name, to display the
<emphasis role="bold">Close</emphasis> menu. Options to
shut down and power off the cloud VM are available.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Terminate.</emphasis> Use the
<emphasis role="bold">Terminate</emphasis> button in the
&vbox-mgr; toolbar.
</para>
<caution>
<para>
This action deletes the instance from &oci;.
</para>
</caution>
</listitem>
</itemizedlist>
<para>
When you control a cloud VM in &vbox-mgr; the machine list is
updated automatically with the current instance state, such as
<emphasis role="bold">Stopped</emphasis> or
<emphasis role="bold">Running</emphasis>.
</para>
<para>
When you control an instance using the &oci; console,
&vbox-mgr; updates the status for the corresponding cloud VM
automatically.
</para>
</sect3>
<sect3 id="cloud-vm-remove">
<title>Removing a Cloud VM</title>
<para>
You can use &vbox-mgr; to remove a cloud VM as follows:
</para>
<para>
Right-click on the cloud VM name and select
<emphasis role="bold">Remove</emphasis>.
</para>
<itemizedlist>
<listitem>
<para>
Click <emphasis role="bold">Remove Only</emphasis> to
remove the cloud VM from the machine list in VirtualBox
Manager.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Delete Everything</emphasis>
to remove the cloud VM from &vbox-mgr; and also to delete
the &oci; instance and any associated boot volumes.
</para>
</listitem>
</itemizedlist>
</sect3>
<sect3 id="cloud-vm-instance-console">
<title>Creating an Instance Console Connection for a Cloud VM</title>
<para>
To create a instance console connection, the cloud VM must be
in <emphasis role="bold">Running</emphasis> state.
</para>
<orderedlist>
<listitem>
<para>
Right-click on the cloud VM name and select
<emphasis role="bold">Console</emphasis>,
<emphasis role="bold">Create Connection</emphasis>.
</para>
</listitem>
<listitem>
<para>
The <emphasis role="bold">Public Key</emphasis> dialog is
displayed. Paste the public key used for the instance
connection into the dialog and click
<emphasis role="bold">OK</emphasis>.
</para>
<para>
By default, either the first entry in your SSH keys folder
or the public key used for your previous instance console
connection is used.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Connect</emphasis> to connect
to the instance. An instance console is displayed
automatically on the host.
</para>
</listitem>
<listitem>
<para>
(Optional) Click <emphasis role="bold">Show Log</emphasis>
to display log messages for the instance console
connection.
</para>
</listitem>
</orderedlist>
<para>
See the &oci; documentation for details about how you can use
an instance console connection to troubleshoot instance
problems.
</para>
</sect3>
</sect2>
<sect2 id="cloud-export-oci">
<title>Exporting an Appliance to &oci;</title>
<para>
&product-name; supports the export of VMs to an &oci; service.
The exported VM is stored on &oci; as a custom Linux image. You
can configure whether a cloud instance is created and started
after the export process has completed.
</para>
<note>
<para>
Before you export a VM to &oci;, you must prepare the VM as
described in <xref linkend="cloud-export-oci-prepare-vm"/>.
</para>
</note>
<para>
Use the following steps to export a VM to &oci;:
</para>
<orderedlist>
<listitem>
<para>
Select <emphasis role="bold">File</emphasis>,
<emphasis role="bold">Export Appliance</emphasis> to open
the <emphasis role="bold">Export Virtual
Appliance</emphasis> wizard.
</para>
<para>
Select a VM to export and click
<emphasis role="bold">Next</emphasis> to display the
<emphasis role="bold">Format Settings</emphasis> page.
</para>
</listitem>
<listitem>
<para>
From the <emphasis role="bold">Format</emphasis> drop-down
list, select <emphasis role="bold">&oci;</emphasis>.
</para>
<para>
In the <emphasis role="bold">Profile</emphasis> drop-down
list, select the cloud profile used for your &oci; account.
</para>
<figure id="fig-export-appliance-oci">
<title>Export Virtual Appliance Wizard: Format Settings</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/export-appliance-oci.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
In the <emphasis role="bold">Machine Creation</emphasis>
field, select an option to configure settings for the cloud
instance created when you export to &oci;. The options
enable you to do one of the following:
</para>
<itemizedlist>
<listitem>
<para>
Configure settings for the cloud instance
<emphasis>after</emphasis> you have finished exporting
the VM.
</para>
</listitem>
<listitem>
<para>
Configure settings for the cloud instance
<emphasis>before</emphasis> you start to export the VM.
</para>
</listitem>
<listitem>
<para>
Do not create a cloud instance when you export the VM.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Next</emphasis> to make an API
request to the &oci; service and open the
<emphasis role="bold">Appliance Settings</emphasis> page.
</para>
</listitem>
<listitem>
<para>
(Optional) Edit storage settings used for the exported
virtual machine in &oci;. You can change the following
settings:
</para>
<itemizedlist>
<listitem>
<para>
The name of the bucket used to store the exported files.
</para>
</listitem>
<listitem>
<para>
Whether to store the custom image in &oci;.
</para>
</listitem>
<listitem>
<para>
The display name for the custom image in &oci;.
</para>
</listitem>
<listitem>
<para>
The launch mode for the custom image.
</para>
<para>
<emphasis role="bold">Paravirtualized</emphasis> mode
gives improved performance and should be suitable for
most &product-name; VMs.
</para>
<para>
<emphasis role="bold">Emulated</emphasis> mode is
suitable for legacy OS images.
</para>
</listitem>
</itemizedlist>
<para>
Click <emphasis role="bold">Finish</emphasis> to continue.
</para>
</listitem>
<listitem>
<para>
(Optional) Depending on the selection in the
<emphasis role="bold">Machine Creation</emphasis> field, the
<emphasis role="bold">Appliance Settings</emphasis> page may
be displayed before or after export. This screen enables you
to configure settings for the cloud instance, such as Shape
and Disk Size.
</para>
<para>
Click <emphasis role="bold">Finish</emphasis>. The VM is
exported to &oci;.
</para>
<para>
Depending on the <emphasis role="bold">Machine
Creation</emphasis> setting, a cloud instance may be started
after upload to &oci; is completed.
</para>
</listitem>
<listitem>
<para>
Monitor the export process by using the &oci; Console.
</para>
</listitem>
</orderedlist>
<para>
You can also use the <command>VBoxManage export</command>
command to export a VM to &oci;. See
<xref linkend="vboxmanage-export-cloud"/>.
</para>
<sect3 id="cloud-export-oci-prepare-vm">
<title>Preparing a VM for Export to &oci;</title>
<para>
&oci; provides the option to import a custom Linux image.
Before an &product-name; image can be exported to &oci;, the
custom image needs to be prepared to ensure that instances
launched from the custom image can boot correctly and that
network connections will work. This section provides advice on
how to prepare a Linux image for export from &product-name;.
</para>
<para>
The following list shows some tasks to consider when preparing
an Oracle Linux VM for export:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Use DHCP for network
addresses.</emphasis> Configure the VM to use a DHCP
server to allocate network addresses, rather than using a
static IP address. The &oci; instance will then be
allocated an IP address automatically.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Do not specify a MAC
address.</emphasis> The network interface configuration
for the VM must not specify the MAC address.
</para>
<para>
Remove the HWADDR setting from the
<filename>/etc/sysconfig/ifcfg-<replaceable>devicename</replaceable></filename>
network script.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Disable persistent network device
naming rules.</emphasis> This means that the &oci;
instance will use the same network device names as the VM.
</para>
<orderedlist>
<listitem>
<para>
Change the GRUB kernel parameters.
</para>
<para>
Add <literal>net.ifnames=0</literal> and
<literal>biosdevname=0</literal> as kernel parameter
values to the <literal>GRUB_CMDLINE_LINUX</literal>
variable.
</para>
</listitem>
<listitem>
<para>
Update the GRUB configuration.
</para>
<screen># grub2-mkconfig -o /boot/grub2/grub.cfg</screen>
</listitem>
<listitem>
<para>
Disable any <literal>udev</literal> rules for network
device naming.
</para>
<para>
For example, if an automated <literal>udev</literal>
rule exists for <literal>net-persistence</literal>:
</para>
<screen># cd /etc/udev/rules.d
# rm -f 70-persistent-net.rules
# ln -s /dev/null /etc/udev/rules.d/70-persistent-net.rules</screen>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Enable the serial
console.</emphasis> This enables you to troubleshoot the
instance when it is running on &oci;.
</para>
<orderedlist>
<listitem>
<para>
Edit the <filename>/etc/default/grub</filename> file,
as follows:
</para>
<itemizedlist>
<listitem>
<para>
Remove the <literal>resume</literal> setting from
the kernel parameters. This setting slows down
boot time significantly.
</para>
</listitem>
<listitem>
<para>
Replace <literal>GRUB_TERMINAL="gfxterm"</literal>
with <literal>GRUB_TERMINAL="console
serial"</literal>. This configures use of the
serial console instead of a graphical terminal.
</para>
</listitem>
<listitem>
<para>
Add <literal>GRUB_SERIAL_COMMAND="serial --unit=0
--speed=115200"</literal>. This configures the
serial connection.
</para>
</listitem>
<listitem>
<para>
Add <literal>console=tty0
console=ttyS0,115200</literal> to the
<literal>GRUB_CMDLINE_LINUX</literal> variable.
This adds the serial console to the Linux kernel
boot parameters.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Regenerate the GRUB configuration.
</para>
<screen># grub2-mkconfig -o /boot/grub2/grub.cfg</screen>
</listitem>
<listitem>
<para>
To verify the changes, reboot the machine and run the
<command>dmesg</command> command to look for the
updated kernel parameters.
</para>
<screen># dmesg |grep console=ttyS0</screen>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Enable paravirtualized device
support.</emphasis> You do this by adding the
<literal>virtio</literal> drivers to the
<literal>initrd</literal> for the VM.
</para>
<orderedlist>
<listitem>
<para>
This procedure works only on machines with a Linux
kernel of version 3.4 or later. Check that the VM is
running a supported kernel:
</para>
<screen># uname -a</screen>
</listitem>
<listitem>
<para>
Use the <literal>dracut</literal> tool to rebuild
<literal>initrd</literal>. Add the
<literal>qemu</literal> module, as follows:
</para>
<screen># dracut –-logfile /var/log/Dracut.log --force --add qemu</screen>
</listitem>
<listitem>
<para>
Verify that the <literal>virtio</literal> drivers are
now present in <literal>initrd</literal>.
</para>
<screen> # lsinitrd |grep virtio</screen>
</listitem>
</orderedlist>
</listitem>
</itemizedlist>
<para>
For more information about importing a custom Linux image into
&oci;, see also:
</para>
<para>
<ulink url="https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/importingcustomimagelinux.htm" />
</para>
</sect3>
</sect2>
<sect2 id="cloud-import-oci">
<title>Importing an Instance from &oci;</title>
<para>
Perform the following steps to import a cloud instance from
&oci; into &product-name;:
</para>
<orderedlist>
<listitem>
<para>
Select <emphasis role="bold">File</emphasis>,
<emphasis role="bold">Import Appliance</emphasis> to open
the <emphasis role="bold">Import Virtual
Appliance</emphasis> wizard.
</para>
<para>
In the <emphasis role="bold">Source</emphasis> drop-down
list, select <emphasis role="bold">&oci;</emphasis>.
</para>
<para>
In the <emphasis role="bold">Profile</emphasis> drop-down
list, select the cloud profile for your &oci; account.
</para>
<para>
Choose the required cloud instance from the list in the
<emphasis role="bold">Machines</emphasis> field.
</para>
<para>
Click <emphasis role="bold">Next</emphasis> to make an API
request to the &oci; service and display the
<emphasis role="bold">Appliance Settings</emphasis> page.
</para>
</listitem>
<listitem>
<para>
(Optional) Edit settings for the new local virtual machine.
</para>
<para>
For example, you can edit the VM name and description.
</para>
<figure id="fig-import-instance-oci">
<title>Import Cloud Instance Wizard: Appliance Settings</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/import-instance.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
<para>
Click <emphasis role="bold">Finish</emphasis> to import the
instance from &oci;.
</para>
</listitem>
<listitem>
<para>
Monitor the import process by using the &oci; Console.
</para>
</listitem>
</orderedlist>
<para>
You can also use the <command>VBoxManage import</command>
command to import an instance from &oci;. See
<xref linkend="vboxmanage-import-cloud"/>.
</para>
<simplesect id="import-instance-sequence">
<title>Importing an Instance: Overview of Events</title>
<para>
The following describes the sequence of events when you import
an instance from &oci;.
</para>
<itemizedlist>
<listitem>
<para>
A custom image is created from the boot volume of the
instance.
</para>
</listitem>
<listitem>
<para>
The custom image is exported to an &oci; object and is
stored using Object Storage in the bucket specified by the
user.
</para>
</listitem>
<listitem>
<para>
The &oci; object is downloaded to the local host. The
object is a TAR archive which contains a boot volume of
the instance in QCOW2 format and a JSON file containing
metadata related to the instance.
</para>
</listitem>
<listitem>
<para>
The boot volume of the instance is extracted from the
archive and a new VMDK image is created by converting the
boot volume into the VMDK format. The VMDK image is
registered with &product-name;.
</para>
</listitem>
<listitem>
<para>
A new VM is created using the VMDK image for the cloud
instance.
</para>
<para>
By default, the new VM is not started after import from
&oci;.
</para>
</listitem>
<listitem>
<para>
The downloaded TAR archive is deleted after a successful
import.
</para>
</listitem>
</itemizedlist>
</simplesect>
</sect2>
<sect2 id="cloud-using-cloud-networks">
<title>Using a Cloud Network</title>
<para>
A cloud network is a type of network that can be used for
connections from a local VM to a remote &oci; cloud instance.
</para>
<para>
To create and use a cloud network, do the following:
</para>
<orderedlist>
<listitem>
<para>
Set up a virtual cloud network on &oci;.
</para>
<para>
The following steps create and configure a virtual cloud
network (VCN) on &oci;. The VCN is used to tunnel network
traffic across the cloud.
</para>
<orderedlist>
<listitem>
<para>
Ensure that you have a cloud profile for connecting to
&oci;. See <xref linkend="cloud-create-cloud-profile"/>.
</para>
</listitem>
<listitem>
<para>
Run the following <command>VBoxManage cloud</command>
command:
</para>
<screen>VBoxManage cloud --provider="OCI" --profile="vbox-oci" network setup</screen>
<para>
where <literal>vbox-oci</literal> is the name of your
cloud profile.
</para>
<para>
Other options are available for the <command>VBoxManage
cloud network setup</command> command, to enable you to
configure details for the VCN. For example, you can
configure the operating system used for the cloud
gateway instance and the IP address range used by the
tunneling network. See
<xref linkend="vboxmanage-cloud"/>.
</para>
<para>
For best results, use an Oracle Linux 7 instance for the
cloud gateway. This is the default option.
</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
<para>
Register the new cloud network with &product-name;.
</para>
<para>
Use the <emphasis role="bold">Cloud Networks</emphasis> tab
in the <emphasis role="bold">Network Manager</emphasis>
tool. See
<xref linkend="network-manager-cloud-network-tab"/>.
</para>
</listitem>
<listitem>
<para>
Add cloud network adaptors to the local VMs that will use
the cloud network. See <xref linkend="network_cloud"/>.
</para>
</listitem>
</orderedlist>
</sect2>
<sect2 id="cloud-using-cli">
<title>Using VBoxManage Commands With &oci;</title>
<para>
This section includes some examples of how
<command>VBoxManage</command> commands can be used to integrate
with &oci; and perform common cloud operations.
</para>
<para>
<emphasis role="bold">Creating a Cloud Profile</emphasis>
</para>
<para>
To create a cloud profile called <literal>vbox-oci</literal>:
</para>
<screen>VBoxManage cloudprofile --provider "OCI" --profile="vbox-oci" add \
--clouduser="ocid1.user.oc1..." --keyfile="/home/username/.oci/oci_api_key.pem" \
--tenancy="ocid1.tenancy.oc1..." --compartment="ocid1.compartment.oc1..." --region="us-ashburn-1"
</screen>
<para>
The new cloud profile is added to the
<filename>oci_config</filename> file in your &product-name;
global configuration directory. For example, this is
<filename>$HOME/.VirtualBox/oci_config</filename> on a Windows
host.
</para>
<para>
<emphasis role="bold">Listing Cloud Instances</emphasis>
</para>
<para>
To list the instances in your &oci; compartment:
</para>
<screen>VBoxManage cloud --provider="OCI" --profile="vbox-oci" list instances
</screen>
<para>
<emphasis role="bold">Exporting an &product-name; VM to the
Cloud</emphasis>
</para>
<para>
To export a VM called <literal>myVM</literal> and create a cloud
instance called <literal>myVM_Cloud</literal>:
</para>
<screen>VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \
--cloudprofile "vbox-oci" --cloudbucket myBucket \
--cloudshape VM.Standard2.1 --clouddomain US-ASHBURN-AD-1 --clouddisksize 50 \
--cloudocivcn ocid1.vcn.oc1... --cloudocisubnet ocid1.subnet.oc1... \
--cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true
</screen>
<para>
<emphasis role="bold">Importing a Cloud Instance Into
&product-name;</emphasis>
</para>
<para>
To import a cloud instance and create an &product-name; VM
called <literal>oci_Import</literal>:
</para>
<screen>VBoxManage import OCI:// --cloud --vmname oci_Import --memory 4000
--cpus 3 --ostype FreeBSD_64 --cloudprofile "vbox-oci"
--cloudinstanceid ocid1.instance.oc1... --cloudbucket myBucket
</screen>
<para>
<emphasis role="bold">Creating a New Cloud Instance From a
Custom Image</emphasis>
</para>
<para>
To create a new cloud instance from a custom image on &oci;:
</para>
<screen>VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance create \
--domain-name="oraclecloud.com" --image-id="ocid1.image.oc1..." --display-name="myInstance" \
--shape="VM.Standard2.1" --subnet="ocid1.subnet.oc1..."</screen>
<para>
<emphasis role="bold">Terminating a Cloud Instance</emphasis>
</para>
<para>
To terminate an instance in your compartment on &oci;:
</para>
<screen>VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance terminate \
--id="ocid1.instance.oc1..." </screen>
<para>
For more details about the available commands for cloud
operations, see <xref linkend="vboxmanage-cloud"/>.
</para>
</sect2>
</sect1>
<sect1 id="preferences">
<title>Preferences</title>
<para>
The Preferences window offers a selection of settings, which apply
to all virtual machines of the current user.
</para>
<para>
To display the Preferences window, do either of the following:
</para>
<itemizedlist>
<listitem>
<para>
Select <emphasis role="bold">File</emphasis>,
<emphasis role="bold">Preferences</emphasis>.
</para>
</listitem>
<listitem>
<para>
Click <emphasis role="bold">Preferences</emphasis> on the
Welcome screen in &vbox-mgr;.
</para>
</listitem>
</itemizedlist>
<para>
The following settings are available:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">General.</emphasis> Enables you to
specify the default folder or directory for VM files, and the
VRDP Authentication Library.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Input.</emphasis> Enables you to specify
keyboard shortcuts, such as the <emphasis role="bold">Host
key</emphasis>. This is the key that toggles whether the
cursor is in the focus of the VM or the Host OS windows, see
<xref linkend="keyb_mouse_normal"/>. The Host key is also used
to trigger certain VM actions, see
<xref linkend="specialcharacters"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Update.</emphasis> Enables you to
specify various settings for Automatic Updates.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Language.</emphasis> Enables you to
specify the language used for menus, labels, and text in
&vbox-mgr;.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Display.</emphasis> Enables you to
specify the screen resolution, and its width and height. A
default scale factor can be specified for all guest screens.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Proxy.</emphasis> Enables you to
configure an HTTP Proxy Server.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Interface.</emphasis> Enables you to
select a color theme for the &vbox-mgr; user interface.
</para>
<note>
<para>
This setting is only available on Windows host platforms.
</para>
</note>
</listitem>
</itemizedlist>
</sect1>
<sect1 id="frontends">
<title>Alternative Front-Ends</title>
<para>
As briefly mentioned in <xref linkend="features-overview" />,
&product-name; has a very flexible internal design that enables
you to use multiple interfaces to control the same virtual
machines. For example, you can start a virtual machine with the
&vbox-mgr; window and then stop it from the command line. With
&product-name;'s support for the Remote Desktop Protocol (RDP),
you can even run virtual machines remotely on a headless server
and have all the graphical output redirected over the network.
</para>
<para>
The following front-ends are shipped in the standard
&product-name; package:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">VirtualBox.</emphasis> This is the
&vbox-mgr;, a graphical user interface that uses the Qt
toolkit. This interface is described throughout this manual.
While this is the simplest and easiest front-end to use, some
of the more advanced &product-name; features are not included.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">VBoxManage.</emphasis> A command-line
interface for automated and detailed control of every aspect
of &product-name;. See
<xref
linkend="vboxmanage" />.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">VBoxHeadless.</emphasis> A front-end
that produces no visible output on the host at all, but can
act as a RDP server if the VirtualBox Remote Desktop Extension
(VRDE) is installed and enabled for the VM. As opposed to the
other graphical interfaces, the headless front-end requires no
graphics support. This is useful, for example, if you want to
host your virtual machines on a headless Linux server that has
no X Window system installed. See
<xref linkend="vboxheadless" />.
</para>
</listitem>
</itemizedlist>
<para>
If the above front-ends still do not satisfy your particular
needs, it is possible to create yet another front-end to the
complex virtualization engine that is the core of &product-name;,
as the &product-name; core neatly exposes all of its features in a
clean API. See <xref linkend="VirtualBoxAPI" />.
</para>
</sect1>
<sect1 id="soft-keyb">
<title>Soft Keyboard</title>
<para>
&product-name; provides a <emphasis>soft keyboard</emphasis> that
enables you to input keyboard characters on the guest. A soft
keyboard is an on-screen keyboard that can be used as an
alternative to a physical keyboard. See
<xref linkend="soft-keyb-using"/> for details of how to use the
soft keyboard.
</para>
<caution>
<para>
For best results, ensure that the keyboard layout configured on
the guest OS matches the keyboard layout used by the soft
keyboard. &product-name; does not do this automatically.
</para>
</caution>
<figure id="fig-soft-keyb">
<title>Soft Keyboard in a Guest Virtual Machine</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/softkeybd.png"
width="14cm" />
</imageobject>
</mediaobject>
</figure>
<para>
The soft keyboard can be used in the following scenarios:
</para>
<itemizedlist>
<listitem>
<para>
When the physical keyboard on the host is not the same as the
keyboard layout configured on the guest. For example, if the
guest is configured to use an international keyboard, but the
host keyboard is US English.
</para>
</listitem>
<listitem>
<para>
To send special key combinations to the guest. Note that some
common key combinations are also available in the
<emphasis role="bold">Input</emphasis>,
<emphasis role="bold">Keyboard</emphasis> menu of the guest VM
window. See <xref linkend="specialcharacters"/>.
</para>
</listitem>
<listitem>
<para>
For guests in kiosk mode, where a physical keyboard is not
present.
</para>
</listitem>
<listitem>
<para>
When using nested virtualization, the soft keyboard provides a
method of sending key presses to a guest.
</para>
</listitem>
</itemizedlist>
<para>
By default, the soft keyboard includes some common international
keyboard layouts. You can copy and modify these to meet your own
requirements. See <xref linkend="soft-keyb-custom"/>.
</para>
<sect2 id="soft-keyb-using">
<title>Using the Soft Keyboard</title>
<orderedlist>
<listitem>
<para>
Display the soft keyboard.
</para>
<para>
In the guest VM window, select
<emphasis role="bold">Input</emphasis>,
<emphasis role="bold">Keyboard</emphasis>,
<emphasis role="bold">Soft Keyboard</emphasis>.
</para>
</listitem>
<listitem>
<para>
Select the required keyboard layout.
</para>
<para>
The name of the current keyboard layout is displayed in the
toolbar of the soft keyboard window. This is the previous
keyboard layout that was used.
</para>
<para>
Click the <emphasis role="bold">Layout List</emphasis> icon
in the toolbar of the soft keyboard window. The
<emphasis role="bold">Layout List</emphasis> window is
displayed.
</para>
<para>
Select the required keyboard layout from the entries in the
<emphasis role="bold">Layout List</emphasis> window.
</para>
<para>
The keyboard display graphic is updated to show the
available input keys.
</para>
</listitem>
<listitem>
<para>
Use the soft keyboard to enter keyboard characters on the
guest.
</para>
<itemizedlist>
<listitem>
<para>
Modifier keys such as Shift, Ctrl, and Alt are available
on the soft keyboard. Click once to select the modifier
key, click twice to lock the modifier key.
</para>
<para>
The <emphasis role="bold">Reset the Keyboard and Release
All Keys</emphasis> icon can be used to release all
pressed modifier keys, both on the host and the guest.
</para>
</listitem>
<listitem>
<para>
To change the look of the soft keyboard, click the
<emphasis role="bold">Settings</emphasis> icon in the
toolbar. You can change colors used in the keyboard
graphic, and can hide or show sections of the keyboard,
such as the NumPad or multimedia keys.
</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</sect2>
<sect2 id="soft-keyb-custom">
<title>Creating a Custom Keyboard Layout</title>
<para>
You can use one of the supplied default keyboard layouts as the
starting point to create a custom keyboard layout.
</para>
<note>
<para>
To permananently save a custom keyboard layout, you must save
it to a file. Otherwise, any changes you make are discarded
when you close down the <emphasis role="bold">Soft
Keyboard</emphasis> window.
</para>
<para>
Custom keyboard layouts that you save are stored as an XML
file on the host, in the <filename>keyboardLayouts</filename>
folder in the global configuration data directory. For
example, in
<filename>$HOME/.config/VirtualBox/keyboardLayouts</filename>
on a Linux host.
</para>
</note>
<orderedlist>
<listitem>
<para>
Display the <emphasis role="bold">Layout List</emphasis>.
</para>
<para>
Click the <emphasis role="bold">Layout List</emphasis> icon
in the toolbar of the soft keyboard window.
</para>
</listitem>
<listitem>
<para>
Make a copy of an existing keyboard layout.
</para>
<para>
Highlight the required layout and click the
<emphasis role="bold">Copy the Selected Layout</emphasis>
icon.
</para>
<para>
A new layout entry with a name suffix of
<literal>-Copy</literal> is created.
</para>
</listitem>
<listitem>
<para>
Edit the new keyboard layout.
</para>
<para>
Highlight the new layout in the <emphasis role="bold">Layout
List</emphasis> and click the <emphasis role="bold">Edit the
Selected Layout</emphasis> icon.
</para>
<para>
Enter a new name for the layout.
</para>
<para>
Edit keys in the new layout. Click on the key that you want
to edit and enter new key captions in the
<emphasis role="bold">Captions</emphasis> fields.
</para>
<para>
The keyboard graphic is updated with the new captions.
</para>
</listitem>
<listitem>
<para>
(Optional) Save the layout to a file. This means that your
custom keyboard layout will be available for future use.
</para>
<para>
Highlight the new layout in the <emphasis role="bold">Layout
List</emphasis> and click the <emphasis role="bold">Save the
Selected Layout into File</emphasis> icon.
</para>
<para>
Any custom layouts that you create can later be removed from
the Layout List, by highlighting and clicking the
<emphasis role="bold">Delete the Selected Layout</emphasis>
icon.
</para>
</listitem>
</orderedlist>
</sect2>
</sect1>
<sect1 id="vm-info">
<title>Monitoring of Virtual Machines</title>
<para>
&vbox-mgr; includes the following tools for viewing runtime
information and changing the configuration of virtual machines.
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold"> VM Activity Overview.</emphasis>
Displays an overview of performance metrics for all running
VMs.
</para>
<para>
See <xref linkend="vm-activity-overview"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Session Information Dialog.</emphasis>
Displays configuration and runtime information for the
selected guest system.
</para>
<para>
See <xref linkend="vm-activity-session-information"/>
</para>
</listitem>
</itemizedlist>
<sect2 id="vm-activity-overview">
<title>VM Activity Overview</title>
<para>
The VM Activity Overview tool displays several performance
metrics for all running virtual machines and for the host
system. This provides an overview of system resources used by
individual virtual machines and the host system.
</para>
<para>
To display the VM Activity Overview tool, do the following:
</para>
<para>
Go to the global <emphasis role="bold">Tools</emphasis> menu and
click <emphasis role="bold">Activities</emphasis>. The
<emphasis role="bold">VM Activity Overview</emphasis> window is
shown.
</para>
<figure id="fig-vm-activity-overview-widget">
<title>VM Activity Overview Tool</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/vm-activity-overview.png"
width="14cm" />
</imageobject>
</mediaobject>
</figure>
<para>
To show metrics for <emphasis>all</emphasis> virtual machines,
including those that are not running, right-click on the list of
virtual machines and select <emphasis role="bold">List All
Virtual Machines</emphasis>.
</para>
<para>
To configure the set of metrics to be shown, click
<emphasis role="bold">Columns</emphasis> in the toolbar. You can
then sort the list of virtual machines by a particular metric.
</para>
<para>
To see more performance information for a virtual machine,
select the VM name and click <emphasis role="bold">VM
Activity</emphasis> in the toolbar. The <emphasis role="bold">VM
Activity</emphasis> tab of the <emphasis role="bold">Session
Information</emphasis> dialog is shown, see
<xref linkend="vm-activity-session-information"/>.
</para>
</sect2>
<sect2 id="vm-activity-session-information">
<title>Session Information Dialog</title>
<para>
The Session Information dialog includes multiple tabs which show
important configuration and runtime information for the guest
system. The tabs of the dialog are as follows:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Configuration Details.</emphasis>
Displays the system configuration of the virtual machine in
a tabular format. The displayed information includes details
such as storage configuration and audio settings.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Runtime Information.</emphasis>
Displays runtime information for the guest session in a
tabular format similar to the Configuration Details tab.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">VM Activity.</emphasis> Includes
several time series charts which monitor guest resource
usage including CPU, RAM, Disk I/O, and Network. Note that
the RAM chart requires the Guest Additions to be running on
the guest system. The VM Activity tab can also be accessed
directly from the VM Activity Overview tool. See
<xref linkend="vm-activity-overview"/>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Guest Control</emphasis>. Details of
processes used by the Guest Control File Manager. See
<xref linkend="guestadd-gc-file-manager"/>.
</para>
</listitem>
</itemizedlist>
<para>
To display the Session Information dialog, select
<emphasis role="bold">Machine</emphasis>,
<emphasis role="bold">Session Information</emphasis> in the
guest VM.
</para>
<figure id="fig-vm-session-information">
<title>Session Information Dialog, Showing VM Activity Tab</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/session-information.png"
width="12cm" />
</imageobject>
</mediaobject>
</figure>
</sect2>
</sect1>
<sect1 id="log-viewer">
<title>The Log Viewer</title>
<para>
Every time you start up a VM, &product-name; creates a log file
that records system configuration and events. The
<emphasis role="bold">Log Viewer</emphasis> is a &vbox-mgr; tool
that enables you to view and analyze system logs.
</para>
<figure id="fig-log-viewer-tool">
<title>Log Viewer Tool, Showing System Events</title>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="images/log-viewer.png"
width="10cm" />
</imageobject>
</mediaobject>
</figure>
<para>
To display the Log Viewer, do either of the following:
</para>
<itemizedlist>
<listitem>
<para>
Click the VM name in the machine list and select
<emphasis role="bold">Logs</emphasis> from the machine tools
menu.
</para>
</listitem>
<listitem>
<para>
In the guest VM, select
<emphasis role="bold">Machine</emphasis>,
<emphasis role="bold">Show Log</emphasis>.
</para>
</listitem>
</itemizedlist>
<para>
Log messages for the VM are displayed in tabs in the Log Viewer
window. See <xref linkend="collect-debug-info"/> for details of
the various log files generated by &product-name;.
</para>
<para>
If you select multiple VMs in the machine list, logs are listed
for each VM.
</para>
<para>
The toolbar of the Log Viewer includes the following options:
</para>
<itemizedlist>
<listitem>
<para>
<emphasis role="bold">Save:</emphasis> Exports the contents of
the selected log file to a text file. Specify the destination
filename and location in the displayed dialog.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Find:</emphasis> Searches for a text
string in the log file.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Filter:</emphasis> Uses filter terms to
display specific types of log messages. Common log message
terms used by &product-name;, such as Audio and NAT, are
included by default. Select one or more terms from the
drop-down list. To add your own filter term, enter the text
string in the text box field.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Bookmark:</emphasis> Saves the location
of a log message, enabling you to find it quickly. To create a
bookmark, either click on the line number, or select some text
and then click <emphasis role="bold">Bookmark</emphasis>.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Options:</emphasis> Configures the text
display used in the log message window.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Refresh:</emphasis> Refreshes the log
file you are currently viewing. Only log messages in the
current tab are updated.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Reload:</emphasis> Refreshes all log
files. Log messages in every tab are updated.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Settings:</emphasis> Displays the
<emphasis role="bold">Settings</emphasis> window for the VM,
enabling you to make configuration changes.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Discard:</emphasis> For a running VM,
discards the saved state for the VM and closes it down.
</para>
</listitem>
<listitem>
<para>
<emphasis role="bold">Show/Start:</emphasis> For a running VM,
<emphasis role="bold">Show</emphasis> displays the VM window.
For a stopped VM, <emphasis role="bold">Start</emphasis>
displays options for powering up the VM.
</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>
|