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