VirtualBox

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

Last change on this file since 86692 was 82350, checked in by vboxsync, 5 years ago

manual: integrate 6.1 drop #10 with minimal manual adjustments (frontmatter for preface and eliminated trailing whitespace)

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