VirtualBox

source: vbox/trunk/doc/manual/en_US/user_Introduction.xml@ 76694

Last change on this file since 76694 was 76079, checked in by vboxsync, 6 years ago

manual: update supported host OSes (drop 32-bit and "modernize" everything) and guest OSes

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
  • Property svn:mergeinfo set to (toggle deleted branches)
    /branches/VBox-4.0/doc/manual/en_US/user_Introduction.xml71214
    /branches/VBox-4.2/doc/manual/en_US/user_Introduction.xml91503-91504,​91506-91508,​91510,​91514-91515,​91521
    /branches/VBox-4.3/doc/manual/en_US/user_Introduction.xml91223
    /branches/VBox-4.3/trunk/doc/manual/en_US/user_Introduction.xml91223
    /branches/VBox-5.0/doc/manual/en_US/user_Introduction.xml104445
    /branches/dsen/gui/doc/manual/en_US/user_Introduction.xml79076-79078,​79089,​79109-79110,​79112-79113,​79127-79130,​79134,​79141,​79151,​79155,​79157-79159,​79193,​79197
    /branches/dsen/gui2/doc/manual/en_US/user_Introduction.xml79224,​79228,​79233,​79235,​79258,​79262-79263,​79273,​79341,​79345,​79354,​79357,​79387-79388,​79559-79569,​79572-79573,​79578,​79581-79582,​79590-79591,​79598-79599,​79602-79603,​79605-79606,​79632,​79635,​79637,​79644
    /branches/dsen/gui3/doc/manual/en_US/user_Introduction.xml79645-79692
