VirtualBox

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

Last change on this file since 98108 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

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