VirtualBox

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

Last change on this file since 77977 was 76786, checked in by vboxsync, 6 years ago

manual: integrate drop #40 with minimal manual adjustments (but everything into one book, with manually applied tweaks to turn the release notes into a pure changelog again, and eliminated trailing whitespace)

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