VirtualBox

source: vbox/trunk/doc/manual/en_US/user_BasicConcepts.xml@ 96407

Last change on this file since 96407 was 96407, checked in by vboxsync, 2 years ago

scm copyright and license note update

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 96.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 Copyright (C) 2006-2022 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="BasicConcepts">
29
30 <title>Configuring Virtual Machines</title>
31
32 <para>
33 This chapter provides detailed steps for configuring an
34 &product-name; virtual machine (VM). For an introduction to
35 &product-name; and steps to get your first virtual machine running,
36 see <xref linkend="Introduction" />.
37 </para>
38
39 <para>
40 You have considerable latitude when deciding what virtual hardware
41 to provide to the guest. Use virtual hardware to communicate with
42 the host system or with other guests. For example, you can use
43 virtual hardware in the following ways:
44 </para>
45
46 <itemizedlist>
47
48 <listitem>
49 <para>
50 Have &product-name; present an ISO CD-ROM image to a guest
51 system as if it were a physical CD-ROM.
52 </para>
53 </listitem>
54
55 <listitem>
56 <para>
57 Provide a guest system access to the physical network through
58 its virtual network card.
59 </para>
60 </listitem>
61
62 <listitem>
63 <para>
64 Provide the host system, other guests, and computers on the
65 Internet access to the guest system.
66 </para>
67 </listitem>
68
69 </itemizedlist>
70
71 <sect1 id="guestossupport">
72
73 <title>Supported Guest Operating Systems</title>
74
75 <para>
76 Because &product-name; is designed to provide a generic
77 virtualization environment for x86 systems, it can run guest
78 operating systems (OSes) of any kind.
79 </para>
80
81 <para>
82 The following guest OS platforms are supported:
83 </para>
84
85 <itemizedlist>
86
87 <listitem>
88 <para>
89 <emphasis role="bold">Platforms With Full Support.</emphasis>
90 These guest OS platforms qualify for Oracle Premier Support.
91 See <xref linkend="table-premier-support"/>.
92 </para>
93 </listitem>
94
95 <listitem>
96 <para>
97 <emphasis role="bold">Platforms With Limited
98 Support.</emphasis> These legacy guest OS platforms can be
99 used with &product-name;, but only qualify for <emphasis>best
100 effort</emphasis> support. Therefore, resolution of customer
101 issues is not guaranteed. See
102 <xref linkend="table-limited-support"/>.
103 </para>
104 </listitem>
105
106 </itemizedlist>
107
108 <table id="table-premier-support" tabstyle="oracle-all">
109 <title>Guest Operating Systems With Full Support</title>
110 <tgroup cols="2">
111 <thead>
112 <row>
113 <entry><para>
114 <emphasis role="bold">Operating System</emphasis>
115 </para></entry>
116 <entry><para>
117 <emphasis role="bold">Comments</emphasis>
118 </para></entry>
119 </row>
120 </thead>
121 <tbody>
122 <row>
123 <entry><para>
124 Windows 10 (32-bit and 64-bit)
125 </para></entry>
126 <entry><para>
127 Insider preview builds are not supported
128 </para></entry>
129 </row>
130 <row>
131 <entry><para>
132 Windows 8 and 8.1 (32-bit and 64-bit)
133 </para></entry>
134 <entry><para></para></entry>
135 </row>
136 <row>
137 <entry><para>
138 Windows Server 2019 (64-bit)
139 </para></entry>
140 <entry><para></para></entry>
141 </row>
142 <row>
143 <entry><para>
144 Windows Server 2016 (64-bit)
145 </para></entry>
146 <entry><para></para></entry>
147 </row>
148 <row>
149 <entry><para>
150 Windows Server 2012 and 2012 R2 (64-bit)
151 </para></entry>
152 <entry><para></para></entry>
153 </row>
154 <row>
155 <entry><para>
156 Solaris 11 (32-bit and 64-bit)
157 </para></entry>
158 <entry><para></para></entry>
159 </row>
160 <row>
161 <entry><para>
162 Solaris 10 8/11 Update 10 and later (32-bit and 64-bit)
163 </para></entry>
164 <entry><para></para></entry>
165 </row>
166 <row>
167 <entry><para>
168 Oracle Linux 8 (64-bit)
169 </para></entry>
170 <entry><para>
171 Includes Red Hat Enterprise Linux 8, CentOS 8
172 </para></entry>
173 </row>
174 <row>
175 <entry><para>
176 Oracle Linux 7 (64-bit)
177 </para></entry>
178 <entry><para>
179 Includes Red Hat Enterprise Linux 7, CentOS 7
180 </para></entry>
181 </row>
182 <row>
183 <entry><para>
184 Oracle Linux 6 (32-bit and 64-bit)
185 </para></entry>
186 <entry><para>
187 Includes Red Hat Enterprise Linux 6, CentOS 6
188 </para></entry>
189 </row>
190 <row>
191 <entry><para>
192 Ubuntu 16.04 LTS (Xenial Xerus) (32-bit and 64-bit)
193 </para></entry>
194 <entry><para></para></entry>
195 </row>
196 <row>
197 <entry><para>
198 Ubuntu 18.04 LTS (Bionic Beaver) (64-bit)
199 </para></entry>
200 <entry><para></para></entry>
201 </row>
202 <row>
203 <entry><para>
204 Ubuntu 20.04 LTS (Focal Fossa) (64-bit)
205 </para></entry>
206 <entry><para></para></entry>
207 </row>
208 <row>
209 <entry><para>
210 SUSE Linux Enterprise Server 15 (64-bit)
211 </para></entry>
212 <entry><para></para></entry>
213 </row>
214 <row>
215 <entry><para>
216 SUSE Linux Enterprise Server 12 (64-bit)
217 </para></entry>
218 <entry><para></para></entry>
219 </row>
220 </tbody>
221 </tgroup>
222 </table>
223
224 <table id="table-limited-support" tabstyle="oracle-all">
225 <title>Legacy Guest Operating Systems With Limited Support</title>
226 <tgroup cols="2">
227 <thead>
228 <row>
229 <entry><para>
230 <emphasis role="bold">Operating System</emphasis>
231 </para></entry>
232 <entry><para>
233 <emphasis role="bold">Comments</emphasis>
234 </para></entry>
235 </row>
236 </thead>
237 <tbody>
238 <row>
239 <entry><para>
240 Windows 7 (32-bit and 64-bit)
241 </para></entry>
242 <entry><para></para></entry>
243 </row>
244 <row>
245 <entry><para>
246 Windows Vista SP2 and later (32-bit and 64-bit)
247 </para></entry>
248 <entry><para></para></entry>
249 </row>
250 <row>
251 <entry><para>
252 Windows XP (32-bit)
253 </para></entry>
254 <entry><para></para></entry>
255 </row>
256 <row>
257 <entry><para>
258 Windows Vista (32-bit)
259 </para></entry>
260 <entry><para></para></entry>
261 </row>
262 <row>
263 <entry><para>
264 Windows Server 2008 and 2008 R2 (32-bit and 64-bit)
265 </para></entry>
266 <entry><para></para></entry>
267 </row>
268 <row>
269 <entry><para>
270 Windows Server 2003 (32-bit and 64-bit)
271 </para></entry>
272 <entry><para></para></entry>
273 </row>
274 <row>
275 <entry><para>
276 Oracle Linux 5 (32-bit and 64-bit)
277 </para></entry>
278 <entry><para>
279 Includes Red Hat Enterprise Linux 5, CentOS 5
280 </para></entry>
281 </row>
282 <row>
283 <entry><para>
284 Ubuntu 14.04.5 LTS (Trusty Tahr) (32-bit and 64-bit)
285 </para></entry>
286 <entry><para></para></entry>
287 </row>
288 <row>
289 <entry><para>
290 OS/2 Warp 4.5
291 </para></entry>
292 <entry><para></para></entry>
293 </row>
294 </tbody>
295 </tgroup>
296 </table>
297
298 <sect2 id="intro-macosxguests">
299
300 <title>Mac OS X Guests</title>
301
302 <para>
303 &product-name; enables you to install and execute unmodified
304 versions of Mac OS X guests on supported host hardware. Note
305 that this feature is experimental and thus unsupported.
306 </para>
307
308 <para>
309 &product-name; is the first product to provide the modern PC
310 architecture expected by OS X without requiring any of the
311 modifications used by competing virtualization solutions. For
312 example, some competing solutions perform modifications to the
313 Mac OS X install DVDs, such as a different boot loader and
314 replaced files.
315 </para>
316
317 <para>
318 Be aware of the following important issues before you attempt to
319 install a Mac OS X guest:
320 </para>
321
322 <itemizedlist>
323
324 <listitem>
325 <para>
326 Mac OS X is commercial, licensed software and contains
327 <emphasis role="bold">both license and technical
328 restrictions</emphasis> that limit its use to certain
329 hardware and usage scenarios. You must understand and comply
330 with these restrictions.
331 </para>
332
333 <para>
334 In particular, Apple prohibits the installation of most
335 versions of Mac OS X on non-Apple hardware.
336 </para>
337
338 <para>
339 These license restrictions are also enforced on a technical
340 level. Mac OS X verifies that it is running on Apple
341 hardware. Most DVDs that accompany Apple hardware check for
342 the exact model. These restrictions are
343 <emphasis>not</emphasis> circumvented by &product-name; and
344 continue to apply.
345 </para>
346 </listitem>
347
348 <listitem>
349 <para>
350 Only <emphasis role="bold">CPUs</emphasis> that are known
351 and tested by Apple are supported. As a result, if your
352 Intel CPU is newer than the Mac OS X build, or if you have a
353 non-Intel CPU, you will likely encounter a panic during
354 bootup with an "Unsupported CPU" exception.
355 </para>
356
357 <para>
358 Ensure that you use the Mac OS X DVD that comes with your
359 Apple hardware.
360 </para>
361 </listitem>
362
363 <listitem>
364 <para>
365 The Mac OS X installer expects the hard disk to be
366 <emphasis>partitioned</emphasis>. So, the installer will not
367 offer a partition selection to you. Before you can install
368 the software successfully, start the Disk Utility from the
369 Tools menu and partition the hard disk. Close the Disk
370 Utility and proceed with the installation.
371 </para>
372 </listitem>
373
374 <listitem>
375 <para>
376 In addition, Mac OS X support in &product-name; is an
377 experimental feature. See <xref linkend="KnownIssues" />.
378 </para>
379 </listitem>
380
381 </itemizedlist>
382
383 </sect2>
384
385 <sect2 id="intro-64bitguests">
386
387 <title>64-bit Guests</title>
388
389 <warning>
390 <para>
391 Be sure to enable <emphasis role="bold">I/O APIC</emphasis>
392 for virtual machines that you intend to use in 64-bit mode.
393 This is especially true for 64-bit Windows VMs. See
394 <xref linkend="settings-general-advanced" />. For 64-bit
395 Windows guests, ensure that the VM uses the
396 <emphasis role="bold">Intel networking device</emphasis>
397 because there is no 64-bit driver support for the AMD PCNet
398 card. See <xref linkend="nichardware" />.
399 </para>
400 </warning>
401
402 <para>
403 If you use the <emphasis role="bold">Create VM</emphasis> wizard
404 of the VirtualBox Manager, &product-name; automatically uses the
405 correct settings for each selected 64-bit OS type. See
406 <xref linkend="gui-createvm" />.
407 </para>
408
409 </sect2>
410
411 </sect1>
412
413 <sect1 id="basic-unattended">
414
415 <title>Unattended Guest Installation</title>
416
417 <para>
418 &product-name; can install a guest OS automatically. You only need
419 to provide the installation medium and a few other parameters,
420 such as the name of the default user.
421 </para>
422
423 <para>
424 Performing an unattended guest installation involves the following
425 steps:
426 </para>
427
428 <itemizedlist>
429
430 <listitem>
431 <para>
432 <emphasis role="bold">Create a new VM.</emphasis> Use one of
433 the following methods:
434 </para>
435
436 <itemizedlist>
437
438 <listitem>
439 <para>
440 The VirtualBox Manager, see
441 <xref linkend="gui-createvm" />.
442 </para>
443 </listitem>
444
445 <listitem>
446 <para>
447 The <command>VBoxManage createvm</command> command, see
448 <xref linkend="vboxmanage-createvm" />.
449 </para>
450 </listitem>
451
452 </itemizedlist>
453
454 <para>
455 For the new VM, choose the guest OS type and accept the
456 default settings for that OS. The following sections in this
457 chapter describe how to change the settings for a VM.
458 </para>
459 </listitem>
460
461 <listitem>
462 <para>
463 <emphasis role="bold">Prepare the VM for unattended guest
464 installation.</emphasis> Use the <command>VBoxManage
465 unattended</command> command, see
466 <xref linkend="vboxmanage-unattended" />.
467 </para>
468
469 <para>
470 During this step, &product-name; scans the installation medium
471 and changes certain parameters to ensure a seamless
472 installation as a guest running on &product-name;.
473 </para>
474 </listitem>
475
476 <listitem>
477 <para>
478 <emphasis role="bold">Start the VM.</emphasis> Use the
479 VirtualBox Manager or the <command>VBoxManage
480 startvm</command> command.
481 </para>
482
483 <para>
484 When you start the VM, the unattended installation is
485 performed automatically.
486 </para>
487
488 <para>
489 The installation operation changes the boot device order to
490 boot the virtual hard disk first and then the virtual DVD
491 drive. If the virtual hard disk is empty prior to the
492 automatic installation, the VM boots from the virtual DVD
493 drive and begins the installation.
494 </para>
495
496 <para>
497 If the virtual hard disk contains a bootable OS, the
498 installation operation exits. In this case, change the boot
499 device order manually by pressing F12 during the BIOS splash
500 screen.
501 </para>
502 </listitem>
503
504 </itemizedlist>
505
506 <para>
507 <xref linkend="unattended-guest-install-example"/> describes how
508 to perform an unattended guest installation for an Oracle Linux
509 guest.
510 </para>
511
512 <sect2 id="unattended-guest-install-example">
513
514 <title>An Example of Unattended Guest Installation</title>
515
516 <para>
517 The following example shows how to perform an unattended guest
518 installation for an Oracle Linux VM. The example uses various
519 <command>VBoxManage</command> commands to prepare the guest VM.
520 The <command>VBoxManage unattended install</command> command is
521 then used to install and configure the guest OS.
522 </para>
523
524 <orderedlist>
525
526 <listitem>
527 <para>
528 Create the virtual machine.
529 </para>
530
531<screen># VM="ol7-autoinstall"
532# VBoxManage list ostypes
533# VBoxManage createvm --name $VM --ostype "Oracle_64" --register</screen>
534
535 <para>
536 Note the following:
537 </para>
538
539 <itemizedlist>
540
541 <listitem>
542 <para>
543 The $VM variable represents the name of the VM.
544 </para>
545 </listitem>
546
547 <listitem>
548 <para>
549 The <command>VBoxManage list ostypes</command> command
550 lists the guest OSes supported by &product-name;,
551 including the name used for each OS in the
552 <command>VBoxManage</command> commands.
553 </para>
554 </listitem>
555
556 <listitem>
557 <para>
558 A 64-bit Oracle Linux 7 VM is created and registered
559 with &product-name;.
560 </para>
561 </listitem>
562
563 <listitem>
564 <para>
565 The VM has a unique UUID.
566 </para>
567 </listitem>
568
569 <listitem>
570 <para>
571 An XML settings file is generated.
572 </para>
573 </listitem>
574
575 </itemizedlist>
576 </listitem>
577
578 <listitem>
579 <para>
580 Create a virtual hard disk and storage devices for the VM.
581 </para>
582
583<screen># VBoxManage createhd --filename /VirtualBox/$VM/$VM.vdi --size 32768
584# VBoxManage storagectl $VM --name "SATA Controller" --add sata --controller IntelAHCI
585# VBoxManage storageattach $VM --storagectl "SATA Controller" --port 0 --device 0 \
586--type hdd --medium /VirtualBox/$VM/$VM.vdi
587# VBoxManage storagectl $VM --name "IDE Controller" --add ide
588# VBoxManage storageattach $VM --storagectl "IDE Controller" --port 0 --device 0 \
589--type dvddrive --medium /u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso</screen>
590
591 <para>
592 The previous commands do the following:
593 </para>
594
595 <itemizedlist>
596
597 <listitem>
598 <para>
599 Create a 32768 MB virtual hard disk.
600 </para>
601 </listitem>
602
603 <listitem>
604 <para>
605 Create a SATA storage controller and attach the virtual
606 hard disk.
607 </para>
608 </listitem>
609
610 <listitem>
611 <para>
612 Create an IDE storage controller for a virtual DVD drive
613 and attach an Oracle Linux installation ISO.
614 </para>
615 </listitem>
616
617 </itemizedlist>
618 </listitem>
619
620 <listitem>
621 <para>
622 (Optional) Configure some settings for the VM.
623 </para>
624
625<screen># VBoxManage modifyvm $VM --ioapic on
626# VBoxManage modifyvm $VM --boot1 dvd --boot2 disk --boot3 none --boot4 none
627# VBoxManage modifyvm $VM --memory 8192 --vram 128</screen>
628
629 <para>
630 The previous commands do the following:
631 </para>
632
633 <itemizedlist>
634
635 <listitem>
636 <para>
637 Enable I/O APIC for the motherboard of the VM.
638 </para>
639 </listitem>
640
641 <listitem>
642 <para>
643 Configure the boot device order for the VM.
644 </para>
645 </listitem>
646
647 <listitem>
648 <para>
649 Allocate 8192 MB of RAM and 128 MB of video RAM to the
650 VM.
651 </para>
652 </listitem>
653
654 </itemizedlist>
655 </listitem>
656
657 <listitem>
658 <para>
659 Perform an unattended install of the OS.
660 </para>
661
662<screen># VBoxManage unattended install $VM \
663--iso=/u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso \
664--user=<replaceable>login</replaceable> --full-user-name=<replaceable>name</replaceable> --password <replaceable>password</replaceable> \
665--install-additions --time-zone=CET</screen>
666
667 <para>
668 The previous command does the following:
669 </para>
670
671 <itemizedlist>
672
673 <listitem>
674 <para>
675 Specifies an Oracle Linux ISO as the installation ISO.
676 </para>
677 </listitem>
678
679 <listitem>
680 <para>
681 Specifies a login name, full name, and login password
682 for a default user on the guest OS.
683 </para>
684
685 <para>
686 Note that the specified password is also used for the
687 root user account on the guest.
688 </para>
689 </listitem>
690
691 <listitem>
692 <para>
693 Installs the Guest Additions on the VM.
694 </para>
695 </listitem>
696
697 <listitem>
698 <para>
699 Sets the time zone for the guest OS to Central European
700 Time (CET).
701 </para>
702 </listitem>
703
704 </itemizedlist>
705 </listitem>
706
707 <listitem>
708 <para>
709 Start the virtual machine.
710 </para>
711
712 <para>
713 This step completes the unattended installation process.
714 </para>
715
716<screen># VBoxManage startvm $VM --type headless</screen>
717
718 <para>
719 The VM starts in headless mode, which means that the
720 VirtualBox Manager window does not open.
721 </para>
722 </listitem>
723
724 <listitem>
725 <para>
726 (Optional) Update the guest OS to use the latest Oracle
727 Linux packages.
728 </para>
729
730 <para>
731 On the guest VM, run the following command:
732 </para>
733
734<screen># yum update</screen>
735 </listitem>
736
737 </orderedlist>
738
739 </sect2>
740
741 </sect1>
742
743 <sect1 id="emul-hardware">
744
745 <title>Emulated Hardware</title>
746
747 <para>
748 &product-name; virtualizes nearly all hardware of the host.
749 Depending on a VM's configuration, the guest will see the
750 following virtual hardware:
751 </para>
752
753 <itemizedlist>
754
755 <listitem>
756 <para>
757 <emphasis role="bold">Input devices.</emphasis> &product-name;
758 can emulate a standard PS/2 keyboard and mouse. These devices
759 are supported by most guest OSes.
760 </para>
761
762 <para>
763 In addition, &product-name; can provide virtual USB input
764 devices to avoid having to capture mouse and keyboard, as
765 described in <xref linkend="keyb_mouse_normal" />.
766 </para>
767 </listitem>
768
769 <listitem>
770 <para>
771 <emphasis role="bold">Graphics.</emphasis> The default
772 &product-name; graphics device for Windows guests is an SVGA
773 device. For Linux guests, the default graphics device emulates
774 a VMware SVGA graphics device. See
775 <xref linkend="settings-screen"/>.
776 </para>
777
778 <para>
779 For legacy guest OSes, a VGA-compatible graphics device is
780 available.
781 </para>
782 </listitem>
783
784 <listitem>
785 <para>
786 <emphasis role="bold">Storage.</emphasis> &product-name;
787 emulates the most common types of hard disk controllers. See
788 <xref linkend="harddiskcontrollers" />. Whereas supporting
789 only one of these controllers would be enough for
790 &product-name; by itself, this multitude of storage adapters
791 is required for compatibility with other hypervisors. Windows
792 is very selective about its boot devices, and migrating VMs
793 between hypervisors is very difficult or impossible if the
794 storage controllers are different.
795 </para>
796 </listitem>
797
798 <listitem>
799 <para>
800 <emphasis role="bold">Networking.</emphasis> See
801 <xref linkend="nichardware" />.
802 </para>
803 </listitem>
804
805 <listitem>
806 <para>
807 <emphasis role="bold">USB.</emphasis> &product-name; emulates
808 these types of USB host controllers: xHCI, EHCI, and OHCI.
809 While xHCI handles all USB transfer speeds, some legacy guest
810 OSes may not support xHCI. Note that for some legacy Windows
811 guests, third party drivers must be installed for xHCI
812 support.
813 </para>
814
815 <para>
816 Legacy guest OSes typically support OHCI and EHCI. These two
817 controllers are needed because OHCI only handles USB low-speed
818 and full-speed devices (both USB 1.x and 2.0), while EHCI only
819 handles high-speed devices (USB 2.0 only).
820 </para>
821
822 <para>
823 The emulated USB controllers do not communicate directly with
824 devices on the host. Instead they communicate with a virtual
825 USB layer which abstracts the USB protocol and enables the use
826 of remote USB devices.
827 </para>
828 </listitem>
829
830 <listitem>
831 <para>
832 <emphasis role="bold">Audio.</emphasis> See
833 <xref linkend="settings-audio" />.
834 </para>
835 </listitem>
836
837 </itemizedlist>
838
839 </sect1>
840
841 <sect1 id="generalsettings">
842
843 <title>General Settings</title>
844
845 <para>
846 In the <emphasis role="bold">Settings</emphasis> window, under
847 <emphasis role="bold">General</emphasis>, you can configure the
848 most fundamental aspects of the virtual machine such as memory and
849 essential hardware. The following tabs are available.
850 </para>
851
852 <sect2 id="settings-basic">
853
854 <title>Basic Tab</title>
855
856 <para>
857 In the <emphasis role="bold">Basic</emphasis> tab of the
858 <emphasis role="bold">General</emphasis> settings category, you
859 can find these settings:
860 </para>
861
862 <itemizedlist>
863
864 <listitem>
865 <para>
866 <emphasis role="bold">Name:</emphasis> The name of the the
867 VM, as shown in the list of VMs in the main VirtualBox
868 Manager window. Using this name, &product-name; also saves
869 the VM's configuration files. If you change the name,
870 &product-name; renames these files as well. As a result, you
871 can only use characters which are allowed for file names on
872 your host OS.
873 </para>
874
875 <para>
876 Note that internally, &product-name; uses unique identifiers
877 (UUIDs) to identify virtual machines. You can display these
878 using the <command>VBoxManage</command> commands.
879 </para>
880 </listitem>
881
882 <listitem>
883 <para>
884 <emphasis role="bold">Type:</emphasis> The type of the guest
885 OS for the VM. This is the same setting that is specified in
886 the <emphasis role="bold">New Virtual Machine</emphasis>
887 wizard. See <xref linkend="gui-createvm" />.
888 </para>
889
890 <para>
891 Whereas the default settings of a newly created VM depend on
892 the selected OS type, changing the type later has no effect
893 on VM settings. This value is purely informational and
894 decorative.
895 </para>
896 </listitem>
897
898 <listitem>
899 <para>
900 <emphasis role="bold">Version:</emphasis> The version of the
901 guest OS for the VM. This is the same setting that is
902 specified in the <emphasis role="bold">New Virtual
903 Machine</emphasis> wizard. See
904 <xref linkend="gui-createvm" />.
905 </para>
906 </listitem>
907
908 </itemizedlist>
909
910 </sect2>
911
912 <sect2 id="settings-general-advanced">
913
914 <title>Advanced Tab</title>
915
916 <para>
917 The following settings are available in the
918 <emphasis role="bold">Advanced</emphasis> tab:
919 </para>
920
921 <itemizedlist>
922
923 <listitem>
924 <para>
925 <emphasis role="bold">Snapshot Folder:</emphasis> By
926 default, &product-name; saves snapshot data together with
927 your other &product-name; configuration data. See
928 <xref linkend="vboxconfigdata" />. With this setting, you
929 can specify any other folder for each VM.
930 </para>
931 </listitem>
932
933 <listitem>
934 <para>
935 <emphasis role="bold">Shared Clipboard:</emphasis> You can
936 select here whether the clipboard of the guest OS should be
937 shared with that of your host. If you select
938 <emphasis role="bold">Bidirectional</emphasis>, then
939 &product-name; will always make sure that both clipboards
940 contain the same data. If you select
941 <emphasis role="bold">Host to Guest</emphasis> or
942 <emphasis role="bold">Guest to Host</emphasis>, then
943 &product-name; will only ever copy clipboard data in one
944 direction.
945 </para>
946
947 <para>
948 Clipboard sharing requires that the &product-name; Guest
949 Additions be installed. In such a case, this setting has no
950 effect. See <xref linkend="guestadditions" />.
951 </para>
952
953 <para>
954 For security reasons, the shared clipboard is disabled by
955 default. This setting can be changed at any time using the
956 <emphasis role="bold">Shared Clipboard</emphasis> menu item
957 in the <emphasis role="bold">Devices</emphasis> menu of the
958 virtual machine.
959 </para>
960 </listitem>
961
962 <listitem>
963 <para>
964 <emphasis role="bold">Drag and Drop:</emphasis> This setting
965 enables support for drag and drop. Select an object, such as
966 a file, from the host or guest and directly copy or open it
967 on the guest or host. Multiple drag and drop modes for a VM
968 enable restricting of access in either direction.
969 </para>
970
971 <para>
972 For drag and drop to work the Guest Additions need to be
973 installed on the guest.
974 </para>
975
976 <note>
977 <para>
978 Drag and drop is disabled by default. This setting can be
979 changed at any time using the <emphasis role="bold">Drag
980 and Drop</emphasis> menu item in the
981 <emphasis role="bold">Devices</emphasis> menu of the
982 virtual machine.
983 </para>
984 </note>
985
986 <para>
987 See <xref linkend="guestadd-dnd"/>.
988 </para>
989 </listitem>
990
991 </itemizedlist>
992
993 </sect2>
994
995 <sect2 id="settings-description">
996
997 <title>Description Tab</title>
998
999 <para>
1000 On the <emphasis role="bold">Description</emphasis> tab you can
1001 enter a description for your virtual machine. This has no effect
1002 on the functionality of the machine, but you may find this space
1003 useful to note down things such as the configuration of a
1004 virtual machine and the software that has been installed into
1005 it.
1006 </para>
1007
1008 <para>
1009 To insert a line break into the
1010 <emphasis role="bold">Description</emphasis> text field, press
1011 Shift+Enter.
1012 </para>
1013
1014 </sect2>
1015
1016 <sect2 id="settings-disk-encryption">
1017
1018 <title>Disk Encryption Tab</title>
1019
1020 <para>
1021 The <emphasis role="bold">Disk Encryption</emphasis> tab enables
1022 you to encrypt disks that are attached to the virtual machine.
1023 </para>
1024
1025 <para>
1026 To enable disk encryption, select the
1027 <emphasis role="bold">Enable Disk Encryption</emphasis> check
1028 box.
1029 </para>
1030
1031 <para>
1032 Settings are available to configure the cipher used for
1033 encryption and the encryption password.
1034 </para>
1035
1036 <note>
1037 <para>
1038 All files related to the virtual machine except disk images
1039 are stored unencrypted.
1040 </para>
1041 </note>
1042
1043 </sect2>
1044
1045 </sect1>
1046
1047 <sect1 id="settings-system">
1048
1049 <title>System Settings</title>
1050
1051 <para>
1052 The <emphasis role="bold">System</emphasis> category groups
1053 various settings that are related to the basic hardware that is
1054 presented to the virtual machine.
1055 </para>
1056
1057 <note>
1058 <para>
1059 As the activation mechanism of Microsoft Windows is sensitive to
1060 hardware changes, if you are changing hardware settings for a
1061 Windows guest, some of these changes may trigger a request for
1062 another activation with Microsoft.
1063 </para>
1064 </note>
1065
1066 <para>
1067 The following tabs are available.
1068 </para>
1069
1070 <sect2 id="settings-motherboard">
1071
1072 <title>Motherboard Tab</title>
1073
1074 <para>
1075 On the <emphasis role="bold">Motherboard</emphasis> tab, you can
1076 configure virtual hardware that would normally be on the
1077 motherboard of a real computer.
1078 </para>
1079
1080 <itemizedlist>
1081
1082 <listitem>
1083 <para>
1084 <emphasis role="bold">Base Memory:</emphasis> Sets the
1085 amount of RAM that is allocated and given to the VM when it
1086 is running. The specified amount of memory will be requested
1087 from the host OS, so it must be available or made available
1088 as free memory on the host when attempting to start the VM
1089 and will not be available to the host while the VM is
1090 running. This is the same setting that was specified in the
1091 <emphasis role="bold">New Virtual Machine</emphasis> wizard,
1092 as described in <xref linkend="gui-createvm" />.
1093 </para>
1094
1095 <para>
1096 Generally, it is possible to change the memory size after
1097 installing the guest OS. But you must not reduce the memory
1098 to an amount where the OS would no longer boot.
1099 </para>
1100 </listitem>
1101
1102 <listitem>
1103 <para>
1104 <emphasis role="bold">Boot Order:</emphasis> Determines the
1105 order in which the guest OS will attempt to boot from the
1106 various virtual boot devices. Analogous to a real PC's BIOS
1107 setting, &product-name; can tell a guest OS to start from
1108 the virtual floppy, the virtual CD/DVD drive, the virtual
1109 hard drive (each of these as defined by the other VM
1110 settings), the network, or none of these.
1111 </para>
1112
1113 <para>
1114 If you select <emphasis role="bold">Network</emphasis>, the
1115 VM will attempt to boot from a network using the PXE
1116 mechanism. This needs to be configured in detail on the
1117 command line. See <xref linkend="vboxmanage-modifyvm" />.
1118 </para>
1119 </listitem>
1120
1121 <listitem>
1122 <para>
1123 <emphasis role="bold">Chipset:</emphasis> You can select
1124 which chipset will be presented to the virtual machine.
1125 PIIX3 is the default chipset for most guests. For some guest
1126 OSes such as Mac OS X, the PIIX3 chipset is not well
1127 supported. As a result, &product-name; supports an emulation
1128 of the ICH9 chipset, which supports PCI express, three PCI
1129 buses, PCI-to-PCI bridges and Message Signaled Interrupts
1130 (MSI). This enables modern OSes to address more PCI devices
1131 and no longer requires IRQ sharing. Using the ICH9 chipset
1132 it is also possible to configure up to 36 network cards,
1133 compared to a maximum of eight network adapters with PIIX3.
1134 Note that ICH9 support is experimental and not recommended
1135 for guest OSes which do not require it.
1136 </para>
1137 </listitem>
1138
1139 <listitem>
1140 <para>
1141 <emphasis role="bold">Pointing Device:</emphasis> The
1142 default virtual pointing device for some guest OSes is the
1143 traditional PS/2 mouse. If set to <emphasis role="bold">USB
1144 Tablet</emphasis>, &product-name; reports to the virtual
1145 machine that a USB tablet device is present and communicates
1146 mouse events to the virtual machine through this device.
1147 Another setting is <emphasis role="bold">USB Multi-Touch
1148 Tablet</emphasis>, which is suitable for guests running
1149 Windows 8 or later.
1150 </para>
1151
1152 <para>
1153 Using the virtual USB tablet has the advantage that
1154 movements are reported in absolute coordinates, instead of
1155 as relative position changes. This enables &product-name; to
1156 translate mouse events over the VM window into tablet events
1157 without having to "capture" the mouse in the guest as
1158 described in <xref linkend="keyb_mouse_normal" />. This
1159 makes using the VM less tedious even if Guest Additions are
1160 not installed.
1161 </para>
1162 </listitem>
1163
1164 <listitem>
1165 <para>
1166 <emphasis role="bold">Enable I/O APIC:</emphasis> Advanced
1167 Programmable Interrupt Controllers (APICs) are an x86
1168 hardware feature that have replaced Programmable Interrupt
1169 Controllers (PICs). With an I/O APIC, OSes can use more than
1170 16 interrupt requests (IRQs) and therefore avoid IRQ sharing
1171 for improved reliability.
1172 </para>
1173
1174 <note>
1175 <para>
1176 Enabling the I/O APIC is <emphasis>required</emphasis>,
1177 especially for 64-bit Windows guest OSes. It is also
1178 required if you want to use more than one virtual CPU in a
1179 virtual machine.
1180 </para>
1181 </note>
1182
1183 <para>
1184 However, software support for I/O APICs has been unreliable
1185 with some OSes other than Windows. Also, the use of an I/O
1186 APIC slightly increases the overhead of virtualization and
1187 therefore slows down the guest OS a little.
1188 </para>
1189
1190 <warning>
1191 <para>
1192 All Windows OSes install different kernels, depending on
1193 whether an I/O APIC is available. As with ACPI, the I/O
1194 APIC therefore <emphasis>must not be turned off after
1195 installation</emphasis> of a Windows guest OS. Turning it
1196 on after installation will have no effect however.
1197 </para>
1198 </warning>
1199 </listitem>
1200
1201 <listitem>
1202 <para>
1203 <emphasis role="bold">Enable EFI:</emphasis> Enables
1204 Extensible Firmware Interface (EFI), which replaces the
1205 legacy BIOS and may be useful for certain advanced use
1206 cases. See <xref linkend="efi" />.
1207 </para>
1208 </listitem>
1209
1210 <listitem>
1211 <para>
1212 <emphasis role="bold">Hardware Clock in UTC Time:</emphasis>
1213 If selected, &product-name; will report the system time in
1214 UTC format to the guest instead of the local (host) time.
1215 This affects how the virtual real-time clock (RTC) operates
1216 and may be useful for UNIX-like guest OSes, which typically
1217 expect the hardware clock to be set to UTC.
1218 </para>
1219 </listitem>
1220
1221 </itemizedlist>
1222
1223 <para>
1224 In addition, you can turn off the <emphasis role="bold">Advanced
1225 Configuration and Power Interface (ACPI)</emphasis> which
1226 &product-name; presents to the guest OS by default.
1227 </para>
1228
1229 <para>
1230 ACPI is the current industry standard to allow OSes to recognize
1231 hardware, configure motherboards and other devices and manage
1232 power. As most computers contain this feature and Windows and
1233 Linux support ACPI, it is also enabled by default in
1234 &product-name;. ACPI can only be turned off using the command
1235 line. See <xref linkend="vboxmanage-modifyvm" />.
1236 </para>
1237
1238 <warning>
1239 <para>
1240 All Windows OSes install different kernels, depending on
1241 whether ACPI is available. This means that ACPI <emphasis>must
1242 not be turned off</emphasis> after installation of a Windows
1243 guest OS. However, turning it on after installation will have
1244 no effect.
1245 </para>
1246 </warning>
1247
1248 </sect2>
1249
1250 <sect2 id="settings-processor">
1251
1252 <title>Processor Tab</title>
1253
1254 <para>
1255 On the <emphasis role="bold">Processor</emphasis> tab, you can
1256 configure settings for the CPU used by the virtual machine.
1257 </para>
1258
1259 <itemizedlist>
1260
1261 <listitem>
1262 <para>
1263 <emphasis role="bold">Processor(s):</emphasis> Sets the
1264 number of virtual CPU cores the guest OSes can see.
1265 &product-name; supports symmetrical multiprocessing (SMP)
1266 and can present up to 32 virtual CPU cores to each virtual
1267 machine.
1268 </para>
1269
1270 <para>
1271 You should not configure virtual machines to use more CPU
1272 cores than are available physically. This includes real
1273 cores, with no hyperthreads.
1274 </para>
1275 </listitem>
1276
1277 <listitem>
1278 <para>
1279 <emphasis role="bold">Execution Cap:</emphasis> Configures
1280 the CPU execution cap. This limits the amount of time a host
1281 CPU spends to emulate a virtual CPU. The default setting is
1282 100%, meaning that there is no limitation. A setting of 50%
1283 implies a single virtual CPU can use up to 50% of a single
1284 host CPU. Note that limiting the execution time of the
1285 virtual CPUs may cause guest timing problems.
1286 </para>
1287
1288 <para>
1289 A warning is displayed at the bottom of the Processor tab if
1290 an Execution Cap setting is made that may affect system
1291 performance.
1292 </para>
1293 </listitem>
1294
1295 <listitem>
1296 <para>
1297 <emphasis role="bold">Enable PAE/NX:</emphasis> Determines
1298 whether the PAE and NX capabilities of the host CPU will be
1299 exposed to the virtual machine.
1300 </para>
1301
1302 <para>
1303 PAE stands for Physical Address Extension. Normally, if
1304 enabled and supported by the OS, then even a 32-bit x86 CPU
1305 can access more than 4 GB of RAM. This is made possible by
1306 adding another 4 bits to memory addresses, so that with 36
1307 bits, up to 64 GB can be addressed. Some OSes, such as
1308 Ubuntu Server, require PAE support from the CPU and cannot
1309 be run in a virtual machine without it.
1310 </para>
1311 </listitem>
1312
1313 <listitem>
1314 <para>
1315 <emphasis role="bold">Enable Nested VT-x/AMD-V</emphasis>:
1316 Enables nested virtualization, with passthrough of hardware
1317 virtualization functions to the guest VM.
1318 </para>
1319 </listitem>
1320
1321 </itemizedlist>
1322
1323 <para>
1324 With virtual machines running modern server OSes, &product-name;
1325 also supports CPU hot-plugging. For details, see
1326 <xref linkend="cpuhotplug" />.
1327 </para>
1328
1329 </sect2>
1330
1331 <sect2 id="settings-acceleration">
1332
1333 <title>Acceleration Tab</title>
1334
1335 <para>
1336 On this tab, you can configure &product-name; to use hardware
1337 virtualization extensions that your host CPU supports.
1338 </para>
1339
1340 <itemizedlist>
1341
1342 <listitem>
1343 <para>
1344 <emphasis role="bold">Paravirtualization
1345 Interface:</emphasis> &product-name; provides
1346 paravirtualization interfaces to improve time-keeping
1347 accuracy and performance of guest OSes. The options
1348 available are documented under the
1349 <option>--paravirt-provider</option> option in
1350 <xref linkend="vboxmanage-modifyvm" />. For further details
1351 on the paravirtualization providers, see
1352 <xref linkend="gimproviders" />.
1353 </para>
1354 </listitem>
1355
1356 <listitem>
1357 <para>
1358 <emphasis role="bold">Hardware Virtualization:</emphasis>
1359 You can configure hardware virtualization features for each
1360 virtual machine.
1361 </para>
1362
1363 <itemizedlist>
1364
1365 <listitem>
1366 <para>
1367 <emphasis role="bold">Enable Nested Paging:</emphasis>
1368 If the host CPU supports the nested paging (AMD-V) or
1369 EPT (Intel VT-x) features, then you can expect a
1370 significant performance increase by enabling nested
1371 paging in addition to hardware virtualization. For
1372 technical details, see <xref linkend="nestedpaging" />.
1373 For Intel EPT security recommendations, see
1374 <xref linkend="sec-rec-cve-2018-3646" />.
1375 </para>
1376 </listitem>
1377
1378 </itemizedlist>
1379
1380 <para>
1381 Advanced users may be interested in technical details about
1382 hardware virtualization. See <xref linkend="hwvirt" />.
1383 </para>
1384 </listitem>
1385
1386 </itemizedlist>
1387
1388 <para>
1389 In most cases, the default settings on the
1390 <emphasis role="bold">Acceleration</emphasis> tab will work
1391 well. &product-name; selects sensible defaults, depending on the
1392 OS that you selected when you created the virtual machine. In
1393 certain situations, however, you may want to change the
1394 preconfigured defaults.
1395 </para>
1396
1397 </sect2>
1398
1399 </sect1>
1400
1401 <sect1 id="settings-display">
1402
1403 <title>Display Settings</title>
1404
1405 <para>
1406 The following tabs are available for configuring the display for a
1407 virtual machine.
1408 </para>
1409
1410 <sect2 id="settings-screen">
1411
1412 <title>Screen Tab</title>
1413
1414 <itemizedlist>
1415
1416 <listitem>
1417 <para>
1418 <emphasis role="bold">Video Memory:</emphasis> Sets the size
1419 of the memory provided by the virtual graphics card
1420 available to the guest, in MB. As with the main memory, the
1421 specified amount will be allocated from the host's resident
1422 memory. Based on the amount of video memory, higher
1423 resolutions and color depths may be available.
1424 </para>
1425
1426 <para>
1427 The GUI will show a warning if the amount of video memory is
1428 too small to be able to switch the VM into full screen mode.
1429 The minimum value depends on the number of virtual monitors,
1430 the screen resolution and the color depth of the host
1431 display as well as on the use of <emphasis>3D
1432 acceleration</emphasis> and <emphasis>2D video
1433 acceleration</emphasis>. A rough estimate is
1434 (<emphasis>color depth</emphasis> / 8) x <emphasis>vertical
1435 pixels</emphasis> x <emphasis>horizontal pixels</emphasis> x
1436 <emphasis>number of screens</emphasis> = <emphasis>number of
1437 bytes</emphasis>. Extra memory may be required if display
1438 acceleration is used.
1439 </para>
1440 </listitem>
1441
1442 <listitem>
1443 <para>
1444 <emphasis role="bold">Monitor Count:</emphasis> With this
1445 setting, &product-name; can provide more than one virtual
1446 monitor to a virtual machine. If a guest OS supports
1447 multiple attached monitors, &product-name; can pretend that
1448 multiple virtual monitors are present. Up to eight such
1449 virtual monitors are supported.
1450 </para>
1451
1452 <para>
1453 The output of the multiple monitors are displayed on the
1454 host in multiple VM windows which are running side by side.
1455 However, in full screen and seamless mode, they use the
1456 available physical monitors attached to the host. As a
1457 result, for full screen and seamless modes to work with
1458 multiple monitors, you will need at least as many physical
1459 monitors as you have virtual monitors configured, or
1460 &product-name; will report an error.
1461 </para>
1462
1463 <para>
1464 You can configure the relationship between guest and host
1465 monitors using the <emphasis role="bold">View</emphasis>
1466 menu by pressing Host key + Home when you are in full screen
1467 or seamless mode.
1468 </para>
1469
1470 <para>
1471 See also <xref linkend="KnownIssues" />.
1472 </para>
1473 </listitem>
1474
1475 <listitem>
1476 <para>
1477 <emphasis role="bold">Scale Factor:</emphasis> Enables
1478 scaling of the display size. For multiple monitor displays,
1479 you can set the scale factor for individual monitors, or
1480 globally for all of the monitors. Use the slider to select a
1481 scaling factor up to 200%.
1482 </para>
1483
1484 <para>
1485 You can set a default scale factor for all VMs. Use the
1486 <emphasis role="bold">Display</emphasis> tab in the Global
1487 Settings dialogs.
1488 </para>
1489 </listitem>
1490
1491 <listitem>
1492 <para>
1493 <emphasis role="bold">Graphics Controller:</emphasis>
1494 Specifies the graphics adapter type used by the guest VM.
1495 Note that you must install the Guest Additions on the guest
1496 VM to specify the VBoxSVGA or VMSVGA graphics controller.
1497 The following options are available:
1498 </para>
1499
1500 <itemizedlist>
1501
1502 <listitem>
1503 <para>
1504 <emphasis role="bold">VBoxSVGA:</emphasis> The default
1505 graphics controller for new VMs that use Windows 7 or
1506 later.
1507 </para>
1508
1509 <para>
1510 This graphics controller improves performance and 3D
1511 support when compared to the legacy VBoxVGA option.
1512 </para>
1513 </listitem>
1514
1515 <listitem>
1516 <para>
1517 <emphasis role="bold">VBoxVGA:</emphasis> Use this
1518 graphics controller for legacy guest OSes. This is the
1519 default graphics controller for Windows versions before
1520 Windows 7 and for Oracle Solaris.
1521 </para>
1522
1523 <para>
1524 3D acceleration is not supported for this graphics
1525 controller.
1526 </para>
1527 </listitem>
1528
1529 <listitem>
1530 <para>
1531 <emphasis role="bold">VMSVGA:</emphasis> Use this
1532 graphics controller to emulate a VMware SVGA graphics
1533 device. This is the default graphics controller for
1534 Linux guests.
1535 </para>
1536 </listitem>
1537
1538 <listitem>
1539 <para>
1540 <emphasis role="bold">None:</emphasis> Does not emulate
1541 a graphics adapter type.
1542 </para>
1543 </listitem>
1544
1545 </itemizedlist>
1546 </listitem>
1547
1548 <listitem>
1549 <para>
1550 <emphasis role="bold">Enable 3D Acceleration:</emphasis> If
1551 a virtual machine has Guest Additions installed, you can
1552 select here whether the guest should support accelerated 3D
1553 graphics. See <xref linkend="guestadd-3d" />.
1554 </para>
1555 </listitem>
1556
1557 <listitem>
1558 <para>
1559 <emphasis role="bold">Enable 2D Video
1560 Acceleration:</emphasis> If a virtual machine with Microsoft
1561 Windows has Guest Additions installed, you can select here
1562 whether the guest should support accelerated 2D video
1563 graphics. See <xref linkend="guestadd-2d" />.
1564 </para>
1565 </listitem>
1566
1567 </itemizedlist>
1568
1569 </sect2>
1570
1571 <sect2 id="settings-remote-display">
1572
1573 <title>Remote Display Tab</title>
1574
1575 <para>
1576 On the <emphasis role="bold">Remote Display</emphasis> tab, if
1577 the VirtualBox Remote Display Extension (VRDE) is installed, you
1578 can enable the VRDP server that is built into &product-name;.
1579 This enables you to connect to the console of the virtual
1580 machine remotely with any standard RDP viewer, such as
1581 <command>mstsc.exe</command> that comes with Microsoft Windows.
1582 On Linux and Oracle Solaris systems you can use the standard
1583 open source <command>rdesktop</command> program. These features
1584 are described in <xref linkend="vrde" />.
1585 </para>
1586
1587 <itemizedlist>
1588
1589 <listitem>
1590 <para>
1591 <emphasis role="bold">Enable Server:</emphasis> Select this
1592 check box and configure settings for the remote display
1593 connection.
1594 </para>
1595 </listitem>
1596
1597 </itemizedlist>
1598
1599 </sect2>
1600
1601 <sect2 id="settings-capture">
1602
1603 <title>Recording Tab</title>
1604
1605 <para>
1606 On the <emphasis role="bold">Recording</emphasis> tab you can
1607 enable video and audio recording for a virtual machine and
1608 change related settings. Note that these features can be enabled
1609 and disabled while a VM is running.
1610 </para>
1611
1612 <itemizedlist>
1613
1614 <listitem>
1615 <para>
1616 <emphasis role="bold">Enable Recording:</emphasis> Select
1617 this check box and select a <emphasis role="bold">Recording
1618 Mode</emphasis> option.
1619 </para>
1620 </listitem>
1621
1622 <listitem>
1623 <para>
1624 <emphasis role="bold">Recording Mode:</emphasis> You can
1625 choose to record video, audio, or both video and audio.
1626 </para>
1627
1628 <para>
1629 Some settings on the
1630 <emphasis role="bold">Recording</emphasis> tab may be grayed
1631 out, depending on the <emphasis role="bold">Recording
1632 Mode</emphasis> setting.
1633 </para>
1634 </listitem>
1635
1636 <listitem>
1637 <para>
1638 <emphasis role="bold">File Path:</emphasis> The file where
1639 the recording is saved.
1640 </para>
1641 </listitem>
1642
1643 <listitem>
1644 <para>
1645 <emphasis role="bold">Frame Size:</emphasis> The video
1646 resolution of the recorded video, in pixels. The drop-down
1647 list enables you to select from common frame sizes.
1648 </para>
1649 </listitem>
1650
1651 <listitem>
1652 <para>
1653 <emphasis role="bold">Frame Rate:</emphasis> Use the slider
1654 to set the maximum number of video frames per second (FPS)
1655 to record. Frames that have a higher frequency are skipped.
1656 Increasing this value reduces the number of skipped frames
1657 and increases the file size.
1658 </para>
1659 </listitem>
1660
1661 <listitem>
1662 <para>
1663 <emphasis role="bold">Video Quality:</emphasis> Use the
1664 slider to set the the bit rate of the video in kilobits per
1665 second. Increasing this value improves the appearance of the
1666 video at the cost of an increased file size.
1667 </para>
1668 </listitem>
1669
1670 <listitem>
1671 <para>
1672 <emphasis role="bold">Audio Quality:</emphasis> Use the
1673 slider to set the quality of the audio recording. Increasing
1674 this value improves the audio quality at the cost of an
1675 increased file size.
1676 </para>
1677 </listitem>
1678
1679 <listitem>
1680 <para>
1681 <emphasis role="bold">Screens:</emphasis> For a multiple
1682 monitor display, you can select which screens to record
1683 video from.
1684 </para>
1685 </listitem>
1686
1687 </itemizedlist>
1688
1689 <para>
1690 As you adjust the video and audio recording settings, the
1691 approximate output file size for a five minute video is shown.
1692 </para>
1693
1694 </sect2>
1695
1696 </sect1>
1697
1698 <sect1 id="settings-storage">
1699
1700 <title>Storage Settings</title>
1701
1702 <para>
1703 The <emphasis role="bold">Storage</emphasis> category in the VM
1704 settings enables you to connect virtual hard disk, CD/DVD, and
1705 floppy images and drives to your virtual machine.
1706 </para>
1707
1708 <para>
1709 In a real computer, so-called <emphasis>storage
1710 controllers</emphasis> connect physical disk drives to the rest of
1711 the computer. Similarly, &product-name; presents virtual storage
1712 controllers to a virtual machine. Under each controller, the
1713 virtual devices, such as hard disks, CD/DVD or floppy drives,
1714 attached to the controller are shown.
1715 </para>
1716
1717 <note>
1718 <para>
1719 This section gives a quick introduction to the &product-name;
1720 storage settings. See <xref linkend="storage" /> for a full
1721 description of the available storage settings in &product-name;.
1722 </para>
1723 </note>
1724
1725 <para>
1726 If you have used the <emphasis role="bold">Create VM</emphasis>
1727 wizard to create a machine, you will normally see something like
1728 the following:
1729 </para>
1730
1731 <figure id="fig-storage-settings">
1732 <title>Storage Settings for a Virtual Machine</title>
1733 <mediaobject>
1734 <imageobject>
1735 <imagedata align="center" fileref="images/vm-settings-harddisk.png"
1736 width="10cm" />
1737 </imageobject>
1738 </mediaobject>
1739 </figure>
1740
1741 <para>
1742 Depending on the guest OS type that you selected when you created
1743 the VM, a new VM includes the following storage devices:
1744 </para>
1745
1746 <itemizedlist>
1747
1748 <listitem>
1749 <para>
1750 <emphasis role="bold">IDE controller.</emphasis> A virtual
1751 CD/DVD drive is attached to device 0 on the secondary channel
1752 of the IDE controller.
1753 </para>
1754 </listitem>
1755
1756 <listitem>
1757 <para>
1758 <emphasis role="bold">SATA controller.</emphasis> This is a
1759 modern type of storage controller for higher hard disk data
1760 throughput, to which the virtual hard disks are attached.
1761 Initially you will normally have one such virtual disk, but as
1762 shown in the previous screenshot, you can have more than one.
1763 Each is represented by a disk image file, such as a VDI file
1764 in this example.
1765 </para>
1766 </listitem>
1767
1768 </itemizedlist>
1769
1770 <para>
1771 If you created your VM with an older version of &product-name;,
1772 the default storage layout may differ. You might then only have an
1773 IDE controller to which both the CD/DVD drive and the hard disks
1774 have been attached. This might also apply if you selected an older
1775 OS type when you created the VM. Since older OSes do not support
1776 SATA without additional drivers, &product-name; will make sure
1777 that no such devices are present initially. See
1778 <xref linkend="harddiskcontrollers" />.
1779 </para>
1780
1781 <para>
1782 &product-name; also provides a <emphasis>floppy
1783 controller</emphasis>. You cannot add devices other than floppy
1784 drives to this controller. Virtual floppy drives, like virtual
1785 CD/DVD drives, can be connected to either a host floppy drive, if
1786 you have one, or a disk image, which in this case must be in RAW
1787 format.
1788 </para>
1789
1790 <para>
1791 You can modify these media attachments freely. For example, if you
1792 wish to copy some files from another virtual disk that you
1793 created, you can connect that disk as a second hard disk, as in
1794 the above screenshot. You could also add a second virtual CD/DVD
1795 drive, or change where these items are attached. The following
1796 options are available:
1797 </para>
1798
1799 <itemizedlist>
1800
1801 <listitem>
1802 <para>
1803 To <emphasis role="bold">add another virtual hard disk, or a
1804 CD/DVD or floppy drive</emphasis>, select the storage
1805 controller to which it should be added (such as IDE, SATA,
1806 SCSI, SAS, floppy controller) and then click the
1807 <emphasis role="bold">Add Disk</emphasis> button below the
1808 tree. You can then either select <emphasis role="bold">Optical
1809 Drive</emphasis> or <emphasis role="bold">Hard
1810 Disk</emphasis>. If you clicked on a floppy controller, you
1811 can add a floppy drive instead. Alternatively, right-click on
1812 the storage controller and select a menu item there.
1813 </para>
1814
1815 <para>
1816 A dialog is displayed, enabling you to select an existing disk
1817 image file or to create a new disk image file. Depending on
1818 the type of disk image, the dialog is called
1819 <emphasis role="bold">Hard Disk Selector</emphasis>,
1820 <emphasis role="bold">Optical Disk Selector</emphasis>, or
1821 <emphasis role="bold">Floppy Disk Selector</emphasis>.
1822 </para>
1823
1824 <para>
1825 See <xref linkend="vdidetails"/> for information on the image
1826 file types that are supported by &product-name;.
1827 </para>
1828
1829 <para>
1830 For virtual CD/DVD drives, the image files will typically be
1831 in the standard ISO format instead. Most commonly, you will
1832 select this option when installing an OS from an ISO file that
1833 you have obtained from the Internet. For example, most Linux
1834 distributions are available in this way.
1835 </para>
1836
1837 <para>
1838 Depending on the type of disk image, you can set the following
1839 <emphasis role="bold">Attributes</emphasis> for the disk image
1840 in the right part of the Storage settings page:
1841 </para>
1842
1843 <itemizedlist>
1844
1845 <listitem>
1846 <para>
1847 The <emphasis role="bold">device slot</emphasis> of the
1848 controller that the virtual disk is connected to. IDE
1849 controllers have four slots: primary device 0, primary
1850 device 1, secondary device 0, and secondary device 1. By
1851 contrast, SATA and SCSI controllers offer you up to 30
1852 slots for attaching virtual devices.
1853 </para>
1854 </listitem>
1855
1856 <listitem>
1857 <para>
1858 <emphasis role="bold">Solid-state Drive</emphasis>
1859 presents a virtual disk to the guest as a solid-state
1860 device.
1861 </para>
1862 </listitem>
1863
1864 <listitem>
1865 <para>
1866 <emphasis role="bold">Hot-pluggable</emphasis> presents a
1867 virtual disk to the guest as a hot-pluggable device.
1868 </para>
1869 </listitem>
1870
1871 <listitem>
1872 <para>
1873 For virtual CD/DVD drives, you can select
1874 <emphasis role="bold">Live CD/DVD</emphasis>. This means
1875 that the virtual optical disk is not removed from when the
1876 guest system ejects it.
1877 </para>
1878 </listitem>
1879
1880 </itemizedlist>
1881 </listitem>
1882
1883 <listitem>
1884 <para>
1885 To <emphasis role="bold">remove an attachment</emphasis>,
1886 either select it and click on the
1887 <emphasis role="bold">Remove</emphasis> icon at the bottom, or
1888 right-click on it and select the menu item.
1889 </para>
1890 </listitem>
1891
1892 </itemizedlist>
1893
1894 <para>
1895 Removable media, such as CD/DVDs and floppies, can be changed
1896 while the guest is running. Since the
1897 <emphasis role="bold">Settings</emphasis> dialog is not available
1898 at that time, you can also access these settings from the
1899 <emphasis role="bold">Devices</emphasis> menu of your virtual
1900 machine window.
1901 </para>
1902
1903 </sect1>
1904
1905 <sect1 id="settings-audio">
1906
1907 <title>Audio Settings</title>
1908
1909 <para>
1910 The <emphasis role="bold">Audio</emphasis> section in a virtual
1911 machine's <emphasis role="bold">Settings</emphasis> window
1912 determines whether the VM will detect a connected sound card, and
1913 if the audio output should be played on the host system.
1914 </para>
1915
1916 <para>
1917 To enable audio for a guest, select the
1918 <emphasis role="bold">Enable Audio</emphasis> check box. The
1919 following settings are available:
1920 </para>
1921
1922 <itemizedlist>
1923
1924 <listitem>
1925 <para>
1926 <emphasis role="bold">Host Audio Driver:</emphasis> The audio
1927 driver that &product-name; uses on the host. On a Linux host,
1928 depending on your host configuration, you can select between
1929 the OSS, ALSA, or the PulseAudio subsystem. On newer Linux
1930 distributions, the PulseAudio subsystem is preferred.
1931 </para>
1932
1933 <para>
1934 Only OSS is supported on Oracle Solaris hosts. The Oracle
1935 Solaris Audio audio backend is no longer supported on Oracle
1936 Solaris hosts.
1937 </para>
1938 </listitem>
1939
1940 <listitem>
1941 <para>
1942 <emphasis role="bold">Audio Controller:</emphasis> You can
1943 choose between the emulation of an Intel AC'97 controller, an
1944 Intel HD Audio controller, or a SoundBlaster 16 card.
1945 </para>
1946 </listitem>
1947
1948 <listitem>
1949 <para>
1950 <emphasis role="bold">Enable Audio Output:</emphasis> Enables
1951 audio output only for the VM.
1952 </para>
1953 </listitem>
1954
1955 <listitem>
1956 <para>
1957 <emphasis role="bold">Enable Audio Input:</emphasis> Enables
1958 audio input only for the VM.
1959 </para>
1960 </listitem>
1961
1962 </itemizedlist>
1963
1964 </sect1>
1965
1966 <sect1 id="settings-network">
1967
1968 <title>Network Settings</title>
1969
1970 <para>
1971 The <emphasis role="bold">Network</emphasis> section in a virtual
1972 machine's <emphasis role="bold">Settings</emphasis> window enables
1973 you to configure how &product-name; presents virtual network cards
1974 to your VM, and how they operate.
1975 </para>
1976
1977 <para>
1978 When you first create a virtual machine, &product-name; by default
1979 enables one virtual network card and selects the Network Address
1980 Translation (NAT) mode for it. This way the guest can connect to
1981 the outside world using the host's networking and the outside
1982 world can connect to services on the guest which you choose to
1983 make visible outside of the virtual machine.
1984 </para>
1985
1986 <para>
1987 This default setup is good for the majority of &product-name;
1988 users. However, &product-name; is extremely flexible in how it can
1989 virtualize networking. It supports many virtual network cards per
1990 virtual machine. The first four virtual network cards can be
1991 configured in detail in the VirtualBox Manager window. Additional
1992 network cards can be configured using the
1993 <command>VBoxManage</command> command.
1994 </para>
1995
1996 <para>
1997 Many networking options are available. See
1998 <xref linkend="networkingdetails" /> for more information.
1999 </para>
2000
2001 </sect1>
2002
2003 <sect1 id="serialports">
2004
2005 <title>Serial Ports</title>
2006
2007 <para>
2008 &product-name; supports the use of virtual serial ports in a
2009 virtual machine.
2010 </para>
2011
2012 <para>
2013 Ever since the original IBM PC, personal computers have been
2014 equipped with one or two serial ports, also called COM ports by
2015 DOS and Windows. Serial ports were commonly used with modems, and
2016 some computer mice used to be connected to serial ports before USB
2017 became commonplace.
2018 </para>
2019
2020 <para>
2021 While serial ports are no longer as common as they used to be,
2022 there are still some important uses left for them. For example,
2023 serial ports can be used to set up a primitive network over a
2024 null-modem cable, in case Ethernet is not available. Also, serial
2025 ports are indispensable for system programmers needing to do
2026 kernel debugging, since kernel debugging software usually
2027 interacts with developers over a serial port. With virtual serial
2028 ports, system programmers can do kernel debugging on a virtual
2029 machine instead of needing a real computer to connect to.
2030 </para>
2031
2032 <para>
2033 If a virtual serial port is enabled, the guest OS sees a standard
2034 16550A compatible UART device. Other UART types can be configured
2035 using the <command>VBoxManage modifyvm</command> command. Both
2036 receiving and transmitting data is supported. How this virtual
2037 serial port is then connected to the host is configurable, and the
2038 details depend on your host OS.
2039 </para>
2040
2041 <para>
2042 You can use either the Settings tabs or the
2043 <command>VBoxManage</command> command to set up virtual serial
2044 ports. For the latter, see <xref linkend="vboxmanage-modifyvm" />
2045 for information on the <option>--uart</option>,
2046 <option>--uart-mode</option> and <option>--uart-type</option>
2047 options.
2048 </para>
2049
2050 <para>
2051 You can configure up to four virtual serial ports per virtual
2052 machine. For each device, you must set the following:
2053 </para>
2054
2055 <orderedlist>
2056
2057 <listitem>
2058 <para>
2059 <emphasis role="bold">Port Number:</emphasis> This determines
2060 the serial port that the virtual machine should see. For best
2061 results, use the traditional values as follows:
2062 </para>
2063
2064 <itemizedlist>
2065
2066 <listitem>
2067 <para>
2068 COM1: I/O base 0x3F8, IRQ 4
2069 </para>
2070 </listitem>
2071
2072 <listitem>
2073 <para>
2074 COM2: I/O base 0x2F8, IRQ 3
2075 </para>
2076 </listitem>
2077
2078 <listitem>
2079 <para>
2080 COM3: I/O base 0x3E8, IRQ 4
2081 </para>
2082 </listitem>
2083
2084 <listitem>
2085 <para>
2086 COM4: I/O base 0x2E8, IRQ 3
2087 </para>
2088 </listitem>
2089
2090 </itemizedlist>
2091
2092 <para>
2093 You can also configure a user-defined serial port. Enter an
2094 I/O base address and interrupt (IRQ).
2095 </para>
2096 </listitem>
2097
2098 <listitem>
2099 <para>
2100 <emphasis role="bold">Port Mode:</emphasis> What the virtual
2101 port is connected to. For each virtual serial port, you have
2102 the following options:
2103 </para>
2104
2105 <itemizedlist>
2106
2107 <listitem>
2108 <para>
2109 <emphasis role="bold">Disconnected:</emphasis> The guest
2110 will see the device, but it will behave as if no cable had
2111 been connected to it.
2112 </para>
2113 </listitem>
2114
2115 <listitem>
2116 <para>
2117 <emphasis role="bold">Host Device:</emphasis> Connects the
2118 virtual serial port to a physical serial port on your
2119 host. On a Windows host, this will be a name like
2120 <literal>COM1</literal>. On Linux or Oracle Solaris hosts,
2121 it will be a device node like
2122 <filename>/dev/ttyS0</filename>. &product-name; will then
2123 simply redirect all data received from and sent to the
2124 virtual serial port to the physical device.
2125 </para>
2126 </listitem>
2127
2128 <listitem>
2129 <para>
2130 <emphasis role="bold">Host Pipe:</emphasis> Configure
2131 &product-name; to connect the virtual serial port to a
2132 software pipe on the host. This depends on your host OS,
2133 as follows:
2134 </para>
2135
2136 <itemizedlist>
2137
2138 <listitem>
2139 <para>
2140 On a Windows host, data will be sent and received
2141 through a named pipe. The pipe name must be in the
2142 format
2143 <filename>\\.\pipe\<replaceable>name</replaceable></filename>
2144 where <replaceable>name</replaceable> should identify
2145 the virtual machine but may be freely chosen.
2146 </para>
2147 </listitem>
2148
2149 <listitem>
2150 <para>
2151 On a Mac OS, Linux, or Oracle Solaris host, a local
2152 domain socket is used instead. The socket filename
2153 must be chosen such that the user running
2154 &product-name; has sufficient privileges to create and
2155 write to it. The <filename>/tmp</filename> directory
2156 is often a good candidate.
2157 </para>
2158
2159 <para>
2160 On Linux there are various tools which can connect to
2161 a local domain socket or create one in server mode.
2162 The most flexible tool is <command>socat</command> and
2163 is available as part of many distributions.
2164 </para>
2165 </listitem>
2166
2167 </itemizedlist>
2168
2169 <para>
2170 In this case, you can configure whether &product-name;
2171 should create the named pipe, or the local domain socket
2172 non-Windows hosts, itself or whether &product-name; should
2173 assume that the pipe or socket exists already. With the
2174 <command>VBoxManage</command> command-line options, this
2175 is referred to as server mode or client mode,
2176 respectively.
2177 </para>
2178
2179 <para>
2180 For a direct connection between two virtual machines,
2181 corresponding to a null-modem cable, simply configure one
2182 VM to create a pipe or socket and another to attach to it.
2183 </para>
2184 </listitem>
2185
2186 <listitem>
2187 <para>
2188 <emphasis role="bold">Raw File:</emphasis> Send the
2189 virtual serial port output to a file. This option is very
2190 useful for capturing diagnostic output from a guest. Any
2191 file may be used for this purpose, as long as the user
2192 running &product-name; has sufficient privileges to create
2193 and write to the file.
2194 </para>
2195 </listitem>
2196
2197 <listitem>
2198 <para>
2199 <emphasis role="bold">TCP Socket:</emphasis> Useful for
2200 forwarding serial traffic over TCP/IP, acting as a server,
2201 or it can act as a TCP client connecting to other servers.
2202 This option enables a remote machine to directly connect
2203 to the guest's serial port using TCP.
2204 </para>
2205
2206 <itemizedlist>
2207
2208 <listitem>
2209 <para>
2210 <emphasis role="bold">TCP Server:</emphasis> Deselect
2211 the <emphasis role="bold">Connect to Existing
2212 Pipe/Socket</emphasis> check box and specify the port
2213 number in the
2214 <emphasis role="bold">Path/Address</emphasis> field.
2215 This is typically 23 or 2023. Note that on UNIX-like
2216 systems you will have to use a port a number greater
2217 than 1024 for regular users.
2218 </para>
2219
2220 <para>
2221 The client can use software such as
2222 <command>PuTTY</command> or the
2223 <command>telnet</command> command line tool to access
2224 the TCP Server.
2225 </para>
2226 </listitem>
2227
2228 <listitem>
2229 <para>
2230 <emphasis role="bold">TCP Client:</emphasis> To create
2231 a virtual null-modem cable over the Internet or LAN,
2232 the other side can connect using TCP by specifying
2233 <literal><replaceable>hostname</replaceable>:<replaceable>port</replaceable></literal>
2234 in the <emphasis role="bold">Path/Address</emphasis>
2235 field. The TCP socket will act in client mode if you
2236 select the <emphasis role="bold">Connect to Existing
2237 Pipe/Socket</emphasis> check box.
2238 </para>
2239 </listitem>
2240
2241 </itemizedlist>
2242 </listitem>
2243
2244 </itemizedlist>
2245 </listitem>
2246
2247 </orderedlist>
2248
2249 <para>
2250 Up to four serial ports can be configured per virtual machine, but
2251 you can pick any port numbers out of the above. However, serial
2252 ports cannot reliably share interrupts. If both ports are to be
2253 used at the same time, they must use different interrupt levels,
2254 for example COM1 and COM2, but not COM1 and COM3.
2255 </para>
2256
2257 </sect1>
2258
2259 <sect1 id="usb-support">
2260
2261 <title>USB Support</title>
2262
2263 <sect2 id="settings-usb">
2264
2265 <title>USB Settings</title>
2266
2267 <para>
2268 The <emphasis role="bold">USB</emphasis> section in a virtual
2269 machine's <emphasis role="bold">Settings</emphasis> window
2270 enables you to configure &product-name;'s sophisticated USB
2271 support.
2272 </para>
2273
2274 <para>
2275 &product-name; can enable virtual machines to access the USB
2276 devices on your host directly. To achieve this, &product-name;
2277 presents the guest OS with a virtual USB controller. As soon as
2278 the guest system starts using a USB device, it will appear as
2279 unavailable on the host.
2280 </para>
2281
2282 <note>
2283 <itemizedlist>
2284
2285 <listitem>
2286 <para>
2287 Be careful with USB devices that are currently in use on
2288 the host. For example, if you allow your guest to connect
2289 to your USB hard disk that is currently mounted on the
2290 host, when the guest is activated, it will be disconnected
2291 from the host without a proper shutdown. This may cause
2292 data loss.
2293 </para>
2294 </listitem>
2295
2296 <listitem>
2297 <para>
2298 Oracle Solaris hosts have a few known limitations
2299 regarding USB support. See <xref linkend="KnownIssues" />.
2300 </para>
2301 </listitem>
2302
2303 </itemizedlist>
2304 </note>
2305
2306 <para>
2307 In addition to allowing a guest access to your local USB
2308 devices, &product-name; even enables your guests to connect to
2309 remote USB devices by use of the VirtualBox Remote Desktop
2310 Extension (VRDE). See <xref linkend="usb-over-rdp" />.
2311 </para>
2312
2313 <para>
2314 To enable USB for a VM, select the <emphasis role="bold">Enable
2315 USB Controller</emphasis> check box. The following settings are
2316 available:
2317 </para>
2318
2319 <itemizedlist>
2320
2321 <listitem>
2322 <para>
2323 <emphasis role="bold">USB Controller:</emphasis> Selects a
2324 controller with the specified level of USB support, as
2325 follows:
2326 </para>
2327
2328 <itemizedlist>
2329
2330 <listitem>
2331 <para>
2332 OHCI for USB 1.1
2333 </para>
2334 </listitem>
2335
2336 <listitem>
2337 <para>
2338 EHCI for USB 2.0. This also enables OHCI.
2339 </para>
2340 </listitem>
2341
2342 <listitem>
2343 <para>
2344 xHCI for USB 3.0. This supports all USB speeds.
2345 </para>
2346 </listitem>
2347
2348 </itemizedlist>
2349
2350 <note>
2351 <para>
2352 The xHCI and EHCI controllers are shipped as an
2353 &product-name; extension package, which must be installed
2354 separately. See <xref linkend="intro-installing" />.
2355 </para>
2356 </note>
2357 </listitem>
2358
2359 <listitem>
2360 <para>
2361 <emphasis role="bold">USB Device Filters:</emphasis> When
2362 USB support is enabled for a VM, you can determine in detail
2363 which devices will be automatically attached to the guest.
2364 For this, you can create filters by specifying certain
2365 properties of the USB device. USB devices with a matching
2366 filter will be automatically passed to the guest once they
2367 are attached to the host. USB devices without a matching
2368 filter can be passed manually to the guest, for example by
2369 using the <emphasis role="bold">Devices</emphasis>,
2370 <emphasis role="bold">USB</emphasis> menu.
2371 </para>
2372
2373 <para>
2374 Clicking on the <emphasis role="bold">+</emphasis> button to
2375 the right of the <emphasis role="bold">USB Device
2376 Filters</emphasis> window creates a new filter. You can give
2377 the filter a name, for later reference, and specify the
2378 filter criteria. The more criteria you specify, the more
2379 precisely devices will be selected. For instance, if you
2380 specify only a vendor ID of 046d, all devices produced by
2381 Logitech will be available to the guest. If you fill in all
2382 fields, on the other hand, the filter will only apply to a
2383 particular device model from a particular vendor, and not
2384 even to other devices of the same type with a different
2385 revision and serial number.
2386 </para>
2387
2388 <para>
2389 In detail, the following criteria are available:
2390 </para>
2391
2392 <itemizedlist>
2393
2394 <listitem>
2395 <para>
2396 <emphasis role="bold">Vendor and Product ID.</emphasis>
2397 With USB, each vendor of USB products carries an
2398 identification number that is unique world-wide, called
2399 the <emphasis>vendor ID</emphasis>. Similarly, each line
2400 of products is assigned a <emphasis>product
2401 ID</emphasis> number. Both numbers are commonly written
2402 in hexadecimal, and a colon separates the vendor from
2403 the product ID. For example,
2404 <literal>046d:c016</literal> stands for Logitech as a
2405 vendor, and the M-UV69a Optical Wheel Mouse product.
2406 </para>
2407
2408 <para>
2409 Alternatively, you can also specify
2410 <emphasis role="bold">Manufacturer</emphasis> and
2411 <emphasis role="bold">Product</emphasis> by name.
2412 </para>
2413
2414 <para>
2415 To list all the USB devices that are connected to your
2416 host machine with their respective vendor IDs and
2417 product IDs, use the following command:
2418 </para>
2419
2420<screen>VBoxManage list usbhost</screen>
2421
2422 <para>
2423 On Windows, you can also see all USB devices that are
2424 attached to your system in the Device Manager. On Linux,
2425 you can use the <command>lsusb</command> command.
2426 </para>
2427 </listitem>
2428
2429 <listitem>
2430 <para>
2431 <emphasis role="bold">Serial Number.</emphasis> While
2432 vendor ID and product ID are quite specific to identify
2433 USB devices, if you have two identical devices of the
2434 same brand and product line, you will also need their
2435 serial numbers to filter them out correctly.
2436 </para>
2437 </listitem>
2438
2439 <listitem>
2440 <para>
2441 <emphasis role="bold">Remote.</emphasis> This setting
2442 specifies whether the device will be local only, remote
2443 only, such as over VRDP, or either.
2444 </para>
2445 </listitem>
2446
2447 </itemizedlist>
2448
2449 <para>
2450 On a Windows host, you will need to unplug and reconnect a
2451 USB device to use it after creating a filter for it.
2452 </para>
2453
2454 <para>
2455 As an example, you could create a new USB filter and specify
2456 a vendor ID of 046d for Logitech, Inc, a manufacturer index
2457 of 1, and "not remote". Then any USB devices on the host
2458 system produced by Logitech, Inc with a manufacturer index
2459 of 1 will be visible to the guest system.
2460 </para>
2461
2462 <para>
2463 Several filters can select a single device. For example, a
2464 filter which selects all Logitech devices, and one which
2465 selects a particular webcam.
2466 </para>
2467
2468 <para>
2469 You can deactivate filters without deleting them by
2470 deselecting the check box next to the filter name.
2471 </para>
2472 </listitem>
2473
2474 </itemizedlist>
2475
2476 </sect2>
2477
2478 <sect2 id="usb-implementation-notes">
2479
2480 <title>Implementation Notes for Windows and Linux Hosts</title>
2481
2482 <para>
2483 On Windows hosts, a kernel mode device driver provides USB proxy
2484 support. It implements both a USB monitor, which enables
2485 &product-name; to capture devices when they are plugged in, and
2486 a USB device driver to claim USB devices for a particular
2487 virtual machine. System reboots are not necessary after
2488 installing the driver. Also, you do not need to replug devices
2489 for &product-name; to claim them.
2490 </para>
2491
2492 <para>
2493 On supported Linux hosts, &product-name; accesses USB devices
2494 through special files in the file system. When &product-name; is
2495 installed, these are made available to all users in the
2496 <literal>vboxusers</literal> system group. In order to be able
2497 to access USB from guest systems, make sure that you are a
2498 member of this group.
2499 </para>
2500
2501 </sect2>
2502
2503 </sect1>
2504
2505 <sect1 id="shared-folders">
2506
2507 <title>Shared Folders</title>
2508
2509 <para>
2510 Shared folders enable you to easily exchange data between a
2511 virtual machine and your host. This feature requires that the
2512 &product-name; Guest Additions be installed in a virtual machine
2513 and is described in detail in <xref linkend="sharedfolders" />.
2514 </para>
2515
2516 </sect1>
2517
2518 <sect1 id="user-interface">
2519
2520 <title>User Interface</title>
2521
2522 <para>
2523 The <emphasis role="bold">User Interface</emphasis> section
2524 enables you to change certain aspects of the user interface of
2525 this VM.
2526 </para>
2527
2528 <itemizedlist>
2529
2530 <listitem>
2531 <para>
2532 <emphasis role="bold">Menu Bar:</emphasis> This widget enables
2533 you to disable menus by clicking on the menu to release it,
2534 menu entries by deselecting the check box of the entry to
2535 disable it and the complete menu bar by deselecting the
2536 rightmost check box.
2537 </para>
2538 </listitem>
2539
2540 <listitem>
2541 <para>
2542 <emphasis role="bold">Mini ToolBar:</emphasis> In full screen
2543 or seamless mode, &product-name; can display a small toolbar
2544 that contains some of the items that are normally available
2545 from the virtual machine's menu bar. This toolbar reduces
2546 itself to a small gray line unless you move the mouse over it.
2547 With the toolbar, you can return from full screen or seamless
2548 mode, control machine execution or enable certain devices. If
2549 you do not want to see the toolbar, disable this setting.
2550 </para>
2551
2552 <para>
2553 The second setting enables you to show the toolbar at the top
2554 of the screen, instead of showing it at the bottom.
2555 </para>
2556 </listitem>
2557
2558 <listitem>
2559 <para>
2560 <emphasis role="bold">Status Bar:</emphasis> This widget
2561 enables you to disable icons on the status bar by deselecting
2562 the check box of an icon to disable it, to rearrange icons by
2563 dragging and dropping the icon, and to disable the complete
2564 status bar by deselecting the leftmost check box.
2565 </para>
2566 </listitem>
2567
2568 </itemizedlist>
2569
2570 </sect1>
2571
2572 <sect1 id="efi">
2573
2574 <title>Alternative Firmware (EFI)</title>
2575
2576 <para>
2577 &product-name; includes experimental support for the Extensible
2578 Firmware Interface (EFI), which is an industry standard intended
2579 to replace the legacy BIOS as the primary interface for
2580 bootstrapping computers and certain system services later.
2581 </para>
2582
2583 <para>
2584 By default, &product-name; uses the BIOS firmware for virtual
2585 machines. To use EFI for a given virtual machine, you can enable
2586 EFI in the machine's <emphasis role="bold">Settings</emphasis>
2587 dialog. See <xref linkend="settings-motherboard"/>. Alternatively,
2588 use the <command>VBoxManage</command> command line interface as
2589 follows:
2590 </para>
2591
2592<screen>VBoxManage modifyvm "VM name" --firmware efi</screen>
2593
2594 <para>
2595 To switch back to using the BIOS:
2596 </para>
2597
2598<screen>VBoxManage modifyvm "VM name" --firmware bios</screen>
2599
2600 <para>
2601 One notable user of EFI is Apple Mac OS X. More recent Linux
2602 versions and Windows releases, starting with Vista, also offer
2603 special versions that can be booted using EFI.
2604 </para>
2605
2606 <para>
2607 Another possible use of EFI in &product-name; is development and
2608 testing of EFI applications, without booting any OS.
2609 </para>
2610
2611 <para>
2612 Note that the &product-name; EFI support is experimental and will
2613 be enhanced as EFI matures and becomes more widespread. Mac OS X,
2614 Linux, and newer Windows guests are known to work fine. Windows 7
2615 guests are unable to boot with the &product-name; EFI
2616 implementation.
2617 </para>
2618
2619 <sect2 id="efividmode">
2620
2621 <title>Video Modes in EFI</title>
2622
2623 <para>
2624 EFI provides two distinct video interfaces: GOP (Graphics Output
2625 Protocol) and UGA (Universal Graphics Adapter). Modern OSes,
2626 such as Mac OS X, generally use GOP, while some older ones still
2627 use UGA. &product-name; provides a configuration option to
2628 control the graphics resolution for both interfaces, making the
2629 difference mostly irrelevant for users.
2630 </para>
2631
2632 <para>
2633 The default resolution is 1024x768. To select a graphics
2634 resolution for EFI, use the following
2635 <command>VBoxManage</command> command:
2636 </para>
2637
2638<screen>VBoxManage setextradata "VM name" VBoxInternal2/EfiGraphicsResolution HxV</screen>
2639
2640 <para>
2641 Determine the horizontal resolution H and the vertical
2642 resolution V from the following list of default resolutions:
2643 </para>
2644
2645 <variablelist>
2646
2647 <varlistentry>
2648 <term>
2649 VGA
2650 </term>
2651
2652 <listitem>
2653 <para>
2654 640x480, 32bpp, 4:3
2655 </para>
2656 </listitem>
2657 </varlistentry>
2658
2659 <varlistentry>
2660 <term>
2661 SVGA
2662 </term>
2663
2664 <listitem>
2665 <para>
2666 800x600, 32bpp, 4:3
2667 </para>
2668 </listitem>
2669 </varlistentry>
2670
2671 <varlistentry>
2672 <term>
2673 XGA
2674 </term>
2675
2676 <listitem>
2677 <para>
2678 1024x768, 32bpp, 4:3
2679 </para>
2680 </listitem>
2681 </varlistentry>
2682
2683 <varlistentry>
2684 <term>
2685 XGA+
2686 </term>
2687
2688 <listitem>
2689 <para>
2690 1152x864, 32bpp, 4:3
2691 </para>
2692 </listitem>
2693 </varlistentry>
2694
2695 <varlistentry>
2696 <term>
2697 HD
2698 </term>
2699
2700 <listitem>
2701 <para>
2702 1280x720, 32bpp, 16:9
2703 </para>
2704 </listitem>
2705 </varlistentry>
2706
2707 <varlistentry>
2708 <term>
2709 WXGA
2710 </term>
2711
2712 <listitem>
2713 <para>
2714 1280x800, 32bpp, 16:10
2715 </para>
2716 </listitem>
2717 </varlistentry>
2718
2719 <varlistentry>
2720 <term>
2721 SXGA
2722 </term>
2723
2724 <listitem>
2725 <para>
2726 1280x1024, 32bpp, 5:4
2727 </para>
2728 </listitem>
2729 </varlistentry>
2730
2731 <varlistentry>
2732 <term>
2733 SXGA+
2734 </term>
2735
2736 <listitem>
2737 <para>
2738 1400x1050, 32bpp, 4:3
2739 </para>
2740 </listitem>
2741 </varlistentry>
2742
2743 <varlistentry>
2744 <term>
2745 WXGA+
2746 </term>
2747
2748 <listitem>
2749 <para>
2750 1440x900, 32bpp, 16:10
2751 </para>
2752 </listitem>
2753 </varlistentry>
2754
2755 <varlistentry>
2756 <term>
2757 HD+
2758 </term>
2759
2760 <listitem>
2761 <para>
2762 1600x900, 32bpp, 16:9
2763 </para>
2764 </listitem>
2765 </varlistentry>
2766
2767 <varlistentry>
2768 <term>
2769 UXGA
2770 </term>
2771
2772 <listitem>
2773 <para>
2774 1600x1200, 32bpp, 4:3
2775 </para>
2776 </listitem>
2777 </varlistentry>
2778
2779 <varlistentry>
2780 <term>
2781 WSXGA+
2782 </term>
2783
2784 <listitem>
2785 <para>
2786 1680x1050, 32bpp, 16:10
2787 </para>
2788 </listitem>
2789 </varlistentry>
2790
2791 <varlistentry>
2792 <term>
2793 Full HD
2794 </term>
2795
2796 <listitem>
2797 <para>
2798 1920x1080, 32bpp, 16:9
2799 </para>
2800 </listitem>
2801 </varlistentry>
2802
2803 <varlistentry>
2804 <term>
2805 WUXGA
2806 </term>
2807
2808 <listitem>
2809 <para>
2810 1920x1200, 32bpp, 16:10
2811 </para>
2812 </listitem>
2813 </varlistentry>
2814
2815 <varlistentry>
2816 <term>
2817 DCI 2K
2818 </term>
2819
2820 <listitem>
2821 <para>
2822 2048x1080, 32bpp, 19:10
2823 </para>
2824 </listitem>
2825 </varlistentry>
2826
2827 <varlistentry>
2828 <term>
2829 Full HD+
2830 </term>
2831
2832 <listitem>
2833 <para>
2834 2160x1440, 32bpp, 3:2
2835 </para>
2836 </listitem>
2837 </varlistentry>
2838
2839 <varlistentry>
2840 <term>
2841 Unnamed
2842 </term>
2843
2844 <listitem>
2845 <para>
2846 2304x1440, 32bpp, 16:10
2847 </para>
2848 </listitem>
2849 </varlistentry>
2850
2851 <varlistentry>
2852 <term>
2853 QHD
2854 </term>
2855
2856 <listitem>
2857 <para>
2858 2560x1440, 32bpp, 16:9
2859 </para>
2860 </listitem>
2861 </varlistentry>
2862
2863 <varlistentry>
2864 <term>
2865 WQXGA
2866 </term>
2867
2868 <listitem>
2869 <para>
2870 2560x1600, 32bpp, 16:10
2871 </para>
2872 </listitem>
2873 </varlistentry>
2874
2875 <varlistentry>
2876 <term>
2877 QWXGA+
2878 </term>
2879
2880 <listitem>
2881 <para>
2882 2880x1800, 32bpp, 16:10
2883 </para>
2884 </listitem>
2885 </varlistentry>
2886
2887 <varlistentry>
2888 <term>
2889 QHD+
2890 </term>
2891
2892 <listitem>
2893 <para>
2894 3200x1800, 32bpp, 16:9
2895 </para>
2896 </listitem>
2897 </varlistentry>
2898
2899 <varlistentry>
2900 <term>
2901 WQSXGA
2902 </term>
2903
2904 <listitem>
2905 <para>
2906 3200x2048, 32bpp, 16:10
2907 </para>
2908 </listitem>
2909 </varlistentry>
2910
2911 <varlistentry>
2912 <term>
2913 4K UHD
2914 </term>
2915
2916 <listitem>
2917 <para>
2918 3840x2160, 32bpp, 16:9
2919 </para>
2920 </listitem>
2921 </varlistentry>
2922
2923 <varlistentry>
2924 <term>
2925 WQUXGA
2926 </term>
2927
2928 <listitem>
2929 <para>
2930 3840x2400, 32bpp, 16:10
2931 </para>
2932 </listitem>
2933 </varlistentry>
2934
2935 <varlistentry>
2936 <term>
2937 DCI 4K
2938 </term>
2939
2940 <listitem>
2941 <para>
2942 4096x2160, 32bpp, 19:10
2943 </para>
2944 </listitem>
2945 </varlistentry>
2946
2947 <varlistentry>
2948 <term>
2949 HXGA
2950 </term>
2951
2952 <listitem>
2953 <para>
2954 4096x3072, 32bpp, 4:3
2955 </para>
2956 </listitem>
2957 </varlistentry>
2958
2959 <varlistentry>
2960 <term>
2961 UHD+
2962 </term>
2963
2964 <listitem>
2965 <para>
2966 5120x2880, 32bpp, 16:9
2967 </para>
2968 </listitem>
2969 </varlistentry>
2970
2971 <varlistentry>
2972 <term>
2973 WHXGA
2974 </term>
2975
2976 <listitem>
2977 <para>
2978 5120x3200, 32bpp, 16:10
2979 </para>
2980 </listitem>
2981 </varlistentry>
2982
2983 <varlistentry>
2984 <term>
2985 WHSXGA
2986 </term>
2987
2988 <listitem>
2989 <para>
2990 6400x4096, 32bpp, 16:10
2991 </para>
2992 </listitem>
2993 </varlistentry>
2994
2995 <varlistentry>
2996 <term>
2997 HUXGA
2998 </term>
2999
3000 <listitem>
3001 <para>
3002 6400x4800, 32bpp, 4:3
3003 </para>
3004 </listitem>
3005 </varlistentry>
3006
3007 <varlistentry>
3008 <term>
3009 8K UHD2
3010 </term>
3011
3012 <listitem>
3013 <para>
3014 7680x4320, 32bpp, 16:9
3015 </para>
3016 </listitem>
3017 </varlistentry>
3018
3019 </variablelist>
3020
3021 <para>
3022 If this list of default resolution does not cover your needs,
3023 see <xref linkend="customvesa" />. Note that the color depth
3024 value specified in a custom video mode must be specified. Color
3025 depths of 8, 16, 24, and 32 are accepted. EFI assumes a color
3026 depth of 32 by default.
3027 </para>
3028
3029 <para>
3030 The EFI default video resolution settings can only be changed
3031 when the VM is powered off.
3032 </para>
3033
3034 </sect2>
3035
3036 <sect2 id="efibootargs">
3037
3038 <title>Specifying Boot Arguments</title>
3039
3040 <para>
3041 It is currently not possible to manipulate EFI variables from
3042 within a running guest. For example, setting the
3043 <literal>boot-args</literal> variable by running the
3044 <command>nvram</command> tool in a Mac OS X guest will not work.
3045 As an alternative method,
3046 <literal>VBoxInternal2/EfiBootArgs</literal> extradata can be
3047 passed to a VM in order to set the <literal>boot-args</literal>
3048 variable. To change the <literal>boot-args</literal> EFI
3049 variable, use the following command:
3050 </para>
3051
3052<screen>VBoxManage setextradata "VM name" VBoxInternal2/EfiBootArgs &lt;value&gt;</screen>
3053
3054 </sect2>
3055
3056 </sect1>
3057
3058</chapter>
Note: See TracBrowser for help on using the repository browser.

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