File size: 116.0 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
4<!ENTITY % all.entities SYSTEM "all-entities.ent">
5%all.entities;
6]>
7<chapter id="Introduction">
8
9 <title>First Steps</title>
10
11 <para>
12 Welcome to &product-name;.
13 </para>
14
15 <para>
16 &product-name; is a cross-platform virtualization application. What
17 does that mean? For one thing, it installs on your existing Intel or
18 AMD-based computers, whether they are running Windows, Mac, Linux or
19 Oracle Solaris operating systems. Secondly, it extends the
20 capabilities of your existing computer so that it can run multiple
21 operating systems, inside multiple virtual machines, at the same
22 time. So, for example, you can run Windows and Linux on your Mac,
23 run Windows Server 2008 on your Linux server, run Linux on your
24 Windows PC, and so on, all alongside your existing applications. You
25 can install and run as many virtual machines as you like. The only
26 practical limits are disk space and memory.
27 </para>
28
29 <para>
30 &product-name; is deceptively simple yet also very powerful. It can
31 run everywhere from small embedded systems or desktop class machines
32 all the way up to datacenter deployments and even Cloud
33 environments.
34 </para>
35
36 <para>
37 The following screenshot shows how &product-name;, installed on a
38 Mac computer, is running Windows 8 in a virtual machine window:
39 </para>
40
41 <figure id="fig-win8-intro">
42 <title>Windows 8 Virtual Machine, Displayed on a Mac OS X Host</title>
43 <mediaobject>
44 <imageobject>
45 <imagedata align="center" fileref="images/vm-vista-running.png"
46 width="14cm" />
47 </imageobject>
48 </mediaobject>
49 </figure>
50
51 <para>
52 In this User Manual, we will begin simply with a quick introduction
53 to virtualization and how to get your first virtual machine running
54 with the easy-to-use &product-name; graphical user interface.
55 Subsequent chapters will go into much more detail covering more
56 powerful tools and features, but fortunately, it is not necessary to
57 read the entire User Manual before you can use &product-name;.
58 </para>
59
60 <para>
61 You can find a summary of &product-name;'s capabilities in
62 <xref linkend="features-overview" />. For existing &product-name;
63 users who just want to find out what is new in this release, see the
64 <emphasis>&product-name; Release Notes</emphasis>.
65 </para>
66
67 <sect1 id="virt-why-useful">
68
69 <title>Why is Virtualization Useful?</title>
70
71 <para>
72 The techniques and features that &product-name; provides are
73 useful in the following scenarios:
74 </para>
75
76 <itemizedlist>
77
78 <listitem>
79 <para>
80 <emphasis role="bold">Running multiple operating systems
81 simultaneously.</emphasis> &product-name; enables you to run
82 more than one operating system at a time. This way, you can
83 run software written for one operating system on another, such
84 as Windows software on Linux or a Mac, without having to
85 reboot to use it. Since you can configure what kinds of
86 <emphasis>virtual</emphasis> hardware should be presented to
87 each such operating system, you can install an old operating
88 system such as DOS or OS/2 even if your real computer's
89 hardware is no longer supported by that operating system.
90 </para>
91 </listitem>
92
93 <listitem>
94 <para>
95 <emphasis role="bold">Easier software
96 installations.</emphasis> Software vendors can use virtual
97 machines to ship entire software configurations. For example,
98 installing a complete mail server solution on a real machine
99 can be a tedious task. With &product-name;, such a complex
100 setup, often called an <emphasis>appliance</emphasis>, can be
101 packed into a virtual machine. Installing and running a mail
102 server becomes as easy as importing such an appliance into
103 &product-name;.
104 </para>
105 </listitem>
106
107 <listitem>
108 <para>
109 <emphasis role="bold">Testing and disaster
110 recovery.</emphasis> Once installed, a virtual machine and its
111 virtual hard disks can be considered a
112 <emphasis>container</emphasis> that can be arbitrarily frozen,
113 woken up, copied, backed up, and transported between hosts.
114 </para>
115
116 <para>
117 On top of that, with the use of another &product-name; feature
118 called <emphasis>snapshots</emphasis>, one can save a
119 particular state of a virtual machine and revert back to that
120 state, if necessary. This way, one can freely experiment with
121 a computing environment. If something goes wrong, such as
122 prolems after installing software or infecting the guest with
123 a virus, you can easily switch back to a previous snapshot and
124 avoid the need of frequent backups and restores.
125 </para>
126
127 <para>
128 Any number of snapshots can be created, allowing you to travel
129 back and forward in virtual machine time. You can delete
130 snapshots while a VM is running to reclaim disk space.
131 </para>
132 </listitem>
133
134 <listitem>
135 <para>
136 <emphasis role="bold">Infrastructure consolidation.</emphasis>
137 Virtualization can significantly reduce hardware and
138 electricity costs. Most of the time, computers today only use
139 a fraction of their potential power and run with low average
140 system loads. A lot of hardware resources as well as
141 electricity is thereby wasted. So, instead of running many
142 such physical computers that are only partially used, one can
143 pack many virtual machines onto a few powerful hosts and
144 balance the loads between them.
145 </para>
146 </listitem>
147
148 </itemizedlist>
149
150 </sect1>
151
152 <sect1 id="virtintro">
153
154 <title>Some Terminology</title>
155
156 <para>
157 When dealing with virtualization, and also for understanding the
158 following chapters of this documentation, it helps to acquaint
159 oneself with a bit of crucial terminology, especially the
160 following terms:
161 </para>
162
163 <itemizedlist>
164
165 <listitem>
166 <para>
167 <emphasis role="strong">Host operating system (host
168 OS).</emphasis> This is the operating system of the physical
169 computer on which &product-name; was installed. There are
170 versions of &product-name; for Windows, Mac OS X, Linux, and
171 Oracle Solaris hosts. See <xref linkend="hostossupport" />.
172 </para>
173
174 <para>
175 Most of the time, this manual discusses all &product-name;
176 versions together. There may be platform-specific differences
177 which we will point out where appropriate.
178 </para>
179 </listitem>
180
181 <listitem>
182 <para>
183 <emphasis role="strong"> Guest operating system (guest
184 OS).</emphasis> This is the operating system that is running
185 inside the virtual machine. Theoretically, &product-name; can
186 run any x86 operating system. such as DOS, Windows, OS/2,
187 FreeBSD, and OpenBSD. But to achieve near-native performance
188 of the guest code on your machine, we had to go through a lot
189 of optimizations that are specific to certain operating
190 systems. So while your favorite operating system
191 <emphasis>may</emphasis> run as a guest, we officially support
192 and optimize for a select few, which include the most common
193 operating systems.
194 </para>
195
196 <para>
197 See <xref linkend="guestossupport" />.
198 </para>
199 </listitem>
200
201 <listitem>
202 <para>
203 <emphasis role="strong">Virtual machine (VM).</emphasis> This
204 is the special environment that &product-name; creates for
205 your guest operating system while it is running. In other
206 words, you run your guest operating system
207 <emphasis>in</emphasis> a VM. Normally, a VM will be shown as
208 a window on your computer's desktop, but depending on which of
209 the various frontends of &product-name; you use, it can be
210 displayed in full screen mode or remotely on another computer.
211 </para>
212
213 <para>
214 In a more abstract way, internally, &product-name; thinks of a
215 VM as a set of parameters that determine its behavior. They
216 include hardware settings, such as: how much memory the VM
217 should have, what hard disks &product-name; should virtualize
218 through which container files, what CDs are mounted. They also
219 include state information, such as: whether the VM is
220 currently running, saved, if the VM has snapshots. These
221 settings are mirrored in the VirtualBox Manager window, as
222 well as the <command>VBoxManage</command> command. See
223 <xref linkend="vboxmanage" />. In other words, a VM is also
224 what you can see in its
225 <emphasis role="bold">Settings</emphasis> dialog.
226 </para>
227 </listitem>
228
229 <listitem>
230 <para>
231 <emphasis role="strong">Guest Additions.</emphasis> This
232 refers to special software packages which are shipped with
233 &product-name; but designed to be installed
234 <emphasis>inside</emphasis> a VM to improve performance of the
235 guest OS and to add extra features. See
236 <xref linkend="guestadditions" />.
237 </para>
238 </listitem>
239
240 </itemizedlist>
241
242 </sect1>
243
244 <sect1 id="features-overview">
245
246 <title>Features Overview</title>
247
248 <para>
249 The following is a brief outline of &product-name;'s main
250 features:
251 </para>
252
253 <itemizedlist>
254
255 <listitem>
256 <para>
257 <emphasis role="bold">Portability.</emphasis> &product-name;
258 runs on a large number of 32-bit and 64-bit host operating
259 systems See <xref linkend="hostossupport" />.
260 </para>
261
262 <para>
263 &product-name; is a so-called <emphasis>hosted</emphasis>
264 hypervisor, sometimes referred to as a <emphasis>type
265 2</emphasis> hypervisor. Whereas a
266 <emphasis>bare-metal</emphasis> or <emphasis>type 1</emphasis>
267 hypervisor would run directly on the hardware, &product-name;
268 requires an existing operating system to be installed. It can
269 thus run alongside existing applications on that host.
270 </para>
271
272 <para>
273 To a very large degree, &product-name; is functionally
274 identical on all of the host platforms, and the same file and
275 image formats are used. This enables you to run virtual
276 machines created on one host on another host with a different
277 host operating system. For example, you can create a virtual
278 machine on Windows and then run it under Linux.
279 </para>
280
281 <para>
282 In addition, virtual machines can easily be imported and
283 exported using the Open Virtualization Format (OVF), an
284 industry standard created for this purpose. You can even
285 import OVFs that were created with a different virtualization
286 software. See <xref linkend="ovf" />.
287 </para>
288 </listitem>
289
290 <listitem>
291 <para>
292 <emphasis role="bold">No hardware virtualization
293 required.</emphasis> For many scenarios, &product-name; does
294 not require the processor features built into newer hardware
295 like Intel VT-x or AMD-V. As opposed to many other
296 virtualization solutions, you can therefore use &product-name;
297 even on older hardware where these features are not present.
298 See <xref
299 linkend="hwvirt" />.
300 </para>
301 </listitem>
302
303 <listitem>
304 <para>
305 <emphasis role="bold">Guest Additions: shared folders,
306 seamless windows, 3D virtualization.</emphasis> The
307 &product-name; Guest Additions are software packages which can
308 be installed <emphasis>inside</emphasis> of supported guest
309 systems to improve their performance and to provide additional
310 integration and communication with the host system. After
311 installing the Guest Additions, a virtual machine will support
312 automatic adjustment of video resolutions, seamless windows,
313 accelerated 3D graphics and more. See
314 <xref linkend="guestadditions" />.
315 </para>
316
317 <para>
318 In particular, Guest Additions provide for "shared folders",
319 which let you access files from the host system from within a
320 guest machine. See <xref linkend="sharedfolders" />.
321 </para>
322 </listitem>
323
324 <listitem>
325 <para>
326 <emphasis role="bold">Great hardware support.</emphasis> Among
327 others, &product-name; supports the following:
328 </para>
329
330 <itemizedlist>
331
332 <listitem>
333 <para>
334 <emphasis role="bold">Guest multiprocessing
335 (SMP).</emphasis> &product-name; can present up to 32
336 virtual CPUs to each virtual machine, irrespective of how
337 many CPU cores are physically present on your host.
338 </para>
339 </listitem>
340
341 <listitem>
342 <para>
343 <emphasis role="bold">USB device support.</emphasis>
344 &product-name; implements a virtual USB controller and
345 enables you to connect arbitrary USB devices to your
346 virtual machines without having to install device-specific
347 drivers on the host. USB support is not limited to certain
348 device categories. See <xref linkend="settings-usb" />.
349 </para>
350 </listitem>
351
352 <listitem>
353 <para>
354 <emphasis role="bold">Hardware compatibility.</emphasis>
355 &product-name; virtualizes a vast array of virtual
356 devices, among them many devices that are typically
357 provided by other virtualization platforms. That includes
358 IDE, SCSI and SATA hard disk controllers, several virtual
359 network cards and sound cards, virtual serial and parallel
360 ports and an Input/Output Advanced Programmable Interrupt
361 Controller (I/O APIC), which is found in many modern PC
362 systems. This eases cloning of PC images from real
363 machines and importing of third-party virtual machines
364 into &product-name;.
365 </para>
366 </listitem>
367
368 <listitem>
369 <para>
370 <emphasis role="bold">Full ACPI support.</emphasis> The
371 Advanced Configuration and Power Interface (ACPI) is fully
372 supported by &product-name;. This eases cloning of PC
373 images from real machines or third-party virtual machines
374 into &product-name;. With its unique <emphasis>ACPI power
375 status support</emphasis>, &product-name; can even report
376 to ACPI-aware guest operating systems the power status of
377 the host. For mobile systems running on battery, the guest
378 can thus enable energy saving and notify the user of the
379 remaining power, for example in full screen modes.
380 </para>
381 </listitem>
382
383 <listitem>
384 <para>
385 <emphasis role="bold">Multiscreen resolutions.</emphasis>
386 &product-name; virtual machines support screen resolutions
387 many times that of a physical screen, allowing them to be
388 spread over a large number of screens attached to the host
389 system.
390 </para>
391 </listitem>
392
393 <listitem>
394 <para>
395 <emphasis role="bold">Built-in iSCSI support.</emphasis>
396 This unique feature enables you to connect a virtual
397 machine directly to an iSCSI storage server without going
398 through the host system. The VM accesses the iSCSI target
399 directly without the extra overhead that is required for
400 virtualizing hard disks in container files. See
401 <xref linkend="storage-iscsi" />.
402 </para>
403 </listitem>
404
405 <listitem>
406 <para>
407 <emphasis role="bold">PXE Network boot.</emphasis> The
408 integrated virtual network cards of &product-name; fully
409 support remote booting using the Preboot Execution
410 Environment (PXE).
411 </para>
412 </listitem>
413
414 </itemizedlist>
415 </listitem>
416
417 <listitem>
418 <para>
419 <emphasis role="bold">Multigeneration branched
420 snapshots.</emphasis> &product-name; can save arbitrary
421 snapshots of the state of the virtual machine. You can go back
422 in time and revert the virtual machine to any such snapshot
423 and start an alternative VM configuration from there,
424 effectively creating a whole snapshot tree. See
425 <xref linkend="snapshots" />. You can create and delete
426 snapshots while the virtual machine is running.
427 </para>
428 </listitem>
429
430 <listitem>
431 <para>
432 <emphasis role="bold">VM groups.</emphasis> &product-name;
433 provides a groups feature that enables the user to organize
434 and control virtual machines collectively, as well as
435 individually. In addition to basic groups, it is also possible
436 for any VM to be in more than one group, and for groups to be
437 nested in a hierarchy. This means you can have groups of
438 groups. In general, the operations that can be performed on
439 groups are the same as those that can be applied to individual
440 VMs: Start, Pause, Reset, Close (Save state, Send Shutdown,
441 Poweroff), Discard Saved State, Show in File System, Sort.
442 </para>
443 </listitem>
444
445 <listitem>
446 <para>
447 <emphasis role="bold">Clean architecture and unprecedented
448 modularity.</emphasis> &product-name; has an extremely modular
449 design with well-defined internal programming interfaces and a
450 clean separation of client and server code. This makes it easy
451 to control it from several interfaces at once. For example,
452 you can start a VM simply by clicking on a button in the
453 &product-name; graphical user interface and then control that
454 machine from the command line, or even remotely. See
455 <xref linkend="frontends" />.
456 </para>
457
458 <para>
459 Due to its modular architecture, &product-name; can also
460 expose its full functionality and configurability through a
461 comprehensive <emphasis role="bold">software development kit
462 (SDK),</emphasis> which enables integration of &product-name;
463 with other software systems. See
464 <xref linkend="VirtualBoxAPI" />.
465 </para>
466 </listitem>
467
468 <listitem>
469 <para>
470 <emphasis role="bold">Remote machine display.</emphasis> The
471 VirtualBox Remote Desktop Extension (VRDE) enables
472 high-performance remote access to any running virtual machine.
473 This extension supports the Remote Desktop Protocol (RDP)
474 originally built into Microsoft Windows, with special
475 additions for full client USB support.
476 </para>
477
478 <para>
479 The VRDE does not rely on the RDP server that is built into
480 Microsoft Windows. Instead, the VRDE is plugged directly into
481 the virtualization layer. As a result, it works with guest
482 operating systems other than Windows, even in text mode, and
483 does not require application support in the virtual machine
484 either. The VRDE is described in detail in
485 <xref linkend="vrde" />.
486 </para>
487
488 <para>
489 On top of this special capacity, &product-name; offers you
490 more unique features:
491 </para>
492
493 <itemizedlist>
494
495 <listitem>
496 <para>
497 <emphasis role="bold">Extensible RDP
498 authentication.</emphasis> &product-name; already supports
499 Winlogon on Windows and PAM on Linux for RDP
500 authentication. In addition, it includes an easy-to-use
501 SDK which enables you to create arbitrary interfaces for
502 other methods of authentication. See
503 <xref linkend="vbox-auth" />.
504 </para>
505 </listitem>
506
507 <listitem>
508 <para>
509 <emphasis role="bold">USB over RDP.</emphasis> Using RDP
510 virtual channel support, &product-name; also enables you
511 to connect arbitrary USB devices locally to a virtual
512 machine which is running remotely on a &product-name; RDP
513 server. See <xref linkend="usb-over-rdp" />.
514 </para>
515 </listitem>
516
517 </itemizedlist>
518 </listitem>
519
520 </itemizedlist>
521
522 </sect1>
523
524 <sect1 id="hostossupport">
525
526 <title>Supported Host Operating Systems</title>
527
528 <para>
529 Currently, &product-name; runs on the following host operating
530 systems:
531 </para>
532
533 <itemizedlist>
534
535 <listitem>
536 <para>
537 <emphasis role="bold">Windows hosts (64-bit):</emphasis>
538 </para>
539
540 <itemizedlist>
541
542 <listitem>
543 <para>
544 Windows 7
545 </para>
546 </listitem>
547
548 <listitem>
549 <para>
550 Windows 8
551 </para>
552 </listitem>
553
554 <listitem>
555 <para>
556 Windows 8.1
557 </para>
558 </listitem>
559
560 <listitem>
561 <para>
562 Windows 10 RTM (1507) build 10240
563 </para>
564 </listitem>
565
566 <listitem>
567 <para>
568 Windows 10 November Update (1511) build 10586
569 </para>
570 </listitem>
571
572 <listitem>
573 <para>
574 Windows 10 Anniversary Update (1607) build 14393
575 </para>
576 </listitem>
577
578 <listitem>
579 <para>
580 Windows 10 Creators Update (1703) build 15063
581 </para>
582 </listitem>
583
584 <listitem>
585 <para>
586 Windows 10 Fall Creators Update (1709) build 16299
587 </para>
588 </listitem>
589
590 <listitem>
591 <para>
592 Windows 10 April 2018 Update (1803) build 17134
593 </para>
594 </listitem>
595
596 <listitem>
597 <para>
598 Windows 10 October 2018 Update (1809) build 17763
599 </para>
600 </listitem>
601
602 <listitem>
603 <para>
604 Windows Server 2008 R2
605 </para>
606 </listitem>
607
608 <listitem>
609 <para>
610 Windows Server 2012
611 </para>
612 </listitem>
613
614 <listitem>
615 <para>
616 Windows Server 2012 R2
617 </para>
618 </listitem>
619
620 <listitem>
621 <para>
622 Windows Server 2016
623 </para>
624 </listitem>
625
626 <listitem>
627 <para>
628 Windows Server 2019
629 </para>
630 </listitem>
631
632 </itemizedlist>
633 </listitem>
634
635 <listitem>
636 <para>
637 <emphasis role="bold">Mac OS X hosts (64-bit):</emphasis>
638 </para>
639
640 <itemizedlist>
641
642 <listitem>
643 <para>
644 10.12 (Sierra)
645 </para>
646 </listitem>
647
648 <listitem>
649 <para>
650 10.13 (High Sierra)
651 </para>
652 </listitem>
653
654 <listitem>
655 <para>
656 10.14 (Mojave)
657 </para>
658 </listitem>
659
660 </itemizedlist>
661
662 <para>
663 Intel hardware is required. See also
664 <xref
665 linkend="KnownIssues" />.
666 </para>
667 </listitem>
668
669 <listitem>
670 <para>
671 <emphasis role="bold">Linux hosts (64-bit).</emphasis> Includes the following:
672 </para>
673
674 <itemizedlist>
675
676 <listitem>
677 <para>
678 Ubuntu 16.04 LTS, 18.04 LTS and 18.10
679 </para>
680 </listitem>
681
682 <listitem>
683 <para>
684 Debian GNU/Linux 9 ("Stretch")
685 </para>
686 </listitem>
687
688 <listitem>
689 <para>
690 Oracle Linux 6 and 7
691 </para>
692 </listitem>
693
694 <listitem>
695 <para>
696 Redhat Enterprise Linux 6 and 7
697 </para>
698 </listitem>
699
700 <listitem>
701 <para>
702 Fedora 28 and 29
703 </para>
704 </listitem>
705
706 <listitem>
707 <para>
708 Gentoo Linux
709 </para>
710 </listitem>
711
712 <listitem>
713 <para>
714 SUSE Linux Enterprise server 12 and 15
715 </para>
716 </listitem>
717
718 <listitem>
719 <para>
720 openSUSE Leap 42.3 and 15.0
721 </para>
722 </listitem>
723
724 </itemizedlist>
725
726 <para>
727 It should be possible to use &product-name; on most systems
728 based on Linux kernel 2.6 or 3.x using either the
729 &product-name; installer or by doing a manual installation.
730 See <xref linkend="install-linux-host" />. However, the
731 formally tested and supported Linux distributions are those
732 for which we offer a dedicated package.
733 </para>
734
735 <para>
736 Note that Linux 2.4-based host operating systems are no longer
737 supported.
738 </para>
739 </listitem>
740
741 <listitem>
742 <para>
743 <emphasis role="bold">Oracle Solaris hosts (64-bit
744 only).</emphasis> The following versions are supported with
745 the restrictions listed in <xref linkend="KnownIssues" />:
746 </para>
747
748 <itemizedlist>
749
750 <listitem>
751 <para>
752 Oracle Solaris 11
753 </para>
754 </listitem>
755
756 </itemizedlist>
757 </listitem>
758
759 </itemizedlist>
760
761 <para>
762 Note that the above list is informal. Oracle support for customers
763 who have a support contract is limited to a subset of the listed
764 host operating systems. Also, any feature which is marked as
765 <emphasis>experimental</emphasis> is not supported. Feedback and
766 suggestions about such features are welcome.
767 </para>
768
769 </sect1>
770
771 <sect1 id="hostcpurequirements">
772
773 <title>Host CPU Requirements</title>
774
775 <para>
776 SSE2 is required, starting with &product-name; version 5.2.10 and
777 version 5.1.24.
778 </para>
779
780 </sect1>
781
782 <sect1 id="intro-installing">
783
784 <title>Installing &product-name; and Extension Packs</title>
785
786 <para>
787 &product-name; comes in many different packages, and installation
788 depends on your host operating system. If you have installed
789 software before, installation should be straightforward. On each
790 host platform, &product-name; uses the installation method that is
791 most common and easy to use. If you run into trouble or have
792 special requirements, see <xref linkend="installation" /> for
793 details about the various installation methods.
794 </para>
795
796 <para>
797 &product-name; is split into the following components:
798 </para>
799
800 <itemizedlist>
801
802 <listitem>
803 <para>
804 <emphasis role="bold">Base package.</emphasis> The base
805 package consists of all open source components and is licensed
806 under the GNU General Public License V2.
807 </para>
808 </listitem>
809
810 <listitem>
811 <para>
812 <emphasis role="bold">Extension packs.</emphasis> Additional
813 extension packs can be downloaded which extend the
814 functionality of the &product-name; base package. Currently,
815 Oracle provides a single extension pack, available from:
816 <ulink
817 url="http://www.virtualbox.org">http://www.virtualbox.org</ulink>.
818 The extension pack provides the following added functionality:
819 </para>
820
821 <orderedlist>
822
823 <listitem>
824 <para>
825 The virtual USB 2.0 (EHCI) device. See
826 <xref linkend="settings-usb" />.
827 </para>
828 </listitem>
829
830 <listitem>
831 <para>
832 The virtual USB 3.0 (xHCI) device. See
833 <xref
834 linkend="settings-usb" />.
835 </para>
836 </listitem>
837
838 <listitem>
839 <para>
840 VirtualBox Remote Desktop Protocol (VRDP) support. See
841 <xref linkend="vrde" />.
842 </para>
843 </listitem>
844
845 <listitem>
846 <para>
847 Host webcam passthrough. See
848 <xref linkend="webcam-passthrough" />.
849 </para>
850 </listitem>
851
852 <listitem>
853 <para>
854 Intel PXE boot ROM.
855 </para>
856 </listitem>
857
858 <listitem>
859 <para>
860 Experimental support for PCI passthrough on Linux hosts.
861 See <xref linkend="pcipassthrough" />.
862 </para>
863 </listitem>
864
865 <listitem>
866 <para>
867 Disk image encryption with AES algorithm. See
868 <xref linkend="diskencryption" />.
869 </para>
870 </listitem>
871
872 </orderedlist>
873
874 <para>
875 &product-name; extension packages have a
876 <computeroutput>.vbox-extpack</computeroutput> file name
877 extension. To install an extension, simply double-click on the
878 package file and a <emphasis role="bold">Network Operations
879 Manager</emphasis> window is shown to guide you through the
880 required steps.
881 </para>
882
883 <para>
884 To view the extension packs that are currently installed,
885 start the VirtualBox Manager, as shown in
886 <xref linkend="intro-starting"/>. From the
887 <emphasis role="bold">File</emphasis> menu, select
888 <emphasis role="bold">Preferences</emphasis>. In the window
889 that displays, go to the
890 <emphasis role="bold">Extensions</emphasis> category. This
891 shows you the extensions which are currently installed, and
892 enables you to remove a package or add a new package.
893 </para>
894
895 <para>
896 Alternatively, you can use the <command>VBoxManage</command>
897 command line. See <xref linkend="vboxmanage-extpack" />.
898 </para>
899 </listitem>
900
901 </itemizedlist>
902
903 </sect1>
904
905 <sect1 id="intro-starting">
906
907 <title>Starting &product-name;</title>
908
909 <para>
910 After installation, you can start &product-name; as follows:
911 </para>
912
913 <itemizedlist>
914
915 <listitem>
916 <para>
917 On a Windows host, in the
918 <emphasis role="bold">Programs</emphasis> menu, click on the
919 item in the <emphasis role="bold">VirtualBox</emphasis> group.
920 On Vista or Windows 7, you can also enter
921 <computeroutput>VirtualBox</computeroutput> in the search box
922 of the <emphasis role="bold">Start</emphasis> menu.
923 </para>
924 </listitem>
925
926 <listitem>
927 <para>
928 On a Mac OS X host, in the Finder, double-click on the
929 <emphasis role="bold">VirtualBox</emphasis> item in the
930 Applications folder. You may want to drag this item onto your
931 Dock.
932 </para>
933 </listitem>
934
935 <listitem>
936 <para>
937 On a Linux or Oracle Solaris host, depending on your desktop
938 environment, an &product-name; item may have been placed in
939 either the System or System Tools group of your
940 <emphasis role="bold">Applications</emphasis> menu.
941 Alternatively, you can enter
942 <computeroutput>VirtualBox</computeroutput> in a terminal
943 window.
944 </para>
945 </listitem>
946
947 </itemizedlist>
948
949 <para>
950 When you start &product-name; for the first time, a window like
951 the following is displayed:
952 </para>
953
954 <figure id="fig-vbox-manager-initial">
955 <title>VirtualBox Manager Window, After Initial Startup</title>
956 <mediaobject>
957 <imageobject>
958 <imagedata align="center" fileref="images/virtualbox-main-empty.png"
959 width="10cm" />
960 </imageobject>
961 </mediaobject>
962 </figure>
963
964 <para>
965 This window is called the <emphasis role="bold">VirtualBox
966 Manager</emphasis>. On the left, you can see a pane that will
967 later list all your virtual machines. Since you have not created
968 any, the list is empty. A row of buttons above it enables you to
969 create new VMs and work on existing VMs, once you have some. The
970 pane on the right displays the properties of the virtual machine
971 currently selected, if any. Again, since you do not have any
972 machines yet, the pane displays a welcome message.
973 </para>
974
975 <para>
976 To give you an idea what &product-name; might look like later,
977 after you have created many machines, here is another example:
978 </para>
979
980 <figure id="fig-vbox-manager-populated">
981 <title>VirtualBox Manager Window, After Creating Virtual Machines</title>
982 <mediaobject>
983 <imageobject>
984 <imagedata align="center" fileref="images/virtualbox-main.png"
985 width="10cm" />
986 </imageobject>
987 </mediaobject>
988 </figure>
989
990 </sect1>
991
992 <sect1 id="gui-createvm">
993
994 <title>Creating Your First Virtual Machine</title>
995
996 <para>
997 Click the <emphasis role="bold">New</emphasis> button at the top
998 of the VirtualBox Manager window. A wizard is shown, to guide you
999 through setting up a new virtual machine (VM):
1000 </para>
1001
1002 <figure id="fig-new-vm-name">
1003 <title>Creating a New Virtual Machine: Name and Operating System</title>
1004 <mediaobject>
1005 <imageobject>
1006 <imagedata align="center" fileref="images/create-vm-1.png"
1007 width="10cm" />
1008 </imageobject>
1009 </mediaobject>
1010 </figure>
1011
1012 <para>
1013 On the following pages, the wizard will ask you for the bare
1014 minimum of information that is needed to create a VM, in
1015 particular:
1016 </para>
1017
1018 <orderedlist>
1019
1020 <listitem>
1021 <para>
1022 The <emphasis role="bold">Name</emphasis> of the VM will later
1023 be shown in the machine list of the VirtualBox Manager window,
1024 and it will be used for the VM's files on disk. Even though
1025 any name can be used, bear in mind that if you create a few
1026 VMs, you will appreciate if you have given your VMs rather
1027 informative names."My VM" would thus be less useful than
1028 "Windows XP SP2 with OpenOffice", for example.
1029 </para>
1030 </listitem>
1031
1032 <listitem>
1033 <para>
1034 For <emphasis role="bold">Operating System Type</emphasis>
1035 select the operating system that you want to install later.
1036 The supported operating systems are grouped. If you want to
1037 install something very unusual that is not listed, select
1038 <emphasis role="bold">Other</emphasis>. Depending on your
1039 selection, &product-name; will enable or disable certain VM
1040 settings that your guest operating system may require. This is
1041 particularly important for 64-bit guests. See
1042 <xref linkend="intro-64bitguests" />. It is therefore
1043 recommended to always set it to the correct value.
1044 </para>
1045 </listitem>
1046
1047 <listitem>
1048 <para>
1049 On the next page, select the <emphasis role="bold">Memory
1050 (RAM)</emphasis> that &product-name; should allocate every
1051 time the virtual machine is started. The amount of memory
1052 given here will be taken away from your host machine and
1053 presented to the guest operating system, which will report
1054 this size as the virtual computer's installed RAM.
1055 </para>
1056
1057 <caution>
1058 <para>
1059 Choose this setting carefully. The memory you give to the VM
1060 will not be available to your host OS while the VM is
1061 running, so do not specify more than you can spare. For
1062 example, if your host machine has 1 GB of RAM and you enter
1063 512 MB as the amount of RAM for a particular virtual
1064 machine, while that VM is running, you will only have 512 MB
1065 left for all the other software on your host. If you run two
1066 VMs at the same time, even more memory will be allocated for
1067 the second VM, which may not even be able to start if that
1068 memory is not available. On the other hand, you should
1069 specify as much as your guest OS and your applications will
1070 require to run properly.
1071 </para>
1072 </caution>
1073
1074 <para>
1075 A Windows XP guest will require at least a few hundred MB of
1076 RAM to run properly, and Windows Vista will not install with
1077 less than 512 MB. If you want to run graphics-intensive
1078 applications in your VM, you may require even more RAM.
1079 </para>
1080
1081 <para>
1082 As a rule of thumb, if you have 1 GB of RAM or more in your
1083 host computer, it is usually safe to allocate 512 MB to each
1084 VM. In any case, make sure you always have at least 256 to 512
1085 MB of RAM left on your host operating system. Otherwise you
1086 may cause your host OS to excessively swap out memory to your
1087 hard disk, effectively bringing your host system to a
1088 standstill.
1089 </para>
1090
1091 <para>
1092 As with the other settings, you can change this setting later,
1093 after you have created the VM.
1094 </para>
1095 </listitem>
1096
1097 <listitem>
1098 <para>
1099 Next, you must specify a <emphasis role="bold">Virtual Hard
1100 Disk</emphasis> for your VM.
1101 </para>
1102
1103 <para>
1104 There are many and potentially complicated ways in which
1105 &product-name; can provide hard disk space to a VM, see
1106 <xref linkend="storage" />, but the most common way is to use
1107 a large image file on your "real" hard disk, whose contents
1108 &product-name; presents to your VM as if it were a complete
1109 hard disk. This file represents an entire hard disk then, so
1110 you can even copy it to another host and use it with another
1111 &product-name; installation.
1112 </para>
1113
1114 <para>
1115 The wizard displays the following window:
1116 </para>
1117
1118 <figure id="fig-new-vm-hard-disk">
1119 <title>Creating a New Virtual Machine: Hard Disk</title>
1120 <mediaobject>
1121 <imageobject>
1122 <imagedata align="center" fileref="images/create-vm-2.png"
1123 width="10cm" />
1124 </imageobject>
1125 </mediaobject>
1126 </figure>
1127
1128 <para>
1129 At this screen, you have the following options:
1130 </para>
1131
1132 <itemizedlist>
1133
1134 <listitem>
1135 <para>
1136 To create a new, empty virtual hard disk, click the
1137 <emphasis role="bold">Create</emphasis> button.
1138 </para>
1139 </listitem>
1140
1141 <listitem>
1142 <para>
1143 You can pick an <emphasis>existing</emphasis> disk image
1144 file.
1145 </para>
1146
1147 <para>
1148 The drop-down list presented in the window lists all disk
1149 images which are currently remembered by &product-name;.
1150 These disk images are currently attached to a virtual
1151 machine, or have been attached to a virtual machine.
1152 </para>
1153
1154 <para>
1155 Alternatively, click on the small
1156 <emphasis role="bold">folder icon</emphasis> next to the
1157 drop-down list. In the displayed file dialog, you can
1158 click <emphasis role="bold">Add</emphasis> to select any
1159 disk image file on your host disk.
1160 </para>
1161 </listitem>
1162
1163 </itemizedlist>
1164
1165 <para>
1166 If you are using &product-name; for the first time, you will
1167 want to create a new disk image. Click the
1168 <emphasis role="bold">Create</emphasis> button.
1169 </para>
1170
1171 <para>
1172 This displays another window, the <emphasis role="bold">Create
1173 Virtual Hard Disk Wizard</emphasis> wizard. This wizard helps
1174 you to create a new disk image file in the new virtual
1175 machine's folder.
1176 </para>
1177
1178 <para>
1179 &product-name; supports the following types of image files:
1180 </para>
1181
1182 <itemizedlist>
1183
1184 <listitem>
1185 <para>
1186 A <emphasis role="bold">dynamically allocated
1187 file</emphasis> will only grow in size when the guest
1188 actually stores data on its virtual hard disk. It will
1189 therefore initially be small on the host hard drive and
1190 only later grow to the size specified as it is filled with
1191 data.
1192 </para>
1193 </listitem>
1194
1195 <listitem>
1196 <para>
1197 A <emphasis role="bold">fixed-size file</emphasis> will
1198 immediately occupy the file specified, even if only a
1199 fraction of the virtual hard disk space is actually in
1200 use. While occupying much more space, a fixed-size file
1201 incurs less overhead and is therefore slightly faster than
1202 a dynamically allocated file.
1203 </para>
1204 </listitem>
1205
1206 </itemizedlist>
1207
1208 <para>
1209 For details about the differences, see
1210 <xref linkend="vdidetails" />.
1211 </para>
1212
1213 <para>
1214 To prevent your physical hard disk from running full,
1215 &product-name; limits the size of the image file. Still, it
1216 needs to be large enough to hold the contents of your
1217 operating system and the applications you want to install. For
1218 a modern Windows or Linux guest, you will probably need
1219 several gigabytes for any serious use. The limit of the image
1220 file size can be changed later, see
1221 <xref linkend="vboxmanage-modifyvdi"/>.
1222 </para>
1223
1224 <figure id="fig-new-vm-vdi">
1225 <title>Creating a New Virtual Machine: File Location and Size</title>
1226 <mediaobject>
1227 <imageobject>
1228 <imagedata align="center" fileref="images/create-vdi-1.png"
1229 width="10cm" />
1230 </imageobject>
1231 </mediaobject>
1232 </figure>
1233
1234 <para>
1235 After having selected or created your image file, click
1236 <emphasis role="bold">Next</emphasis> to go to the next page.
1237 </para>
1238 </listitem>
1239
1240 <listitem>
1241 <para>
1242 Click <emphasis role="bold">Create</emphasis>, to create your
1243 new virtual machine. The virtual machine is displayed in the
1244 list on the left side of the VirtualBox Manager window, with
1245 the name that you entered initially.
1246 </para>
1247 </listitem>
1248
1249 </orderedlist>
1250
1251 <note>
1252 <para>
1253 After becoming familiar with the use of wizards, consider using
1254 the Expert Mode available in some wizards. Where available, this
1255 is selectable using a button, and speeds up the process of using
1256 wizards.
1257 </para>
1258 </note>
1259
1260 </sect1>
1261
1262 <sect1 id="intro-running">
1263
1264 <title>Running Your Virtual Machine</title>
1265
1266 <para>
1267 To start a virtual machine, you have several options:
1268 </para>
1269
1270 <itemizedlist>
1271
1272 <listitem>
1273 <para>
1274 Double-click on the VM's entry in the list in the VirtualBox
1275 Manager window.
1276 </para>
1277 </listitem>
1278
1279 <listitem>
1280 <para>
1281 Select the VM's entry in the list in the VirtualBox Manager
1282 window, and click <emphasis role="bold">Start</emphasis> at
1283 the top of the window.
1284 </para>
1285 </listitem>
1286
1287 <listitem>
1288 <para>
1289 Go to the <computeroutput>VirtualBox VMs</computeroutput>
1290 folder in your system user's home directory. Find the
1291 subdirectory of the machine you want to start and double-click
1292 on the machine settings file. This file has a
1293 <computeroutput>.vbox</computeroutput> file extension.
1294 </para>
1295 </listitem>
1296
1297 </itemizedlist>
1298
1299 <para>
1300 Starting a virtual machine displays a new window, and the virtual
1301 machine which you selected will boot up. Everything which would
1302 normally be seen on the virtual system's monitor is shown in the
1303 window. See the screenshot image in
1304 <xref linkend="Introduction"/>.
1305 </para>
1306
1307 <para>
1308 In general, you can use the virtual machine as you would use a
1309 real computer. There are couple of points worth mentioning
1310 however.
1311 </para>
1312
1313 <sect2 id="intro-starting-vm-first-time">
1314
1315 <title>Starting a New VM for the First Time</title>
1316
1317 <para>
1318 When a VM is started for the first time, the
1319 <emphasis role="bold">First Start Wizard</emphasis>, is
1320 displayed. This wizard helps you to select an installation
1321 medium. Since the VM is created empty, it would otherwise behave
1322 just like a real computer with no operating system installed. It
1323 will do nothing and display an error message that no bootable
1324 operating system was found.
1325 </para>
1326
1327 <para>
1328 For this reason, the wizard helps you to select a medium to
1329 install an operating system from.
1330 </para>
1331
1332 <itemizedlist>
1333
1334 <listitem>
1335 <para>
1336 If you have physical CD or DVD media from which you want to
1337 install your guest operating system, such as a Windows
1338 installation CD or DVD, put the media into your host's CD or
1339 DVD drive.
1340 </para>
1341
1342 <para>
1343 In the wizard's drop-down list of installation media, select
1344 <emphasis role="bold">Host Drive</emphasis> with the correct
1345 drive letter. In the case of a Linux host, choose a device
1346 file. This will allow your VM to access the media in your
1347 host drive, and you can proceed to install from there.
1348 </para>
1349 </listitem>
1350
1351 <listitem>
1352 <para>
1353 If you have downloaded installation media from the Internet
1354 in the form of an ISO image file such as with a Linux
1355 distribution, you would normally burn this file to an empty
1356 CD or DVD and proceed as described above. With
1357 &product-name; however, you can skip this step and mount the
1358 ISO file directly. &product-name; will then present this
1359 file as a CD or DVD-ROM drive to the virtual machine, much
1360 like it does with virtual hard disk images.
1361 </para>
1362
1363 <para>
1364 In this case, the wizard's drop-down list contains a list of
1365 installation media that were previously used with
1366 &product-name;.
1367 </para>
1368
1369 <para>
1370 If your medium is not in the list, especially if you are
1371 using &product-name; for the first time, click the small
1372 folder icon next to the drop-down list to display a standard
1373 file dialog. Here you can pick an image file on your host
1374 disks.
1375 </para>
1376 </listitem>
1377
1378 </itemizedlist>
1379
1380 <para>
1381 After completing the choices in the wizard, you will be able to
1382 install your operating system.
1383 </para>
1384
1385 </sect2>
1386
1387 <sect2 id="keyb_mouse_normal">
1388
1389 <title>Capturing and Releasing Keyboard and Mouse</title>
1390
1391 <para>
1392 &product-name; provides a virtual USB tablet device to new
1393 virtual machines through which mouse events are communicated to
1394 the guest operating system. If you are running a modern guest
1395 operating system that can handle such devices, mouse support may
1396 work out of the box without the mouse being
1397 <emphasis>captured</emphasis> as described below. See
1398 <xref linkend="settings-motherboard" />.
1399 </para>
1400
1401 <para>
1402 Otherwise, if the virtual machine only sees standard PS/2 mouse
1403 and keyboard devices, since the operating system in the virtual
1404 machine does not know that it is not running on a real computer,
1405 it expects to have exclusive control over your keyboard and
1406 mouse. But unless you are running the VM in full screen mode,
1407 your VM needs to share keyboard and mouse with other
1408 applications and possibly other VMs on your host.
1409 </para>
1410
1411 <para>
1412 After installing a guest operating system and before you install
1413 the Guest Additions, described later, either your VM or the rest
1414 of your computer can "own" the keyboard and the mouse. Both
1415 cannot own the keyboard and mouse at the same time. You will see
1416 a <emphasis>second</emphasis> mouse pointer which is always
1417 confined to the limits of the VM window. You activate the VM by
1418 clicking inside it.
1419 </para>
1420
1421 <para>
1422 To return ownership of keyboard and mouse to your host operating
1423 system, &product-name; reserves a special key on your keyboard:
1424 the <emphasis>Host key</emphasis>. By default, this is the
1425 <emphasis>right Ctrl key</emphasis> on your keyboard. On a Mac
1426 host, the default Host key is the left Command key. You can
1427 change this default in the &product-name; Global Settings. See
1428 <xref linkend="globalsettings" />. The current setting for the
1429 Host key is always displayed at the bottom right of your VM
1430 window.
1431 </para>
1432
1433 <figure id="fig-host-key">
1434 <title>Host Key Setting on the Virtual Machine Task Bar</title>
1435 <mediaobject>
1436 <imageobject>
1437 <imagedata align="center" fileref="images/vm-hostkey.png"
1438 width="7cm" />
1439 </imageobject>
1440 </mediaobject>
1441 </figure>
1442
1443 <para>
1444 This means the following:
1445 </para>
1446
1447 <itemizedlist>
1448
1449 <listitem>
1450 <para>
1451 Your <emphasis role="bold">keyboard</emphasis> is owned by
1452 the VM if the VM window on your host desktop has the
1453 keyboard focus. If you have many windows open in your guest
1454 operating system, the window that has the focus in your VM
1455 is used. This means that if you want to enter text within
1456 your VM, click on the title bar of your VM window first.
1457 </para>
1458
1459 <para>
1460 To release keyboard ownership, press the Host key. As
1461 explained above, this is typically the right Ctrl key.
1462 </para>
1463
1464 <para>
1465 Note that while the VM owns the keyboard, some key
1466 sequences, such as Alt-Tab, will no longer be seen by the
1467 host, but will go to the guest instead. After you press the
1468 Host key to reenable the host keyboard, all key presses will
1469 go through the host again, so that sequences such as Alt-Tab
1470 will no longer reach the guest. For technical reasons it may
1471 not be possible for the VM to get all keyboard input even
1472 when it does own the keyboard. Examples of this are the
1473 Ctrl-Alt-Del sequence on Windows hosts or single keys
1474 grabbed by other applications on X11 hosts like the GNOME
1475 desktop's "Control key highlights mouse pointer"
1476 functionality.
1477 </para>
1478 </listitem>
1479
1480 <listitem>
1481 <para>
1482 Your <emphasis role="bold">mouse</emphasis> is owned by the
1483 VM only after you have clicked in the VM window. The host
1484 mouse pointer will disappear, and your mouse will drive the
1485 guest's pointer instead of your normal mouse pointer.
1486 </para>
1487
1488 <para>
1489 Note that mouse ownership is independent of that of the
1490 keyboard. Even after you have clicked on a titlebar to be
1491 able to enter text into the VM window, your mouse is not
1492 necessarily owned by the VM yet.
1493 </para>
1494
1495 <para>
1496 To release ownership of your mouse by the VM, press the Host
1497 key.
1498 </para>
1499 </listitem>
1500
1501 </itemizedlist>
1502
1503 <para>
1504 As this behavior can be inconvenient, &product-name; provides a
1505 set of tools and device drivers for guest systems called the
1506 &product-name; Guest Additions which make VM keyboard and mouse
1507 operation a lot more seamless. Most importantly, the Additions
1508 will get rid of the second "guest" mouse pointer and make your
1509 host mouse pointer work directly in the guest. See
1510 <xref linkend="guestadditions" />.
1511 </para>
1512
1513 </sect2>
1514
1515 <sect2 id="specialcharacters">
1516
1517 <title>Typing Special Characters</title>
1518
1519 <para>
1520 Operating systems expect certain key combinations to initiate
1521 certain procedures. Some of these key combinations may be
1522 difficult to enter into a virtual machine, as there are three
1523 candidates as to who receives keyboard input: the host operating
1524 system, &product-name;, or the guest operating system. Which of
1525 these three receives keypresses depends on a number of factors,
1526 including the key itself.
1527 </para>
1528
1529 <itemizedlist>
1530
1531 <listitem>
1532 <para>
1533 Host operating systems reserve certain key combinations for
1534 themselves. For example, it is impossible to enter the
1535 <emphasis role="bold">Ctrl+Alt+Delete</emphasis> combination
1536 if you want to reboot the guest operating system in your
1537 virtual machine, because this key combination is usually
1538 hard-wired into the host OS, both Windows and Linux
1539 intercept this, and pressing this key combination will
1540 therefore reboot your <emphasis>host</emphasis>.
1541 </para>
1542
1543 <para>
1544 On Linux and Oracle Solaris hosts, which use the X Window
1545 System, the key combination
1546 <emphasis role="bold">Ctrl+Alt+Backspace</emphasis> normally
1547 resets the X server and restarts the entire graphical user
1548 interface. As the X server intercepts this combination,
1549 pressing it will usually restart your
1550 <emphasis>host</emphasis> graphical user interface and kill
1551 all running programs, including &product-name;, in the
1552 process.
1553 </para>
1554
1555 <para>
1556 On Linux hosts supporting virtual terminals, the key
1557 combination <emphasis role="bold">Ctrl+Alt+Fx</emphasis>,
1558 where Fx is one of the function keys from F1 to F12,
1559 normally enables you to switch between virtual terminals. As
1560 with Ctrl+Alt+Delete, these combinations are intercepted by
1561 the host operating system and therefore always switch
1562 terminals on the <emphasis>host</emphasis>.
1563 </para>
1564
1565 <para>
1566 If, instead, you want to send these key combinations to the
1567 <emphasis>guest</emphasis> operating system in the virtual
1568 machine, you will need to use one of the following methods:
1569 </para>
1570
1571 <itemizedlist>
1572
1573 <listitem>
1574 <para>
1575 Use the items in the
1576 <emphasis role="bold">Input</emphasis>,
1577 <emphasis role="bold">Keyboard</emphasis> menu of the
1578 virtual machine window. This menu includes the settings
1579 <emphasis role="bold">Insert Ctrl+Alt+Delete</emphasis>
1580 and <emphasis role="bold">Ctrl+Alt+Backspace</emphasis>.
1581 The latter will only have an effect with Linux or Oracle
1582 Solaris guests, however.
1583 </para>
1584
1585 <para>
1586 This menu also includes an option for inserting the Host
1587 key combination.
1588 </para>
1589 </listitem>
1590
1591 <listitem>
1592 <para>
1593 Use special key combinations with the Host key, normally
1594 the right Control key. &product-name; will then
1595 translate these key combinations for the virtual
1596 machine:
1597 </para>
1598
1599 <itemizedlist>
1600
1601 <listitem>
1602 <para>
1603 <emphasis role="bold">Host key + Del</emphasis> to
1604 send Ctrl+Alt+Del to reboot the guest.
1605 </para>
1606 </listitem>
1607
1608 <listitem>
1609 <para>
1610 <emphasis role="bold">Host key +
1611 Backspace</emphasis> to send Ctrl+Alt+Backspace to
1612 restart the graphical user interface of a Linux or
1613 Oracle Solaris guest.
1614 </para>
1615 </listitem>
1616
1617 <listitem>
1618 <para>
1619 <emphasis role="bold">Host key + Function
1620 key</emphasis>. For example, to simulate Ctrl+Alt+Fx
1621 to switch between virtual terminals in a Linux
1622 guest.
1623 </para>
1624 </listitem>
1625
1626 </itemizedlist>
1627 </listitem>
1628
1629 </itemizedlist>
1630 </listitem>
1631
1632 <listitem>
1633 <para>
1634 For some other keyboard combinations such as
1635 <emphasis role="bold">Alt-Tab</emphasis> to switch between
1636 open windows, &product-name; enables you to configure
1637 whether these combinations will affect the host or the
1638 guest, if a virtual machine currently has the focus. This is
1639 a global setting for all virtual machines and can be found
1640 under <emphasis role="bold">File</emphasis>,
1641 <emphasis role="bold">Preferences</emphasis>,
1642 <emphasis role="bold">Input</emphasis>.
1643 </para>
1644 </listitem>
1645
1646 </itemizedlist>
1647
1648 </sect2>
1649
1650 <sect2 id="intro-removable-media-changing">
1651
1652 <title>Changing Removable Media</title>
1653
1654 <para>
1655 While a virtual machine is running, you can change removable
1656 media in the <emphasis role="bold">Devices</emphasis> menu of
1657 the VM's window. Here you can select in detail what
1658 &product-name; presents to your VM as a CD, DVD, or floppy.
1659 </para>
1660
1661 <para>
1662 The settings are the same as would be available for the VM in
1663 the <emphasis role="bold">Settings</emphasis> dialog of the
1664 &product-name; main window. But as the
1665 <emphasis role="bold">Settings</emphasis> dialog is disabled
1666 while the VM is in the Running or Saved state, this extra menu
1667 saves you from having to shut down and restart the VM every time
1668 you want to change media.
1669 </para>
1670
1671 <para>
1672 Hence, in the <emphasis role="bold">Devices</emphasis> menu,
1673 &product-name; enables you to attach the host drive to the guest
1674 or select a floppy or DVD image using the Disk Image Manager, as
1675 described in <xref linkend="configbasics" />.
1676 </para>
1677
1678 </sect2>
1679
1680 <sect2 id="intro-resize-window">
1681
1682 <title>Resizing the Machine's Window</title>
1683
1684 <para>
1685 You can resize the virtual machine's window when it is running.
1686 In that case, one of the following things will happen:
1687 </para>
1688
1689 <orderedlist>
1690
1691 <listitem>
1692 <para>
1693 If you have <emphasis role="bold">scale mode</emphasis>
1694 enabled, then the virtual machine's screen will be scaled to
1695 the size of the window. This can be useful if you have many
1696 machines running and want to have a look at one of them
1697 while it is running in the background. Alternatively, it
1698 might be useful to enlarge a window if the VM's output
1699 screen is very small, for example because you are running an
1700 old operating system in it.
1701 </para>
1702
1703 <para>
1704 To enable scale mode, press the <emphasis role="bold">Host
1705 key + C</emphasis>, or select <emphasis role="bold">Scale
1706 mode</emphasis> from the
1707 <emphasis role="bold">Machine</emphasis> menu in the VM
1708 window. To leave scale mode, press the Host key + C again.
1709 </para>
1710
1711 <para>
1712 The aspect ratio of the guest screen is preserved when
1713 resizing the window. To ignore the aspect ratio, press
1714 <emphasis role="bold">Shift</emphasis> during the resize
1715 operation.
1716 </para>
1717
1718 <para>
1719 See <xref linkend="KnownIssues" /> for additional remarks.
1720 </para>
1721 </listitem>
1722
1723 <listitem>
1724 <para>
1725 If you have the Guest Additions installed and they support
1726 automatic <emphasis role="bold">resizing</emphasis>, the
1727 Guest Additions will automatically adjust the screen
1728 resolution of the guest operating system. For example, if
1729 you are running a Windows guest with a resolution of
1730 1024x768 pixels and you then resize the VM window to make it
1731 100 pixels wider, the Guest Additions will change the
1732 Windows display resolution to 1124x768.
1733 </para>
1734
1735 <para>
1736 See <xref linkend="guestadditions" />.
1737 </para>
1738 </listitem>
1739
1740 <listitem>
1741 <para>
1742 Otherwise, if the window is bigger than the VM's screen, the
1743 screen will be centered. If it is smaller, then scroll bars
1744 will be added to the machine window.
1745 </para>
1746 </listitem>
1747
1748 </orderedlist>
1749
1750 </sect2>
1751
1752 <sect2 id="intro-save-machine-state">
1753
1754 <title>Saving the State of the Machine</title>
1755
1756 <para>
1757 When you click on the <emphasis role="bold">Close</emphasis>
1758 button of your virtual machine window, at the top right of the
1759 window, just like you would close any other window on your
1760 system, &product-name; asks you whether you want to save or
1761 power off the VM. As a shortcut, you can also press
1762 <emphasis role="bold">Host key + Q</emphasis>.
1763 </para>
1764
1765 <figure id="fig-vm-close">
1766 <title>Closing Down a Virtual Machine</title>
1767 <mediaobject>
1768 <imageobject>
1769 <imagedata align="center" fileref="images/vm-close.png"
1770 width="11cm" />
1771 </imageobject>
1772 </mediaobject>
1773 </figure>
1774
1775 <para>
1776 The difference between the three options is crucial. They mean
1777 the following:
1778 </para>
1779
1780 <itemizedlist>
1781
1782 <listitem>
1783 <para>
1784 <emphasis role="bold">Save the machine state:</emphasis>
1785 With this option, &product-name;
1786 <emphasis>freezes</emphasis> the virtual machine by
1787 completely saving its state to your local disk.
1788 </para>
1789
1790 <para>
1791 When you start the VM again later, you will find that the VM
1792 continues exactly where it was left off. All your programs
1793 will still be open, and your computer resumes operation.
1794 Saving the state of a virtual machine is thus in some ways
1795 similar to suspending a laptop computer by closing its lid.
1796 </para>
1797 </listitem>
1798
1799 <listitem>
1800 <para>
1801 <emphasis role="bold">Send the shutdown signal.</emphasis>
1802 This will send an ACPI shutdown signal to the virtual
1803 machine, which has the same effect as if you had pressed the
1804 power button on a real computer. So long as the VM is
1805 running a fairly modern operating system, this should
1806 trigger a proper shutdown mechanism from within the VM.
1807 </para>
1808 </listitem>
1809
1810 <listitem>
1811 <para>
1812 <emphasis role="bold">Power off the machine:</emphasis> With
1813 this option, &product-name; also stops running the virtual
1814 machine, but <emphasis>without</emphasis> saving its state.
1815 </para>
1816
1817 <warning>
1818 <para>
1819 This is equivalent to pulling the power plug on a real
1820 computer without shutting it down properly. If you start
1821 the machine again after powering it off, your operating
1822 system will have to reboot completely and may begin a
1823 lengthy check of its virtual system disks. As a result,
1824 this should not normally be done, since it can potentially
1825 cause data loss or an inconsistent state of the guest
1826 system on disk.
1827 </para>
1828 </warning>
1829
1830 <para>
1831 As an exception, if your virtual machine has any snapshots,
1832 see <xref linkend="snapshots"/>, you can use this option to
1833 quickly <emphasis
1834 role="bold">restore the current
1835 snapshot</emphasis> of the virtual machine. In that case,
1836 powering off the machine will not disrupt its state, but any
1837 changes made since that snapshot was taken will be lost.
1838 </para>
1839 </listitem>
1840
1841 </itemizedlist>
1842
1843 <para>
1844 The <emphasis role="bold">Discard</emphasis> button in the
1845 VirtualBox Manager window discards a virtual machine's saved
1846 state. This has the same effect as powering it off, and the same
1847 warnings apply.
1848 </para>
1849
1850 </sect2>
1851
1852 </sect1>
1853
1854 <sect1 id="gui-vmgroups">
1855
1856 <title>Using VM Groups</title>
1857
1858 <para>
1859 VM groups enable the user to create ad hoc groups of VMs, and to
1860 manage and perform functions on them collectively, as well as
1861 individually. There are a number of features relating to groups.
1862 </para>
1863
1864 <orderedlist>
1865
1866 <listitem>
1867 <para>
1868 Create a group using the GUI. Do one of the following:
1869 </para>
1870
1871 <itemizedlist>
1872
1873 <listitem>
1874 <para>
1875 Drag one VM on top of another VM.
1876 </para>
1877 </listitem>
1878
1879 <listitem>
1880 <para>
1881 Select multiple VMs and select
1882 <emphasis role="bold">Group</emphasis> from the
1883 right-click menu, as shown in the following image.
1884 </para>
1885
1886 <figure id="fig-vm-groups">
1887 <title>Creating a Group of Virtual Machines</title>
1888 <mediaobject>
1889 <imageobject>
1890 <imagedata align="center" fileref="images/vm-groups.png"
1891 width="10cm" />
1892 </imageobject>
1893 </mediaobject>
1894 </figure>
1895 </listitem>
1896
1897 </itemizedlist>
1898 </listitem>
1899
1900 <listitem>
1901 <para>
1902 Create and manage a group using the command line. Do one of
1903 the following:
1904 </para>
1905
1906 <itemizedlist>
1907
1908 <listitem>
1909 <para>
1910 Create a group and assign a VM. For example:
1911 </para>
1912
1913<screen>VBoxManage modifyvm "Fred" --groups "/TestGroup"</screen>
1914
1915 <para>
1916 This command creates a group "TestGroup" and attaches the
1917 VM "Fred" to that group.
1918 </para>
1919 </listitem>
1920
1921 <listitem>
1922 <para>
1923 Detach a VM from the group, and delete the group if empty.
1924 For example:
1925 </para>
1926
1927<screen>VBoxManage modifyvm "Fred" --groups ""</screen>
1928
1929 <para>
1930 This command detaches all groups from the VM "Fred" and
1931 deletes the empty group.
1932 </para>
1933 </listitem>
1934
1935 </itemizedlist>
1936 </listitem>
1937
1938 <listitem>
1939 <para>
1940 Create multiple groups. For example:
1941 </para>
1942
1943<screen>VBoxManage modifyvm "Fred" --groups "/TestGroup,/TestGroup2"</screen>
1944
1945 <para>
1946 This command creates the groups "TestGroup" and "TestGroup2",
1947 if they do not exist, and attaches the VM "Fred" to both of
1948 them.
1949 </para>
1950 </listitem>
1951
1952 <listitem>
1953 <para>
1954 Create nested groups, having a group hierarchy. For example:
1955 </para>
1956
1957<screen>VBoxManage modifyvm "Fred" --groups "/TestGroup/TestGroup2"</screen>
1958
1959 <para>
1960 This command attaches the VM "Fred" to the subgroup
1961 "TestGroup2" of the "TestGroup" group.
1962 </para>
1963 </listitem>
1964
1965 <listitem>
1966 <para>
1967 The following is a summary of group commands: Start, Pause,
1968 Reset, Close (save state, send shutdown signal, poweroff),
1969 Discard Saved State, Show in File System, Sort.
1970 </para>
1971 </listitem>
1972
1973 </orderedlist>
1974
1975 </sect1>
1976
1977 <sect1 id="snapshots">
1978
1979 <title>Snapshots</title>
1980
1981 <para>
1982 With snapshots, you can save a particular state of a virtual
1983 machine for later use. At any later time, you can revert to that
1984 state, even though you may have changed the VM considerably since
1985 then. A snapshot of a virtual machine is thus similar to a machine
1986 in Saved state, but there can be many of them, and these saved
1987 states are preserved.
1988 </para>
1989
1990 <para>
1991 You can see the snapshots of a virtual machine by first selecting
1992 a machine in the VirtualBox Manager and then clicking
1993 <emphasis role="bold">Snapshots</emphasis> at the top right. Until
1994 you take a snapshot of the machine, the list of snapshots will be
1995 empty except for the <emphasis role="bold">Current
1996 State</emphasis> item, which represents the "now" point in the
1997 lifetime of the virtual machine.
1998 </para>
1999
2000 <sect2 id="snapshots-take-restore-delete">
2001
2002 <title>Taking, Restoring, and Deleting Snapshots</title>
2003
2004 <para>
2005 There are three operations related to snapshots, as follows:
2006 </para>
2007
2008 <orderedlist>
2009
2010 <listitem>
2011 <para>
2012 <emphasis role="bold">Take a snapshot</emphasis>. This makes
2013 a copy of the machine's current state, to which you can go
2014 back at any given time later.
2015 </para>
2016
2017 <itemizedlist>
2018
2019 <listitem>
2020 <para>
2021 If your VM is currently running, select
2022 <emphasis role="bold">Take Snapshot</emphasis> from the
2023 <emphasis role="bold">Machine</emphasis> pull-down menu
2024 of the VM window.
2025 </para>
2026 </listitem>
2027
2028 <listitem>
2029 <para>
2030 If your VM is currently in either the Saved or the
2031 Powered Off state, as displayed next to the VM in the
2032 &product-name; main window, click on the
2033 <emphasis role="bold">Snapshots </emphasis>tab on the
2034 top right of the main window. Do one of the following:
2035 </para>
2036
2037 <itemizedlist>
2038
2039 <listitem>
2040 <para>
2041 Click on the small camera icon.
2042 </para>
2043 </listitem>
2044
2045 <listitem>
2046 <para>
2047 Right-click on the <emphasis role="bold">Current
2048 State </emphasis>item in the list and select
2049 <emphasis role="bold">Take Snapshot</emphasis> from
2050 the menu.
2051 </para>
2052 </listitem>
2053
2054 </itemizedlist>
2055 </listitem>
2056
2057 </itemizedlist>
2058
2059 <para>
2060 In either case, a window is displayed prompting you for a
2061 snapshot name. This name is purely for reference purposes to
2062 help you remember the state of the snapshot. For example, a
2063 useful name would be "Fresh installation from scratch, no
2064 Guest Additions", or "Service Pack 3 just installed". You
2065 can also add a longer text in the
2066 <emphasis role="bold">Description</emphasis> field.
2067 </para>
2068
2069 <para>
2070 Your new snapshot will then appear in the snapshots list.
2071 Underneath your new snapshot, you will see an item called
2072 Current State, signifying that the current state of your VM
2073 is a variation based on the snapshot you took earlier. If
2074 you later take another snapshot, you will see that they will
2075 be displayed in sequence, and each subsequent snapshot is
2076 derived from an earlier one.
2077 </para>
2078
2079 <figure id="fig-snapshots-list">
2080 <title>Snapshots List for a Virtual Machine</title>
2081 <mediaobject>
2082 <imageobject>
2083 <imagedata align="center" fileref="images/snapshots-1.png"
2084 width="12cm" />
2085 </imageobject>
2086 </mediaobject>
2087 </figure>
2088
2089 <para>
2090 &product-name; imposes no limits on the number of snapshots
2091 you can take. The only practical limitation is disk space on
2092 your host. Each snapshot stores the state of the virtual
2093 machine and thus occupies some disk space. See
2094 <xref linkend="snapshots-contents"/> for details on what is
2095 stored in a snapshot.
2096 </para>
2097 </listitem>
2098
2099 <listitem>
2100 <para>
2101 <emphasis role="bold">Restore a snapshot</emphasis>. You do
2102 this by right-clicking on any snapshot you have taken in the
2103 list of snapshots. By restoring a snapshot, you go back or
2104 forward in time. The current state of the machine is lost,
2105 and the machine is restored to the exact state it was in
2106 when the snapshot was taken.
2107 </para>
2108
2109 <note>
2110 <para>
2111 Restoring a snapshot will affect the virtual hard drives
2112 that are connected to your VM, as the entire state of the
2113 virtual hard drive will be reverted as well. This means
2114 also that all files that have been created since the
2115 snapshot and all other file changes <emphasis>will be
2116 lost. </emphasis>In order to prevent such data loss while
2117 still making use of the snapshot feature, it is possible
2118 to add a second hard drive in
2119 <emphasis>write-through</emphasis> mode using the
2120 <command>VBoxManage</command> interface and use it to
2121 store your data. As write-through hard drives are
2122 <emphasis>not</emphasis> included in snapshots, they
2123 remain unaltered when a machine is reverted. See
2124 <xref
2125 linkend="hdimagewrites" />.
2126 </para>
2127 </note>
2128
2129 <para>
2130 To avoid losing the current state when restoring a snapshot,
2131 you can create a new snapshot before the restore.
2132 </para>
2133
2134 <para>
2135 By restoring an earlier snapshot and taking more snapshots
2136 from there, it is even possible to create a kind of
2137 alternate reality and to switch between these different
2138 histories of the virtual machine. This can result in a whole
2139 tree of virtual machine snapshots, as shown in the
2140 screenshot above.
2141 </para>
2142 </listitem>
2143
2144 <listitem>
2145 <para>
2146 <emphasis role="bold">Delete a snapshot</emphasis>. This
2147 does not affect the state of the virtual machine, but only
2148 releases the files on disk that &product-name; used to store
2149 the snapshot data, thus freeing disk space. To delete a
2150 snapshot, right-click on it in the snapshots tree and select
2151 <emphasis role="bold">Delete</emphasis>. Snapshots can be
2152 deleted even while a machine is running.
2153 </para>
2154
2155 <note>
2156 <para>
2157 Whereas taking and restoring snapshots are fairly quick
2158 operations, deleting a snapshot can take a considerable
2159 amount of time since large amounts of data may need to be
2160 copied between several disk image files. Temporary disk
2161 files may also need large amounts of disk space while the
2162 operation is in progress.
2163 </para>
2164 </note>
2165
2166 <para>
2167 There are some situations which cannot be handled while a VM
2168 is running, and you will get an appropriate message that you
2169 need to perform this snapshot deletion when the VM is shut
2170 down.
2171 </para>
2172 </listitem>
2173
2174 </orderedlist>
2175
2176 </sect2>
2177
2178 <sect2 id="snapshots-contents">
2179
2180 <title>Snapshot Contents</title>
2181
2182 <para>
2183 Think of a snapshot as a point in time that you have preserved.
2184 More formally, a snapshot consists of the following three
2185 things:
2186 </para>
2187
2188 <itemizedlist>
2189
2190 <listitem>
2191 <para>
2192 The snapshot contains a complete copy of the VM settings,
2193 including the hardware configuration, so that when you
2194 restore a snapshot, the VM settings are restored as well.
2195 For example, if you changed the hard disk configuration or
2196 the VM's system settings, that change is undone when you
2197 restore the snapshot.
2198 </para>
2199
2200 <para>
2201 The copy of the settings is stored in the machine
2202 configuration, an XML text file, and thus occupies very
2203 little space.
2204 </para>
2205 </listitem>
2206
2207 <listitem>
2208 <para>
2209 The complete state of all the virtual disks attached to the
2210 machine is preserved. Going back to a snapshot means that
2211 all changes that had been made to the machine's disks, file
2212 by file and bit by bit, will be undone as well. Files that
2213 were since created will disappear, files that were deleted
2214 will be restored, changes to files will be reverted.
2215 </para>
2216
2217 <para>
2218 Strictly speaking, this is only true for virtual hard disks
2219 in "normal" mode. You can configure disks to behave
2220 differently with snapshots, see
2221 <xref linkend="hdimagewrites" />. Even more formally and
2222 technically correct, it is not the virtual disk itself that
2223 is restored when a snapshot is restored. Instead, when a
2224 snapshot is taken, &product-name; creates differencing
2225 images which contain only the changes since the snapshot
2226 were taken, and when the snapshot is restored,
2227 &product-name; throws away that differencing image, thus
2228 going back to the previous state. This is both faster and
2229 uses less disk space. For the details, which can be complex,
2230 see <xref linkend="diffimages" />.
2231 </para>
2232
2233 <para>
2234 Creating the differencing image as such does not occupy much
2235 space on the host disk initially, since the differencing
2236 image will initially be empty and grow dynamically later
2237 with each write operation to the disk. The longer you use
2238 the machine after having created the snapshot, however, the
2239 more the differencing image will grow in size.
2240 </para>
2241 </listitem>
2242
2243 <listitem>
2244 <para>
2245 If you took a snapshot while the machine was running, the
2246 memory state of the machine is also saved in the snapshot.
2247 This is in the same way that memory can be saved when you
2248 close a VM window. When you restore such a snapshot,
2249 execution resumes at exactly the point when the snapshot was
2250 taken.
2251 </para>
2252
2253 <para>
2254 The memory state file can be as large as the memory size of
2255 the virtual machine and will therefore occupy quite some
2256 disk space as well.
2257 </para>
2258 </listitem>
2259
2260 </itemizedlist>
2261
2262 </sect2>
2263
2264 </sect1>
2265
2266 <sect1 id="configbasics">
2267
2268 <title>Virtual Machine Configuration</title>
2269
2270 <para>
2271 When you select a virtual machine from the list in the VirtualBox
2272 Manager window, you will see a summary of that machine's settings
2273 on the right.
2274 </para>
2275
2276 <para>
2277 Clicking on the <emphasis role="bold">Settings</emphasis> button
2278 in the toolbar at the top brings up a detailed window where you
2279 can configure many of the properties of the selected VM. But be
2280 careful. Even though it is possible to change all VM settings
2281 after installing a guest operating system, certain changes might
2282 prevent a guest operating system from functioning correctly if
2283 done after installation.
2284 </para>
2285
2286 <note>
2287 <para>
2288 The <emphasis role="bold">Settings</emphasis> button is disabled
2289 while a VM is either in the Running or Saved state. This is
2290 because the <emphasis role="bold">Settings</emphasis> dialog
2291 enables you to change fundamental characteristics of the virtual
2292 computer that is created for your guest operating system, and
2293 this operating system may perform well when, for example, half
2294 of its memory is taken away. As a result, if the
2295 <emphasis role="bold">Settings</emphasis> button is disabled,
2296 shut down the current VM first.
2297 </para>
2298 </note>
2299
2300 <para>
2301 &product-name; provides a wide range of parameters that can be
2302 changed for a virtual machine. The various settings that can be
2303 changed in the <emphasis role="bold">Settings</emphasis> window
2304 are described in detail in <xref linkend="BasicConcepts" />. Even
2305 more parameters are available with the &product-name; command line
2306 interface. See <xref linkend="vboxmanage" />.
2307 </para>
2308
2309 </sect1>
2310
2311 <sect1 id="intro-removing">
2312
2313 <title>Removing and Moving Virtual Machines</title>
2314
2315 <para>
2316 You can easily remove a virtual machine from &product-name;.
2317 Alternatively, you can move the virtual machine and associated
2318 files, such as a disk image, to another location on the host.
2319 </para>
2320
2321 <itemizedlist>
2322
2323 <listitem>
2324 <para>
2325 <emphasis role="bold">Removing a VM.</emphasis> To remove a
2326 virtual machine which you no longer need, right-click on the
2327 VM in the VirtualBox Manager's machine list and select
2328 <emphasis role="bold">Remove</emphasis>.
2329 </para>
2330
2331 <para>
2332 A confirmation dialog is displayed that enables you to select
2333 whether the virtual machine should only be removed from the
2334 list of machines, or whether the files associated with it
2335 should also be deleted.
2336 </para>
2337
2338 <para>
2339 The <emphasis role="bold">Remove</emphasis> menu item is
2340 disabled while a VM is running.
2341 </para>
2342 </listitem>
2343
2344 <listitem>
2345 <para>
2346 <emphasis role="bold">Moving a VM.</emphasis> To move a
2347 virtual machine to a new location on the host, right-click on
2348 the VM in the VirtualBox Manager's machine list and select
2349 <emphasis role="bold">Move</emphasis>.
2350 </para>
2351
2352 <para>
2353 A file dialog prompts you to select a new location for the
2354 virtual machine.
2355 </para>
2356
2357 <para>
2358 When you move a VM, &product-name; configuration files are
2359 updated automatically to use the new location on the host.
2360 </para>
2361
2362 <para>
2363 The <emphasis role="bold">Move</emphasis> menu item is
2364 disabled while a VM is running.
2365 </para>
2366
2367 <para>
2368 You can also use the <command>VBoxManage</command> command to
2369 move a VM. See <xref linkend="vboxmanage-movevm"/>.
2370 </para>
2371 </listitem>
2372
2373 </itemizedlist>
2374
2375 <para>
2376 For details of removing or moving a disk image file from
2377 &product-name;, see <xref linkend="vdis"/>.
2378 </para>
2379
2380 </sect1>
2381
2382 <sect1 id="clone">
2383
2384 <title>Cloning Virtual Machines</title>
2385
2386 <para>
2387 To experiment with a VM configuration, test different guest OS
2388 levels or to simply backup a VM, &product-name; can create a full
2389 or a linked copy of an existing VM. This is called
2390 <emphasis>cloning</emphasis> a virtual machine.
2391 </para>
2392
2393 <para>
2394 The <emphasis role="bold">Clone Virtual Machine</emphasis> wizard
2395 guides you through the cloning process.
2396 </para>
2397
2398 <figure id="fig-clone-wizard">
2399 <title>The Clone Virtual Machine Wizard</title>
2400 <mediaobject>
2401 <imageobject>
2402 <imagedata align="center" fileref="images/clone-vm.png"
2403 width="10cm" />
2404 </imageobject>
2405 </mediaobject>
2406 </figure>
2407
2408 <para>
2409 Start the wizard by clicking
2410 <emphasis role="bold">Clone</emphasis> in the right-click menu of
2411 the VirtualBox Manager's machine list, or in the
2412 <emphasis role="bold">Snapshots</emphasis> view of the selected
2413 VM.
2414 </para>
2415
2416 <para>
2417 Enter a new <emphasis role="bold">Name</emphasis> for the clone.
2418 You can choose a <emphasis role="bold">Path</emphasis> for the
2419 cloned virtual machine, otherwise the default machines folder is
2420 used.
2421 </para>
2422
2423 <para>
2424 The <emphasis role="bold">Clone Type</emphasis> option is used to
2425 specify if the clone should be linked to the source VM, or if a
2426 fully independent clone should be created, as follows:
2427 </para>
2428
2429 <itemizedlist>
2430
2431 <listitem>
2432 <para>
2433 <emphasis role="bold">Full Clone:</emphasis> In this mode, all
2434 dependent disk images are copied to the new VM folder. The
2435 clone can fully operate without the source VM.
2436 </para>
2437 </listitem>
2438
2439 <listitem>
2440 <para>
2441 <emphasis role="bold">Linked Clone:</emphasis> In this mode,
2442 new differencing disk images are created where the parent disk
2443 images are the source disk images. If you selected the current
2444 state of the source VM as clone point, a new snapshot will be
2445 created implicitly.
2446 </para>
2447 </listitem>
2448
2449 </itemizedlist>
2450
2451 <para>
2452 The <emphasis role="bold">Snapshots</emphasis> option determines
2453 what should be cloned. You can create a clone of the
2454 <emphasis role="bold">Current Machine State</emphasis> only or
2455 <emphasis role="bold">Everything</emphasis>. When you select
2456 <emphasis role="bold">Everything</emphasis>, the current machine
2457 state and additionally all snapshots are cloned. If you started
2458 from a snapshot which has additional children, you can also clone
2459 the <emphasis role="bold">Current Machine State and All
2460 Children</emphasis>. This creates a clone starting with this
2461 snapshot and includes all child snapshots.
2462 </para>
2463
2464 <para>
2465 The following clone options are available:
2466 </para>
2467
2468 <itemizedlist>
2469
2470 <listitem>
2471 <para>
2472 <emphasis role="bold">MAC Address Policy:</emphasis> Select an
2473 option for retaining network card MAC addresses when cloning
2474 the VM.
2475 </para>
2476
2477 <para>
2478 For example, when you select <emphasis role="bold">Generate
2479 New MAC Addresses For All Network Adapters</emphasis> every
2480 network card is assigned a new MAC address during cloning.
2481 This is the default setting, and is useful when both the
2482 source VM and the cloned VM have to operate on the same
2483 network. Other options enable you to retain existing MAC
2484 addresses in the cloned VM.
2485 </para>
2486 </listitem>
2487
2488 <listitem>
2489 <para>
2490 <emphasis role="bold">Keep Disk Names:</emphasis> The names of
2491 disk images are retained when cloning the VM.
2492 </para>
2493 </listitem>
2494
2495 <listitem>
2496 <para>
2497 <emphasis role="bold">Keep Hardware UUIDs:</emphasis> Hardware
2498 UUIDs are retained when cloning the VM.
2499 </para>
2500 </listitem>
2501
2502 </itemizedlist>
2503
2504 <para>
2505 The clone operation itself can be a lengthy operation depending on
2506 the size and count of the attached disk images. Also keep in mind
2507 that every snapshot has differencing disk images attached, which
2508 need to be cloned as well.
2509 </para>
2510
2511 <para>
2512 The <emphasis role="bold">Clone</emphasis> menu item is disabled
2513 while a machine is running.
2514 </para>
2515
2516 <para>
2517 To clone a VM from the command line, see
2518 <xref linkend="vboxmanage-clonevm" />.
2519 </para>
2520
2521 </sect1>
2522
2523 <sect1 id="ovf">
2524
2525 <title>Importing and Exporting Virtual Machines</title>
2526
2527 <para>
2528 &product-name; can import and export virtual machines in the
2529 following formats:
2530 </para>
2531
2532 <itemizedlist>
2533
2534 <listitem>
2535 <para>
2536 <emphasis role="bold">Open Virtualization Format
2537 (OVF).</emphasis> This is the industry-standard format. See
2538 <xref linkend="ovf-about"/>.
2539 </para>
2540 </listitem>
2541
2542 <listitem>
2543 <para>
2544 <emphasis role="bold">Cloud service formats.</emphasis> Export
2545 to cloud services such as &oci; is supported. Import is not
2546 supported. See <xref linkend="ovf-export-oci"/>.
2547 </para>
2548 </listitem>
2549
2550 </itemizedlist>
2551
2552 <sect2 id="ovf-about">
2553
2554 <title>About the OVF Format</title>
2555
2556 <para>
2557 OVF is a cross-platform standard supported by many
2558 virtualization products which enables the creation of ready-made
2559 virtual machines that can then be imported into a hypervisor
2560 such as &product-name;. &product-name; makes OVF import and
2561 export easy to do, using the VirtualBox Manager window or the
2562 command-line interface.
2563 </para>
2564
2565 <para>
2566 Using OVF enables packaging of <emphasis>virtual
2567 appliances</emphasis>. These are disk images, together with
2568 configuration settings that can be distributed easily. This way
2569 one can offer complete ready-to-use software packages, including
2570 operating systems with applications, that need no configuration
2571 or installation except for importing into &product-name;.
2572 </para>
2573
2574 <note>
2575 <para>
2576 The OVF standard is complex, and support in &product-name; is
2577 an ongoing process. In particular, no guarantee is made that
2578 &product-name; supports all appliances created by other
2579 virtualization software. For a list of known limitations, see
2580 <xref
2581 linkend="KnownIssues" />.
2582 </para>
2583 </note>
2584
2585 <para>
2586 Appliances in OVF format can appear in the following variants:
2587 </para>
2588
2589 <itemizedlist>
2590
2591 <listitem>
2592 <para>
2593 They can come in several files, as one or several disk
2594 images, typically in the widely-used VMDK format. See
2595 <xref linkend="vdidetails" />. They also include a textual
2596 description file in an XML dialect with an
2597 <computeroutput>.ovf</computeroutput> extension. These files
2598 must then reside in the same directory for &product-name; to
2599 be able to import them.
2600 </para>
2601 </listitem>
2602
2603 <listitem>
2604 <para>
2605 Alternatively, the above files can be packed together into a
2606 single archive file, typically with an
2607 <computeroutput>.ova</computeroutput> extension. Such
2608 archive files use a variant of the TAR archive format and
2609 can therefore be unpacked outside of &product-name; with any
2610 utility that can unpack standard TAR files.
2611 </para>
2612 </listitem>
2613
2614 </itemizedlist>
2615
2616 <note>
2617 <para>
2618 OVF cannot describe snapshots that were taken for a virtual
2619 machine. As a result, when you export a virtual machine that
2620 has snapshots, only the current state of the machine will be
2621 exported. The disk images in the export will have a
2622 <emphasis>flattened</emphasis> state identical to the current
2623 state of the virtual machine.
2624 </para>
2625 </note>
2626
2627 </sect2>
2628
2629 <sect2 id="ovf-import-appliance">
2630
2631 <title>Importing an Appliance in OVF Format</title>
2632
2633 <para>
2634 To import an appliance in OVF format, use the following steps.
2635 </para>
2636
2637 <orderedlist>
2638
2639 <listitem>
2640 <para>
2641 Double-click on the OVF or OVA file.
2642 </para>
2643
2644 <para>
2645 &product-name; creates file type associations automatically
2646 for any OVF and OVA files on your host operating system.
2647 </para>
2648 </listitem>
2649
2650 <listitem>
2651 <para>
2652 Select <emphasis role="bold">File</emphasis>,
2653 <emphasis role="bold">Import Appliance</emphasis> in the
2654 VirtualBox Manager window. In the displayed file dialog,
2655 navigate to the file with either the
2656 <computeroutput>.ovf</computeroutput> or the
2657 <computeroutput>.ova</computeroutput> file extension.
2658 </para>
2659
2660 <para>
2661 Click <emphasis role="bold">Import</emphasis>. The
2662 <emphasis role="bold">Appliance Settings</emphasis> screen
2663 is shown.
2664 </para>
2665
2666 <figure id="fig-import-appliance">
2667 <title>Appliance Settings Screen for Import Appliance</title>
2668 <mediaobject>
2669 <imageobject>
2670 <imagedata align="center" fileref="images/ovf-import.png"
2671 width="12cm" />
2672 </imageobject>
2673 </mediaobject>
2674 </figure>
2675
2676 <para>
2677 This screen shows the virtual machines described in the OVF
2678 or OVA file and enables you to change the virtual machine
2679 settings.
2680 </para>
2681
2682 <para>
2683 By default, membership of VM groups is preserved on import
2684 for VMs that were initially exported from &product-name;.
2685 This can be changed using the <emphasis role="bold">Primary
2686 Group</emphasis> setting for the VM.
2687 </para>
2688
2689 <para>
2690 The following global settings apply for all of the VMs that
2691 you are importing:
2692 </para>
2693
2694 <itemizedlist>
2695
2696 <listitem>
2697 <para>
2698 <emphasis role="bold">Base Folder:</emphasis> The
2699 directory on the host where the imported VMs are stored.
2700 </para>
2701
2702 <para>
2703 If there are multiple VMs in an appliance, you can
2704 specify a different directory for each VM by editing the
2705 <emphasis role="bold">Base Folder</emphasis> setting for
2706 the VM.
2707 </para>
2708 </listitem>
2709
2710 <listitem>
2711 <para>
2712 <emphasis role="bold">MAC Address Policy</emphasis>: By
2713 default, MAC addresses of network cards on your VMs are
2714 reinitialized before import. You can choose to preserve
2715 MAC addresses on import.
2716 </para>
2717 </listitem>
2718
2719 <listitem>
2720 <para>
2721 <emphasis role="bold">Import Hard Drives as
2722 VDI:</emphasis> By default, hard drives are imported in
2723 VMDK format. This option enables import in VDI format.
2724 </para>
2725 </listitem>
2726
2727 </itemizedlist>
2728 </listitem>
2729
2730 <listitem>
2731 <para>
2732 Click <emphasis role="bold">Import</emphasis> to import the
2733 appliance.
2734 </para>
2735
2736 <para>
2737 &product-name; copies the disk images and creates local
2738 virtual machines with the settings described in the
2739 <emphasis role="bold">Appliance Settings</emphasis> screen.
2740 The imported VMs are shown in the list of virtual machines
2741 in VirtualBox Manager.
2742 </para>
2743
2744 <para>
2745 Note that since disk images tend to be big, and VMDK images
2746 that come with virtual appliances are typically shipped in a
2747 special compressed format that is unsuitable for being used
2748 by virtual machines directly, the images are unpacked and
2749 copied first, which can take a few minutes.
2750 </para>
2751 </listitem>
2752
2753 </orderedlist>
2754
2755 <para>
2756 To import an appliance using the command line, see
2757 <xref linkend="vboxmanage-import" />.
2758 </para>
2759
2760 </sect2>
2761
2762 <sect2 id="ovf-export-appliance">
2763
2764 <title>Exporting an Appliance in OVF Format</title>
2765
2766 <para>
2767 To export an appliance in OVF format, use the following steps.
2768 </para>
2769
2770 <orderedlist>
2771
2772 <listitem>
2773 <para>
2774 Select <emphasis role="bold">File</emphasis>,
2775 <emphasis role="bold"> Export Appliance</emphasis>.
2776 </para>
2777
2778 <para>
2779 The <emphasis role="bold">Export Virtual
2780 Appliance</emphasis> wizard is shown. The initial window
2781 enables you to combine several virtual machines into an OVF
2782 appliance.
2783 </para>
2784
2785 <para>
2786 Select one or more VMs to export and click
2787 <emphasis role="bold">Next</emphasis>.
2788 </para>
2789 </listitem>
2790
2791 <listitem>
2792 <para>
2793 The <emphasis role="bold">Appliance Settings</emphasis>
2794 screen is shown, where you can choose the following
2795 settings:
2796 </para>
2797
2798 <itemizedlist>
2799
2800 <listitem>
2801 <para>
2802 <emphasis role="bold">Format:</emphasis> Select an
2803 <emphasis role="bold">Open Virtualization
2804 Format</emphasis> option for the output files.
2805 </para>
2806
2807 <para>
2808 The <emphasis role="bold">&oci;</emphasis> option is
2809 used for export to &oci;. See
2810 <xref linkend="ovf-export-oci"/>.
2811 </para>
2812 </listitem>
2813
2814 <listitem>
2815 <para>
2816 <emphasis role="bold">File:</emphasis> Select the
2817 location where the exported files are to be stored.
2818 </para>
2819 </listitem>
2820
2821 <listitem>
2822 <para>
2823 <emphasis role="bold">MAC Address Policy:</emphasis>
2824 Select an option for retaining network card MAC
2825 addresses on export.
2826 </para>
2827 </listitem>
2828
2829 <listitem>
2830 <para>
2831 <emphasis role="bold">Write Manifest File:</emphasis>
2832 Enables you to include a manifest file in the exported
2833 archive file.
2834 </para>
2835 </listitem>
2836
2837 <listitem>
2838 <para>
2839 <emphasis role="bold">Include ISO Image
2840 Files:</emphasis> Enables you to include ISO image files
2841 in the exported archive file.
2842 </para>
2843 </listitem>
2844
2845 </itemizedlist>
2846 </listitem>
2847
2848 <listitem>
2849 <para>
2850 Click <emphasis role="bold">Next</emphasis> to display the
2851 <emphasis role="bold">Virtual System Settings</emphasis>
2852 screen.
2853 </para>
2854
2855 <para>
2856 You can edit settings for the virtual appliance. For
2857 example, you can change the name and add product information
2858 such as vendor details or license text.
2859 </para>
2860
2861 <para>
2862 To change a setting, double-click on the required field.
2863 </para>
2864 </listitem>
2865
2866 <listitem>
2867 <para>
2868 Click <emphasis role="bold">Export</emphasis> and the export
2869 process begins. Note that this can take a while.
2870 </para>
2871 </listitem>
2872
2873 </orderedlist>
2874
2875 <para>
2876 To export an appliance using the command line, see
2877 <xref linkend="vboxmanage-export" />.
2878 </para>
2879
2880 </sect2>
2881
2882<!-- New content for 6.0 -->
2883
2884 <sect2 id="ovf-export-oci">
2885
2886 <title>Exporting an Appliance to &oci;</title>
2887
2888 <para>
2889 &product-name; supports the export of VMs to an &oci; service.
2890 </para>
2891
2892 <para>
2893 Before you export a VM to &oci;, you need to do the following:
2894 </para>
2895
2896 <itemizedlist>
2897
2898 <listitem>
2899 <para>
2900 Generate an API signing key pair. This is used for API
2901 requests to &oci;.
2902 </para>
2903
2904 <itemizedlist>
2905
2906 <listitem>
2907 <para>
2908 The key pair is usually installed in the
2909 <computeroutput>.oci</computeroutput> folder in your
2910 home directory. For example,
2911 <computeroutput>~/.oci</computeroutput> on a Linux
2912 system.
2913 </para>
2914 </listitem>
2915
2916 <listitem>
2917 <para>
2918 The public key of the key pair must be uploaded to the
2919 cloud service.
2920 </para>
2921 </listitem>
2922
2923 </itemizedlist>
2924
2925 <para>
2926 Instructions for creating and uploading an API signing key
2927 for &oci; are at:
2928 </para>
2929
2930 <para>
2931 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#How</ulink>
2932 </para>
2933 </listitem>
2934
2935 <listitem>
2936 <para>
2937 Create a profile for your cloud account.
2938 </para>
2939
2940 <para>
2941 The cloud profile contains resource identifiers for your
2942 cloud account, such as your user OCID, and the fingerprint
2943 for your public key. You can create a cloud profile in the
2944 following ways:
2945 </para>
2946
2947 <itemizedlist>
2948
2949 <listitem>
2950 <para>
2951 Automatically, using the <emphasis role="bold">Cloud
2952 Profile Manager</emphasis>. See
2953 <xref linkend="ovf-cloud-profile-manager"/>.
2954 </para>
2955 </listitem>
2956
2957 <listitem>
2958 <para>
2959 Manually, by creating an
2960 <computeroutput>oci_config</computeroutput> file in your
2961 &product-name; global configuration directory. For
2962 example, this is
2963 <computeroutput>$HOME/.config/VirtualBox/oci_config</computeroutput>
2964 on a Linux host.
2965 </para>
2966 </listitem>
2967
2968 <listitem>
2969 <para>
2970 Manually, by creating a
2971 <computeroutput>config</computeroutput> file in your
2972 &oci; configuration directory. For example, this is
2973 <computeroutput>$HOME/.oci/config</computeroutput> on a
2974 Linux host.
2975 </para>
2976
2977 <para>
2978 This is the same file that is used by the &oci; Command
2979 Line Interface.
2980 </para>
2981
2982 <para>
2983 &product-name; uses this file automatically if a cloud
2984 profile file is not present in your global configuration
2985 directory. Alternatively, you can import this file
2986 manually into the Cloud Profile Manager.
2987 </para>
2988 </listitem>
2989
2990 </itemizedlist>
2991
2992 <para>
2993 For information on cloud profile settings used by &oci; see
2994 the following:
2995 </para>
2996
2997 <para>
2998 <ulink url="https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm">https://docs.cloud.oracle.com/iaas/Content/API/Concepts/sdkconfig.htm</ulink>
2999 </para>
3000 </listitem>
3001
3002 <listitem>
3003 <para>
3004 Ensure that the subnet used by source VMs are available in
3005 the target compartment on the cloud service.
3006 </para>
3007 </listitem>
3008
3009 </itemizedlist>
3010
3011 <para>
3012 To export a VM to &oci;, use the following steps.
3013 </para>
3014
3015 <orderedlist>
3016
3017 <listitem>
3018 <para>
3019 Select <emphasis role="bold">File</emphasis>,
3020 <emphasis role="bold"> Export Appliance</emphasis>.
3021 </para>
3022
3023 <para>
3024 The <emphasis role="bold">Export Virtual
3025 Appliance</emphasis> wizard is shown.
3026 </para>
3027
3028 <para>
3029 Select a VM to export and click
3030 <emphasis role="bold">Next</emphasis>.
3031 </para>
3032 </listitem>
3033
3034 <listitem>
3035 <para>
3036 The <emphasis role="bold">Appliance Settings</emphasis>
3037 screen is shown.
3038 </para>
3039
3040 <para>
3041 In the <emphasis role="bold">Format</emphasis> drop-down
3042 list, select <emphasis role="bold">&oci;</emphasis>.
3043 </para>
3044
3045 <para>
3046 In the <emphasis role="bold">Account</emphasis> drop-down
3047 list, select your &oci; account.
3048 </para>
3049
3050 <para>
3051 &oci; accounts can be set up using the Cloud Profile
3052 Manager.
3053 </para>
3054
3055 <para>
3056 The window below the
3057 <emphasis role="bold">Account</emphasis> field displays the
3058 profile settings for your cloud account.
3059 </para>
3060
3061 <figure id="fig-export-appliance-oci">
3062 <title>Appliance Settings Screen, Showing Cloud Profile Settings</title>
3063 <mediaobject>
3064 <imageobject>
3065 <imagedata align="center" fileref="images/export-appliance-oci.png"
3066 width="12cm" />
3067 </imageobject>
3068 </mediaobject>
3069 </figure>
3070
3071 <para>
3072 Click <emphasis role="bold">Next</emphasis>. &product-name;
3073 makes an API request to the &oci; service.
3074 </para>
3075 </listitem>
3076
3077 <listitem>
3078 <para>
3079 The <emphasis role="bold">Virtual System Settings</emphasis>
3080 screen is shown.
3081 </para>
3082
3083 <para>
3084 You can edit settings used for the virtual machine on &oci;.
3085 For example, you can edit the Disk Size and Shape used for
3086 the VM instance.
3087 </para>
3088
3089 <para>
3090 Click <emphasis role="bold">Export</emphasis> to export the
3091 virtual machines to the cloud service.
3092 </para>
3093 </listitem>
3094
3095 <listitem>
3096 <para>
3097 The VMs are uploaded to &oci;.
3098 </para>
3099
3100 <para>
3101 Instances are created for the uploaded VMs.
3102 </para>
3103
3104 <para>
3105 If the <emphasis role="bold">Launch Instance</emphasis>
3106 setting was enabled on the <emphasis role="bold">Virtual
3107 System Settings</emphasis> screen, the VM instance is
3108 started.
3109 </para>
3110
3111 <para>
3112 You can monitor the export process using the &oci; Console.
3113 </para>
3114 </listitem>
3115
3116 </orderedlist>
3117
3118 </sect2>
3119
3120 <sect2 id="ovf-cloud-profile-manager">
3121
3122 <title>The Cloud Profile Manager</title>
3123
3124 <para>
3125 The Cloud Profile Manager is a component of &product-name; that
3126 enables you to create, edit, and manage cloud profiles for your
3127 cloud service accounts.
3128 </para>
3129
3130 <figure id="fig-cloud-profile-manager">
3131 <title>The Cloud Profile Manager</title>
3132 <mediaobject>
3133 <imageobject>
3134 <imagedata align="center" fileref="images/cloud-profile-manager.png"
3135 width="12cm" />
3136 </imageobject>
3137 </mediaobject>
3138 </figure>
3139
3140 <para>
3141 To display the Cloud Profile Manager select
3142 <emphasis role="bold">File</emphasis>,
3143 <emphasis role="bold">Cloud Profile Manager</emphasis> in the
3144 VirtualBox Manager window.
3145 </para>
3146
3147 <para>
3148 You can use the Cloud Profile Manager to create a new cloud
3149 profile automatically, or you can create a cloud profile by
3150 importing settings from your &oci; configuration file into the
3151 Cloud Profile Manager.
3152 </para>
3153
3154 <para>
3155 To create a new cloud profile, do the following:
3156 </para>
3157
3158 <orderedlist>
3159
3160 <listitem>
3161 <para>
3162 Click the <emphasis role="bold">Add</emphasis> icon and
3163 specify a <emphasis role="bold">Name</emphasis> for the
3164 profile.
3165 </para>
3166 </listitem>
3167
3168 <listitem>
3169 <para>
3170 Click <emphasis role="bold">Properties</emphasis> and enter
3171 the following settings for the profile:
3172 </para>
3173
3174 <itemizedlist>
3175
3176 <listitem>
3177 <para>
3178 Compartment OCID
3179 </para>
3180 </listitem>
3181
3182 <listitem>
3183 <para>
3184 Fingerprint of the public key
3185 </para>
3186 </listitem>
3187
3188 <listitem>
3189 <para>
3190 Location of the private key on the client device
3191 </para>
3192 </listitem>
3193
3194 <listitem>
3195 <para>
3196 (Optional) Passphrase for the private key, if the key is
3197 encrypted
3198 </para>
3199 </listitem>
3200
3201 <listitem>
3202 <para>
3203 Region OCID
3204 </para>
3205 </listitem>
3206
3207 <listitem>
3208 <para>
3209 Tenancy OCID
3210 </para>
3211 </listitem>
3212
3213 <listitem>
3214 <para>
3215 User OCID
3216 </para>
3217 </listitem>
3218
3219 </itemizedlist>
3220
3221 <para>
3222 Some of these are settings for your &oci; account. They can
3223 be viewed using the &oci; Console.
3224 </para>
3225 </listitem>
3226
3227 <listitem>
3228 <para>
3229 Click <emphasis role="bold">Apply</emphasis> to save your
3230 changes.
3231 </para>
3232
3233 <para>
3234 Settings for your cloud profile are added to the
3235 <computeroutput>oci_config</computeroutput> file in your
3236 &product-name; global settings directory.
3237 </para>
3238 </listitem>
3239
3240 </orderedlist>
3241
3242 <para>
3243 To import an existing &oci; configuration file, do the
3244 following:
3245 </para>
3246
3247 <orderedlist>
3248
3249 <listitem>
3250 <para>
3251 Ensure that a <computeroutput>config</computeroutput> file
3252 is present in your &oci; configuration directory. For
3253 example, this is
3254 <computeroutput>$HOME/.oci/config</computeroutput> on a
3255 Linux host.
3256 </para>
3257 </listitem>
3258
3259 <listitem>
3260 <para>
3261 Click the <emphasis role="bold">Import</emphasis> icon.
3262 </para>
3263
3264 <para>
3265 A dialog prompting you to import cloud profiles from
3266 external files is shown.
3267 </para>
3268
3269 <warning>
3270 <para>
3271 The dialog warns you that any cloud profiles in your
3272 &product-name; global settings directory will be
3273 overwritten.
3274 </para>
3275 </warning>
3276 </listitem>
3277
3278 <listitem>
3279 <para>
3280 Click <emphasis role="bold">Import</emphasis>.
3281 </para>
3282
3283 <para>
3284 Settings for your cloud profile are added to the
3285 <computeroutput>oci_config</computeroutput> file in your
3286 &product-name; global settings directory.
3287 </para>
3288 </listitem>
3289
3290 <listitem>
3291 <para>
3292 Click <emphasis role="bold">Properties</emphasis> to display
3293 settings for the cloud profile.
3294 </para>
3295
3296 <para>
3297 To change a setting, double-click on the required field.
3298 </para>
3299 </listitem>
3300
3301 <listitem>
3302 <para>
3303 Click <emphasis role="bold">Apply</emphasis> to save your
3304 changes.
3305 </para>
3306 </listitem>
3307
3308 </orderedlist>
3309
3310 </sect2>
3311
3312 </sect1>
3313
3314 <sect1 id="globalsettings">
3315
3316 <title>Global Settings</title>
3317
3318 <para>
3319 The <emphasis role="bold">Global Settings</emphasis> dialog can be
3320 displayed using the <emphasis role="bold">File</emphasis> menu, by
3321 clicking the <emphasis role="bold">Preferences</emphasis> item.
3322 This dialog offers a selection of settings, most of which apply to
3323 all virtual machines of the current user. The
3324 <emphasis role="bold">Extensions</emphasis> option applies to the
3325 entire system.
3326 </para>
3327
3328 <para>
3329 The following settings are available:
3330 </para>
3331
3332 <itemizedlist>
3333
3334 <listitem>
3335 <para>
3336 <emphasis role="bold">General.</emphasis> Enables the user to
3337 specify the default folder/directory for VM files, and the
3338 VRDP Authentication Library.
3339 </para>
3340 </listitem>
3341
3342 <listitem>
3343 <para>
3344 <emphasis role="bold">Input.</emphasis> Enables the user to
3345 specify the Host key. It identifies the key that toggles
3346 whether the cursor is in the focus of the VM or the Host
3347 operating system windows, see
3348 <xref linkend="keyb_mouse_normal"/>, and which is also used to
3349 trigger certain VM actions, see
3350 <xref linkend="specialcharacters"/>.
3351 </para>
3352 </listitem>
3353
3354 <listitem>
3355 <para>
3356 <emphasis role="bold">Update.</emphasis> Enables the user to
3357 specify various settings for Automatic Updates.
3358 </para>
3359 </listitem>
3360
3361 <listitem>
3362 <para>
3363 <emphasis role="bold">Language.</emphasis> Enables the user to
3364 specify the GUI language.
3365 </para>
3366 </listitem>
3367
3368 <listitem>
3369 <para>
3370 <emphasis role="bold">Display.</emphasis> Enables the user to
3371 specify the screen resolution, and its width and height. A
3372 default scale factor can be specified for all guest screens.
3373 </para>
3374 </listitem>
3375
3376 <listitem>
3377 <para>
3378 <emphasis role="bold">Network.</emphasis> Enables the user to
3379 configure the details of Host Only Networks.
3380 </para>
3381 </listitem>
3382
3383 <listitem>
3384 <para>
3385 <emphasis role="bold">Extensions.</emphasis> Enables the user
3386 to list and manage the installed extension packages.
3387 </para>
3388 </listitem>
3389
3390 <listitem>
3391 <para>
3392 <emphasis role="bold">Proxy.</emphasis> Enables the user to
3393 configure a HTTP Proxy Server.
3394 </para>
3395 </listitem>
3396
3397 </itemizedlist>
3398
3399 </sect1>
3400
3401 <sect1 id="frontends">
3402
3403 <title>Alternative Front-Ends</title>
3404
3405 <para>
3406 As briefly mentioned in <xref linkend="features-overview" />,
3407 &product-name; has a very flexible internal design that enables
3408 you to use multiple interfaces to control the same virtual
3409 machines. For example, you can start a virtual machine with the
3410 VirtualBox Manager window and then stop it from the command line.
3411 With &product-name;'s support for the Remote Desktop Protocol
3412 (RDP), you can even run virtual machines remotely on a headless
3413 server and have all the graphical output redirected over the
3414 network.
3415 </para>
3416
3417 <para>
3418 The following front-ends are shipped in the standard
3419 &product-name; package:
3420 </para>
3421
3422 <itemizedlist>
3423
3424 <listitem>
3425 <para>
3426 <emphasis role="bold">VirtualBox.</emphasis> This is the
3427 VirtualBox Manager, a graphical user interface that uses the
3428 Qt toolkit. This interface is described throughout this
3429 manual. While this is the simplest and easiest front-end to
3430 use, some of the more advanced &product-name; features are not
3431 included.
3432 </para>
3433 </listitem>
3434
3435 <listitem>
3436 <para>
3437 <emphasis role="bold">VBoxManage.</emphasis> A command-line
3438 interface for automated and detailed control of every aspect
3439 of &product-name;. See
3440 <xref
3441 linkend="vboxmanage" />.
3442 </para>
3443 </listitem>
3444
3445 <listitem>
3446 <para>
3447 <emphasis role="bold">VBoxHeadless.</emphasis> A front-end
3448 that produces no visible output on the host at all, but can
3449 act as a RDP server if the VirtualBox Remote Desktop Extension
3450 (VRDE) is installed and enabled for the VM. As opposed to the
3451 other graphical interfaces, the headless front-end requires no
3452 graphics support. This is useful, for example, if you want to
3453 host your virtual machines on a headless Linux server that has
3454 no X Window system installed. See
3455 <xref linkend="vboxheadless" />.
3456 </para>
3457 </listitem>
3458
3459 </itemizedlist>
3460
3461 <para>
3462 If the above front-ends still do not satisfy your particular
3463 needs, it is possible to create yet another front-end to the
3464 complex virtualization engine that is the core of &product-name;,
3465 as the &product-name; core neatly exposes all of its features in a
3466 clean API. See <xref linkend="VirtualBoxAPI" />.
3467 </para>
3468
3469 </sect1>
3470
3471</chapter>
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette