From 4035b1bfb1e5843a539a8b624d21952b756974d1 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 16:19:18 +0200 Subject: Adding upstream version 6.1.22-dfsg. Signed-off-by: Daniel Baumann --- doc/manual/en_US/.scm-settings | 21 + doc/manual/en_US/Accessibility.xml | 229 + doc/manual/en_US/Makefile.kup | 0 doc/manual/en_US/SDKRef.xml | 6252 ++++++++++++++ doc/manual/en_US/UserManual.xml | 90 + doc/manual/en_US/images/clone-vm.png | Bin 0 -> 59209 bytes doc/manual/en_US/images/cloud-profile-manager.png | Bin 0 -> 48730 bytes doc/manual/en_US/images/create-vdi-1.png | Bin 0 -> 53859 bytes doc/manual/en_US/images/create-vm-1.png | Bin 0 -> 61947 bytes doc/manual/en_US/images/create-vm-2.png | Bin 0 -> 58000 bytes doc/manual/en_US/images/dnd-modes.png | Bin 0 -> 19004 bytes doc/manual/en_US/images/export-appliance-oci.png | Bin 0 -> 214590 bytes doc/manual/en_US/images/guest-fm.png | Bin 0 -> 84517 bytes doc/manual/en_US/images/import-instance.png | Bin 0 -> 154751 bytes doc/manual/en_US/images/newcloudvm.png | Bin 0 -> 126865 bytes doc/manual/en_US/images/ovf-import.png | Bin 0 -> 91671 bytes doc/manual/en_US/images/seamless.png | Bin 0 -> 603665 bytes doc/manual/en_US/images/snapshots-1.png | Bin 0 -> 11768 bytes doc/manual/en_US/images/softkeybd.png | Bin 0 -> 90286 bytes doc/manual/en_US/images/upload-key.png | Bin 0 -> 37716 bytes doc/manual/en_US/images/vbox-components.png | Bin 0 -> 61668 bytes doc/manual/en_US/images/vbox-sdl.png | Bin 0 -> 865462 bytes doc/manual/en_US/images/vboxlogo.png | Bin 0 -> 57874 bytes doc/manual/en_US/images/virtual-disk-manager.png | Bin 0 -> 46245 bytes doc/manual/en_US/images/virtual-disk-manager2.png | Bin 0 -> 19565 bytes doc/manual/en_US/images/virtualbox-main-empty.png | Bin 0 -> 67366 bytes doc/manual/en_US/images/virtualbox-main.png | Bin 0 -> 411734 bytes doc/manual/en_US/images/vm-close.png | Bin 0 -> 6558 bytes doc/manual/en_US/images/vm-groups.png | Bin 0 -> 97888 bytes doc/manual/en_US/images/vm-hostkey.png | Bin 0 -> 1977 bytes doc/manual/en_US/images/vm-settings-harddisk.png | Bin 0 -> 37864 bytes doc/manual/en_US/images/vm-vista-running.png | Bin 0 -> 522810 bytes doc/manual/en_US/man_VBoxHeadless.xml | 228 + doc/manual/en_US/man_VBoxManage-adoptstate.xml | 99 + doc/manual/en_US/man_VBoxManage-bandwidthctl.xml | 296 + doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml | 102 + doc/manual/en_US/man_VBoxManage-clonemedium.xml | 203 + doc/manual/en_US/man_VBoxManage-clonevm.xml | 263 + doc/manual/en_US/man_VBoxManage-closemedium.xml | 108 + doc/manual/en_US/man_VBoxManage-cloud.xml | 623 ++ doc/manual/en_US/man_VBoxManage-cloudimage.xml | 229 + doc/manual/en_US/man_VBoxManage-cloudinstance.xml | 212 + doc/manual/en_US/man_VBoxManage-cloudlist.xml | 130 + doc/manual/en_US/man_VBoxManage-cloudprofile.xml | 176 + doc/manual/en_US/man_VBoxManage-controlvm.xml | 2081 +++++ doc/manual/en_US/man_VBoxManage-convertfromraw.xml | 239 + doc/manual/en_US/man_VBoxManage-createmedium.xml | 180 + doc/manual/en_US/man_VBoxManage-createvm.xml | 163 + doc/manual/en_US/man_VBoxManage-debugvm.xml | 615 ++ .../man_VBoxManage-dhcpserver-dhcpoptions.xml | 221 + .../man_VBoxManage-dhcpserver-dhcpoptions.xsl | 114 + doc/manual/en_US/man_VBoxManage-dhcpserver.xml | 564 ++ doc/manual/en_US/man_VBoxManage-discardstate.xml | 91 + doc/manual/en_US/man_VBoxManage-encryptmedium.xml | 163 + doc/manual/en_US/man_VBoxManage-export.xml | 436 + doc/manual/en_US/man_VBoxManage-extpack.xml | 144 + doc/manual/en_US/man_VBoxManage-getextradata.xml | 141 + doc/manual/en_US/man_VBoxManage-guestcontrol.xml | 1319 +++ doc/manual/en_US/man_VBoxManage-guestproperty.xml | 325 + doc/manual/en_US/man_VBoxManage-hostonlyif.xml | 190 + doc/manual/en_US/man_VBoxManage-import.xml | 218 + doc/manual/en_US/man_VBoxManage-list.xml | 523 ++ doc/manual/en_US/man_VBoxManage-mediumio.xml | 164 + doc/manual/en_US/man_VBoxManage-mediumproperty.xml | 209 + doc/manual/en_US/man_VBoxManage-metrics.xml | 414 + doc/manual/en_US/man_VBoxManage-modifymedium.xml | 245 + doc/manual/en_US/man_VBoxManage-modifyvm.xml | 2484 ++++++ doc/manual/en_US/man_VBoxManage-movevm.xml | 97 + doc/manual/en_US/man_VBoxManage-natnetwork.xml | 360 + doc/manual/en_US/man_VBoxManage-registervm.xml | 92 + doc/manual/en_US/man_VBoxManage-setextradata.xml | 112 + doc/manual/en_US/man_VBoxManage-setproperty.xml | 208 + doc/manual/en_US/man_VBoxManage-sharedfolder.xml | 201 + doc/manual/en_US/man_VBoxManage-showmediuminfo.xml | 131 + doc/manual/en_US/man_VBoxManage-showvminfo.xml | 177 + doc/manual/en_US/man_VBoxManage-snapshot.xml | 392 + doc/manual/en_US/man_VBoxManage-startvm.xml | 162 + doc/manual/en_US/man_VBoxManage-storageattach.xml | 538 ++ doc/manual/en_US/man_VBoxManage-storagectl.xml | 194 + doc/manual/en_US/man_VBoxManage-unattended.xml | 242 + doc/manual/en_US/man_VBoxManage-unregistervm.xml | 112 + doc/manual/en_US/man_VBoxManage-usbdevsource.xml | 118 + doc/manual/en_US/man_VBoxManage-usbfilter.xml | 304 + doc/manual/en_US/man_VBoxManage.xml | 262 + doc/manual/en_US/man_vboximg-mount.xml | 398 + doc/manual/en_US/oracle-accessibility-en.xml | 27 + doc/manual/en_US/oracle-diversity.xml | 13 + doc/manual/en_US/oracle-support-en.xml | 23 + doc/manual/en_US/user_AdvancedTopics.xml | 7403 ++++++++++++++++ doc/manual/en_US/user_BasicConcepts.xml | 3037 +++++++ doc/manual/en_US/user_ChangeLog.xml | 48 + doc/manual/en_US/user_Frontends.xml | 1210 +++ doc/manual/en_US/user_Glossary.xml | 700 ++ doc/manual/en_US/user_GuestAdditions.xml | 2478 ++++++ doc/manual/en_US/user_Installation.xml | 1405 +++ doc/manual/en_US/user_Introduction.xml | 4801 +++++++++++ doc/manual/en_US/user_KnownIssues.xml | 464 + doc/manual/en_US/user_Networking.xml | 1562 ++++ doc/manual/en_US/user_Preface.xml | 93 + doc/manual/en_US/user_PrivacyPolicy.xml | 93 + doc/manual/en_US/user_Security.xml | 729 ++ doc/manual/en_US/user_Storage.xml | 1800 ++++ doc/manual/en_US/user_Technical.xml | 941 ++ doc/manual/en_US/user_ThirdParty.xml | 4813 +++++++++++ doc/manual/en_US/user_Troubleshooting.xml | 1872 ++++ doc/manual/en_US/user_VBoxManage.xml | 8969 ++++++++++++++++++++ doc/manual/en_US/user_VirtualBoxAPI.xml | 37 + 107 files changed, 67122 insertions(+) create mode 100644 doc/manual/en_US/.scm-settings create mode 100644 doc/manual/en_US/Accessibility.xml create mode 100644 doc/manual/en_US/Makefile.kup create mode 100644 doc/manual/en_US/SDKRef.xml create mode 100644 doc/manual/en_US/UserManual.xml create mode 100644 doc/manual/en_US/images/clone-vm.png create mode 100644 doc/manual/en_US/images/cloud-profile-manager.png create mode 100644 doc/manual/en_US/images/create-vdi-1.png create mode 100644 doc/manual/en_US/images/create-vm-1.png create mode 100644 doc/manual/en_US/images/create-vm-2.png create mode 100644 doc/manual/en_US/images/dnd-modes.png create mode 100644 doc/manual/en_US/images/export-appliance-oci.png create mode 100644 doc/manual/en_US/images/guest-fm.png create mode 100644 doc/manual/en_US/images/import-instance.png create mode 100644 doc/manual/en_US/images/newcloudvm.png create mode 100644 doc/manual/en_US/images/ovf-import.png create mode 100644 doc/manual/en_US/images/seamless.png create mode 100644 doc/manual/en_US/images/snapshots-1.png create mode 100644 doc/manual/en_US/images/softkeybd.png create mode 100644 doc/manual/en_US/images/upload-key.png create mode 100644 doc/manual/en_US/images/vbox-components.png create mode 100644 doc/manual/en_US/images/vbox-sdl.png create mode 100644 doc/manual/en_US/images/vboxlogo.png create mode 100644 doc/manual/en_US/images/virtual-disk-manager.png create mode 100644 doc/manual/en_US/images/virtual-disk-manager2.png create mode 100644 doc/manual/en_US/images/virtualbox-main-empty.png create mode 100644 doc/manual/en_US/images/virtualbox-main.png create mode 100644 doc/manual/en_US/images/vm-close.png create mode 100644 doc/manual/en_US/images/vm-groups.png create mode 100644 doc/manual/en_US/images/vm-hostkey.png create mode 100644 doc/manual/en_US/images/vm-settings-harddisk.png create mode 100644 doc/manual/en_US/images/vm-vista-running.png create mode 100644 doc/manual/en_US/man_VBoxHeadless.xml create mode 100644 doc/manual/en_US/man_VBoxManage-adoptstate.xml create mode 100644 doc/manual/en_US/man_VBoxManage-bandwidthctl.xml create mode 100644 doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml create mode 100644 doc/manual/en_US/man_VBoxManage-clonemedium.xml create mode 100644 doc/manual/en_US/man_VBoxManage-clonevm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-closemedium.xml create mode 100644 doc/manual/en_US/man_VBoxManage-cloud.xml create mode 100644 doc/manual/en_US/man_VBoxManage-cloudimage.xml create mode 100644 doc/manual/en_US/man_VBoxManage-cloudinstance.xml create mode 100644 doc/manual/en_US/man_VBoxManage-cloudlist.xml create mode 100644 doc/manual/en_US/man_VBoxManage-cloudprofile.xml create mode 100644 doc/manual/en_US/man_VBoxManage-controlvm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-convertfromraw.xml create mode 100644 doc/manual/en_US/man_VBoxManage-createmedium.xml create mode 100644 doc/manual/en_US/man_VBoxManage-createvm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-debugvm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml create mode 100644 doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl create mode 100644 doc/manual/en_US/man_VBoxManage-dhcpserver.xml create mode 100644 doc/manual/en_US/man_VBoxManage-discardstate.xml create mode 100644 doc/manual/en_US/man_VBoxManage-encryptmedium.xml create mode 100644 doc/manual/en_US/man_VBoxManage-export.xml create mode 100644 doc/manual/en_US/man_VBoxManage-extpack.xml create mode 100644 doc/manual/en_US/man_VBoxManage-getextradata.xml create mode 100644 doc/manual/en_US/man_VBoxManage-guestcontrol.xml create mode 100644 doc/manual/en_US/man_VBoxManage-guestproperty.xml create mode 100644 doc/manual/en_US/man_VBoxManage-hostonlyif.xml create mode 100644 doc/manual/en_US/man_VBoxManage-import.xml create mode 100644 doc/manual/en_US/man_VBoxManage-list.xml create mode 100644 doc/manual/en_US/man_VBoxManage-mediumio.xml create mode 100644 doc/manual/en_US/man_VBoxManage-mediumproperty.xml create mode 100644 doc/manual/en_US/man_VBoxManage-metrics.xml create mode 100644 doc/manual/en_US/man_VBoxManage-modifymedium.xml create mode 100644 doc/manual/en_US/man_VBoxManage-modifyvm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-movevm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-natnetwork.xml create mode 100644 doc/manual/en_US/man_VBoxManage-registervm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-setextradata.xml create mode 100644 doc/manual/en_US/man_VBoxManage-setproperty.xml create mode 100644 doc/manual/en_US/man_VBoxManage-sharedfolder.xml create mode 100644 doc/manual/en_US/man_VBoxManage-showmediuminfo.xml create mode 100644 doc/manual/en_US/man_VBoxManage-showvminfo.xml create mode 100644 doc/manual/en_US/man_VBoxManage-snapshot.xml create mode 100644 doc/manual/en_US/man_VBoxManage-startvm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-storageattach.xml create mode 100644 doc/manual/en_US/man_VBoxManage-storagectl.xml create mode 100644 doc/manual/en_US/man_VBoxManage-unattended.xml create mode 100644 doc/manual/en_US/man_VBoxManage-unregistervm.xml create mode 100644 doc/manual/en_US/man_VBoxManage-usbdevsource.xml create mode 100644 doc/manual/en_US/man_VBoxManage-usbfilter.xml create mode 100644 doc/manual/en_US/man_VBoxManage.xml create mode 100644 doc/manual/en_US/man_vboximg-mount.xml create mode 100644 doc/manual/en_US/oracle-accessibility-en.xml create mode 100644 doc/manual/en_US/oracle-diversity.xml create mode 100644 doc/manual/en_US/oracle-support-en.xml create mode 100644 doc/manual/en_US/user_AdvancedTopics.xml create mode 100644 doc/manual/en_US/user_BasicConcepts.xml create mode 100644 doc/manual/en_US/user_ChangeLog.xml create mode 100644 doc/manual/en_US/user_Frontends.xml create mode 100644 doc/manual/en_US/user_Glossary.xml create mode 100644 doc/manual/en_US/user_GuestAdditions.xml create mode 100644 doc/manual/en_US/user_Installation.xml create mode 100644 doc/manual/en_US/user_Introduction.xml create mode 100644 doc/manual/en_US/user_KnownIssues.xml create mode 100644 doc/manual/en_US/user_Networking.xml create mode 100644 doc/manual/en_US/user_Preface.xml create mode 100644 doc/manual/en_US/user_PrivacyPolicy.xml create mode 100644 doc/manual/en_US/user_Security.xml create mode 100644 doc/manual/en_US/user_Storage.xml create mode 100644 doc/manual/en_US/user_Technical.xml create mode 100644 doc/manual/en_US/user_ThirdParty.xml create mode 100644 doc/manual/en_US/user_Troubleshooting.xml create mode 100644 doc/manual/en_US/user_VBoxManage.xml create mode 100644 doc/manual/en_US/user_VirtualBoxAPI.xml (limited to 'doc/manual/en_US') diff --git a/doc/manual/en_US/.scm-settings b/doc/manual/en_US/.scm-settings new file mode 100644 index 00000000..59a06b6b --- /dev/null +++ b/doc/manual/en_US/.scm-settings @@ -0,0 +1,21 @@ +# $Id: .scm-settings $ +## @file +# Source code massager settings for the manual. +# + +# +# Copyright (C) 2010-2020 Oracle Corporation +# +# This file is part of VirtualBox Open Source Edition (OSE), as +# available from http://www.virtualbox.org. This file is free software; +# you can redistribute it and/or modify it under the terms of the GNU +# General Public License (GPL) as published by the Free Software +# Foundation, in version 2 as it comes in the "COPYING" file of the +# VirtualBox OSE distribution. VirtualBox OSE is distributed in the +# hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. +# + + +/oracle-accessibility-en.xml: --external-copyright --no-strip-trailing-blanks +/oracle-support-en.xml: --external-copyright --no-strip-trailing-blanks + diff --git a/doc/manual/en_US/Accessibility.xml b/doc/manual/en_US/Accessibility.xml new file mode 100644 index 00000000..2c6efe9a --- /dev/null +++ b/doc/manual/en_US/Accessibility.xml @@ -0,0 +1,229 @@ + + +%all.entities; +]> + + + + &VBOX_PRODUCT; + + Accessibility Reference + + Version &VBOX_VERSION_STRING; + + &VBOX_VENDOR; + +
https://www.virtualbox.org
+ + + 2016-&VBOX_C_YEAR; + + &VBOX_VENDOR; + + + + + Introduction + + Welcome to the VirtualBox Accessibility Support documentation! This document is primarily + a reference to help people who are interested in our project accessibility support and will describe how to use VirtualBox + user interface step-by-step. Since whole the application navigation will be explained here, this document will also be + helpful for those who are not familiar with our product user interface and wish to learn more. It will be written in a bit + excessive manner so that many obvious things will be explained too precisely to make it easier to understand by ear for a + blind users. The document will be periodically updated with recent changes and test-cases allowing us to more strictly + follow the required guidelines and make our product fully accessible. + + + Our application is based on Qt5, a powerful cross-platform library which allows to visualize various user interface ideas + the most flexible and native way. This also means that the library we use is responsible for many navigation and + accessibility aspects (like fonts, size hints, colors, look&feel patterns and many other things), but not for all of + them. Nativity as one of the main ideas of the Qt-based application sometimes brings additional complexity because there is + always at least one host which uses unique combination of fonts and colors which breaks accessibility support in an + unpredictable way. + + + Independently on platform we are supporting screen-reader applications which can communicate with Qt5 accessibility + interface which supports Microsoft Active Accessibility (MSAA), OS X Accessibility, and the Unix/X11 AT-SPI standard. + + + Our application user interface is able to be started in two modes: + + + + First of them is VirtualBox Manager user interface, the main application window + which allows to manage and configure virtual machines and their groups. Besides that, this window provides user with + access to various global and machine related tools allowing to administrate some of VirtualBox objects and their + settings. + + + + + Second application mode is Virtual Machine user interface, which allows to control + virtual machine guest screens as separate application windows. Besides that, this interface allows to access some of + machine tools and adjust guest screens up to your needs, by changing their resolution and toggling full-screen, + seamless and scaled modes. + + + + But first of all we should start from the General Concept which is related to whole the + GUI and summarizes the navigation and accessibility aspects we are using for whole application. + + + + + General concept + + This chapter describes the general navigation and accessibility concept. We should note that not every detail of this + concept is already implemented and not every widget in our project already follows that concept. There is still large work + to be done in that regard. But in the end whole the project should correspond to this concept. + + + In short, every application window of our project should be navigated using the following approaches: + + Mouse Navigation + Keyboard Navigation + Screen-reader Navigation + + + + Mouse Navigation + + + + Each interactable widget can be focused with mouse (if that is not restricted by underlying host OS). + + + + + Each hovered interactable widget causes own tool-tip to appear. + + + + + Each tool-tip is given either in imperative mood (ex. "Create new virtual machine") or in short form (ex. "New"). + + + + + Short tool-tip form is only used if context is obvious for a user. + + + + + Tool-tip can contain shortcut mentioned in parentheses. + + + + + Each hovered menu bar / toolbar action causes own status-tip to appear (if window have status-bar). + + + + + Each status-tip is given in imperative mood only. + + + + + TBD... + + + + + + Keyboard Navigation + + + + Each interactable widget can be focused with keyboard (if that is not restricted by underlying host OS). + + + + + Focusing is possible through tabbing or mnemonic navigation. + + + + + Each button and menu bar / toolbar action can be directly activated with keyboard. + + + + + Activation is possible via shortcut or mnemonic. + + + + + Each shortcut is configurable through application preferences. + + + + + Mnemonic mentioned above is underlined alphanumeric character which is a part of widget label (if widget has label). + Mnemonic being triggered in conjunction with the Alt key. + + + + + Each mnemonic is unique within the visible part of current application window, there are no collisions. + + + + + TBD... + + + + + + Screen-reader Navigation + + + + Each interactable widget can be focused with screen-reader cursor. + + + + + Each focused widget have clear name (or full description) in native user language. + + + + + Each button and menu bar / toolbar action can be directly activated through the screen-reader cursor functionality. + + + + + Each complex widget which has children (like list, tree, table and similar) is represented as closed group which + encapsulates it's children clearly. + + + + + While navigating user is able to skip any group without forcing to be entered inside. + + + + + Each group child can be a group itself with the same rules as above applicable. + + + + + Each text-field can be directly edited through the screen-reader cursor functionality. + + + + + TBD... + + + + + + + diff --git a/doc/manual/en_US/Makefile.kup b/doc/manual/en_US/Makefile.kup new file mode 100644 index 00000000..e69de29b diff --git a/doc/manual/en_US/SDKRef.xml b/doc/manual/en_US/SDKRef.xml new file mode 100644 index 00000000..d4a221b9 --- /dev/null +++ b/doc/manual/en_US/SDKRef.xml @@ -0,0 +1,6252 @@ + + +%all.entities; +]> + + + + &VBOX_PRODUCT; + + Programming Guide and Reference + + Version &VBOX_VERSION_STRING; + + &VBOX_VENDOR; + +
http://www.virtualbox.org
+ + + 2004-&VBOX_C_YEAR; + + &VBOX_VENDOR; + + + + + Introduction + + VirtualBox comes with comprehensive support for third-party + developers. This Software Development Kit (SDK) contains all the + documentation and interface files that are needed to write code that + interacts with VirtualBox. + + + Modularity: the building blocks of VirtualBox + + VirtualBox is cleanly separated into several layers, which can be + visualized like in the picture below: + + + + + + + + The orange area represents code that runs in kernel mode, the blue + area represents userspace code. + + At the bottom of the stack resides the hypervisor -- the core of + the virtualization engine, controlling execution of the virtual machines + and making sure they do not conflict with each other or whatever the + host computer is doing otherwise. + + On top of the hypervisor, additional internal modules provide + extra functionality. For example, the RDP server, which can deliver the + graphical output of a VM remotely to an RDP client, is a separate module + that is only loosely tacked into the virtual graphics device. Live + Migration and Resource Monitor are additional modules currently in the + process of being added to VirtualBox. + + What is primarily of interest for purposes of the SDK is the API + layer block that sits on top of all the previously mentioned blocks. + This API, which we call the "Main API", + exposes the entire feature set of the virtualization engine below. It is + completely documented in this SDK Reference -- see and -- and + available to anyone who wishes to control VirtualBox programmatically. + We chose the name "Main API" to differentiate it from other programming + interfaces of VirtualBox that may be publicly accessible. + + With the Main API, you can create, configure, start, stop and + delete virtual machines, retrieve performance statistics about running + VMs, configure the VirtualBox installation in general, and more. In + fact, internally, the front-end programs + VirtualBox and + VBoxManage use nothing but this API as + well -- there are no hidden backdoors into the virtualization engine for + our own front-ends. This ensures the entire Main API is both + well-documented and well-tested. (The same applies to + VBoxHeadless, which is not shown in the + image.) + + + + Two guises of the same "Main API": the web service or + COM/XPCOM + + There are several ways in which the Main API can be called by + other code: + + VirtualBox comes with a web + service that maps nearly the entire Main API. The web + service ships in a stand-alone executable + (vboxwebsrv) that, when running, + acts as an HTTP server, accepts SOAP connections and processes + them. + + Since the entire web service API is publicly described in a + web service description file (in WSDL format), you can write + client programs that call the web service in any language with a + toolkit that understands WSDL. These days, that includes most + programming languages that are available: Java, C++, .NET, PHP, + Python, Perl and probably many more. + + All of this is explained in detail in subsequent chapters of + this book. + + There are two ways in which you can write client code that + uses the web service: + + For Java as well as Python, the SDK contains + easy-to-use classes that allow you to use the web service in + an object-oriented, straightforward manner. We shall refer + to this as the "object-oriented web + service (OOWS)". + + The OO bindings for Java are described in , those for Python in . + + + + Alternatively, you can use the web service directly, + without the object-oriented client layer. We shall refer to + this as the "raw web + service". + + You will then have neither native object orientation + nor full type safety, since web services are neither + object-oriented nor stateful. However, in this way, you can + write client code even in languages for which we do not ship + object-oriented client code; all you need is a programming + language with a toolkit that can parse WSDL and generate + client wrapper code from it. + + We describe this further in , with samples for Java and + Perl. + + + + + + Internally, for portability and easier maintenance, the Main + API is implemented using the Component + Object Model (COM), an interprocess mechanism for + software components originally introduced by Microsoft for + Microsoft Windows. On a Windows host, VirtualBox will use + Microsoft COM; on other hosts where COM is not present, it ships + with XPCOM, a free software implementation of COM originally + created by the Mozilla project for their browsers. + + So, if you are familiar with COM and the C++ programming + language (or with any other programming language that can handle + COM/XPCOM objects, such as Java, Visual Basic or C#), then you can + use the COM/XPCOM API directly. VirtualBox comes with all + necessary files and documentation to build fully functional COM + applications. For an introduction, please see below. + + The VirtualBox front-ends (the graphical user interfaces as + well as the command line), which are all written in C++, use + COM/XPCOM to call the Main API. Technically, the web service is + another front-end to this COM API, mapping almost all of it to + SOAP clients. + + + + If you wonder which way to choose, here are a few + comparisons: + Comparison web service vs. COM/XPCOM + + + + + Web service + + COM/XPCOM + + + + Pro: Easy to use with + Java and Python with the object-oriented web service; + extensive support even with other languages (C++, .NET, PHP, + Perl and others) + + Con: Usable from + languages where COM bridge available (most languages on + Windows platform, Python and C++ on other hosts) + + + + Pro: Client can be on + remote machine + + Con: Client must be on + the same host where virtual machine is executed + + + + Con: Significant + overhead due to XML marshalling over the wire for each method + call + + Pro: Relatively low + invocation overhead + + + +
+ + In the following chapters, we will describe the different ways in + which to program VirtualBox, starting with the method that is easiest to + use and then increase complexity as we go along. + + + + About web services in general + + Web services are a particular type of programming interface. + Whereas, with "normal" programming, a program calls an application + programming interface (API) defined by another program or the operating + system and both sides of the interface have to agree on the calling + convention and, in most cases, use the same programming language, web + services use Internet standards such as HTTP and XML to + communicate. + In some ways, web services promise to deliver the same thing + as CORBA and DCOM did years ago. However, while these previous + technologies relied on specific binary protocols and thus proved to + be difficult to use between diverging platforms, web services + circumvent these incompatibilities by using text-only standards like + HTTP and XML. On the downside (and, one could say, typical of things + related to XML), a lot of standards are involved before a web + service can be implemented. Many of the standards invented around + XML are used one way or another. As a result, web services are slow + and verbose, and the details can be incredibly messy. The relevant + standards here are called SOAP and WSDL, where SOAP describes the + format of the messages that are exchanged (an XML document wrapped + in an HTTP header), and WSDL is an XML format that describes a + complete API provided by a web service. WSDL in turn uses XML Schema + to describe types, which is not exactly terse either. However, as + you will see from the samples provided in this chapter, the + VirtualBox web service shields you from these details and is easy to + use. + + + In order to successfully use a web service, a number of things are + required -- primarily, a web service accepting connections; service + descriptions; and then a client that connects to that web service. The + connections are governed by the SOAP standard, which describes how + messages are to be exchanged between a service and its clients; the + service descriptions are governed by WSDL. + + In the case of VirtualBox, this translates into the following + three components: + + The VirtualBox web service (the "server"): this is the + vboxwebsrv executable shipped + with VirtualBox. Once you start this executable (which acts as a + HTTP server on a specific TCP/IP port), clients can connect to the + web service and thus control a VirtualBox installation. + + + + VirtualBox also comes with WSDL files that describe the + services provided by the web service. You can find these files in + the sdk/bindings/webservice/ + directory. These files are understood by the web service toolkits + that are shipped with most programming languages and enable you to + easily access a web service even if you don't use our + object-oriented client layers. VirtualBox is shipped with + pregenerated web service glue code for several languages (Python, + Perl, Java). + + + + A client that connects to the web service in order to + control the VirtualBox installation. + + Unless you play with some of the samples shipped with + VirtualBox, this needs to be written by you. + + + + + + Running the web service + + The web service ships in an stand-alone executable, + vboxwebsrv, that, when running, acts as + a HTTP server, accepts SOAP connections and processes them -- remotely + or from the same machine. + The web service executable is not contained with the + VirtualBox SDK, but instead ships with the standard VirtualBox + binary package for your specific platform. Since the SDK contains + only platform-independent text files and documentation, the binaries + are instead shipped with the platform-specific packages. For this + reason the information how to run it as a service is included in the + VirtualBox documentation. + + + The vboxwebsrv program, which + implements the web service, is a text-mode (console) program which, + after being started, simply runs until it is interrupted with Ctrl-C or + a kill command. + + Once the web service is started, it acts as a front-end to the + VirtualBox installation of the user account that it is running under. In + other words, if the web service is run under the user account of + user1, it will see and manipulate the + virtual machines and other data represented by the VirtualBox data of + that user (for example, on a Linux machine, under + /home/user1/.config/VirtualBox; see the + VirtualBox User Manual for details on where this data is stored). + + + Command line options of vboxwebsrv + + The web service supports the following command line + options: + + + + --help (or + -h): print a brief summary of + command line options. + + + + --background (or + -b): run the web service as a + background daemon. This option is not supported on Windows + hosts. + + + + --host (or + -H): This specifies the host to + bind to and defaults to "localhost". + + + + --port (or + -p): This specifies which port to + bind to on the host and defaults to 18083. + + + + --ssl (or + -s): This enables SSL + support. + + + + --keyfile (or + -K): This specifies the file name + containing the server private key and the certificate. This is a + mandatory parameter if SSL is enabled. + + + + --passwordfile (or + -a): This specifies the file name + containing the password for the server private key. If unspecified + or an empty string is specified this is interpreted as an empty + password (i.e. the private key is not protected by a password). If + the file name - is specified then + then the password is read from the standard input stream, otherwise + from the specified file. The user is responsible for appropriate + access rights to protect the confidential password. + + + + --cacert (or + -c): This specifies the file name + containing the CA certificate appropriate for the server + certificate. + + + + --capath (or + -C): This specifies the directory + containing several CA certificates appropriate for the server + certificate. + + + + --dhfile (or + -D): This specifies the file name + containing the DH key. Alternatively it can contain the number of + bits of the DH key to generate. If left empty, RSA is used. + + + + --randfile (or + -r): This specifies the file name + containing the seed for the random number generator. If left empty, + an operating system specific source of the seed. + + + + --timeout (or + -t): This specifies the session + timeout, in seconds, and defaults to 300 (five minutes). A web + service client that has logged on but makes no calls to the web + service will automatically be disconnected after the number of + seconds specified here, as if it had called the + IWebSessionManager::logoff() + method provided by the web service itself. + + It is normally vital that each web service client call this + method, as the web service can accumulate large amounts of memory + when running, especially if a web service client does not properly + release managed object references. As a result, this timeout value + should not be set too high, especially on machines with a high + load on the web service, or the web service may eventually deny + service. + + + + --check-interval (or + -i): This specifies the interval + in which the web service checks for timed-out clients, in seconds, + and defaults to 5. This normally does not need to be + changed. + + + + --threads (or + -T): This specifies the maximum + number or worker threads, and defaults to 100. This normally does + not need to be changed. + + + + --keepalive (or + -k): This specifies the maximum + number of requests which can be sent in one web service connection, + and defaults to 100. This normally does not need to be + changed. + + + + --authentication (or + -A): This specifies the desired + web service authentication method. If the parameter is not + specified or the empty string is specified it does not change the + authentication method, otherwise it is set to the specified value. + Using this parameter is a good measure against accidental + misconfiguration, as the web service ensures periodically that it + isn't changed. + + + + --verbose (or + -v): Normally, the web service + outputs only brief messages to the console each time a request is + served. With this option, the web service prints much more detailed + data about every request and the COM methods that those requests + are mapped to internally, which can be useful for debugging client + programs. + + + + --pidfile (or + -P): Name of the PID file which is + created when the daemon was started. + + + + --logfile (or + -F) + <file>: If this is + specified, the web service not only prints its output to the + console, but also writes it to the specified file. The file is + created if it does not exist; if it does exist, new output is + appended to it. This is useful if you run the web service + unattended and need to debug problems after they have + occurred. + + + + --logrotate (or + -R): Number of old log files to + keep, defaults to 10. Log rotation is disabled if set to 0. + + + + --logsize (or + -S): Maximum size of log file in + bytes, defaults to 100MB. Log rotation is triggered if the file + grows beyond this limit. + + + + --loginterval (or + -I): Maximum time interval to be + put in a log file before rotation is triggered, in seconds, and + defaults to one day. + + + + + + Authenticating at web service logon + + As opposed to the COM/XPCOM variant of the Main API, a client + that wants to use the web service must first log on by calling the + IWebsessionManager::logon() + API that is specific to the + web service. Logon is necessary for the web service to be stateful; + internally, it maintains a session for each client that connects to + it. + + The IWebsessionManager::logon() + API takes a user name and a password as arguments, which the web + service then passes to a customizable authentication plugin that + performs the actual authentication. + + For testing purposes, it is recommended that you first disable + authentication with this command: + VBoxManage setproperty websrvauthlibrary null + + + This will cause all logons to succeed, regardless of user + name or password. This should of course not be used in a + production environment. + Generally, the mechanism by which clients are + authenticated is configurable by way of the + VBoxManage command: + + VBoxManage setproperty websrvauthlibrary default|null|<library> + + This way you can specify any shared object/dynamic link module + that conforms with the specifications for VirtualBox external + authentication modules as laid out in section VRDE authentication of the VirtualBox User + Manual; the web service uses the same kind of modules as the + VirtualBox VRDE server. For technical details on VirtualBox external + authentication modules see + + By default, after installation, the web service uses the + VBoxAuth module that ships with VirtualBox. This module uses PAM on + Linux hosts to authenticate users. Any valid username/password + combination is accepted, it does not have to be the username and + password of the user running the web service daemon. Unless + vboxwebsrv runs as root, PAM + authentication can fail, because sometimes the file + /etc/shadow, which is used by PAM, is + not readable. On most Linux distribution PAM uses a suid root helper + internally, so make sure you test this before deploying it. One can + override this behavior by setting the environment variable + VBOX_PAM_ALLOW_INACTIVE which will + suppress failures when unable to read the shadow password file. Please + use this variable carefully, and only if you fully understand what + you're doing. + + + + + + Environment-specific notes + + The Main API described in and + is mostly identical in all the supported + programming environments which have been briefly mentioned in the + introduction of this book. As a result, the Main API's general concepts + described in are the same whether you use the + object-oriented web service (OOWS) for JAX-WS or a raw web service + connection via, say, Perl, or whether you use C++ COM bindings. + + Some things are different depending on your environment, however. + These differences are explained in this chapter. + + + Using the object-oriented web service (OOWS) + + As explained in , VirtualBox + ships with client-side libraries for Java, Python and PHP that allow you + to use the VirtualBox web service in an intuitive, object-oriented way. + These libraries shield you from the client-side complications of managed + object references and other implementation details that come with the + VirtualBox web service. (If you are interested in these complications, + have a look at ). + + We recommend that you start your experiments with the VirtualBox + web service by using our object-oriented client libraries for JAX-WS, a + web service toolkit for Java, which enables you to write code to + interact with VirtualBox in the simplest manner possible. + + As "interfaces", "attributes" and "methods" are COM concepts, + please read the documentation in and + with the following notes in mind. + + The OOWS bindings attempt to map the Main API as closely as + possible to the Java, Python and PHP languages. In other words, objects + are objects, interfaces become classes, and you can call methods on + objects as you would on local objects. + + The main difference remains with attributes: to read an attribute, + call a "getXXX" method, with "XXX" being the attribute name with a + capitalized first letter. So when the Main API Reference says that + IMachine has a "name" attribute (see + IMachine::name), call + getName() on an IMachine object to + obtain a machine's name. Unless the attribute is marked as read-only in + the documentation, there will also be a corresponding "set" + method. + + + The object-oriented web service for JAX-WS + + JAX-WS is a powerful toolkit by Sun Microsystems to build both + server and client code with Java. It is part of Java 6 (JDK 1.6), but + can also be obtained separately for Java 5 (JDK 1.5). The VirtualBox + SDK comes with precompiled OOWS bindings working with both Java 5 and + 6. + + The following sections explain how to get the JAX-WS sample code + running and explain a few common practices when using the JAX-WS + object-oriented web service. + + + Preparations + + Since JAX-WS is already integrated into Java 6, no additional + preparations are needed for Java 6. + + If you are using Java 5 (JDK 1.5.x), you will first need to + download and install an external JAX-WS implementation, as Java 5 + does not support JAX-WS out of the box; for example, you can + download one from here: https://jax-ws.dev.java.net/2.1.4/JAXWS2.1.4-20080502.jar. + Then perform the installation (java -jar + JAXWS2.1.4-20080502.jar). + + + + Getting started: running the sample code + + To run the OOWS for JAX-WS samples that we ship with the SDK, + perform the following steps: + + Open a terminal and change to the directory where the + JAX-WS samples reside. + In + sdk/bindings/glue/java/. + Examine the header of + Makefile to see if the + supplied variables (Java compiler, Java executable) and a few + other details match your system settings. + + + + To start the VirtualBox web service, open a second + terminal and change to the directory where the VirtualBox + executables are located. Then type: + ./vboxwebsrv -v + + The web service now waits for connections and will run + until you press Ctrl+C in this second terminal. The -v + argument causes it to log all connections to the terminal. + (See for details on how + to run the web service.) + + + + Back in the first terminal and still in the samples + directory, to start a simple client example just type: + make run16 + + if you're on a Java 6 system; on a Java 5 system, run + make run15 instead. + + This should work on all Unix-like systems such as Linux + and Solaris. For Windows systems, use commands similar to what + is used in the Makefile. + + This will compile the + clienttest.java code on the + first call and then execute the resulting + clienttest class to show the + locally installed VMs (see below). + + + + The clienttest sample + imitates a few typical command line tasks that + VBoxManage, VirtualBox's regular + command-line front-end, would provide (see the VirtualBox User + Manual for details). In particular, you can run: + + java clienttest show + vms: show the virtual machines that are + registered locally. + + + + java clienttest list + hostinfo: show various information about the + host this VirtualBox installation runs on. + + + + java clienttest startvm + <vmname|uuid>: start the given virtual + machine. + + + + The clienttest.java sample + code illustrates common basic practices how to use the VirtualBox + OOWS for JAX-WS, which we will explain in more detail in the + following chapters. + + + + Logging on to the web service + + Before a web service client can do anything useful, two + objects need to be created, as can be seen in the + clienttest constructor: + + An instance of + IWebsessionManager, + which is an interface provided by the web service to manage + "web sessions" -- that is, stateful connections to the web + service with persistent objects upon which methods can be + invoked. + + In the OOWS for JAX-WS, the IWebsessionManager class + must be constructed explicitly, and a URL must be provided in + the constructor that specifies where the web service (the + server) awaits connections. The code in + clienttest.java connects to + "http://localhost:18083/", which is the default. + + The port number, by default 18083, must match the port + number given to the + vboxwebsrv command line; see + . + + + + After that, the code calls + IWebsessionManager::logon(), + which is the first call that actually communicates with the + server. This authenticates the client with the web service and + returns an instance of + IVirtualBox, + the most fundamental interface of the VirtualBox web service, + from which all other functionality can be derived. + + If logon doesn't work, please take another look at . + + + + + + Object management + + The current OOWS for JAX-WS has certain memory management + related limitations. When you no longer need an object, call its + IManagedObjectRef::release() + method explicitly, which + frees appropriate managed reference, as is required by the raw + web service; see for + details. This limitation may be reconsidered in a future version of + the VirtualBox SDK. + + + + + The object-oriented web service for Python + + VirtualBox comes with two flavors of a Python API: one for web + service, discussed here, and one for the COM/XPCOM API discussed in + . The client code is mostly similar, except + for the initialization part, so it is up to the application developer + to choose the appropriate technology. Moreover, a common Python glue + layer exists, abstracting out concrete platform access details, see + . + + The minimum supported Python version is 2.6. + + As indicated in , the + COM/XPCOM API gives better performance without the SOAP overhead, and + does not require a web server to be running. On the other hand, the + COM/XPCOM Python API requires a suitable Python bridge for your Python + installation (VirtualBox ships the most important ones for each + platform + On On Mac OS X only the Python versions bundled with the OS + are officially supported. This means 2.6 and 2.7 for 10.9 and later. + ). On Windows, you can use the Main API from Python if the + Win32 extensions package for Python + See http://sourceforge.net/project/showfiles.php?group_id=78018. + is installed. Versions of Python Win32 extensions earlier + than 2.16 are known to have bugs, leading to issues with VirtualBox + Python bindings, so please make sure to use latest available Python + and Win32 extensions. + + The VirtualBox OOWS for Python relies on the Python ZSI SOAP + implementation (see http://pywebsvcs.sourceforge.net/zsi.html), + which you will need to install locally before trying the examples. + Most Linux distributions come with package for ZSI, such as + python-zsi in Ubuntu. + + To get started, open a terminal and change to the + bindings/glue/python/sample + directory, which contains an example of a simple interactive shell + able to control a VirtualBox instance. The shell is written using the + API layer, thereby hiding different implementation details, so it is + actually an example of code share among XPCOM, MSCOM and web services. + If you are interested in how to interact with the web services layer + directly, have a look at + install/vboxapi/__init__.py which + contains the glue layer for all target platforms (i.e. XPCOM, MSCOM + and web services). + + To start the shell, perform the following commands: + /opt/VirtualBox/vboxwebsrv -t 0 + # start web service with object autocollection disabled +export VBOX_PROGRAM_PATH=/opt/VirtualBox + # your VirtualBox installation directory +export VBOX_SDK_PATH=/home/youruser/vbox-sdk + # where you've extracted the SDK +./vboxshell.py -w + See for more + details on the shell's functionality. For you, as a VirtualBox + application developer, the vboxshell sample could be interesting as an + example of how to write code targeting both local and remote cases + (COM/XPCOM and SOAP). The common part of the shell is the same -- the + only difference is how it interacts with the invocation layer. You can + use the connect shell command to + connect to remote VirtualBox servers; in this case you can skip + starting the local web server. + + + + The object-oriented web service for PHP + + VirtualBox also comes with object-oriented web service (OOWS) + wrappers for PHP5. These wrappers rely on the PHP SOAP + Extension + See + https://www.php.net/soap. + , which can be installed by configuring PHP with + --enable-soap. + + + + + Using the raw web service with any language + + The following examples show you how to use the raw web service, + without the object-oriented client-side code that was described in the + previous chapter. + + Generally, when reading the documentation in and , due to + the limitations of SOAP and WSDL lined out in , please have the following notes in + mind: + + + + Any COM method call becomes a plain + function call in the raw web service, with the object + as an additional first parameter (before the "real" parameters + listed in the documentation). So when the documentation says that + the IVirtualBox interface + supports the createMachine() + method (see + IVirtualBox::createMachine()), + the web service operation is + IVirtualBox_createMachine(...), + and a managed object reference to an + IVirtualBox object must be passed + as the first argument. + + + + For attributes in + interfaces, there will be at least one "get" function; there will + also be a "set" function, unless the attribute is "readonly". The + attribute name will be appended to the "get" or "set" prefix, with + a capitalized first letter. So, the "version" readonly attribute + of the IVirtualBox interface can + be retrieved by calling + IVirtualBox_getVersion(vbox), + with vbox being the VirtualBox + object. + + + + Whenever the API documentation says that a method (or an + attribute getter) returns an object, it will returned a managed object + reference in the web service instead. As said above, managed + object references should be released if the web service client + does not log off again immediately! + + + + + + + Raw web service example for Java with Axis + + Axis is an older web service toolkit created by the Apache + foundation. If your distribution does not have it installed, you can + get a binary from http://www.apache.org. The + following examples assume that you have Axis 1.4 installed. + + The VirtualBox SDK ships with an example for Axis that, again, + is called clienttest.java and that + imitates a few of the commands of + VBoxManage over the wire. + + Then perform the following steps: + + Create a working directory somewhere. Under your + VirtualBox installation directory, find the + sdk/webservice/samples/java/axis/ + directory and copy the file + clienttest.java to your working + directory. + + + + Open a terminal in your working directory. Execute the + following command: + java org.apache.axis.wsdl.WSDL2Java /path/to/vboxwebService.wsdl + + The vboxwebService.wsdl + file should be located in the + sdk/webservice/ + directory. + + If this fails, your Apache Axis may not be located on your + system classpath, and you may have to adjust the CLASSPATH + environment variable. Something like this: + export CLASSPATH="/path-to-axis-1_4/lib/*":$CLASSPATH + + Use the directory where the Axis JAR files are located. + Mind the quotes so that your shell passes the "*" character to + the java executable without expanding. Alternatively, add a + corresponding -classpath + argument to the "java" call above. + + If the command executes successfully, you should see an + "org" directory with subdirectories containing Java source files + in your working directory. These classes represent the + interfaces that the VirtualBox web service offers, as described + by the WSDL file. + + This is the bit that makes using web services so + attractive to client developers: if a language's toolkit + understands WSDL, it can generate large amounts of support code + automatically. Clients can then easily use this support code and + can be done with just a few lines of code. + + + + Next, compile the + clienttest.java + source:javac clienttest.java + + This should yield a "clienttest.class" file. + + + + To start the VirtualBox web service, open a second + terminal and change to the directory where the VirtualBox + executables are located. Then type: + ./vboxwebsrv -v + + The web service now waits for connections and will run + until you press Ctrl+C in this second terminal. The -v argument + causes it to log all connections to the terminal. (See for details on how to run the + web service.) + + + + Back in the original terminal where you compiled the Java + source, run the resulting binary, which will then connect to the + web service:java clienttest + + The client sample will connect to the web service (on + localhost, but the code could be changed to connect remotely if + the web service was running on a different machine) and make a + number of method calls. It will output the version number of + your VirtualBox installation and a list of all virtual machines + that are currently registered (with a bit of seemingly random + data, which will be explained later). + + + + + + Raw web service example for Perl + + We also ship a small sample for Perl. It uses the SOAP::Lite + perl module to communicate with the VirtualBox web service. + + The + sdk/bindings/webservice/perl/lib/ + directory contains a pre-generated Perl module that allows for + communicating with the web service from Perl. You can generate such a + module yourself using the "stubmaker" tool that comes with SOAP::Lite, + but since that tool is slow as well as sometimes unreliable, we are + shipping a working module with the SDK for your convenience. + + Perform the following steps: + + If SOAP::Lite is not yet installed on your system, you + will need to install the package first. On Debian-based systems, + the package is called + libsoap-lite-perl; on Gentoo, + it's dev-perl/SOAP-Lite. + + + + Open a terminal in the + sdk/bindings/webservice/perl/samples/ + directory. + + + + To start the VirtualBox web service, open a second + terminal and change to the directory where the VirtualBox + executables are located. Then type: + ./vboxwebsrv -v + + The web service now waits for connections and will run + until you press Ctrl+C in this second terminal. The -v argument + causes it to log all connections to the terminal. (See for details on how to run the + web service.) + + + + In the first terminal with the Perl sample, run the + clienttest.pl script: + perl -I ../lib clienttest.pl + + + + + + Programming considerations for the raw web service + + If you use the raw web service, you need to keep a number of + things in mind, or you will sooner or later run into issues that are + not immediately obvious. By contrast, the object-oriented client-side + libraries described in take care of these + things automatically and thus greatly simplify using the web + service. + + + Fundamental conventions + + If you are familiar with other web services, you may find the + VirtualBox web service to behave a bit differently to accommodate + for the fact that VirtualBox web service more or less maps the + VirtualBox Main COM API. The following main differences had to be + taken care of: + + Web services, as expressed by WSDL, are not + object-oriented. Even worse, they are normally stateless (or, + in web services terminology, "loosely coupled"). Web service + operations are entirely procedural, and one cannot normally + make assumptions about the state of a web service between + function calls. + + In particular, this normally means that you cannot work + on objects in one method call that were created by another + call. + + + + By contrast, the VirtualBox Main API, being expressed in + COM, is object-oriented and works entirely on objects, which + are grouped into public interfaces, which in turn have + attributes and methods associated with them. + + For the VirtualBox web service, this results in + three fundamental conventions: + + All function names in + the VirtualBox web service consist of an interface name and a + method name, joined together by an underscore. This is because + there are only functions ("operations") in WSDL, but no + classes, interfaces, or methods. + + In addition, all calls to the VirtualBox web service + (except for logon, see below) take a managed object reference as the first + argument, representing the object upon which the underlying + method is invoked. (Managed object references are explained in + detail below; see .) + + So, when one would normally code, in the pseudo-code of + an object-oriented language, to invoke a method upon an + object:IMachine machine; +result = machine.getName(); + + In the VirtualBox web service, this looks something like + this (again, pseudo-code):IMachineRef machine; +result = IMachine_getName(machine); + + + + To make the web service stateful, and objects persistent + between method calls, the VirtualBox web service introduces a + session manager (by way of the + IWebsessionManager + interface), which manages object references. Any client wishing + to interact with the web service must first log on to the + session manager and in turn receives a managed object reference + to an object that supports the + IVirtualBox + interface (the basic interface in the Main API). + + + + In other words, as opposed to other web services, the VirtualBox web service is both object-oriented and + stateful. + + + + Example: A typical web service client session + + A typical short web service session to retrieve the version + number of the VirtualBox web service (to be precise, the underlying + Main API version number) looks like this: + + A client logs on to the web service by calling + IWebsessionManager::logon() + with a valid user name and password. See + + for details about how authentication works. + + + + On the server side, + vboxwebsrv creates a session, + which persists until the client calls + IWebsessionManager::logoff() + or the session times out after a configurable period of + inactivity (see ). + + For the new session, the web service creates an instance + of IVirtualBox. + This interface is the most central one in the Main API and + allows access to all other interfaces, either through + attributes or method calls. For example, IVirtualBox contains + a list of all virtual machines that are currently registered + (as they would be listed on the left side of the VirtualBox + main program). + + The web service then creates a managed object reference + for this instance of IVirtualBox and returns it to the calling + client, which receives it as the return value of the logon + call. Something like this: + + string oVirtualBox; +oVirtualBox = webservice.IWebsessionManager_logon("user", "pass"); + + (The managed object reference "oVirtualBox" is just a + string consisting of digits and dashes. However, it is a + string with a meaning and will be checked by the web service. + For details, see below. As hinted above, + IWebsessionManager::logon() + is the only operation provided by the web + service which does not take a managed object reference as the + first argument!) + + + + The VirtualBox Main API documentation says that the + IVirtualBox interface has a + version + attribute, which is a string. For each attribute, there is a + "get" and a "set" method in COM, which maps to according + operations in the web service. So, to retrieve the "version" + attribute of this IVirtualBox + object, the web service client does this: + string version; +version = webservice.IVirtualBox_getVersion(oVirtualBox); + +print version; + + And it will print + "&VBOX_VERSION_MAJOR;.&VBOX_VERSION_MINOR;.&VBOX_VERSION_BUILD;". + + + + The web service client calls + IWebsessionManager::logoff() + with the VirtualBox managed object reference. This will clean + up all allocated resources. + + + + + + Managed object references + + To a web service client, a managed object reference looks like + a string: two 64-bit hex numbers separated by a dash. This string, + however, represents a COM object that "lives" in the web service + process. The two 64-bit numbers encoded in the managed object + reference represent a session ID (which is the same for all objects + in the same web service session, i.e. for all objects after one + logon) and a unique object ID within that session. + + Managed object references are created in two + situations: + + When a client logs on, by calling + IWebsessionManager::logon(). + + Upon logon, the websession manager creates one instance + of IVirtualBox, + which can be used for directly performing calls to its + methods, or used as a parameter for calling some methods of + IWebsessionManager. + Creating Main API session objects is performed using + IWebsessionManager::getSessionObject(). + + (Technically, there is always only one + IVirtualBox object, which + is shared between all websessions and clients, as it is a COM + singleton. However, each session receives its own managed + object reference to it.) + + + + Whenever a web service clients invokes an operation + whose COM implementation creates COM objects. + + For example, + IVirtualBox::createMachine() + creates a new instance of + IMachine; + the COM object returned by the COM method call is then wrapped + into a managed object reference by the web server, and this + reference is returned to the web service client. + + + + Internally, in the web service process, each managed object + reference is simply a small data structure, containing a COM pointer + to the "real" COM object, the web session ID and the object ID. This + structure is allocated on creation and stored efficiently in hashes, + so that the web service can look up the COM object quickly whenever + a web service client wishes to make a method call. The random + session ID also ensures that one web service client cannot intercept + the objects of another. + + Managed object references are not destroyed automatically and + must be released by explicitly calling + IManagedObjectRef::release(). + This is important, as + otherwise hundreds or thousands of managed object references (and + corresponding COM objects, which can consume much more memory!) can + pile up in the web service process and eventually cause it to deny + service. + + To reiterate: The underlying COM object, which the reference + points to, is only freed if the managed object reference is + released. It is therefore vital that web service clients properly + clean up after the managed object references that are returned to + them. + + When a web service client calls + IWebsessionManager::logoff(), + all managed object references created during the session are + automatically freed. For short-lived sessions that do not create a + lot of objects, logging off may therefore be sufficient, although it + is certainly not "best practice". + + + + Some more detail about web service operation + + + SOAP messages + + Whenever a client makes a call to a web service, this + involves a complicated procedure internally. These calls are + remote procedure calls. Each such procedure call typically + consists of two "message" being passed, where each message is a + plain-text HTTP request with a standard HTTP header and a special + XML document following. This XML document encodes the name of the + procedure to call and the argument names and values passed to + it. + + To give you an idea of what such a message looks like, + assuming that a web service provides a procedure called + "SayHello", which takes a string "name" as an argument and returns + "Hello" with a space and that name appended, the request message + could look like this: + + <?xml version="1.0" encoding="UTF-8"?> +<SOAP-ENV:Envelope + xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" + xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns:xsd="http://www.w3.org/2001/XMLSchema" + xmlns:test="http://test/"> +<SOAP-ENV:Body> + <test:SayHello> + <name>Peter</name> + </test:SayHello> + </SOAP-ENV:Body> +</SOAP-ENV:Envelope>A similar message -- the "response" message + -- would be sent back from the web service to the client, + containing the return value "Hello Peter". + + Most programming languages provide automatic support to + generate such messages whenever code in that programming language + makes such a request. In other words, these programming languages + allow for writing something like this (in pseudo-C++ code): + + webServiceClass service("localhost", 18083); // server and port +string result = service.SayHello("Peter"); // invoke remote procedure + and would, for these two pseudo-lines, automatically perform these + steps: + + + + prepare a connection to a web service running on port + 18083 of "localhost"; + + + + for the SayHello() + function of the web service, generate a SOAP message like in + the above example by encoding all arguments of the remote + procedure call (which could involve all kinds of type + conversions and complex marshalling for arrays and + structures); + + + + connect to the web service via HTTP and send that + message; + + + + wait for the web service to send a response + message; + + + + decode that response message and put the return value + of the remote procedure into the "result" variable. + + + + + + Service descriptions in WSDL + + In the above explanations about SOAP, it was left open how + the programming language learns about how to translate function + calls in its own syntax into proper SOAP messages. In other words, + the programming language needs to know what operations the web + service supports and what types of arguments are required for the + operation's data in order to be able to properly serialize and + deserialize the data to and from the web service. For example, if + a web service operation expects a number in "double" floating + point format for a particular parameter, the programming language + cannot send to it a string instead. + + For this, the Web Service Definition Language (WSDL) was + invented, another XML substandard that describes exactly what + operations the web service supports and, for each operation, which + parameters and types are needed with each request and response + message. WSDL descriptions can be incredibly verbose, and one of + the few good things that can be said about this standard is that + it is indeed supported by most programming languages. + + So, if it is said that a programming language "supports" web + services, this typically means that a programming language has + support for parsing WSDL files and somehow integrating the remote + procedure calls into the native language syntax -- for example, + like in the Java sample shown in . + + For details about how programming languages support web + services, please refer to the documentation that comes with the + individual languages. Here are a few pointers: + + + + For C++, among many + others, the gSOAP toolkit is a good option. Parts of gSOAP are + also used in VirtualBox to implement the VirtualBox web + service. + + + + For Java, there are + several implementations already described in this document + (see and ). + + + + Perl supports WSDL via + the SOAP::Lite package. This in turn comes with a tool called + stubmaker.pl that allows you + to turn any WSDL file into a Perl package that you can import. + (You can also import any WSDL file "live" by having it parsed + every time the script runs, but that can take a while.) You + can then code (again, assuming the above example): + my $result = servicename->sayHello("Peter"); + + + A sample that uses SOAP::Lite was described in . + + + + + + + + + Using COM/XPCOM directly + + If you do not require remote procedure calls + such as those offered by the VirtualBox web service, and if you know + Python or C++ as well as COM, you might find it preferable to program + VirtualBox's Main API directly via COM. + + COM stands for "Component Object Model" and is a standard + originally introduced by Microsoft in the 1990s for Microsoft Windows. + It allows for organizing software in an object-oriented way and across + processes; code in one process may access objects that live in another + process. + + COM has several advantages: it is language-neutral, meaning that + even though all of VirtualBox is internally written in C++, programs + written in other languages could communicate with it. COM also cleanly + separates interface from implementation, so that external programs need + not know anything about the messy and complicated details of VirtualBox + internals. + + On a Windows host, all parts of VirtualBox will use the COM + functionality that is native to Windows. On other hosts (including + Linux), VirtualBox comes with a built-in implementation of XPCOM, as + originally created by the Mozilla project, which we have enhanced to + support interprocess communication on a level comparable to Microsoft + COM. Internally, VirtualBox has an abstraction layer that allows the + same VirtualBox code to work both with native COM as well as our XPCOM + implementation. + + + Python COM API + + On Windows, Python scripts can use COM and VirtualBox interfaces + to control almost all aspects of virtual machine execution. As an + example, use the following commands to instantiate the VirtualBox + object and start a VM: + vbox = win32com.client.Dispatch("VirtualBox.VirtualBox") + session = win32com.client.Dispatch("VirtualBox.Session") + mach = vbox.findMachine("uuid or name of machine to start") + progress = mach.launchVMProcess(session, "gui", "") + progress.waitForCompletion(-1) + Also, see + /bindings/glue/python/samples/vboxshell.py + for more advanced usage scenarious. However, unless you have specific + requirements, we strongly recommend to use the generic glue layer + described in the next section to access MS COM objects. + + + + Common Python bindings layer + + As different wrappers ultimately provide access to the same + underlying API, and to simplify porting and development of Python + application using the VirtualBox Main API, we developed a common glue + layer that abstracts out most platform-specific details from the + application and allows the developer to focus on application logic. + The VirtualBox installer automatically sets up this glue layer for the + system default Python install. See below for details on how to set up + the glue layer if you want to use a different Python + installation. + + The minimum supported Python version is 2.6. + + In this layer, the class + VirtualBoxManager hides most + platform-specific details. It can be used to access both the local + (COM) and the web service based API. The following code can be used by + an application to use the glue layer. + + # This code assumes vboxapi.py from VirtualBox distribution +# being in PYTHONPATH, or installed system-wide +from vboxapi import VirtualBoxManager + +# This code initializes VirtualBox manager with default style +# and parameters +virtualBoxManager = VirtualBoxManager(None, None) + +# Alternatively, one can be more verbose, and initialize +# glue with web service backend, and provide authentication +# information +virtualBoxManager = VirtualBoxManager("WEBSERVICE", + {'url':'http://myhost.com::18083/', + 'user':'me', + 'password':'secret'}) + + We supply the VirtualBoxManager + constructor with 2 arguments: style and parameters. Style defines + which bindings style to use (could be "MSCOM", "XPCOM" or + "WEBSERVICE"), and if set to None + defaults to usable platform bindings (MS COM on Windows, XPCOM on + other platforms). The second argument defines parameters, passed to + the platform-specific module, as we do in the second example, where we + pass username and password to be used to authenticate against the web + service. + + After obtaining the + VirtualBoxManager instance, one can + perform operations on the IVirtualBox class. For example, the + following code will a start virtual machine by name or ID: + + from vboxapi import VirtualBoxManager +mgr = VirtualBoxManager(None, None) +vbox = mgr.getVirtualBox() +name = "Linux" +mach = vbox.findMachine(name) +session = mgr.getSessionObject(vbox) +progress = mach.launchVMProcess(session, "gui", "") +progress.waitForCompletion(-1) +mgr.closeMachineSession(session) + + + Following code will print all registered machines and their log + folders + + from vboxapi import VirtualBoxManager +mgr = VirtualBoxManager(None, None) +vbox = mgr.getVirtualBox() + +for m in mgr.getArray(vbox, 'machines'): + print "Machine '%s' logs in '%s'" %(m.name, m.logFolder) + + + Code above demonstrates cross-platform access to array properties + (certain limitations prevent one from using + vbox.machines to access a list of + available virtual machines in case of XPCOM), and a mechanism of + uniform session creation and closing + (mgr.getSessionObject()). + + In case you want to use the glue layer with a different Python + installation, use these steps in a shell to add the necessary + files: + + # cd VBOX_INSTALL_PATH/sdk/installer + # PYTHON vboxapisetup.py install + + + + C++ COM API + + C++ is the language that VirtualBox itself is written in, so C++ + is the most direct way to use the Main API -- but it is not + necessarily the easiest, as using COM and XPCOM has its own set of + complications. + + VirtualBox ships with sample programs that demonstrate how to + use the Main API to implement a number of tasks on your host platform. + These samples can be found in the + /bindings/xpcom/samples directory for + Linux, Mac OS X and Solaris and + /bindings/mscom/samples for Windows. + The two samples are actually different, because the one for Windows + uses native COM, whereas the other uses our XPCOM implementation, as + described above. + + Since COM and XPCOM are conceptually very similar but vary in + the implementation details, we have created a "glue" layer that + shields COM client code from these differences. All VirtualBox uses is + this glue layer, so the same code written once works on both Windows + hosts (with native COM) as well as on other hosts (with our XPCOM + implementation). It is recommended to always use this glue code + instead of using the COM and XPCOM APIs directly, as it is very easy + to make your code completely independent from the platform it is + running on. + + In order to encapsulate platform differences between Microsoft + COM and XPCOM, the following items should be kept in mind when using + the glue layer: + + + + Attribute getters and + setters. COM has the notion of "attributes" in + interfaces, which roughly compare to C++ member variables in + classes. The difference is that for each attribute declared in + an interface, COM automatically provides a "get" method to + return the attribute's value. Unless the attribute has been + marked as "readonly", a "set" attribute is also provided. + + To illustrate, the IVirtualBox interface has a "version" + attribute, which is read-only and of the "wstring" type (the + standard string type in COM). As a result, you can call the + "get" method for this attribute to retrieve the version number + of VirtualBox. + + Unfortunately, the implementation differs between COM and + XPCOM. Microsoft COM names the "get" method like this: + get_Attribute(), whereas XPCOM + uses this syntax: + GetAttribute() (and accordingly + for "set" methods). To hide these differences, the VirtualBox + glue code provides the + COMGETTER(attrib) and + COMSETTER(attrib) macros. So, + COMGETTER(version)() (note, two + pairs of brackets) expands to + get_Version() on Windows and + GetVersion() on other + platforms. + + + + Unicode conversions. + While the rest of the modern world has pretty much settled on + encoding strings in UTF-8, COM, unfortunately, uses UCS-16 + encoding. This requires a lot of conversions, in particular + between the VirtualBox Main API and the Qt GUI, which, like the + rest of Qt, likes to use UTF-8. + + To facilitate these conversions, VirtualBox provides the + com::Bstr and + com::Utf8Str classes, which + support all kinds of conversions back and forth. + + + + COM autopointers. + Possibly the greatest pain of using COM -- reference counting -- + is alleviated by the + ComPtr<> template + provided by the ptr.h file in + the glue layer. + + + + + + Event queue processing + + Both VirtualBox client programs and frontends should + periodically perform processing of the main event queue, and do that + on the application's main thread. In case of a typical GUI Windows/Mac + OS application this happens automatically in the GUI's dispatch loop. + However, for CLI only application, the appropriate actions have to be + taken. For C++ applications, the VirtualBox SDK provided glue method + + int EventQueue::processEventQueue(uint32_t cMsTimeout) + can be used for both blocking and non-blocking operations. + For the Python bindings, a common layer provides the method + VirtualBoxManager.waitForEvents(ms) + with similar semantics. + + Things get somewhat more complicated for situations where an + application using VirtualBox cannot directly control the main event + loop and the main event queue is separated from the event queue of the + programming librarly (for example in case of Qt on Unix platforms). In + such a case, the application developer is advised to use a + platform/toolkit specific event injection mechanism to force event + queue checks either based on periodical timer events delivered to the + main thread, or by using custom platform messages to notify the main + thread when events are available. See the VBoxSDL and Qt (VirtualBox) + frontends as examples. + + + + Visual Basic and Visual Basic Script (VBS) on Windows + hosts + + On Windows hosts, one can control some of the VirtualBox Main + API functionality from VBS scripts, and pretty much everything from + Visual Basic programs. + The difference results from the way VBS treats COM + safearrays, which are used to keep lists in the Main API. VBS + expects every array element to be a + VARIANT, which is too strict a + limitation for any high performance API. We may lift this + restriction for interface APIs in a future version, or + alternatively provide conversion APIs. + + + VBS is scripting language available in any recent Windows + environment. As an example, the following VBS code will print + VirtualBox version: + set vb = CreateObject("VirtualBox.VirtualBox") + Wscript.Echo "VirtualBox version " & vb.version + See + bindings/mscom/vbs/sample/vboxinfo.vbs + for the complete sample. + + Visual Basic is a popular high level language capable of + accessing COM objects. The following VB code will iterate over all + available virtual machines: + Dim vb As VirtualBox.IVirtualBox + + vb = CreateObject("VirtualBox.VirtualBox") + machines = "" + For Each m In vb.Machines + m = m & " " & m.Name + Next + See + bindings/mscom/vb/sample/vboxinfo.vb + for the complete sample. + + + + C binding to VirtualBox API + + The VirtualBox API originally is designed as object oriented, + using XPCOM or COM as the middleware, which translates natively to C++. + This means that in order to use it from C there needs to be some + helper code to bridge the language differences and reduce the + differences between platforms. + + + Cross-platform C binding to VirtualBox API + + Starting with version 4.3, VirtualBox offers a C binding + which allows using the same C client sources for all platforms, + covering Windows, Linux, Mac OS X and Solaris. It is the + preferred way to write API clients, even though the old style + is still available. + + + + + Getting started + + The following sections describe how to use the VirtualBox API + in a C program. The necessary files are included in the SDK, in the + directories sdk/bindings/c/include + and sdk/bindings/c/glue. + + As part of the SDK, a sample program + tstCAPIGlue.c is provided in the + directory sdk/bindings/c/samples + which demonstrates + using the C binding to initialize the API, get handles for + VirtualBox and Session objects, make calls to list and start virtual + machines, monitor events, and uninitialize resources when done. The + sample program is trying to illustrate all relevant concepts, so it + is a great source of detail information. Among many other generally + useful code sequences it contains a function which shows how to + retrieve error details in C code if they are available from the API + call. + + The sample program tstCAPIGlue + can be built using the provided + Makefile and can be run without + arguments. + + It uses the VBoxCAPIGlue library (source code is in directory + sdk/bindings/c/glue, to be used in + your API client code) to open the C binding layer during runtime, + which is preferred to other means as it isolates the code which + locates the necessary dynamic library, using a known working way + which works on all platforms. If you encounter problems with this + glue code in VBoxCAPIGlue.c, let the + VirtualBox developers know, rather than inventing incompatible + solutions. + + The following sections document the important concepts needed + to correctly use the C binding, as it is vital for developing API + client code which manages memory correctly, updates the reference + counters correctly, avoiding crashes and memory leaks. Often API + clients need to handle events, so the C API specifics are also + described below. + + + + VirtualBox C API initialization + + Just like in C++, the API and the underlying middleware needs + to be initialized before it can be used. The + VBoxCAPI_v4_3.h header provides the + interface to the C binding, but you can alternatively and more + conveniently also include + VBoxCAPIGlue.h, + as this avoids the VirtualBox version dependent header file name and + makes sure the global variable g_pVBoxFuncs contains a + pointer to the structure which contains the helper function pointers. + Here's how to initialize the C API:#include "VBoxCAPIGlue.h" +... +IVirtualBoxClient *vboxclient = NULL; +IVirtualBox *vbox = NULL; +ISession *session = NULL; +HRESULT rc; +ULONG revision; + +/* + * VBoxCGlueInit() loads the necessary dynamic library, handles errors + * (producing an error message hinting what went wrong) and gives you + * the pointer to the function table (g_pVBoxFuncs). + * + * Once you get the function table, then how and which functions + * to use is explained below. + * + * g_pVBoxFuncs->pfnClientInitialize does all the necessary startup + * action and provides us with pointers to an IVirtualBoxClient instance. + * It should be matched by a call to g_pVBoxFuncs->pfnClientUninitialize() + * when done. + */ + +if (VBoxCGlueInit()) +{ + fprintf(stderr, "s: FATAL: VBoxCGlueInit failed: %s\n", + argv[0], g_szVBoxErrMsg); + return EXIT_FAILURE; +} + +g_pVBoxFuncs->pfnClientInitialize(NULL, &vboxclient); +if (!vboxclient) +{ + fprintf(stderr, "%s: FATAL: could not get VirtualBoxClient reference\n", + argv[0]); + return EXIT_FAILURE; +} + + If vboxclient is still + NULL this means the initializationi + failed and the VirtualBox C API cannot be used. + + It is possible to write C applications using multiple threads + which all use the VirtualBox API, as long as you're initializing + the C API in each thread which your application creates. This is done + with g_pVBoxFuncs->pfnClientThreadInitialize() and + likewise before the thread is terminated the API must be + uninitialized with + g_pVBoxFuncs->pfnClientThreadUninitialize(). You don't + have to use these functions in worker threads created by COM/XPCOM + (which you might observe if your code uses active event handling), + everything is initialized correctly already. On Windows the C + bindings create a marshaller which supports a wide range of COM + threading models, from STA to MTA, so you don't have to worry about + these details unless you plan to use active event handlers. See + the sample code how to get this to work reliably (in other words + think twice if passive event handling isn't the better solution after + you looked at the sample code). + + + + C API attribute and method invocation + + Method invocation is straightforward. It looks pretty much + like the C++ way, by using a macro which internally accesses the + vtable, and additionally needs to be passed a pointer to the objecti + as the first argument to serve as the + this pointer. + + Using the C binding, all method invocations return a numeric + result code of type HRESULT (with a few exceptions + which normally are not relevant). + + If an interface is specified as returning an object, a pointer + to a pointer to the appropriate object must be passed as the last + argument. The method will then store an object pointer in that + location. + + Likewise, attributes (properties) can be queried or set using + method invocations, using specially named methods. For each + attribute there exists a getter method, the name of which is composed + of get_ followed by the capitalized + attribute name. Unless the attribute is read-only, an analogous + set_ method exists. Let's apply + these rules to get the IVirtualBox + reference, an ISession instance + reference and read the + IVirtualBox::revision + attribute: + rc = IVirtualBoxClient_get_VirtualBox(vboxclient, &vbox); +if (FAILED(rc) || !vbox) +{ + PrintErrorInfo(argv[0], "FATAL: could not get VirtualBox reference", rc); + return EXIT_FAILURE; +} +rc = IVirtualBoxClient_get_Session(vboxclient, &session); +if (FAILED(rc) || !session) +{ + PrintErrorInfo(argv[0], "FATAL: could not get Session reference", rc); + return EXIT_FAILURE; +} + +rc = IVirtualBox_get_Revision(vbox, &revision); +if (SUCCEEDED(rc)) +{ + printf("Revision: %u\n", revision); +} + + The convenience macros for calling a method are named by + prepending the method name with the interface name (using + _as the separator). + + So far only attribute getters were illustrated, but generic + method calls are straightforward, too: + IMachine *machine = NULL; +BSTR vmname = ...; +... +/* + * Calling IMachine::findMachine(...) + */ +rc = IVirtualBox_FindMachine(vbox, vmname, &machine); + + As a more complicated example of a method invocation, let's + call + IMachine::launchVMProcess + which returns an IProgress object. Note again that the method name is + capitalized: + IProgress *progress; +... +rc = IMachine_LaunchVMProcess( + machine, /* this */ + session, /* arg 1 */ + sessionType, /* arg 2 */ + env, /* arg 3 */ + &progress /* Out */ +); + + All objects with their methods and attributes are documented + in . + + + + String handling + + When dealing with strings you have to be aware of a string's + encoding and ownership. + + Internally, the API uses UTF-16 encoded strings. A set of + conversion functions is provided to convert other encodings to and + from UTF-16. The type of a UTF-16 character is + BSTR (or its constant counterpart + CBSTR), which is an array type, + represented by a pointer to the start of the zero-terminated string. + There are functions for converting between UTF-8 and UTF-16 strings + available through g_pVBoxFuncs: + int (*pfnUtf16ToUtf8)(CBSTR pwszString, char **ppszString); +int (*pfnUtf8ToUtf16)(const char *pszString, BSTR *ppwszString); + + The ownership of a string determines who is responsible for + releasing resources associated with the string. Whenever the API + creates a string (essentially for output parameters), ownership is + transferred to the caller. To avoid resource leaks, the caller + should release resources once the string is no longer needed. + There are plenty of examples in the sample code. + + + + Array handling + + Arrays are handled somewhat similarly to strings, with the + additional information of the number of elements in the array. The + exact details of string passing depends on the platform middleware + (COM/XPCOM), and therefore the C binding offers helper functions to + gloss over these differences. + + Passing arrays as input parameters to API methods is usually + done by the following sequence, calling a hypothetical + IArrayDemo_PassArray API method: + static const ULONG aElements[] = { 1, 2, 3, 4 }; +ULONG cElements = sizeof(aElements) / sizeof(aElements[0]); +SAFEARRAY *psa = NULL; +psa = g_pVBoxFuncs->pfnSafeArrayCreateVector(VT_I4, 0, cElements); +g_pVBoxFuncs->pfnSafeArrayCopyInParamHelper(psa, aElements, sizeof(aElements)); +IArrayDemo_PassArray(pThis, ComSafeArrayAsInParam(psa)); +g_pVBoxFuncs->pfnSafeArrayDestroy(psa); + + Likewise, getting arrays results from output parameters is done + using helper functions which manage memory allocations as part of + their other functionality: + SAFEARRAY *psa = g_pVBoxFuncs->pfnSafeArrayOutParamAlloc(); +ULONG *pData; +ULONG cElements; +IArrayDemo_ReturnArray(pThis, ComSafeArrayAsOutTypeParam(psa, ULONG)); +g_pVBoxFuncs->pfnSafeArrayCopyOutParamHelper((void **)&pData, &cElements, VT_I4, psa); +g_pVBoxFuncs->pfnSafeArrayDestroy(psa); + + This covers the necessary functionality for all array element + types except interface references. These need special helpers to + manage the reference counting correctly. The following code snippet + gets the list of VMs, and passes the first IMachine reference to + another API function (assuming that there is at least one element + in the array, to simplify the example): + SAFEARRAY psa = g_pVBoxFuncs->pfnSafeArrayOutParamAlloc(); +IMachine **machines = NULL; +ULONG machineCnt = 0; +ULONG i; +IVirtualBox_get_Machines(virtualBox, ComSafeArrayAsOutIfaceParam(machinesSA, IMachine *)); +g_pVBoxFuncs->pfnSafeArrayCopyOutIfaceParamHelper((IUnknown ***)&machines, &machineCnt, machinesSA); +g_pVBoxFuncs->pfnSafeArrayDestroy(machinesSA); +/* Now "machines" contains the IMachine references, and machineCnt the + * number of elements in the array. */ +... +SAFEARRAY *psa = g_pVBoxFuncs->pfnSafeArrayCreateVector(VT_IUNKNOWN, 0, 1); +g_pVBoxFuncs->pfnSafeArrayCopyInParamHelper(psa, (void *)&machines[0], sizeof(machines[0])); +IVirtualBox_GetMachineStates(ComSafeArrayAsInParam(psa), ...); +... +g_pVBoxFuncs->pfnSafeArrayDestroy(psa); +for (i = 0; i < machineCnt; ++i) +{ + IMachine *machine = machines[i]; + IMachine_Release(machine); +} +free(machines); + + Handling output parameters needs more special effort than + input parameters, thus only for the former there are special helpers, + and the latter is handled through the generic array support. + + + + Event handling + + The VirtualBox API offers two types of event handling, active + and passive, and consequently there is support for both with the + C API binding. Active event handling (based on asynchronous + callback invocation for event delivery) is more difficult, as it + requires the construction of valid C++ objects in C, which is + inherently platform and compiler dependent. Passive event handling + is much simpler, it relies on an event loop, fetching events and + triggering the necessary handlers explicitly in the API client code. + Both approaches depend on an event loop to make sure that events + get delivered in a timely manner, with differences what exactly needs + to be done. + + The C API sample contains code for both event handling styles, + and one has to modify the appropriate #define to select + which style is actually used by the compiled program. It allows a + good comparison between the two variants, and the code sequences are + probably worth reusing without much change in other API clients + with only minor adaptions. + + Active event handling needs to ensure that the following helper + function is called frequently enough in the primary thread: + g_pVBoxFuncs->pfnProcessEventQueue(cTimeoutMS); + + The actual event handler implementation is quite tedious, as + it has to implement a complete API interface. Especially on Windows + it is a lot of work to implement the complicated + IDispatch interface, requiring to load COM type + information and using it in the IDispatch method + implementation. Overall this is quite tedious compared to passive + event handling. + + Passive event handling uses a similar event loop structure, + which requires calling the following function in a loop, and + processing the returned event appropriately: + rc = IEventSource_GetEvent(pEventSource, pListener, cTimeoutMS, &pEvent); + + After processing the event it needs to be marked as processed + with the following method call: + rc = IEventSource_EventProcessed(pEventSource, pListener, pEvent); + + This is vital for vetoable events, as they would be stuck + otherwise, waiting whether the veto comes or not. It does not do any + harm for other event types, and in the end is cheaper than checking + if the event at hand is vetoable or not. + + The general event handling concepts are described in the API + specification (see ), including how to + aggregate multiple event sources for processing in one event loop. + As mentioned, the sample illustrates the practical aspects of how to + use both types of event handling, active and passive, from a C + application. Additional hints are in the comments documenting + the helper methods in + VBoxCAPI_v4_3.h. The code complexity + of active event handling (and its inherenly platform/compiler + specific aspects) should be motivation to use passive event handling + whereever possible. + + + + C API uninitialization + + Uninitialization is performed by + g_pVBoxFuncs->pfnClientUninitialize(). + If your program can exit from more than one place, it is a good idea + to install this function as an exit handler with Standard C's + atexit() just after calling + g_pVBoxFuncs->pfnClientInitialize() + , e.g. #include <stdlib.h> +#include <stdio.h> + +... + +/* + * Make sure g_pVBoxFuncs->pfnClientUninitialize() is called at exit, no + * matter if we return from the initial call to main or call exit() + * somewhere else. Note that atexit registered functions are not + * called upon abnormal termination, i.e. when calling abort() or + * signal(). + */ + +if (atexit(g_pVBoxFuncs->pfnClientUninitialize()) != 0) { + fprintf(stderr, "failed to register g_pVBoxFuncs->pfnClientUninitialize()\n"); + exit(EXIT_FAILURE); +} + + Another idea would be to write your own void + myexit(int status) function, calling + g_pVBoxFuncs->pfnClientUninitialize() + followed by the real exit(), and + use it instead of exit() throughout + your program and at the end of + main. + + If you expect the program to be terminated by a signal (e.g. + user types CTRL-C sending SIGINT) you might want to install a signal + handler setting a flag noting that a signal was sent and then + calling + g_pVBoxFuncs->pfnClientUninitialize() + later on, not from the handler itself. + + That said, if a client program forgets to call + g_pVBoxFuncs->pfnClientUninitialize() + before it terminates, there is a mechanism in place which will + eventually release references held by the client. On Windows it can + take quite a while, in the order of 6-7 minutes. + + + + Compiling and linking + + A program using the C binding has to open the library during + runtime using the help of glue code provided and as shown in the + example tstCAPIGlue.c. + Compilation and linking can be achieved with a makefile fragment + similar to:# Where is the SDK directory? +PATH_SDK = ../../.. +CAPI_INC = -I$(PATH_SDK)/bindings/c/include +ifeq ($(BUILD_PLATFORM),win) +PLATFORM_INC = -I$(PATH_SDK)/bindings/mscom/include +PLATFORM_LIB = $(PATH_SDK)/bindings/mscom/lib +else +PLATFORM_INC = -I$(PATH_SDK)/bindings/xpcom/include +PLATFORM_LIB = $(PATH_SDK)/bindings/xpcom/lib +endif +GLUE_DIR = $(PATH_SDK)/bindings/c/glue +GLUE_INC = -I$(GLUE_DIR) + +# Compile Glue Library +VBoxCAPIGlue.o: $(GLUE_DIR)/VBoxCAPIGlue.c + $(CC) $(CFLAGS) $(CAPI_INC) $(PLATFORM_INC) $(GLUE_INC) -o $@ -c $< + +# Compile interface ID list +VirtualBox_i.o: $(PLATFORM_LIB)/VirtualBox_i.c + $(CC) $(CFLAGS) $(CAPI_INC) $(PLATFORM_INC) $(GLUE_INC) -o $@ -c $< + +# Compile program code +program.o: program.c + $(CC) $(CFLAGS) $(CAPI_INC) $(PLATFORM_INC) $(GLUE_INC) -o $@ -c $< + +# Link program. +program: program.o VBoxCAPICGlue.o VirtualBox_i.o + $(CC) -o $@ $^ -ldl -lpthread + + + + Conversion of code using legacy C binding + + This section aims to make the task of converting code using + the legacy C binding to the new style a breeze, by pointing out some + key steps. + + One necessary change is adjusting your Makefile to reflect the + different include paths. See above. There are now 3 relevant include + directories, and most of it is pointing to the C binding directory. + The XPCOM include directory is still relevant for platforms where + the XPCOM middleware is used, but most of the include files live + elsewhere now, so it's good to have it last. Additionally the + VirtualBox_i.c file needs to be + compiled and linked to the program, it contains the IIDs relevant + for the VirtualBox API, making sure they are not replicated endlessly + if the code refers to them frequently. + + The C API client code should include + VBoxCAPIGlue.h instead of + VBoxXPCOMCGlue.h or + VBoxCAPI_v4_3.h, as this makes sure + the correct macros and internal translations are selected. + + All API method calls (anything mentioning vtbl) + should be rewritten using the convenience macros for calling methods, + as these hide the internal details, are generally easier to use and + shorter to type. You should remove as many as possible + (nsISupports **) or similar typecasts, as the new style + should use the correct type in most places, increasing the type + safety in case of an error in the source code. + + To gloss over the platform differences, API client code should + no longer rely on XPCOM specific interface names such as + nsISupports, nsIException and + nsIEventQueue, and replace them by the platform + independent interface names IUnknown and + IErrorInfo for the first two respectively. Event queue + handling should be replaced by using the platform independent way + described in . + + Finally adjust the string and array handling to use the new + helpers, as these make sure the code works without changes with + both COM and XPCOM, which are significantly different in this area. + The code should be double checked if it uses the correct way to + manage memory, and is freeing it only after the last use. + + + + Legacy C binding to VirtualBox API for XPCOM + + + This section applies to Linux, Mac OS X and Solaris + hosts only and describes deprecated use of the API from C. + + + Starting with version 2.2, VirtualBox offers a C binding for + its API which works only on platforms using XPCOM. Refer to the + old SDK documentation (included in the SDK packages for version 4.3.6 + or earlier), it still applies unchanged. The fundamental concepts are + similar (but the syntactical details are quite different) to the + newer cross-platform C binding which should be used for all new code, + as the support for the old C binding will go away in a major release + after version 4.3. + + + + + + + Basic VirtualBox concepts; some examples + + The following explains some basic VirtualBox concepts such as the + VirtualBox object, sessions and how virtual machines are manipulated and + launched using the Main API. The coding examples use a pseudo-code style + closely related to the object-oriented web service (OOWS) for JAX-WS. + Depending on which environment you are using, you will need to adjust the + examples. + + + Obtaining basic machine information. Reading attributes + + Any program using the Main API will first need access to the + global VirtualBox object (see + IVirtualBox), from which all other + functionality of the API is derived. With the OOWS for JAX-WS, this is + returned from the + IWebsessionManager::logon() + call. + + To enumerate virtual machines, one would look at the "machines" + array attribute in the VirtualBox object (see + IVirtualBox::machines). + This array contains all virtual machines currently registered with the + host, each of them being an instance of + IMachine. + From each such instance, one can query additional information, such as + the UUID, the name, memory, operating system and more by looking at the + attributes; see the attributes list in + IMachine documentation. + + As mentioned in the preceding chapters, depending on your + programming environment, attributes are mapped to corresponding "get" + and (if the attribute is not read-only) "set" methods. So when the + documentation says that IMachine has a + "name" attribute, this means you + need to code something + like the following to get the machine's name: + IMachine machine = ...; +String name = machine.getName(); + Boolean attribute getters can sometimes be called + isAttribute() due to JAX-WS naming + conventions. + + + + Changing machine settings: Sessions + + As said in the previous section, to read a machine's attribute, + one invokes the corresponding "get" method. One would think that to + change settings of a machine, it would suffice to call the corresponding + "set" method -- for example, to set a VM's memory to 1024 MB, one would + call setMemorySize(1024). Try that, and + you will get an error: "The machine is not mutable." + + So unfortunately, things are not that easy. VirtualBox is a + complicated environment in which multiple processes compete for possibly + the same resources, especially machine settings. As a result, machines + must be "locked" before they can either be modified or started. This is + to prevent multiple processes from making conflicting changes to a + machine: it should, for example, not be allowed to change the memory + size of a virtual machine while it is running. (You can't add more + memory to a real computer while it is running either, at least not to an + ordinary PC.) Also, two processes must not change settings at the same + time, or start a machine at the same time. + + These requirements are implemented in the Main API by way of + "sessions", in particular, the ISession + interface. Each process which talks to + VirtualBox needs its own instance of ISession. In the web service, you + can request the creation of such an object by calling + IWebsessionManager::getSessionObject(). + More complex management tasks might need multiple instances of ISession, + and each call returns a new one. + + This session object must then be used like a mutex semaphore in + common programming environments. Before you can change machine settings, + you must write-lock the machine by calling + IMachine::lockMachine() + with your process's session object. + + After the machine has been locked, the + ISession::machine attribute + contains a copy of the original IMachine object upon which the session + was opened, but this copy is "mutable": you can invoke "set" methods on + it. + + When done making the changes to the machine, you must call + IMachine::saveSettings(), + which will copy the changes you have made from your "mutable" machine + back to the real machine and write them out to the machine settings XML + file. This will make your changes permanent. + + Finally, it is important to always unlock the machine again, by + calling + ISession::unlockMachine(). + Otherwise, when the calling process end, the machine will receive the + "aborted" state, which can lead to loss of data. + + So, as an example, the sequence to change a machine's memory to + 1024 MB is something like this:IWebsessionManager mgr ...; +IVirtualBox vbox = mgr.logon(user, pass); +... +IMachine machine = ...; // read-only machine +ISession session = mgr.getSessionObject(); +machine.lockMachine(session, LockType.Write); // machine is now locked for writing +IMachine mutable = session.getMachine(); // obtain the mutable machine copy +mutable.setMemorySize(1024); +mutable.saveSettings(); // write settings to XML +session.unlockMachine(); + + + + Launching virtual machines + + To launch a virtual machine, you call + IMachine::launchVMProcess(). + In doing so, the caller instructs the VirtualBox engine to start a new + process with the virtual machine in it, since to the host, each virtual + machine looks like single process, even if it has hundreds of its own + processes inside. (This new VM process in turn obtains a write lock on + the machine, as described above, to prevent conflicting changes from + other processes; this is why opening another session will fail while the + VM is running.) + + Starting a machine looks something like this: + IWebsessionManager mgr ...; +IVirtualBox vbox = mgr.logon(user, pass); +... +IMachine machine = ...; // read-only machine +ISession session = mgr.getSessionObject(); +IProgress prog = machine.launchVMProcess(session, + "gui", // session type + ""); // possibly environment setting +prog.waitForCompletion(10000); // give the process 10 secs +if (prog.getResultCode() != 0) // check success + System.out.println("Cannot launch VM!") + + The caller's session object can then be used as a sort of remote + control to the VM process that was launched. It contains a "console" + object (see ISession::console) + with which the VM can be paused, + stopped, snapshotted or other things. + + + + VirtualBox events + + In VirtualBox, "events" provide a uniform mechanism to register + for and consume specific events. A VirtualBox client can register an + "event listener" (represented by the + IEventListener interface), which + will then get notified by the server when an event (represented by the + IEvent interface) happens. + + The IEvent interface is an abstract parent interface for all + events that can occur in VirtualBox. The actual events that the server + sends out are then of one of the specific subclasses, for example + IMachineStateChangedEvent + or + IMediumChangedEvent. + + As an example, the VirtualBox GUI waits for machine events and can + thus update its display when the machine state changes or machine + settings are modified, even if this happens in another client. This is + how the GUI can automatically refresh its display even if you manipulate + a machine from another client, for example, from VBoxManage. + + To register an event listener to listen to events, use code like + this:EventSource es = console.getEventSource(); +IEventListener listener = es.createListener(); +VBoxEventType aTypes[] = (VBoxEventType.OnMachineStateChanged); + // list of event types to listen for +es.registerListener(listener, aTypes, false /* active */); + // register passive listener +IEvent ev = es.getEvent(listener, 1000); + // wait up to one second for event to happen +if (ev != null) +{ + // downcast to specific event interface (in this case we have only registered + // for one type, otherwise IEvent::type would tell us) + IMachineStateChangedEvent mcse = IMachineStateChangedEvent.queryInterface(ev); + ... // inspect and do something + es.eventProcessed(listener, ev); +} +... +es.unregisterListener(listener); + + A graphical user interface would probably best start its own + thread to wait for events and then process these in a loop. + + The events mechanism was introduced with VirtualBox 3.3 and + replaces various callback interfaces which were called for each event in + the interface. The callback mechanism was not compatible with scripting + languages, local Java bindings and remote web services as they do not + support callbacks. The new mechanism with events and event listeners + works with all of these. + + To simplify developement of application using events, concept of + event aggregator was introduced. Essentially it's mechanism to aggregate + multiple event sources into single one, and then work with this single + aggregated event source instead of original sources. As an example, one + can evaluate demo recorder in VirtualBox Python shell, shipped with SDK + - it records mouse and keyboard events, represented as separate event + sources. Code is essentially like this: + listener = console.eventSource.createListener() + agg = console.eventSource.createAggregator([console.keyboard.eventSource, console.mouse.eventSource]) + agg.registerListener(listener, [ctx['global'].constants.VBoxEventType_Any], False) + registered = True + end = time.time() + dur + while time.time() < end: + ev = agg.getEvent(listener, 1000) + processEent(ev) + agg.unregisterListener(listener) Without using aggregators + consumer have to poll on both sources, or start multiple threads to + block on those sources. + + + + + The VirtualBox shell + + VirtualBox comes with an extensible shell, which allows you to + control your virtual machines from the command line. It is also a + nontrivial example of how to use the VirtualBox APIs from Python, for all + three COM/XPCOM/WS styles of the API. + + You can easily extend this shell with your own commands. Create a + subdirectory named + .config/VirtualBox/shexts below your home + directory (respectively .VirtualBox/shexts + on a Windows system and + Library/VirtualBox/shexts on OS X) and put + a Python file implementing your shell extension commands in this directory. + This file must contain an array named + commands containing your command + definitions: + commands = { + 'cmd1': ['Command cmd1 help', cmd1], + 'cmd2': ['Command cmd2 help', cmd2] + } + For example, to create a command for creating hard drive + images, the following code can be used: + def createHdd(ctx,args): + # Show some meaningful error message on wrong input + if (len(args) < 3): + print "usage: createHdd sizeM location type" + return 0 + + # Get arguments + size = int(args[1]) + loc = args[2] + if len(args) > 3: + format = args[3] + else: + # And provide some meaningful defaults + format = "vdi" + + # Call VirtualBox API, using context's fields + hdd = ctx['vb'].createMedium(format, loc, ctx['global'].constants.AccessMode_ReadWrite, \ + ctx['global'].constants.DeviceType_HardDisk) + # Access constants using ctx['global'].constants + progress = hdd.createBaseStorage(size, (ctx['global'].constants.MediumVariant_Standard, )) + # use standard progress bar mechanism + ctx['progressBar'](progress) + + + # Report errors + if not hdd.id: + print "cannot create disk (file %s exist?)" %(loc) + return 0 + + # Give user some feedback on success too + print "created HDD with id: %s" %(hdd.id) + + # 0 means continue execution, other values mean exit from the interpreter + return 0 + + commands = { + 'myCreateHDD': ['Create virtual HDD, createHdd size location type', createHdd] + } + Just store the above text in the file + createHdd (or any other meaningful name) + in .config/VirtualBox/shexts/. Start the + VirtualBox shell, or just issue the + reloadExts command, if the shell is + already running. Your new command will now be available. + + + + + + Working with the Cloud + + VirtualBox supports and goes towards the Oracle tendencies like "move to the Cloud". + + + OCI features + VirtualBox supports the Oracle Cloud Infrastructure (OCI). See the interfaces: + ICloudClient, + ICloudProvider, + ICloudProfile, + ICloudProviderManager. + + Each cloud interface has own implementation to support OCI features. There are everal functions in the implementation + which should be explained in details because OCI requires some special data or settings. + + + Also see the enumeration VirtualSystemDescriptionType for the possible values. + + + + + Function ICloudClient::exportVM + + See the ICloudClient::exportVM. + The function exports an existing virtual machine into OCI. The final result of this operation is creation a custom image + from the bootable image of VM. The Id of created image is returned in the parameter "description" (which is + IVirtualSystemDescription) as an entry with the type + VirtualSystemDescriptionType::CloudImageId. The standard steps here are: + + + Upload VBox image to OCI Object Storage. + + + Create OCI custom image from the uploaded object. + + + Parameter "description" must contain all information and settings needed for creation a custom image in OCI. + At least next entries must be presented there before the call: + + + VirtualSystemDescriptionType::Name - Name of new instance in OCI. + + + VirtualSystemDescriptionType::HardDiskImage - The local path or id of bootable VM image. + + + VirtualSystemDescriptionType::CloudBucket - A cloud bucket name where the exported image is uploaded. + + + VirtualSystemDescriptionType::CloudImageDisplayName - A name which is assigned to a new custom image in the OCI. + + + VirtualSystemDescriptionType::CloudKeepObject - Whether keep or delete an uploaded object after its usage. + + + VirtualSystemDescriptionType::CloudLaunchInstance - Whether launch or not a new instance. + + + + + + + Function ICloudClient::launchVM + + See the ICloudClient::launchVM. + The function launches a new instance in OCI with a bootable volume previously created from a custom image in OCI or + as the source may be used an existing bootable volume which shouldn't be attached to any instance. + For launching instance from a custom image use the parameter VirtualSystemDescriptionType::CloudImageId. + For launching instance from a bootable volume use the parameter VirtualSystemDescriptionType::CloudBootVolumeId. + Only one of them must be presented otherwise the error will occur. + The final result of this operation is a running instance. The id of created instance is returned + in the parameter "description" (which is IVirtualSystemDescription) + as an entry with the type VirtualSystemDescriptionType::CloudInstanceId. Parameter "description" must contain all information + and settings needed for creation a new instance in OCI. At least next entries must be presented there before the call: + + + VirtualSystemDescriptionType::Name - Name of new instance in OCI. + + + VirtualSystemDescriptionType::CloudOCISubnet - OCID of existing subnet in OCI which will be used by the instance. + + + + Use VirtualSystemDescriptionType::CloudImageId - OCID of custom image used as a bootable image for the instance + or + VirtualSystemDescriptionType::CloudBootVolumeId - OCID of existing and non-attached bootable volume used as a bootable volume for the instance. + + + + Add VirtualSystemDescriptionType::CloudBootDiskSize - The size of instance bootable volume in GB, + If you use VirtualSystemDescriptionType::CloudImageId. + + + VirtualSystemDescriptionType::CloudInstanceShape - The shape of instance according to OCI documentation, + defines the number of CPUs and RAM memory. + + + VirtualSystemDescriptionType::CloudLaunchInstance - Whether launch or not a new instance. + + + VirtualSystemDescriptionType::CloudDomain - Availability domain in OCI where new instance is created. + + + VirtualSystemDescriptionType::CloudPublicIP - Whether the instance will have a public IP or not. + + + VirtualSystemDescriptionType::CloudPublicSSHKey - Public SSH key which is used to connect to an instance via SSH. + It may be one or more records with the type VirtualSystemDescriptionType::CloudPublicSSHKey in the VirtualSystemDescription. + But at least one should be presented otherwise user won't be able to connect to the instance via SSH. + + + + + + + + Function ICloudClient::getInstanceInfo + + See the ICloudClient::getInstanceInfo. + The function takes an instance id (parameter "uid"), finds the requested instance in OCI and gets back information + about the found instance in the parameter "description" (which is IVirtualSystemDescription) + The entries with next types will be presented in the object: + + + VirtualSystemDescriptionType::Name - Displayed name of the instance. + + + VirtualSystemDescriptionType::CloudDomain - Availability domain in OCI. + + + VirtualSystemDescriptionType::CloudImageId - Name of custom image used for creation this instance. + + + VirtualSystemDescriptionType::CloudInstanceId - The OCID of the instance. + + + VirtualSystemDescriptionType::OS - Guest OS type of the instance. + + + VirtualSystemDescriptionType::CloudBootDiskSize - Size of instance bootable image. + + + VirtualSystemDescriptionType::CloudInstanceState - The instance state according to OCI documentation. + + + VirtualSystemDescriptionType::CloudInstanceShape - The instance shape according to OCI documentation + + + VirtualSystemDescriptionType::Memory - RAM memory in GB allocated for the instance. + + + VirtualSystemDescriptionType::CPU - Number of virtual CPUs allocated for the instance. + + + + + + + Function ICloudClient::importInstance + + See the ICloudClient::importInstance. + The API function imports an existing instance from the OCI to the local host. + The standard steps here are: + + + Create a custom image from an existing OCI instance. + + + Export the custom image to OCI object (the object is created in the OCI Object Storage). + + + Download the OCI object to the local host. + + + As the result of operation user will have a file with the suffix ".oci" on the local host. This file is a TAR archive which + contains a bootable instance image in QCOW2 format and a JSON file with some metadata related to + the imported instance. The function takes the parameter "description" + (which is IVirtualSystemDescription) + Parameter "description" must contain all information and settings needed for successful operation result. + At least next entries must be presented there before the call: + + + VirtualSystemDescriptionType::Name is used for the several purposes: + + + As a custom image name. A custom image is created from an instance. + + + As OCI object name. An object is a file in OCI Object Storage. The object is created from the custom image. + + + Name of imported instance on the local host. Because the result of import is a file, the file will have this + name and extension ".oci". + + + + + + VirtualSystemDescriptionType::CloudInstanceId - The OCID of the existing instance. + + + VirtualSystemDescriptionType::CloudBucket - a cloud bucket name in OCI Object Storage where created an OCI object + from a custom image. + + + + + + + + + + Host-Guest Communication Manager + + The VirtualBox Host-Guest Communication Manager (HGCM) allows a + guest application or a guest driver to call a host shared library. The + following features of VirtualBox are implemented using HGCM: + + Shared Folders + + + + Shared Clipboard + + + + Guest configuration interface + + + + The shared library contains a so called HGCM service. The guest HGCM + clients establish connections to the service to call it. When calling a + HGCM service the client supplies a function code and a number of + parameters for the function. + + + Virtual hardware implementation + + HGCM uses the VMM virtual PCI device to exchange data between the + guest and the host. The guest always acts as an initiator of requests. A + request is constructed in the guest physical memory, which must be + locked by the guest. The physical address is passed to the VMM device + using a 32-bit out edx, eax + instruction. The physical memory must be allocated below 4GB by 64-bit + guests. + + The host parses the request header and data and queues the request + for a host HGCM service. The guest continues execution and usually waits + on a HGCM event semaphore. + + When the request has been processed by the HGCM service, the VMM + device sets the completion flag in the request header, sets the HGCM + event and raises an IRQ for the guest. The IRQ handler signals the HGCM + event semaphore and all HGCM callers check the completion flag in the + corresponding request header. If the flag is set, the request is + considered completed. + + + + Protocol specification + + The HGCM protocol definitions are contained in the + VBox/VBoxGuest.h + + + Request header + + HGCM request structures contains a generic header + (VMMDevHGCMRequestHeader): + HGCM Request Generic Header + + + + + Name + + Description + + + + size + + Size of the entire request. + + + + version + + Version of the header, must be set to + 0x10001. + + + + type + + Type of the request. + + + + rc + + HGCM return code, which will be set by the VMM + device. + + + + reserved1 + + A reserved field 1. + + + + reserved2 + + A reserved field 2. + + + + flags + + HGCM flags, set by the VMM device. + + + + result + + The HGCM result code, set by the VMM device. + + + +
+ + + All fields are 32-bit. + + + + Fields from size to + reserved2 are a standard VMM + device request header, which is used for other interfaces as + well. + + + + + The type field indicates the + type of the HGCM request: + Request Types + + + + + Name (decimal + value) + + Description + + + + VMMDevReq_HGCMConnect + (60) + + Connect to a HGCM service. + + + + VMMDevReq_HGCMDisconnect + (61) + + Disconnect from the service. + + + + VMMDevReq_HGCMCall32 + (62) + + Call a HGCM function using the 32-bit + interface. + + + + VMMDevReq_HGCMCall64 + (63) + + Call a HGCM function using the 64-bit + interface. + + + + VMMDevReq_HGCMCancel + (64) + + Cancel a HGCM request currently being processed by a + host HGCM service. + + + +
+ + The flags field may contain: + + Flags + + + + + Name (hexadecimal + value) + + Description + + + + VBOX_HGCM_REQ_DONE + (0x00000001) + + The request has been processed by the host + service. + + + + VBOX_HGCM_REQ_CANCELLED + (0x00000002) + + This request was cancelled. + + + +
+ + + + Connect + + The connection request must be issued by the guest HGCM client + before it can call the HGCM service (VMMDevHGCMConnect): + Connect request + + + + + Name + + Description + + + + header + + The generic HGCM request header with type equal to + VMMDevReq_HGCMConnect + (60). + + + + type + + The type of the service location information (32 + bit). + + + + location + + The service location information (128 bytes). + + + + clientId + + The client identifier assigned to the connecting + client by the HGCM subsystem (32-bit). + + + +
The type field tells the + HGCM how to look for the requested service: + Location Information Types + + + + + Name (hexadecimal + value) + + Description + + + + VMMDevHGCMLoc_LocalHost + (0x1) + + The requested service is a shared library located on + the host and the location information contains the library + name. + + + + VMMDevHGCMLoc_LocalHost_Existing + (0x2) + + The requested service is a preloaded one and the + location information contains the service name. + + + +
+ Currently preloaded HGCM services are hard-coded in + VirtualBox: + + VBoxSharedFolders + + + + VBoxSharedClipboard + + + + VBoxGuestPropSvc + + + + VBoxSharedOpenGL + + + There is no difference between both types of HGCM services, + only the location mechanism is different. + + The client identifier is returned by the host and must be used + in all subsequent requests by the client. + + + + Disconnect + + This request disconnects the client and makes the client + identifier invalid (VMMDevHGCMDisconnect): + Disconnect request + + + + + Name + + Description + + + + header + + The generic HGCM request header with type equal to + VMMDevReq_HGCMDisconnect + (61). + + + + clientId + + The client identifier previously returned by the + connect request (32-bit). + + + +
+ + + + Call32 and Call64 + + Calls the HGCM service entry point (VMMDevHGCMCall) using 32-bit + or 64-bit addresses: + Call request + + + + + Name + + Description + + + + header + + The generic HGCM request header with type equal to + either VMMDevReq_HGCMCall32 + (62) or + VMMDevReq_HGCMCall64 + (63). + + + + clientId + + The client identifier previously returned by the + connect request (32-bit). + + + + function + + The function code to be processed by the service (32 + bit). + + + + cParms + + The number of following parameters (32-bit). This + value is 0 if the function requires no parameters. + + + + parms + + An array of parameter description structures + (HGCMFunctionParameter32 or + HGCMFunctionParameter64). + + + +
+ + The 32-bit parameter description (HGCMFunctionParameter32) + consists of 32-bit type field and 8 bytes of an opaque value, so 12 + bytes in total. The 64-bit variant (HGCMFunctionParameter64) consists + of the type and 12 bytes of a value, so 16 bytes in total. + + + Parameter types + + + + + Type + + Format of the + value + + + + VMMDevHGCMParmType_32bit (1) + + A 32-bit value. + + + + VMMDevHGCMParmType_64bit (2) + + A 64-bit value. + + + + VMMDevHGCMParmType_PhysAddr (3) + + A 32-bit size followed by a 32-bit or 64-bit guest + physical address. + + + + VMMDevHGCMParmType_LinAddr (4) + + A 32-bit size followed by a 32-bit or 64-bit guest + linear address. The buffer is used both for guest to host + and for host to guest data. + + + + VMMDevHGCMParmType_LinAddr_In (5) + + Same as VMMDevHGCMParmType_LinAddr but the buffer is + used only for host to guest data. + + + + VMMDevHGCMParmType_LinAddr_Out (6) + + Same as VMMDevHGCMParmType_LinAddr but the buffer is + used only for guest to host data. + + + + VMMDevHGCMParmType_LinAddr_Locked (7) + + Same as VMMDevHGCMParmType_LinAddr but the buffer is + already locked by the guest. + + + + VMMDevHGCMParmType_LinAddr_Locked_In (1) + + Same as VMMDevHGCMParmType_LinAddr_In but the buffer + is already locked by the guest. + + + + VMMDevHGCMParmType_LinAddr_Locked_Out (1) + + Same as VMMDevHGCMParmType_LinAddr_Out but the buffer + is already locked by the guest. + + + +
+ + The + + + + Cancel + + This request cancels a call request (VMMDevHGCMCancel): + Cancel request + + + + + Name + + Description + + + + header + + The generic HGCM request header with type equal to + VMMDevReq_HGCMCancel + (64). + + + +
+ + + + + Guest software interface + + The guest HGCM clients can call HGCM services from both drivers + and applications. + + + The guest driver interface + + The driver interface is implemented in the VirtualBox guest + additions driver (VBoxGuest), which works with the VMM virtual device. + Drivers must use the VBox Guest Library (VBGL), which provides an API + for HGCM clients (VBox/VBoxGuestLib.h + and VBox/VBoxGuest.h). + + +DECLR0VBGL(int) VbglR0HGCMConnect(VBGLHGCMHANDLE *pHandle, const char *pszServiceName, HGCMCLIENTID *pidClient); + Connects to the service: + VBoxGuestHGCMConnectInfo data; + + memset(&data, sizeof(VBoxGuestHGCMConnectInfo)); + + data.result = VINF_SUCCESS; + data.Loc.type = VMMDevHGCMLoc_LocalHost_Existing; + strcpy (data.Loc.u.host.achName, "VBoxSharedFolders"); + + rc = VbglHGCMConnect (&handle, "VBoxSharedFolders"&data); + + if (RT_SUCCESS (rc)) + { + rc = data.result; + } + + if (RT_SUCCESS (rc)) + { + /* Get the assigned client identifier. */ + ulClientID = data.u32ClientID; + } + + + +DECLVBGL(int) VbglHGCMDisconnect (VBGLHGCMHANDLE handle, VBoxGuestHGCMDisconnectInfo *pData); + Disconnects from the service. + VBoxGuestHGCMDisconnectInfo data; + + RtlZeroMemory (&data, sizeof (VBoxGuestHGCMDisconnectInfo)); + + data.result = VINF_SUCCESS; + data.u32ClientID = ulClientID; + + rc = VbglHGCMDisconnect (handle, &data); + + + +DECLVBGL(int) VbglHGCMCall (VBGLHGCMHANDLE handle, VBoxGuestHGCMCallInfo *pData, uint32_t cbData); + Calls a function in the service. +typedef struct _VBoxSFRead +{ + VBoxGuestHGCMCallInfo callInfo; + + /** pointer, in: SHFLROOT + * Root handle of the mapping which name is queried. + */ + HGCMFunctionParameter root; + + /** value64, in: + * SHFLHANDLE of object to read from. + */ + HGCMFunctionParameter handle; + + /** value64, in: + * Offset to read from. + */ + HGCMFunctionParameter offset; + + /** value64, in/out: + * Bytes to read/How many were read. + */ + HGCMFunctionParameter cb; + + /** pointer, out: + * Buffer to place data to. + */ + HGCMFunctionParameter buffer; + +} VBoxSFRead; + +/** Number of parameters */ +#define SHFL_CPARMS_READ (5) + +... + + VBoxSFRead data; + + /* The call information. */ + data.callInfo.result = VINF_SUCCESS; /* Will be returned by HGCM. */ + data.callInfo.u32ClientID = ulClientID; /* Client identifier. */ + data.callInfo.u32Function = SHFL_FN_READ; /* The function code. */ + data.callInfo.cParms = SHFL_CPARMS_READ; /* Number of parameters. */ + + /* Initialize parameters. */ + data.root.type = VMMDevHGCMParmType_32bit; + data.root.u.value32 = pMap->root; + + data.handle.type = VMMDevHGCMParmType_64bit; + data.handle.u.value64 = hFile; + + data.offset.type = VMMDevHGCMParmType_64bit; + data.offset.u.value64 = offset; + + data.cb.type = VMMDevHGCMParmType_32bit; + data.cb.u.value32 = *pcbBuffer; + + data.buffer.type = VMMDevHGCMParmType_LinAddr_Out; + data.buffer.u.Pointer.size = *pcbBuffer; + data.buffer.u.Pointer.u.linearAddr = (uintptr_t)pBuffer; + + rc = VbglHGCMCall (handle, &data.callInfo, sizeof (data)); + + if (RT_SUCCESS (rc)) + { + rc = data.callInfo.result; + *pcbBuffer = data.cb.u.value32; /* This is returned by the HGCM service. */ + } + + + + + Guest application interface + + Applications call the VirtualBox Guest Additions driver to + utilize the HGCM interface. There are IOCTL's which correspond to the + Vbgl* functions: + + VBOXGUEST_IOCTL_HGCM_CONNECT + + + + VBOXGUEST_IOCTL_HGCM_DISCONNECT + + + + VBOXGUEST_IOCTL_HGCM_CALL + + + + These IOCTL's get the same input buffer as + VbglHGCM* functions and the output + buffer has the same format as the input buffer. The same address can + be used as the input and output buffers. + + For example see the guest part of shared clipboard, which runs + as an application and uses the HGCM interface. + + + + + HGCM Service Implementation + + The HGCM service is a shared library with a specific set of entry + points. The library must export the + VBoxHGCMSvcLoad entry point: +extern "C" DECLCALLBACK(DECLEXPORT(int)) VBoxHGCMSvcLoad (VBOXHGCMSVCFNTABLE *ptable) + + + The service must check the + ptable->cbSize and + ptable->u32Version fields of the + input structure and fill the remaining fields with function pointers of + entry points and the size of the required client buffer size. + + The HGCM service gets a dedicated thread, which calls service + entry points synchronously, that is the service will be called again + only when a previous call has returned. However, the guest calls can be + processed asynchronously. The service must call a completion callback + when the operation is actually completed. The callback can be issued + from another thread as well. + + Service entry points are listed in the + VBox/hgcmsvc.h in the + VBOXHGCMSVCFNTABLE structure. + Service entry points + + + + + Entry + + Description + + + + pfnUnload + + The service is being unloaded. + + + + pfnConnect + + A client u32ClientID + is connected to the service. The + pvClient parameter points to + an allocated memory buffer which can be used by the service to + store the client information. + + + + pfnDisconnect + + A client is being disconnected. + + + + pfnCall + + A guest client calls a service function. The + callHandle must be used in + the VBOXHGCMSVCHELPERS::pfnCallComplete callback when the call + has been processed. + + + + pfnHostCall + + Called by the VirtualBox host components to perform + functions which should be not accessible by the guest. Usually + this entry point is used by VirtualBox to configure the + service. + + + + pfnSaveState + + The VM state is being saved and the service must save + relevant information using the SSM API + (VBox/ssm.h). + + + + pfnLoadState + + The VM is being restored from the saved state and the + service must load the saved information and be able to + continue operations from the saved state. + + + +
+ + + + + RDP Web Control + + The VirtualBox RDP Web Control (RDPWeb) + provides remote access to a running VM. RDPWeb is a RDP (Remote Desktop + Protocol) client based on Flash technology and can be used from a Web + browser with a Flash plugin. + + + RDPWeb features + + RDPWeb is embedded into a Web page and can connect to VRDP server + in order to displays the VM screen and pass keyboard and mouse events to + the VM. + + + + RDPWeb reference + + RDPWeb consists of two required components: + + Flash movie + RDPClientUI.swf + + + + JavaScript helpers + webclient.js + + + + The VirtualBox SDK contains sample HTML code + including: + + JavaScript library for embedding Flash content + SWFObject.js + + + + Sample HTML page + webclient3.html + + + + + RDPWeb functions + + RDPClientUI.swf and + webclient.js work with each other. + JavaScript code is responsible for a proper SWF initialization, + delivering mouse events to the SWF and processing resize requests from + the SWF. On the other hand, the SWF contains a few JavaScript callable + methods, which are used both from + webclient.js and the user HTML + page. + + + JavaScript functions + + webclient.js contains helper + functions. In the following table ElementId refers to an HTML + element name or attribute, and Element to the HTML element itself. + HTML code + <div id="FlashRDP"> + </div> + would have ElementId equal to FlashRDP and Element equal to + the div element. + + + + RDPWebClient.embedSWF(SWFFileName, ElementId) + + Uses SWFObject library to replace the HTML element with + the Flash movie. + + + + RDPWebClient.isRDPWebControlById(ElementId) + + Returns true if the given id refers to a RDPWeb Flash + element. + + + + RDPWebClient.isRDPWebControlByElement(Element) + + Returns true if the given element is a RDPWeb Flash + element. + + + + RDPWebClient.getFlashById(ElementId) + + Returns an element, which is referenced by the given id. + This function will try to resolve any element, event if it is + not a Flash movie. + + + + + + Flash methods callable from JavaScript + + RDPWebClienUI.swf methods can + be called directly from JavaScript code on a HTML page. + + + + getProperty(Name) + + + + setProperty(Name) + + + + connect() + + + + disconnect() + + + + keyboardSendCAD() + + + + + + Flash JavaScript callbacks + + RDPWebClienUI.swf calls + JavaScript functions provided by the HTML page. + + + + + Embedding RDPWeb in an HTML page + + It is necessary to include + webclient.js helper script. If + SWFObject library is used, the + swfobject.js must be also included + and RDPWeb flash content can be embedded to a Web page using dynamic + HTML. The HTML must include a "placeholder", which consists of 2 + div elements. + + + + + RDPWeb change log + + + Version 1.2.28 + + + + keyboardLayout, + keyboardLayouts, + UUID properties. + + + + Support for German keyboard layout on the client. + + + + Rebranding to Oracle. + + + + + + Version 1.1.26 + + + + webclient.js is a part of + the distribution package. + + + + lastError property. + + + + keyboardSendScancodes and + keyboardSendCAD methods. + + + + + + Version 1.0.24 + + + + Initial release. + + + + + + + + Drag and Drop + + Since VirtualBox 4.2 it's possible to transfer files from host to the + Linux guests by dragging files, directories or text from the host into the + guest's screen. This is called drag and drop + (DnD). + + In version 5.0 support for Windows guests has been added, as well as + the ability to transfer data the other way around, that is, from the guest + to the host. + + Currently only the VirtualBox Manager frontend supports drag and + drop. + + This chapter will show how to use the required interfaces provided + by VirtualBox for adding drag and drop functionality to third-party + frontends. + + + Basic concepts + + In order to use the interfaces provided by VirtualBox, some basic + concepts needs to be understood first: To successfully initiate a + drag and drop operation at least two sides needs to be involved, a + source and a target: + + The source is the side which provides the + data, e.g. is the origin of data. This data can be stored within the + source directly or can be retrieved on-demand by the source itself. Other + interfaces don't care where the data from this source actually came + from. + + The target on the other hand is the side which + provides the source a visual representation where the user can drop the + data the source offers. This representation can be a window (or just a + certain part of it), for example. + + The source and the target have abstract interfaces called + IDnDSource and + IDnDTarget. VirtualBox also + provides implementations of both interfaces, called + IGuestDnDSource and + IGuestDnDTarget. Both + implementations are also used in the VirtualBox Manager frontend. + + + + Supported formats + + As the target needs to perform specific actions depending on the + data the source provided, the target first needs to know what type of + data it actually is going to retrieve. It might be that the source offers + data the target cannot (or intentionally does not want to) + support. + + VirtualBox handles those data types by providing so-called + MIME types -- these MIME types were originally + defined in + RFC 2046 and + are also called Content-types. + IGuestDnDSource and + IGuestDnDTarget support + the following MIME types by default: + + text/uri-list - A list of + URIs (Uniform Resource Identifier, see + RFC 3986) + pointing to the file and/or directory paths already transferred + from the source to the target. + + + text/plain;charset=utf-8 and + UTF8_STRING - text in UTF-8 + format. + + + text/plain, TEXT + and STRING - plain ASCII text, + depending on the source's active ANSI page (if any). + + + + + If, for whatever reason, a certain default format should not be + supported or a new format should be registered, + IDnDSource and + IDnDTarget have methods derived from + IDnDBase which provide adding, + removing and enumerating specific formats. + Registering new or removing default formats on the guest side + currently is not implemented. + + + + + + VirtualBox external authentication modules + + VirtualBox supports arbitrary external modules to perform + authentication. The module is used when the authentication method is set + to "external" for a particular VM VRDE access and the library was + specified with VBoxManage setproperty + vrdeauthlibrary. Web service also use the authentication + module which was specified with VBoxManage setproperty + websrvauthlibrary. + + This library will be loaded by the VM or web service process on + demand, i.e. when the first remote desktop connection is made by a client + or when a client that wants to use the web service logs on. + + External authentication is the most flexible as the external handler + can both choose to grant access to everyone (like the "null" + authentication method would) and delegate the request to the guest + authentication component. When delegating the request to the guest + component, the handler will still be called afterwards with the option to + override the result. + + An authentication library is required to implement exactly one entry + point: + + #include "VBoxAuth.h" + +/** + * Authentication library entry point. + * + * Parameters: + * + * szCaller The name of the component which calls the library (UTF8). + * pUuid Pointer to the UUID of the accessed virtual machine. Can be NULL. + * guestJudgement Result of the guest authentication. + * szUser User name passed in by the client (UTF8). + * szPassword Password passed in by the client (UTF8). + * szDomain Domain passed in by the client (UTF8). + * fLogon Boolean flag. Indicates whether the entry point is called + * for a client logon or the client disconnect. + * clientId Server side unique identifier of the client. + * + * Return code: + * + * AuthResultAccessDenied Client access has been denied. + * AuthResultAccessGranted Client has the right to use the + * virtual machine. + * AuthResultDelegateToGuest Guest operating system must + * authenticate the client and the + * library must be called again with + * the result of the guest + * authentication. + * + * Note: When 'fLogon' is 0, only pszCaller, pUuid and clientId are valid and the return + * code is ignored. + */ +AuthResult AUTHCALL AuthEntry( + const char *szCaller, + PAUTHUUID pUuid, + AuthGuestJudgement guestJudgement, + const char *szUser, + const char *szPassword + const char *szDomain + int fLogon, + unsigned clientId) +{ + /* Process request against your authentication source of choice. */ + // if (authSucceeded(...)) + // return AuthResultAccessGranted; + return AuthResultAccessDenied; +} + + A note regarding the UUID implementation of the + pUuid argument: VirtualBox uses a + consistent binary representation of UUIDs on all platforms. For this + reason the integer fields comprising the UUID are stored as little endian + values. If you want to pass such UUIDs to code which assumes that the + integer fields are big endian (often also called network byte order), you + need to adjust the contents of the UUID to e.g. achieve the same string + representation. The required changes are: + + reverse the order of byte 0, 1, 2 and 3 + + + + reverse the order of byte 4 and 5 + + + + reverse the order of byte 6 and 7. + + Using this conversion you will get identical results when + converting the binary UUID to the string representation. + + The guestJudgement argument + contains information about the guest authentication status. For the first + call, it is always set to + AuthGuestNotAsked. In case the + AuthEntry function returns + AuthResultDelegateToGuest, a guest + authentication will be attempted and another call to the + AuthEntry is made with its result. This + can be either granted / denied or no judgement (the guest component chose + for whatever reason to not make a decision). In case there is a problem + with the guest authentication module (e.g. the Additions are not installed + or not running or the guest did not respond within a timeout), the "not + reacted" status will be returned. + + + + Using Java API + + + Introduction + + VirtualBox can be controlled by a Java API, both locally + (COM/XPCOM) and from remote (SOAP) clients. As with the Python bindings, + a generic glue layer tries to hide all platform differences, allowing + for source and binary compatibility on different platforms. + + + + Requirements + + To use the Java bindings, there are certain requirements depending + on the platform. First of all, you need JDK 1.5 (Java 5) or later. Also + please make sure that the version of the VirtualBox API .jar file + exactly matches the version of VirtualBox you use. To avoid confusion, + the VirtualBox API provides versioning in the Java package name, e.g. + the package is named org.virtualbox_3_2 + for VirtualBox version 3.2. + + XPCOM - for all platforms, + but Microsoft Windows. A Java bridge based on JavaXPCOM is shipped + with VirtualBox. The classpath must contain + vboxjxpcom.jar and the + vbox.home property must be set to + location where the VirtualBox binaries are. Please make sure that + the JVM bitness matches bitness of VirtualBox you use as the XPCOM + bridge relies on native libraries. + + Start your application like this: + java -cp vboxjxpcom.jar -Dvbox.home=/opt/virtualbox MyProgram + + + + + COM - for Microsoft + Windows. We rely on Jacob - a + generic Java to COM bridge - which has to be installed seperately. + See http://sourceforge.net/projects/jacob-project/ + for installation instructions. Also, the VirtualBox provided + vboxjmscom.jar must be in the + class path. + + Start your application like this: + java -cp vboxjmscom.jar;c:\jacob\jacob.jar -Djava.library.path=c:\jacob MyProgram + + + + SOAP - all platforms. Java + 6 is required, as it comes with builtin support for SOAP via the + JAX-WS library. Also, the VirtualBox provided + vbojws.jar must be in the class + path. In the SOAP case it's possible to create several + VirtualBoxManager instances to communicate with multiple + VirtualBox hosts. + + Start your application like this: + java -cp vboxjws.jar MyProgram + + + + + Exception handling is also generalized by the generic glue layer, + so that all methods could throw + VBoxException containing human-readable + text message (see getMessage() method) + along with wrapped original exception (see + getWrapped() method). + + + + Example + + This example shows a simple use case of the Java API. Differences + for SOAP vs. local version are minimal, and limited to the connection + setup phase (see ws variable). In the + SOAP case it's possible to create several VirtualBoxManager instances to + communicate with multiple VirtualBox hosts. + import org.virtualbox_4_3.*; + .... + VirtualBoxManager mgr = VirtualBoxManager.createInstance(null); + boolean ws = false; // or true, if we need the SOAP version + if (ws) + { + String url = "http://myhost:18034"; + String user = "test"; + String passwd = "test"; + mgr.connect(url, user, passwd); + } + IVirtualBox vbox = mgr.getVBox(); + System.out.println("VirtualBox version: " + vbox.getVersion() + "\n"); + // get first VM name + String m = vbox.getMachines().get(0).getName(); + System.out.println("\nAttempting to start VM '" + m + "'"); + // start it + mgr.startVm(m, null, 7000); + + if (ws) + mgr.disconnect(); + + mgr.cleanup(); + For more a complete example, see + TestVBox.java, shipped with the + SDK. It contains exception handling and error printing code, which + is important for reliable larger scale projects. + + It is good practice in long-running API clients to process the + system events every now and then in the main thread (does not work + in other threads). As a rule of thumb it makes sense to process them + every few 100msec to every few seconds). This is done by + calling + mgr.waitForEvents(0); + + This avoids that a large number of system events accumulate, which can + need a significant amount of memory, and as they also play a role in + object cleanup it helps freeing additional memory in a timely manner + which is used by the API implementation itself. Java's garbage collection + approach already needs more memory due to the delayed freeing of memory + used by no longer accessible objects, and not processing the system + events exacerbates the memory usage. The + TestVBox.java example code sprinkles + such lines over the code to achieve the desired effect. In multi-threaded + applications it can be called from the main thread periodically. + Sometimes it's possible to use the non-zero timeout variant of the + method, which then waits the specified number of milliseconds for + events, processing them immediately as they arrive. It achieves better + runtime behavior than separate sleeping/processing. + + + + + License information + + The sample code files shipped with the SDK are generally licensed + liberally to make it easy for anyone to use this code for their own + application code. + + The Java files under + bindings/webservice/java/jax-ws/ (library + files for the object-oriented web service) are, by contrast, licensed + under the GNU Lesser General Public License (LGPL) V2.1. + + See + sdk/bindings/webservice/java/jax-ws/src/COPYING.LIB + for the full text of the LGPL 2.1. + + When in doubt, please refer to the individual source code files + shipped with this SDK. + + + + Main API change log + + Generally, VirtualBox will maintain API compatibility within a major + release; a major release occurs when the first or the second of the three + version components of VirtualBox change (that is, in the x.y.z scheme, a + major release is one where x or y change, but not when only z + changes). + + In other words, updates like those from 2.0.0 to 2.0.2 will not come + with API breakages. + + Migration between major releases most likely will lead to API + breakage, so please make sure you updated code accordingly. The OOWS Java + wrappers enforce that mechanism by putting VirtualBox classes into + version-specific packages such as + org.virtualbox_2_2. This approach allows + for connecting to multiple VirtualBox versions simultaneously from the + same Java application. + + The following sections list incompatible changes that the Main API + underwent since the original release of this SDK Reference with VirtualBox + 2.0. A change is deemed "incompatible" only if it breaks existing client + code (e.g. changes in method parameter lists, renamed or removed + interfaces and similar). In other words, the list does not contain new + interfaces, methods or attributes or other changes that do not affect + existing client code. + + + Incompatible API changes with version 6.1 + + + + Split off the graphics adapter part of + IMachine into + IGraphicsAdapter. + This moved 5 attributes. + + + + + + + + Incompatible API changes with version 6.0 + + + + Video recording APIs were changed as follows: + + All attributes which were living in IMachine before + have been moved to an own, dedicated interface named IRecordingSettings. + This new interface can be accessed via the new IMachine::recordingSettings + attribute. This should emphasize that recording is not limited to video capturing as such. + + + For further flexibility all specific per-VM-screen settings have been moved to a new interface + called IRecordingScreenSettings. Such settings now exist per configured + VM display and can be retrieved via the IRecordingSettings::screens + attribute or the IRecordingSettings::getScreenSettings + method. + For now all screen settings will share the same settings, e.g. different settings on a per-screen basis + is not implemented yet. + + + + The event IVideoCaptureChangedEvent was renamed into + IRecordingChangedEvent. + + + + + + Guest Control APIs were changed as follows: + + IGuest::createSession(), + IGuestSession::processCreate(), + IGuestSession::processCreateEx(), + IGuestSession::directoryOpen() and + IGuestSession::fileOpen() now will + return the new error code VBOX_E_MAXIMUM_REACHED if the limit for the according object + group has been reached. + + + The enumerations FileOpenExFlags, FsObjMoveFlags and DirectoryCopyFlags have + been renamed to FileOpenExFlag, + FsObjMoveFlag and DirectoryCopyFlag + accordingly to match the rest of the API. + + + + The following methods have been implemented: + IGuestSession::directoryCopyFromGuest() and + IGuestSession::directoryCopyToGuest(). + + + The following attributes have been implemented: + IGuestFsObjInfo::accessTime, + IGuestFsObjInfo::birthTime, + IGuestFsObjInfo::changeTime and + IGuestFsObjInfo::modificationTime. + + + + + + + The webservice version of the ISharedFolder + interface was changed from a struct to a managed object. This causes incompatiblities on the + protocol level as the shared folder attributes are not returned in the responses of + IVirtualBox::getSharedFolders and + IMachine::getSharedFolders anymore. They + return object UUIDs instead which need be wrapped by stub objects. The change is not visible when + using the appropriate client bindings from the most recent VirtualBox SDK. + + + + + + + + Incompatible API changes with version 5.x + + + ProcessCreateFlag::NoProfile has been renamed to + ProcessCreateFlag::Profile, + whereas the semantics also has been changed: ProcessCreateFlag::NoProfile + explicitly did not utilize the guest user's profile data, + which in turn ProcessCreateFlag::Profile + explicitly does now. + + + + + + + Incompatible API changes with version 5.0 + + + + The methods for saving state, adopting a saved state file, + discarding a saved state, taking a snapshot, restoring + a snapshot and deleting a snapshot have been moved from + IConsole to + IMachine. This straightens out the + logical placement of methods and was necessary to resolve a + long-standing issue, preventing 32-bit API clients from invoking + those operations in the case where no VM is running. + + IMachine::saveState() + replaces + IConsole::saveState() + + + IMachine::adoptSavedState() + replaces + IConsole::adoptSavedState() + + + IMachine::discardSavedState() + replaces + IConsole::discardSavedState() + + + IMachine::takeSnapshot() + replaces + IConsole::takeSnapshot() + + + IMachine::deleteSnapshot() + replaces + IConsole::deleteSnapshot() + + + IMachine::deleteSnapshotAndAllChildren() + replaces + IConsole::deleteSnapshotAndAllChildren() + + + IMachine::deleteSnapshotRange() + replaces + IConsole::deleteSnapshotRange() + + + IMachine::restoreSnapshot() + replaces + IConsole::restoreSnapshot() + + + Small adjustments to the parameter lists have been made to reduce + the number of API calls when taking online snapshots (no longer + needs explicit pausing), and taking a snapshot also returns now + the snapshot id (useful for finding the right snapshot if there + are non-unique snapshot names). + + + + Two new machine states have been introduced to allow proper + distinction between saving state and taking a snapshot. + MachineState::Saving + now is used exclusively while the VM's state is being saved, without + any overlaps with snapshot functionality. The new state + MachineState::Snapshotting + is used when an offline snapshot is taken and likewise the new state + MachineState::OnlineSnapshotting + is used when an online snapshot is taken. + + + + A new event has been introduced, which signals when a snapshot + has been restored: + ISnapshotRestoredEvent. + Previously the event + ISnapshotDeletedEvent + was signalled, which isn't logical (but could be distinguished from + actual deletion by the fact that the snapshot was still + there). + + + + The method + IVirtualBox::createMedium() + replaces + VirtualBox::createHardDisk(). + Adjusting existing code needs adding two parameters with + value AccessMode_ReadWrite + and DeviceType_HardDisk + respectively. The new method supports creating floppy and + DVD images, and (less obviously) further API functionality + such as cloning floppy images. + + + + The method + IMachine::getStorageControllerByInstance() + now has an additional parameter (first parameter), for specifying the + storage bus which the storage controller must be using. The method + was not useful before, as the instance numbers are only unique for a + specfic storage bus. + + + + The attribute + IMachine::sessionType has been + renamed to + IMachine::sessionName(). + This cleans up the confusing terminology (as the session type is + something different). + + + + The attribute + IMachine::guestPropertyNotificationPatterns + has been removed. In practice it was not usable because it is too + global and didn't distinguish between API clients. + + + Drag and drop APIs were changed as follows: + + + Methods for providing host to guest drag and drop + functionality, such as + IGuest::dragHGEnter, + IGuest::dragHGMove(), + IGuest::dragHGLeave(), + IGuest::dragHGDrop() and + IGuest::dragHGPutData(), + have been moved to an abstract base class called + IDnDTarget. + VirtualBox implements this base class in the + IGuestDnDTarget + interface. The implementation can be used by using the + IGuest::dnDTarget() + method. + Methods for providing guest to host drag and drop + functionality, such as + IGuest::dragGHPending(), + IGuest::dragGHDropped() and + IGuest::dragGHGetData(), + have been moved to an abstract base class called + IDnDSource. + VirtualBox implements this base class in the + IGuestDnDSource + interface. The implementation can be used by using the + IGuest::dnDSource() + method. + + + + The DragAndDropAction + enumeration has been renamed to + DnDAction. + + + + The DragAndDropMode + enumeration has been renamed to + DnDMode. + + + + The attribute + IMachine::dragAndDropMode + has been renamed to + IMachine::dnDMode(). + + + + The event + IDragAndDropModeChangedEvent + has been renamed to + IDnDModeChangedEvent. + + + + + + IDisplay and IFramebuffer interfaces were changed to + allow IFramebuffer object to reside in a separate frontend + process: + + + IDisplay::ResizeCompleted() has been removed, because the + IFramebuffer object does not provide the screen memory anymore. + + + + IDisplay::SetFramebuffer() has been replaced with + IDisplay::AttachFramebuffer() and IDisplay::DetachFramebuffer(). + + + + IDisplay::GetFramebuffer() has been replaced with + IDisplay::QueryFramebuffer(). + + + + IDisplay::GetScreenResolution() has a new output parameter + guestMonitorStatus + which tells whether the monitor is enabled in the guest. + + + + IDisplay::TakeScreenShot() and IDisplay::TakeScreenShotToArray() + have a new parameter + bitmapFormat. As a consequence of + this, IDisplay::TakeScreenShotPNGToArray() has been removed. + + + + IFramebuffer::RequestResize() has been replaced with + IFramebuffer::NotifyChange(). + + + + IFramebuffer::NotifyUpdateImage() added to support IFramebuffer + objects in a different process. + + + + IFramebuffer::Lock(), IFramebuffer::Unlock(), + IFramebuffer::Address(), IFramebuffer::UsesGuestVRAM() have been + removed because the IFramebuffer object does not provide the screen + memory anymore. + + + + + + IGuestSession, IGuestFile and IGuestProcess interfaces + were changed as follows: + + + Replaced IGuestSession::directoryQueryInfo and + IGuestSession::fileQueryInfo with a new + IGuestSession::fsObjQueryInfo + method that works on any type of file system object. + + + Replaced IGuestSession::fileRemove, + IGuestSession::symlinkRemoveDirectory and + IGuestSession::symlinkRemoveFile with a new + IGuestSession::fsObjRemove + method that works on any type of file system object except + directories. (fileRemove also worked on any type of object + too, though that was not the intent of the method.) + + + Replaced IGuestSession::directoryRename and + IGuestSession::directoryRename with a new + IGuestSession::fsObjRename + method that works on any type of file system object. + (directoryRename and fileRename may already have worked for + any kind of object, but that was never the intent of the + methods.) + + + Replaced the unimplemented IGuestSession::directorySetACL + and IGuestSession::fileSetACL with a new + IGuestSession::fsObjSetACL + method that works on all type of file system object. Also + added a UNIX-style mode parameter as an alternative to the + ACL. + + + Replaced IGuestSession::fileRemove, + IGuestSession::symlinkRemoveDirectory and + IGuestSession::symlinkRemoveFile with a new + IGuestSession::fsObjRemove + method that works on any type of file system object except + directories (fileRemove also worked on any type of object, + though that was not the intent of the method.) + + + Renamed IGuestSession::copyTo to + IGuestSession::fileCopyToGuest. + + + Renamed IGuestSession::copyFrom to + IGuestSession::fileCopyFromGuest. + + + Renamed the CopyFileFlag enum to + FileCopyFlag. + + + Renamed the IGuestSession::environment attribute to + IGuestSession::environmentChanges + to better reflect what it does. + + + Changed the + IGuestProcess::environment + to a stub returning E_NOTIMPL since it wasn't doing what was + advertised (returned changes, not the actual environment). + + + Renamed IGuestSession::environmentSet to + IGuestSession::environmentScheduleSet + to better reflect what it does. + + + Renamed IGuestSession::environmentUnset to + IGuestSession::environmentScheduleUnset + to better reflect what it does. + + + Removed IGuestSession::environmentGet it was only getting + changes while giving the impression it was actual environment + variables, and it did not represent scheduled unset + operations. + + + Removed IGuestSession::environmentClear as it duplicates + assigning an empty array to the + IGuestSession::environmentChanges + (formerly known as IGuestSession::environment). + + + Changed the + IGuestSession::processCreate + and + IGuestSession::processCreateEx + methods to accept arguments starting with argument zero (argv[0]) + instead of argument one (argv[1]). (Not yet implemented on the + guest additions side, so argv[0] will probably be ignored for a + short while.) + + + + Added a followSymlink parameter to the following methods: + + IGuestSession::directoryExists + IGuestSession::fileExists + IGuestSession::fileQuerySize + + + + The parameters to the + IGuestSession::fileOpen + and + IGuestSession::fileOpenEx + methods were altered: + The openMode string parameter was replaced by + the enum + FileAccessMode + and renamed to accessMode. + The disposition string parameter was replaced + by the enum + FileOpenAction + and renamed to openAction. + The unimplemented sharingMode string parameter + was replaced by the enum + FileSharingMode + (fileOpenEx only). + Added a flags parameter taking a list of + FileOpenExFlag values + (fileOpenEx only). + Removed the offset parameter (fileOpenEx + only). + + + + + IGuestFile::seek now + returns the new offset. + + + Renamed the FileSeekType enum used by + IGuestFile::seek + to FileSeekOrigin and + added the missing End value and renaming the Set to + Begin. + + + Extended the unimplemented + IGuestFile::setACL + method with a UNIX-style mode parameter as an alternative to + the ACL. + + + Renamed the IFile::openMode attribute to + IFile::accessMode + and change the type from string to + FileAccessMode to reflect + the changes to the fileOpen methods. + + + Renamed the IGuestFile::disposition attribute to + IFile::openAction and + change the type from string to + FileOpenAction to reflect + the changes to the fileOpen methods. + + + + + Added + IGuestSession::pathStyle + attribute. + + + Added + IGuestSession::fsObjExists + attribute. + + + + + + + + IConsole::GetDeviceActivity() returns information about multiple + devices. + + + + IMachine::ReadSavedThumbnailToArray() has a new parameter + bitmapFormat. As a consequence of + this, IMachine::ReadSavedThumbnailPNGToArray() has been removed. + + + + IMachine::QuerySavedScreenshotPNGSize() has been renamed to + IMachine::QuerySavedScreenshotInfo() which also returns + an array of available screenshot formats. + + + + IMachine::ReadSavedScreenshotPNGToArray() has been renamed to + IMachine::ReadSavedScreenshotToArray() which has a new parameter + bitmapFormat. + + + + IMachine::QuerySavedThumbnailSize() has been removed. + + + + The method + IWebsessionManager::getSessionObject() + now returns a new ISession instance + for every invocation. This puts the behavior in line with other + binding styles, which never forced the equivalent of establishing + another connection and logging in again to get another + instance. + + + + + + Incompatible API changes with version 4.3 + + + + The explicit medium locking methods + IMedium::lockRead() + and IMedium::lockWrite() + have been redesigned. They return a lock token object reference + now, and calling the + IToken::abandon() method (or + letting the reference count to this object drop to 0) will unlock + it. This eliminates the rather common problem that an API client + crash left behind locks, and also improves the safety (API clients + can't release locks they didn't obtain). + + + + The parameter list of + IAppliance::write() + has been changed slightly, to allow multiple flags to be + passed. + + + + IMachine::delete + has been renamed to + IMachine::deleteConfig(), + to improve API client binding compatibility. + + + + IMachine::export + has been renamed to + IMachine::exportTo(), + to improve API client binding compatibility. + + + + For + IMachine::launchVMProcess() + the meaning of the type parameter + has changed slightly. Empty string now means that the per-VM or + global default frontend is launched. Most callers of this method + should use the empty string now, unless they really want to override + the default and launch a particular frontend. + + + + Medium management APIs were changed as follows: + + + The type of attribute + IMedium::variant() + changed from unsigned long + to safe-array MediumVariant. + It is an array of flags instead of a set of flags which were + stored inside one variable. + + + + + The parameter list for + IMedium::cloneTo() + was modified. The type of parameter variant was changed from + unsigned long to safe-array MediumVariant. + + + + + The parameter list for + IMedium::createBaseStorage() + was modified. The type of parameter variant was changed from + unsigned long to safe-array MediumVariant. + + + + + The parameter list for + IMedium::createDiffStorage() + was modified. The type of parameter variant was changed from + unsigned long to safe-array MediumVariant. + + + + + The parameter list for + IMedium::cloneToBase() + was modified. The type of parameter variant was changed from + unsigned long to safe-array MediumVariant. + + + + + + + The type of attribute + IMediumFormat::capabilities() + changed from unsigned long to + safe-array MediumFormatCapabilities. + It is an array of flags instead of a set of flags which were stored + inside one variable. + + + + + The attribute + IMedium::logicalSize() + now returns the logical size of exactly this medium object (whether + it is a base or diff image). The old behavior was no longer + acceptable, as each image can have a different capacity. + + + + Guest control APIs - such as + IGuest, + IGuestSession, + IGuestProcess and so on - now + emit own events to provide clients much finer control and the ability + to write own frontends for guest operations. The event + IGuestSessionEvent acts as + an abstract base class for all guest control events. Certain guest + events contain a + IVirtualBoxErrorInfo + member to provide more information in case of an error happened on + the guest side. + + + + Guest control sessions on the guest started by + IGuest::createSession() + now are dedicated guest processes to provide more safety and + performance for certain operations. Also, the + IGuest::createSession() + call does not wait for the guest session being created anymore due + to the dedicated guest session processes just mentioned. This also + will enable webservice clients to handle guest session creation + more gracefully. To wait for a guest session being started, use the + newly added attribute + IGuestSession::status() + to query the current guest session status. + + + + The IGuestFile + APIs are now implemented to provide native guest file access from + the host. + + + + The parameter list for + IMedium::updateGuestAdditions() + was modified. It now supports specifying optional command line + arguments for the Guest Additions installer performing the actual + update on the guest. + + + + + A new event + IGuestUserStateChangedEvent + was introduced to provide guest user status updates to the host via + event listeners. To use this event there needs to be at least the 4.3 + Guest Additions installed on the guest. At the moment only the states + "Idle" and "InUse" of the + GuestUserState enumeration arei + supported on Windows guests, starting at Windows 2000 SP2. + + + + + The attribute + IGuestSession::protocolVersion + was added to provide a convenient way to lookup the guest session's + protocol version it uses to communicate with the installed Guest + Additions on the guest. Older Guest Additions will set the protocol + version to 1, whereas Guest Additions 4.3 will set the protocol + version to 2. This might change in the future as new features + arise. + + + + IDisplay::getScreenResolution + has been extended to return the display position in the guest. + + + + + The IUSBController + class is not a singleton of + IMachine anymore but + IMachine contains a list of USB + controllers present in the VM. The USB device filter handling was + moved to + IUSBDeviceFilters. + + + + + + + Incompatible API changes with version 4.2 + + + + Guest control APIs for executing guest processes, working with + guest files or directories have been moved to the newly introduced + IGuestSession interface which + can be created by calling + IGuest::createSession(). + + A guest session will act as a + guest user's impersonation so that the guest credentials only have to + be provided when creating a new guest session. There can be up to 32 + guest sessions at once per VM, each session serving up to 2048 guest + processes running or files opened. + + Instead of working with process or directory handles before + version 4.2, there now are the dedicated interfaces + IGuestProcess, + IGuestDirectory and + IGuestFile. To retrieve more + information of a file system object the new interface + IGuestFsObjInfo has been + introduced. + + Even though the guest control API was changed it is backwards + compatible so that it can be used with older installed Guest + Additions. However, to use upcoming features like process termination + or waiting for input / output new Guest Additions must be installed + when these features got implemented. + + The following limitations apply: + + The IGuestFile + interface is not fully implemented yet. + + The symbolic link APIs + IGuestSession::symlinkCreate(), + IGuestSession::symlinkExists(), + IGuestSession::symlinkRead(), + IGuestSession::symlinkRemoveDirectory() and + IGuestSession::symlinkRemoveFile() are not + implemented yet. + + The directory APIs + IGuestSession::directoryRemove(), + IGuestSession::directoryRemoveRecursive(), + IGuestSession::directoryRename() and + IGuestSession::directorySetACL() are not + implemented yet. + + The temporary file creation API + IGuestSession::fileCreateTemp() + is not implemented yet. + + Guest process termination via + IProcess::terminate() + is not implemented yet. + + Waiting for guest process output via + ProcessWaitForFlag::StdOut + and + ProcessWaitForFlag::StdErr + is not implemented yet. + To wait for process output, + IProcess::read() with + appropriate flags still can be used to periodically check for + new output data to arrive. Note that + ProcessCreateFlag::WaitForStdOut + and / or + ProcessCreateFlag::WaitForStdErr + need to be specified when creating a guest process via + IGuestSession::processCreate() + or + IGuestSession::processCreateEx(). + + + ACL (Access Control List) handling in general is not + implemented yet. + + + + + + + The LockType + enumeration now has an additional value + VM which tells + IMachine::lockMachine() + to create a full-blown object structure for running a VM. This was + the previous behavior with Write, + which now only creates the minimal object structure to save time and + resources (at the moment the Console object is still created, but all + sub-objects such as Display, Keyboard, Mouse, Guest are not. + + + + Machines can be put in groups (actually an array of groups). + The primary group affects the default placement of files belonging + to a VM. + IVirtualBox::createMachine() + and + IVirtualBox::composeMachineFilename() + have been adjusted accordingly, the former taking an array of groups + as an additional parameter and the latter taking a group as an + additional parameter. The create option handling has been changed for + those two methods, too. + + + + The method IVirtualBox::findMedium() has been removed, since + it provides a subset of the functionality of + IVirtualBox::openMedium(). + + + + The use of acronyms in API enumeration, interface, attribute + and method names has been made much more consistent, previously they + sometimes were lowercase and sometimes mixed case. They are now + consistently all caps: + Renamed identifiers in VirtualBox 4.2 + + + + + Old name + + New name + + + PointingHidType + PointingHIDType + + + KeyboardHidType + KeyboardHIDType + + + IPciAddress + IPCIAddress + + + IPciDeviceAttachment + IPCIDeviceAttachment + + + IMachine::pointingHidType + IMachine::pointingHIDType + + + IMachine::keyboardHidType + IMachine::keyboardHIDType + + + IMachine::hpetEnabled + IMachine::HPETEnabled + + + IMachine::sessionPid + IMachine::sessionPID + + + IMachine::ioCacheEnabled + IMachine::IOCacheEnabled + + + IMachine::ioCacheSize + IMachine::IOCacheSize + + + IMachine::pciDeviceAssignments + IMachine::PCIDeviceAssignments + + + IMachine::attachHostPciDevice() + IMachine::attachHostPCIDevice + + + IMachine::detachHostPciDevice() + IMachine::detachHostPCIDevice() + + + IConsole::attachedPciDevices + IConsole::attachedPCIDevices + + + IHostNetworkInterface::dhcpEnabled + IHostNetworkInterface::DHCPEnabled + + + IHostNetworkInterface::enableStaticIpConfig() + IHostNetworkInterface::enableStaticIPConfig() + + + IHostNetworkInterface::enableStaticIpConfigV6() + IHostNetworkInterface::enableStaticIPConfigV6() + + + IHostNetworkInterface::enableDynamicIpConfig() + IHostNetworkInterface::enableDynamicIPConfig() + + + IHostNetworkInterface::dhcpRediscover() + IHostNetworkInterface::DHCPRediscover() + + + IHost::Acceleration3DAvailable + IHost::acceleration3DAvailable + + + IGuestOSType::recommendedPae + IGuestOSType::recommendedPAE + + + IGuestOSType::recommendedDvdStorageController + IGuestOSType::recommendedDVDStorageController + + + IGuestOSType::recommendedDvdStorageBus + IGuestOSType::recommendedDVDStorageBus + + + IGuestOSType::recommendedHdStorageController + IGuestOSType::recommendedHDStorageController + + + IGuestOSType::recommendedHdStorageBus + IGuestOSType::recommendedHDStorageBus + + + IGuestOSType::recommendedUsbHid + IGuestOSType::recommendedUSBHID + + + IGuestOSType::recommendedHpet + IGuestOSType::recommendedHPET + + + IGuestOSType::recommendedUsbTablet + IGuestOSType::recommendedUSBTablet + + + IGuestOSType::recommendedRtcUseUtc + IGuestOSType::recommendedRTCUseUTC + + + IGuestOSType::recommendedUsb + IGuestOSType::recommendedUSB + + + INetworkAdapter::natDriver + INetworkAdapter::NATEngine + + + IUSBController::enabledEhci + IUSBController::enabledEHCI" + + + INATEngine::tftpPrefix + INATEngine::TFTPPrefix + + + INATEngine::tftpBootFile + INATEngine::TFTPBootFile + + + INATEngine::tftpNextServer + INATEngine::TFTPNextServer + + + INATEngine::dnsPassDomain + INATEngine::DNSPassDomain + + + INATEngine::dnsProxy + INATEngine::DNSProxy + + + INATEngine::dnsUseHostResolver + INATEngine::DNSUseHostResolver + + + VBoxEventType::OnHostPciDevicePlug + VBoxEventType::OnHostPCIDevicePlug + + + ICPUChangedEvent::cpu + ICPUChangedEvent::CPU + + + INATRedirectEvent::hostIp + INATRedirectEvent::hostIP + + + INATRedirectEvent::guestIp + INATRedirectEvent::guestIP + + + IHostPciDevicePlugEvent + IHostPCIDevicePlugEvent + + +
+ + + + + + Incompatible API changes with version 4.1 + + + + The method + IAppliance::importMachines() + has one more parameter now, which allows to configure the import + process in more detail. + + + + + The method + IVirtualBox::openMedium() + has one more parameter now, which allows resolving duplicate medium + UUIDs without the need for external tools. + + + + The INetworkAdapter + interface has been cleaned up. The various methods to activate an + attachment type have been replaced by the + INetworkAdapter::attachmentType + setter. + Additionally each attachment mode now has its own attribute, + which means that host only networks no longer share the settings with + bridged interfaces. + To allow introducing new network attachment implementations + without making API changes, the concept of a generic network + attachment driver has been introduced, which is configurable through + key/value properties. + + + + This version introduces the guest facilities concept. A guest + facility either represents a module or feature the guest is running + or offering, which is defined by + AdditionsFacilityType. + Each facility is member of a + AdditionsFacilityClass + and has a current status indicated by + AdditionsFacilityStatus, + together with a timestamp (in ms) of the last status update. + To address the above concept, the following changes were made: + + + + In the IGuest interface, the + following were removed: + + + the + supportsSeamless + attribute; + + + the + supportsGraphics + attribute; + + + + + + + The function + IGuest::getFacilityStatus() + was added. It quickly provides a facility's status without + the need to get the facility collection with + IGuest::facilities. + + + + + The attribute + IGuest::facilities + was added to provide an easy to access collection of all + currently known guest facilities, that is, it contains all + facilies where at least one status update was made since the + guest was started. + + + + + The interface + IAdditionsFacility + was added to represent a single facility returned by + IGuest::facilities. + + + + + AdditionsFacilityStatus + was added to represent a facility's overall status. + + + + + AdditionsFacilityType and + AdditionsFacilityClass were + added to represent the facility's type and class. + + + + + + + + + + Incompatible API changes with version 4.0 + + + + A new Java glue layer replacing the previous OOWS JAX-WS + bindings was introduced. The new library allows for uniform code + targeting both local (COM/XPCOM) and remote (SOAP) transports. Now, + instead of IWebsessionManager, the + new class VirtualBoxManager must be + used. See for details. + + + + The confusingly named and impractical session APIs were + changed. In existing client code, the following changes need to be + made: + + Replace any + IVirtualBox::openSession(uuidMachine, + ...) API call with the machine's + IMachine::lockMachine() + call and a + LockType.Write argument. The + functionality is unchanged, but instead of "opening a direct + session on a machine" all documentation now refers to + "obtaining a write lock on a machine for the client + session". + + + + Similarly, replace any + IVirtualBox::openExistingSession(uuidMachine, + ...) call with the machine's + IMachine::lockMachine() + call and a LockType.Shared + argument. Whereas it was previously impossible to connect a + client session to a running VM process in a race-free manner, + the new API will atomically either write-lock the machine for + the current session or establish a remote link to an existing + session. Existing client code which tried calling both + openSession() and + openExistingSession() can now + use this one call instead. + + + + Third, replace any + IVirtualBox::openRemoteSession(uuidMachine, + ...) call with the machine's + IMachine::launchVMProcess() + call. The functionality is unchanged. + + + + The SessionState enum + was adjusted accordingly: "Open" is now "Locked", "Closed" is + now "Unlocked", "Closing" is now "Unlocking". + + + + + + Virtual machines created with VirtualBox 4.0 or later no + longer register their media in the global media registry in the + VirtualBox.xml file. Instead, such + machines list all their media in their own machine XML files. As a + result, a number of media-related APIs had to be modified again. + + + Neither + IVirtualBox::createHardDisk() + nor + IVirtualBox::openMedium() + register media automatically any more. + + + + IMachine::attachDevice() + and + IMachine::mountMedium() + now take an IMedium object instead of a UUID as an argument. It + is these two calls which add media to a registry now (either a + machine registry for machines created with VirtualBox 4.0 or + later or the global registry otherwise). As a consequence, if a + medium is opened but never attached to a machine, it is no + longer added to any registry any more. + + + + To reduce code duplication, the APIs + IVirtualBox::findHardDisk(), getHardDisk(), findDVDImage(), + getDVDImage(), findFloppyImage() and getFloppyImage() have all + been merged into IVirtualBox::findMedium(), and + IVirtualBox::openHardDisk(), openDVDImage() and + openFloppyImage() have all been merged into + IVirtualBox::openMedium(). + + + + The rare use case of changing the UUID and parent UUID + of a medium previously handled by + openHardDisk() is now in a + separate IMedium::setIDs method. + + + + ISystemProperties::get/setDefaultHardDiskFolder() + have been removed since disk images are now by default placed + in each machine's folder. + + + + The + ISystemProperties::infoVDSize + attribute replaces the + getMaxVDISize() + API call; this now uses bytes instead of megabytes. + + + + + + Machine management APIs were enhanced as follows: + + IVirtualBox::createMachine() + is no longer restricted to creating machines in the default + "Machines" folder, but can now create machines at arbitrary + locations. For this to work, the parameter list had to be + changed. + + + + The long-deprecated + IVirtualBox::createLegacyMachine() + API has been removed. + + + + To reduce code duplication and for consistency with the + aforementioned media APIs, + IVirtualBox::getMachine() has + been merged with + IVirtualBox::findMachine(), + and + IMachine::getSnapshot() has + been merged with + IMachine::findSnapshot(). + + + + IVirtualBox::unregisterMachine() + was replaced with + IMachine::unregister() + with additional functionality for cleaning up machine + files. + + + + IMachine::deleteSettings + has been replaced by IMachine::delete, which allows specifying + which disk images are to be deleted as part of the deletion, + and because it can take a while it also returns a + IProgress object reference, + so that the completion of the asynchronous activities can be + monitored. + + + + IConsole::forgetSavedState + has been renamed to + IConsole::discardSavedState(). + + + + + + All event callbacks APIs were replaced with a new, generic + event mechanism that can be used both locally (COM, XPCOM) and + remotely (web services). Also, the new mechanism is usable from + scripting languages and a local Java. See + events for details. The new concept + will require changes to all clients that used event callbacks. + + + + additionsActive() was replaced + with + additionsRunLevel() + and + getAdditionsStatus() + in order to support a more detailed status of the current Guest + Additions loading/readiness state. + IGuest::additionsVersion() + no longer returns the Guest Additions interface version but the + installed Guest Additions version and revision in form of + 3.3.0r12345. + + + + To address shared folders auto-mounting support, the following + APIs were extended to require an additional + automount parameter: + + IVirtualBox::createSharedFolder() + + + + IMachine::createSharedFolder() + + + + IConsole::createSharedFolder() + + Also, a new property named + autoMount was added to the + ISharedFolder + interface. + + + + The appliance (OVF) APIs were enhanced as + follows: + + IMachine::export + received an extra parameter + location, which is used to + decide for the disk naming. + + + + IAppliance::write() + received an extra parameter + manifest, which can suppress + creating the manifest file on export. + + + + IVFSExplorer::entryList() + received two extra parameters + sizes and + modes, which contains the + sizes (in bytes) and the file access modes (in octal form) of + the returned files. + + + + + + Support for remote desktop access to virtual machines has been + cleaned up to allow third party implementations of the remote + desktop server. This is called the VirtualBox Remote Desktop + Extension (VRDE) and can be added to VirtualBox by installing the + corresponding extension package; see the VirtualBox User Manual for + details. + + The following API changes were made to support the VRDE + interface: + + IVRDPServer has been + renamed to + IVRDEServer. + + + + IRemoteDisplayInfo has + been renamed to + IVRDEServerInfo. + + + + IMachine::VRDEServer + replaces + VRDPServer. + + + + IConsole::VRDEServerInfo + replaces + RemoteDisplayInfo. + + + + ISystemProperties::VRDEAuthLibrary + replaces + RemoteDisplayAuthLibrary. + + + + The following methods have been implemented in + IVRDEServer to support + generic VRDE properties: + + IVRDEServer::setVRDEProperty + + + + IVRDEServer::getVRDEProperty + + + + IVRDEServer::VRDEProperties + + + + A few implementation-specific attributes of the old + IVRDPServer interface have + been removed and replaced with properties: + + IVRDPServer::Ports + has been replaced with the + "TCP/Ports" property. + The property value is a string, which contains a + comma-separated list of ports or ranges of ports. Use a + dash between two port numbers to specify a range. + Example: + "5000,5010-5012" + + + + IVRDPServer::NetAddress + has been replaced with the + "TCP/Address" property. + The property value is an IP address string. Example: + "127.0.0.1" + + + + IVRDPServer::VideoChannel + has been replaced with the + "VideoChannel/Enabled" + property. The property value is either + "true" or + "false" + + + + IVRDPServer::VideoChannelQuality + has been replaced with the + "VideoChannel/Quality" + property. The property value is a string which contain a + decimal number in range 10..100. Invalid values are + ignored and the quality is set to the default value 75. + Example: "50" + + + + + + + + The VirtualBox external authentication module interface has + been updated and made more generic. Because of that, + VRDPAuthType enumeration has been + renamed to AuthType. + + + + + + Incompatible API changes with version 3.2 + + + + The following interfaces were renamed for consistency: + + + IMachine::getCpuProperty() is now + IMachine::getCPUProperty(); + + + + IMachine::setCpuProperty() is now + IMachine::setCPUProperty(); + + + + IMachine::getCpuIdLeaf() is now + IMachine::getCPUIDLeaf(); + + + + IMachine::setCpuIdLeaf() is now + IMachine::setCPUIDLeaf(); + + + + IMachine::removeCpuIdLeaf() is now + IMachine::removeCPUIDLeaf(); + + + + IMachine::removeAllCpuIdLeafs() is now + IMachine::removeAllCPUIDLeaves(); + + + + the CpuPropertyType enum is now + CPUPropertyType. + + + + IVirtualBoxCallback::onSnapshotDiscarded() is now + IVirtualBoxCallback::onSnapshotDeleted. + + + + + + When creating a VM configuration with + IVirtualBox::createMachine() + it is now possible to ignore existing configuration files which would + previously have caused a failure. For this the + override parameter was added. + + + + Deleting snapshots via + IConsole::deleteSnapshot() is now + possible while the associated VM is running in almost all cases. + The API is unchanged, but client code that verifies machine states + to determine whether snapshots can be deleted may need to be + adjusted. + + + + The IoBackendType enumeration was replaced with a boolean flag + (see + IStorageController::useHostIOCache). + + + + To address multi-monitor support, the following APIs were + extended to require an additional + screenId parameter: + + IMachine::querySavedThumbnailSize() + + + + IMachine::readSavedThumbnailToArray() + + + + IMachine::querySavedScreenshotPNGSize() + + + + IMachine::readSavedScreenshotPNGToArray() + + + + + + The shape parameter of + IConsoleCallback::onMousePointerShapeChange was changed from a + implementation-specific pointer to a safearray, enabling scripting + languages to process pointer shapes. + + + + + + Incompatible API changes with version 3.1 + + + + Due to the new flexibility in medium attachments that was + introduced with version 3.1 (in particular, full flexibility with + attaching CD/DVD drives to arbitrary controllers), we seized the + opportunity to rework all interfaces dealing with storage media to + make the API more flexible as well as logical. The + IStorageController, + IMedium, + IMediumAttachment and + IMachine interfaces were + affected the most. Existing code using them to configure storage and + media needs to be carefully checked. + + All media (hard disks, floppies and CDs/DVDs) are now + uniformly handled through the IMedium + interface. The device-specific interfaces + (IHardDisk, IDVDImage, + IHostDVDDrive, IFloppyImage and + IHostFloppyDrive) have been merged into IMedium; CD/DVD + and floppy media no longer need special treatment. The device type + of a medium determines in which context it can be used. Some + functionality was moved to the other storage-related + interfaces. + + IMachine::attachHardDisk and similar methods have + been renamed and generalized to deal with any type of drive and + medium. + IMachine::attachDevice() + is the API method for adding any drive to a storage controller. The + floppy and DVD/CD drives are no longer handled specially, and that + means you can have more than one of them. As before, drives can only + be changed while the VM is powered off. Mounting (or unmounting) + removable media at runtime is possible with + IMachine::mountMedium(). + + Newly created virtual machines have no storage controllers + associated with them. Even the IDE Controller needs to be created + explicitly. The floppy controller is now visible as a separate + controller, with a new storage bus type. For each storage bus type + you can query the device types which can be attached, so that it is + not necessary to hardcode any attachment rules. + + This required matching changes e.g. in the callback interfaces + (the medium specific change notification was replaced by a generic + medium change notification) and removing associated enums (e.g. + DriveState). In many places the incorrect use of the + plural form "media" was replaced by "medium", to improve + consistency. + + + + Reading the + IMedium::state attribute no + longer automatically performs an accessibility check; a new method + IMedium::refreshState() + does this. The attribute only returns the state now. + + + + There were substantial changes related to snapshots, triggered + by the "branched snapshots" functionality introduced with version + 3.1. IConsole::discardSnapshot was renamed to + IConsole::deleteSnapshot(). + IConsole::discardCurrentState and + IConsole::discardCurrentSnapshotAndState were removed; corresponding + new functionality is in + IConsole::restoreSnapshot(). + Also, when IConsole::takeSnapshot() + is called on a running virtual machine, a live snapshot will be + created. The old behavior was to temporarily pause the virtual + machine while creating an online snapshot. + + + + The IVRDPServer, + IRemoteDisplayInfo" and + IConsoleCallback interfaces were + changed to reflect VRDP server ability to bind to one of available + ports from a list of ports. + + The IVRDPServer::port + attribute has been replaced with + IVRDPServer::ports, which is a + comma-separated list of ports or ranges of ports. + + An IRemoteDisplayInfo::port" + attribute has been added for querying the actual port VRDP server + listens on. + + An IConsoleCallback::onRemoteDisplayInfoChange() notification + callback has been added. + + + + The parameter lists for the following functions were + modified: + + IHost::removeHostOnlyNetworkInterface() + + + + IHost::removeUSBDeviceFilter() + + + + + + In the OOWS bindings for JAX-WS, the behavior of structures + changed: for one, we implemented natural structures field access so + you can just call a "get" method to obtain a field. Secondly, + setters in structures were disabled as they have no expected effect + and were at best misleading. + + + + + + Incompatible API changes with version 3.0 + + + + In the object-oriented web service bindings for JAX-WS, proper + inheritance has been introduced for some classes, so explicit + casting is no longer needed to call methods from a parent class. In + particular, IHardDisk and other classes now properly derive from + IMedium. + + + + All object identifiers (machines, snapshots, disks, etc) + switched from GUIDs to strings (now still having string + representation of GUIDs inside). As a result, no particular internal + structure can be assumed for object identifiers; instead, they + should be treated as opaque unique handles. This change mostly + affects Java and C++ programs; for other languages, GUIDs are + transparently converted to strings. + + + + The uses of NULL strings have been changed greatly. All out + parameters now use empty strings to signal a null value. For in + parameters both the old NULL and empty string is allowed. This + change was necessary to support more client bindings, especially + using the web service API. Many of them either have no special NULL + value or have trouble dealing with it correctly in the respective + library code. + + + + Accidentally, the TSBool interface still appeared + in 3.0.0, and was removed in 3.0.2. This is an SDK bug, do not use + the SDK for VirtualBox 3.0.0 for developing clients. + + + + The type of + IVirtualBoxErrorInfo::resultCode + changed from + result to + long. + + + + The parameter list of IVirtualBox::openHardDisk was + changed. + + + + The method IConsole::discardSavedState was renamed to + IConsole::forgetSavedState, and a parameter was added. + + + + The method IConsole::powerDownAsync was renamed to + IConsole::powerDown, + and the previous method with that name was deleted. So effectively a + parameter was added. + + + + In the + IFramebuffer interface, the + following were removed: + + the operationSupported + attribute; + + (as a result, the + FramebufferAccelerationOperation + enum was no longer needed and removed as well); + + + + the solidFill() + method; + + + + the copyScreenBits() + method. + + + + + + In the IDisplay + interface, the following were removed: + + the + setupInternalFramebuffer() + method; + + + + the lockFramebuffer() + method; + + + + the unlockFramebuffer() + method; + + + + the + registerExternalFramebuffer() + method. + + + + + + + + Incompatible API changes with version 2.2 + + + + Added explicit version number into JAX-WS Java package names, + such as org.virtualbox_2_2, + allowing connect to multiple VirtualBox clients from single Java + application. + + + + The interfaces having a "2" suffix attached to them with + version 2.1 were renamed again to have that suffix removed. This + time around, this change involves only the name, there are no + functional differences. + + As a result, IDVDImage2 is now IDVDImage; IHardDisk2 is now + IHardDisk; IHardDisk2Attachment is now IHardDiskAttachment. + + Consequentially, all related methods and attributes that had a + "2" suffix have been renamed; for example, IMachine::attachHardDisk2 + now becomes IMachine::attachHardDisk(). + + + + IVirtualBox::openHardDisk has an extra parameter for opening a + disk read/write or read-only. + + + + The remaining collections were replaced by more performant + safe-arrays. This affects the following collections: + + + + IGuestOSTypeCollection + + + + IHostDVDDriveCollection + + + + IHostFloppyDriveCollection + + + + IHostUSBDeviceCollection + + + + IHostUSBDeviceFilterCollection + + + + IProgressCollection + + + + ISharedFolderCollection + + + + ISnapshotCollection + + + + IUSBDeviceCollection + + + + IUSBDeviceFilterCollection + + + + + + Since "Host Interface Networking" was renamed to "bridged + networking" and host-only networking was introduced, all associated + interfaces needed renaming as well. In detail: + + + + The HostNetworkInterfaceType enum has been renamed to + HostNetworkInterfaceMediumType + + + + The IHostNetworkInterface::type attribute has been renamed + to + IHostNetworkInterface::mediumType + + + + INetworkAdapter::attachToHostInterface() has been renamed + to INetworkAdapter::attachToBridgedInterface + + + + In the IHost interface, createHostNetworkInterface() has + been renamed to + createHostOnlyNetworkInterface() + + + + Similarly, removeHostNetworkInterface() has been renamed + to + removeHostOnlyNetworkInterface() + + + + + + + + Incompatible API changes with version 2.1 + + + + With VirtualBox 2.1, error codes were added to many error + infos that give the caller a machine-readable (numeric) feedback in + addition to the error string that has always been available. This is + an ongoing process, and future versions of this SDK reference will + document the error codes for each method call. + + + + The hard disk and other media interfaces were completely + redesigned. This was necessary to account for the support of VMDK, + VHD and other image types; since backwards compatibility had to be + broken anyway, we seized the moment to redesign the interfaces in a + more logical way. + + + + Previously, the old IHardDisk interface had several + derivatives called IVirtualDiskImage, IVMDKImage, IVHDImage, + IISCSIHardDisk and ICustomHardDisk for the various disk formats + supported by VirtualBox. The new IHardDisk2 interface that comes + with version 2.1 now supports all hard disk image formats + itself. + + + + IHardDiskFormat is a new interface to describe the + available back-ends for hard disk images (e.g. VDI, VMDK, VHD or + iSCSI). The IHardDisk2::format attribute can be used to find out + the back-end that is in use for a particular hard disk image. + ISystemProperties::hardDiskFormats[] contains a list of all + back-ends supported by the system. + ISystemProperties::defaultHardDiskFormat + contains the default system format. + + + + In addition, the new + IMedium interface is a generic + interface for hard disk, DVD and floppy images that contains the + attributes and methods shared between them. It can be considered + a parent class of the more specific interfaces for those images, + which are now IHardDisk2, IDVDImage2 and IFloppyImage2. + + In each case, the "2" versions of these interfaces replace + the earlier versions that did not have the "2" suffix. + Previously, the IDVDImage and IFloppyImage interfaces were + entirely unrelated to IHardDisk. + + + + As a result, all parts of the API that previously + referenced IHardDisk, IDVDImage or IFloppyImage or any of the + old subclasses are gone and will have replacements that use + IHardDisk2, IDVDImage2 and IFloppyImage2; see, for example, + IMachine::attachHardDisk2. + + + + In particular, the IVirtualBox::hardDisks2 array replaces + the earlier IVirtualBox::hardDisks collection. + + + + + + IGuestOSType was + extended to group operating systems into families and for 64-bit + support. + + + + The + IHostNetworkInterface + interface was completely rewritten to account for the changes in how + Host Interface Networking is now implemented in VirtualBox + 2.1. + + + + The IVirtualBox::machines2[] array replaces the former + IVirtualBox::machines collection. + + + + Added + IHost::getProcessorFeature() + and ProcessorFeature + enumeration. + + + + The parameter list for + IVirtualBox::createMachine() + was modified. + + + + Added IMachine::pushGuestProperty. + + + + New attributes in IMachine: accelerate3DEnabled, + HWVirtExVPIDEnabled, + IMachine::guestPropertyNotificationPatterns, + CPUCount. + + + + Added + IConsole::powerUpPaused() + and + IConsole::getGuestEnteredACPIMode(). + + + + Removed ResourceUsage enumeration. + + + + + + diff --git a/doc/manual/en_US/UserManual.xml b/doc/manual/en_US/UserManual.xml new file mode 100644 index 00000000..278faed6 --- /dev/null +++ b/doc/manual/en_US/UserManual.xml @@ -0,0 +1,90 @@ + + +%all.entities; +]> + + + + + + + &VBOX_PRODUCT; + + User Manual + + Version &VBOX_VERSION_STRING; + + &VBOX_VENDOR; + +
http://www.virtualbox.org
+ + + + 2004-&VBOX_C_YEAR; + + &VBOX_VENDOR; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/manual/en_US/images/clone-vm.png b/doc/manual/en_US/images/clone-vm.png new file mode 100644 index 00000000..35af34c6 Binary files /dev/null and b/doc/manual/en_US/images/clone-vm.png differ diff --git a/doc/manual/en_US/images/cloud-profile-manager.png b/doc/manual/en_US/images/cloud-profile-manager.png new file mode 100644 index 00000000..d88070e9 Binary files /dev/null and b/doc/manual/en_US/images/cloud-profile-manager.png differ diff --git a/doc/manual/en_US/images/create-vdi-1.png b/doc/manual/en_US/images/create-vdi-1.png new file mode 100644 index 00000000..9bf79988 Binary files /dev/null and b/doc/manual/en_US/images/create-vdi-1.png differ diff --git a/doc/manual/en_US/images/create-vm-1.png b/doc/manual/en_US/images/create-vm-1.png new file mode 100644 index 00000000..f42fc398 Binary files /dev/null and b/doc/manual/en_US/images/create-vm-1.png differ diff --git a/doc/manual/en_US/images/create-vm-2.png b/doc/manual/en_US/images/create-vm-2.png new file mode 100644 index 00000000..f643acaa Binary files /dev/null and b/doc/manual/en_US/images/create-vm-2.png differ diff --git a/doc/manual/en_US/images/dnd-modes.png b/doc/manual/en_US/images/dnd-modes.png new file mode 100644 index 00000000..f88f02c6 Binary files /dev/null and b/doc/manual/en_US/images/dnd-modes.png differ diff --git a/doc/manual/en_US/images/export-appliance-oci.png b/doc/manual/en_US/images/export-appliance-oci.png new file mode 100644 index 00000000..aea7b6b7 Binary files /dev/null and b/doc/manual/en_US/images/export-appliance-oci.png differ diff --git a/doc/manual/en_US/images/guest-fm.png b/doc/manual/en_US/images/guest-fm.png new file mode 100644 index 00000000..bfe24233 Binary files /dev/null and b/doc/manual/en_US/images/guest-fm.png differ diff --git a/doc/manual/en_US/images/import-instance.png b/doc/manual/en_US/images/import-instance.png new file mode 100644 index 00000000..7170ab15 Binary files /dev/null and b/doc/manual/en_US/images/import-instance.png differ diff --git a/doc/manual/en_US/images/newcloudvm.png b/doc/manual/en_US/images/newcloudvm.png new file mode 100644 index 00000000..d267a914 Binary files /dev/null and b/doc/manual/en_US/images/newcloudvm.png differ diff --git a/doc/manual/en_US/images/ovf-import.png b/doc/manual/en_US/images/ovf-import.png new file mode 100644 index 00000000..e484fffa Binary files /dev/null and b/doc/manual/en_US/images/ovf-import.png differ diff --git a/doc/manual/en_US/images/seamless.png b/doc/manual/en_US/images/seamless.png new file mode 100644 index 00000000..7239300d Binary files /dev/null and b/doc/manual/en_US/images/seamless.png differ diff --git a/doc/manual/en_US/images/snapshots-1.png b/doc/manual/en_US/images/snapshots-1.png new file mode 100644 index 00000000..aafb6e8e Binary files /dev/null and b/doc/manual/en_US/images/snapshots-1.png differ diff --git a/doc/manual/en_US/images/softkeybd.png b/doc/manual/en_US/images/softkeybd.png new file mode 100644 index 00000000..f3f36483 Binary files /dev/null and b/doc/manual/en_US/images/softkeybd.png differ diff --git a/doc/manual/en_US/images/upload-key.png b/doc/manual/en_US/images/upload-key.png new file mode 100644 index 00000000..cae44e44 Binary files /dev/null and b/doc/manual/en_US/images/upload-key.png differ diff --git a/doc/manual/en_US/images/vbox-components.png b/doc/manual/en_US/images/vbox-components.png new file mode 100644 index 00000000..ed1326dc Binary files /dev/null and b/doc/manual/en_US/images/vbox-components.png differ diff --git a/doc/manual/en_US/images/vbox-sdl.png b/doc/manual/en_US/images/vbox-sdl.png new file mode 100644 index 00000000..2c5b9fb3 Binary files /dev/null and b/doc/manual/en_US/images/vbox-sdl.png differ diff --git a/doc/manual/en_US/images/vboxlogo.png b/doc/manual/en_US/images/vboxlogo.png new file mode 100644 index 00000000..1394b447 Binary files /dev/null and b/doc/manual/en_US/images/vboxlogo.png differ diff --git a/doc/manual/en_US/images/virtual-disk-manager.png b/doc/manual/en_US/images/virtual-disk-manager.png new file mode 100644 index 00000000..1648907c Binary files /dev/null and b/doc/manual/en_US/images/virtual-disk-manager.png differ diff --git a/doc/manual/en_US/images/virtual-disk-manager2.png b/doc/manual/en_US/images/virtual-disk-manager2.png new file mode 100644 index 00000000..030043ba Binary files /dev/null and b/doc/manual/en_US/images/virtual-disk-manager2.png differ diff --git a/doc/manual/en_US/images/virtualbox-main-empty.png b/doc/manual/en_US/images/virtualbox-main-empty.png new file mode 100644 index 00000000..7871d3cd Binary files /dev/null and b/doc/manual/en_US/images/virtualbox-main-empty.png differ diff --git a/doc/manual/en_US/images/virtualbox-main.png b/doc/manual/en_US/images/virtualbox-main.png new file mode 100644 index 00000000..fade285c Binary files /dev/null and b/doc/manual/en_US/images/virtualbox-main.png differ diff --git a/doc/manual/en_US/images/vm-close.png b/doc/manual/en_US/images/vm-close.png new file mode 100644 index 00000000..b23cfa25 Binary files /dev/null and b/doc/manual/en_US/images/vm-close.png differ diff --git a/doc/manual/en_US/images/vm-groups.png b/doc/manual/en_US/images/vm-groups.png new file mode 100644 index 00000000..02752eef Binary files /dev/null and b/doc/manual/en_US/images/vm-groups.png differ diff --git a/doc/manual/en_US/images/vm-hostkey.png b/doc/manual/en_US/images/vm-hostkey.png new file mode 100644 index 00000000..7c36c0ca Binary files /dev/null and b/doc/manual/en_US/images/vm-hostkey.png differ diff --git a/doc/manual/en_US/images/vm-settings-harddisk.png b/doc/manual/en_US/images/vm-settings-harddisk.png new file mode 100644 index 00000000..1ae354ef Binary files /dev/null and b/doc/manual/en_US/images/vm-settings-harddisk.png differ diff --git a/doc/manual/en_US/images/vm-vista-running.png b/doc/manual/en_US/images/vm-vista-running.png new file mode 100644 index 00000000..79f04b09 Binary files /dev/null and b/doc/manual/en_US/images/vm-vista-running.png differ diff --git a/doc/manual/en_US/man_VBoxHeadless.xml b/doc/manual/en_US/man_VBoxHeadless.xml new file mode 100644 index 00000000..a8497a3e --- /dev/null +++ b/doc/manual/en_US/man_VBoxHeadless.xml @@ -0,0 +1,228 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxHeadless + + + + VBoxHeadless + 1 + + + + VBoxHeadless + &product-name; remote desktop server + Oracle VM VirtualBox + + + + + VBoxHeadless + --startvm= + uuid + vmname + + --vrde= + on + off + config + + --vrdeproperty=prop-name=[prop-value] + --settingspw=[password] + --settingspwfile=password-file + --start-paused=vmname + --capture + --width=width + --height=height + --bitrate=bit-rate + --filename=filename + + + + + Description + + The VBoxHeadless command is an alternate front + end that enables you to remotely manage virtual machines (VMs). + The front end is a CLI rather than the VirtualBox Manager + graphical user interface (GUI). + + + For information about using this command, see + . + + + Command Options + + + + + Specifies the Universally Unique Identifier (UUID) or name + of the VM to start. + + Use the VBoxManage list vms command to + obtain VM information. + + The short versions of this option are + and . + + + + + + Specifies how to use the VRDP server. The default value is + config. Valid values are as follows: + + + on enables the VRDP server. + VBoxHeadless --startvm=vmname --vrde=on + + off disables the VRDP server. + VBoxHeadless --startvm=vmname --vrde=off + + config enables the VRDP server + depending on the VM configuration. + VBoxHeadless --startvm=vmname --vrde=config + + The short version of this option is . + + + + + + Specifies a value for one of the following properties: + + + The TCP/Ports property value is a + comma-separated list of ports to which the VRDE server + can bind. Use a hyphen (-) between + two port numbers to specify a range of ports. + + + The TCP/Address property value is + the interface IP address to which to bind the VRDE + server. + + + + + + + Specifies a settings password to access encrypted + settings. If you do not specify the password on the + command line, VBoxHeadless prompts you + for the password. + + This design does not conform to Oracle's security + guidelines. You should not be able to specify a password + on the command line because the password can be seen in a + process listing. + + + + + + Specifies the file that contains the settings password. + + + + + + Starts the specified VM in the paused state. + + + + + + Records the VM screen output to a file. In addition to + this option, you must use the + option to specify the name of the file. + + + + + + Specifies the frame width of the recording in pixels. This + option is associated with the + option. + + + + + + Specifies the frame height of the recording in pixels. + This option is associated with the + option. + + + + + + Specifies the bit rate of the recording in kilobits per + second. This option is associated with the + option. + + + + + + Specifies the name of the file in which to store the + recording. The codec used is based on the file extension + that you choose. You must specify this option if you use + the option. + + Where can we get information about the file extensions + that are supported? + + + + + + + + Examples + + + The following command starts the ol7u4 VM: + +$ VBoxHeadless --startvm "ol7u4" + + The following command starts the ol7u6 VM in + the Paused state. + +$ VBoxHeadless --startvm "ol7u6" --start-paused + + The following command starts the ol7u6 VM and + records the session. The recording is saved to the + ol7u6-recording WebM file. + +$ VBoxHeadless --startvm "ol7u6" --capture --filename ol7u6-recording.webm + + + + See Also + + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-adoptstate.xml b/doc/manual/en_US/man_VBoxManage-adoptstate.xml new file mode 100644 index 00000000..0463c953 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-adoptstate.xml @@ -0,0 +1,99 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage adoptstate + + + + VBoxManage-adoptstate + 1 + + + + VBoxManage-adoptstate + change a virtual machine's state based on a saved state file + Oracle VM VirtualBox + + + + + + VBoxManage adoptstate + + uuid + vmname + + state-filename + + + + + Description + + The VBoxManage adoptstate command enables you + to change the state of a virtual machine (VM) to a state described + in a saved state file (.sav). This action is + referred to as a VM adopting a saved state + file. The saved state file must be separate from the VM + configuration. + + + When you start the VM after adopting the saved state, the VM + restores its state from the saved state file. + + + Only use this command for custom deployments. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + state-filename + + Specifies the name of the saved state file. + + + + + + + Examples + + + The following command starts a VM called vm2 + using a saved state file called mystate.sav. + +$ VBoxManage adoptstate vm2 /home/user/mystate.sav + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml b/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml new file mode 100644 index 00000000..4daf9cbc --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-bandwidthctl.xml @@ -0,0 +1,296 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage bandwidthctl + + + + VBoxManage-bandwidthctl + 1 + + + + VBoxManage-bandwidthctl + manage bandwidth groups + Oracle VM VirtualBox + + + + + + VBoxManage bandwidthctl + + uuid + vmname + + add + bandwidth-group-name + --limit=bandwidth-limit[k|m|g|K|M|G] + --type=disk|network + + + + VBoxManage bandwidthctl + + uuid + vmname + + list + --machinereadable + + + + VBoxManage bandwidthctl + + uuid + vmname + + remove + bandwidth-group-name + + + + VBoxManage bandwidthctl + + uuid + vmname + + set + bandwidth-group-name + --limit=bandwidth-limit[k|m|g|K|M|G] + + + + + Description + + The VBoxManage bandwidthctl command enables you + to manage bandwidth groups for virtual machines (VMs). A bandwidth + group specifies the bandwidth limit for the disks or for the + network adapters of a VM. + + + Note that a network bandwidth limit applies only to the outbound + traffic from the VM. The inbound traffic is unlimited. + + + Create a Bandwidth Group + + + The VBoxManage bandwidthctl add command + creates a bandwidth group for the specified VM. You must specify + whether the bandwidth group is for disks or for networks, and + specify the bandwidth limit. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or the + name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + Specifies the type of the bandwidth group: + disk and network. + For more information, see + or + . + + + + + + Specifies the bandwidth limit for a bandwidth group. The + default unit is megabytes per second. You can modify this + value while the VM is running. + + You can change the unit by appending one of the following + unit specifiers to the bandwidth limit: + + + k – kilobits per second + + + m – megabits per second + + + g – gigabits per second + + + K – kilobytes per second + + + M – megabytes per second + + + G – gigabytes per second + + + + + + + List Bandwidth Groups + + + The VBoxManage bandwidthctl list command + lists the all the bandwidth groups that have been defined for + the specified VM. Use the + option to produce the output in a machine-readable format, which + uses name-value pairs. + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Outputs the information about the bandwidth groups in + name-value pairs. + + + + + + Remove a Bandwidth Group + + + The VBoxManage bandwidthctl remove command + removes a bandwidth group. + + + + To successfully remove a bandwidth group, ensure that it is + not referenced by any disk or adapter in the running VM. + + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + Modify the Bandwidth Limit of a Bandwidth Group + + + The VBoxManage bandwidthctl set command + modifies the bandwidth limit for a bandwidth group. + + + + uuid | vmname + + Specifies the UUID or the name of the VM. + + + + + + Specifies the name of the bandwidth group. + + + + + + Specifies the bandwidth limit for a bandwidth group. The + default unit is megabytes per second. You can modify this + value while the VM is running. + + You can change the unit by appending one of the following + unit specifiers to the bandwidth limit: + + + k – kilobits per second + + + m – megabits per second + + + g – gigabits per second + + + K – kilobytes per second + + + M – megabytes per second + + + G – gigabytes per second + + + + + + + + + Examples + + + The following example shows how to use the VBoxManage + bandwidthctl command to create the + Literal bandwidth group and set the limit to 20 + Mbps. Then use the VBoxManage modifyvm command + to assign this bandwidth group to the first and second adapters of + the vm1 VM. + +$ VBoxManage bandwidthctl "vm1" add Limit --type network --limit 20m +$ VBoxManage modifyvm "vm1" --nicbandwidthgroup1 Limit +$ VBoxManage modifyvm "vm1" --nicbandwidthgroup2 Limit + + You can dynamically modify the limit of a bandwidth group while + the VM is running. The following example shows how to modify the + limit for the Limit bandwidth group from 20 + Mbps to 100 kbps: + +$ VBoxManage bandwidthctl "vm1" set Limit --limit 100k + + The following command disables shaping for all adapters in the + Limit bandwidth group by specifying a limit of + zero (0): + +$ VBoxManage bandwidthctl "vm1" set Limit --limit 0 + + diff --git a/doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml b/doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml new file mode 100644 index 00000000..0edceb7b --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-checkmediumpwd.xml @@ -0,0 +1,102 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage checkmediumpwd + + + + VBoxManage-checkmediumpwd + 1 + + + + VBoxManage-checkmediumpwd + check encryption password on a DEK-encrypted medium or a disk image + Oracle VM VirtualBox + + + + + + VBoxManage checkmediumpwd + + uuid + filename + + password-file + + + + + Description + + The VBoxManage checkmediumpwd command checks + the current encryption password on a DEK-encrypted medium or a + disk image. See . + + + The command response indicates if the specified password is + correct. + + + + uuid|filename + + Specifies the Universally Unique Identifier (UUID) or the + absolute path name of the medium or image. + + + + password-file + + Specifies the password identifier to check. The password + identifier can be the absolute path name of a password file + on the host OS or the dash character (-) + to prompt you for the password on the command line. + + + + + + + Examples + + + The following example checks the encryption password for the + ol7u4-1.vdi disk image. The password + identifier is a file called pwfile. + + + The command returns a message indicating that the specified + password is correct. + +$ VBoxManage checkmediumpwd "$HOME/VirtualBox VMs/ol7u4/ol7u4-1.vdi" /home/user/pwfile + The given password is correct + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-clonemedium.xml b/doc/manual/en_US/man_VBoxManage-clonemedium.xml new file mode 100644 index 00000000..be5a1da5 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-clonemedium.xml @@ -0,0 +1,203 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage clonemedium + + + + VBoxManage-clonemedium + 1 + + + + VBoxManage-clonemedium + create a clone of a medium + Oracle VM VirtualBox + + + + + + VBoxManage clonemedium + + uuid + source-medium + + + uuid + target-medium + + + disk + dvd + floppy + + --existing + --format= + VDI + VMDK + VHD + RAW + other + + --variant=Standard,Fixed,Split2G,Stream,ESX + + + + + Description + + The VBoxManage clonemedium command enables you + to clone an existing medium (virtual disk, DVD, or floppy), which + is typically an image file. Only the Universally Unique Identifier + (UUID) differs between the original image and the cloned image. + + + You can use the Virtual Media Manager to transfer the cloned image + to another host system or reimport it into &product-name;. See + and . + + + + uuid | source-medium + + Specifies the UUID or the absolute or relative file name of + the source medium to clone. You can specify the UUID of the + medium only if it is registered. Use the VBoxManage + list hdds command to list registered images. + + + + uuid | target-medium + + Specifies the UUID or the absolute or relative file name of + the target (clone) medium. You can specify the UUID of the + target medium only if it is registered. Use the + VBoxManage list hdds command to list + registered images. + + + + disk | dvd | floppy + + Specifies the type of the medium to clone. Valid values are + disk, dvd, and + floppy. The default value is + disk. + + + + + + Performs the clone operation by overwriting an existing + target medium. The result is that only the portion of the + source medium that fits into the existing target medium is + copied. + + If the target medium is smaller than the source, only the + portion of the source medium up to the size of the target + medium is copied. + + If the target medium is larger than the source, the + remaining part of the target medium is unchanged. + + + + + + Specifies the file format of the target medium if it differs + from the format of the source medium. Valid values are + VDI, VMDK, + VHD, RAW, and + other. + + What file formats can other be? + + + + + + Specifies the file format variant for the target medium, + which is a comma-separated list of variants. Following are + the valid values: + + + Standard is the default disk image + type, which has a dynamically allocated file size. + + + Fixed uses a disk image that has a + fixed file size. + + + Split2G indicates that the disk image + is split into 2GB segments. This value is for VMDK only. + + + Stream optimizes the disk image for + downloading. This value is for VMDK only. + + + ESX is used for some VMWare products. + This value is for VMDK only. + + + Note that not all variant combinations are valid. Specifying + incompatible variant values in the list will produce an + error message. + + + + + + For compatibility with earlier versions of &product-name;, you + can use the clonevdi and + clonehd commands instead of the + clonemedium command. + + + + + + Examples + + + The following command creates a clone of the + disk01.vdi disk image file. The clone is + called disk02.vdi. + +$ VBoxManage clonemedium disk01.vdi disk02.vdi + + The following command creates a clone of the + disk01.vdi disk image file. The clone is in + VMDK format and is called disk02.vmdk. + +$ VBoxManage clonemedium disk01.vdi disk02.vmdk --format VMDK + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-clonevm.xml b/doc/manual/en_US/man_VBoxManage-clonevm.xml new file mode 100644 index 00000000..9ec0f0e1 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-clonevm.xml @@ -0,0 +1,263 @@ + + + +%all.entities; +]> + + + February 2019 + VBoxManage clonevm + + + + VBoxManage-clonevm + 1 + + + + VBoxManage-clonevm + create a clone of an existing &product-name; virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage clonevm + vmname|uuid + + --basefolder=basefolder + + --groups=group, + + + --mode=machine + --mode=machinechildren + --mode=all + + + --name=name + + --options=option, + + --register + + --snapshot=snapshot-name + + --uuid=uuid + + + + + Description + + The VBoxManage clonevm command creates a clone + of an existing virtual machine (VM). The clone can be a full copy + of the VM or a linked copy of a VM. + + + You must specify the name or the universal unique identifier + (UUID) of the VM you want to clone. + + + + + Command Operand and Options + + The following list describes the operand and the options that you + can use with the VBoxManage clonevm command: + + + + vmname|uuid + + Specifies the name or UUID of the VM to clone. + + + + + + Specifies the name of the folder in which to save the + configuration for the new VM. + + + + + + Assigns the clone to the specified group or groups. If you + specify more than one group, separate each group name with a + comma. + + Note that each group is identified by a group ID that starts + with a slash character (/) + so that groups can be nested. By default, a clone is always + assigned membership to the + / group. + + + + + + Specifies which of the following cloning modes to use: + + + machine mode clones the + current state of the existing VM without any snapshots. + This is the default mode. + + + machineandchildren mode + clones the snapshot specified by by the + option and all child + snapshots. + + + all mode clones all + snapshots and the current state of the existing VM. + + + + + + + Specifies a new name for the new VM. The default value is + original-name + Clone where + original-name is the original + name of the VM. + + + + + + Specifies how to create the new clone. + The argument can be used multiple + times to enable multiple options, or the options can be given as a + comma separated list. The options are case insensitive. + The following options (case-insensitive) are recognized: + + + + + Creates a linked clone from a snapshot only. + + + + + + Specifies that the new clone reuses the MAC addresses + of each virtual network card from the existing VM. + + If you do not specify this option or the + option, the + default behavior is to reinitialize the MAC addresses + of each virtual network card. + + + + + + Specifies that the new clone reuses the MAC addresses + of each virtual network card from the existing VM when + the network type is NAT. + + If you do not specify this option or the + option, the + default behavior is to reinitialize the MAC addresses + of each virtual network card. + + + + + + Specifies that the new clone reuses the disk image + names from the existing VM. By default, disk images + are renamed. + + + + + + Specifies that the new clone reuses the hardware IDs + from the existing VM. By default, new UUIDs are used. + + + + + + + + Automatically registers the new clone in this &product-name; + installation. You can manually register the new VM later by + using the VBoxManage registervm command. + See . + + + + + + Specifies the snapshot on which to base the new VM. By + default, the clone is created from the current state of the + specified VM. + + + + + + Specifies the UUID for the new VM. Ensure that this ID is + unique for the &product-name; instance if you decide to + register this new VM. By default, &product-name; provides a + new UUID. + + + + + + + Examples + + The following command creates and registers an exact clone of the + ol7 VM. The clone is called + ol7-dev-001. + + + The new clone includes all of the source VM's snapshots. The new + VM also reuses all network interface MAC addresses, disk names, + and UUIDs from the source VM. + + +$ VBoxManage clonevm ol7 --name="ol7-dev-001" --register --mode=all \ + --options=keepallmacs --options=keepdisknames --options=keephwuuids + + + The following command creates and registers a clone of the + Snapshot 1 snapshot of the + ol7 VM. The clone is called + ol7-dev-002. + + +$ VBoxManage clonevm ol7 --name="ol7-dev-002" --register --snapshot="Snapshot 1" + + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-closemedium.xml b/doc/manual/en_US/man_VBoxManage-closemedium.xml new file mode 100644 index 00000000..55000965 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-closemedium.xml @@ -0,0 +1,108 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage closemedium + + + + VBoxManage-closemedium + 1 + + + + VBoxManage-closemedium + remove a hard disk, DVD, or floppy image from the media registry + Oracle VM VirtualBox + + + + + + VBoxManage closemedium + + disk + dvd + floppy + + + uuid + filename + + --delete + + + + + Description + + The VBoxManage closemedium command removes a + hard disk, DVD, or floppy image from the list of known media used + by &product-name;. The image is then unavailable for selection in + the Virtual Media Manager. + + + To use this command, the image must not be attached to any VMs. + + + Optionally, you can request that the image be deleted. + + + + disk|dvd|floppy + + Specifies the type of medium. Valid values are + disk (hard drive), + dvd, or floppy. + + + + uuid|filename + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + + + + + + Deletes the image file. + + + + + + + Examples + + + The following command removes the disk image file called + disk01.vdi from the registry. + +$ VBoxManage closemedium disk01.vdi + + The following command removes the disk image file called + disk01.vdi from the registry and deletes the + image file. + +$ VBoxManage closemedium disk01.vdi --delete + + diff --git a/doc/manual/en_US/man_VBoxManage-cloud.xml b/doc/manual/en_US/man_VBoxManage-cloud.xml new file mode 100644 index 00000000..c8652d49 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloud.xml @@ -0,0 +1,623 @@ + + + + + + + $Date: 2021-03-01 11:20:37 +0100 (Mon, 01 Mar 2021) $ + VBoxManage cloud + + + + VBoxManage-cloud + 1 + + + + VBoxManage-cloud + Manage the cloud entities + Oracle VM VirtualBox + + + + + + VBoxManage cloud + --provider=name + --profile=name + list + instances + --state=string + --compartment-id=string + + + VBoxManage cloud + --provider=name + --profile=name + list + images + --compartment-id=string + --state=string + + + + + VBoxManage cloud + --provider=name + --profile=name + instance + create + --domain-name=name + + --image-id=id + --boot-volume-id=id + + --display-name=name + --shape=type + --subnet=id + --boot-disk-size=size in GB + --publicip=true/false + --privateip=IP address + --public-ssh-key=key string + --launch-mode=NATIVE/EMULATED/PARAVIRTUALIZED + --cloud-init-script-path=path to a script + + + VBoxManage cloud + --provider=name + --profile=name + instance + info + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + terminate + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + start + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + pause + --id=unique id + + + + + VBoxManage cloud + --provider=name + --profile=name + image + create + --display-name=name + --bucket-name=name + --object-name=name + --instance-id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + info + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + delete + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + import + --id=unique id + --bucket-name=name + --object-name=name + + + VBoxManage cloud + --provider=name + --profile=name + image + export + --id=unique id + --display-name=name + --bucket-name=name + --object-name=name + + + + + VBoxManage cloud + --provider=name + --profile=name + network setup + --local-gateway-iso=path + --gateway-os-name=string + --gateway-os-version=string + --gateway-shape=string + --tunnel-network-name=string + --tunnel-network-range=string + --guest-additions-iso=path + --proxy=string + --compartment-id=string + + + VBoxManage cloud + --provider=name + --profile=name + network create + --name=string + --network-id=string + + --enable + --disable + + + + VBoxManage cloud network update + --name=string + --network-id=string + + --enable + --disable + + + + VBoxManage cloud + network delete + --name=string + + + VBoxManage cloud + network info + --name=string + + + + + Description + + + + Common options + + The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud. + The next common options must be placed between the "cloud" and the following sub-commands: + + + --provider=name + Short cloud provider name. + + + --profile=name + Cloud profile name. + + + + + + + cloud list instances + + + Displays the list of the instances for a specified compartment. + + + + --state"running/paused/terminated" + + The state of cloud instance. The possible states are "running/paused/terminated" at moment. + If the state isn't provided the list of instances with all possible states is returned. + + + + + + + A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + + + + + + + + cloud list images + + + Displays the list of the images for a specified compartment. + + + + --state"available/disabled/deleted" + + The state of cloud image. The possible states are "available/disabled/deleted" at moment. + If the state isn't provided the list of images with all possible states is returned. + + + + + + + A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + + + + + + + + + cloud instance create + + + Creates new instance in the Cloud. + There are two standard ways to create an instance in the Cloud: + 1. Create an instance from an existing custom image. + 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance. + For the 1st approach next parameters are required: image-id and boot-disk-size. + For the 2nd approach next parameters are required: boot-volume-id; + The rest parameters are common for both cases: + display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain. + + + + Cloud domain where new instance is created. + + + Unique identifier which fully identifies a custom image in the Cloud. + + + Unique identifier which fully identifies a boot volume in the Cloud. + + + Name for new instance in the Cloud. + + + The shape of instance, defines the number of CPUs and RAM memory. + + + Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance. + + + The size of bootable image in GB. Default is 50GB. + + + Whether the instance will have a public IP or not. + + + Private IP address for the created instance. + + + + + Public SSH key used to connect to the instance via SSH. + This parameter may be repeated if you plan to use more than one key as: + "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey". + + + + + The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. + + + Absolute path to the user cloud-init script. + + + + + + cloud instance info + + Display information about a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance termination + + Delete a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance start + + Start a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance pause + + Pause a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + + + cloud image create + + + Creates new image in the Cloud. + There are two standard ways to create an image in the Cloud: + 1. Create an image from an object in the Cloud Storage; + 2. Create an image from an existing cloud instance. + For the 1st approach next parameters are required: + bucket-name - cloud bucket name where an object is located; + object-name - name of object in the bucket; + display-name - name for new image in the Cloud. + For the 2d approach next parameters are required: + instance-id - Id of instance in the Cloud; + display-name - name for new image in the Cloud. + + + + Name for new image in the Cloud. + + + Cloud bucket name where an object is located. + + + Name of object in the bucket. + + + Unique identifier which fully identifies the instance in the Cloud. + + + + + + cloud image info + + + Display information about a cloud image with a specified id. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image delete + + + Delete an image with a specified id from the Cloud. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image import + + + Import an image with a specified id from the Cloud to a local host. + The result is an object in the local "temp" folder on the local host. + Possible approach may have two general steps: + 1. Create an object from an image in the Cloud Storage; + 2. Download the object to the local host. + So the next parameters may be required: + bucket-name - cloud bucket name where the object will be created; + object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used. + If the first step isn't needed only the parameter "id" is required. + + + + Unique identifier which fully identifies the image in the Cloud. + + + Cloud bucket name where an object will be created. + + + + + + Name of created object in the bucket. The downloaded object will have this name. + + + + + + + + cloud image export + + + Export an existing VBox image with a specified uuid from a local host to the Cloud. + The result is new image in the Cloud. + Possible approach may have two general steps: + 1. Upload VBox image to the Cloud Storage; + 2. Create an image from the uploaded object. + So the next parameters may be required: + bucket-name -cloud bucket name where the object will be uploaded; + object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used; + display-name - name for new image in the Cloud. + If the first step isn't needed the parameters "id" and "display-name" are required only. + + + + Unique identifier of the image in the VirtualBox. + + + Name for new image in the Cloud. + + + Cloud bucket name where the image (object) will be uploaded. + + + Name of object in the bucket. + + + + + + + + cloud network setup + + + Set up a cloud network environment for the specified cloud profile. + + + + The local path to an installation media for a local gateway. + + + The name of OS to use for a cloud gateway. + + + The version of OS to use for a cloud gateway. + + + The instance shape to use for a cloud gateway. + + + The name of VCN/subnet to use for tunneling. + + + The IP address range to use for tunneling. + + + The local path to an installation media for VirtualBox guest additions. + + + The proxy URL to be used in local gateway installation. + + + The compartment to create the tunnel network in. + + + + + + cloud network create + + + Create a new cloud network descriptor associated with an existing cloud subnet. + + + + The name to assign to the cloud network descriptor. + + + The unique identifier of an existing subnet in the cloud. + + + , --disable + Whether to enable the network descriptor or disable it. If not specified, + the network will be enabled. + + + + + + cloud network update + + + Modify an existing cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + The unique identifier of an existing subnet in the cloud. + + + , --disable + Whether to enable the network descriptor or disable it. + + + + + + cloud network delete + + + Delete an existing cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + + + + cloud network info + + + Display information about a cloud network descriptor. + + + + The name of an existing cloud network descriptor. + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-cloudimage.xml b/doc/manual/en_US/man_VBoxManage-cloudimage.xml new file mode 100644 index 00000000..5b3e831e --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloudimage.xml @@ -0,0 +1,229 @@ + + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage cloud image + + + + VBoxManage-cloudimage + 1 + + + + VBoxManage-cloudimage + Manage the cloud images + Oracle VM VirtualBox + + + + + VBoxManage cloud + --provider=name + --profile=name + image + create + --display-name=name + --bucket-name=name + --object-name=name + --instance-id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + info + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + delete + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + image + import + --id=unique id + --bucket-name=name + --object-name=name + + + VBoxManage cloud + --provider=name + --profile=name + image + export + --id=unique id + --display-name=name + --bucket-name=name + --object-name=name + + + + + Description + + + Common options + + The subcommands of cloudimage implement the standard operations for a cloud image + like create/delete/show/import/export. The next common options must be placed between the "cloud" and the following sub-commands: + + + --provider=name + Short cloud provider name. + + + --profile=name + Cloud profile name. + + + + + + cloud image create + + + Creates new image in the Cloud. + There are two standard ways to create an image in the Cloud: + 1. Create an image from an object in the Cloud Storage; + 2. Create an image from an existing cloud instance. + For the 1st approach next parameters are required: + bucket-name - cloud bucket name where an object is located; + object-name - name of object in the bucket; + display-name - name for new image in the Cloud. + For the 2d approach next parameters are required: + instance-id - Id of instance in the Cloud; + display-name - name for new image in the Cloud. + + + + Name for new image in the Cloud. + + + Cloud bucket name where an object is located. + + + Name of object in the bucket. + + + Unique identifier which fully identifies the instance in the Cloud. + + + + + + cloud image info + + + Display information about a cloud image with a specified id. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image delete + + + Delete an image with a specified id from the Cloud. + + + + Unique identifier which fully identifies the image in the Cloud. + + + + + + cloud image import + + + Import an image with a specified id from the Cloud to a local host. + The result is an object in the local "temp" folder on the local host. + Possible approach may have two general steps: + 1. Create an object from an image in the Cloud Storage; + 2. Download the object to the local host. + So the next parameters may be required: + bucket-name - cloud bucket name where the object will be created; + object-name - name of object in the bucket. if parameter "object-name" is absent a displayed image name is used. + If the first step isn't needed only the parameter "id" is required. + + + + Unique identifier which fully identifies the image in the Cloud. + + + Cloud bucket name where an object will be created. + + + + + + Name of created object in the bucket. The downloaded object will have this name. + + + + + + + + cloud image export + + + Export an existing VBox image with a specified uuid from a local host to the Cloud. + The result is new image in the Cloud. + Possible approach may have two general steps: + 1. Upload VBox image to the Cloud Storage; + 2. Create an image from the uploaded object. + So the next parameters may be required: + bucket-name -cloud bucket name where the object will be uploaded; + object-name - name of object in the bucket. If parameter "object-name" is absent the image id is used; + display-name - name for new image in the Cloud. + If the first step isn't needed the parameters "id" and "display-name" are required only. + + + + Unique identifier of the image in the VirtualBox. + + + Name for new image in the Cloud. + + + Cloud bucket name where the image (object) will be uploaded. + + + Name of object in the bucket. + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-cloudinstance.xml b/doc/manual/en_US/man_VBoxManage-cloudinstance.xml new file mode 100644 index 00000000..a03e228d --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloudinstance.xml @@ -0,0 +1,212 @@ + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage cloud instance + + + + VBoxManage-cloudinstance + 1 + + + + VBoxManage-cloudinstance + Manage the cloud instances + Oracle VM VirtualBox + + + + + VBoxManage cloud + --provider=name + --profile=name + instance + create + --domain-name=name + + --image-id=id + --boot-volume-id=id + + --display-name=name + --shape=type + --subnet=id + --boot-disk-size=size in GB + --publicip=true/false + --privateip=IP address + --public-ssh-key=key string + --launch-mode=NATIVE/EMULATED/PARAVIRTUALIZED + + + VBoxManage cloud + --provider=name + --profile=name + instance + info + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + terminate + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + start + --id=unique id + + + VBoxManage cloud + --provider=name + --profile=name + instance + pause + --id=unique id + + + + + Description + + + Common options + + The subcommands of cloudinstance implement the standard operations for a cloud instance + like start/pause/show/terminate. The next common options must be placed between the "cloud" and the following sub-commands: + + + --provider=name + Short cloud provider name. + + + --profile=name + Cloud profile name. + + + + + + cloud instance create + + + Creates new instance in the Cloud. + There are two standard ways to create an instance in the Cloud: + 1. Create an instance from an existing custom image. + 2. Create an instance from an existing bootable volume. This bootable volume shouldn't be attached to any instance. + For the 1st approach next parameters are required: image-id and boot-disk-size. + For the 2nd approach next parameters are required: boot-volume-id; + The rest parameters are common for both cases: + display-name, launch-mode, subnet-id, publicIP, privateIP, shape, domain. + + + + Cloud domain where new instance is created. + + + Unique identifier which fully identifies a custom image in the Cloud. + + + Unique identifier which fully identifies a boot volume in the Cloud. + + + Name for new instance in the Cloud. + + + The shape of instance, defines the number of CPUs and RAM memory. + + + Unique identifier which fully identifies an existing subnet in the Cloud which will be used by the instance. + + + The size of bootable image in GB. Default is 50GB. + + + Whether the instance will have a public IP or not. + + + Private IP address for the created instance. + + + + + Public SSH key used to connect to the instance via SSH. + This parameter may be repeated if you plan to use more than one key as: + "--public-ssh-key=firstSSHKey --public-ssh-key=secondSSHKey". + + + + + The most known values here may be EMULATED, NATIVE, PARAVIRTUALIZED. + + + + + + cloud instance info + + Display information about a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance termination + + Delete a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance start + + Start a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + + cloud instance pause + + Pause a cloud instance with a specified id. + + + + Unique identifier which fully identify the instance in the Cloud. + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-cloudlist.xml b/doc/manual/en_US/man_VBoxManage-cloudlist.xml new file mode 100644 index 00000000..6fb004bf --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloudlist.xml @@ -0,0 +1,130 @@ + + + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage cloud list + + + + VBoxManage-cloudlist + 1 + + + + VBoxManage-cloudlist + The cloud list command gives information about some standard entities in the every Cloud + and which can be represented by the list like the list of instances/disk images/networks and etc + Oracle VM VirtualBox + + + + + VBoxManage cloud + --provider=name + --profile=name + list + instances + --state=string + --compartment-id=string + + + VBoxManage cloud + --provider=name + --profile=name + list + images + --state=string + --compartment-id=string + + + + + Description + + Common options + + The word "cloud" is an umbrella for all commands related to the interconnection with the Cloud. + The following common options must be placed between the "cloud" and the following command, in our case "list": + + + --provider=name + Short cloud provider name. + + + --profile=name + Cloud profile name. + + + + + + cloud list instances + + + Displays the list of the instances for a specified compartment. + + + + --state"running/paused/terminated" + + The state of cloud instance. The possible states are "running/paused/terminated" at moment. + If the state isn't provided the list of instances with all possible states is returned. + + + + + + + A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + + + + + + + + cloud list images + + + Displays the list of the images for a specified compartment. + + + + --state"available/disabled/deleted" + + The state of cloud image. The possible states are "available/disabled/deleted" at moment. + If the state isn't provided the list of images with all possible states is returned. + + + + + + + A compartment is the logical container used to organize and isolate cloud resources. + The different cloud providers can have the different names for this entity. + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-cloudprofile.xml b/doc/manual/en_US/man_VBoxManage-cloudprofile.xml new file mode 100644 index 00000000..bcf92ca0 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-cloudprofile.xml @@ -0,0 +1,176 @@ + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage cloudprofile + + + + VBoxManage-cloudprofile + 1 + + + + VBoxManage-cloudprofile + Manage the cloud profiles + Oracle VM VirtualBox + + + + + VBoxManage cloudprofile + --provider=name + --profile=name + add + --clouduser=unique id + --fingerprint=MD5 string + --keyfile=path + --passphrase=string + --tenancy=unique id + --compartment=unique id + --region=string + + + VBoxManage cloudprofile + --provider=name + --profile=name + update + --clouduser=unique id + --fingerprint=MD5 string + --keyfile=path + --passphrase=string + --tenancy=unique id + --compartment=unique id + --region=string + + + VBoxManage cloudprofile + --provider=name + --profile=name + delete + + + VBoxManage cloudprofile + --provider=name + --profile=name + show + + + + + Description + + + Common options + + The subcommands of cloudprofile implement the standard CRUD operations for a cloud profile. + The next common options must be placed between the "cloud" and the following sub-commands: + + + --provider=name + Short cloud provider name. + + + --profile=name + Cloud profile name. + + + + + + cloudprofile add + + + Add new cloud profile for a specified cloud provider. + + + + The name which fully identifies the user in the specified cloud provider. + + + Fingerprint for the key pair being used. + + + Full path and filename of the private key. + + + Passphrase used for the key, if it is encrypted. + + + ID of your tenancy. + + + ID of your compartment. + + + Region name. Region is where you plan to deploy an application. + + + + + + cloudprofile show + + + Display information about a cloud profile for a specified cloud provider. + + + + + cloudprofile update + + + Modify a cloud profile for the specified cloud provider. + + + + The name which fully identifies the user in the specified cloud provider. + + + Fingerprint for the key pair being used. + + + Full path and filename of the private key. + + + Passphrase used for the key, if it is encrypted. + + + ID of your tenancy. + + + ID of your compartment. + + + Region name. Region is where you plan to deploy an application. + + + + + + cloudprofile delete + + + Delete a cloud profile for a specified cloud provider. + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-controlvm.xml b/doc/manual/en_US/man_VBoxManage-controlvm.xml new file mode 100644 index 00000000..4b5c0745 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-controlvm.xml @@ -0,0 +1,2081 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage controlvm + + + + VBoxManage-controlvm + 1 + + + + VBoxManage-controlvm + change state and settings for a running virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage controlvm + + uuid + vmname + + pause + + + + VBoxManage controlvm + + uuid + vmname + + resume + + + + VBoxManage controlvm + + uuid + vmname + + reset + + + + VBoxManage controlvm + + uuid + vmname + + poweroff + + + + VBoxManage controlvm + + uuid + vmname + + savestate + + + + VBoxManage controlvm + + uuid + vmname + + acpipowerbutton + + + + VBoxManage controlvm + + uuid + vmname + + acpisleepbutton + + + + VBoxManage controlvm + + uuid + vmname + + keyboardputscancode + hex + hex + + + + VBoxManage controlvm + + uuid + vmname + + keyboardputstring + string + string + + + + VBoxManage controlvm + + uuid + vmname + + keyboardputfile + filename + + + + VBoxManage controlvm + + uuid + vmname + + setlinkstateN + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + nicN + + null + nat + bridged + intnet + hostonly + generic + natnetwork + + device-name + + + + VBoxManage controlvm + + uuid + vmname + + nictraceN + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + nictracefileN + filename + + + + VBoxManage controlvm + + uuid + vmname + + nicpropertyN + prop-name=prop-value + + + + VBoxManage controlvm + + uuid + vmname + + nicpromiscN + + deny + allow-vms + allow-all + + + + + VBoxManage controlvm + + uuid + vmname + + natpfN + + [rulename],tcp + udp,host-IP,hostport,guest-IP,guestport + + + + + VBoxManage controlvm + + uuid + vmname + + natpfN delete + + rulename + + + + VBoxManage controlvm + + uuid + vmname + + guestmemoryballoon + balloon-size + + + + VBoxManage controlvm + + uuid + vmname + + usbattach + + uuid + address + + --capturefile=filename + + + + VBoxManage controlvm + + uuid + vmname + + usbdetach + + uuid + address + + + + + VBoxManage controlvm + + uuid + vmname + + audioin + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + audioout + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + clipboard + + disabled + hosttoguest + guesttohost + bidirectional + + + + + VBoxManage controlvm + + uuid + vmname + + draganddrop + + disabled + hosttoguest + guesttohost + bidirectional + + + + + VBoxManage controlvm + + uuid + vmname + + vrde + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + vrdeport + port + + + + VBoxManage controlvm + + uuid + vmname + + vrdeproperty + prop-name=prop-value + + + + VBoxManage controlvm + + uuid + vmname + + vrdevideochannelquality + percentage + + + + VBoxManage controlvm + + uuid + vmname + + setvideomodehint + xres + yres + bpp + display + enabled:yes | no + x-origin y-origin + + + + + VBoxManage controlvm + + uuid + vmname + + setscreenlayout + display + + on + primary x-origin y-origin x-resolution y-resolution bpp + off + + + + + VBoxManage controlvm + + uuid + vmname + + screenshotpng + filename + display + + + + VBoxManage controlvm + + uuid + vmname + + recording + + on + off + + + + + VBoxManage controlvm + + uuid + vmname + + recording screens + + all + none + screen,[screen...] + + + + + VBoxManage controlvm + + uuid + vmname + + recording filename + filename + + + + VBoxManage controlvm + + uuid + vmname + + recording videores + widthxheight + + + + VBoxManage controlvm + + uuid + vmname + + recording videorate + rate + + + + VBoxManage controlvm + + uuid + vmname + + recording videofps + fps + + + + VBoxManage controlvm + + uuid + vmname + + recording maxtime + sec + + + + VBoxManage controlvm + + uuid + vmname + + recording maxfilesize + MB + + + + VBoxManage controlvm + + uuid + vmname + + setcredentials + username + --passwordfile= + filename + password + + domain-name + --allowlocallogon= + yes + no + + + + + VBoxManage controlvm + + uuid + vmname + + teleport + --host=host-name + --port=port-name + --maxdowntime=msec + + --passwordfile=filename + --password=password + + + + + VBoxManage controlvm + + uuid + vmname + + plugcpu + ID + + + + VBoxManage controlvm + + uuid + vmname + + unplugcpu + ID + + + + VBoxManage controlvm + + uuid + vmname + + cpuexecutioncap + num + + + + VBoxManage controlvm + + uuid + vmname + + vm-process-priority + + default + flat + low + normal + high + + + + + VBoxManage controlvm + + uuid + vmname + + webcam attach + pathnamesettings + + + + VBoxManage controlvm + + uuid + vmname + + webcam detach + pathname + + + + VBoxManage controlvm + + uuid + vmname + + webcam list + + + + VBoxManage controlvm + + uuid + vmname + + addencpassword + ID + + password-file + - + + --removeonsuspend= + yes + no + + + + + VBoxManage controlvm + + uuid + vmname + + removeencpassword + ID + + + + VBoxManage controlvm + + uuid + vmname + + removeallencpasswords + + + + VBoxManage controlvm + + uuid + vmname + + changeuartmodeN + + disconnected + server pipe-name + client pipe-name + tcpserver port + tcpclient hostname:port + file filename + device-name + + + + + + Description + + The VBoxManage controlvm command enables you to + change the state of a running virtual machine (VM). The following + sections describe the subcommands that you can use: + + + Pause a Virtual Machine + + + The VBoxManage controlvm + vmname pause command + temporarily stops the execution of a VM. When paused, the VM's + state is not permanently changed. + + + The VM window appears as gray and the title bar of the window + indicates that the VM is currently Paused. This action is + equivalent to selecting Pause + from the Machine menu of the + GUI. + + + + Resume a Paused Virtual Machine + + + The VBoxManage controlvm + vmname resume command + restarts the execution of a paused VM. This action is equivalent + to selecting Resume from the + Machine menu of the GUI. + + + + Reset a Virtual Machine + + + The VBoxManage controlvm + vmname reset command + performs a cold reset the VM. This command has the same effect + on a VM as pressing the Reset button on a physical computer. + + + The cold reboot immediately restarts and reboots the guest + operating system (OS). The state of the VM is not saved prior to + the reset, so data might be lost. This action is equivalent to + selecting Reset from the + Machine menu of the GUI. + + + + Power Off a Virtual Machine + + + The VBoxManage controlvm + vmname poweroff command + powers off the VM. This command has the same effect on a VM as + pulling the power cable on a physical computer. + + + The state of the VM is not saved prior to poweroff, so data + might be lost. This action is equivalent to selecting + Close from the + Machine menu of the GUI or to + clicking the VM window's Close button, and then selecting + Power Off the Machine. + + + When in the powered off state, you can restart the VM. See + . + + + + Save the State of a Virtual Machine + + + The VBoxManage controlvm + vmname savestate command + saves the current state of the VM to disk and then stops the VM. + + + This action is equivalent to selecting + Close from the + Machine menu of the GUI or to + clicking the VM window's Close button, and then selecting + Save the Machine State. + + + When in the powered off state, you can restart the VM. + + + + Send an APCI Shutdown Signal to a Virtual Machine + + + The VBoxManage controlvm + vmname acpipowerbutton + command sends an ACPI shutdown signal to the VM. This command + has the same effect on a VM as pressing the Power button on a + physical computer. + + + So long as the VM runs a guest OS that provides ACPI support, + this command triggers a proper shutdown mechanism from within + the VM. + + + + Send an APCI Sleep Signal to a Virtual Machine + + + The VBoxManage controlvm + vmname acpisleepbutton + command sends an ACPI sleep signal to the VM. + + + So long as the VM runs a guest OS that provides ACPI support, + this command triggers a proper sleep mechanism from within the + VM. + + + + Send Keyboard Scancodes to a Virtual Machine + + + The VBoxManage controlvm + vmname keyboardputscancode + command sends keyboard scancode commands to the VM. + + + For information about keyboard scancodes, see + . + + + + Send Keyboard Strings to a Virtual Machine + + + The VBoxManage controlvm + vmname keyboardputstring + command sends keyboard strings to the VM. + + + + Send a File to a Virtual Machine + + + The VBoxManage controlvm + vmname keyboardputfile + command sends a file to the VM. + + + + Configure a Virtual Machine Target for Teleporting + + + The VBoxManage controlvm + vmname teleport command + initiates a teleporting operation between the specified VM and + the specified host system. See . + + + If you specify a password, it must match the password you + specified when you issued the VBoxManage + modifyvm command for the target machine. + + + + + + Specifies the name of the VM. + + + + + + Specifies the port on the VM that should listen for a + teleporting request from other VMs. The port number can be + any free TCP/IP port number, such as + 6000. + + + + + + Specifies the maximum downtime, in milliseconds, for the + teleporting target VM. + + + + + + Specifies the password that the source machine uses for + the teleporting request. The request succeeds only if the + source machine specifies the same password. + + This design does not conform to Oracle's security + guidelines. You should not be able to specify a password + on the command line because the password can be seen in a + process listing. + + The is mutually exclusive with + the option. + + + + + + Specifies the file from which to obtain the password that + the source machine uses for the teleporting request. The + request succeeds only if the source machine specifies the + same password. + + When you specify a file name of stdin, + you can read the password from standard input. + + The is mutually exclusive + with the option. + + + + + + Set the Link State for a Virtual Machine + + + VBoxManage controlvm vmname + setlinkstateN command + enables you to connect or disconnect the virtual network cable + from the network interface instance + (N). Valid values are + on and off. The default + value is on. + + + Before connecting the virtual network cable, use the + VBoxManage controlvm + nictracefileN command at + runtime to specify the name of the file in which to log the + trace. Otherwise, use the VBoxManage modifyvm + --nictracefileN=filename + command to specify the name of the file. + + + This subcommand does not affect the VM's running state directly. + + + + Set the Type of Networking to Use for a Virtual Machine + + + The VBoxManage controlvm + vmname + nicN command specifies the + type of networking to use on the specified VM's virtual network + card. N numbering begins with + 1. + + + The following valid network types are also described in + : + + + + null specifies that the VM is is not + connected to the host system. + + + nat specifies that the VM uses network + address translation (NAT). + + + bridged specifies that the VM uses + bridged networking. + + + intnet specifies that the VM communicates + with other VMs by using internal networking. + + + hostonly specifies that the VM uses + host-only networking. + + + natnetwork specifies that the VM uses NAT + networking. + + + generic specifies that the VM has access + to rarely used submodes + + + + This subcommand does not affect the VM's running state directly. + + + + Trace the Network Traffic of a Virtual Machine + + + The VBoxManage controlvm + vmname + nictraceN command enables + you to trace the network traffic on the specified virtual + network card (N). + N numbering begins with + 1. Valid values are on and + off. The default value is + off. + + + When set to on, use the same value of + N for the VBoxManage + controlvm vmname + nictracefileN command that + you use to specify the path name to the log file in which to + write trace output. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Network Traffic Trace Log File for a Virtual Machine + + + The VBoxManage controlvm + vmname + nictracefileN command + enables you to specify the name of the network traffic trace log + file for the specified virtual network card + (N). N + numbering begins with 1. Ensure that you use + the same value of N as you used for + the VBoxManage controlvm + vmname + nicN and + VBoxManage controlvm vmname + nictraceN commands. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Promiscuous Mode to Use for a Virtual Machine + + + The VBoxManage controlvm + vmname + nicpromiscN command enables + you to specify how to handle promiscuous mode for a bridged + network. The default value of deny hides any + traffic that is not intended for this VM. The + allow-vms value hides all host traffic from + this VM but enables the VM to see traffic to and from other VMs. + The allow-all value removes this restriction + completely. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Network Backend Property Values for a Virtual Machine + + + The VBoxManage controlvm + vmname + nicpropertyN + prop-name="prop-value" + command, in combination with nicgenericdrv, + enables you to pass property values to rarely-used network + backends. + + + Those properties are backend engine-specific, and are different + between UDP Tunnel and the VDE backend drivers. See + . + + + This subcommand does not affect the VM's running state directly. + + + + Specify a NAT Port Forwarding Rule for a Virtual Machine + + + The VBoxManage controlvm + vmname + natpfN command specifies a + NAT port-forwarding rule. See . + + + This subcommand does not affect the VM's running state directly. + + + + Delete a NAT Port Forwarding Rule for a Virtual Machine + + + The VBoxManage controlvm + vmname + natpfN delete deletes the + specified NAT port-forwarding rule. See + . + + + This subcommand does not affect the VM's running state directly. + + + + Change Size of a Virtual Machine's Guest Memory Balloon + + + The VBoxManage controlvm + vmname guestmemoryballoon + command changes the size of the guest memory balloon. The guest + memory balloon is the memory allocated by the &product-name; + Guest Additions from the guest OS and returned to the hypervisor + for reuse by other VMs. The value you specify is in megabytes. + See . + + + This subcommand does not affect the VM's running state directly. + + + + Make a Host System USB Device Visible to a Virtual Machine + + + The VBoxManage controlvm + vmname usbattach command + dynamically attaches a host USB device to the VM, which makes it + visible. You do not need to create a filter. + + + Specify a USB device by its Universally Unique Identifier (UUID) + or by its address on the host system. Use the + VBoxManage list usbhost command to obtain + information about USB devices on the host system. + + + Use the option to specify the + absolute path of a file in which to write logging data. + + + This subcommand does not affect the VM's running state directly. + + + + Make a Host System USB Device Invisible to a Virtual Machine + + + The VBoxManage controlvm + vmname usbdetach command + dynamically detaches a host USB device from the VM, which makes + it invisible. You do not need to create a filter. + + + Specify a USB device by its UUID or by its address on the host + system. Use the VBoxManage list usbhost + command to obtain information about USB devices on the host + system. + + + This subcommand does not affect the VM's running state directly. + + + + Enable or Disable Audio Capture From the Host System + + + The VBoxManage controlvm + vmname audioin command + specifies whether to enable or disable audio capture from the + host system. Valid values are on, which + enables audio capture and off, which disables + audio capture. The default value is off. + + + This subcommand does not affect the VM's running state directly. + + + + Enable or Disable Audio Playback From a Virtual Machine + + + The VBoxManage controlvm + vmname audioout command + specifies whether to enable or disable audio playback from the + guest VM. Valid values are on, which enables + audio playback and off, which disables audio + playback. The default value is off. + + + This subcommand does not affect the VM's running state directly. + + + + Specify How to Share The Host OS or Guest OS Clipboard + + + The VBoxManage controlvm + vmname clipboard command + specifies how to share the guest or host OS's clipboard with the + host system or VM. Valid values are disabled, + hosttoguest, guesttohost, + and bidirectional. The default value is + disabled. See + . + + + This feature requires that the &product-name; Guest Additions + are installed in the VM. + + + This subcommand does not affect the VM's running state directly. + + + + Set the Drag and Drop Mode Between the Host System and a Virtual Machine + + + The VBoxManage controlvm + vmname draganddrop command + specifies the current drag and drop mode to use between the host + system and the VM. Valid values are disabled, + hosttoguest, guesttohost, + and bidirectional. The default value is + disabled. See + . + + + This feature requires that the &product-name; Guest Additions + are installed in the VM. + + + This subcommand does not affect the VM's running state directly. + + + + Enable or Disable the VRDE Server + + + The VBoxManage controlvm + vmname vrde command enables + or disables the VirtualBox Remote Desktop Extension (VRDE) + server, if installed. Valid values are on and + off. The default value is + off. + + + This subcommand does not affect the VM's running state directly. + + + + Specify VRDE Server Ports + + + The VBoxManage controlvm + vmname vrdeport command + specifies the port or range of ports to which the VRDE server + can bind. The default value is default or + 0, which is the standard RDP port, + 3389. + + + Also see the option description in + . + + + This subcommand does not affect the VM's running state directly. + + + + Specify VRDE Server Port Numbers and IP Addresses + + + The VBoxManage controlvm + vmname vrdeproperty command + specifies the port numbers and IP address on the VM to which the + VRDE server can bind. + + + This subcommand does not affect the VM's running state directly. + + + + TCP/Ports specifies a port or a range of + ports to which the VRDE server can bind. The default value + is default or 0, which + is the standard RDP port, 3389. + + Also see the option description + in . + + + TCP/Address specifies the IP address of + the host network interface to which the VRDE server binds. + When specified, the server accepts to connect only on the + specified host network interface. + + Also see the option + description in . + + + VideoChannel/Enabled specifies whether to + enable the VirtualBox Remote Desktop Protocol (VRDP) video + channel. Valid values are 1 to enable the + video channel and 0 to disable the video + channel. The default value is off. See + . + + + VideoChannel/Quality specifies the JPEG + compression level on the VRDE server video channel. Valid + values are between 10% and 100%, inclusive. Lower values + mean lower quality but higher compression. The default value + is 100. See + . + + + VideoChannel/DownscaleProtection + specifies whether to enable the video channel downscale + protection feature. Specify 1 to enable + the feature. This feature is disabled by default. + + When enabled, if the video's size equals the shadow buffer + size, the video is shown in full-screen mode. If the video's + size is between full-screen mode and the downscale + threshold, the video is not shown as it might be an + application window that is unreadable when downscaled. When + disabled, the downscale protection feature always attempts + to show videos. + + + Client/DisableDisplay specifies whether + to disable the VRDE server display feature. Valid values are + 1 to disable the feature and null + (“”) to enable the feature. + The default value is null. See + . + + + Client/DisableInput specifies whether to + disable the VRDE server input feature. Valid values are + 1 to disable the feature and null + (“”) to enable the feature. + The default value is 1. See + . + + + Client/DisableAudio specifies whether to + disable the VRDE server audio feature. Valid values are + 1 to disable the feature and null + (“”) to enable the feature. + The default value is 1. See + . + + + Client/DisableUSB specifies whether to + disable the VRDE server USB feature. Valid values are + 1 to disable the feature and null + (“”) to enable the feature. + The default value is 1. See + . + + + Client/DisableClipboard specifies whether + to disable the VRDE clipboard feature. Valid values are + 1 to disable the feature and null + (“”) to enable the feature. + To reenable the feature, use + Client/DisableClipboard=. The default + value is 1. See + . + + + Client/DisableUpstreamAudio specifies + whether to disable the VRDE upstream audio feature. Valid + values are 1 to disable the feature and + null (“”) to enable the + feature. To reenable the feature, use + Client/DisableUpstreamAudio=. The default + value is 1. See + . + + + Client/DisableRDPDR specifies whether to + disable the RDP Device Redirection For Smart Cards feature + on the VRDE server. Valid values are 1 to + disable the feature and null + (“”) to enable the feature. + The default value is 1. See + . + + + H3DRedirect/Enabled specifies whether to + enable the VRDE server 3D redirection feature. Valid values + are 1 to enable the feature and null + (“”) to disable the feature. + See . + + + Security/Method specifies the security + method to use for a connection. See + . + + + Negotiate accepts both enhanced (TLS) + and standard RDP security connections. The security + method is negotiated with the client. This is the + default value. + + + RDP accepts only standard RDP + security connections. + + + TLS accepts only enhanced RDP + security connections. The client must support TLS. + + + + Security/ServerCertificate specifies the + absolute path of the server certificate to use for a + connection. See . + + + Security/ServerPrivateKey specifies the + absolute path of the server private key. See + . + + + Security/CACertificate specifies the + absolute path of the CA self-signed certificate. See + . + + + Audio/RateCorrectionMode specifies the + rate correction mode to use. + + + VRDP_AUDIO_MODE_VOID indicates that + no mode is specified. Use this value to unset any audio + mode that is already set. + + + VRDP_AUDIO_MODE_RC specifies to use + the rate correction mode. + + + VRDP_AUDIO_MODE_LPF specifies to use + the low pass filter mode. + + + VRDP_AUDIO_MODE_CS specifies to use + the client sync mode to prevent underflow or overflow of + the client queue. + + + + Audio/LogPath specifies the absolute path + of the audio log file. + + + + + Specify the Image Quality for VRDP Video Redirection + + + The VBoxManage controlvm + vmname + vrdevideochannelquality command sets the image + quality, as a JPEG compression level value, for video + redirection. Valid values are between 10% and 100%, inclusive. + Lower values mean lower quality but higher compression. See + . + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Video Mode for the Guest VM + + + The VBoxManage controlvm + vmname setvideomodehint + command specifies the video mode for the guest VM to use. You + must have the &product-name; Guest Additions installed. Note + that this feature does not work for all guest systems. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Screen Layout for a Display on the Guest VM + + + The VBoxManage controlvm + vmname setscreenlayout + command can be used to configure multiscreen displays. The + specified screen on the guest VM can be enabled or disabled, or + a custom screen layout can be configured. + + + This subcommand does not affect the VM's running state directly. + + + + Take a Screen Shot of the Virtual Machine Display + + + The VBoxManage controlvm + vmname screenshotpng + command takes a screenshot of the guest display and saves it as + PNG in the specified file. + + + This subcommand does not affect the VM's running state directly. + + + + filename specifies the name of + the PNG file to create. + + + display specifies the display + number for the screen shot. For a single monitor guest + display, this is 0. + + + + + Enable or Disable the Recording of a Virtual Machine Session + + + The VBoxManage controlvm + vmname recording command + enables or disables the recording of a VM session into a + WebM/VP8 file. Valid values are on, which + begins recording when the VM session starts and + off, which disables recording. The default + value is off. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Virtual Machine Screens to Record + + + The VBoxManage controlvm + vmname recording screens + command enables you to specify which VM screens to record. The + recording for each screen that you specify is saved to its own + file in the machine folder. You cannot modify this setting while + recording is enabled. + + + This subcommand does not affect the VM's running state directly. + + + + all specifies that you record all VM + screens. + + + none specifies that you do not record any + VM screens. + + + screen-ID specifies one or more + VM screens to record. + + + + + Specify the File in Which to Save Virtual Machine Recording + + + The VBoxManage controlvm + vmname recording filename + command specifies the file in which to save the recording. You + cannot modify this setting while recording is enabled. + + + The default setting is to store a recording in the machine + folder, using the VM name as the file name, with a + webm file name extension. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Resolution of the Recorded Video + + + VBoxManage controlvm vmname + recording videores command specifies the resolution of + the recorded video in pixels. You cannot modify this setting + while recording is enabled. + + + Use the Settings tool to view the video recording settings, + which are based on the resolution (frame size). See the Frame + Size field on the Recording tab of the Display page to view the + default value. + + + This subcommand does not affect the VM's running state directly. + + + Specify the resolution as + widthxheight: + + + + width specifies the width in + pixels. + + + height specifies the height in + pixels. + + + + + Specify the Bit Rate of the Video + + + + The VBoxManage controlvm + vmname recording videorate + command specifies the bit rate, + bit-rate, of the video in kilobits + per second. Increasing this value improves the appearance of the + video at the cost of an increased file size. You cannot modify + this setting while recording is enabled. + + + Use the Settings tool to view the video recording settings, + which are based on the frame size. See the Video Quality field + on the Recording tab of the Display page to view the default + value. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Maximum Frequency of the Video + + + The VBoxManage controlvm + vmname recording videofps + command specifies the maximum frequency of the video to record. + Video frequency is measured in frames per second (FPS). The + recording skips any frames that have a frequency higher than the + specified maximum. Increasing the frequency reduces the number + of skipped frames and increases the file size. You cannot modify + this setting while recording is enabled. + + + Use the Settings tool to view the video recording settings, + which are based on the frame size. See the Frame Rate field on + the Recording tab of the Display page to view the default value. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Maximum Amount of Time to Record Video + + + + The VBoxManage controlvm + vmname recording maxtime + command specifies the maximum amount time to record in seconds. + The recording stops after the specified number of seconds + elapses. If this value is zero, the recording continues until + you stop the recording. + + + This subcommand does not affect the VM's running state directly. + + + + Specify the Maximum Size of the Recorded Video + + + The VBoxManage controlvm + vmname recording + maxfilesize command specifies the maximum size of the + recorded video file in megabytes. The recording stops when the + file reaches the specified size. If this value is zero, the + recording continues until you stop the recording. You cannot + modify this setting while recording is enabled. + + + This subcommand does not affect the VM's running state directly. + + + + Specify Credentials for Remote Logins on Windows Virtual Machines + + + The setcredentials command enables you to + specify the credentials for remotely logging in to Windows VMs. + See . + + + This subcommand does not affect the VM's running state directly. + + + + username specifies the user name + with which to log in to the Windows VM. + + + + specifies the file from which to obtain the password for + username. + + The is mutually exclusive + with the option. + + + + specifies the password for + username. + + This design does not conform to Oracle's security + guidelines. You should not be able to specify a password on + the command line because the password can be seen in a + process listing. + + The is mutually exclusive with + the option. + + + specifies whether to + enable or disable local logins. Valid values are + on to enable local logins and + off to disable local logins. + + + + + Add a Virtual CPU to a Virtual Machine + + + The VBoxManage controlvm + vmname plugcpu command adds + a virtual CPU to the specified VM if CPU hot-plugging is + enabled. ID specifies the index of + the virtual CPU to be added and must be a number from 0 to the + maximum number of CPUs configured. + + + This subcommand does not affect the VM's running state directly. + + + + Remove a Virtual CPU From a Virtual Machine + + + The VBoxManage controlvm + vmname unplugcpu command + removes a virtual CPU from the specified VM if CPU hot-plugging + is enabled. ID specifies the index of + the virtual CPU to be removed and must be a number from 0 to the + maximum number of CPUs configured. You cannot remove CPU 0. + + + This subcommand does not affect the VM's running state directly. + + + + Set the Maximum Amount of Physical CPU Time Used by a Virtual CPU + + + The VBoxManage controlvm + vmname cpuexecutioncap + command specifies how the maximum amount of physical CPU time + used by a virtual CPU. Valid values are a percentage between + 1 and 100. A value of + 50 specifies that a single virtual CPU can + use up to 50% of a physical CPU. The default value is + 100. + + + This subcommand does not affect the VM's running state directly. + + + + Change the Priority of a VM Process + + + The VBoxManage controlvm + vmname vm-process-priority + command specifies the priority scheme of the VM process to use + when starting the specified VM and while the VM runs. + + + Valid values are default, + flat, low, + normal, and high. + + + This subcommand does not affect the VM's running state directly. + + + + Attach a Webcam to a Virtual Machine + + + The VBoxManage controlvm + vmname webcam attach + command attaches a webcam to a running VM. Specify the webcam as + the absolute path of the webcam on the host OS or as an alias. + Use the VBoxManage list webcams command to + obtain the webcam alias. + + + Note that the .0 alias is the default video + input device on the host OS. .1 is the first + video input device, .2 is the second video + input device, and so on. The order of the devices is specific to + the host system. + + + You can specify optional settings in the form of + semi-colon-separated (;) name-value pairs. + These properties enable you to configure the emulated webcam + device. + + + The following settings are supported: + + + + MaxFramerate + + Specifies the highest rate at which to send video frames + to the VM. The rate is in frames per second. Higher frame + rates increase CPU load, so you can use this setting to + reduce CPU load. The default value is no maximum + limit. This value enables the VM to use any + frame rate supported by the webcam. + + + + MaxPayloadTransferSize + + Specifies the maximum number of bytes that the VM receives + from the emulated webcam in one buffer. The default + setting is 3060 bytes, which is used by + some webcams. If the VM is able to use larger buffers, + higher values might reduce CPU load slightly. Note that + some guest OSes might not suppport higher + MaxPayloadTransferSize values. + + + + + This subcommand does not affect the VM's running state directly. + + + + Detach a Webcam From a Virtual Machine + + + The VBoxManage controlvm + vmname webcam detach + command detaches a webcam from a running VM. Specify the webcam + as the absolute path of the webcam on the host OS or as an + alias. Use the VBoxManage list webcams to + obtain the webcam alias. + + + When a webcam device is detached from the host, the host OS + determines how the emulated webcam behaves. + + + + Windows hosts: The emulated + webcam device is detached from the VM automatically. + + + Mac OS X hosts that run at least OS X + 10.7: The emulated webcam device remains attached + to the VM and you must detach it manually by using the + VBoxManage controlvm webcam detach + command. + + + Linux hosts: The emulated + webcam device is detached from the VM automatically only if + the webcam is actively streaming video. If the emulated + webcam is inactive, manually detach it by using the + VBoxManage controlvm + vmname webcam detach + command. + + + + This subcommand does not affect the VM's running state directly. + + + + List the Webcams Attached to a Virtual Machine + + + The VBoxManage controlvm + vmname webcam list command + lists webcams that are attached to the running VM. The output + shows a list of absolute paths or aliases that attached the + webcams to the VM by using the VBoxManage controlvm + vmname webcam attach + command. + + + This subcommand does not affect the VM's running state directly. + + + + Set an Encryption Password for a Virtual Machine + + + The VBoxManage controlvm + vmname addencpassword + command provides the vmname encrypted + VM with the encryption password to enable a headless start. + Specify the absolute path of a password file on the host system. + If filename is -, + VBoxManage prompts for the encryption + password. + + + Use the option to specify + whether to save the passsword or clear it from VM memory when + the VM is suspended. + + + If the VM is suspended and the password is cleared, use the + VBoxManage controlvm vmname + addencpassword to provide the password to resume + execution on the VM. Use this feature when you do not want to + store the password in VM memory while the VM is suspended by a + host suspend event. + + + + You can encrypt data stored on hard disk images used by the + VM. &product-name; uses the AES algorithm in XTS mode and + supports 128-bit or 256-bit data encryption keys (DEK). The + encrypted DEK is stored in the medium properties and is + decrypted during VM startup when you provide the encryption + password. + + + + Use the VBoxManage encryptmedium command to + create a DEK encrypted medium. See + . + + + The &product-name; GUI prompts you for the encryption password + when you start an encrypted VM. + + + Use the following command to perform a headless start of an + encrypted VM: + + + $ VBoxManage startvm vmname --type headless + + + Then, use the following command to provide the encryption + password: + + + $ VBoxManage vmname controlvm addencpassword vmname - + Password: encryption-password + + + This subcommand does not affect the VM's running state directly. + + + + Disable an Encryption Password for a Virtual Machine + + + The VBoxManage controlvm + vmname removeencpassword + command disables a specific encryption password for all + encrypted media attached to the VM. + + + ID is the password identifier for the + encryption password that you want to disable. + + + This subcommand does not affect the VM's running state directly. + + + + Disable All Encryption Passwords for a Virtual Machine + + + The VBoxManage controlvm + vmname + removeallencpasswords command disables all encryption + passwords for all encrypted media attached to the VM. + + + This subcommand does not affect the VM's running state directly. + + + + Change the Connection Mode for a Virtual Serial Port on a Virtual + Machine + + + The VBoxManage controlvm + vmname changeuartmode + command changes the connection mode for the specified virtual + serial port. Valid serial port values are integers that start + from 1. + + + This subcommand does not affect the VM's running state directly. + + + + disconnected + + Disconnects the device. + + + + server pipe-name + + Specifies the pipe name of the server. + + + + client pipe-name + + Specifies the pipe name of the client. + + + + tcpserver port + + Specifies the port number of the TCP server. + + + + tcpclient hostname:port + + Specifies the host name and port number of the TCP client. + + + + file filename + + Specifies the name of the file. + + + + device-name + + Specifies the name of the device. + + + + + + + + Examples + + + The following command temporarily stops the execution of the + ol7 VM. + +$ VBoxManage controlvm ol7 pause + + The following command configures shared clipboard operation for + the ol7 VM. Copying of clipboard data is + allowed in both directions between the host and guest. + +$ VBoxManage controlvm ol7 clipboard bidirectional + + + + See Also + + , + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-convertfromraw.xml b/doc/manual/en_US/man_VBoxManage-convertfromraw.xml new file mode 100644 index 00000000..ac94d0cc --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-convertfromraw.xml @@ -0,0 +1,239 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage convertfromraw + + + + VBoxManage-convertfromraw + 1 + + + + VBoxManage-convertfromraw + convert a raw disk image to a virtual disk image + Oracle VM VirtualBox + + + + + + VBoxManage convertfromraw + inputfile + outputfile + --format= + VDI + VMDK + VHD + + --uuid=uuid + --variant=Standard,Fixed,Split2G,Stream,ESX + + + + VBoxManage convertfromraw stdin + outputfile + --format= + VDI + VMDK + VHD + + --uuid=uuid + --variant=Standard,Fixed,Split2G,Stream,ESX + + + + + Description + + The VBoxManage convertfromraw command enables + you to convert a raw disk image to an &product-name; virtual disk + image (VDI). + + + + For compatibility with earlier versions of &product-name;, you + can use the VBoxManage convertdd command + instead of the VBoxManage convertfromraw + command. + + + + Convert a Raw Disk File to a Virtual Disk Image File + + + The VBoxManage convertfromraw command + converts the specified raw disk image input file to an + &product-name; VDI file. + + + + inputfile + + Specifies the name of the raw disk image file to convert. + + + + outputfile + + Specifies the name of the file in which to write the VDI + output. + + + + + + Specifies the format of the disk image to create. Valid + values are VDI, + VMDK, and VHD. The + default format is VDI. + + + + + + Specifies the Universally Unique Identifier (UUID) of the + output file. + + + + + + Specifies any required file format variants for the output + file. This is a comma-separated list of variant values. + Following are the valid values: + + + Standard is the default disk image + type, which has a dynamically allocated file size. + + + Fixed uses a disk image that has a + fixed file size. + + + Split2G indicates that the disk + image is split into 2GB segments. This value is for + VMDK only. + + + Stream optimizes the disk image for + downloading. This value is for VMDK only. + + + ESX is used for some VMWare + products. This value is for VMDK only. + + + Note that not all variant combinations are valid. + Specifying incompatible variant values in the list will + produce an error message. + + + + + + Convert Raw Data From Standard Input to a Virtual Disk Image File + + + The VBoxManage convertfromraw stdin command + reads the content of the disk image from standard input. + Consider using this form of the command in a pipe sequence. + + + + outputfile + + Specifies the name of the file in which to write the VDI + output. + + + + + + Specifies the format of the disk image to create. Valid + values are VDI, + VMDK, and VHD. The + default format is VDI. + + + + + + Specifies the UUID of the output file. + + + + + + Specifies any required file format variants for the output + file. This is a comma-separated list of variant values. + Following are the valid values: + + + Standard is the default disk image + type, which has a dynamically allocated file size. + + + Fixed uses a disk image that has a + fixed file size. + + + Split2G indicates that the disk + image is split into 2GB segments. This value is for + VMDK only. + + + Stream optimizes the disk image for + downloading. This value is for VMDK only. + + + ESX is used for some VMWare + products. This value is for VMDK only. + + + Note that not all variant combinations are valid. + Specifying incompatible variant values in the list will + produce an error message. + + + + + + + + Examples + + + The following command converts the raw disk image input file + disk01.raw. The output file is a VDI disk + image called disk02.vdi. + +$ VBoxManage convertfromraw disk01.raw disk02.vdi + + The following command converts the raw disk image input file + disk01.raw. The output file is a VMDK disk + image called disk02.vmdk. + +$ VBoxManage convertfromraw disk01.raw disk02.vmdk --format VMDK + + diff --git a/doc/manual/en_US/man_VBoxManage-createmedium.xml b/doc/manual/en_US/man_VBoxManage-createmedium.xml new file mode 100644 index 00000000..1d457061 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-createmedium.xml @@ -0,0 +1,180 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage createmedium + + + + VBoxManage-createmedium + 1 + + + + VBoxManage-createmedium + create a new medium + Oracle VM VirtualBox + + + + + + VBoxManage createmedium + + disk + dvd + floppy + + --filename=filename + + --size=megabytes + --sizebyte=bytes + + --diffparent= + UUID + filename + + --format= + VDI + VMDK + VHD + + --variant Standard,Fixed,Split2G,Stream,ESX,Formatted + + + + + Description + + The VBoxManage createmedium command creates a + new medium, such as a disk image file. + + + + For compatibility with earlier versions of &product-name;, you + can use the createvdi and + createhd commands instead of the + createmedium command. + + + + + disk | dvd | floppy + + Specifies the media type. The default value is + disk. + + + + + + Specifies the absolute path name to a file on the host file + system. + + + + + + Specifies the image capacity in one megabyte units. + + + + + + Specifies the image capacity in one byte units. + + + + + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of a differencing image parent file on + the host file system. + + Use this file to share a base box disk image among VMs. + + + + + + Specifies the file format of the output file. Valid formats + are VDI, VMDK, and + VHD. The default format is + VDI. + + + + + + Specifies the file format variant for the target medium, + which is a comma-separated list of variants. Following are + the valid values: + + + Standard is the default disk image + type, which has a dynamically allocated file size. + + + Fixed uses a disk image that has a + fixed file size. + + + Split2G indicates that the disk image + is split into 2GB segments. This value is for VMDK only. + + + Stream optimizes the disk image for + downloading. This value is for VMDK only. + + + ESX is used for some VMWare products. + This value is for VMDK only. + + + Formatted + + For floppy images only. Formats the medium + automatically. + + + Note that not all variant combinations are valid. Specifying + incompatible variant values in the list will produce an + error message. + + + + + + + Examples + + + The following command creates a new disk image file called + disk01.vdi. The file size is 1024 megabytes. + +$ VBoxManage createmedium --filename disk01.vdi --size 1024 + + The following command creates a new floppy disk image file called + floppy01.vdi. The file size is 1 megabyte. + +$ VBoxManage createmedium floppy --filename floppy01.img --size 1 + + diff --git a/doc/manual/en_US/man_VBoxManage-createvm.xml b/doc/manual/en_US/man_VBoxManage-createvm.xml new file mode 100644 index 00000000..bcfbbcd6 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-createvm.xml @@ -0,0 +1,163 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage createvm + + + + VBoxManage-createvm + 1 + + + + VBoxManage-createvm + create a new virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage createvm + --name=name + --basefolder=basefolder + --default + --group=group-ID, ... + --ostype=ostype + --register + --uuid=uuid + + + + + Description + + The VBoxManage createvm command creates a new + XML virtual machine (VM) definition file. + + + You must specify the name of the VM by using . This name is used by + default as the name of the settings file that has the + .vbox extension and the machine folder, which + is a subfolder of the $HOME/VirtualBox VMs + directory. + + + Ensure that the VM name conforms to the host OS file name + requirements. If you later rename the VM, the file and folder + names will be updated to match the new name automatically. + + + + + Command Options + + In addition to specifying the name or UUID of the VM, which is + required, you can specify any of the following options: + + + + + + Specifies the name of the folder in which to save the + machine configuration file for the new VM. + + Note that the names of the file and the folder do not change + if you rename the VM. + + + + + + Applies a default hardware configuration for the specified + guest OS. By default, the VM is created with minimal + hardware. + + + + + + Assigns the VM to the specified groups. If you specify more + than one group, separate each group name with a comma. + + Note that each group is identified by a group ID that starts + with a slash character (/) so that groups + can be nested. By default, a VM is always assigned + membership to the / group. + + + + + + Specifies the guest OS to run in the VM. Run the + VBoxManage list ostypes command to see + the available OS types. + + + + + + Registers the VM with your &product-name; installation. By + default, the VBoxManage createvm command + creates only the XML configuration for the VM but does not + register the VM. If you do not register the VM at creation, + you can run the VBoxManage registervm + command after you create the VM. + + + + + + Specifies the Universally Unique Identifier (UUID) of the + VM. Ensure that this UUID is unique within the + &product-name; namespace of the host or of its VM group + memberships if you decide to register the VM. By default, + &product-name; command provides the UUID. + + + + + + + Examples + + + The following command creates a VM called vm2 + where you plan to run a 64-bit version of Oracle Linux. + +$ VBoxManage createvm --name "vm2" --ostype "Oracle_64" + + The following command creates and registers a VM called + vm3. + +$ VBoxManage createvm --name "vm3" --register + + + + See Also + + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-debugvm.xml b/doc/manual/en_US/man_VBoxManage-debugvm.xml new file mode 100644 index 00000000..eaa7cbd1 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-debugvm.xml @@ -0,0 +1,615 @@ + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage debugvm + + + + VBoxManage-debugvm + 1 + + + + VBoxManage-debugvm + introspection and guest debugging + Oracle VM VirtualBox + + + + + VBoxManage debugvm + uuid|vmname + dumpvmcore + --filename=name + + + VBoxManage debugvm + uuid|vmname + info + item + args + + + VBoxManage debugvm + uuid|vmname + injectnmi + + + VBoxManage debugvm + uuid|vmname + log + --release--debug + group-settings + + + VBoxManage debugvm + uuid|vmname + logdest + --release--debug + destinations + + + VBoxManage debugvm + uuid|vmname + logflags + --release--debug + flags + + + VBoxManage debugvm + uuid|vmname + osdetect + + + VBoxManage debugvm + uuid|vmname + osinfo + + + VBoxManage debugvm + uuid|vmname + osdmesg + --lines=lines + + + VBoxManage debugvm + uuid|vmname + getregisters + --cpu=id + reg-set.reg-name + + + VBoxManage debugvm + uuid|vmname + setregisters + --cpu=id + reg-set.reg-name=value + + + VBoxManage debugvm + uuid|vmname + show + --human-readable--sh-export--sh-eval--cmd-set + settings-item + + + VBoxManage debugvm + uuid|vmname + stack + --cpu=id + + + VBoxManage debugvm + uuid|vmname + statistics + --reset + --descriptions + --pattern=pattern + + + + Description + + The "debugvm" commands are for experts who want to tinker with the + exact details of virtual machine execution. Like the VM debugger + described in , these commands are only useful if you are + very familiar with the details of the PC architecture and how to debug + software. + + + Common options + + The subcommands of debugvm all operate on a running virtual + machine: + + + uuid|vmname + Either the UUID or the name (case sensitive) of a VM. + + + + + + debugvm dumpvmcore + + + Creates a system dump file of the specified VM. This file will have + the standard ELF core format (with custom sections); see + . + + + This corresponds to the writecore command in the debugger. + + + + + The name of the output file. + + + + + + debugvm info + + + Displays info items relating to the VMM, device emulations and + associated drivers. + + + This corresponds to the info command in the debugger. + + + + info + + Name of the info item to display. The special name + will list all the available info items and + hints about optional arguments. + + + + args + + Optional argument string for the info item handler. Most info items + does not take any extra arguments. Arguments not recognized are generally + ignored. + + + + + + + debugvm injectnmi + + + Causes a non-maskable interrupt (NMI) to be injected into the guest. This + might be useful for certain debugging scenarios. What happens exactly is + dependent on the guest operating system, but an NMI can crash the whole + guest operating system. Do not use unless you know what you're doing. + + + + + debugvm log + + + Changes the group settings for either debug () + or release () logger of the VM process. + + + The group-settings are typically strings on the form + em.e.f.l, hm=~0 + and -em.f. Basic wildcards are supported for + group matching. The all group is an alias for + all the groups. + + + Please do keep in mind that the group settings are applied as modifications + to the current ones. + + + This corresponds to the log command in the debugger. + + + + + debugvm logdest + + + Changes the destination settings for either debug () + or release () logger of the VM process. For details + on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp. + + + The destinations is one or more mnemonics, optionally + prefixed by "no" to disable them. Some of them take values after a ":" or "=" + separator. Multiple mnemonics can be separated by space or given as separate + arguments on the command line. + + + List of available destination: + + + + + Specifies a log file. It no filname is given, one will be + generated based on the current UTC time and VM process name and placed in + the current directory of the VM process. Note that this will currently not + have any effect if the log file has already been opened. + + + + + Specifies the output directory for log files. Note that this + will currently not have any effect if the log file has already been opened. + + + + + A non-zero value enables log historization, with the value + specifying how many old log files to keep. + + + + + The max size of a log file before it is historized. Default is infinite. + + + + The max age (in seconds) of a log file before it is historized. Default is infinite. + + + + Only log to the log buffer until an explicit flush (e.g. via an assertion) + occurs. This is fast and saves diskspace. + + + + Write the log content to standard output. + + + + Write the log content to standard error. + + + + Write the log content to the debugger, if supported by the host OS. + + + + Writes logging to the COM port. This is only applicable for raw-mode and ring-0 logging. + + + + Custom destination which has no meaning to VM processes.. + + + + This corresponds to the logdest command in the debugger. + + + + + debugvm logflags + + + Changes the flags on either debug () or release + () logger of the VM process. Please note that the + modifications are applied onto the existing changes, they are not replacing them. + + + The flags are a list of flag mnemonics, optionally + prefixed by a "no", "!", "~" or "-" to negate their meaning. The "+" prefix + can be used to undo previous negation or use as a separator, though better use + whitespace or separate arguments for that. + + + List of log flag mnemonics, with their counter form where applicable + (asterisk indicates defaults): + + + + + Enables or disables logging. + + + + Enabling buffering of log output before it hits the destinations. + + + + Whether to open the destination file with writethru buffering settings or not. + + + + Enables flushing of the output file (to disk) after each log statement. + + + + + Prefix each log line with lock counts for the current thread. + + + + Prefix each log line with the ID of the current CPU. + + + + Prefix each log line with the current process ID. + + + + Prefix each log line with the numberic flags corresponding to the log statement. + + + + Prefix each log line with the flag mnemonics corresponding to the log statement. + + + + Prefix each log line with the log group number for the log statement producing it. + + + + Prefix each log line with the log group name for the log statement producing it. + + + + Prefix each log line with the current thread identifier. + + + + Prefix each log line with the current thread name. + + + + Prefix each log line with the current UTC wall time. + + + + Prefix each log line with the current monotonic time since the start of the program. + + + + Prefix each log line with the current monotonic timestamp value in milliseconds since the start of the program. + + + + Prefix each log line with the current monotonic timestamp value in nanoseconds. + + + + Prefix each log line with the current CPU timestamp counter (TSC) value. + + + + Selects the whether ts and + tsc prefixes should be displayed as relative to the + previous log line or as absolute time. + + + + Selects the whether the ts and + tsc prefixes should be formatted as hexadecimal + or decimal. + + + + + + Custom log prefix, has by default no meaning for VM processes. + + + + + Output with DOS style (CRLF) or just UNIX style (LF) line endings. + + + + Overwrite the destination file or append to it. + + + + + This corresponds to the logflags command in the debugger. + + + + + debugvm osdetect + + + Make the VMM's debugger facility (re)-detect the guest operating system (OS). + This will first load all debugger plug-ins. + + + This corresponds to the detect command in the debugger. + + + + + debugvm osinfo + + + Displays information about the guest operating system (OS) previously + detected by the VMM's debugger facility. + + + + + debugvm osdmesg + + + Displays the guest OS kernel log, if detected and supported. + + + + + Number of lines of the log to display, counting from + the end. The default is infinite. + + + + + + debugvm getregisters + + + Retrieves register values for guest CPUs and emulated devices. + + + + reg-set.reg-name + + One of more registers, each having one of the following forms: + + register-set.register-name.sub-field + register-set.register-name + cpu-register-name.sub-field + cpu-register-name + all + + The all form will cause all registers + to be shown (no sub-fields). The registers names are case-insensitive. + + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + debugvm setregisters + + + Changes register values for guest CPUs and emulated devices. + + + + reg-set.reg-name=value + + One of more register assignment, each having one of the following forms: + + register-set.register-name.sub-field=value + register-set.register-name=value + cpu-register-name.sub-field=value + cpu-register-name=value + + The value format should be in the same style as what + getregisters displays, with the exception that + both octal and decimal can be used instead of hexadecimal. + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + debugvm show + + + Shows logging settings for the VM. + + + + + Selects human readable output. + + + + Selects output format as bourne shell style export commands. + + + + Selects output format as bourne shell style eval command input. + + + + Selects output format as DOS style SET commands. + + + settings-item + + What to display. One or more of the following: + + logdbg-settings - debug log settings. + logrel-settings - release log settings. + log-settings - alias for both debug and release log settings. + + + + + + + + + debugvm stack + + + Unwinds the guest CPU stacks to the best of our ability. It is + recommended to first run the osdetect command, as this + gives both symbols and perhaps unwind information. + + + + + Selects a single guest CPU to display the stack for. The default is all CPUs. + + + + + + + debugvm statistics + + + Displays or resets VMM statistics. + + + Retrieves register values for guest CPUs and emulated devices. + + + + + DOS/NT-style wildcards patterns for selecting statistics. Multiple + patterns can be specified by using the '|' (pipe) character as separator. + + + + + Select reset instead of display mode. + + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml b/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml new file mode 100644 index 00000000..73f32a0e --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xml @@ -0,0 +1,221 @@ + + + + + + 1 - SubnetMask + IPv4 netmask. Set to the value of the --netmask option by default. + + 2 - TimeOffset + UTC offset in seconds (32-bit decimal value). + + 3 - Routers + Space separated list of IPv4 router addresses. + + 4 - TimeServers + Space separated list of IPv4 time server (RFC 868) addresses. + + 5 - NameServers + Space separated list of IPv4 name server (IEN 116) addresses. + + 6 - DomainNameServers + Space separated list of IPv4 DNS addresses. + + 7 - LogServers + Space separated list of IPv4 log server addresses. + + 8 - CookieServers + Space separated list of IPv4 cookie server (RFC 865) addresses. + + 9 - LPRServers + Space separated list of IPv4 line printer server (RFC 1179) addresses. + + 10 - ImpressServers + Space separated list of IPv4 imagen impress server addresses. + + 11 - ResourseLocationServers + Space separated list of IPv4 resource location (RFC 887) addresses. + + 12 - HostName + The client name. See RFC 1035 for character limits. + + 13 - BootFileSize + Number of 512 byte blocks making up the boot file (16-bit decimal value). + + 14 - MeritDumpFile + Client core file. + + 15 - DomainName + Domain name for the client. + + 16 - SwapServer + IPv4 address of the swap server that the client should use. + + 17 - RootPath + The path to the root disk the client should use. + + 18 - ExtensionPath + Path to a file containing additional DHCP options (RFC2123). + + 19 - IPForwarding + Whether IP forwarding should be enabled by the client (boolean). + + 20 - OptNonLocalSourceRouting + Whether non-local datagrams should be forwarded by the client (boolean) + + 21 - PolicyFilter + List of IPv4 addresses and masks paris controlling non-local source routing. + + 22 - MaxDgramReassemblySize + The maximum datagram size the client should reassemble (16-bit decimal value). + + 23 - DefaultIPTTL + The default time-to-leave on outgoing (IP) datagrams (8-bit decimal value). + + 24 - PathMTUAgingTimeout + RFC1191 path MTU discovery timeout value in seconds (32-bit decimal value). + + 25 - PathMTUPlateauTable + RFC1191 path MTU discovery size table, sorted in ascending order (list of 16-bit decimal values). + + 26 - InterfaceMTU + The MTU size for the interface (16-bit decimal value). + + 27 - AllSubnetsAreLocal + Indicates whether the MTU size is the same for all subnets (boolean). + + 28 - BroadcastAddress + Broadcast address (RFC1122) for the client to use (IPv4 address). + + 29 - PerformMaskDiscovery + Whether to perform subnet mask discovery via ICMP (boolean). + + 30 - MaskSupplier + Whether to respond to subnet mask requests via ICMP (boolean). + + 31 - PerformRouterDiscovery + Whether to perform router discovery (RFC1256) (boolean). + + 32 - RouterSolicitationAddress + Where to send router solicitation requests (RFC1256) (IPv4 address). + + 33 - StaticRoute + List of network and router address pairs addresses. + + 34 - TrailerEncapsulation + Whether to negotiate the use of trailers for ARP (RTF893) (boolean). + + 35 - ARPCacheTimeout + The timeout in seconds for ARP cache entries (32-bit decimal value). + + 36 - EthernetEncapsulation + Whether to use IEEE 802.3 (RTF1042) rather than of v2 (RFC894) ethernet encapsulation (boolean). + + 37 - TCPDefaultTTL + Default time-to-live for TCP sends (non-zero 8-bit decimal value). + + 38 - TCPKeepaliveInterval + The interface in seconds between TCP keepalive messages (32-bit decimal value). + + 39 - TCPKeepaliveGarbage + Whether to include a byte of garbage in TCP keepalive messages for backward compatibility (boolean). + + 40 - NISDomain + The NIS (Sun Network Information Services) domain name (string). + + 41 - NISServers + Space separated list of IPv4 NIS server addresses. + + 42 - NTPServers + Space separated list of IPv4 NTP (RFC1035) server addresses. + + 43 - VendorSpecificInfo + Vendor specific information. Only accessible using --set-opt-hex. + + 44 - NetBIOSNameServers + Space separated list of IPv4 NetBIOS name server (NBNS) addresses (RFC1001,RFC1002). + + 45 - NetBIOSDatagramServers + Space separated list of IPv4 NetBIOS datagram distribution server (NBDD) addresses (RFC1001,RFC1002). + + 46 - NetBIOSNodeType + NetBIOS node type (RFC1001,RFC1002): 1=B-node, 2=P-node, 4=M-node, and 8=H-node (8-bit decimal value). + + 47 - NetBIOSScope + NetBIOS scope (RFC1001,RFC1002). Only accessible using --set-opt-hex. + + 48 - XWindowsFontServers + Space separated list of IPv4 X windows font server addresses. + + 49 - XWindowsDisplayManager + Space separated list of IPv4 X windows display manager addresses. + + 62 - NetWareIPDomainName + Netware IP domain name (RFC2242) (string). + + 63 - NetWareIPInformation + Netware IP information (RFC2242). Only accessible using --set-opt-hex. + + 64 - NISPlusDomain + The NIS+ domain name (string). + + 65 - NISPlusServers + Space separated list of IPv4 NIS+ server addresses. + + 66 - TFTPServerName + TFTP server name (string). + + 67 - BootfileName + Bootfile name (string). + + 68 - MobileIPHomeAgents + Space separated list of IPv4 mobile IP agent addresses. + + 69 - SMTPServers + Space separated list of IPv4 simple mail transport protocol (SMPT) server addresses. + + 70 - POP3Servers + Space separated list of IPv4 post office protocol 3 (POP3) server addresses. + + 71 - NNTPServers + Space separated list of IPv4 network news transport protocol (NTTP) server addresses. + + 72 - WWWServers + Space separated list of default IPv4 world wide web (WWW) server addresses. + + 73 - FingerServers + Space separated list of default IPv4 finger server addresses. + + 74 - IRCServers + Space separated list of default IPv4 internet relay chat (IRC) server addresses. + + 75 - StreetTalkServers + Space separated list of IPv4 StreetTalk server addresses. + + 76 - STDAServers + Space separated list of IPv4 StreetTalk directory assistance (STDA) server addresses. + + 78 - SLPDirectoryAgent + Addresses of one or more service location protocol (SLP) directory agent, and an indicator of whether their use is mandatory. Only accessible using --set-opt-hex. + + 79 - SLPServiceScope + List of service scopes for the service location protocol (SLP) and whether using the list is mandator. Only accessible using --set-opt-hex. + + 119 - DomainSearch + Domain search list, see RFC3397 and section 4.1.4 in RFC1035 for encoding. Only accessible using --set-opt-hex. + + diff --git a/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl b/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl new file mode 100644 index 00000000..ac5bd090 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-dhcpserver-dhcpoptions.xsl @@ -0,0 +1,114 @@ + + + + + + + + + + + + + + + + + the value of the --netmask option + + + + --set-opt-hex + + + + + + + + + <varlistentry> + <term></term> + <listitem><para> + + </para></listitem> + </varlistentry> + + + + <?xml version="1.0" encoding="UTF-8"?> +<!-- + Manually generated from src/VBox/Main/idl/VirtualBox.xidl by 'kmk dhcpoptions'. + DO NOT EDIT! + + + Copyright (C) 2019-2020 Oracle Corporation + + This file is part of VirtualBox Open Source Edition (OSE), as + available from http://www.virtualbox.org. This file is free software; + you can redistribute it and/or modify it under the terms of the GNU + General Public License (GPL) as published by the Free Software + Foundation, in version 2 as it comes in the "COPYING" file of the + VirtualBox OSE distribution. VirtualBox OSE is distributed in the + hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. +--> + + <variablelist> + + + + </variablelist> + + + + + + + + + + + + text() + + + + + + [@id= + + ] + + + [] + + + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-dhcpserver.xml b/doc/manual/en_US/man_VBoxManage-dhcpserver.xml new file mode 100644 index 00000000..3d502a64 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-dhcpserver.xml @@ -0,0 +1,564 @@ + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage dhcpserver + + + + VBoxManage-dhcpserver + 1 + + + + VBoxManage-dhcpserver + DHCP server management + Oracle VM VirtualBox + + + + + VBoxManage dhcpserver add + + --network=netname + --interface=ifname + + --server-ip=address + --netmask=mask + --lower-ip=address + --upper-ip=address + + --enable + --disable + + + + --global + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + + + + --group=name + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --incl-mac=address + --excl-mac=address + --incl-mac-wild=pattern + --excl-mac-wild=pattern + --incl-vendor=string + --excl-vendor=string + --incl-vendor-wild=pattern + --excl-vendor-wild=pattern + --incl-user=string + --excl-user=string + --incl-user-wild=pattern + --excl-user-wild=pattern + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + + + + --vm=name|uuid + --nic=1-N + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --fixed-address=address + + + + --mac-address=address + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --fixed-address=address + + + + VBoxManage dhcpserver modify + + --network=netname + --interface=ifname + + --server-ip=address + --lower-ip=address + --upper-ip=address + --netmask=mask + + --enable + --disable + + + + --global + --del-opt=dhcp-opt-no + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --unforce-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --unsupress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --remove-config + + + + --group=name + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --unforce-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --unsupress-opt=dhcp-opt-no + --del-mac=address + --incl-mac=address + --excl-mac=address + --del-mac-wild=pattern + --incl-mac-wild=pattern + --excl-mac-wild=pattern + --del-vendor=string + --incl-vendor=string + --excl-vendor=string + --del-vendor-wild=pattern + --incl-vendor-wild=pattern + --excl-vendor-wild=pattern + --del-user=string + --incl-user=string + --excl-user=string + --del-user-wild=pattern + --incl-user-wild=pattern + --excl-user-wild=pattern + --zap-conditions + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --remove-config + + + + --vm=name|uuid + --nic=1-N + --del-opt=dhcp-opt-no + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --unforce-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --unsupress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --fixed-address=address + --remove-config + + + + --mac-address=address + --del-opt=dhcp-opt-no + --set-opt=dhcp-opt-no value + --set-opt-hex=dhcp-opt-no hexstring + --force-opt=dhcp-opt-no + --unforce-opt=dhcp-opt-no + --supress-opt=dhcp-opt-no + --unsupress-opt=dhcp-opt-no + --min-lease-time=seconds + --default-lease-time=seconds + --max-lease-time=seconds + --fixed-address=address + --remove-config + + + + VBoxManage dhcpserver remove + + --network=netname + --interface=ifname + + + + VBoxManage dhcpserver restart + + --network=netname + --interface=ifname + + + + VBoxManage dhcpserver findlease + + --network=netname + --interface=ifname + + --mac-address=mac + + + + + Description + + + The dhcpserver commands enable you to control the DHCP + server that is built into VirtualBox. You may find this useful when + using internal or host-only networking. Theoretically, you can also + enable it for a bridged network, but that may cause conflicts with other + DHCP servers in your physical network. + + + + Common options + + The subcommands of dhcpserver all operate on an + internal network that can be identified via its name or in the host-only + case via the host-only interface name: + + + --network=netname + The internal network name. This is the same as you + would use as value to the VBoxManage modifyvm --intnet + option when configuring a VM for internal networking. Or you see as + VBoxNetworkName in the output from + VBoxManage list intnets, + VBoxManage list natnets, or + VBoxManage list hostonlyifs. + + + + --interface=ifname + The host only interface name. This would be same value + as you would use for the VBoxManage modifyvm --hostonlyadapter + option when configuring a VM to use a host-only network. The value + can also be found in the Name row in VBoxManage list hostonlyifs. + + + + + + + dhcpserver add + + + Adds a new DHCP server to a network or host-only interface. + + + Options configuring the DHCP server core: + + + + + The IP address the DHCP server should use. + + + , + The IP address range for the DHCP server to manage. This + should not include the address of the DHCP server itself, but it must be + in the same network as it. The boundraries are inclusive, so both the + lower and upper addresses will be handed out to clients. + + + + The network mask. Typically 255.255.255.0. + + + , --disable + Whether to enable the DHCP server or disable it. If not specified, + the server will be created in disabled state and no IP addresses handed out. + + + + Options selecting the scope: + + + + + Set the configuration scope to global. Any subsequent + options will be apply to all the DHCP clients. + + + + Set the configuration scope to the first NIC of the specified VM. Any + subsequent options will apply just to that interface, + nothing else. + + + + Set the configuration scope to a NIC other than first of + the VM specified the in . + + + + + Set the configuration scope to the specified MAC address. + + + + Set the configuration scope to the specified group. + + + + Options configuring the currently selected scope: + + + + + Adds the specified DHCP option number (0-255) and value. The + value format is option specific (typically human readable) and will be + validated by the API and the DHCP server. + + + + + Adds the specified DHCP option number (0-255) and value. The option value + is specified as a raw series of hex bytes, optionally separated by colons. No validation + is performed on these by the API or the DHCP server, they will be pass as specified to the + client. + + + + + Forces the specified DHCP option number (0-255) onto to be + sent to the client whether it requested it or not (provided the option is + configured with a value at some level). + + + + + Prevents the specified DHCP option number (0-255) from being + sent to the client when present in this or a high configuration scope. + + + + + Sets the minimum lease time for the current scope in seconds. + Zero means taking the value from a higher option level or use default. + + + + + Sets the default lease time for the current scope in seconds. + Zero means taking the value from a higher option level or use default. + + + + + Sets the maximum lease time for the current scope in seconds. + Zero means taking the value from a higher option level or use default. + + + + + Fixed address assignment for a or + configuration scope. Any empty + address turns it back to dynamic address assignment. + + + + + + Options configuring group membership conditions (excludes overrides includes): + + + + + Include the specific MAC address in the group. + + + + Exclude the specific MAC address from the group. + + + + Include the specific MAC address pattern in the group. + + + + Exclude the specific MAC address pattern from the group. + + + + Include the specific vendor class ID in the group. + + + + Exclude the specific vendor class ID from the group. + + + + Include the specific vendor class ID pattern in the group. + + + + Exclude the specific vendor class ID pattern from the group. + + + + Include the specific user class ID in the group. + + + + Exclude the specific user class ID from the group. + + + + Include the specific user class ID pattern in the group. + + + + Exclude the specific user class ID pattern from the group. + + + + + + dhcpserver modify + + + This modifies an existing DHCP server configuration. It takes the same + options as the add command with the addition of the following + on scope configuration: + + + + + Counterpart to that will cause the specified + DHCP option number (0-255) to be deleted from the server settings. Like with + the scope of the deletion is governed by the + , , + and options. + + + + + Removes the specified DHCP option number (0-255) from the forced + option list (i.e. the reverse of ). Like with + the scope of the deletion is governed by the + , , + and options. + + + + + Removes the specified DHCP option number (0-255) from the supressed + option list (i.e. the reverse of ). Like with + the scope of the deletion is governed by the + , , + and options. + + + + + Removes the configuration currently being scoped. The + scope is not removable. The configuration scope will + change to after this option. + + + + + And the addition of these group membership condition options: + + + + + Delete the specific MAC address from the group conditions. + + + + Delete the specific MAC address pattern from the group conditions. + + + + Delete the specific vendor class ID from the group conditions. + + + + Delete the specific vendor class ID pattern from the group conditions. + + + + Delete the specific user class ID pattern from the group conditions. + + + + Delete the specific user class ID pattern from the group conditions. + + + + Deletes all the group conditions. + + + + + + dhcpserver remove + + + Removes the specified DHCP server. + + + + + dhcpserver restart + + + Restarts the specified DHCP server. The DHCP server must be running. + + + + + dhcpserver findlease + + + Performs a lease database lookup. This is mainly for getting the IP + address of a running VM. + + + + + The MAC address to lookup in the lease database. + + + + + + Common DHCP Options: + + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-discardstate.xml b/doc/manual/en_US/man_VBoxManage-discardstate.xml new file mode 100644 index 00000000..cebad719 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-discardstate.xml @@ -0,0 +1,91 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage discardstate + + + + VBoxManage-discardstate + 1 + + + + VBoxManage-discardstate + discard the saved state of a virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage discardstate + + uuid + vmname + + + + + + Description + + The VBoxManage discardstate command discards + the saved state of a virtual machine (VM) that is not currently + running. This command causes the VM's operating system to restart + the next time you start the VM. + + + + Where possible, avoid performing this action. The effects of + this command are equivalent to unplugging the power cable on a + physical machine. + + + + + uuid|vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + + + + Examples + + + The following command discards the saved state file for the VM + called vm2. When you next start the VM, the + VM's operating system is restarted. + +$ VBoxManage discardstate vm2 + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-encryptmedium.xml b/doc/manual/en_US/man_VBoxManage-encryptmedium.xml new file mode 100644 index 00000000..090f76ed --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-encryptmedium.xml @@ -0,0 +1,163 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage encryptmedium + + + + VBoxManage-encryptmedium + 1 + + + + VBoxManage-encryptmedium + manage a DEK-encrypted medium or image + Oracle VM VirtualBox + + + + + + VBoxManage encryptmedium + + uuid + filename + + --cipher=cipher-ID + --newpassword=password + --newpasswordid=password-ID + --oldpassword=password + + + + + Description + + The VBoxManage encryptmedium command enables + you to create and manage a DEK-encrypted medium or image. You can + encrypt an image, decrypt an image, and change the encryption + password of an image. See + . + + + + uuid | filename + + Specifies the Universally Unique Identifier (UUID) or the + absolute path name of the medium or image to encrypt. + + + + + + Specifies the new encryption password. + password is either the absolute + path name of a password file on the host operating system or + -, which prompts you for the password. + + You must use the option + with this option. + + + + + + Specifies the original encryption password. + password is either the absolute + path name of a password file on the host operating system or + -, which prompts you for the original + password. + + This option enables you to gain access to an encrypted + medium or image to do the following: + + + Decrypt an encrypted image by using this option by + itself. + + + Change the password of the encrypted image by using the + option. + + + Change the encryption cipher of the image by using the + option. + + + + + + + Specifies the cipher to use for encryption. Valid values are + AES-XTS128-PLAIN64 or + AES-XTS256-PLAIN64. + + This option enables you to set up or change encryption on + the medium or image. + + + + + + Specifies a new password identifier that is used for correct + identification when supplying multiple passwords during VM + startup. + + If you use the same password and password identifier when + encrypting multiple images, you need to supply the password + only one time during VM startup. + + + + + + + Examples + + + The following example shows how to encrypt the + ol7u4-1.vdi image by using the + AES-XTS128-PLAIN64 cipher, specifying a + password identifier of 1001, and using the + $HOME/pwfile password file: + +$ VBoxManage encryptmedium "$HOME/VirtualBox VMs/ol7u4/ol7u4-1.vdi" \ + --cipher="AES-XTS128-PLAIN64" --newpasswordid="1001" --newpassword=$HOME/pwfile + + The following example shows how to decrypt an encrypted image + called ol7u4-2.vdi: + +$ VBoxManage encryptmedium "$HOME/VirtualBox VMs/ol7u4/ol7u4-2.vdi" \ + --oldpassword=- + Password: original-password + + The following example shows how to change the password for an + encrypted image called ol7u4-3.vdi. The + command reads the original password from the + $HOME/pwfile.orig file, reads the new + password from the $HOME/pwfile file, and + assigns a password identifier of 1001. + +$ VBoxManage encryptmedium "$HOME/VirtualBox VMs/ol7u4/ol7u4-3.vdi" \ + --oldpassword=$HOME/pwfile.orig --newpassword=$HOME/pwfile --newpasswordid="1001" + + diff --git a/doc/manual/en_US/man_VBoxManage-export.xml b/doc/manual/en_US/man_VBoxManage-export.xml new file mode 100644 index 00000000..3c6e6781 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-export.xml @@ -0,0 +1,436 @@ + + + +%all.entities; +]> + + + November 2019 + VBoxManage export + + + + VBoxManage-export + 1 + + + + VBoxManage-export + export a virtual machine to a virtual appliance or to a cloud service + Oracle VM VirtualBox + + + + + + VBoxManage export + machines + --output=name + + --legacy09 + --ovf09 + --ovf10 + --ovf20 + --opc10 + + --manifest + --iso + --options= + manifest + iso + nomacs + nomacsbutnat + + --vsys=virtual-system-number + --description=description-info + --eula=license-text + --eulafile=filename + --product=product-name + --producturl=product-URL + --vendor=vendor-name + --vendorurl=vendor-URL + --version=version-info + --vmname=vmname + + + + VBoxManage export + machine + --output=cloud-service-provider + --vmname=vmname + --cloud=virtual-system-number + --cloudprofile=cloud-profile-name + --cloudshape=cloud-shape-name + --clouddomain=cloud-domain + --clouddisksize=disk-size-in-GB + --cloudbucket=bucket-name + --cloudocivcn=OCI-VCN-ID + --cloudocisubnet=OCI-subnet-ID + --cloudkeepobject= + true + false + + --cloudlaunchinstance= + true + false + + --cloudlaunchmode= + EMULATED + PARAVIRTUALIZED + + --cloudpublicip= + true + false + + + + + + Description + + The VBoxManage export command enables you to + export one or more virtual machines (VMs) from &product-name;. You + can export the VM to one of the following: + + + + Virtual appliance in OVF + format. Includes the copying of its virtual disk + images to compressed VMDK. + + + Cloud service such as &oci;. + Exports a single VM in VMDK format. + + + + For more information about exporting VMs from &product-name;, see + + + + Export a Virtual Machine to an OVF Virtual Appliance + + + The VBoxManage export command enables you to + export a VM as a virtual appliance in OVF format. + + + + machines + + Specifies a comma-separated list of one or more machines + to export to the same OVF file. + + + + + + Specifies the target OVF file. The file can be OVF, OVA, + or a ZIP file compressed with the gzip + command. Because the directory that contains the target + OVF file will also store the exported disk images in the + compressed VMDK format, ensure that this directory has + sufficient disk space in which to store the images. + + The short form of this option is . + + + + + + Exports in OVF 0.9 legacy mode if the virtualization + product is not fully compatible with the OVF 1.0 standard. + + + + + + Exports in OVF 0.9 format. + + + + + + Exports in OVF 1.0 format. + + + + + + Exports in OVF 2.0 format. + + + + + + Exports in &oci; format. + + + + + + Creates a manifest of the exported files. + + + + + + Creates an ISO file. + + + + + + Specifies information to control the exact content of the + appliance file. Specify one or more comma-separated + arguments: + + + manifest + + Produces a manifest file that detects corrupted + appliances on import. + + + + iso + + Exports DVD images in an ISO file. + + + + nomacs + + Excludes all MAC addresses. + + + + nomacsbutnat + + Excludes all MAC addresses except for those in a NAT + network. + + + + + + + + Specifies a description of the VM. + + + + + + Specifies end-user license text. + + + + + + Specifies an end-user license file. + + + + + + Specifies a product name. + + + + + + Specifies a product URL. + + + + + + Specifies a vendor name. + + + + + + Specifies a vendor URL. + + + + + + Specifies version information. + + + + + + Specifies the name of the exported VM. + + + + + + Specifies the number of the virtual system. + + + + + + Export a Virtual Machine to &oci; + + + The VBoxManage export command enables you to + export a VM to a cloud service provider such as &oci;. By + default, the exported disk image is converted into stream VMDK + format. This ensures compatibility with &oci;. + + + Some of the following options are configuration settings for the + VM instance. As a result, specify an Oracle Cloud Identifier + (OCID) for a resource. Use the &oci; Console to view OCIDs. + + + + + + Specifies the short name of the cloud service provider to + which you export the VM. For &oci;, specify + OCI://. + + The short form of this option is . + + + + + + Specifies a number that identifies the VM to export. + Numbering starts at 0 for the first VM. + + + + + + Specifies the name of the exported VM, which is used as + the VM instance name in &oci;. + + + + + + Specifies the cloud profile to use to connect to the cloud + service provider. The cloud profile contains your &oci; + account details, such as your user OCID and the + fingerprint for your public key. + + To use a cloud profile, you must have the required + permissions on &oci;. + + + + + + Specifies the shape used by the VM instance. The shape + defines the number of CPUs and the amount of memory that + is allocated to the VM instance. Ensure that the shape is + compatible with the exported image. + + + + + + Specifies the availability domain to use for the VM + instance. Enter the full name of the availability domain. + + + + + + Specifies the amount of disk space, in gigabytes, to use + for the exported disk image. Valid values are from 50 GB + to 300 GB. + + + + + + Specifies the bucket in which to store uploaded files. In + &oci;, a bucket is a logical container for storing + objects. + + + + + + Specifies the OCID of the virtual cloud network (VCN) to + use for the VM instance. + + + + + + Specifies the OCID of the VCN subnet to use for the VM + instance. + + + + + + Specifies whether to store the exported disk image in + Oracle Object Storage. + + + + + + Specifies whether to start the VM instance after the + export to &oci; completes. + + + + + + Specifies the launch mode used for the instance. + Paravirtualized mode gives improved performance. + + + + + + Specifies whether to enable a public IP address for the VM + instance. + + + + + + + + Example + + + The following example shows how to export the + myVM VM to &oci;. The command's option + arguments describe the configuration of the + myVM_Cloud VM in &oci;. + +# VBoxManage export myVM --output=OCI:// --cloud=0 --vmname=myVM_Cloud \ +--cloudprofile="standard user" --cloudbucket=myBucket \ +--cloudshape=VM.Standard2.1 --clouddomain=US-ASHBURN-AD-1 --clouddisksize=50 \ +--cloudocivcn=ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet=ocid1.subnet.oc1.iad.aaaa... \ +--cloudkeepobject=true --cloudlaunchinstance=true --cloudpublicip=true + + diff --git a/doc/manual/en_US/man_VBoxManage-extpack.xml b/doc/manual/en_US/man_VBoxManage-extpack.xml new file mode 100644 index 00000000..a22d2ec8 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-extpack.xml @@ -0,0 +1,144 @@ + + + + + + + $Date: 2020-04-07 12:00:46 +0200 (Tue, 07 Apr 2020) $ + VBoxManage extpack + + + + VBoxManage-extpack + 1 + + + + VBoxManage-extpack + extension package management + Oracle VM VirtualBox + + + + + VBoxManage extpack install + --replace + --accept-license=sha256 + tarball + + + VBoxManage extpack uninstall + --force + name + + + VBoxManage extpack cleanup + + + + + Description + + + extpack install + + + Installs a new extension pack on the system. This command will fail if an older + version of the same extension pack is already installed. The + option can be used to uninstall any + old package before the new one is installed. + + + + Uninstall existing extension pack version. + + + + + Accept the license text with the given SHA-256 hash value. + VBoxManage will display the SHA-256 value when performing a manual + installation. The hash can of course be calculated by looking inside + the extension pack and using sha256sum or similar on the license file. + + + + tarball + + The file containing the extension pack to be installed. + + + + + + + extpack uninstall + + + Uninstalls an extension pack from the system. The subcommand will also succeed + in the case where the specified extension pack is not present on the system. + You can use VBoxManage list extpacks to show + the names of the extension packs which are currently installed. + + + + + + Overrides most refusals to uninstall an extension pack + + + + name + + The name of the extension pack to be uninstalled. + + + + + + + extpack cleanup + + + Used to remove temporary files and directories that may have been left behind + if a previous install or uninstall command failed. + + + + + + + Examples + + + How to list extension packs: +$ VBoxManage list extpacks +Extension Packs: 1 +Pack no. 0: Oracle VM VirtualBox Extension Pack +Version: 4.1.12 +Revision: 77218 +Edition: +Description: USB 2.0 Host Controller, VirtualBox RDP, PXE ROM with E1000 support. +VRDE Module: VBoxVRDP +Usable: true +Why unusable: + + How to remove an extension pack: +$ VBoxManage extpack uninstall "Oracle VM VirtualBox Extension Pack" +0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% +Successfully uninstalled "Oracle VM VirtualBox Extension Pack". + + + + diff --git a/doc/manual/en_US/man_VBoxManage-getextradata.xml b/doc/manual/en_US/man_VBoxManage-getextradata.xml new file mode 100644 index 00000000..dadae599 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-getextradata.xml @@ -0,0 +1,141 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage getextradata + + + + VBoxManage-getextradata + 1 + + + + VBoxManage-getextradata + view keyword values that are associated with a virtual machine or + configuration + Oracle VM VirtualBox + + + + + + VBoxManage getextradata + + global + uuid + vmname + + + keyword + enumerate + + + + + + Description + + The VBoxManage getextradata command enables you + to retrieve keyword data that is associated with a virtual machine + (VM) or with an &product-name; configuration. + + + + global + + Specifies to retrieve information about the configuration + rather than a VM. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + enumerate + + Shows all keyword values for the specified VM or + configuration. + + + + keyword + + Specifies the keyword for which to retrieve its value. + + + + + + + Examples + + + The following command retrieves the installdate + keyword value for the Fedora5 VM: + +$ VBoxManage getextradata Fedora5 installdate +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2019 Oracle Corporation +All rights reserved. + +Value: 2006.01.01 + + The following command retrieves the information for all keywords + of the OracleLinux7u4 VM: + +$ VBoxManage getextradata OracleLinux7u4 enumerate +Key: GUI/LastCloseAction, Value: PowerOff +Key: GUI/LastGuestSizeHint, Value: 1048,696 +Key: GUI/LastNormalWindowPosition, Value: 851,286,1048,738 + + The following command retrieves the information for all keywords + in the configuration: + +$ VBoxManage getextradata global enumerate +Key: GUI/Details/Elements, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description +Key: GUI/DetailsPageBoxes, Value: general,system,preview,display,storage,audio,network,usb,sharedFolders,description +Key: GUI/GroupDefinitions/, Value: m=43349dd8-2aa3-41b8-988f-0e255ce68090,m=9ebcd81e-5231-48ce-a27d-28218757f3fe,m=c690e8b1-93a0-4c95-9cd7-6437fff93251,m=f7c1e10d-3722-4891-887e-07b3c4104946 +Key: GUI/HideDescriptionForWizards, Value: NewVM +Key: GUI/LastItemSelected, Value: m=ol7u4 +Key: GUI/LastWindowPosition, Value: 951,510,960,520 +Key: GUI/RecentFolderCD, Value: C:/Users/user1 +Key: GUI/RecentListCD, Value: C:\Users\user1\V1.iso,C:\Users\user1\V2.iso,C:\Users\user1\V3.iso +Key: GUI/SplitterSizes, Value: 318,637 +Key: GUI/SuppressMessages, Value: remindAboutMouseIntegration,remindAboutAutoCapture +Key: GUI/Toolbar/MachineTools/Order, Value: Details +Key: GUI/Tools/LastItemsSelected, Value: Welcome,Details +Key: GUI/UpdateCheckCount, Value: 71 +Key: GUI/UpdateDate, Value: 1 d, 2019-04-10, stable, 5.2.22 +Key: GUI/VirtualMediaManager/Details/Expanded, Value: true + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-guestcontrol.xml b/doc/manual/en_US/man_VBoxManage-guestcontrol.xml new file mode 100644 index 00000000..1973463c --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-guestcontrol.xml @@ -0,0 +1,1319 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage guestcontrol + + + + VBoxManage-guestcontrol + 1 + + + + VBoxManage-guestcontrol + control a virtual machine from the host system + Oracle VM VirtualBox + + + + + + VBoxManage guestcontrol + + uuid + vmname + + run + --domain=domainname + --dos2unix + --exe=filename + --ignore-orphaned-processes + + --no-wait-stderr + --wait-stderr + + + --no-wait-stdout + --wait-stdout + + + --passwordfile=password-file + --password=password + + --profile + --putenv=var-name=[value] + --quiet + --timeout=msec + --unix2dos + --unquoted-args + --username=username + --verbose + -- program/arg0 argument + + + + VBoxManage guestcontrol + + uuid + vmname + + start + --domain=domainname + --exe=filename + --ignore-orphaned-processes + + --passwordfile=password-file + --password=password + + --profile + --putenv=var-name=[value] + --quiet + --timeout=msec + --unquoted-args + --username=username + --verbose + -- program/arg0 argument + + + + VBoxManage guestcontrol + + uuid + vmname + + copyfrom + --domain=domainname + --follow + + --passwordfile=password-file + --password=password + + --quiet + --recursive + --username=username + --verbose + guest-source0 + guest-source1 [...] + host-destination + + + + VBoxManage guestcontrol + + uuid + vmname + + copyfrom + --domain=domainname + --follow + + --passwordfile=password-file + --password=password + + --quiet + --recursive + --target-directory=host-destination-dir + --username=username + --verbose + guest-source0 + guest-source1 [...] + + + + VBoxManage guestcontrol + + uuid + vmname + + copyto + --domain=domainname + --follow + + --passwordfile=password-file + --password=password + + --quiet + --recursive + --username=username + --verbose + host-source0 + host-source1 [...] + guest-destination + + + + VBoxManage guestcontrol + + uuid + vmname + + copyto + --domain=domainname + --follow + + --passwordfile=password-file + --password=password + + --quiet + --recursive + --target-directory=guest-destination-dir + --username=username + --verbose + host-source0 + host-source1 [...] + + + + VBoxManage guestcontrol + + uuid + vmname + + mkdir + --domain=domainname + --mode=mode + --parents + + --passwordfile=password-file + --password=password + + --quiet + --username=username + --verbose + guest-directory + + + + VBoxManage guestcontrol + + uuid + vmname + + rmdir + --domain=domainname + + --passwordfile=password-file + --password=password + + --quiet + --recursive + --username=username + --verbose + guest-directory + + + + VBoxManage guestcontrol + + uuid + vmname + + rm + --domain=domainname + --force + + --passwordfile=password-file + --password=password + + --quiet + --username=username + --verbose + guest-directory + + + + VBoxManage guestcontrol + + uuid + vmname + + mv + --domain=domainname + + --passwordfile=password-file + --password=password + + --quiet + --username=username + --verbose + source + destination-directory + + + + VBoxManage guestcontrol + + uuid + vmname + + mktemp + --domain=domainname + --mode=mode + + --passwordfile=password-file + --password=password + + --quiet + --secure + --tmpdir=directory-name + --username=username + --verbose + template-name + + + + VBoxManage guestcontrol + + uuid + vmname + + stat + --domain=domainname + + --passwordfile=password-file + --password=password + + --quiet + --username=username + --verbose + filename + + + + VBoxManage guestcontrol + + uuid + vmname + + list + + all + files + processes + sessions + + --quiet + --verbose + + + + VBoxManage guestcontrol + + uuid + vmname + + closeprocess + + --session-id=ID + --session-name=name-or-pattern + + --quiet + --verbose + PID + + + + VBoxManage guestcontrol + + uuid + vmname + + closesession + + --all + --session-id=ID + --session-name=name-or-pattern + + --quiet + --verbose + + + + VBoxManage guestcontrol + + uuid + vmname + + updatega + --quiet + --verbose + --source=guest-additions.ISO + --wait-start + -- argument + + + + VBoxManage guestcontrol + + uuid + vmname + + watch + --quiet + --verbose + + + + + Description + + The VBoxManage guestcontrol command enables you + to control a guest virtual machine (VM) from the host system. See + . + + + Common Options and Operands + + The following options can be used by any of the + VBoxManage guestcontrol subcommands: + + + + uuid|vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + + + Specifies that the command produce quieter output. + + The short form of this option is . + + + + + + Specifies that the command produce more detailed output. + + The short form of this option is . + + + + + Some of the VBoxManage guestcontrol + subcommands require that you provide guest credentials for + authentication. The subcommands are: + copyfrom, copyto, + mkdir, mktemp, + mv, rmdir, + rm, run, + start, and stat. + + + While you cannot perform anonymous executions, a user account + password is optional and depends on the guest's OS security + policy. If a user account does not have an associated password, + specify an empty password. On OSes such as Windows, you might + need to adjust the security policy to permit user accounts with + an empty password. In additional, global domain rules might + apply and therefore cannot be changed. + + + The following options are used for authentication on the guest + VM: + + + + + + Specifies the user domain for Windows guest VMs. + + + + + + Specifies the password for the specified user. If you do + not specify a password on the command line or if the + password file is empty, the specified user has a null + password. + + + + + + Specifies the absolute path to a file on the guest OS that + contains the password for the specified user. If the + password file is empty or if you do not specify a password + on the command line, the specified user has a null + password. + + + + + + Specifies an existing user on the guest OS that runs the + process. If unspecified, the host user runs the process. + + + + + + Guest Process Restrictions + + By default, you can run up to five guest processes + simultaneously. If a new guest process starts and would exceed + this limit, the oldest not-running guest process is discarded to + run the new process. You cannot retrieve output from a discarded + guest process. If all five guest processes are active and + running, attempting to start a new guest process fails. + + + You can modify the guest process execution limit in two ways: + + + + Use the VBoxManage setproperty command to + update the + /VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept + guest property value. + + + Use the VBoxService command and specify + the + + option. + + + + After you change the limit, you must restart the guest OS. + + + You can serve an unlimited number guest processes by specifing a + value of 0, however this action is not + recommended. + + + + Run a Command on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname run command enables + you to execute a program on the guest VM. Standard input, + standard output, and standard error are redirected from the VM + to the host system until the program completes. + + + + The Windows OS imposes certain limitations for graphical + applications. See . + + + + + + + Specifies the absolute path of the executable program to + run on the guest VM. For example: + C:\Windows\System32\calc.exe. + + + + + + Specifies the maximum amount of time, in milliseconds, + that the program can run. While the program runs, + VBoxManage receives its output. + + If you do not specify a timeout value, + VBoxManage waits indefinitely for the + process to end, or for an error to occur. + + + + + + Sets, modifies, and unsets environment variables in the + guest VM environment. + + When you create a guest process, it runs with the default + standard guest OS environment. Use this option to modify + environment variables in that default environment. + + Use the + + option to set or modify the environment variable specified + by NAME. + + Use the + + option to unset the environment variable specified by + NAME. + + Ensure that any environment variable name or value that + includes spaces is enclosed by quotes. + + Specify a option for each + environment variable that you want to modify. + + The short form of this option is . + + + + + + Disables the escaped double quoting of arguments that you + pass to the program. For example, + \"fred\". + + + + + + Ignores orphaned processes. Not yet implemented. + + + + + + Uses a shell profile to specify the environment to use. + Not yet implemented. + + + + + + Does not wait for the guest process to end or receive its + exit code and any failure explanation. + + + + + + Waits for the guest process to end to receive its exit + code and any failure explanation. The + VBoxManage command receives the + standard output of the guest process while the process + runs. + + + + + + Does not wait for the guest process to end to receive its + exit code, error messages, and flags. + + + + + + Waits for the guest process to end to receive its exit + code, error messages, and flags. The + VBoxManage command receives the + standard error of the guest process while the process + runs. + + + + + + Transform DOS or Windows guest output to UNIX or Linux + output. This transformation changes CR + LF line endings + to LF. Not yet implemented. + + + + + + Transform UNIX or Linux guest output to DOS or Windows + output. This transformation changes LF line endings to CR + + LF. + + + + + + Specifies the name of the program and any arguments to + pass to the program. + + Ensure that any command argument that includes spaces is + enclosed by quotes. + + + + + + Start a Command on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname start command + enables you to execute a guest program until it completes. + + + + The Windows OS imposes certain limitations for graphical + applications. See . + + + + + Copy a File From the Guest Virtual Machine to the Host System + + + The VBoxManage guestcontrol + vmname copyfrom command + enables you to copy a file from the guest VM to the host system. + + + + + + Enables following of symbolic links on the guest file + system. + + + + + + Recursively copies files and directories from the + specified directory on the guest VM. + + The short form of this option is . + + + + guest-source0 [guest-source1 [...]] + + Specifies the absolute path of one or more files to copy + from the guest VM. For example, + C:\Windows\System32\calc.exe. You can + use wildcards to specify multiple files. For example, + C:\Windows\System*\*.dll. + + + + + + Copy a File From the Guest Virtual Machine to a Directory on the Host + System + + + The VBoxManage guestcontrol + vmname copyfrom command + enables you to copy a file from the guest VM to the host system. + + + + + + Enables following of symbolic links on the guest file + system. + + + + + + Recursively copies files and directories from the + specified directory on the guest VM. + + The short form of this option is . + + + + + + Specifies the absolute path of the destination directory + on the host system. For example, + C:\Temp. + + + + guest-source0 [guest-source1 [...]] + + Specifies the absolute path of one or more the files to + copy from the guest VM. For example, + C:\Windows\System32\calc.exe. You can + use wildcards to specify multiple files. For example, + C:\Windows\System*\*.dll. + + + + + + Copy a File to the Guest Virtual Machine From the Host System + + + The VBoxManage guestcontrol + vmname copyto command + enables you to copy a file from the host system to the guest VM. + + + + + + Enables following of symbolic links on the host system. + + + + + + Recursively copies files and directories from the + specified directory on the host system. + + The short form of this option is . + + + + host-source0 [host-source1 [...]] + + Specifies the absolute path of one or more the files to + copy from the host system. For example, + C:\Windows\System32\calc.exe. You can + use wildcards to specify multiple files. For example, + C:\Windows\System*\*.dll. + + + + + + Copy a File to a Directory on the Guest Virtual Machine From the Host + System + + + The VBoxManage guestcontrol + vmname copyto command + enables you to copy a file from the host system to the guest VM. + + + + + + Enables following of symbolic links on the host system. + + + + + + Recursively copies files and directories from the + specified directory on the host system. + + The short form of this option is . + + + + + + Specifies the absolute path of the destination directory + on the guest VM. For example, + C:\Temp. + + + + host-source0 [host-source1 [...]] + + Specifies the absolute path of one or more the files to + copy from the host system. For example, + C:\Windows\System32\calc.exe. You can + use wildcards to specify multiple files. For example, + C:\Windows\System*\*.dll. + + + + + + Create a Directory on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname mkdir command + enables you to create one or more directories on the guest VM. + + + Alternate forms of this subcommand are md, + createdir, and + createdirectory. + + + + + + Creates any of the missing parent directories of the + specified directory. + + For example, if you attempt to create the + D:\Foo\Bar directory and the + D:\Foo directory does not exist, + using the creates the missing + D:\Foo directory. However, if you + attempt to create the D:\Foo\Bar and + do not specify the option, the + command fails. + + + + + + Specifies the permission mode to use for the specified + directory. If you specify the + option, the mode is used for the associated parent + directories, as well. mode is a + four-digit octal mode such as 0755. + + + + guest-dir [guest-dir...] + + Specifies an absolute path of one or more directories to + create on the guest VM. For example, + D:\Foo\Bar. + + If all of the associated parent directories do not exist + on the guest VM, you must specify the + option. + + You must have sufficient rights on the guest VM to create + the specified directory and its parent directories. + + + + + + Remove a Directory From the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname rmdir command + enables you to delete the specified directory from the guest VM. + + + Alternate forms of this subcommand are + removedir and + removedirectory. + + + + + + Recursively removes directories from the specified from + the guest VM. + + The short form of this option is . + + + + guest-dir [guest-dir...] + + Specifies an absolute path of one or more directories to + remove from the guest VM. You can use wildcards to specify + the directory names. For example, + D:\Foo\*Bar. + + You must have sufficient rights on the guest VM to remove + the specified directory and its parent directories. + + + + + + Remove a File From the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname rm command enables + you to delete the specified files from the guest VM. + + + The alternate form of this subcommand is + removefile. + + + + + + Forces the operation and overrides any confirmation + requests. + + The short form of this option is . + + + + guest-file [guest-file...] + + Specifies an absolute path of one or more file to remove + from the guest VM. You can use wildcards to specify the + file names. For example, + D:\Foo\Bar\text*.txt. + + You must have sufficient rights on the guest VM to remove + the specified file. + + + + + + Rename a File or Directory on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname mv command enables + you to rename files and directories on the guest VM. + + + Alternate forms of this subcommand are move, + ren, and rename. + + + + guest-source [guest-source...] + + Specifies an absolute path of a file or a single directory + to move or rename on the guest VM. You can use wildcards + to specify the file names. + + You must have sufficient rights on the guest VM to access + the specified file or directory. + + + + dest + + Specifies the absolute path of the renamed file or + directory, or the destination directory to which to move + the files. If you move only one file, + dest can be a file or a + directory, otherwise dest must + be a directory. + + You must have sufficient rights on the guest VM to access + the destination file or directory. + + + + + + Create a Temporary File or Directory on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname mktemp command + enables you to create a temporary file or temporary directory on + the guest VM. You can use this command to assist with the + subsequent copying of files from the host system to the guest + VM. By default, this command creates the file or directory in + the guest VM's platform-specific temp + directory. + + + Alternate forms of this subcommand are + createtemp and + createtemporary. + + + + + + Creates a temporary directory that is specified by the + template operand. + + + + + + Enforces secure file and directory creation by setting the + permission mode to 0755. Any operation + that cannot be performed securely fails. + + + + + + Specifies the permission mode to use for the specified + directory. mode is a four-digit + octal mode such as 0755. + + + + + + Specifies the absolute path of the directory on the guest + VM in which to create the specified file or directory. If + unspecified, directory is the + platform-specific temp directory. + + + + template + + Specifies a template file name for the temporary file, + without a directory path. The template file name must + contain at least one sequence of three consecutive X + characters, or must end in X. + + + + + + Show a File or File System Status on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname stat command enables + you to show the status of files or file systems on the guest VM. + + + + file [file ...] + + Specifies an absolute path of a file or file system on the + guest VM. For example, + /home/foo/a.out. + + You must have sufficient rights on the guest VM to access + the specified files or file systems. + + + + + + List the Configuration and Status Information for a Guest Virtual + Machine + + + The VBoxManage guestcontrol + vmname list command enables + you to list guest control configuration and status information. + For example, the output shows open guest sessions, guest + processes, and files. + + + + all|sessions|processes|files + + Indicates the type of information to show. + all shows all available data, + sessions shows guest sessions, + processes shows processes, and + files shows files. + + + + + + Terminate a Process in a Guest Virtual Machine Session + + + The VBoxManage guestcontrol + vmname closeprocess command + enables you to terminate a guest process that runs in a guest + session. Specify the process by using a process identifier (PID) + and the session by using the session ID or name. + + + + + + Specifies the ID of the guest session. + + + + + + Specifies the name of the guest session. Use a pattern + that contains wildcards to specify multiple sessions. + + + + PID [PID ...] + + Specifies the list of PIDs of guest processes to + terminate. + + + + + + Close a Guest Virtual Machine Session + + + The VBoxManage guestcontrol + vmname closesession command + enables you to close a guest session. Specify the guest session + either by session ID or by name. + + + + + + Specifies the ID of the guest session. + + + + + + Specifies the name of the guest session. Use a pattern + that contains wildcards to specify multiple sessions. + + + + + + Closes all guest sessions. + + + + + + Update the Guest Additions Software on the Guest Virtual Machine + + + The VBoxManage guestcontrol + vmname updatega command + enables you to update the Guest Additions software installed in + the specified guest VM. + + + Alternate forms of this subcommand are + updateadditions and + updateguestadditions. + + + + + + Specifies the absolute path of the Guest Additions update + .ISO file on the guest VM. + + + + + + Starts the VBoxManage update process on + the guest VM and then waits for the Guest Additions update + to begin before terminating the + VBoxManage process. + + By default, the VBoxManage command + waits for the Guest Additions update to complete before it + terminates. Use this option when a running + VBoxManage process affects the + interaction between the installer and the guest OS. + + + + + + Specifies optional command-line arguments to pass to the + Guest Additions updater. You might use the + option to pass the appropriate updater + arguments to retrofit features that are not yet installed. + + Ensure that any command argument that includes spaces is + enclosed by quotes. + + + + + + Show Current Guest Control Activity + + + The VBoxManage guestcontrol + vmname watch command + enables you to show current guest control activity. + + + + + + Examples + + + The following VBoxManage guestcontrol run + command executes the ls -l /usr command on the + My OL VM Oracle Linux VM as the + user1 user. + + +$ VBoxManage --nologo guestcontrol "My OL VM" run --exe "/bin/ls" \ +--username user1 --passwordfile pw.txt --wait-stdout -- -l /usr + + + The option specifies the absolute path of + the command to run in the guest VM, /bin/ls. + Use the option to pass any arguments that + follow it to the ls command. + + + Use the option to specify the user + name, user1 and use the + option to specify the name of a + file that includes the password for the user1 + user, pw.txt. + + + The option waits for the + ls guest process to complete before providing + the exit code and the command output. The + option suppresses the output of the logo + information. + + + The following VBoxManage guestcontrol run + command executes the ipconfig command on the + My Win VM Windows VM as the + user1 user. Standard input, standard output, + and standard error are redirected from the VM to the host system + until the program completes. + + +$ VBoxManage --nologo guestcontrol "My Win VM" run \ +--exe "c:\\windows\\system32\\ipconfig.exe" \ +--username user1 --passwordfile pw.txt --wait-stdout + + + The specifies the absolute path of command + to run in the guest VM, + c:\windows\system32\ipconfig.exe. The double + backslashes shown in this example are required only on UNIX host + systems. + + + Use the option to specify the user + name, user1 and use the + option to specify the name of a + file that includes the password for the user1 + user, pw.txt. + + + The option waits for the + ls guest process to complete before providing + the exit code and the command output. The + option to suppress the output of the + logo information. + + + The following VBoxManage guestcontrol start + command executes the ls -l /usr command on the + My OL VM Oracle Linux VM until the program + completes. + + +$ VBoxManage --nologo guestcontrol "My Win VM" start \ +--exe "c:\\windows\\system32\\ipconfig.exe" \ +--username user1 --passwordfile pw.txt --wait-stdout + + + diff --git a/doc/manual/en_US/man_VBoxManage-guestproperty.xml b/doc/manual/en_US/man_VBoxManage-guestproperty.xml new file mode 100644 index 00000000..00100697 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-guestproperty.xml @@ -0,0 +1,325 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage guestproperty + + + + VBoxManage-guestproperty + 1 + + + + VBoxManage-guestproperty + manage virtual machine guest properties + Oracle VM VirtualBox + + + + + + VBoxManage guestproperty get + + uuid + vmname + + property-name + --verbose + + + + VBoxManage guestproperty enumerate + + uuid + vmname + + --patterns=patterns + + + + VBoxManage guestproperty set + + uuid + vmname + + property-name + property-value--flags=flags + + + + VBoxManage guestproperty unset + + uuid + vmname + + property-name + + + + VBoxManage guestproperty wait + + uuid + vmname + + patterns + --timeout=msec + --fail-on-timeout + + + + + Description + + The VBoxManage guestproperty command enables + you to set or retrieve the properties of a running virtual machine + (VM). See . Guest properties + are arbitrary name-value string pairs that can be written to and + read from by either the guest or the host. As a result, these + properties can be used as a low-volume communication channel for + strings provided that a guest is running and has the Guest + Additions installed. In addition, the Guest Additions + automatically set and maintain values whose keywords begin with + /VirtualBox/. + + + General Command Operand + + + uuid|vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + + + List All Properties for a Virtual Machine + + The VBoxManage guestproperty enumerate + command lists each guest property and value for the specified + VM. Note that the output is limited if the guest's service + process cannot be contacted, for example because the VM is not + running or because the Guest Additions are not installed. + + + + + + Filters the list of properties based on the specified + pattern, which can contain the following wildcard + characters: + + + * (asterisk) + + Represents any number of characters. For example, + the /VirtualBox* pattern matches + all properties that begin with + /VirtualBox. + + + + ? (question mark) + + Represents a single arbitrary character. For + example, the fo? pattern matches + both foo and + for. + + + + | (pipe) + + Specifies multiple alternative patterns. For + example, the s*|t* pattern + matches any property that begins with + s or t. + + + + + + + + Retrieve a Property Value for a Virtual Machine + + + The VBoxManage guestproperty get command + retrieves the value of the specified property. If the property + cannot be found, for example because the guest is not running, + the command issues the following message: + +No value set! + + + property-name + + Specifies the name of the property. + + + + + + Provides the property value, timestamp, and any specified + value attributes. + + + + + + Set a Property Value for a Virtual Machine + + + The VBoxManage guestproperty set command + enables you to set a guest property by specifying the property + and its value. If you omit the value, the property is deleted. + + + + property-name + + Specifies the name of the property. + + + + property-value + + Specifies the value of the property. If no value is + specified, any existing value is removed. + + + + + + Specify the additional attributes of the value. The + following attributes can be specified as a comma-separated + list: + + + TRANSIENT + + Removes the value with the VM data when the VM + exits. + + + + TRANSRESET + + Removes the value when the VM restarts or exits. + + + + RDONLYGUEST + + Specifies that the value can be changed only by the + host and that the guest can read the value. + + + + RDONLYHOST + + Specifies that the value can be changed only by the + guest and that the host can read the value. + + + + READONLY + + Specifies that the value cannot be changed. + + + + + + + + Wait for a Property Value to Be Created, Deleted, or Changed + + + The VBoxManage guestproperty wait command + waits for a particular value that is described by the pattern + string to change, to be deleted, or to be created. + + + + patterns + + Specifies a pattern that matches the properties on which + you want to wait. For information about the pattern + wildcards, see the description of the + option. + + + + + + Specifies the number of microseconds to wait. + + + + + + Specifies that the command fails if the timeout is + reached. + + + + + + Unset a Virtual Machine Property Value + + + The VBoxManage guestproperty unset command + unsets the value of a guest property. + + + The alternate form of this subcommand is + delete. + + + + property-name + + Specifies the name of the property. + + + + + + + + Examples + + + The following command lists the guest properties and their values + for the win8 VM. + +$ VBoxManage guestproperty enumerate win8 + + The following command creates a guest property called + region for the win8 VM. The + value of the property is set to west. + +$ VBoxManage guestproperty set win8 region west + + diff --git a/doc/manual/en_US/man_VBoxManage-hostonlyif.xml b/doc/manual/en_US/man_VBoxManage-hostonlyif.xml new file mode 100644 index 00000000..6a136ecd --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-hostonlyif.xml @@ -0,0 +1,190 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage hostonlyif + + + + VBoxManage-hostonlyif + 1 + + + + VBoxManage-hostonlyif + manage host-only network interfaces + Oracle VM VirtualBox + + + + + + VBoxManage hostonlyif ipconfig + ifname + + --dhcp + --ip=IPv4-address --netmask=IPv4-netmask + --ipv6=IPv6-address --netmasklengthv6=length + + + + + VBoxManage hostonlyif create + + + + VBoxManage hostonlyif remove + ifname + + + + + Description + + The VBoxManage hostonlyif command enables you + to change the IP configuration of a host-only network interface. + For a description of host-only networking, see + . Each host-only network + interface is identified by a name and can either use the internal + DHCP server or a manual IP configuration, both IPv4 and IPv6. + + + Configure a Host-Only Interface + + + The VBoxManage hostonlyif ipconfig command + configures a host-only interface. + + + + ifname + + Specifies the name of the network interface. The name is + of the form + vboxnetN + where N is the interface + instance. + + + + + + Uses DHCP for the network interface. + + You cannot use this option with the , + , , and + options. + + + + + + Specifies the IPv4 IP address for the network interface. + + You cannot use this option with the + , , and + options. + + + + + + Specifies the IPv4 netmask of the network interface. The + default value is 255.255.255.0. + + You can use this option only with the + option. + + + + + + Specifies the IPv6 IP address for the network interface. + + You cannot use this option with the + , , and + options. + + + + + + Specifies the length of the IPv6 network interface. The + default value is 64. + + You can use this option only with the + option. + + + + + + Create a Network Interface on the Host System + + + The VBoxManage hostonlyif create command + creates a new host-only network interface on the host operating + system (OS). The network interface name is of the form + vboxnetN where + N is the interface instance. You must + run this command before you can attach virtual machines (VMs) to + the host-only network. + + + + Remove a Network Interface From the Host System + + + The VBoxManage hostonlyif remove command + removes the specified host-only network interface from the host + OS. + + + + ifname + + Specifies the name of the network interface. The name is + of the form + vboxnetN + where N is the interface + instance. + + + + + + + + Examples + + + The following command creates a new host-only network interface. + +$ VBoxManage hostonlyif create +0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% +Interface 'vboxnet2' was successfully created + + The following command configures the IPv4 address for the + vboxnet2 host-only network interface. + +$ VBoxManage hostonlyif ipconfig vboxnet2 --ip 10.0.2.18 + + diff --git a/doc/manual/en_US/man_VBoxManage-import.xml b/doc/manual/en_US/man_VBoxManage-import.xml new file mode 100644 index 00000000..7ab33595 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-import.xml @@ -0,0 +1,218 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage import + + + + VBoxManage-import + 1 + + + + VBoxManage-import + import a virtual appliance in OVF format and create virtual machines + Oracle VM VirtualBox + + + + + + VBoxManage import + + ovfname + ovaname + + --dry-run + --options= + keepallmacs + keepnatmacs + keepdisknames + importtovdi + + + + + + Description + + The VBoxManage import command imports a virtual + appliance in OVF or OVA format by copying virtual disk images and + by creating virtual machines (VMs) in &product-name;. See + . + + + You must specify the path name of an OVF file or OVA archive to + use as input. Also, ensure that any disk images are in the same + directory as the OVF file or OVA archive. + + + Note that any options you specify to control the imported virtual + appliance or to modify the import parameters rely on the contents + of the OVF file. + + + Before you use the import operation to create the VM, perform a + dry run to verify the correctness of your configuration. + + + Common Options + + + ovfname | ovaname + + Specifies the name of the OVF file or OVA archive that + describes the appliance. + + + + + + Performs a dry run of the VBoxManage + import command before you perform the actual + import operation. A dry run operation does the following: + + + Outputs a description of the appliance's contents + based on the specified OVF or OVA file. + + + Shows how the appliance would be imported into + &product-name;. In addition, the output shows any + options that you can use to change the import + behavior. + + + The shortened form of this option is . + + + + + + Enables you to fine tune the import operation. + + Valid arguments are as follows: + + + keepallmacs: Specifies that the MAC + addresses of every virtual network card are left + unchanged. + + + keepnatmacs: Specifies that the MAC + addresses of every virtual network card are left + unchanged if the network type is NAT. + + + keepdisknames: Specifies that all + new disk images are assigned the same names as the + originals. + + + importtovdi: Specifies that all new + disk images are in VDI file format. + + + + + + + + + Examples + + + The following example performs the dry run of an import operation + for a sample appliance that contains a Windows 10 guest: + +$ VBoxManage import Windows10.ovf --dry-run +Interpreting Windows10.ovf... +OK. +Virtual system 0: + 0: Suggested OS type: "Windows10_64" + (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all) + 1: Suggested VM name "win10-appliance" + (change with "--vsys 0 --vmname <name>") + 2: Suggested VM group "/" + (change with "--vsys 0 --group <group>") + 3: Suggested VM settings file name "/home/user1/VirtualBox VMs/win10-appliance/win10-appliance.vbox" + (change with "--vsys 0 --settingsfile <filename>") + 4: Suggested VM base folder "/home/user1/VirtualBox VMs" + (change with "--vsys 0 --basefolder <path>") + 5: End-user license agreement + (display with "--vsys 0 --eula show"; + accept with "--vsys 0 --eula accept") + 6: Number of CPUs: 1 + (change with "--vsys 0 --cpus <n>") + 7: Guest memory: 1024 MB (change with "--vsys 0 --memory <MB>") + 8: Sound card (appliance expects "ensoniq1371", can change on import) + (disable with "--vsys 0 --unit 5 --ignore") + 9: USB controller + (disable with "--vsys 0 --unit 6 --ignore") +10: Network adapter: orig bridged, config 2, extra type=bridged +11: Floppy + (disable with "--vsys 0 --unit 8 --ignore") +12: SCSI controller, type BusLogic + (change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}"; + disable with "--vsys 0 --unit 9 --ignore") +13: IDE controller, type PIIX4 + (disable with "--vsys 0 --unit 10 --ignore") +14: Hard disk image: source image=Windows10.vmdk, + target path=/home/user1/disks/Windows10.vmdk, controller=9;channel=0 + (change controller with "--vsys 0 --unit 11 --controller <id>"; + disable with "--vsys 0 --unit 11 --ignore") + + The dry run output lists and numbers the individual configuration + items that are described in the Windows10.ovf + file. Some of the items include information about how to disable + or change the configuration of the item. + + + You can disable many of the items by using the options. X is the + number of the virtual system. The value is 0 + unless the appliance includes several virtual system descriptions. + Y is the configuration item number. + + + Item 1 in the example command output specifies the name of the + target machine. Items 12 and 13 specify the IDE and SCSI hard disk + controllers, respectively. + + + Item 14 indicates the hard disk image and the + option specifies the device on which + the image resides. The default value is specified in the OVF file. + + + You can combine several items for the same virtual system by + specifying the same value for the option. + For example use the following command to import a machine as + described in the OVF, exclude the sound card and USB controller + and specify that the disk image is connected to the IDE controller + instead of the SCSI controller. + +$ VBoxManage import Windows10.ovf --vsys 0 --unit 8 --ignore \ + --unit 9 --ignore --unit 14 --controller 13 + + diff --git a/doc/manual/en_US/man_VBoxManage-list.xml b/doc/manual/en_US/man_VBoxManage-list.xml new file mode 100644 index 00000000..10dca66e --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-list.xml @@ -0,0 +1,523 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage list + + + + VBoxManage-list + 1 + + + + VBoxManage-list + view system information and VM configuration details + Oracle VM VirtualBox + + + + + + VBoxManage list + --long + --sorted + bridgedifs + + + + VBoxManage list + --long + --sorted + cloudprofiles + + + + VBoxManage list + --long + --sorted + cloudproviders + + + + VBoxManage list + --long + --sorted + dhcpservers + + + + VBoxManage list + --long + --sorted + dvds + + + + VBoxManage list + --long + --sorted + extpacks + + + VBoxManage list + --long + --sorted + floppies + + + + VBoxManage list + --long + --sorted + groups + + + + VBoxManage list + --long + --sorted + hddbackends + + + + VBoxManage list + --long + --sorted + hdds + + + + VBoxManage list + --long + --sorted + hostcpuids + + + + VBoxManage list + --long + --sorted + hostdvds + + + + VBoxManage list + --long + --sorted + hostfloppies + + + + VBoxManage list + --long + --sorted + hostinfo + + + + VBoxManage list + --long + --sorted + hostonlyifs + + + + VBoxManage list + --long + --sorted + intnets + + + + VBoxManage list + --long + --sorted + natnets + + + + VBoxManage list + --long + --sorted + ostypes + + + + VBoxManage list + --long + --sorted + runningvms + + + + VBoxManage list + --long + --sorted + screenshotformats + + + + VBoxManage list + --long + --sorted + systemproperties + + + + VBoxManage list + --long + --sorted + usbfilters + + + + VBoxManage list + --long + --sorted + usbhost + + + + VBoxManage list + --long + --sorted + vms + + + + VBoxManage list + --long + --sorted + webcams + + + + + Description + + The VBoxManage list subcommands enable you to + obtain information about the &product-name; software and the VMs + that you create. + + + Common Options + + + + + Shows detailed information about each VM and its + configuration. The short form of this option is + . + + + + + + Sorts the list of VM entries alphabetically. The short + form of this option is . + + + + + + List the Bridged Network Interfaces on the Host System + + + The VBoxManage list bridgedifs command lists + the bridged network interfaces that are currently available on + the host system. The output shows detailed configuration + information about each interface. + + + + List the Cloud Profiles + + + The VBoxManage list cloudprofiles command + lists the cloud profiles that have been configured. A cloud + profile contains settings for a cloud service account. + + + + List the Cloud Providers + + + The VBoxManage list cloudproviders command + lists the cloud providers that are supported by &product-name;. + Oracle Cloud Infrastructure is an example of a cloud provider. + + + + List the DHCP Servers That Are Available on the Host System + + + The VBoxManage list dhcpservers command lists + the DHCP servers that are currently available on the host + system. The output shows detailed configuration information + about each DHCP server. + + + + List the DVD Virtual Disk Images + + + The VBoxManage list dvds command shows + information about the DVD virtual disk images that are currently + in use by the &product-name; software. For each image, the + output shows all the settings, the UUIDs associated with the + image by &product-name;, and all files associated with the + image. + + + This command performs the same function as the Virtual Media + Manager. + + + + List the Installed &product-name; Extension Packs + + + The VBoxManage list extpacks command shows + all &product-name; extension packs that are currently installed. + + + + List the Floppy Disk Virtual Disk Images + + + The VBoxManage list floppies command shows + information about the floppy disk images that are currently in + use by the &product-name; software. For each image, the output + shows all the settings, the UUIDs associated with the image by + &product-name;, and all files associated with the image. + + + This command performs the same function as the Virtual Media + Manager. + + + + List Information about Virtual Machine Groups + + + The VBoxManage list groups command shows + detailed information about VM groups. + + + + List the Virtual Disk Backends + + + The VBoxManage list hddbackends command lists + all known virtual disk backends of the &product-name; software. + For each such format, such as VDI, VMDK, or RAW, this command + lists the backend's capabilities and configuration. + + + + List the Hard Disk Virtual Disk Images + + + The VBoxManage list hdds command shows + information about the hard disk virtual disk images that are + currently in use by the &product-name; software. For each image, + the output shows all the settings, the UUIDs associated with the + image by &product-name;, and all files associated with the + image. + + + This command performs the same function as the Virtual Media + Manager. + + + + List the CPUID Information for the Host System CPUs + + + The VBoxManage list hostcpuids command lists + CPUID information for each CPU on the host system. Use this + information to perform a more fine grained analyis of the host + system's virtualization capabilities. + + + + List the DVD Interfaces on the Host System + + + The VBoxManage list hostdvds command lists + the DVD interfaces on the host system. Each DVD entry includes + the name used to access them from within &product-name;. + + + + List the Floppy Disk Interfaces on the Host System + + + The VBoxManage list hostfloppies command + lists the floppy disk interfaces on the host system. Each floppy + disk entry includes the name used to access them from within + &product-name;. + + + + List Information About the Host System + + + The VBoxManage list hostinfo command shows + information about the host system. The output includes + information about the CPUs, memory, and the OS version. + + + + List the Host-Only Network Interfaces on the Host System + + + The VBoxManage list hostonlyifs command lists + the host-only network interfaces that are currently available on + the host system. The output shows detailed configuration + information about each interface. + + + + List Internal Networks + + + The VBoxManage list intnets command shows + information about the internal networks. + + + + List the NAT Network Interfaces on the Host System + + + The VBoxManage list natnets command lists the + NAT network interfaces that are currently available on the host + system. + + + + List the Guest Operating Systems + + + The VBoxManage list ostypes command lists all + guest operating systems (OSes) that are known to &product-name;. + Each OS entry includes an identifier, a description, a family + identifier, a family description, and whether the OS has 64-bit + support. + + + You can use these identifiers with the VBoxManage + modifyvm command. + + + + List the Running Virtual Machines + + + The VBoxManage list runningvms command lists + all virtual machines (VMs) that are currently running. By + default this displays a compact list that shows the name and + Universally Unique Identifier (UUID) of each VM. + + + + List the Available Screen Shot Formats + + + The VBoxManage list screenshotformats command + shows the list of available screen shot formats. + + + + List System Properties + + + The VBoxManage list systemproperties command + shows some global &product-name; settings, such as minimum and + maximum guest RAM, virtual hard disk size, folder settings, and + the current authentication library in use. + + + + List the Registered Global USB Filters + + + The VBoxManage list usbfilters command lists + all global USB filters registered with &product-name; and + displays the filter parameters. Global USB filters are for + devices which are accessible to all virtual machines. + + + + List the USB Devices on the Host System + + + The VBoxManage list usbhost command shows + information about the USB devices that are attached to the host + system. The output includes information that you can use to + construct USB filters and indicates whether the device is + currently in use by the host system. + + + + List Virtual Machines + + + The VBoxManage list vms command lists all + virtual machines (VMs) that are currently registered with + &product-name;. By default this command displays a compact list + that shows the name and UUID of each VM. + + + + List the Webcams Attached to a Running Virtual Machine + + + The VBoxManage list webcams command shows the + list of webcams that are attached to the running VM. + + + The output is a list of absolute paths or aliases that are used + to attach the webcams to the VM by using the VBoxManage + webcam attach command. + + + + + + Examples + + + The following command lists the VM groups configured for + &product-name;. + +$ VBoxManage list groups +"/Linux-VMs" +"/Windows-VMs" + + The following command lists the VMs that are currently running. + +$ VBoxManage list runningvms +"ol7" {ol7-UUID} +"win8" {win8-UUID} + + diff --git a/doc/manual/en_US/man_VBoxManage-mediumio.xml b/doc/manual/en_US/man_VBoxManage-mediumio.xml new file mode 100644 index 00000000..8693c6b0 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-mediumio.xml @@ -0,0 +1,164 @@ + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage mediumio + + + + VBoxManage-mediumio + 1 + + + + VBoxManage-mediumio + medium content access + Oracle VM VirtualBox + + + + + VBoxManage mediumio + + --disk=uuid|filename + --dvd=uuid|filename + --floppy=uuid|filename + + --password-file=-|filename + formatfat + --quick + + + VBoxManage mediumio + + --disk=uuid|filename + --dvd=uuid|filename + --floppy=uuid|filename + + --password-file=-|filename + cat + --hex + --offset=byte-offset + --size=bytes + --output=-|filename + + + VBoxManage mediumio + + --disk=uuid|filename + --dvd=uuid|filename + --floppy=uuid|filename + + --password-file=-|filename + stream + --format=image-format + --variant=image-variant + --output=-|filename + + + + + Description + + + Common options + + The subcommands of mediumio all operate on a medium which need to be specified, optionally + with an encryption password. The following common options can be placed before or after the sub-command: + + + --disk=uuid|filename + Either the UUID or filename of a harddisk image, e.g. VDI, VMDK, VHD, ++. + + + --dvd=uuid|filename + Either the UUID or filename of a DVD image, e.g. ISO, DMG, CUE. + + + --floppy=uuid|filename + Either the UUID or filename of a floppy image, e.g. IMG. + + + --password-file=-|filename + The name of a file containing the medium encryption password. If + is specified, the password will be read from stdin. + + + + + + mediumio formatfat + + + Formats a floppy medium with the FAT file system. This will erase the + content of the medium. + + + + Quickformat the medium. + + + + + + mediumio cat + + + Dumps the medium content to stdout or the specified file. + + + + Dump as hex bytes. + + + The byte offset in the medium to start. + + + The number of bytes to dump. + + + + The output filename. As usual is take to mean stdout. + + + + + + mediumio stream + + + Converts the medium to a streamable format and dumps it to the given output. + + + + The format of the destination image. + + + The medium variant for the destination. + + + + The output filename. As usual is take to mean stdout. + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-mediumproperty.xml b/doc/manual/en_US/man_VBoxManage-mediumproperty.xml new file mode 100644 index 00000000..726be99f --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-mediumproperty.xml @@ -0,0 +1,209 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage mediumproperty + + + + VBoxManage-mediumproperty + 1 + + + + VBoxManage-mediumproperty + manage medium properties + Oracle VM VirtualBox + + + + + + VBoxManage mediumproperty + + disk + dvd + floppy + + set + + uuid + filename + + property-name + property-value + + + + VBoxManage mediumproperty + + disk + dvd + floppy + + get + + uuid + filename + + property-name + + + + VBoxManage mediumproperty + + disk + dvd + floppy + + delete + + uuid + filename + + property-name + + + + + Description + + The VBoxManage mediumproperty command enables + you to set, retrieve, or delete a medium property. + + + Set a Medium Property + + + The VBoxManage mediumproperty set command + enables you to set a medium property. + + + + disk | dvd | floppy + + Specifies the type of medium. Valid values are + disk (hard drive), + dvd, or floppy. + + + + uuid | filename + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + + + + property-name + + Specifies the name of the property. + + + + property-value + + Specifies the value of the specified property. + + + + + + Retrieve a Medium Property Value + + + The VBoxManage mediumproperty get command + enables you to retrieve the value of a medium property. + + + + disk | dvd | floppy + + Specifies the type of medium. Valid values are + disk (hard drive), + dvd, or floppy. + + + + uuid | filename + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + + + + property-name + + Specifies the name of the property. + + + + + + Delete a Medium Property + + + The VBoxManage mediumproperty delete command + enables you to delete a medium property. + + + + disk | dvd | floppy + + Specifies the type of medium. Valid values are + disk (hard drive), + dvd, or floppy. + + + + uuid | filename + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + + + + property-name + + Specifies the name of the property. + + + + + + + + Examples + + + The following command sets the property called + prop1 to val1 for the + ol7.vdi disk image. + +$ VBoxManage mediumproperty disk set ol7.vdi prop1 val1 + + The following command gets the value of the property called + prop1 for the ol7.vdi disk + image. + +$ VBoxManage mediumproperty disk get ol7.vdi prop1 + + diff --git a/doc/manual/en_US/man_VBoxManage-metrics.xml b/doc/manual/en_US/man_VBoxManage-metrics.xml new file mode 100644 index 00000000..a60d0ff2 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-metrics.xml @@ -0,0 +1,414 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage metrics + + + + VBoxManage-metrics + 1 + + + + VBoxManage-metrics + monitor system resource usage + Oracle VM VirtualBox + + + + + VBoxManage metrics collect + --detach + --list + --period=seconds + --samples=count + + * + host + vmname metric-list + + + + + VBoxManage metrics disable + --list + + * + host + vmname metric-list + + + + + VBoxManage metrics enable + --list + + * + host + vmname metric-list + + + + + VBoxManage metrics list + + * + host + vmname metric-list + + + + + VBoxManage metrics query + + * + host + vmname metric-list + + + + + VBoxManage metrics setup + --list + --period seconds + --samples count + + * + host + vmname metric-list + + + + + + Description + + The VBoxManage metrics command enables you to + monitor system resource usage for the host system and for virtual + machines (VMs). For example, you can monitor particular metrics, + such as the percentage of time CPUs spend executing in user mode + (CPU/Load/User) over a specified sampling + period. + + + While it runs, the VBoxSVC process collects and + saves the specified metric data internally. The + VBoxSVC process runs until shortly after you + close all VMs and frontends. Use the VBoxManage metrics + query command to retrieve data at any time. + + + By default, metrics are not collected unless you run the + VBoxManage metrics setup command to specify a + sampling interval in seconds and the number of metrics to save. + + + Note that you can enable metric collection only for started VMs. + Collected data and collection settings for a VM are discarded when + the VM shuts down. + + + Metrics + + The host and VMs have different sets of associated metrics, + which you can view by running the VBoxManage metrics + list command. + + + Each metric is represented as a string that is composed of a + category and a metric. Optionally, the metric string can include + any of the following: a submetric, a sub-submetric, and an + aggregate. The metric string has the following format: + +category/metric[/submetric[/sub-submetric]][:aggregate] + + + category is the resource type, + such as CPU, RAM, + FS, Net. + + + metric is a measurement type that + is associated with the resource category. For example, the + Load and MHz metrics + are associated with the CPU resource + category. + + + submetric is an optional + measurement type that is associated with the metric. For + example, the User, + Kernel, and Idle + submetrics are associated with the Load + metric. + + + sub-submetric is an optional + measurement type that is associated with the submetric. For + example, the Rx and Tx + sub-submetrics are associated with the + Rate submetric of the + Net resource category. The associated + metric is the network interface. + + + aggregate is an optional function + to provide minimum, maximum, and average measurements for a + resource category. For example, the + RAM/Usage/Free:min metric represents the + minimum amount of available memory found in all saved data + on the host system. + + + + By default, the VBoxManage metrics commands + operate on the host system and all VMs, and report on all + metrics. You can optionally limit these commands to operate on + the host system or on a particular VM, and report on a list of + one or more metrics. + + + + Common Options + + + * | host | vmname + + Specifies the component on which to operate. By default, + this command operates on the host system and all running + VMs. + + If you specify host, the + VBoxManage metrics command operates on + the host system only. If you specify an asterisk + (*), the command operates on all VMs. + If you specify the name of a VM, the VBoxManage + metrics command operates on that VM. + + + + metric-list + + Specifies a comma-separated list of one or more metrics. + + The form of the metric must include the + category and + metric part of the metric + string separated by a slash. + + Note that the VBoxManage metrics enable + and VBoxManage metrics disable commands + require that you specify metrics as parameters. The + metrics must include only the resource category and metric + part, such as CPU/Load and + RAM/Usage. + + + + + + Collect Data Metrics + + + The VBoxManage metrics collect command + collects and outputs data periodically until you stop the + process by pressing Ctrl+C. + + + + + + Disables the collection of metric data, so no data is + output. Using this option is the same as running the + VBoxManage metrics setup command. + + + + + + Shows which metrics match the specified filter. + + + + + + Specifies the number of seconds to wait between collecting + metric data samples. The default value is 1. + + + + + + Specifies the number of metric data samples to save. To + view the saved data, use the VBoxManage metrics + query command. The default value is 1. + + + + + + Disable Metric Data Collection + + + The VBoxManage metrics disable command + suspends data collection. This action does not affect the data + collection properties or the collected data. Note that + specifying a submetric in the metric list does not disable its + underlying metrics. + + + Note that the VBoxManage metrics disable + command requires that you specify metrics as parameters. The + metrics must include only the resource category and metric part, + such as CPU/Load and + RAM/Usage. + + + + + + Shows whether the command succeeded as expected. + + + + + + Enable Metric Data Collection + + + The VBoxManage metrics enable command resumes + data collection after it has been suspended by using the + VBoxManage metrics disable command. Note that + specifying a submetric in the metric list does not enable its + underlying metrics. + + + Unlike the VBoxManage metrics setup command, + the VBoxManage metrics enable command does + not discard previously collected samples for the specified set + of objects and metrics. + + + Note that the VBoxManage metrics enable + command requires that you specify metrics as parameters. The + metrics must include only the resource category and metric part, + such as CPU/Load and + RAM/Usage. + + + + + + Shows whether the command succeeded as expected. + + + + + + List Metric Values + + + The VBoxManage metrics list command shows the + metrics that are currently available. Note that VM-specific + metrics are shown only when that VM is running. + + + + List Saved Metric Data + + + The VBoxManage metrics query command + retrieves and shows the saved metric data. + + + Note that the VBoxManage metrics query + command does not remove or flush saved data but older samples + are replaced by newer samples over time. + + + + Configure Metric-Gathering Properties + + + The VBoxManage metrics setup command + configures metric-gathering properties. + + + Note that this command discards any previously collected samples + for the specified set of objects and metrics. To enable or + disable metrics collection without discarding the data, use the + VBoxManage metrics enable command or the + VBoxManage metrics disable command, + respectively. + + + + + + Shows which metrics have been modified as a result of the + command execution. + + + + + + Specifies the number of seconds to wait between collecting + metric data samples. The default value is 1. + + + + + + Specifies the number of metric data samples to save. To + view the saved data, use the VBoxManage metrics + query command. The default value is 1. + + + + + + + + Examples + + + The following example command enables the collection of host + processor and memory usage metrics every second. The + option saves the five latest samples. + +$ VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage + + The following command lists the metrics that are available to the + host system and VMs: + +$ VBoxManage metrics list + + Note that the host system and VMs have different sets of metrics. + + + The following example shows how to query metric data about the CPU + time spent in user and kernel modes for the + test VM: + +$ VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel + + diff --git a/doc/manual/en_US/man_VBoxManage-modifymedium.xml b/doc/manual/en_US/man_VBoxManage-modifymedium.xml new file mode 100644 index 00000000..97b0e1ef --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-modifymedium.xml @@ -0,0 +1,245 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage modifymedium + + + + VBoxManage-modifymedium + 1 + + + + VBoxManage-modifymedium + change the characteristics of an existing disk image + Oracle VM VirtualBox + + + + + + VBoxManage modifymedium + + disk + dvd + floppy + + + uuid + filename + + --autoreset=on | off + --compact + --description=description + --move=pathname + --property=name=[value] + --resize=megabytes | --resizebyte=bytes + --setlocation=pathname + --type=normal | writethrough | immutable | shareable | readonly | multiattach + + + + + Description + + The VBoxManage modifymedium command enables you + to change the characteristics of an existing disk image. + + + + For compatibility with earlier versions of &product-name;, you + can use the modifyvdi and + modifyhd commands. + + + + + disk | dvd | floppy + + Specifies the media type of the image. + + + + filename + + Specifies the Universally Unique Identifier (UUID) or path + name of the disk image on the host file system. You can + specify the UUID only if the medium is registered. Use the + VBoxManage list hdds command to list the + registered images. You can specfy an absolute or relative + path to the medium. + + + + + + Specifies whether to automatically reset an immutable hard + disk on every virtual machine (VM) startup. This option is + only for immutable hard disks and the default value is + on. See . + + + + + + Compresses disk images by removing blocks that contain only + zeroes. This option shrinks a dynamically allocated image + and reduces the physical size of the + image without affecting the logical size of the virtual + disk. + + You can use this option for base images and for differencing + images that are created as part of a snapshot. + + + Before you compress the image, you must use a suitable + software tool to zero out free space in the guest system. + For example: + + + + Windows guests. Run + the sdelete -z command. + + + Linux guests. Use the + zerofree utility, which supports + ext2 and ext3 + file systems. + + + Mac OS X guests. Use + the diskutil secureErase freespace 0 + / command. + + + + Note that you can only use this option to compress VDI + images. To compress non-VID images, you can zero out free + blocks and then clone the disk to any other dynamically + allocated format. + + + + + + Specifies a text description of the medium. + + + + + + Specifies a relative or absolute path to a medium on the + host system. Use this option to relocate a medium to a + different location on the host system. + + + + + + Specifies a property name and value for the medium. + + + + + + Specifes the new capacity of an existing image in MB. You + can use this option only to expand the capacity of an image. + You can cannot shrink the capacity of an image. + + Note that you can resize only dynamically allocated disk + images that use the VDI and VHD formats. This option adjusts + the logical size of a virtual disk and + has only a minor affect on the physical size. + + For example, if your dynamically allocated 10 GB disk is + full, you can use the option + to increase the capacity of the existing disk to 15 GB + (15,360 MB). This operation enables you to avoid having to + create a new image and copy all data from within a VM. + + Note that using this option only changes the capacity of the + drive. So, you might need to subsequently use a partition + management tool in the guest to adjust the main partition to + fill the drive. + + + + + + Specifes the new capacity of an existing image in bytes. + This option is similar to the + option, but you specify the size in bytes instead of + megabytes. + + + + + + Specifies the new location of the medium on the host system + after the medium has been moved. The path name can be + relative to the current directory or be absolute to the + root. + + Note that the VBoxManage modifymedium + command does not perform any sanity checks on the path name + you specify. Ensure that the path name is valid. + + + + + + Specifies the new mode type of an existing image. Valid + values are normal, + immutable, + writethrough, + multi-attach, + shareable, and + readonly. For descriptions of these mode + types, see . + + + + + + + Examples + + + The following command modifies the description for the disk image + file called disk01.vdi. + +$ VBoxManage modifymedium disk disk01.vdi --description "Oracle Linux 7 image" + + The following command modifies the write mode for the disk image + file called disk01.vdi. + +$ VBoxManage modifymedium disk disk01.vdi --type writethrough + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-modifyvm.xml b/doc/manual/en_US/man_VBoxManage-modifyvm.xml new file mode 100644 index 00000000..322dcf44 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-modifyvm.xml @@ -0,0 +1,2484 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage modifyvm + + + + VBoxManage-modifyvm + 1 + + + + VBoxManage-modifyvm + Change settings for a virtual machine that is stopped + Oracle VM VirtualBox + + + + + + VBoxManage modifyvm + + uuid + vmname + + --name=name + --groups= group [,group...] + --description=description + --ostype=OS-type + --iconfile=filename + --memory=size-in-MB + --pagefusion= + on + off + + --vram=size-in-MB + --acpi= + on + off + + --pciattach=host-PCI-address + --pcidetach=host-PCI-address + --ioapic= + on + off + + --hardwareuuid=UUID + --cpus=CPU-count + --cpuhotplug= + on + off + + --plugcpu=CPU-ID + --unplugcpu=CPU-ID + --cpuexecutioncap=number + --pae= + on + off + + --longmode= + on + off + + --ibpb-on-vm-exit= + on + off + + --ibpb-on-vm-entry= + on + off + + --spec-ctrl= + on + off + + --l1d-flush-on-sched= + on + off + + --l1d-flush-on-vm-entry= + on + off + + --mds-clear-on-sched= + on + off + + --mds-clear-on-vm-entry= + on + off + + --cpu-profile= + host + Intel 8086 + Intel 80286 + Intel 80386 + + --hpet= + on + off + + --hwvirtex= + on + off + + --triplefaultreset= + on + off + + --apic= + on + off + + --x2apic= + on + off + + --paravirtprovider= + none + default + legacy + minimal + hyperv + kvm + + --paravirtdebug= key=value [,key=value...] + --nestedpaging= + on + off + + --largepages= + on + off + + --vtxvpid= + on + off + + --vtxux= + on + off + + --accelerate3d= + on + off + + --accelerate2dvideo= + on + off + + --chipset= + ich9 + piix3 + + --bioslogofadein= + on + off + + --bioslogofadeout= + on + off + + --bioslogodisplaytime=msec + --bioslogoimagepath=pathname + --biosbootmenu= + disabled + menuonly + messageandmenu + + --biosapic= + disabled + apic + x2apic + + --biossystemtimeoffset=msec + --biospxedebug= + on + off + + --system-uuid-le= + on + off + + --bootX= + none + floppy + dvd + disk + net + + --rtcuseutc= + on + off + + --graphicscontroller= + none + vboxvga + vmsvga + vboxsvga + + --snapshotfolder= + default + pathname + + --firmware= + bios + efi + efi32 + efi64 + + --guestmemoryballoon=size-in-MB + --defaultfrontend= + default + name + + --nested-hw-virt= + on + off + + --vm-process-priority= + default + flat + low + normal + high + + + + + VBoxManage modifyvm + + uuid + vmname + + --nicN= + none + null + nat + bridged + intnet + hostonly + generic + natnetwork + + --nictypeN= + Am79C970A + Am79C973 + 82540EM + 82543GC + 82545EM + virtio + + --cableconnectedN= + on + off + + --nictraceN= + on + off + + --nictracefileN=filename + --nicpropertyN=name= value + --nicspeedN=kbps + --nicbootprioN=priority + --nicpromiscN= + deny + allow-vms + allow-all + + --nicbandwidthgroupN= + none + name + + --bridgeadapterN= + none + device-name + + --hostonlyadapterN= + none + device-name + + --intnetN=network-name + --nat-networkN=network-name + --nicgenericdrvN=driver-name + --macaddressN= + auto + MAC-address + + + + + VBoxManage modifyvm + + uuid + vmname + + --natnetN= + network + default + + --natpfN= + [rule-name],tcp + udp,[host-IP],hostport,[guest-IP],guestport + + --natpfN=delete=rule-name + --nattftpprefixN=prefix + --nattftpfileN=filename + --nattftpserverN=IP-address + --natbindipN=IP-address + --natdnspassdomainN= + on + off + + --natdnsproxyN= + on + off + + --natdnshostresolverN= + on + off + + --natsettingsN=[mtu],[socksnd],[sockrcv],[tcpsnd],[tcprcv] + --nataliasmodeN= + default + [log],[proxyonly],[sameports] + + + + + VBoxManage modifyvm + + uuid + vmname + + --mouse= + ps2 + usb + usbtablet + usbmultitouch + + --keyboard= + ps2 + usb + + --uartN= + off + IO-base IRQ + + --uartmodeN= + disconnected + server pipe + client pipe + tcpserver port + tcpclient hostname:port + file filename + device-name + + --uarttypeN= + 16450 + 16550A + 16750 + + --lptmodeN=device-name + --lptN= + off + IO-base IRQ + + --audio= + none + null + dsound + oss + alsa + pulse + coreaudio + + --audiocontroller= + ac97 + hda + sb16 + + --audiocodec= + stac9700 + ad1980 + stac9221 + sb16 + + --audioin= + on + off + + --audioout= + on + off + + --clipboard= + disabled + hosttoguest + guesttohost + bidirectional + + --draganddrop= + disabled + hosttoguest + guesttohost + bidirectional + + --monitorcount=number + --usbehci= + on + off + + --usbohci= + on + off + + --usbxhci= + on + off + + --usbrename=old-name new-name + + + + VBoxManage modifyvm + + uuid + vmname + + --recording= + on + off + + --recordingscreens= + all + screen-ID [screen-ID...] + + --recordingfile=filename + --recordingmaxsize=MB + --recordingmaxtime=msec + --recordingopts= key=value [,key=value...] + --recordingvideofps=fps + --recordingvideorate=rate + --recordingvideores=width height + + + + VBoxManage modifyvm + + uuid + vmname + + --vrde= + on + off + + --vrdeproperty=property-name= property-value + --vrdeextpack= + default + name + + --vrdeport=port + --vrdeaddress=hostip + --vrdeauthtype= + null + external + guest + + --vrdeauthlibrary= + default + name + + --vrdemulticon= + on + off + + --vrdereusecon= + on + off + + --vrdevideochannel= + on + off + + --vrdevideochannelquality=percent + + + + VBoxManage modifyvm + + uuid + vmname + + --teleporter= + on + off + + --teleporterport=port + --teleporteraddress= + address + empty + + --teleporterpassword=password + --teleporterpasswordfile= + filename + stdin + + --cpuid-portability-level=level + --cpuid-set=leaf :subleaf eax ebx ecx edx + --cpuid-remove=leaf :subleaf + --cpuidremoveall + + + + VBoxManage modifyvm + + uuid + vmname + + --tracing-enabled= + on + off + + --tracing-config=string + --tracing-allow-vm-access= + on + off + + + + + VBoxManage modifyvm + + uuid + vmname + + --usbcardreader= + on + off + + + + + VBoxManage modifyvm + + uuid + vmname + + --autostart-enabled= + on + off + + --autostart-delay=seconds + + + + + Description + + The VBoxManage modifyvm command enables you to + change the properties of a registered virtual machine (VM) that is + not running. + + + Most of these properties correspond to the VM settings that are + shown in each VM's Settings + dialog in the VirtualBox Manager. See + . However, some settings can only + be viewed and managed with the VBoxManage + command. + + + You can use the VBoxManage modifyvm command to + change VM settings only when the VM is powered off. The VM cannot + be running or in saved state when you use this command. + + + You can use the VBoxManage controlvm command to + dynamically change some VM machine settings while the VM is + running. See . + + + General Settings + + + The following options enable you to modify general information + about your VM. + + + The VBoxManage modifyvm command supports the + following options: + + + + + + Changes the name of the VM and its related internal VM + files. See . + + + + + + Changes the group membership of a VM. Group names always + begin with a slash character (/) and + can be nested. By default, VMs are members of the + / group. + + + + + + Changes the optional VM description. Use a description to + record details about the VM in a meaningful way. The GUI + interprets HTML markup while the VBoxManage + modifyvm command enables you include arbitrary + strings that can contain multiple lines. + + + + + + Specifies the guest operating system (OS) to run in the + VM. Use the VBoxManage list ostypes + command to view the OS type identifiers. + + + + + + Specifies the absolute path to the &product-name; icon on + the host system. The icon is shown on the VM. + + + + + + Specifies the amount of host system RAM to allocate to the + VM. The size is in MB. See + . + + + + + + Enables or disables the Page Fusion feature, which is + disabled by default. Use the Page Fusion feature to + minimize the memory duplication between VMs that have + similar configurations and that run on the same host + system. See . + + + + + + Specifies the amount of RAM to allocate to the virtual + graphics card. See . + + + + + + Determines whether the VM has ACPI support. See + . + + + + + + Determines whether the VM has I/O APIC support. See + . + + + + + + Attaches the specified PCI network controller on the host + to the guest VM. You can optionally specify the PCI bus on + the guest VM on which to attach the controller. See + . + + + + + + Detaches the specified PCI network controller from the + attached PCI bus on the guest VM. See + . + + + + + + Specifies the Universally Unique Identifier (UUID) to + present to the guest VM in memory tables (DMI/SMBIOS), + hardware, and VM properties. By default this hardware UUID + is the same as the VM UUID. Use this option when cloning a + VM. Note that the teleporting feature automatically + handles the UUID value. + + + + + + Specifies the number of virtual CPUs to assign to the VM. + See . + + If CPU hot-plugging is enabled, this option specifies the + maximum number of virtual CPUs that can be plugged into + the VMs. + + + + + + Enables or disables CPU hot-plugging. When enabled, you + can dynamically add virtual CPUs to a VM or remove virtual + CPUs from a VM. See . + + + + + + Adds a virtual CPU to the VM. + CPU-ID is the index of the + virtual CPU to add. A valid index value is a number from + 0 to the maximum number of CPUs that + you configured by using the + option. + + Only use this option if CPU hot-plugging is enabled. + + + + + + Removes a virtual CPU from the VM. + CPU-ID is the index of the + virtual CPU to remove. A valid index value is a number + from 1 to the maximum number of CPUs + that you configured by using the + option. + + Only use this option if CPU hot-plugging is enabled. + + Note that you cannot remove CPU 0. + + + + + + Specifies how much CPU time a virtual CPU can use. A valid + value is from 1 to + 100. A value of 50 indicates that a + single virtual CPU can use up to 50% of a single host CPU. + + + + + + Enables or disables physical address extension (PAE). See + . + + + + + + Enables or disables long mode. See + . + + + + + + Enables use of Indirect Branch Prediction Barrier (IBPB) + on every VM exit. + + + + + + Enables use of Indirect Branch Prediction Barrier (IBPB) + on every VM entry. + + + + + + Enables or disables the exposure of speculation control + interfaces to the guest VM. These interfaces must be + available on the host system. + + Depending on the host CPU and the workload, enabling + speculation control might significantly reduce + performance. + + + + + + Enables or disables level 1 data cache flushing when a + thread is scheduled to execute guest code. See + . + + + + + + Enables or disables level 1 data cache flushing on every + VM entry. See . + + + + + + Enables CPU buffer clearing when a thread is scheduled to + execute guest code. See + . + + + + + + Enables CPU buffer clearing on every VM entry. See + . + + + + + + Specifies the profile to use for guest CPU emulation. + Specify a value that is based on the host system CPU + (host) or one of the following older + Intel micro-architectures: 8086, + 80286, or 80386. + + + + + + Enables or disables a High Precision Event Timer (HPET) + that can replace a legacy system timer. This feature is + disabled by default. Note HPET is supported on Windows + versions starting with Vista. + + + + + + Enables or disables the use of hardware virtualization + extensions in the processor of the host system. Such + extensions are Intel VT-x or AMD-V. See + . + + + + + + Enables or disables the resetting of the guest VM instead + of triggering a Guru Meditation. Some guest VMs raise a + triple fault to reset the CPU, so sometimes resetting the + guest VM is the best outcome. This option only applies to + guests that do not use symmetric multiprocessing (SMP). + + + + + + Enables or disables I/O APIC. With I/O APIC, OSes can use + more than 16 interrupt requests (IRQs) to avoid IRQ + sharing and to improve reliability. I/O APIC is enabled by + default. See . + + + + + + Enables or disables the CPU x2APIC feature. CPU x2APIC + enables an OS to run more efficiently on high core count + configurations and to optimize interrupt distribution in + virtualized environments. This feature is enabled by + default. + + Disable this feature when the OS that runs on a host + system or a guest VM is incompatible with CPU x2APIC. + + + + + + Specifies one of the following paravirtualization + interfaces to provide to the guest OS: + + + none does not expose any + paravirtualization interface. + + + default selects the appropriate + interface based on the guest OS type when starting the + VM. This is the default value used when creating new + VMs. + + + legacy selects a paravirtual + interface for VMs that were created by older + &product-name; versions. + + + minimal is required for Mac OS X + guest VMs. + + + kvm is recommended for Linux guest + VMs. See . + + + hyperv is recommended for Windows + guest VMs. See . + + + + + + + Specifies debugging properties that are specific to the + paravirtualization provider configured for the specified + VM. See . + + + + + + Enables or disables the nested paging feature in the + processor of the host system. This option is available + only when hardware virtualization is enabled. See + and + . + + + + + + Enables or disables the hypervisor's use of large pages, + which can improve performance by up to 5%. The use of + large pages reduces TLB use and overhead. This option is + available only when both hardware virtualization and + nested paging are enabled. + + + + + + Enables or disables the use of the tagged TLB (VPID) + feature in the processor of your host system. See + . This option is available only + when hardware virtualization is enabled on Intel VT-x. + + + + + + Enables or disables the use of unrestricted guest mode for + executing the guest VM. This option is available only when + hardware virtualization is enabled on Intel VT-x. + + + + + + Enables or disables hardware 3D acceleration. This option + is available only when the Guest Additions are installed. + See . + + + + + + Enables or disables 2D video acceleration. This option is + available only when the Guest Additions are installed. See + . + + + + + + Specify the Intel chipset for &product-name; to emulate. + The default value is the Intel PIIX3 chipset + (piix3). + + Change this value only if you need to relax some of the + chipset constraints. See + . + + + + + + Specifies whether the BIOS logo fades in on VM startup. By + default, an &product-name; logo is shown. + + + + + + Specifies whether the BIOS logo fades out on VM startup. + + + + + + Specifies the amount of time in milliseconds that the BIOS + logo is visible. + + + + + + Replaces the existing BIOS logo with a different image. + The replacement image must be an uncompressed 256-color + bitmap file (BMP) that does not contain color space + information (Windows 3.0 format). Also ensure that the + image is no larger than 640 X 480 pixels. + + + + + + Specifies whether the BIOS permits you to select a + temporary boot device. Valid values are: + + + disabled outputs the alternate boot + device message and permits you to select a temporary + boot device by pressing F12. + + + menuonly suppresses the alternate + boot device message, but permits you to select a + temporary boot device by pressing F12. + + + messageandmenu suppresses the + alternate boot device message and prevents you from + selecting a temporary boot device by pressing F12. + + + + + + + Specifies the APIC level of the firmware. Valid values + are: x2apic, apic, + and disabled. When the value is + disabled, neither the + apic nor the x2apic + version of the firmware is used. + + Note that if you specify the x2apic + value and x2APIC is unsupported by the virtual CPU, the + APIC level downgrades to apic, if + supported. Otherwise, the APIC level downgrades to + disabled. Similarly, if you specify the + apic value and APIC is unsupported by + the virtual CPU, the APIC level downgrades to + disabled. + + + + + + Specifies the time offset in milliseconds of the guest VM + relative to the time on the host system. If the offset + value is positive, the guest VM time runs ahead of the + time on the host system. + + + + + + Enables or disables additional debugging output when using + the Intel PXE boot ROM. The debug output is written to the + release log file. See + . + + + + + + Enables or disables representing the system UUID in little + endian form. The default value is on for + new VMs. For old VMs the setting is off to + keep the content of the DMI/SMBIOS table unchanged, which can + be important for Windows license activation. + + + + + + Enables you to specify the boot device order for the VM by + assigning one of the device types to each of the four boot + device slots that are represented by + N in the option name. + + A value of 1 for N represents + the first boot device slot, and so on. + + The device types are floppy for floppy + disks, dvd for DVDs or CDs, + disk for hard disks, and + net for a network device. A value of + none indicates that no boot device is + associated with the specified slot. + + + + + + Specifies whether the real-time clock (RTC) uses + coordinated universal time (UTC). See + . + + + + + + Specifies the graphics controller type to use. See + . + + + + + + Specifies the name of the VM's snapshot storage folder. If + you specify default, the folder name is + Snapshots/ in the machine folder. + + + + + + Specifies the firmware used to boot the VM. Valid values + are: bios, efi, + efi32, or efi64. Use + EFI values with care. + + By default, BIOS firmware is used. + + + + + + Specifies the size of the guest memory balloon. The guest + memory balloon is the memory allocated by the Guest + Additions from the guest OS and returned to the hypervisor + for use by other VMs. Specify + size in megabytes. The default + value is 0 megabytes. See + . + + + + + + Specifies the default frontend to use when starting the + specified VM. If you specify default, + the VM is shown in a window on the user's desktop. See + . + + + + + + Enables or disables nested virtualization. See + . + + + + + + Specifies the priority scheme of the VM process to use + when starting the specified VM and while the VM runs. + + + + + + Networking Settings + + + The following options enable you to modify networking on your + VM. With all these options, N is an + integer greater than zero that represents the particular virtual + network adapter to configure. + + + + + + Configures the network type used by each virtual network + card in the VM. + + The following valid values correspond to the modes + described in : + + + none – No networking present + + + null – Not connected to the + host system + + + nat – Use network address + translation (NAT) + + + natnetwork – Use a NAT + metwork + + + bridged – Use bridged + networking + + + intnet – Use internal + networking + + + hostonly – Use host-only + networking + + + generic – Access rarely used + sub-modes + + + + + + + Identifies the type of networking hardware that + &product-name; presents to the guest VM for the specified + virtual network card. See . + + Valid values are as follows: + + + Am79C970A represents the AMD PCNet + PCI II. + + + Am79C973 represents the AMD PCNet + FAST III, which is the default value. + + + 82540EM represents the Intel + PRO/1000 MT Desktop. + + + 82543GC represents the Intel + PRO/1000 T Server. + + + 82545EM represents the Intel + PRO/1000 MT Server. + + + virtio represents a paravirtualized + network adapter. + + + + + + + Temporarily disconnects a virtual network interface, as if + you pull a network cable from a physical network card. You + might use this option to reset certain software components + in the VM. + + + + + + Enables or disables network tracing for the specified + virtual network card. + + + + + + Specifies the absolute path of the file in which to write + trace log information. Use this option if network tracing + is enabled. + + + + + + Enables you to set property values and pass them to rarely + used network backends. To use this option, you must also + use the option. + + These properties are specific to the backend engine and + differ between the UDP Tunnel and the VDE backend drivers. + For property examples, see + . + + + + + + Specifies the throughput rate in kilobits per second for + rarely used networking sub-modes such as VDE network and + UDP Tunnel. Use this option only if you used the + option to enable generic networking + for the specified virtual network card. + + + + + + Assigns a priority to each NIC that determines the order + in which that NIC is used to perform a PXE network boot. + The priority value is an integer in the range from + 0 to 4. Priority + 0, which is the default value, is the + lowest priority. Priority 1 is the + highest priority, and priorities 3 and + 4 are lower. + + This option has an effect only when using the Intel PXE + boot ROM. + + + + + + Enables you to specify whether to deny or allow + promiscuous mode for the specified VM virtual network + card. This option is relevant only for bridged networking. + Valid values are as follows: + + + deny hides any traffic that is not + intended for the VM. This is the default value. + + + allow-vms hides all host traffic + from the VM, but allows the VM to see traffic to and + from other VMs. + + + allow-all allows the VM to see all + traffic. + + + + + + + Adds or removes a bandwidth group assignment to the + specified virtual network interface. Valid values are as + follows: + + + none removes any current bandwidth + group assignment from the specified virtual network + interface. + + + name adds a bandwidth group + assignment to the specified virtual network interface. + + + See . + + + + + + Specifies the host interface to use for the specified + virtual network interface. See + . Use this option only + if you used the option to enable + bridged networking for the specified virtual network card. + + + + + + Specifies which host-only networking interface to use for + the specified virtual network interface. See + . Use this option only + if you used the option to enable + host-only networking for the specified virtual network + card. + + + + + + Specifies the name of the internal network. See + . Use this option only + if you used the option to enable + internal networking for the specified virtual network + card. + + + + + + Specifies the name of the NAT network to which this + adapter is connected. Use this option only if the + networking type is natnetwork, not + nat. + + + + + + Enables you to access rarely used networking sub-modes, + such as VDE networks and UDP Tunnel. Use this option only + if you used the option to enable + generic networking for a virtual network card. + + + + + + Specifies the MAC address of the specified network adapter + on the VM. By default, &product-name; assigns a random MAC + address to each network adapter at VM creation. + + + + + + NAT Networking Settings + + + The following options use N to + specify the particular virtual network adapter to modify. + + + + + + Specifies the IP address range to use for this network. + See . Use this option only if + the networking type is nat, not + natnetwork. + + + + + + Specifies the NAT port-forwarding rule to use. See + . + + + + + + Specifies the NAT port-forwarding rule to delete. See + . + + + + + + Specifies a prefix to use for the built-in TFTP server. + For example, you might use a prefix to indicate where the + boot file is located. See and + . + + + + + + Specifies the name of the TFT boot file. See + . + + + + + + Specifies the address of the TFTP server from which to + boot. See . + + + + + + Specifies an alternate IP address to which the NAT engine + binds. See . By + default, &product-name;'s NAT engine routes TCP/IP packets + through the default interface assigned by the host's + TCP/IP stack. + + + + + + Specifies whether the built-in DHCP server passes the + domain name for network name resolution. + + + + + + Specifies whether the NAT engine is the proxy for all + guest DNS requests to the host system's DNS servers. See + . + + + + + + Specifies whether the NAT engine uses the host system's + resolver mechanisms to handle DNS requests. See + . + + + + + + Specifies values for tuning NAT performance. See + . + + + + + + Specifies the behavior of the NAT engine core as follows: + + + log enables logging + + + proxyonly switches off aliasing + mode and makes NAT transparent + + + sameports enforces that the NAT + engine sends packets through the same port on which + they originated + + + default disables all aliasing modes + + + For more information, see + . + + + + + + Other Hardware Settings + + + The following options enable you to configure other hardware, + such as the serial port, monitor, audio device, USB ports, and + the clipboard, and drag-and-drop features. + + + + + + Specifies the mode of the mouse to use in the VM. Valid + values are: ps2, + usb, usbtablet, and + usbmultitouch. + + + + + + Specifies the mode of the keyboard to use in the VM. Valid + values are: ps2 and + usb. + + + + + + Configures virtual serial ports for the VM. + N represents the serial port to + modify. Valid values are off to disable + the port or an I/O base address and IRQ. For information + about the traditional COM port I/O base address and IRQ + values, see . + + + + + + Specifies how &product-name; connects the specified + virtual serial port to the host system that runs the VM. + See . + + Ensure that you first configure the virtual serial port by + using the + + option. + + Specify one of the following connection modes for each + port: + + + disconnected indicates that even + though the serial port is shown to the guest VM, it is + not connected. This state is like a physical COM port + without a cable attached. + + + server + pipe-name creates the + specified named pipe or local domain socket on the + host system and connects the virtual serial device to + it. + + On a Windows host system, + pipe-name is a named pipe + that has a name that uses the following form: + \\.\pipe\. + + On a Linux host system, + pipe-name is a local domain + socket. + + + client + pipe-name connects the + virtual serial device to the specified named pipe or + local domain socket. + + Note that the named pipe or local domain socket must + already exist. + + + tcpserver + port creates a TCP socket + with the specified TCP port on the host system and + connects the virtual serial device to it. + + For UNIX-like systems, use ports over 1024 for + non-root users. + + + tcpclient + hostname:port + connects the virtual serial device to the TCP socket. + + Note that the TCP socket must already exist. + + + file + filename redirects the + serial port output to the specified raw file. Ensure + that filename is the + absolute path of the on the host system. + + + device-name: specifies the + device name of a physical hardware serial port on the + specified host system to which the virtual serial port + connects. + + Use this mode to connect a physical serial port to a + VM. + + On a Windows host system, the device name is a COM + port such as COM1. On a Linux host + system, the device name is similar to + /dev/ttyS0. + + + + + + + Configures the UART type for the specified virtual serial + port (N). Valid values are + 16450, 16550A, and + 16750. The default value is + 16550A. + + + + + + Specifies the device name of the parallel port to use. + Ensure that you use this option before using the + option. + + For a Windows host system, use a device name such as + lpt1. For a Linux host system, use a + device name such as /dev/lp0. + + + + + + Specifies the I/O base address and IRQ of the parallel + port. Ensure that you use this option after using the + option. + + You can view the I/O base address and IRQ that the VM uses + for the parallel port in the Device Manager. + + + + + + Specifies whether the VM has audio support, and if so, + which type. Valid audio type values are: + none, null, + dsound, oss, + alsa, pulse, and + coreaudio. + + Note that the audio types are dependent on the host + operating system. Use the VBoxManage + modifyvm command usage output to determine the + supported audio types for your host system. + + + + + + Specifies the audio controller to be used with the VM. + Valid audio controller type values are: + ac97, hda, and + sb16. + + + + + + Specifies the audio codec to be used with the VM. Valid + audio codec type values are: stac9700, + ad1980, stac9221, + and sb16. + + + + + + Specifies whether to enable or disable audio capture from + the host system. + + + + + + Specifies whether to enable or disable audio playback from + the guest VM. + + + + + + Specifies how to share the guest VM or host system OS's + clipboard with the host system or guest VM, respectively. + Valid values are: disabled, + hosttoguest, + guesttohost, and + bidirectional. See + . + + The clipboard feature is available only if you have the + Guest Additions be installed in the VM. + + + + + + Specifies how to use the drag and drop feature between the + host system and the VM. Valid values are: + disabled, + hosttoguest, + guesttohost, and + bidirectional. See + . + + The drag and drop feature is available only if you have + the Guest Additions be installed in the VM. + + + + + + Enables you to configure multiple monitors. See + . + + + + + + Enables or disables the VM's virtual USB controller. See + . + + + + + + Enables or disables the VM's virtual USB 1.1 controller. + See . + + + + + + Enables or disables the VM's virtual USB 2.0 controller. + See . + + + + + + Enables or disables the VM's virtual USB 3.0 controller. + See . + + + + + + Rename's the VM's virtual USB controller from + old-name to + new-name. + + + + + + Recording Settings + + + The following options enable you to modify settings for video + recording, audio recording, or both. + + + + + + Enables or disables the recording of a VM session into a + WebM or VP8 file. When set to on, + recording begins when the VM session starts. + + + + + + Enables you to specify the VM screens to record. The + recording for each screen is output to its own file. Valid + values are: all, which records all + screens, or one or more specified screens. + + + + + + Specifies the name of the file in which to save the + recording. + + + + + + Specifies the maximum size of the recorded video file in + megabytes. When the file reaches the specified size, + recording stops. If the value is 0, + recording continues until you manually stop recording. + + + + + + Specifies the maximum amount of time to record in seconds. + When the specified time elapses, recording stops. If the + value is 0, recording continues until + you manually stop recording. + + + + + + Specifies additional video-recording properties as a + comma-separated property keyword-value list. For example, + foo=bar,a=b. + + Only use this option if you are an advanced user. For + information about keywords, see the Oracle VM + VirtualBox Programming Guide and Reference. + + + + + + Specifies the maximum number of video frames per second + (FPS) to record. The recording ignores any frames that + have a higher frequency. When you increase the FPS, fewer + frames are ignored but the recording and the size of the + recording file increases. + + + + + + Specifies the bit rate of the video in kilobits per + second. When you increase the bit rate, the recording + appearance improves and the size of the recording file + increases. + + + + + + Specifies the video resolution (width and height) of the + recorded video in pixels. + + + + + + Remote Machine Settings + + + The following options enable you to modify the VirtualBox Remote + Desktop Extension (VRDE) behavior. + + + + + + Enables or disables the VRDE server. + + + + + + port is the port or port range + to which the VRDE server binds. The + default or 0 value + uses port 3389, which is the standard + RDP port. + + Also see the option + description. + + + + + + IP-address is the IP address of + the host network interface to which the VRDE server binds. + When specified, the server accepts connections only on the + host network interface at that IP address. + + Also see the option + description. + + + + + + Specifies whether the VRDP video channel is on or off. + 1 means on and + 0 means off. See + . + + + + + + Specifies a value between 10% and 100%, inclusive, that + represents the JPEG compression level on the VRDE server + video channel. A lower value produces lower JPEG quality + but higher compression. See + . + + + + + + Enables or disables the video downscale protection + feature. Valid values are 1 to enable + the feature and 0 to disable the + feature. + + When this feature is enabled, &product-name; determines + whether to display the video: + + + When the video size equals the size of the shadow + buffer, the video is considered to be full screen and + is displayed. + + + When the video size is between full screen and the + downscale threshold, the video is not displayed. Such + a video might be an application window, which is + unreadable when downscaled. + + + When this feature is disabled, an attempt is always made + to display a video. + + + + + + Disables the display VRDE server feature. + + To reenable a feature, assign a null value. For example, + to reenable the display feature, specify the + VBoxManage modifyvm + --vrdeproperty=Client/DisableDisplay= command. + See . + + + + + + Disables the input VRDE server feature. + + + + + + Disables the audio VRDE server feature. + + + + + + Disables the USB VRDE server feature. + + + + + + Disables the clipboard VRDE server feature. To reenable + the feature, assign a null value. See + . + + + + + + Disables the upstream audio VRDE server feature. To + reenable the feature, assign a null value. See + . + + + + + + Disables the RDP device redirection for smart cards VRDE + server feature. To reenable this feature, assign a null + value. + + + + + + Enables the 3D redirection VRDE server feature. To disable + this feature, assign a null value. + + + + + + Specifies the following information that is required for a + connection: + + + Negotiate indicates that both + Enhanced (TLS) and Standard RDP Security connections + are permitted. The security method is negotiated with + the client. This is the default value. + + + RDP indicates that only Standard + RDP Security is accepted. + + + TLS indicates that only Enhanced + RDP Security is accepted. The client must support TLS. + + + See . + + + + + + Specifies the absolute path to the server certificate. See + . + + + + + + Specifies the absolute path to the server private key. See + . + + + + + + Specifies the absolute path to the CA self-signed + certificate. See . + + + + + + Specifies the audio connection mode or the path to the + audio log file. Valid values are as follows: + + + VRDP_AUDIO_MODE_VOID is no mode. + Use this value to unset any set audio mode. + + + VRDP_AUDIO_MODE_RC is the rate + correction mode. + + + VRDP_AUDIO_MODE_LPF is the low pass + filter mode. + + + VRDP_AUDIO_MODE_CS is the client + sync sync mode to prevent an underflow or overflow of + the client queue. + + + + + + + Specifies the absolute path to the audio log file. + + + + + + Specifies the library to use to access the VM remotely. + The default value uses the RDP code + that is part of the &product-name; Extension Pack. + + To use the VRDE module in VNC, specify + VNC. See + . + + + + + + port is the port or port range + to which the VRDE server binds. The + default or 0 value + uses port 3389, which is the standard + RDP port. + + You can specify a comma-separated list of ports or port + ranges of ports. Use a dash between two port numbers to + specify a port range. The VRDE server binds to only one of + the available ports from the list. Only one machine can + use a given port at a time. For example, the + option + specifies that server can bind to one of following ports: + 5000, 5010, + 5011, or 5012. + + + + + + Specifies the IP address of the host network interface to + which the VRDE server binds. If you specify an IP address, + the server accepts connections only on the specified host + network interface. + + Use this option to specify whether the VRDP server should + accept IPv4, IPv6, or both type of connections: + + + Only IPv4: Use the + option. + + + Only IPv6: Use the + option. + + + Both IPv6 and IPv4: + Use the + option. This is the default value. + + + + + + + Specify whether to use authorization and how to perform + authorization. See . Valid + values are as follows: + + + null provides no authentication. + + + external provides external + authentication through an authentication library. + + + guest performs authentication by + using guest user accounts. This unsupported method + requires that you install the Guest Additions on the + VM. + + + + + + + Specifies the library to use for RDP authentication. The + default library for external authentication is + VBoxAuth. See + . + + + + + + Enables or disables the multiple connections VRDE server + feature, if supported. See + . + + + + + + Specifies how the VRDE server behaves when multiple + connections are disabled. When the value is + on, the server permits a new client to + connect and drops the existing connection. When the value + is off, a new connection is not + accepted if a client is already connected to the server. + This is the default value. + + + + + + Enables video redirection if supported by the VRDE server. + See . + + + + + + Specifies the image quality for video redirection as a + value from 10 to 100 percent. The percentage represents + the JPEG compression level where a lower number diminishes + quality and provides higher compression. See + . + + + + + + Teleporting Settings + + + The following options enable you to configure a machine as a + teleporting target. See . + + + + + + Enables or disables the teleporter. When enabled, a + machine starts up and waits to receive a teleporting + request from the network instead of booting normally. + + Teleporting requests are received on the port and address + specified using the following parameters. + + + + + + Specifies the port on which the VM listens to receive a + teleporting request from another VM. + port is any free TCP/IP port + number, such as 6000. You must also + specify the option. + + + + + + Specifies the IP address on which the VM listens to + receive a teleporting request from another VM. + IP-address is any IP address or + host name and specifies the TCP/IP socket on which to + bind. The default IP address is + 0.0.0.0, which represents any IP + address. You must also specify the + option. + + + + + + Specifies the password to use for authentication. When + specified, the teleporting request only succeeds if the + password on the source machine is the same password as the + one you specify. + + + + + + Specifies a file that contains the password to use for + authentication. When specified, the teleporting request + only succeeds if the password on the source machine is the + same password as the one you specify in the password file. + A value of stdin reads the password + from standard input. + + + + + + For advanced users only. + + Restricts the virtual CPU capabilities that &product-name; + presents to the guest VM OS. This option affects what the + guest VM sees when it executes the + CPUID machine instruction. + + Run the VBoxManage modifyvm command + with this option prior to a teleporting operation on both + the source and the target machines. + + Use this option if a misbehaving application assumes that + certain CPU capabilities are present when they are not. + The meaning of the values is hardware dependent. See the + AMD or Intel processor documentation. + + + + + + Debugging Settings + + + Only use the following options to perform low-level VM + debugging. These options are for advanced users only. + + + + + + Enables or disables the trace buffer. Note that when + specified, the trace buffer consumes some memory and adds + overhead. + + + + + + Enables a tracing configuration that defines which group + of trace points are enabled. + + + + + + Enables or disables VM access to the trace buffer. The + default value is off, which disables + access. + + + + + + USB Card Reader Settings + + + The following options specify the access to a USB Card Reader by + the guest environment. A USB card reader can access data on + memory cards, such as CompactFlash (CF), Secure Digital (SD), + and MultiMediaCard (MMC). + + + + + + Enables or disables the USB card reader interface. + + + + + + Autostarting VMs During Host System Boot + + The following options enable you to configure the VM autostart + feature, which automatically starts the VM at host system + boot-up. You must do some host system configuration before you + can use this feature. See . + + + + + + + Enables or disables VM autostart at host system boot-up + for the specified users. + + + + + + Specifies the number of seconds after host system boot-up + to autostart the VM. + + + + + + + + Examples + + + The following command changes the description for the + ol7 VM. + +$ VBoxManage modifyvm ol7 --description "Oracle Linux 7 with UEK4" + + The following command enables VirtualBox Remote Display Protocol + (VRDP) support for the ol7 VM. + +$ VBoxManage modifyvm ol7 --vrde on + + + + See Also + + , + , + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-movevm.xml b/doc/manual/en_US/man_VBoxManage-movevm.xml new file mode 100644 index 00000000..7162f3e2 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-movevm.xml @@ -0,0 +1,97 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage movevm + + + + VBoxManage-movevm + 1 + + + + VBoxManage-movevm + move a virtual machine to a new location on the host system + Oracle VM VirtualBox + + + + + + VBoxManage movevm + + uuid + vmname + + --type=basic + --folder=folder-name + + + + + Description + + The VBoxManage movevm command moves a virtual + machine (VM) to a new location on the host system. + + + When moved, all of the files that are associated with the VM, such + as settings files and disk image files, are moved to the new + location. The &product-name; configuration is updated + automatically. + + + + uuid|vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM to move. + + + + + + Specifies that the type of the move operation is basic. + + + + + + Specifies a full path name or relative path name of the new + location on the host file system. + + + + + + + Examples + + + The following command moves the ol7 VM to a + new location on the host system. + +$ VBoxManage movevm ol7 --folder "/home/testuser/vms" --type basic +0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% +Machine has been successfully moved into /home/testuser/vms + + diff --git a/doc/manual/en_US/man_VBoxManage-natnetwork.xml b/doc/manual/en_US/man_VBoxManage-natnetwork.xml new file mode 100644 index 00000000..11ab1d70 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-natnetwork.xml @@ -0,0 +1,360 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage natnetwork + + + + VBoxManage-natnetwork + 1 + + + + VBoxManage-natnetwork + create, modify, and manage a NAT network + Oracle VM VirtualBox + + + + + + VBoxManage natnetwork add + + --disable + --enable + + --netname=name + --network=network + --dhcp=on|off + --ipv6=on|off + --loopback-4=rule + --loopback-6=rule + --port-forward-4=rule + --port-forward-6=rule + + + + VBoxManage natnetwork list + filter-pattern + + + + VBoxManage natnetwork modify + --dhcp=on|off + + --disable + --enable + + --netname=name + --network=network + --ipv6=on|off + --loopback-4=rule + --loopback-6=rule + --port-forward-4=rule + --port-forward-6=rule + + + + VBoxManage natnetwork remove + --netname=name + + + + VBoxManage natnetwork start + --netname=name + + + + VBoxManage natnetwork stop + --netname=name + + + + + Description + + The VBoxManage natnetwork command enables you + to create, modify and manage a NAT network. + + + NAT networks use the Network Address Translation (NAT) service. + The service groups systems into a network and prevents external + systems from directly accessing the systems in the network. The + service also enables the systems in the network to communicate + with each other and with external systems by means of TCP and UDP + over IPv4 and IPv6. + + + A NAT service is attached to an internal network. For a VM to use + the NAT service, you must attach the VM to the internal network. + Specify the name of the internal network when you create the NAT + service. Note that the internal network is created if it does not + already exist. + + + Add a NAT Network Service + + + The VBoxManage natnetwork add command creates + a new internal network interface, and adds a NAT network + service. You must use this command before you can attach the VM + to the NAT network. + + + + + + Disables the NAT network service. + + + + + + Enables the NAT network service. + + + + + + Specifies the name of the new internal network interface + on the host OS. + + + + + + Specifies the static or DHCP network address and mask of + the NAT service interface. By default, this value + specifies the static network address. + + + + + + Enables or disables the DHCP server that you specify by + using the option. + + + + + + Enables or disables IPv6. By default, IPv6 is disabled and + IPv4 is enabled. + + + + + + Enables an IPv4 loopback interface by using the specified + rule. + + + + + + Enables an IPv6 loopback interface by using the specified + rule. + + + + + + Enables an IPv4 loopback interface by using the specified + rule. + + + + + + Enables IPv6 port forwarding by using the rule specified + by rule. + + + + + + Remove a NAT Network Service + + + The VBoxManage natnetwork remove command + removes the specified NAT network service. + + + + + + Specifies the name of the NAT network service to remove. + + + + + + Start a NAT Network Service + + + The VBoxManage natnetwork start command + starts a NAT network service and any associated DHCP server. + + + + + + Specifies the name of the NAT network service to start. + + + + + + Stop a NAT Network Service + + + The VBoxManage natnetwork stop command stops + a NAT network service and any associated DHCP server. + + + + + + Specifies the name of the NAT network service to stop. + + + + + + List All NAT Network Services + + + The VBoxManage natnetwork list command lists + all NAT network services. You can use a pattern to show a subset + of the NAT network services. + + + + filter-pattern + + Specifies an optional filtering pattern. + + + + + + Modify the Settings of a NAT Network Service + + + The VBoxManage natnetwork modify command + modifies the settings of an existing internal network interface. + + + + + + Disables the NAT network service. + + + + + + Enables the NAT network service. + + + + + + Specifies the name of the new internal network interface + on the host OS. + + + + + + Specifies the static or DHCP network address and mask of + the NAT service interface. By default, this value + specifies the static network address. + + + + + + Enables or disables the DHCP server that you specify by + using the option. + + + + + + Enables or disables IPv6. By default, IPv6 is disabled and + IPv4 is enabled. + + + + + + Enables an IPv4 loopback interface by using the specified + rule. + + + + + + Enables an IPv6 loopback interface by using the specified + rule. + + + + + + Enables an IPv4 loopback interface by using the specified + rule. + + + + + + Enables IPv6 port forwarding by using the rule specified + by rule. + + + + + + + + Examples + + + The following command shows how to create a NAT network for the + natnet1 internal network that uses the + 192.168.15.0/24 network address and mask of the + NAT service interface. In this static configuration, the gateway + is assigned the 192.168.15.1 IP address by + default. Note that this IP address is the next address after the + network address that you specify with the + option. + +$ VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable + + The following command shows how to add a DHCP server to the + natnet1 NAT network after creation: + +$ VBoxManage natnetwork modify --netname natnet1 --dhcp on + + diff --git a/doc/manual/en_US/man_VBoxManage-registervm.xml b/doc/manual/en_US/man_VBoxManage-registervm.xml new file mode 100644 index 00000000..5f5946c6 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-registervm.xml @@ -0,0 +1,92 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage registervm + + + + VBoxManage-registervm + 1 + + + + VBoxManage-registervm + register a virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage registervm + filename + + + + + Description + + The VBoxManage registervm command enables you + to create a virtual machine (VM) by importing an XML machine + configuration file into &product-name;. The VM cannot conflict + with a VM that is already registered in &product-name;. In + addition, the VM cannot have any hard disks or removable disks + attached. Ensure that the XML machine configuration file is in the + machines folder prior to registration. + + + + When you use the VBoxManage createvm command + to create a VM, you can specify the + option to register the VM. + + + + + filename + + Specifies the XML machine configuration file. This file has + the .vbox file extension. + + + + + + + Examples + + + The following command registers a VM called + vm2. The XML machine configuration file for the + VM is located in the default machines folder. + +$ VBoxManage registervm "/home/user/VirtualBox VMs/vm2/vm2.vbox" + + + + See Also + + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-setextradata.xml b/doc/manual/en_US/man_VBoxManage-setextradata.xml new file mode 100644 index 00000000..4cf52ff3 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-setextradata.xml @@ -0,0 +1,112 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage setextradata + + + + VBoxManage-setextradata + 1 + + + + VBoxManage-setextradata + set a keyword value that is associated with a virtual machine or + configuration + Oracle VM VirtualBox + + + + + + VBoxManage setextradata + + global + uuid + vmname + + keyword + value + + + + + Description + + The VBoxManage setextradata command enables you + to set a keyword value that is associated with a virtual machine + (VM) or with an &product-name; configuration. + + + + global + + Sets information about the configuration rather than a VM. + + + + uuid|vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the VM. + + + + keyword + + Specifies the keyword for which to set its value. + + + + value + + Specifies the keyword value. Specifying no value removes the + keyword. + + + + + + + Examples + + + The following command sets the installdate + keyword value for the Fedora5 VM to + 2019.01.01: + +$ VBoxManage setextradata Fedora5 installdate 2019.01.01 + + The following command unsets the value of the + installdate keyword for the + Fedora5 VM: + +$ VBoxManage setextradata Fedora5 installdate + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-setproperty.xml b/doc/manual/en_US/man_VBoxManage-setproperty.xml new file mode 100644 index 00000000..81cd3e62 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-setproperty.xml @@ -0,0 +1,208 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage setproperty + + + + VBoxManage-setproperty + 1 + + + + VBoxManage-setproperty + change global settings + Oracle VM VirtualBox + + + + + + VBoxManage setproperty + property-name + property-value + + + + + Description + + The VBoxManage setproperty command enables you + to change global settings that affect the entire &product-name; + installation. Some of these settings correspond to the settings in + the Preferences dialog in the + VirtualBox Manager. + + + The following properties are available: + + + + autostartdbpath + + Specifies the path to the autostart database. Valid values + are null, which disables the autostart + database, or the name of the folder that contains the + database. See . + + + + defaultfrontend + + Specifies the global default VM frontend. Valid values are + default, which specifies the default + frontend, or the name of the frontend to use. + + + + hwvirtexclusive + + Specifies whether &product-name; makes exclusive use of the + Intel VT-x or AMD-V hardware virtualization extensions of + the host system's processor. See . + + Valid values are as follows: + + + on enables &product-name; to make + exclusive use of these extensions. This is the default + value. + + + off shares these extensions with + other hypervisors that run simultaneously. Note that + disabling this setting has negative performance + implications. + + + + + logginglevel + + Specifies the VBoxSVC release logging details. See + . + + + + loghistorycount + + Specifies the number of rotated VM logs to retain. + + + + machinefolder + + Specifies the default folder in which virtual machine (VM) + definitions are stored. Valid values are + default, which specifies the default + storage folder, or the name of the folder to use. See + . + + + + proxymode + + Configures the mode for an HTTP proxy server. Valid values + are as follows: + + + manual + + Configure the URL of a HTTP proxy server manually, + using the proxyurl property value. + + + + noproxy + + Do not use an HTTP proxy server. A direct connection + to the Internet is used. + + + + system + + Detect the proxy settings automatically for the host + network. This is the default value. + + + + + + proxyurl + + Specifies the URL for an HTTP proxy server when you specify + a manual proxy by setting the proxymode + property to manual. + + + + vrdeauthlibrary + + Specifies which library to use when external authentication + has been configured for a particular VM. Valid values are + default, which specifies the default + library, or the name of the library to use. See + . + + + + vrdeextpack + + Specifies the library that implements the VirtualBox Remote + Desktop Extension (RDE). Valid values are + null, which disables the RDE, or the name + of the library to use. + + + + websrvauthlibrary + + Specifies which library the web service uses to authenticate + users. Valid values are default, which + specifies the default library, null, + which disables authentication, or the name of the library to + use. For information about the &product-name; web service, + see . + + + + + + + Examples + + + The following command configures &product-name; to use the + specified HTTP proxy server. + +$ VBoxManage setproperty proxymode manual +$ VBoxManage setproperty proxyurl "http://myproxy.com:8080" + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-sharedfolder.xml b/doc/manual/en_US/man_VBoxManage-sharedfolder.xml new file mode 100644 index 00000000..1ba24bed --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-sharedfolder.xml @@ -0,0 +1,201 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage sharedfolder + + + + VBoxManage-sharedfolder + 1 + + + + VBoxManage-sharedfolder + add and remove shared folders + Oracle VM VirtualBox + + + + + + VBoxManage sharedfolder add + + uuid + vmname + + --name=name + --hostpath=hostpath + --readonly + --transient + --automount + --auto-mount-point=path + + + + VBoxManage sharedfolder remove + + uuid + vmname + + --name=name + --transient + + + + + Description + + Shared folders enable you to share data between the host system + and guests. To use shared folders, you must first install the + &product-name; Guest Additions software on the guest OS. + + + The shared folder is associated with a share name and the full + path name of the folder or directory on the host system. The share + name is a unique name within the namespace of the host OS. + + + Add a Shared Folder + + + The VBoxManage sharedfolder add command + creates a shared folder. The folder you specify is on the host + computer. When configured, the contents of the folder on the + host system can be shared with the guest OS. + + + + uuid|vmname + + Specifies the name or UUID of the guest VM that shares a + folder with the host system. + + + + --name=name + + Specifies the name of the share, which is a unique name + within the namespace of the host OS. + + + + --hostpath=hostpath + + Specifies the absolute path of the folder or directory on + the host OS to share with the guest OS. + + + + --readonly + + Specifies that the share has only read-only access to + files at the host path. + + By default, shared folders have read-write access to the + files at the host path. However on Linux distributions, + shared folders are mounted with 770 file permissions with + the root user and the + vboxsf group. By using this option, the + file permissions become 700. + + + + --transient + + Specifies that the share is transient, which means that it + can be added and removed at runtime and does not persist + after the VM stops. + + + + --automount + + Specifies that the share is automatically mounted. + + + + --auto-mount-point=path + + Specifies the mount point of the share. This guest OS specific. + + For Windows and OS/2 guest this must be an unused drive letter. + If left blank (or if the drive letter is already in use), the + last unused drive letter is used instead (i.e. searching from + Z: thru A:). + + For Linux, Solaris and other unix guest, it must be an absolute + path like /mnt/mysharedfolder. If left + empty the default location is + /media/sf_sharename. + + + + + + Remove a Shared Folder + + + The VBoxManage sharedfolder remove command + removes a shared folder. + + + + uuid|vmname + + Specifies the name or UUID of the guest VM that shares a + folder with the host system. + + + + --name=name + + Specifies the name of the share to remove. + + + + --transient + + Specifies that the share is transient, which means that it + can be added and removed at runtime and does not persist + after the VM stops. + + + + + + + + Examples + + + The following command creates a shared folder called + o7share for the ol7 VM. + The share is mounted automatically when the VM is started. + +$ VBoxManage sharedfolder add ol7 --name ol7share --hostpath "/home/user/ol7share" --automount + + The following command removes the shared folder called + o7share for the ol7 VM. + +$ VBoxManage sharedfolder remove ol7 --name ol7share + + diff --git a/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml b/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml new file mode 100644 index 00000000..eb9893c1 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-showmediuminfo.xml @@ -0,0 +1,131 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage showmediuminfo + + + + VBoxManage-showmediuminfo + 1 + + + + VBoxManage-showmediuminfo + show information about a medium + Oracle VM VirtualBox + + + + + + VBoxManage showmediuminfo + + disk + dvd + floppy + + + uuid + filename + + + + + + Description + + The VBoxManage showmediuminfo command shows the + following information about a medium: + + + + Size + + + Size on disk + + + Type + + + In use by virtual machines (VMs) + + + + The medium must be specified either by its UUID, if the medium is + registered, or by its filename. Registered images can be listed + using VBoxManage list hdds, VBoxManage + list dvds, or VBoxManage list + floppies, as appropriate. + + + For backward compatibility, you can also use the + showvdiinfo command to obtain information about + the medium. + + + + disk | dvd | floppy + + Specifies the type of medium. Valid values are + disk (hard drive), + dvd, or floppy. + + + + uuid | filename + + Specifies the Universally Unique Identifier (UUID) or + absolute path name of the medium or image. + + If the medium is registered, you can specify the UUID. You + can also list registered images by using the + VBoxManage list hdds, VBoxManage + list dvds, or VBoxManage list + floppies command. + + + + + + + Examples + + + The following command shows information about the + disk01.vdi disk image: + +$ VBoxManage showmediuminfo disk01.vdi + + The following command shows information about the + floppy01.img floppy disk image. + +$ VBoxManage showmediuminfo floppy floppy01.img + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-showvminfo.xml b/doc/manual/en_US/man_VBoxManage-showvminfo.xml new file mode 100644 index 00000000..e435109c --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-showvminfo.xml @@ -0,0 +1,177 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage showvminfo + + + + VBoxManage-showvminfo + 1 + + + + VBoxManage-showvminfo + show configuration information or log file contents for a virtual + machine + Oracle VM VirtualBox + + + + + + VBoxManage showvminfo + + uuid + vmname + + --details + --machinereadable + + + + VBoxManage showvminfo + + uuid + vmname + + --log=index + + + + + Description + + The VBoxManage showvminfo command outputs + configuration information or log file contents for a specified + virtual machine (VM). + + + Viewing Virtual Machine Information + + + The VBoxManage showvminfo command outputs + information about the specified VM in a detailed format or in a + machine-readable format. + + + The VBoxManage showvminfo command shows the + same information as the VBoxManage list vms + --long command for the specified VM. + + + + + + Includes detailed information about the VM. + + + + + + Specifies that the VM information be in a machine-readable + format. + + + + + + Viewing Virtual Machine Log Contents + + + The VBoxManage showvminfo --log command + outputs the contents of one of the specified VM's log files. + + + + + + Specifies a numerical index that identifies the log file. + + The index value starts at 0, which + indicates the VBox.log file. An index + value of 1 indicates the + VBoxHardening.log file. Index values + starting at 2 indicate other log files, + such as the VBox.log.1 file. + + + + + + + + Examples + + + The following example shows typical output for this command: + +$ VBoxManage showvminfo "Windows 10" +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2019 Oracle Corporation +All rights reserved. + +Name: Windows 10 +Groups: / +Guest OS: Windows 10 (64-bit) +UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7 +Config file: /home/username/VirtualBox VMs/Windows 10/Windows 10.vbox +Snapshot folder: /home/username/VirtualBox VMs/Windows 10/Snapshots +Log folder: /home/username/VirtualBox VMs/Windows 10/Logs +Hardware UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7 +Memory size: 2048MB +Page Fusion: off +VRAM size: 12MB +CPU exec cap: 100% +... + + The following example shows the information output in a + machine-readable format, which shows the entries as a + property=value + string: + +$ VBoxManage showvminfo "Windows 10" --machinereadable +... +groups="/" +ostype="Windows 10 (64-bit)" +UUID="1bf3464d-57c6-4d49-92a9-a5cc3816b7e7" +... + + The following example shows the contents of the + VBox.log log file: + +$ VBoxManage showvminfo "Windows 10" --log 0 +00:00:02.895106 VirtualBox VM 6.0.0_RC1 r127378 linux.amd64 (Dec 10 2018 17:16:06) release log +00:00:02.895109 Log opened 2018-12-14T14:31:44.088259000Z +00:00:02.895111 Build Type: release +00:00:02.895115 OS Product: Linux +00:00:02.895117 OS Release: 4.1.12-61.1.22.el7uek.x86_64 +00:00:02.895119 OS Version: #2 SMP Fri Dec 2 09:28:44 PST 2016 +... + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-snapshot.xml b/doc/manual/en_US/man_VBoxManage-snapshot.xml new file mode 100644 index 00000000..add4d862 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-snapshot.xml @@ -0,0 +1,392 @@ + + + +%all.entities; +]> + + + March 2019 + VBoxManage snapshot + + + + VBoxManage-snapshot + 1 + + + + VBoxManage-snapshot + manage &product-name; virtual machine snapshots + Oracle VM VirtualBox + + + + + + VBoxManage snapshot + uuid|vmname + + + + VBoxManage snapshot + uuid|vmname + + take + + snapshot-name + + --description=description + + --live + + --uniquename Number,Timestamp,Space,Force + + + + VBoxManage snapshot + uuid|vmname + + delete + + snapshot-name + + + + VBoxManage snapshot + uuid|vmname + + restore + + snapshot-name + + + + VBoxManage snapshot + uuid|vmname + + restorecurrent + + + + VBoxManage snapshot + uuid|vmname + + edit + + + snapshot-name + --current + + + --description=description + + --name=new-name + + + + VBoxManage snapshot + uuid|vmname + + list + + --details--machinereadable + + + + VBoxManage snapshot + uuid|vmname + + showvminfo + + snapshot-name + + + + + Description + + The VBoxManage snapshot command manages + snapshots. + + + &product-name; uses the snapshot to capture the state of a virtual + machine (VM). You can later use the snapshot to revert to the + state described by the snapshot. + + + A snapshot is a complete copy of a VM's settings. If you take the + snapshot while the VM is running, the snapshot also includes the + VM's state file. + + + After you take a snapshot, &product-name; creates a + differencing hard disk for each normal hard + disk that is associated with the host machine. When you restore a + snapshot, &product-name; uses these differencing files to quickly + reset the contents of the VM's virtual hard disks. + + + For each VBoxManage snapshot command, you must + specify the name or the universal unique identifier (UUID) of the + VM for which you want to take a snapshot. + + + General Command Operand + + + uuid|vmname + + Specifies the UUID or name of the VM. + + + + + + Take a Snapshot of a Virtual Machine + + + The VBoxManage snapshot take command takes a + snapshot of the current state of the VM. You must supply a name + for the snapshot and can optionally supply a description. The + new snapshot is inserted into the snapshots tree as a child of + the current snapshot and then becomes the new current snapshot. + + + + + + Specifies a description of the snapshot. + + + + + + Specifies that the VM is not stopped while you create the + snapshot. This operation is know as live snapshotting. + + + + + + TBD. + + What does this option do and how is it used? + + + + snapshot-name + + Specifies the name of the snapshot to create. + + + + + + Delete a Snapshot + + + The VBoxManage snapshot delete command + removes the specified snapshot. + + + The delete operation may take some time to finish. This is + because the differencing images that are associated with the + snapshot may need to be merged with their child differencing + images. + + + + snapshot-name + + Specifies the UUID or name of the snapshot. + + + + + + Restore a Snapshot + + + The VBoxManage snapshot restore command + restores the specified snapshot. This operation resets the VM's + settings and current state to that of the snapshot. The state of + the VM on which you restore a snapshot is lost. When restored, + the specified snapshot becomes the new current snapshot and + subsequent snapshots are children of that snapshot. + + + + snapshot-name + + Specifies the UUID or name of the snapshot. + + + + + + Restore the Current Snapshot + + + The VBoxManage snapshot restorecurrent + command restores the current snapshot. The current snapshot is + the one from which the current state is derived. This command is + equivalent to using the VBoxManage snapshot + restore command and specifying the name or UUID of the + current snapshot. + + + + Change the Name or Description of an Existing Snapshot + + + The VBoxManage snapshot edit command enables + you to change the name or the description of a specified + snapshot. + + + + snapshot-name + + Specifies the UUID or name of the snapshot to edit. + + This option is mutually exclusive with the + option. + + + + + + Specifies that you update the current version of the + snapshot. + + This option is mutually exclusive with a specific snapshot + name or its UUID. + + + + + + Specifies a new description for the snapshot. + + + + + + Specifies a new name for the snapshot. + + + + + + List the Snapshots + + + The VBoxManage snapshot list command lists + all the snapshots for a VM. + + + + + + Specifies that the output shows detailed information about + the snapshot. + + This option is mutually exclusive with the + option. + + + + + + Specifies that the output is shown in a machine-readable + format. + + This option is mutually exclusive with the + option. + + + + + + Show Information About a Snapshot's Settings + + + The VBoxManage snapshot showvminfo command + enables you to view the VM settings that are part of an existing + snapshot. + + + + snapshot-name + + Specifies the UUID or name of the snapshot. + + + + + + + + Examples + + + The following command creates a snapshot of the + ol7u4 VM. The snapshot is called + ol7u4-snap-001. The command uses + the option to provide a description + of the snapshot contents. + + +$ VBoxManage snapshot ol7u4 take ol7u4-snap-001 \ +--description="Oracle Linux 7.4" + + + The following command lists the snapshots for the + ol7u4 VM. + + +$ VBoxManage snapshot ol7u4 list + + + The following command changes the description for the + ol7u4-snap-001 snapshot of the + ol7u4 VM. + + +$ VBoxManage snapshot ol7u4 edit ol7u4-snap-001 \ +--description="Oracle Linux 7.4 with UEK4 kernel" + + + The following command shows VM settings for the + ol7u1-snap-001 snapshot of the + ol7u4 VM. + + +$ VBoxManage snapshot ol7u4 showvminfo ol7u4-snap-001 +Name: ol7u4 +Groups: / +Guest OS: Oracle (64-bit) +UUID: 43349d78-2ab3-4cb8-978f-0e755cd98090 +Config file: C:\Users\user1\VirtualBox VMs\ol7u4\ol7u4.vbox +... +Snapshots: + + Name: ol7u4-snap-001 (UUID: 1cffc37d-5c37-4b86-b9c5-a0f157a55f43) + Description: Oracle Linux 7.4 with UEK4 kernel + + + diff --git a/doc/manual/en_US/man_VBoxManage-startvm.xml b/doc/manual/en_US/man_VBoxManage-startvm.xml new file mode 100644 index 00000000..b3725e30 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-startvm.xml @@ -0,0 +1,162 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage startvm + + + + VBoxManage-startvm + 1 + + + + VBoxManage-startvm + start a virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage startvm + + uuid + vmname + + --putenv=name[=value] + --type= + gui + headless + sdl + separate + + + + + + Description + + The VBoxManage startvm command starts an + &product-name; virtual machine (VM) that is in the Powered Off or + Saved state. + + + + uuid | vmname + + Specifies the name or Universally Unique Identifier (UUID) + of the VM. + + + + + + Assigns a value to an environment variable as a name-value + pair. For example, VBOX_DISABLE_HOST_DISK_CACHE=1. + + The short form of this option is . + + + + + + Specifies the frontend used to start the VM. + + You can use the VBoxManage setproperty + command to set a global default value for the frontend. + Alternatively, you can use the VBoxManage + modifyvm command to specify a default frontend + value for a specific VM. If neither a global or per-VM + default value is set and you do not specify the + option, then the VM opens in a + window on the host desktop. + + The option accepts the following + values: + + + gui + + Starts a VM in a graphical user interface (GUI) + window. This is the default. + + + + headless + + Starts a VM for remote display only. + + + + sdl + + Starts a VM using the VBoxSDL frontend. + + + + separate + + Starts a VM with a detachable user interface (UI), + which means that the VM runs headless with the UI in a + separate process. + + This is an experimental feature that lacks certain + functionality, such as 3D acceleration. + + + + + + + + If a VM fails to start with a particular frontend and the error + information is inconclusive, consider starting the VM directly + by running the frontend. This workaround might provide + additional error information. + + + + + + Examples + + + The following command starts the ol7u6 VM: + +$ VBoxManage startvm ol7u6 + + The following command starts the + ol7u6-mininstall VM in headless mode. + +$ VBoxManage startvm ol7u6-mininstall --type headless + + + + See Also + + + , + , + . + + + diff --git a/doc/manual/en_US/man_VBoxManage-storageattach.xml b/doc/manual/en_US/man_VBoxManage-storageattach.xml new file mode 100644 index 00000000..4edd541b --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-storageattach.xml @@ -0,0 +1,538 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage storageattach + + + + VBoxManage-storageattach + 1 + + + + VBoxManage-storageattach + attach, remove, and modify storage media used by a virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage storageattach + + uuid + vmname + + --storagectl=name + --bandwidthgroup= + name + none + + --comment=text + --device=number + --discard= + on + off + + --encodedlun=lun + --forceunmount + --hotpluggable= + on + off + + --initiator=initiator + --intnet + --lun=lun + --medium= + none + emptydrive + additions + uuid + filename + host:drive + iscsi + + --mtype= + normal + writethrough + immutable + shareable + readonly + multiattach + + --nonrotational= + on + off + + --passthrough= + on + off + + --passwordfile=file + --password=password + --port=number + --server= + name + ip + + --setparentuuid=uuid + --setuuid=uuid + --target=target + --tempeject= + on + off + + --tport=port + --type= + dvddrive + fdd + hdd + + --username=username + + + + + Description + + The VBoxManage storageattach command enables + you to manage a storage medium that you connected to a storage + controller by using the VBoxManage storagectl + command. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or the + name of the virtual machine (VM). + + + + + + Specifies the name of the storage controller. Use the + VBoxManage showvminfo command to list the + storage controllers that are attached to the VM. + + + + + + Specifies the port number of the storage controller to + modify. You must specify this option unless the storage + controller has only a single port. + + + + + + Specifies the port's device number to modify. You must + specify this option unless the storage controller has only + one device per port. + + + + + + Specifies the drive type to which the medium is associated. + Only omit this option if the medium type can be determined + by using the option or by + information provided by an earlier medium attachment + command. + + + + + + Specifies one of the following values: + + + none + + Removes any existing device from the specified slot. + + + + emptydrive + + For a virtual DVD or floppy drive only. + + Makes the device slot behave like a removeable drive + into which no media has been inserted. + + + + additions + + For a virtual DVD drive only. + + Attaches the VirtualBox Guest Additions image to the + specified device slot. + + + + uuid + + Specifies the UUID of a storage medium to attach to + the specified device slot. The storage medium must + already be known to &product-name;, such as a storage + medium that is attached to another VM. Use the + VBoxManage list command to list + media. + + + + filename + + Specifies the full path of an existing disk image to + attach to the specified device slot. The disk image + can be in ISO, RAW, VDI, VMDK, or other format. + + + + host:drive + + For a virtual DVD or floppy drive only. + + Connects the specified device slot to the specified + DVD or floppy drive on the host computer. + + + + iscsi + + For virtual hard disks only. + + Specifies an iSCSI target for which you must specify + additional information. See + . + + + + For removeable media such as floppies and DVDs, you can make + configuration changes while a VM is running. Changes to + devices or hard disk device slots require that the VM be + powered off. + + + + + + Specifies how this medium behaves with respect to snapshots + and write operations. See . + + + + + + Specifies an optional description to store with the medium. + + + + + + Modifies the UUID of a medium before attaching it to a VM. + + This is an expert option. Inappropriate values might make + the medium unusable or lead to broken VM configurations if + another VM already refers to the same medium. + + Using the option + assigns a new random UUID to an image, which can resolve + duplicate UUID errors if you used a file copy utility to + duplicate an image. + + + + + + Modifies the parent UUID of a medium before attaching it to + a VM. + + This is an expert option. Inappropriate values might make + the medium unusable or lead to broken VM configurations if + another VM already refers to the same medium. + + + + + + For a virtual DVD drive only. + + Enables writing to a DVD. This feature is experimental, see + . + + + + + + For a virtual DVD drive only. + + Specifies whether to permit a temporary guest-triggered + medium eject operation. When set to on, + you can eject a medium. The ability for a guest-triggered + eject operation does not persist if the VM is powered off + and restarted. So, when you set this option to + on and the VM is restarted, the + originally configured medium is still in the drive. + + + + + + Enables you to specify that the virtual hard disk is + non-rotational. Some guest OSes, such as Windows 7 or later, + treat such disks as solid state drives (SSDs) and do not + perform disk fragmentation on them. + + + + + + Specifies whether to enable the auto-discard feature for a + virtual hard disk. When set to on, a VDI + image is shrunk in response to a trim + command from the guest OS. + + The virtual hard disk must meet the following requirements: + + + The disk format must be VDI. + + + The size of the cleared area of the disk must be at + least 1 MB. + + + Ensure that the space being trimmed is at least a 1 MB + contiguous block at a 1 MB boundary. + + + Consider running defragmentation commands as background cron + jobs to save space. On Windows, run the defrag.exe + /D command. On Linux, run the btrfs + filesystem defrag command. + + + When you configure the guest OS to issue the + trim command, the guest OS typically + sees the disk as an SSD. + + + Ext4 supports the mount + option. Mac OS X might require additional settings. + Windows 7, 8, and 10 automatically detect and support + SSDs. The Linux exFAT driver from + Samsung supports the trim command. + + + The Microsoft implementation of exFAT might not support this + feature. + + You can use other methods to issue trim commands. The Linux + fstrim command is part of the + util-linux package. Earlier solutions + required you to zero out unused areas by using the + zerofree or a similar command, and then + to compact the disk. You can only perform these steps when + the VM is offline. + + + + + + Specifies the bandwidth group to use for the device. See + . + + + + + + For a virtual DVD or floppy drive only. + + Forcibly unmounts the DVD, CD, or floppy or mounts a new + DVD, CD, or floppy even if the previous removable storage is + locked by the guest for reading. See + . + + + + + The following options are applicable when you specify the + option: + + + + + + Specifies the host name or IP address of the iSCSI target. + + + + + + Specifies the target name string, which is determined by the + iSCSI target and is used to identify the storage resource. + + + + + + Specifies the TCP/IP port number of the iSCSI service on the + target. + + + + + + Specifies the logical unit number (LUN) of the target + resource. For a single disk drive, the value is zero. + + + + + + Specifies the hexadecimal-encoded of the target resource. + For a single disk drive, the value is zero. + + + + + + Specifies the user name to use for target authentication. + + + Unless you provide a settings password, the user name is + stored as clear text in the XML machine configuration + file. + + + + + + + Specifies the password used for target authentication. + + + Unless you provide a settings password, this password is + stored as clear text in the XML machine configuration + file. When you specify a settings password for the first + time, the target authentication password is stored in + encrypted form. + + + This design does not conform to Oracle's security + guidelines. You should not be able to specify a password on + the command line because the password can be seen in a + process listing. + + + + + + Specifies a file that contains the target authentication + password as clear text. + + + Use permission and ownership settings to ensure that the + contents of this file cannot be read by unauthorized + users. + + + + + + + Specifies the iSCSI initiator. + + The Microsoft iSCSI Initiator is a system, such as a server, + that attaches to an IP network and initiates requests and + receives responses from an iSCSI target. The SAN components + in the iSCSI initiator are largely analogous to Fibre + Channel SAN components, and they include the following: + + + iSCSI driver. + Transports blocks of iSCSI commands over the IP network. + This iSCSI driver is installed on the iSCSI host and is + included with the Microsoft iSCSI Initiator. + + + Gigabit Ethernet + adapter. Connects to an iSCSI target. Use an + Ethernet adapter that can transmit 1000 megabits per + second (Mbps). Like standard 10/100 adapters, most + gigabit adapters use a preexisting Category 5 or + Category 6E cable. Each port on the adapter is + identified by a unique IP address. + + + iSCSI target. Is any + device that receives iSCSI commands. The device can be + an end node such as a storage device, or it can be an + intermediate device such as a network bridge between IP + and Fibre Channel devices. Each port on the storage + array controller or network bridge is identified by one + or more IP addresses. + + + + + + + Specifies whether to connect to the iSCSI target that uses + internal networking. This configuration requires further + configuration. See . + + + + + + + Examples + + + The following command attaches the o7.vdi + disk image to the specified SATA storage controller on the + ol7 VM. + +$ storageattach ol7 --storagectl "SATA Controller" --port 0 --device 0 \ +--type hdd --medium /VirtualBox/ol7/ol7.vdi + + The following command attaches the + o7-r6-dvd.iso DVD image to the specified IDE + storage controller on the ol7 VM. + +$ VBoxManage storageattach ol7 --storagectl "IDE Controller" --port 0 --device 0 \ +--type dvddrive --medium ol7-r6-dvd.iso + + + + See Also + + , + , + + + + diff --git a/doc/manual/en_US/man_VBoxManage-storagectl.xml b/doc/manual/en_US/man_VBoxManage-storagectl.xml new file mode 100644 index 00000000..17122861 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-storagectl.xml @@ -0,0 +1,194 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage storagectl + + + + VBoxManage-storagectl + 1 + + + + VBoxManage-storagectl + manage a storage controller + Oracle VM VirtualBox + + + + + + VBoxManage storagectl + + uuid + vmname + + --name=controller-name + --add= + floppy + ide + pcie + sas + sata + scsi + usb + + --controller= + BusLogic + I82078 + ICH6 + IntelAhci + LSILogic + LSILogicSAS + NVMe + PIIX3 + PIIX4 + USB + VirtIO + + --bootable= + on + off + + --hostiocache= + on + off + + --portcount=count + --remove + --rename=new-controller-name + + + + + Description + + The VBoxManage storagectl command enables you + to attach, modify, and remove a storage controller. After you + configure the storage controller, you can use the + VBoxManage storageattach command to attach + virtual media to the controller. + + + + uuid | vmname + + Specifies the Universally Unique Identifier (UUID) or name + of the virtual machine (VM). + + + + + + Specifies the name of the storage controller. + + + + + + Specifies the type of the system bus to which to connect the + storage controller. Valid values are + floppy, ide, + pcie, sas, + sata, scsi, and + usb. + + + + + + Specifies the chipset type to emulate for the specified + storage controller. Valid values are + BusLogic, I82078, + ICH6, IntelAHCI, + LSILogic, LSILogicSAS, + NVMe, PIIX3, + PIIX4, and USB. + + The default value varies, according to the type of storage + controller. + + + + + + Specifies the number of ports that the storage controller + supports. Valid values depend on the type of storage + controller. + + + + + + Specifies whether to use the host I/O cache for all disk + images attached to this storage controller. Valid values are + on and off. See + . + + + + + + Specifies whether this controller is bootable. Valid values + are on and off. + + + + + + Specifies a new name for the storage controller. + + + + + + Removes a storage controller from the VM configuration. + + + + + + + Examples + + + The following command creates a SATA storage controller called + sata01 and adds it to the + ol7 VM. The storage controller emulates the + IntelAHCI chipset. + +$ VBoxManage storagectl ol7 --name "sata01" --add sata --controller IntelAHCI + + The following command creates an IDE storage controller called + ide01 and adds it to the ol7 + VM. + +$ VBoxManage storagectl ol7 --name "ide01" --add ide + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-unattended.xml b/doc/manual/en_US/man_VBoxManage-unattended.xml new file mode 100644 index 00000000..dec03d8f --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-unattended.xml @@ -0,0 +1,242 @@ + + + + + + + $Date: 2020-02-04 11:54:12 +0100 (Tue, 04 Feb 2020) $ + VBoxManage unattended + + + + VBoxManage-unattended + 1 + + + + VBoxManage-unattended + unattended guest OS installation + Oracle VM VirtualBox + + + + + VBoxManage unattended detect + --iso=install-iso + --machine-readable + + + VBoxManage unattended install + uuid|vmname + --iso=install-iso + --user=login + --password=password + --password-file=file + --full-user-name=name + --key=product-key + --install-additions + --no-install-additions + --additions-iso=add-iso + --install-txs + --no-install-txs + --validation-kit-iso=testing-iso + --locale=ll_CC + --country=CC + --time-zone=tz + --hostname=fqdn + --package-selection-adjustment=keyword + --dry-run + --auxiliary-base-path=path + --image-index=number + --script-template=file + --post-install-template=file + --post-install-command=command + --extra-install-kernel-parameters=params + --language=lang + --start-vm=session-type + + + + + Description + + + unattended detect + + + Detects the guest operating system (OS) on the specified installation ISO + and displays the result. This can be used as input when creating a VM for + the ISO to be installed in. + + + + + The installation ISO to run the detection on. + + + + Produce output that is simpler to parse from a script. + + + + + + unattended install + + + Reconfigures the specified VM for installation and optionally starts it up. + + + + uuid|vmname + Either the UUID or the name (case sensitive) of a VM. + + + + The installation ISO to run the detection on. + + + + The login name. (default: vboxuser) + + + + + The login password. This is used for the user given by as well as the + root/administrator user. (default: changeme) + + + + + Alternative to for providing the password. Special filename + stdin can be used to read the password from standard input. + + + + The full user name. (default: --user) + + + + The guest OS product key. Not all guest OSes requires this. + + + , + Whether to install the VirtualBox guest additions. (default: --no-install-addations) + + + + + Path to the VirtualBox guest additions ISO. (default: installed/downloaded GAs) + + + , + + Whether to install the test execution service (TXS) from the VirtualBox ValidationKit. + This is useful when preparing VMs for testing or similar. (default: --no-install-txs) + + + + + Path to the VirtualBox ValidationKit ISO. This is required if + is specified. + + + + + The base locale specification for the guest, like en_US, de_CH, or nn_NO. (default: host or en_US) + + + + The two letter country code if it differs from the specified by . + + + + The time zone to set up the guest OS with. (default: host time zone or UTC) + + + + + The fully qualified domain name of the guest machine. + (default: vmname.myguest.virtualbox.org) + + + + + Adjustments to the guest OS packages/components selection. This can be specfied more than once. Currently + the only recognized keyword is minimal which triggers a minimal installation for + some of the guest OSes. + + + + Do not create any files or make any changes to the VM configuration. + + + + + Start the VM using the front end given by session-type. This is the same as + the option for the startvm command, but we have add + none for indicating that the VM should not be started. + (default: none) + + + + Advanced options: + + + + + The path prefix to the media related files generated for the installation. + (default: vm-config-dir/Unattended-vm-uuid-) + + + + Windows installation image index. (default: 1) + + + + The unattended installation script template. (default: IMachine::OSTypeId dependent) + + + + The post installation script template. (default: IMachine::OSTypeId dependent) + + + + + A single command to run after the installation is completed. The exact format and exactly + when this is run is guest OS installer dependent. + + + + + + List of extra linux kernel parameters to use during the installation. (default: IMachine::OSTypeId dependent) + + + + + + + Specifies the UI language for a Windows installation. The lang is + generally on the form {ll}-{CC}. See detectedOSLanguages results from VBoxManage unattended detect. + (default: detectedOSLanguages[0]) + + + + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-unregistervm.xml b/doc/manual/en_US/man_VBoxManage-unregistervm.xml new file mode 100644 index 00000000..8744e26e --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-unregistervm.xml @@ -0,0 +1,112 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage unregistervm + + + + VBoxManage-unregistervm + 1 + + + + VBoxManage-unregistervm + unregister a virtual machine + Oracle VM VirtualBox + + + + + + VBoxManage unregistervm + + uuid + vmname + + --delete + + + + + Description + + The VBoxManage unregistervm command unregisters + a virtual machine (VM). + + + + uuid|vmname + + Specifies the name or Universally Unique Identifier (UUID) + of the VM. + + + + + + Deletes the following files related to the VM automatically: + + + All hard disk image files, including differencing files. + + + All saved state files that the machine created, + including one for each snapshot. + + + XML VM machine definition file and its backups. + + + VM log files. + + + The empty directory associated with the unregistered VM. + + + + + + + + Examples + + + The following command unregisters a VM called + vm2. + +$ VBoxManage unregistervm vm2 + + The following command unregisters a VM called + vm3. All files associated with the VM are + deleted. + +$ VBoxManage unregistervm vm3 --delete +%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100% + + + + See Also + + + + + diff --git a/doc/manual/en_US/man_VBoxManage-usbdevsource.xml b/doc/manual/en_US/man_VBoxManage-usbdevsource.xml new file mode 100644 index 00000000..95a74ce1 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-usbdevsource.xml @@ -0,0 +1,118 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage usbdevsource + + + + VBoxManage-usbdevsource + 1 + + + + vboxmanage-usbdevsource + add and remove USB device sources + Oracle VM VirtualBox + + + + + VBoxManage usbdevsource add + source-name + --backend=backend + --address=address + + + + VBoxManage usbdevsource remove + source-name + + + + + Description + + The VBoxManage usbdevsource command adds a USB + device source and makes it available to the guests on the host + system. You can also use this command to remove the USB device + source. + + + Add a USB Device Source + + + The VBoxManage usbdevsource add command adds + a USB device source, which is available to all guests on the + host system. + + + + source-name + + Specifies a unique name for the USB device source. + + + + --address=address + + Specifies the address of the USB backend. + + + + --backend=backend + + Specifies the USB proxy service backend to use. + + What is the USB proxy service? How do you + determine the backend to use? + + + + + + Remove a USB Device + + + The VBoxManage usbdevsource remove command + removes a USB device. + + + + source-name + + Specifies the name of the USB device source to remove. + + + + + + + + Examples + + + The following command adds a USB device server called + hostusb01. + +$ VBoxManage usbdevsource add hostusb01 --backend USBIP --address 10.0.1.16 + + diff --git a/doc/manual/en_US/man_VBoxManage-usbfilter.xml b/doc/manual/en_US/man_VBoxManage-usbfilter.xml new file mode 100644 index 00000000..671a38d7 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-usbfilter.xml @@ -0,0 +1,304 @@ + + + +%all.entities; +]> + + + September 2019 + VBoxManage usbfilter + + + + VBoxManage-usbfilter + 1 + + + + VBoxManage-usbfilter + manage USB filters + Oracle VM VirtualBox + + + + + + VBoxManage usbfilter add + index,0-N + --target= + uuid + vmname + global + + --name=string + --action=ignore | hold + --active=yes | no + --vendorid=XXXX + --productid=XXXX + --revision=IIFF + --manufacturer=string + --product=string + --remote=yes | no + --serialnumber=string + --maskedinterfaces=XXXXXXXX + + + + VBoxManage usbfilter modify + index,0-N + --target= + uuid + vmname + global + + --name=string + --action=ignore | hold + --active=yes | no + --vendorid=XXXX | “” + --productid=XXXX | “” + --revision=IIFF | “” + --manufacturer=string | “” + --product=string | “” + --remote=yes | no + --serialnumber=string | “” + --maskedinterfaces=XXXXXXXX + + + + VBoxManage usbfilter remove + index,0-N + --target= + uuid + vmname + global + + + + + + Description + + The VBoxManage usbfilter command enables you to + manage USB filters for a specific virtual machine (VM), or global + USB filters that affect the entire &product-name; configuration. + + + Global filters are applied before VM-specific filters. This means + that you can use a global filter to prevent devices from being + captured by any VM. + + + Global filters are applied in a particular order. Only the first + filter that fits a device is applied. For example, the first + global filter makes a specific Kingston memory stick device + available while the second filter ignores all Kingston devices. + The result of applying these filters is that the specific Kingston + memory stick is made available to any machine that has the + appropriate filter, but no other Kingston devices are made + available. + + + Common Operand and Options + + + index,0-N + + Specifies a single integer that indicates the position of + the filter in the list. Zero (0) + represents the first position in the list. If a filter + already exists at the specified position, the existing + filter and any existing filters that follow are moved down + the list. Otherwise, the new filter is appended to the + list. + + + + + + Specifies whether to permit VMs access to devices that fit + the filter description (hold) or to + deny them access (ignore). This option + applies only to global filters. + + + + + + Specifies whether the USB filter is active or temporarily + disabled. Valid values are yes, which + activates the filter, and no, which + disables the filter. The default value is + yes. + + + + + + Specifies a manufacturer ID filter as a string. The + default value is null (“”). + + + + + + Specifies a masked interface filter that is used to hide + one or more USB interfaces from the guest. The value is a + bit mask where the set bits correspond to the USB + interfaces to hide, or mask off. This feature is supported + on Linux host systems only. + + + + + + Specifies the name of the filter. + + + + + + Specifies a product ID filter as a string. The default + value is null (“”). + + + + + + Specifies a product ID filter. The string representation + for an exact match has the form + XXXX, where + X is a hexadecimal digit + including leading zeroes. The default value is null + (“”). + + + + + + Specifies a remote filter that indicates whether the + device is physically connected to a remote VRDE client or + to a local host system. This option applies to VM filters + only. The default value is null + (“”). + + Why is the default value null when valid values are + yes or no? + + + + + + Specifies a revision ID filter. The string representation + for an exact match has the form + IIFF. + I is a decimal digit of the + integer part of the revision. F + is a decimal digit of its fractional part that includes + leading and trailing zeros. The default value is null + (“”). + + To specify a range of revision IDs, ensure that you use + the hexadecimal form so that the revision is stored as a + 16-bit packed BCD value. For example, the + int:0x0100-0x0199 expression matches + any revision from 1.0 to 1.99, inclusive. + + + + + + Specifies a serial number filter as a string. The default + value is null (“”). + + + + + + Specifies the VM that the filter is attached to. You can + specify the Universally Unique Identifier (UUID) or the + name of the VM. To apply the filter description to all + VMs, specify global. + + + + + + Specifies a vendor ID filter, which is a string + representation of a four-digit hexadecimal number. + X is the hexadecimal digit + including leading zeroes. The default value is null + (“”). + + + + + + Add a USB Filter or a Global Filter + + + Use the VBoxManage usbfilter add command to + create a new USB filter. + + + In addition, specify parameters by which to filter. You can use + the VBoxManage list usbhost command to view + the parameters for devices that are attached to your system. + + + + Modify a USB Filter or a Global Filter + + + Use the VBoxManage usbfilter modify command + to modify a USB filter. You can use the VBoxManage list + usbfilters command to list global filter indexes and + the VBoxManage showvminfo command to list + indexes for a specific machine. + + + + Remove a USB Filter or a Global Filter + + + Use the VBoxManage usbfilter remove command + to remove a USB filter entry. + + + + + + Examples + + + The following command lists the available USB devices on the host + system. + +$ VBoxManage list usbhost + + The following command adds a USB filter called + filter01 to the ol7 VM. + The filter specifies a Kingston DataTraveler memory stick and is + placed first in the list of USB filters for the VM. + +$ VBoxManage usbfilter add 0 --target ol7 --name filter01 --vendorid 0x0930 --productid 0x6545 + + The following command removes the USB filter that is second in the + list for the ol7 VM. + +$ VBoxManage usbfilter remove 1 --target ol7 + + diff --git a/doc/manual/en_US/man_VBoxManage.xml b/doc/manual/en_US/man_VBoxManage.xml new file mode 100644 index 00000000..818daf40 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage.xml @@ -0,0 +1,262 @@ + + + +%all.entities; +]> + + + August 2019 + VBoxManage + + + + VBoxManage + 1 + + + + VBoxManage + &product-name; command-line interface + Oracle VM VirtualBox + + + + + + VBoxManage + --nologo + --settingspw=[password] + --settingspwfile=pw-file + --version + @response-file + subcommand + + + + + Description + + The VBoxManage command is the command-line + interface (CLI) for the &product-name; software. The CLI supports + all the features that are available with the &product-name; + graphical user interface (GUI). In addition, you can use the + VBoxManage command to manage the features of + the virtualization engine that cannot be managed by the GUI. + + + Each time you invoke the VBoxManage command, + only one command is executed. Note that some + VBoxManage subcommands invoke several + subcommands. + + + Run the VBoxManage command from the command + line of the host operating system (OS) to control &product-name; + software. + + + The VBoxManage command is stored in the + following locations on the host system: + + + + Linux: + /usr/bin/VBoxManage + + + Mac OS X: + /Applications/VirtualBox.app/Contents/MacOS/VBoxManage + + + Oracle Solaris: + /opt/VirtualBox/bin/VBoxManage + + + Windows: + C:\Program + Files\Oracle\VirtualBox\VBoxManage.exe + + + + In addition to managing virtual machines (VMs) with this CLI or + the GUI, you can use the VBoxHeadless CLI to + manage VMs remotely. + + + The VBoxManage command performs particular + tasks by using subcommands, such as list, + createvm, and startvm. See + the associated information for each VBoxManage + subcommand. + + + If required, specify the VM by its name or by its Universally + Unique Identifier (UUID). + + + Use the VBoxManage list vms command to obtain + information about all currently registered VMs, including the VM + names and associated UUIDs. + + + Note that you must enclose the entire VM name in double quotes if + it contains spaces. + + + General Options + + + + + Suppresses the output of the logo information, which is + useful for scripts. + + + + + + Specifies the settings password. You can optionally + specify the password as an argument to this option. If you + do not specify the password in this way, the + VBoxManage command prompts you for the + password. + + The settings password is a security feature that encrypts + stored settings, which are stored as plain text by + default. + + You cannot unencrypt encrypted settings. So, if the + settings are encrypted, you must continue to specify the + or + option. + + Only the iSCSI secret is encrypted at this time. + + This design does not conform to Oracle's security + guidelines. You should not be able to specify a password + on the command line because the password can be seen in a + process listing. + + + + + + Specifies the file that contains the settings password. + + + + + + Shows version information about the + VBoxManage command. + + The short version of this option is . + + + + @response-file + + Loads arguments from the specified Bourne shell response + file. + + + + subcommand + + Specifies one of the VBoxManage + subcommands, such as controlvm, + createvm, list, + modifyvm, + showvminfo, startvm, + storageattach, and + storagectl. + + Each subcommand is described in its own command topic, + some of which are shown in See Also sections. + + + + + + + + Examples + + + The following command creates a virtual machine called + Win8 and registers it with &product-name; by + using the option. + +$ VBoxManage createvm --name "Win8" --register +Virtual machine 'Win8' is created. +UUID: UUID-string +Settings file: '/home/username/VirtualBox VMs/Win8/Win8.vbox' + + The command output shows that the Win8 VM is + assigned a UUID and an XML machine settings file. + + + You can use the VBoxManage showvminfo command + to view the configuration information of a VM. + + + The following example uses the VBoxManage + modifyvm command to change the amount of memory for the + Windows XP VM to be 1024 megabytes: + +$ VBoxManage modifyvm "Windows XP" --memory 1024 + + Note that you can use the VBoxManage modifyvm + command even when the VM is powered off. + + + You can use the VBoxManage storagectl command + or the VBoxManage storageattach command to + modify the storage configuration for a VM. For example, to create + a SATA storage controller called sata01 and add + it to the ol7 VM: + +$ VBoxManage storagectl ol7 --name "sata01" --add sata + + Use the VBoxManage startvm command to start a + VM that is currently powered off. For example, to start the + win7 VM: + +$ VBoxManage startvm win7 + + Use the VBoxManage controlvm command to pause + or save a VM that is currently running. You can also use this + command to modify settings for the VM. For example, to enable + audio input for the ol6u9 VM. + +$ VBoxManage controlvm ol6u9 audioin on + + + + See Also + + , + , + , + , + , + , + , + + + + diff --git a/doc/manual/en_US/man_vboximg-mount.xml b/doc/manual/en_US/man_vboximg-mount.xml new file mode 100644 index 00000000..93773f57 --- /dev/null +++ b/doc/manual/en_US/man_vboximg-mount.xml @@ -0,0 +1,398 @@ + + + +%all.entities; +]> + + + November 2019 + vboximg-mount + + + + vboximg-mount + 1 + + + + vboximg-mount + FUSE mount a virtual disk image for Mac OS and Linux hosts + Oracle VM VirtualBox + + + + + + vboximg-mount + + -? + -h + --help + + + + + vboximg-mount + --image=image-UUID + --guest-filesystem + -o=FUSE-option[,FUSE-option] + --root + --rw + mountpoint + + + + vboximg-mount + --list + --image=image-UUID + --guest-filesystem + --verbose + --vm=vm-UUID + --wide + + + + + Description + + The vboximg-mount command enables you to make + &product-name; disk images available to a Mac OS or Linux host + operating system (OS) for privileged or non-priviliged access. You + can mount any version of the disk from its available history of + snapshots. Use this command to mount, view, and optionally modify + the contents of an &product-name; virtual disk image, and you can + also use this command to view information about registered virtual + machines (VMs). + + + This command uses the Filesystem in Userspace (FUSE) technology to + provide raw access to an &product-name; virtual disk image. + + + When you use the option to specify a base + image identifier, only the base image is mounted. Any related + snapshots are disregarded. Alternatively, if you use the + option to specify a snapshot, the state + of the FUSE-mounted virtual disk is synthesized from the implied + chain of snapshots, including the base image. + + + The vboximg-mount command includes experimental + read-only access to file systems inside a VM disk image. This + feature enables you to extract some files from the VM disk image + without starting the VM and without requiring third-party file + system drivers on the host system. &product-name; supports the + FAT, NTFS, ext2, ext3, + and ext4 file systems. + + + The virtual disk is exposed as a device node within a FUSE-based + file system that overlays the specified mount point. + + + The FUSE file system includes a directory that contains a number + of files. The file system can also contain a directory that + includes a symbolic link that has the same base name (see the + basename(1) man page) as the virtual disk base + image and points to the location of the virtual disk base image. + The directory can be of the following types: + + + + vhdd provides access to the raw disk + image data as a flat image + + + volID provides + access to an individual volume on the specified disk image + + + fsID provides + access to a supported file system without requiring a host + file system driver + + + + General Command Options + + + Use the following options to obtain information about the + vboximg-mount command and its options. + + + + , , or + + Shows usage information. + + + + + + Mounting an &product-name; Disk Image + + + Use the vboximg-mount command to mount an + &product-name; virtual disk image on a Mac OS or Linux host + system. When mounted, you can view the contents of the disk + image or modify the contents of the disk image. + + + You can use the vboximg-mount command to + restrict FUSE-based access to a subsection of the virtual disk. + + + + + + Specifies the Universally Unique Identifier (UUID), name, + or path of the &product-name; disk image. + + The short form of the option is + . + + + + + + Enables experimental read-only support for guest file + systems. When you specify this option, all known file + systems are made available to access. + + The short form of the + option is . + + + + + + Specifies FUSE mount options. + + The vboximg-mount command enables you + to use the FUSE mount options that are described in the + mount.fuse(8) man page. + + + + + + Overrides the security measure that restricts file access + to the file system owner by also granting file access to + the root user. + + Same as the option. See the + option description. + + This option is incompatible with the option. + + + + + + Mounts the specified image as read-write, which is + required if you want to modify its contents. By default, + images are mounted as read-only. + + + + mount-point + + Specifies the path name of a directory on which to mount + the &product-name; disk image. + + + + + + Viewing &product-name; Disk Image Information + + + Use the vboximg-mount command to view + information about registered VMs or an &product-name; virtual + disk image. + + + + + + Specifies the UUID, name, or path of the &product-name; + disk image. + + The short form of the option is + . + + + + + + Enables experimental read-only support for guest file + systems. When you specify this option, all known file + systems are made available to access. + + The short form of the + option is . + + + + + + Shows information about the disks that are associated with + the registered VMs. If you specify a disk image, this + option shows information about the partitions of the + specified image. + + When you specify the option, + the output includes detailed information about the VMs and + media, including snapshot images and file paths. + + The short form of the option is + . + + + + + + Shows or logs detailed information. + + The short form of the option is + . + + + + + + Outputs information about the VM that is associated with + the specified UUID. + + + + + + Outputs information in a wide format. This output includes + the lock state information of running VMs. For VMs that + are not running, the state is created. + + The wide output uses a tree-like structure in the VM + column to show the relationship between a VM base image + and its snapshots. + + + + + + + + Examples + + + The following example shows how to mount a virtual disk image on + the host operating system (OS). + +$ mkdir fuse_mount_point +$ vboximg-mount --image=b490e578-08be-4f7d-98e9-4c0ef0952377 fuse_mount_point +$ ls fuse_mount_point +ubu.vdi[32256:2053029880] vhdd +$ sudo mount fuse_mount_point/vhdd /mnt + + The mkdir command creates a mount point called + fuse_mount_point on the host OS. The + vboximg-mount command is then used to mount the + specified disk image on the fuse_mount_point + mount point. The mount includes all snapshots for the disk image. + + + The ls command shows the contents of + fuse_mount_point. The + mount command is then used to mount the + FUSE-mounted device node, vhdd, on the + /mnt mount point. The vhdd + device node represents the virtual disk image. + + + The following example shows how to make the known file systems of + the b490e578-08be-4f7d-98e9-4c0ef0952377 disk + image accessible when the image is mounted on the + fuse_mount_point mount point: + +$ vboximg-mount --image=b490e578-08be-4f7d-98e9-4c0ef0952377 \ +--guest-filesystem fuse_mount_point + + + The following command outputs detailed information about all + registered VMs and their snapshots: + +$ vboximg-mount --list --verbose + + The following command shows an excerpt of the list output in wide + format. + +$ vboximg-mount --list --wide + +VM Image Size Type State UUID (hierarchy) +------------------------------------------ ------------------------------------ +Proxy 0833f5bc-6304-42e1-b799-cdc81c576c60 + | + +- Proxy.vdi 4.8G VDI rlock d5f84afb-0794-4952-ab71-6bbcbee07737 + | +- <snapshot> 12.3G VDI rlock dffc67aa-3023-477f-8033-b27e3daf4f54 + | +- <snapshot> 8.8G VDI rlock 3b2755bd-5f2a-4171-98fe-647d510b6274 + | +- <snapshot> 14.6G VDI rlock e2ccdb5f-49e8-4123-8623-c61f363cc5cf + | +- <snapshot> 7.4G VDI wlock 3c1e6794-9091-4be3-9e80-11aba40c2649 + +------------------------------------------ ------------------------------------ +Oracle Linux 7 5365ab5f-470d-44c0-9863-dad532ee5905 + | + +- Oracle Linux 7.vdi 7.0G VDI created 96d2e92e-0d4e-46ab-a0f1-008fdbf997e7 + | +- <snapshot> 15.9G VDI created f9cc866a-9166-42e9-a503-bbfe9b7312e8 + | + +- kernel.vdi 11.1G VDI created 79a370bd-0c4f-480a-30bb-10cdea68423f + + + The output shows that the Proxy VM is running the fourth snapshot + of the Proxy.vdi virtual disk image. The + running state is indicated by the wlock value + in the State column. + + + The Oracle Linux 7 VM is not running. It has two images: + Oracle Linux 7.vdi and + kernel.vdi. The Oracle Linux + 7.vdi image has a snapshot. + + + The following command shows information about the VM with the + specified UUID: + + +$ vboximg-mount --list --vm=b1d5563b-2a5b-4013-89f1-26c81d6bbfa0 +----------------------------------------------------------------- +VM: ubu +UUID: b1d5563b-2a5b-4013-89f1-26c81d6bbfa0 + + Image: ubu.vdi + UUID: b490e578-08be-4f7d-98e9-4c0ef0952377 + + Snapshot: 35afe1e0-0a51-44f3-a228-caf172f3306f + Size: 12.1G + + Snapshot: 874279c1-4425-4282-ada8-a9c07c00bbf9 + Size: 13.6G + + Image: kernel.vdi + UUID: 79a370bd-6eb7-4dbf-8bc6-d29118f127e0 + + diff --git a/doc/manual/en_US/oracle-accessibility-en.xml b/doc/manual/en_US/oracle-accessibility-en.xml new file mode 100644 index 00000000..e6674936 --- /dev/null +++ b/doc/manual/en_US/oracle-accessibility-en.xml @@ -0,0 +1,27 @@ + + +%all.entities; +]> + + + + + Documentation Accessibility + + + For information about Oracle's commitment to accessibility, visit + the Oracle Accessibility Program website at + + + + . + + + diff --git a/doc/manual/en_US/oracle-diversity.xml b/doc/manual/en_US/oracle-diversity.xml new file mode 100644 index 00000000..df687b08 --- /dev/null +++ b/doc/manual/en_US/oracle-diversity.xml @@ -0,0 +1,13 @@ + + + + Diversity and Inclusion + Oracle is fully committed to diversity and inclusion. Oracle recognizes the influence of + ethnic and cultural values and is working to remove language from our products and + documentation that might be considered insensitive. While doing so, we are also mindful of + the necessity to maintain compatibility with our customers' existing technologies and the + need to ensure continuity of service as Oracle's offerings and industry standards evolve. + Because of these technical constraints, our effort to remove insensitive terms is an + ongoing, long-term process. + diff --git a/doc/manual/en_US/oracle-support-en.xml b/doc/manual/en_US/oracle-support-en.xml new file mode 100644 index 00000000..5b86d05a --- /dev/null +++ b/doc/manual/en_US/oracle-support-en.xml @@ -0,0 +1,23 @@ + + +%all.entities; +]> + + + + + Access to Oracle Support + + + Oracle customers that have purchased support have access to + electronic support through My Oracle Support. For information, visit + + + + . + + + diff --git a/doc/manual/en_US/user_AdvancedTopics.xml b/doc/manual/en_US/user_AdvancedTopics.xml new file mode 100644 index 00000000..593e8094 --- /dev/null +++ b/doc/manual/en_US/user_AdvancedTopics.xml @@ -0,0 +1,7403 @@ + + +%all.entities; +]> + + + Advanced Topics + + + + Automated Guest Logins + + + &product-name; provides Guest Addition modules for Windows, Linux, + and Oracle Solaris to enable automated logins on the guest. + + + + When a guest operating system is running in a virtual machine, it + might be desirable to perform coordinated and automated logins + using credentials passed from the host. Credentials are user + name, password, and domain name, where each value might be empty. + + + + + Automated Windows Guest Logins + + + Windows provides a modular system login subsystem, called + Winlogon, which can be customized and extended by means of + so-called GINA (Graphical Identification and Authentication) + modules. In Windows Vista and later releases, the GINA modules + were replaced with a new mechanism called credential providers. + The &product-name; Guest Additions for Windows come with both, a + GINA and a credential provider module, and therefore enable any + Windows guest to perform automated logins. + + + + To activate the &product-name; GINA or credential provider + module, install the Guest Additions using the command line + switch . All the following + manual steps required for installing these modules will be then + done by the installer. + + + + To manually install the &product-name; GINA module, extract the + Guest Additions as shown in + , and copy the + VBoxGINA.dll file to the Windows + SYSTEM32 directory. In the registry, create + the following key with a value of + VBoxGINA.dll: + + +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon\GinaDLL + + + + The &product-name; GINA module is implemented as a wrapper + around the MSGINA.DLL standard Windows + GINA module. As a result, it might not work correctly with + third-party GINA modules. + + + + + To manually install the &product-name; credential provider + module, extract the Guest Additions as shown in + and copy the + VBoxCredProv.dll file to the Windows + SYSTEM32 directory. In the registry, create + the following keys: + + +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\ +Authentication\Credential Providers\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B} + +HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B} + +HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}\InprocServer32 + + + All default values, the key named Default, + must be set to VBoxCredProv. + + + + Create the following string and assign it a value of + Apartment. + + +HKEY_CLASSES_ROOT\CLSID\{275D3BCC-22BB-4948-A7F6-3A3054EBA92B}\InprocServer32\ThreadingModel + + + To set credentials, use the following command on a + running VM: + + +$ VBoxManage controlvm "Windows XP" setcredentials "John Doe" "secretpassword" "DOMTEST" + + + While the VM is running, the credentials can be queried by the + &product-name; login modules, GINA or credential provider, using + the &product-name; Guest Additions device driver. When Windows + is in logged out mode, the login modules + will constantly poll for credentials and if they are present, a + login will be attempted. After retrieving the credentials, the + login modules will erase them so that the above command will + have to be repeated for subsequent logins. + + + + For security reasons, credentials are not stored in any + persistent manner and will be lost when the VM is reset. Also, + the credentials are write-only. There is no way to retrieve the + credentials from the host side. Credentials can be reset from + the host side by setting empty values. + + + + Depending on the Windows guest version, the following + restrictions apply: + + + + + + + For Windows XP guests. The + login subsystem needs to be configured to use the classic + login dialog, as the &product-name; GINA module does not + support the Windows XP-style welcome dialog. + + + + + + Windows Vista, Windows 7, Windows 8, + and Windows 10 guests. The login subsystem does + not support the so-called Secure Attention Sequence, + Ctrl+Alt+Del. As a result, the guest's + group policy settings need to be changed to not use the + Secure Attention Sequence. Also, the user name given is only + compared to the true user name, not the user friendly name. + This means that when you rename a user, you still have to + supply the original user name as Windows never renames user + accounts internally. + + + + + + Automatic login handling of the built-in + Windows Remote Desktop + Service, formerly known as Terminal Services, is + disabled by default. To enable it, create the following + registry key with a DWORD value of + 1. + + +HKEY_LOCAL_MACHINE\SOFTWARE\Oracle\VirtualBox Guest Additions\AutoLogon + + + + + + The following command forces &product-name; to keep the + credentials after they were read by the guest and on VM reset: + + +$ VBoxManage setextradata "Windows XP" VBoxInternal/Devices/VMMDev/0/Config/KeepCredentials 1 + + + Note that this is a potential security risk, as a malicious + application running on the guest could request this information + using the proper interface. + + + + + + + Automated Linux and UNIX Guest Logins + + + &product-name; provides a custom PAM module (Pluggable + Authentication Module) which can be used to perform automated + guest logins on platforms which support this framework. + Virtually all modern Linux and UNIX distributions rely on PAM. + + + + For automated logins on Ubuntu, or Ubuntu-derived, distributions + using LightDM as the display manager. See + . + + + + The pam_vbox.so module itself + does not do an actual verification of the + credentials passed to the guest OS. Instead it relies on other + modules such as pam_unix.so or + pam_unix2.so down in the PAM stack to do + the actual validation using the credentials retrieved by + pam_vbox.so. Therefore + pam_vbox.so has to be on top of the + authentication PAM service list. + + + + + The pam_vbox.so module only supports the + auth primitive. Other primitives such as + account, session, or + password are not supported. + + + + + The pam_vbox.so module is shipped as part + of the Guest Additions but it is not installed and/or activated + on the guest OS by default. In order to install it, it has to be + copied from + /opt/VBoxGuestAdditions-version/other/ + to the security modules directory. This is usually + /lib/security/ on 32-bit Linux guests or + /lib64/security/ on 64-bit Linux guests. + Please refer to your guest OS documentation for the correct PAM + module directory. + + + + For example, to use pam_vbox.so with a + Ubuntu Linux guest OS and the GNOME Desktop Manager (GDM) to log + in users automatically with the credentials passed by the host, + configure the guest OS as follows: + + + + + + + Copy the pam_vbox.so module to the + security modules directory. In this case, + /lib/security. + + + + + + Edit the PAM configuration file for GDM, found at + /etc/pam.d/gdm. Add the line + auth requisite pam_vbox.so at the top. + Additionally, in most Linux distributions there is a file + called /etc/pam.d/common-auth. This + file is included in many other services, like the GDM file + mentioned above. There you also have to add the line + auth requisite pam_vbox.so. + + + + + + If authentication against the shadow database using + pam_unix.so or + pam_unix2.so is desired, the argument + try_first_pass for + pam_unix.so or + use_first_pass for + pam_unix2.so is needed in order to pass + the credentials from the &product-name; module to the shadow + database authentication module. For Ubuntu, this needs to be + added to /etc/pam.d/common-auth, to the + end of the line referencing + pam_unix.so. This argument tells the + PAM module to use credentials already present in the stack, + such as the ones provided by the &product-name; PAM module. + + + + + + + + An incorrectly configured PAM stack can effectively prevent + you from logging into your guest system. + + + + + To make deployment easier, you can pass the argument + debug right after the + pam_vbox.so statement. Debug log output + will then be recorded using syslog. + + + + + By default, pam_vbox does not wait for + credentials to arrive from the host. When a login prompt is + shown, for example by GDM/KDM or the text console, and + pam_vbox does not yet have credentials it + does not wait until they arrive. Instead the next module in + the PAM stack, depending on the PAM configuration, will have + the chance for authentication. + + + + + pam_vbox supports various guest property + parameters that are located in + /VirtualBox/GuestAdd/PAM/. These parameters + allow pam_vbox to wait for credentials to be + provided by the host and optionally can show a message while + waiting for those. The following guest properties can be set: + + + + + + + CredsWait: Set to 1 if + pam_vbox should start waiting until + credentials arrive from the host. Until then no other + authentication methods such as manually logging in will be + available. If this property is empty or gets deleted no + waiting for credentials will be performed and + pam_vbox will act like before. This + property must be set read-only for the guest + (RDONLYGUEST). + + + + + + CredsWaitAbort: Aborts waiting for + credentials when set to any value. Can be set from host and + the guest. + + + + + + CredsWaitTimeout: Timeout, in seconds, to + let pam_vbox wait for credentials to + arrive. When no credentials arrive within this timeout, + authentication of pam_vbox will be set to + failed and the next PAM module in chain will be asked. If + this property is not specified, set to 0 or an invalid + value, an infinite timeout will be used. This property must + be set read-only for the guest + (RDONLYGUEST). + + + + + + + To customize pam_vbox further there are the + following guest properties: + + + + + + + CredsMsgWaiting: Custom message showed + while pam_vbox is waiting for credentials from the host. + This property must be set read-only for the guest + (RDONLYGUEST). + + + + + + CredsMsgWaitTimeout: Custom message + showed when waiting for credentials by + pam_vbox has timed out. For example, they + did not arrive within time. This property must be set + read-only for the guest (RDONLYGUEST). + + + + + + + + If a pam_vbox guest property does not have + the correct flag set (RDONLYGUEST) the + property is ignored and, depending on the property, a default + value will be used. This can result in pam_vbox not waiting + for credentials. Consult the appropriate syslog file for more + information and use the debug option. + + + + + + &product-name; Greeter for Ubuntu/LightDM + + + &product-name; comes with a greeter module, named + vbox-greeter, that can be used with + LightDM. LightDM is the default display manager for Ubuntu + Linux and therefore can also be used for automated guest + logins. + + + + vbox-greeter does not need the + pam_vbox module described in + in order to function. It comes + with its own authentication mechanism provided by LightDM. + However, to provide maximum flexibility both modules can be + used together on the same guest. + + + + As with the pam_vbox module, + vbox-greeter is shipped as part of the + Guest Additions but it is not installed or activated on the + guest OS by default. To install + vbox-greeter automatically upon Guest + Additions installation, use the + option when starting the + VBoxLinuxAdditions.run file: + + +# ./VBoxLinuxAdditions.run -- --with-autologon + + + For manual or postponed installation, copy the + vbox-greeter.desktop file from + /opt/VBoxGuestAdditions-<version>/other/ + to the xgreeters directory, which is + usually /usr/share/xgreeters/. See your + guest OS documentation for the name of the correct LightDM + greeter directory. + + + + The vbox-greeter module is installed by the + &product-name; Guest Additions installer and is located in + /usr/sbin/. To enable + vbox-greeter as the standard greeter + module, edit the file + /etc/lightdm/lightdm.conf as follows: + + +[SeatDefaults] +greeter-session=vbox-greeter + + + + + + + The LightDM server must be fully restarted in order for + vbox-greeter to be used as the + default greeter. As root on Ubuntu, + run service lightdm --full-restart or + restart the guest. + + + + + + vbox-greeter is independent of the + graphical session you choose, such as Gnome, KDE, or + Unity. However, vbox-greeter does + require FLTK 1.3 or later to implement its own user + interface. + + + + + + + + There are numerous guest properties which can be used to + further customize the login experience. For automatically + logging in users, the same guest properties apply as for + pam_vbox. See + . + + + + In addition to the previously mentioned guest properties, + vbox-greeter enables you to further + customize its user interface. The following guest properties + are located in the + /VirtualBox/GuestAdd/Greeter/ directory: + + + + + + + HideRestart: Set to 1 if + vbox-greeter should hide the button to + restart the guest. This property must be set read-only for + the guest (RDONLYGUEST). + + + + + + HideShutdown: Set to 1 if + vbox-greeter should hide the button to + shutdown the guest. This property must be set read-only + for the guest (RDONLYGUEST). + + + + + + BannerPath: Path to a + .PNG file to use as a banner image on + the top of the greeter. The image size must be 460 x 90 + pixels, any bit depth. This property must be set read-only + for the guest (RDONLYGUEST). + + + + + + UseTheming: Set to 1 for turning on the + following theming options. This property must be set + read-only for the guest (RDONLYGUEST). + + + + + + Theme/BackgroundColor: Hexadecimal + RRGGBB color for the background. This property must be set + read-only for the guest (RDONLYGUEST). + + + + + + Theme/LogonDialog/HeaderColor: + Hexadecimal RRGGBB foreground color for the header text. + This property must be set read-only for the guest + (RDONLYGUEST). + + + + + + Theme/LogonDialog/BackgroundColor: + Hexadecimal RRGGBB color for the login dialog background. + This property must be set read-only for the guest + (RDONLYGUEST). + + + + + + Theme/LogonDialog/ButtonColor: + Hexadecimal RRGGBB background color for the login dialog + button. This property must be set read-only for the guest + (RDONLYGUEST). + + + + + + + + The same restrictions for the guest properties above apply + as for the ones specified in the pam_vbox + section. + + + + + + + + + + + + Advanced Configuration for Windows Guests + + + + Automated Windows System Preparation + + + Microsoft offers a system preparation tool called Sysprep, to + prepare a Windows system for deployment or redistribution. Some + Windows releases include Sysprep on the installation medium, but + the tool is also available for download from the Microsoft web + site. In a standard For most Windows versions, Sysprep is + included in a default installation. Sysprep mainly consists of + an executable called sysprep.exe which is + invoked by the user to put the Windows installation into + preparation mode. + + + + The Guest Additions offer a way to launch a system preparation + on the guest operating system in an automated way, controlled + from the host system. See + for details of how to + use this feature with the special identifier + sysprep as the program to execute, along with + the user name sysprep and password + sysprep for the credentials. Sysprep is then + started with the required system rights. + + + + + Specifying the location of sysprep.exe is + not possible. Instead the + following paths are used, based on the Windows release: + + + + + + + C:\sysprep\sysprep.exe for Windows XP + and earlier + + + + + + %WINDIR%\System32\sysprep\sysprep.exe + for Windows Vista and later + + + + + + + The Guest Additions will automatically use the appropriate + path to execute the system preparation tool. + + + + + + + + + + Advanced Configuration for Linux and Oracle Solaris Guests + + + + Manual Setup of Selected Guest Services on Linux + + + The &product-name; Guest Additions contain several different + drivers. If you do not want to configure them all, use the + following command to install the Guest Additions: + + +$ sh ./VBoxLinuxAdditions.run no_setup + + + After running this script, run the rcvboxadd + setup command as root to compile + the kernel modules. + + + + On some 64-bit guests, you must replace lib + with lib64. On older guests that do not run + the udev service, you must add the + vboxadd service to the default runlevel to + ensure that the modules are loaded. + + + + To set up the time synchronization service, add the + vboxadd-service service to the default + runlevel. To set up the X11 and OpenGL part of the Guest + Additions, run the rcvboxadd-x11 setup + command. Note that you do not need to enable additional + services. + + + + Use the rcvboxadd setup to recompile the + guest kernel modules. + + + + After compilation, reboot your guest to ensure that the new + modules are loaded. + + + + + + + Guest Graphics and Mouse Driver Setup in Depth + + + This section assumes that you are familiar with configuring the + X.Org server using xorg.conf and optionally the newer mechanisms + using hal or udev and xorg.conf.d. If not you can learn about + them by studying the documentation which comes with X.Org. + + + + The &product-name; Guest Additions includes drivers for X.Org. + By default these drivers are in the following directory: + + + + /opt/VBoxGuestAdditions-version/other/ + + + + The correct versions for the X server are symbolically linked + into the X.Org driver directories. + + + + For graphics integration to work correctly, the X server must + load the vboxvideo driver. Many recent X + server versions look for it automatically if they see that they + are running in &product-name;. For an optimal user experience, + the guest kernel drivers must be loaded and the Guest Additions + tool VBoxClient must be running as a client + in the X session. + + + + For mouse integration to work correctly, the guest kernel + drivers must be loaded. In addition, for legacy X servers the + correct vboxmouse driver must be loaded and + associated with /dev/mouse or + /dev/psaux. For most guests, a driver for a + PS/2 mouse must be loaded and the correct vboxmouse driver must + be associated with /dev/vboxguest. + + + + The &product-name; guest graphics driver can use any graphics + configuration for which the virtual resolution fits into the + virtual video memory allocated to the virtual machine, minus a + small amount used by the guest driver, as described in + . The driver will offer a + range of standard modes at least up to the default guest + resolution for all active guest monitors. The default mode can + be changed by setting the output property VBOX_MODE to + "<width>x<height>" for any guest monitor. When + VBoxClient and the kernel drivers are active this is done + automatically when the host requests a mode change. The driver + for older versions can only receive new modes by querying the + host for requests at regular intervals. + + + + With legacy X Servers before version 1.3, you can also add your + own modes to the X server configuration file. Add them to the + "Modes" list in the "Display" subsection of the "Screen" + section. For example, the following section has a custom + 2048x800 resolution mode added: + + +Section "Screen" + Identifier "Default Screen" + Device "VirtualBox graphics card" + Monitor "Generic Monitor" + DefaultDepth 24 + SubSection "Display" + Depth 24 + Modes "2048x800" "800x600" "640x480" + EndSubSection +EndSection + + + + + + + + CPU Hot-Plugging + + + With virtual machines running modern server operating systems, + &product-name; supports CPU hot-plugging. + + + + On a physical computer CPU hot-plugging would mean that a CPU can + be added or removed while the machine is running. &product-name; + supports adding and removing of virtual CPUs while a virtual + machine is running. + + + + CPU hot-plugging works only with guest operating systems that + support the feature. So far this applies only to Linux and Windows + Server. Windows supports only hot-add, while Linux supports + hot-add and hot-remove. To use this feature with more than 8 CPUs, + a 64-bit Linux guest is required. + + + + CPU hot-plugging is done using the VBoxManage + command-line interface. First, hot-plugging needs to be enabled + for a virtual machine: + + +$ VBoxManage modifyvm VM-name --cpuhotplug on + + + The option is used to specify the maximum + number of CPUs that the virtual machine can have: + + +$ VBoxManage modifyvm VM-name --cpus 8 + + + When the VM is off, you can then add and remove virtual CPUs with + the VBoxManage modifyvm --plugcpu and + VBoxManage modifyvm --unplugcpu commands, which + take the number of the virtual CPU as a parameter, as follows: + + +$ VBoxManage modifyvm VM-name --plugcpu 3 +$ VBoxManage modifyvm VM-name --unplugcpu 3 + + + Note that CPU 0 can never be removed. + + + + While the VM is running, CPUs can be added and removed with the + VBoxManage controlvm plugcpu and + VBoxManage controlvm unplugcpu commands + instead, as follows: + + +$ VBoxManage controlvm VM-name plugcpu 3 +$ VBoxManage controlvm VM-name unplugcpu 3 + + + See and + for details. + + + + With Linux guests, the following applies: + + + + To prevent ejection while the CPU is still used it has to be + ejected from within the guest before. The Linux Guest Additions + contain a service which receives hot-remove events and ejects the + CPU. Also, after a CPU is added to the VM it is not automatically + used by Linux. The Linux Guest Additions service will take care of + that if installed. If not a CPU can be started with the following + command: + + +$ echo 1 > /sys/devices/system/cpu/cpu<id>/online + + + + + + + + Webcam Passthrough + + + + Using a Host Webcam in the Guest + + + &product-name; includes a feature called webcam + passthrough, which enables a guest to use a host + webcam. This complements the general USB passthrough support + which was the typical way of using host webcams in legacy + releases. The webcam passthrough support can handle non-USB + video sources in theory, but this is completely untested. + + + + + The webcam passthrough module is shipped as part of the + &product-name; extension pack, which must be installed + separately. See . + + + + + The host webcam can be attached to the VM using the + Devices menu in the VM menu + bar. The Webcams menu contains + a list of available video input devices on the host. Clicking on + a webcam name attaches or detaches the corresponding host + device. + + + + The VBoxManage command line tool can be used + to enable webcam passthrough. Please see the host-specific + sections below for additional details. The following commands + are available: + + + + + + + Get a list of host webcams, or other video input devices: + + +$ VBoxManage list webcams + + + The output format is as follows: + + +alias "user friendly name" +host path or identifier + + + The alias can be used as a shortcut in other commands. Alias + '.0' means the default video input device on the host. Alias + '.1', '.2'means first, second video input device, and so on. + The device order is host-specific. + + + + + + Attach a webcam to a running VM, as follows: + + +VBoxManage controlvm VM name webcam attach [host_path|alias [settings]] + + + This attaches a USB webcam device to the guest. + + + + The settings parameter is a string + Setting1=Value1;Setting2=Value2, which + enables you to configure the emulated webcam device. The + following settings are supported: + + + + + + + MaxFramerate: The highest rate at + which video frames are sent to the guest. A higher frame + rate requires more CPU power. Therefore sometimes it is + useful to set a lower limit. Default is no limit and + allow the guest to use all frame rates supported by the + host webcam. + + + + + + MaxPayloadTransferSize: How many + bytes the emulated webcam can send to the guest at a + time. Default value is 3060 bytes, which is used by some + webcams. Higher values can slightly reduce CPU load, if + the guest is able to use larger buffers. However, a high + MaxPayloadTransferSize might be not + supported by some guests. + + + + + + + + + Detach a webcam from a running VM, as follows: + + +VBoxManage controlvm VM-name webcam detach [host_path|alias] + + + + + List the webcams attached to a running VM, as follows: + + +VBoxManage controlvm VM-name webcam list + + + The output contains the path or alias which was used in the + webcam attach command for each attached + webcam. + + + + + + + + + + Windows Hosts + + + When the webcam device is detached from the host, the emulated + webcam device is automatically detached from the guest. + + + + + + + Mac OS X Hosts + + + Mac OS X version 10.9 or later is required. + + + + When the webcam device is detached from the host, the emulated + webcam device remains attached to the guest and must be manually + detached using the VBoxManage controlvm + VM-name webcam detach + command. + + + + + + + Linux and Oracle Solaris Hosts + + + When the webcam is detached from the host the emulated webcam + device is automatically detached from the guest only if the + webcam is streaming video. If the emulated webcam is inactive it + should be manually detached using the VBoxManage + controlvm VM-name webcam + detach command. + + + + Aliases .0 and .1 are + mapped to /dev/video0, alias + .2 is mapped to + /dev/video1 and so forth. + + + + + + + + + Advanced Display Configuration + + + + Custom VESA Resolutions + + + Apart from the standard VESA resolutions, the &product-name; + VESA BIOS enables you to add up to 16 custom video modes which + will be reported to the guest operating system. When using + Windows guests with the &product-name; Guest Additions, a custom + graphics driver will be used instead of the fallback VESA + solution so this information does not apply. + + + + Additional video modes can be configured for each VM using the + extra data facility. The extra data key is called + CustomVideoModex + with x being a number from 1 to 16. + Please note that modes will be read from 1 until either the + following number is not defined or 16 is reached. The following + example adds a video mode that corresponds to the native display + resolution of many notebook computers: + + +$ VBoxManage setextradata VM-name "CustomVideoMode1" "1400x1050x16" + + + The VESA mode IDs for custom video modes start at + 0x160. In order to use the above defined + custom video mode, the following command line has to be supplied + to Linux: + + +vga = 0x200 | 0x160 +vga = 864 + + + For guest operating systems with &product-name; Guest Additions, + a custom video mode can be set using the video mode hint + feature. + + + + + + + Configuring the Maximum Resolution of Guests When Using the Graphical + Frontend + + + When guest systems with the Guest Additions installed are + started using the graphical frontend, the normal &product-name; + application, they will not be allowed to use screen resolutions + greater than the host's screen size unless the user manually + resizes them by dragging the window, switching to full screen or + seamless mode or sending a video mode hint using + VBoxManage. This behavior is what most users + will want, but if you have different needs, you can change it by + issuing one of the following commands from the command line: + + + + + + + Remove all limits on guest resolutions. + + +VBoxManage setextradata global GUI/MaxGuestResolution any + + + + + Manually specify a maximum resolution. + + +VBoxManage setextradata global GUI/MaxGuestResolution widthxheight + + + + + Restore the default settings to all guest VMs. + + +VBoxManage setextradata global GUI/MaxGuestResolution auto + + + + + + + + + + + Advanced Storage Configuration + + + + Using a Raw Host Hard Disk From a Guest + + + As an alternative to using virtual disk images as described in + , &product-name; can also present + either entire physical hard disks or selected partitions as + virtual disks to virtual machines. + + + + With &product-name;, this type of access is called raw + hard disk access. It enables a guest operating system + to access its virtual hard disk without going through the host + OS file system. The actual performance difference for image + files compared to raw disk varies greatly depending on the + overhead of the host file system, whether dynamically growing + images are used, and on host OS caching strategies. The caching + indirectly also affects other aspects such as failure behavior. + For example, whether the virtual disk contains all data written + before a host OS crash. Consult your host OS documentation for + details on this. + + + + + Raw hard disk access is for expert users only. Incorrect use + or use of an outdated configuration can lead to + total loss of data on the + physical disk. Most importantly, do not + attempt to boot the partition with the currently running host + operating system in a guest. This will lead to severe data + corruption. + + + + + Raw hard disk access, both for entire disks and individual + partitions, is implemented as part of the VMDK image format + support. As a result, you will need to create a special VMDK + image file which defines where the data will be stored. After + creating such a special VMDK image, you can use it like a + regular virtual disk image. For example, you can use the + VirtualBox Manager, see , or + VBoxManage to assign the image to a virtual + machine. + + + + + Access to Entire Physical Hard Disk + + + While this variant is the simplest to set up, you must be + aware that this will give a guest operating system direct and + full access to an entire physical disk. + If your host operating system is also + booted from this disk, please take special care to not access + the partition from the guest at all. On the positive side, the + physical disk can be repartitioned in arbitrary ways without + having to recreate the image file that gives access to the raw + disk. + + + + On a Linux host, to create an image that represents an entire + physical hard disk which will not contain any actual data, as + this will all be stored on the physical disk, use the + following command: + + +$ VBoxManage internalcommands createrawvmdk -filename \ +path-to-file.vmdk -rawdisk /dev/sda + + + This creates the + /path-to-file.vmdk + file image that must be an absolute path. All data is read and + written from /dev/sda. + + + + On a Windows host, instead of the above device specification, + for example use \\.\PhysicalDrive0. On a + Mac OS X host, instead of the above device specification use + for example /dev/disk1. Note that on Mac + OS X you can only get access to an entire disk if no volume is + mounted from it. + + + + Creating the image requires read/write access for the given + device. Read/write access is also later needed when using the + image from a virtual machine. On some host platforms, such as + Windows, raw disk access may be restricted and not permitted + by the host OS in some situations. + + + + Just like with regular disk images, this does not + automatically attach the newly created image to a virtual + machine. This can be done as follows: + + +$ VBoxManage storageattach WindowsXP --storagectl "IDE Controller" \ + --port 0 --device 0 --type hdd --medium path-to-file.vmdk + + + When this is done the selected virtual machine will boot from + the specified physical disk. + + + + + + + Access to Individual Physical Hard Disk Partitions + + + This raw partition support is quite + similar to the full hard disk access described above. However, + in this case, any partitioning information will be stored + inside the VMDK image. This means that you can install a + different boot loader in the virtual hard disk without + affecting the host's partitioning information. While the guest + will be able to see all partitions that + exist on the physical disk, access will be filtered in that + reading from partitions for which no access is allowed the + partitions will only yield zeroes, and all writes to them are + ignored. + + + + To create a special image for raw partition support, which + will contain a small amount of data, on a Linux host, use the + command: + + +$ VBoxManage internalcommands createrawvmdk -filename \ +path-to-file.vmdk -rawdisk /dev/sda -partitions 1,5 + + + The command is identical to the one for full hard disk access, + except for the additional + parameter. This example would create the image + /path-to-file.vmdk, + which must be absolute, and partitions 1 and 5 of + /dev/sda would be made accessible to the + guest. + + + + &product-name; uses the same partition numbering as your Linux + host. As a result, the numbers given in the above example + would refer to the first primary partition and the first + logical drive in the extended partition, respectively. + + + + On a Windows host, instead of the above device specification, + use for example \\.\PhysicalDrive0. On a + Mac OS X host, instead of the above device specification use + /dev/disk1, for example. Note that on OS + X you can only use partitions which are not mounted. Eject the + respective volume first. Partition numbers are the same on + Linux, Windows, and Mac OS X hosts. + + + + The numbers for the list of partitions can be taken from the + output of the following command: + + +$ VBoxManage internalcommands listpartitions -rawdisk /dev/sda + + + The output lists the partition types and sizes to give the + user enough information to identify the partitions necessary + for the guest. + + + + Images which give access to individual partitions are specific + to a particular host disk setup. You cannot transfer these + images to another host. Also, whenever the host partitioning + changes, the image must be recreated. + + + + Creating the image requires read/write access for the given + device. Read/write access is also later needed when using the + image from a virtual machine. If this is not feasible, there + is a special variant for raw partition access, currently only + available on Linux hosts, that avoids having to give the + current user access to the entire disk. To set up such an + image, use: + + +$ VBoxManage internalcommands createrawvmdk -filename \ +path-to-file.vmdk -rawdisk /dev/sda -partitions 1,5 -relative + + + When used from a virtual machine, the image will then refer + not to the entire disk, but only to the individual partitions. + In this example, /dev/sda1 and + /dev/sda5. As a consequence, read/write + access is only required for the affected partitions, not for + the entire disk. During creation however, read-only access to + the entire disk is required to obtain the partitioning + information. + + + + In some configurations it may be necessary to change the MBR + code of the created image. For example, to replace the Linux + boot loader that is used on the host by another boot loader. + This enables for example the guest to boot directly to + Windows, while the host boots Linux from the "same" disk. For + this purpose the option is provided. It + specifies a file name from which to take the MBR code. The + partition table is not modified at all, so a MBR file from a + system with totally different partitioning can be used. An + example of this is: + + +$ VBoxManage internalcommands createrawvmdk -filename +path-to-file.vmdk -rawdisk /dev/sda -partitions 1,5 -mbr winxp.mbr + + + The modified MBR will be stored inside the image, not on the + host disk. + + + + The created image can be attached to a storage controller in a + VM configuration as usual. + + + + + + + + + Configuring the Hard Disk Vendor Product Data (VPD) + + + &product-name; reports vendor product data for its virtual hard + disks which consist of hard disk serial number, firmware + revision and model number. These can be changed using the + following commands: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/SerialNumber" "serial" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/FirmwareRevision" "firmware" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/ModelNumber" "model" + + + The serial number is a 20 byte alphanumeric string, the firmware + revision an 8 byte alphanumeric string and the model number a 40 + byte alphanumeric string. Instead of Port0, referring to the + first port, specify the desired SATA hard disk port. + + + + The above commands apply to virtual machines with an AHCI (SATA) + controller. The commands for virtual machines with an IDE + controller are: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/SerialNumber" "serial" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/FirmwareRevision" "firmware" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/piix3ide/0/Config/PrimaryMaster/ModelNumber" "model" + + + For hard disks, you can mark the drive as having a + non-rotational medium by using the following command: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/NonRotational" "1" + + + Additional three parameters are needed for CD/DVD drives to + report the vendor product data: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIVendorId" "vendor" +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIProductId" "product" +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/ahci/0/Config/Port0/ATAPIRevision" "revision" + + + The vendor id is an 8 byte alphanumeric string, the product id + an 16 byte alphanumeric string and the revision a 4 byte + alphanumeric string. Instead of Port0, referring to the first + port, specify the desired SATA hard disk port. + + + + + + + Access iSCSI Targets Using Internal Networking + + + As an experimental feature, &product-name; enables access to an + iSCSI target running in a virtual machine which is configured to + use Internal Networking mode. See + , + , and + . + + + + The IP stack accessing Internal Networking must be configured in + the virtual machine which accesses the iSCSI target. A free + static IP and a MAC address not used by other virtual machines + must be chosen. In the example below, adapt the name of the + virtual machine, the MAC address, the IP configuration, and the + Internal Networking name (MyIntNet) according to your needs. The + following eight commands must first be issued: + + +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/Trusted 1 +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/Config/MAC 08:00:27:01:02:0f +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/Config/IP 10.0.9.1 +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/Config/Netmask 255.255.255.0 +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/LUN#0/Driver IntNet +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/Network MyIntNet +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/TrunkType 2 +$ VBoxManage setextradata VM-name \ +VBoxInternal/Devices/IntNetIP/0/LUN#0/Config/IsService 1 + + + Finally the iSCSI disk must be attached with the + option to tell the iSCSI initiator to + use internal networking, as follows: + + +$ VBoxManage storageattach ... --medium iscsi --server 10.0.9.30 \ +--target iqn.2008-12.com.sun:sampletarget --intnet + + + Compared to a regular iSCSI setup, the IP address of the target + must be specified as a numeric IP address, + as there is no DNS resolver for internal networking. + + + + The virtual machine with the iSCSI target should be started + before the VM using it is powered on. If a virtual machine using + an iSCSI disk is started without having the iSCSI target powered + up, it can take up to 200 seconds to detect this situation. The + VM will fail to power up. + + + + + + + + + Fine Tuning the &product-name; NAT Engine + + + + Configuring the Address of a NAT Network Interface + + + In NAT mode, the guest network interface is assigned to the IPv4 + range 10.0.x.0/24 + by default where x corresponds to the + instance of the NAT interface +2. So + x is 2 when there is only one NAT + instance active. In that case the guest is assigned to the + address 10.0.2.15, the gateway is set to + 10.0.2.2 and the name server can be found at + 10.0.2.3. + + + + If the NAT network needs to be changed, use the following + command: + + +$ VBoxManage modifyvm VM-name \ +--natnet1 "192.168/16" + + + This command would reserve the network addresses from + 192.168.0.0 to + 192.168.254.254 for the first NAT network + instance of VM-name The guest IP + would be assigned to 192.168.0.15 and the + default gateway could be found at + 192.168.0.2. + + + + + + + Configuring the Boot Server (Next Server) of a NAT Network Interface + + + For network booting in NAT mode, by default &product-name; uses + a built-in TFTP server at the IP address 10.0.2.4. This default + behavior should work fine for typical remote-booting scenarios. + However, it is possible to change the boot server IP and the + location of the boot image with the following commands: + + +$ VBoxManage modifyvm VM-name \ +--nattftpserver1 10.0.2.2 +$ VBoxManage modifyvm VM-name \ +--nattftpfile1 /srv/tftp/boot/MyPXEBoot.pxe + + + + + + Tuning TCP/IP Buffers for NAT + + + The &product-name; NAT stack performance is often determined by + its interaction with the host's TCP/IP stack and the size of + several buffers, SO_RCVBUF and + SO_SNDBUF. For certain setups users might + want to adjust the buffer size for a better performance. This + can by achieved using the following commands, where values are + in kilobytes and can range from 8 to 1024: + + +$ VBoxManage modifyvm VM-name \ +--natsettings1 16000,128,128,0,0 + + + This example illustrates tuning the NAT settings. The first + parameter is the MTU, then the size of the socket's send buffer + and the size of the socket's receive buffer, the initial size of + the TCP send window, and lastly the initial size of the TCP + receive window. Note that specifying zero means fallback to the + default value. + + + + Each of these buffers has a default size of 64KB and default MTU + is 1500. + + + + + + + Binding NAT Sockets to a Specific Interface + + + By default, &product-name;'s NAT engine will route TCP/IP + packets through the default interface assigned by the host's + TCP/IP stack. The technical reason for this is that the NAT + engine uses sockets for communication. If you want to change + this behavior, you can tell the NAT engine to bind to a + particular IP address instead. For example, use the following + command: + + +$ VBoxManage modifyvm VM-name \ +--natbindip1 "10.45.0.2" + + + After this, all outgoing traffic will be sent through the + interface with the IP address 10.45.0.2. Ensure that this + interface is up and running before changing the NAT bind + address. + + + + + + + Enabling DNS Proxy in NAT Mode + + + The NAT engine by default offers the same DNS servers to the + guest that are configured on the host. In some scenarios, it can + be desirable to hide the DNS server IPs from the guest, for + example when this information can change on the host due to + expiring DHCP leases. In this case, you can tell the NAT engine + to act as DNS proxy using the following command: + + +$ VBoxManage modifyvm VM-name --natdnsproxy1 on + + + + + + Using the Host's Resolver as a DNS Proxy in NAT Mode + + + For resolving network names, the DHCP server of the NAT engine + offers a list of registered DNS servers of the host. If for some + reason you need to hide this DNS server list and use the host's + resolver settings, thereby forcing the &product-name; NAT engine + to intercept DNS requests and forward them to host's resolver, + use the following command: + + +$ VBoxManage modifyvm VM-name --natdnshostresolver1 on + + + Note that this setting is similar to the DNS proxy mode, however + whereas the proxy mode just forwards DNS requests to the + appropriate servers, the resolver mode will interpret the DNS + requests and use the host's DNS API to query the information and + return it to the guest. + + + + + User-Defined Host Name Resolving + + + In some cases it might be useful to intercept the name + resolving mechanism, providing a user-defined IP address on a + particular DNS request. The intercepting mechanism enables the + user to map not only a single host but domains and even more + complex naming conventions if required. + + + + The following command sets a rule for mapping a name to a + specified IP: + + +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ +unique-rule-name-of-interception-rule/HostIP" IPv4 + +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ +unique-rule-name/HostName" hostname + + + The following command sets a rule for mapping a pattern name + to a specified IP: + + +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ +unique-rule-name/HostIP" IPv4 + +VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/{pcnet,e1000}/0/LUN#0/AttachedDriver/Config/HostResolverMappings/ \ +unique-rule-name/HostNamePattern" hostpattern + + + The host name pattern can include the following wildcard + characters: pipe (|), question mark + (?), and asterisk (*). + + + + This example demonstrates how to instruct the host-resolver + mechanism to resolve all domain and probably some mirrors of + www.blocked-site.info site with IP 127.0.0.1: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostIP" 127.0.0.1 +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/e1000/0/LUN#0/AttachedDriver/Config/HostResolverMappings/all_blocked_site/HostNamePattern" "*.blocked-site.*|*.fb.org" + + + The host resolver mechanism should be enabled to use + user-defined mapping rules, otherwise they do not have any + effect. + + + + + + + + + Configuring Aliasing of the NAT Engine + + + By default, the NAT core uses aliasing and uses random ports + when generating an alias for a connection. This works well for + the most protocols like SSH, FTP and so on. Though some + protocols might need a more transparent behavior or may depend + on the real port number the packet was sent from. You can change + the NAT mode by using the following commands: + + +$ VBoxManage modifyvm VM-name \ +--nataliasmode1 proxyonly + +$ VBoxManage modifyvm "Linux Guest" --nataliasmode1 sameports + + + The first example disables aliasing and switches NAT into + transparent mode, the second example enforces preserving of port + values. These modes can be combined if necessary. + + + + + + + + + Configuring the BIOS DMI Information + + + The DMI data that &product-name; provides to guests can be changed + for a specific VM. Use the following commands to configure the DMI + BIOS information. In case your VM is configured to use EFI + firmware you need to replace pcbios by + efi in the keys. + + + + + + + DMI BIOS information (type 0) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVendor" "BIOS Vendor" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSVersion" "BIOS Version" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseDate" "BIOS Release Date" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMajor" 1 +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSReleaseMinor" 2 +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMajor" 3 +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBIOSFirmwareMinor" 4 + + + + + DMI system information (type 1) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemVendor" "System Vendor" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemProduct" "System Product" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemVersion" "System Version" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial" "System Serial" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSKU" "System SKU" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemFamily" "System Family" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemUuid" \ +"9852bf98-b83c-49db-a8de-182c42c7226b" + + + + + DMI board information (type 2) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardVendor" "Board Vendor" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardProduct" "Board Product" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardVersion" "Board Version" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardSerial" "Board Serial" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardAssetTag" "Board Tag" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardLocInChass" "Board Location" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiBoardBoardType" 10 + + + + + DMI system enclosure or chassis (type 3) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiChassisVendor" "Chassis Vendor" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiChassisType" 3 +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiChassisVersion" "Chassis Version" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiChassisSerial" "Chassis Serial" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiChassisAssetTag" "Chassis Tag" + + + + + DMI processor information (type 4) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiProcManufacturer" "GenuineIntel" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiProcVersion" "Pentium(R) III" + + + + + DMI OEM strings (type 11) + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxVer" "vboxVer_1.2.3" +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiOEMVBoxRev" "vboxRev_12345" + + + + + + If a DMI string is not set, the default value of &product-name; is + used. To set an empty string use + "<EMPTY>". + + + + Note that in the above list, all quoted parameters (DmiBIOSVendor, + DmiBIOSVersion but not DmiBIOSReleaseMajor) are expected to be + strings. If such a string is a valid number, the parameter is + treated as number and the VM will most probably refuse to start + with an VERR_CFGM_NOT_STRING error. In that + case, use + "string:value". For + example: + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/pcbios/0/Config/DmiSystemSerial" "string:1234" + + + Changing this information can be necessary to provide the DMI + information of the host to the guest to prevent Windows from + asking for a new product key. On Linux hosts, the DMI BIOS + information can be obtained with the following command: + + +$ dmidecode -t0 + + + The DMI system information can be obtained as follows: + + +$ dmidecode -t1 + + + + + + Configuring Custom ACPI Tables + + + You can configure &product-name; to present up to four custom ACPI + tables to the guest. Use a command such as the following to + configure custom ACPI tables. Note that + CustomTable1, CustomTable2, + and CustomTable3 are available in addition to + CustomTable0. + + +$ VBoxManage setextradata VM-name \ +"VBoxInternal/Devices/acpi/0/Config/CustomTable0" "/path-to-table.bin" + + + Configuring custom ACPI tables can for example avoid the need for + asking for a new product key on Windows Vista, Windows 7, Windows + 8 and later guests. On Linux hosts, one of the system's ACPI + tables can be read from + /sys/firmware/acpi/tables/. + + + + + + + Fine Tuning Timers and Time Synchronization + + + + Configuring the Guest Time Stamp Counter (TSC) to Reflect Guest + Execution + + + By default, &product-name; keeps all sources of time visible to + the guest synchronized to a single time source, the monotonic + host time. This reflects the assumptions of many guest operating + systems, which expect all time sources to reflect "wall clock" + time. In special circumstances it may be useful however to make + the time stamp counter (TSC) in the guest reflect the time + actually spent executing the guest. + + + + This special TSC handling mode can be enabled on a per-VM basis, + and for best results must be used only in combination with + hardware virtualization. To enable this mode use the following + command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/TM/TSCTiedToExecution" 1 + + + To revert to the default TSC handling mode use: + + +$ VBoxManage setextradata VM-name "VBoxInternal/TM/TSCTiedToExecution" + + + Note that if you use the special TSC handling mode with a guest + operating system which is very strict about the consistency of + time sources you may get a warning or error message about the + timing inconsistency. It may also cause clocks to become + unreliable with some guest operating systems depending on how + they use the TSC. + + + + + + + Accelerate or Slow Down the Guest Clock + + + For certain purposes it can be useful to accelerate or to slow + down the virtual guest clock. This can be achieved as follows: + + +$ VBoxManage setextradata VM-name "VBoxInternal/TM/WarpDrivePercentage" 200 + + + The above example will double the speed of the guest clock while + + +$ VBoxManage setextradata VM-name "VBoxInternal/TM/WarpDrivePercentage" 50 + + + will halve the speed of the guest clock. Note that changing the + rate of the virtual clock can confuse the guest and can even + lead to abnormal guest behavior. For instance, a higher clock + rate means shorter timeouts for virtual devices with the result + that a slightly increased response time of a virtual device due + to an increased host load can cause guest failures. Note further + that any time synchronization mechanism will frequently try to + resynchronize the guest clock with the reference clock, which is + the host clock if the &product-name; Guest Additions are active. + Therefore any time synchronization should be disabled if the + rate of the guest clock is changed as described above. See + . + + + + + + + Tuning the Guest Additions Time Synchronization Parameters + + + The &product-name; Guest Additions ensure that the guest's + system time is synchronized with the host time. There are + several parameters which can be tuned. The parameters can be set + for a specific VM using the following command: + + +$ VBoxManage guestproperty set VM-name "/VirtualBox/GuestAdd/VBoxService/property" value + + + property is one of the following: + + + + + + + + + + + + Specifies the interval at which to synchronize the time + with the host. The default is 10000 ms (10 seconds). + + + + + + + + + + + + The minimum absolute drift value measured in milliseconds + to make adjustments for. The default is 1000 ms on OS/2 + and 100 ms elsewhere. + + + + + + + + + + + + The factor to multiply the time query latency with to + calculate the dynamic minimum adjust time. The default is + 8 times, which means as follows: + + + + Measure the time it takes to determine the host time, the + guest has to contact the VM host service which may take + some time. Multiply this value by 8 and do an adjustment + only if the time difference between host and guest is + bigger than this value. Do not do any time adjustment + otherwise. + + + + + + + + + + + + The max host timer query latency to accept. The default is + 250 ms. + + + + + + + + + + + + The absolute drift threshold, given as milliseconds where + to start setting the time instead of trying to smoothly + adjust it. The default is 20 minutes. + + + + + + + + + + + + Set the time when starting the time sync service. + + + + + + + + + + + + Set the time after the VM was restored from a saved state + when passing 1 as parameter. This is the default. Disable + by passing 0. In the latter case, the time will be + adjusted smoothly, which can take a long time. + + + + + + + + All these parameters can be specified as command line parameters + to VBoxService as well. + + + + + + + Disabling the Guest Additions Time Synchronization + + + Once installed and started, the &product-name; Guest Additions + will try to synchronize the guest time with the host time. This + can be prevented by forbidding the guest service from reading + the host clock: + + +$ VBoxManage setextradata VM-name "VBoxInternal/Devices/VMMDev/0/Config/GetHostTimeDisabled" 1 + + + + + + + + Installing the Alternate Bridged Networking Driver on Oracle Solaris 11 + Hosts + + + &product-name; includes a network filter driver that utilizes + Oracle Solaris 11's Crossbow functionality. By default, this new + driver is installed for Oracle Solaris 11 hosts that have support + for it. + + + + To force installation of the older STREAMS based network filter + driver, execute as root the following command before installing + the &product-name; package: + + +$ touch /etc/vboxinst_vboxflt + + + To force installation of the Crossbow based network filter driver, + execute as root the following command before installing the + &product-name; package: + + +$ touch /etc/vboxinst_vboxbow + + + To check which driver is currently being used by &product-name;, + execute: + + +$ modinfo | grep vbox + + + If the output contains "vboxbow", it indicates &product-name; is + using the Crossbow network filter driver, while the name "vboxflt" + indicates usage of the older STREAMS network filter. + + + + + + + &product-name; VNIC Templates for VLANs on Oracle Solaris 11 Hosts + + + &product-name; supports Virtual Network Interface (VNIC) templates + for configuring VMs over VLANs. An &product-name; VNIC template is + a VNIC whose name starts with + vboxvnic_template. The string is + case-sensitive. + + + + On Oracle Solaris 11 hosts, when Crossbow-based bridged networking + is used, a VNIC template may be used to specify the VLAN ID to use + while bridging over a network link. + + + + The following is an example of how to use a VNIC template to + configure a VM over a VLAN. Create an &product-name; VNIC + template, by executing as root: + + +# dladm create-vnic -t -l nge0 -v 23 vboxvnic_template0 + + + This will create a temporary VNIC template over interface + nge0 with the VLAN ID 23. To create VNIC + templates that are persistent across host reboots, skip the + parameter in the above command. You may check + the current state of links using the following command: + + +$ dladm show-link +LINK CLASS MTU STATE BRIDGE OVER +nge0 phys 1500 up -- -- +nge1 phys 1500 down -- -- +vboxvnic_template0 vnic 1500 up -- nge0 + +$ dladm show-vnic +LINK OVER SPEED MACADDRESS MACADDRTYPE VID +vboxvnic_template0 nge0 1000 2:8:20:25:12:75 random 23 + + + Once the VNIC template is created, any VMs that need to be on VLAN + 23 over the interface nge0 can be configured to + bridge using this VNIC template. + + + + VNIC templates makes managing VMs on VLANs simpler and efficient. + The VLAN details are not stored as part of every VM's + configuration but rather inherited from the VNIC template while + starting the VM. The VNIC template itself can be modified anytime + using the dladm command. + + + + VNIC templates can be created with additional properties such as + bandwidth limits and CPU fanout. Refer to your Oracle Solaris + network documentation for details. The additional properties are + also applied to VMs which bridge using the VNIC template. + + + + + + + Configuring Multiple Host-Only Network Interfaces on Oracle Solaris + Hosts + + + By default &product-name; provides you with one host-only network + interface. Adding more host-only network interfaces on Oracle + Solaris hosts requires manual configuration. Here is how to add + another host-only network interface. + + + + Begin by stopping all running VMs. Then, unplumb the existing + "vboxnet0" interface by execute the following command as root: + + +# ifconfig vboxnet0 unplumb + + + If you have several vboxnet interfaces, you will need to unplumb + all of them. Once all vboxnet interfaces are unplumbed, remove the + driver by executing the following command as root: + + +# rem_drv vboxnet + + + Edit the file + /platform/i86pc/kernel/drv/vboxnet.conf and + add a line for the new interface we want to add as shown below: + + +name="vboxnet" parent="pseudo" instance=1; +name="vboxnet" parent="pseudo" instance=2; + + + Add as many of these lines as required with each line having a + unique instance number. + + + + Next, reload the vboxnet driver by executing the following command + as root: + + +# add_drv vboxnet + + + On Oracle Solaris 11.1 and newer hosts you may want to rename the + default vanity interface name. To check what name has been + assigned, execute: + + +$ dladm show-phys +LINK MEDIA STATE SPEED DUPLEX DEVICE +net0 Ethernet up 100 full e1000g0 +net2 Ethernet up 1000 full vboxnet1 +net1 Ethernet up 1000 full vboxnet0 + + + In the above example, we can rename "net2" to "vboxnet1" before + proceeding to plumb the interface. This can be done by executing + as root: + + +# dladm rename-link net2 vboxnet1 + + + Now plumb all the interfaces using ifconfig + vboxnetX plumb, where + X would be 1 in this case. Once the + interface is plumbed, it may be configured like any other network + interface. Refer to the ifconfig documentation + for further details. + + + + To make the settings for the newly added interfaces persistent + across reboots, you will need to edit the files + /etc/inet/netmasks, and if you are using NWAM + /etc/nwam/llp and add the appropriate entries + to set the netmask and static IP for each of those interfaces. The + &product-name; installer only updates these configuration files + for the one "vboxnet0" interface it creates by default. + + + + + + + Configuring the &product-name; CoreDumper on Oracle Solaris Hosts + + + &product-name; is capable of producing its own core files for + extensive debugging when things go wrong. Currently this is only + available on Oracle Solaris hosts. + + + + The &product-name; CoreDumper can be enabled using the following + command: + + +$ VBoxManage setextradata VM-name VBoxInternal2/CoreDumpEnabled 1 + + + You can specify which directory to use for core dumps with this + command, as follows: + + +$ VBoxManage setextradata VM-name VBoxInternal2/CoreDumpDir path-to-directory + + + Make sure the directory you specify is on a volume with sufficient + free space and that the &product-name; process has sufficient + permissions to write files to this directory. If you skip this + command and do not specify any core dump directory, the current + directory of the &product-name; executable will be used. This + would most likely fail when writing cores as they are protected + with root permissions. It is recommended you explicitly set a core + dump directory. + + + + You must specify when the &product-name; CoreDumper should be + triggered. This is done using the following commands: + + +$ VBoxManage setextradata VM-name VBoxInternal2/CoreDumpReplaceSystemDump 1 +$ VBoxManage setextradata VM-name VBoxInternal2/CoreDumpLive 1 + + + At least one of the above two commands will have to be provided if + you have enabled the &product-name; CoreDumper. + + + + Setting CoreDumpReplaceSystemDump sets up the + VM to override the host's core dumping mechanism and in the event + of any crash only the &product-name; CoreDumper would produce the + core file. + + + + Setting CoreDumpLive sets up the VM to produce + cores whenever the VM process receives a + SIGUSR2 signal. After producing the core file, + the VM will not be terminated and will continue to run. You can + thus take cores of the VM process using the following command: + + +$ kill -s SIGUSR2 VM-process-id + + + The &product-name; CoreDumper creates core files of the form + core.vb.process-name.process-ID + such as core.vb.VBoxHeadless.11321. + + + + + + + &product-name; and Oracle Solaris Kernel Zones + + + Oracle Solaris kernel zones on x86-based systems make use of + hardware-assisted virtualization features like &product-name; + does. However, for kernel zones and &product-name; to share this + hardware resource, they need to cooperate. + + + + By default, due to performance reasons, &product-name; acquires + the hardware-assisted virtualization resource (VT-x/AMD-V) + globally on the host machine and uses it until the last + &product-name; VM that requires it is powered off. This prevents + other software from using VT-x/AMD-V during the time + &product-name; has taken control of it. + + + + &product-name; can be instructed to relinquish use of + hardware-assisted virtualization features when not executing guest + code, thereby allowing kernel zones to make use of them. To do + this, shutdown all &product-name; VMs and execute the following + command: + + +$ VBoxManage setproperty hwvirtexclusive off + + + This command needs to be executed only once as the setting is + stored as part of the global &product-name; settings which will + continue to persist across host-reboots and &product-name; + upgrades. + + + + + + + Locking Down the &product-name; GUI + + + + Customizing the VirtualBox Manager + + + There are several advanced customization settings for locking + down the VirtualBox Manager. Locking down means removing some + features that the user should not see. + + +VBoxManage setextradata global GUI/Customizations property[,property ...] + + + property is one of the following + properties: + + + + + + + noSelector + + + + + Do not allow users to start the VirtualBox Manager. Trying + to do so will show a window containing a proper error + message. + + + + + + + noMenuBar + + + + + VM windows will not contain a menu bar. + + + + + + + noStatusBar + + + + + VM windows will not contain a status bar. + + + + + + + + To disable any of these VirtualBox Manager customizations use + the following command: + + +$ VBoxManage setextradata global GUI/Customizations + + + + + + VM Selector Customization + + + The following per-machine VM extradata settings can be used to + change the behavior of the VM selector window in respect of + certain VMs: + + +$ VBoxManage setextradata VM-name property true + + + property can be any of the following: + + + + + + + GUI/HideDetails + + + + + Do not show the VM configuration of a certain VM. The + details window will remain just empty if this VM is + selected. + + + + + + + GUI/PreventReconfiguration + + + + + Do not allow the user to open the + Settings dialog for a + certain VM. + + + + + + + GUI/PreventSnapshotOperations + + + + + Prevent snapshot operations for a VM from the GUI, either + at runtime or when the VM is powered off. + + + + + + + GUI/HideFromManager + + + + + Hide a certain VM in the VM selector window. + + + + + + + GUI/PreventApplicationUpdate + + + + + Disable the automatic update check and hide the + corresponding menu item. + + + + + + + + Note that these settings do not prevent the user from + reconfiguring the VM by using the VBoxManage + modifyvm command. + + + + + + + Configure VM Selector Menu Entries + + + You can disable certain entries in the global settings page of + the VM selector: + + +$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages property[,property...] + + + property is one of the following: + + + + + + + General + + + + + Do not show the General + settings pane. + + + + + + + Input + + + + + Do not show the Input + settings pane. + + + + + + + Update + + + + + Do not show the Update + settings pane. + + + + + + + Language + + + + + Do not show the Language + settings pane. + + + + + + + Display + + + + + Do not show the Display + settings pane. + + + + + + + Network + + + + + Do not show the Network + settings pane. + + + + + + + Extensions + + + + + Do not show the + Extensions settings pane. + + + + + + + Proxy + + + + + Do not show the Proxy + settings pane. + + + + + + + + This is a global setting. You can specify any combination of + properties. To restore the default behavior, use the following + command: + + +$ VBoxManage setextradata global GUI/RestrictedGlobalSettingsPages + + + + + + Configure VM Window Menu Entries + + + You can disable certain menu actions in the VM window: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + All + + + + + Do not show any menu in the VM window. + + + + + + + Application + + + + + Do not show + Application/File menu in + the VM window. + + + + + + + Machine + + + + + Do not show the Machine + menu in the VM window. + + + + + + + View + + + + + Do not show the View menu + in the VM window. + + + + + + + Input + + + + + Do not show Input menu in + the VM window. + + + + + + + Devices + + + + + Do not show the Devices + menu in the VM window. + + + + + + + Help + + + + + Do not show the Help menu + in the VM window. + + + + + + + Debug + + + + + Do not show the Debug + menu in the VM window. The Debug menu is only visible if + the GUI was started with special command line parameters + or environment variable settings. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use the following + command: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus + + + You can also disable certain menu actions of certain menus. Use + the following command to disable certain actions of the + Application menu. This is only + available on Mac OS X hosts. + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeApplicationMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + About + + + + + Do not show the About + menu item in this menu. + + + + + + + Preferences + + + + + Do not show the + Preferences menu item in + this menu. + + + + + + + NetworkAccessManager + + + + + Do not show the Network Operations + Manager menu item in this menu. + + + + + + + ResetWarnings + + + + + Do not show the Reset All + Warnings menu item in this menu. + + + + + + + Close + + + + + Do not show the Close + menu item in this menu. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use the following + command: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMenus + + + Use the following command to disable certain actions of the + Machine menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMachineMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + SettingsDialog + + + + + Do not show the Settings + menu item in this menu. + + + + + + + TakeSnapshot + + + + + Do not show the Take + Snapshot... menu item in this menu. + + + + + + + InformationDialog + + + + + Do not show the Session + Information... menu item in this menu. + + + + + + + FileManagerDialog + + + + + Do not show the File + Manager... menu item in this menu. + + + + + + + Pause + + + + + Do not show the Pause + menu item in this menu. + + + + + + + Reset + + + + + Do not show the Reset + menu item in this menu. + + + + + + + Shutdown + + + + + Do not show the ACPI + Shutdown menu item in this menu. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeMachineMenuActions + + + Use the following command to disable certain actions of the + View menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeViewMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + Fullscreen + + + + + Do not show the Full-screen + Mode menu item in this menu. + + + + + + + Seamless + + + + + Do not show the Seamless + Mode menu item in this menu. + + + + + + + Scale + + + + + Do not show the Scaled + Mode menu item in this menu. + + + + + + + GuestAutoresize + + + + + Do not show the Auto-resize Guest + Display menu item in this menu. + + + + + + + AdjustWindow + + + + + Do not show the Adjust Window + Size menu item in this menu. + + + + + + + TakeScreenshot + + + + + Do not show the Take + Screenshot... menu item in this menu. + + + + + + + Recording + + + + + Do not show the Recording + menu item in this menu. + + + + + + + VRDEServer + + + + + Do not show the Remote + Display menu item in this menu. + + + + + + + MenuBar + + + + + Do not show the Menu Bar + menu item in this menu. + + + + + + + MenuBarSettings + + + + + Do not show the Menu Bar + Settings... menu item in this menu. + + + + + + + StatusBar + + + + + Do not show the Status + Bar menu item in this menu. + + + + + + + StatusbarSettings + + + + + Do not show the Statusbar + Settings... menu item in this menu. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeViewMenuActions + + + Use the following command to disable certain actions of the + Input menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + Keyboard + + + + + Do not show the Keyboard + menu item in this menu. + + + + + + + KeyboardSettings + + + + + Do not show the Keyboard + Settings... menu item in this menu. + + + + + + + SoftKeyboard + + + + + Do not show the Soft + Keyboard... menu item in this menu. + + + + + + + TypeCAD + + + + + Do not show the Insert + Ctrl-Alt-Del menu item in this menu. + + + + + + + TypeCABS + + + + + Do not show the Insert + Ctrl-Alt-Backspace menu item in this menu. + + + + + + + TypeCtrlBreak + + + + + Do not show the Insert + Ctrl-Break menu item in this menu. + + + + + + + TypeInsert + + + + + Do not show the Insert + Insert menu item in this menu. + + + + + + + TypePrintScreen + + + + + Do not show the Insert Print + Screen menu item in this menu. + + + + + + + TypeAltPrintScreen + + + + + Do not show the Insert Alt Print + Screen menu item in this menu. + + + + + + + TypeHostKeyCombo + + + + + Do not show the Insert Host Key + Combo menu item in this menu. + + + + + + + MouseIntegration + + + + + Do not show the + MouseIntegration menu + item in this menu. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeInputMenuActions + + + Use the following command to disable certain actions of the + Devices menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeDevicesMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following keywords + to disable actions in the + Devices menu: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + HardDrives + + + + + Do not show the Hard + Disks menu item in this menu. + + + + + + + OpticalDevices + + + + + Do not show the Optical + Devices menu item in this menu. + + + + + + + FloppyDevices + + + + + Do not show the Floppy + Drives menu item in this menu. + + + + + + + Audio + + + + + Do not show the Audio + menu item in this menu. + + + + + + + Network + + + + + Do not show the Network + menu item in this menu. + + + + + + + NetworkSettings + + + + + Do not show the Network + Settings menu item in this menu. + + + + + + + USBDevices + + + + + Do not show the USB menu + item in this menu. + + + + + + + WebCams + + + + + Do not show the WebCams + menu item in this menu. + + + + + + + SharedFolders + + + + + Do not show the Shared + Folders menu item in this menu. + + + + + + + SharedFoldersSettings + + + + + Do not show the Shared Folders + Settings... menu item in this menu. + + + + + + + SharedClipboard + + + + + Do not show the Shared + Clipboard menu item in this menu. + + + + + + + DragAndDrop + + + + + Do not show the Drag and + Drop menu item in this menu. + + + + + + + InstallGuestTools + + + + + Do not show the Insert Guest + Additions CD image... menu item in this menu. + + + + + + + + This is a per-VM or global or global setting. Any combination of + the above is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeDevicesMenuActions + + + Use the following command to disable certain actions of the + Debug menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeDebuggerMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following keywords + to disable actions in the Debug menu, which + is normally completely disabled: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + Statistics + + + + + Do not show the + Statistics... menu item + in this menu. + + + + + + + CommandLine + + + + + Do not show the Command + Line... menu item in this menu. + + + + + + + Logging + + + + + Do not show the + Logging... menu item in + this menu. + + + + + + + LogDialog + + + + + Do not show the Show + Log... menu item in this menu. + + + + + + + GuestControlConsole + + + + + Do not show the Guest Control + Terminal... menu item in this menu. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeDebuggerMenuActions + + + Use the following command to disable certain actions of the + View menu: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeHelpMenuActions OPTION[,OPTION...] + + + where OPTION is one of the following keywords + to disable actions in the Help + menu, which is normally completely disabled: + + + + + + + All + + + + + Do not show any menu item in this menu. + + + + + + + Contents + + + + + Do not show the + Contents... menu item in + this menu. + + + + + + + WebSite + + + + + Do not show the VirtualBox Web + Site... menu item in this menu. + + + + + + + BugTracker + + + + + Do not show the VirtualBox Bug + Tracker... menu item in this menu. + + + + + + + Forums + + + + + Do not show the VirtualBox + Forums... menu item in this menu. + + + + + + + Oracle + + + + + Do not show the Oracle Web + Site... menu item in this menu. + + + + + + + About + + + + + Do not show the About + VirtualBox... menu item in this menu. Only for + non-Mac OS X hosts. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. To restore the default behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedRuntimeHelpMenuActions + + + + + + Configure VM Window Status Bar Entries + + + You can disable certain status bar items: + + +VBoxManage setextradata "VM name"|global GUI/RestrictedStatusBarIndicators OPTION[,OPTION...] + + + where OPTION is one of the following + keywords: + + + + + + + HardDisks + + + + + Do not show the hard disk icon in the VM window status + bar. By default the hard disk icon is only shown if the VM + configuration contains one or more hard disks. + + + + + + + OpticalDisks + + + + + Do not show the CD icon in the VM window status bar. By + default the CD icon is only shown if the VM configuration + contains one or more CD drives. + + + + + + + FloppyDisks + + + + + Do not show the floppy icon in the VM window status bar. + By default the floppy icon is only shown if the VM + configuration contains one or more floppy drives. + + + + + + + Network + + + + + Do not show the network icon in the VM window status bar. + By default the network icon is only shown if the VM + configuration contains one or more active network + adapters. + + + + + + + USB + + + + + Do not show the USB icon in the status bar. + + + + + + + SharedFolders + + + + + Do not show the shared folders icon in the status bar. + + + + + + + Capture + + + + + Do not show the capture icon in the status bar. + + + + + + + Features + + + + + Do not show the CPU features icon in the status bar. + + + + + + + Mouse + + + + + Do not show the mouse icon in the status bar. + + + + + + + Keyboard + + + + + Do not show the keyboard icon in the status bar. + + + + + + + + This is a per-VM or global setting. Any combination of the above + is allowed. If all options are specified, no icons are displayed + in the status bar of the VM window. To restore the default + behavior, use + + +VBoxManage setextradata "VM name"|global GUI/RestrictedStatusBarIndicators + + + + + + Configure VM Window Visual Modes + + + You can disable certain VM visual modes: + + +$ VBoxManage setextradata VM-name GUI/RestrictedVisualStates property[,property...] + + + property is one of the following: + + + + + + + Fullscreen + + + + + Do not allow to switch the VM into full screen mode. + + + + + + + Seamless + + + + + Do not allow to switch the VM into seamless mode. + + + + + + + Scale + + + + + Do not allow to switch the VM into scale mode. + + + + + + + + This is a per-VM setting. You can specify any combination of + properties. To restore the default behavior, use the following + command: + + +$ VBoxManage setextradata VM-name GUI/RestrictedVisualStates + + + + + + Host Key Customization + + + To disable all Host key combinations, open the preferences and + change the Host key to None. This might be useful when using + &product-name; in a kiosk mode. + + + + To redefine or disable certain Host key actions, use the + following command: + + +$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=F,...." + + + The following table shows the possible Host key actions, + together with their default Host key shortcut. Setting an action + to None will disable that Host key action. + + + + Host Key Customization + + + + + Action + + + Default Key + + + Action + + + + + + + TakeSnapshot + + + T + + + Take a snapshot + + + + + TakeScreenshot + + + E + + + Take a screenshot + + + + + MouseIntegration + + + I + + + Toggle mouse integration + + + + + TypeCAD + + + Del + + + Inject Ctrl+Alt+Del + + + + + TypeCABS + + + Backspace + + + Inject Ctrl+Alt+Backspace + + + + + Pause + + + P + + + Pause the VM + + + + + Reset + + + R + + Hard reset the guest + + + + SaveState + + + + Save the VM state and terminate the VM + + + + + Shutdown + + + H + + + Press the virtual ACPI power button + + + + + PowerOff + + + + Power off the VM without saving the state + + + + + Close + + + Q + + + Show the Close VM dialog + + + + + FullscreenMode + + + F + + + Switch the VM into full screen mode + + + + + SeamlessMode + + + L + + + Switch the VM into seamless mode + + + + + ScaleMode + + + C + + + Switch the VM into scaled mode + + + + + GuestAutoResize + + + G + + + Automatically resize the guest window + + + + + WindowAdjust + + + A + + + Immediately resize the guest window + + + + + PopupMenu + + + Home + + + Show the popup menu in full screen mode and seamless + mode + + + + + SettingsDialog + + + S + + + Open the VM Settings dialog + + + + + InformationDialog + + + N + + + Show the VM Session Information window + + + + + NetworkAdaptersDialog + + + + Show the VM Network Adapters dialog + + + + + SharedFoldersDialog + + + + Show the VM Shared Folders dialog + + + + + InstallGuestAdditions + + + D + + + Mount the ISO containing the Guest Additions + + + + +
+ + + To disable full screen mode and seamless mode, use the following + command: + + +$ VBoxManage setextradata global GUI/Input/MachineShortcuts "FullscreenMode=None,SeamlessMode=None" + + + + + + Action when Terminating the VM + + + You can disallow certain actions when terminating a VM. To + disallow specific actions, use the following command: + + +$ VBoxManage setextradata VM-name GUI/RestrictedCloseActions property[,property...] + + + property is one of the following: + + + + + + + SaveState + + + + + Do not allow the user to save the VM state when + terminating the VM. + + + + + + + Shutdown + + + + + Do not allow the user to shutdown the VM by sending the + ACPI power-off event to the guest. + + + + + + + PowerOff + + + + + Do not allow the user to power off the VM. + + + + + + + PowerOffRestoringSnapshot + + + + + Do not allow the user to return to the last snapshot when + powering off the VM. + + + + + + + Detach + + + + + Do not allow the user to detach from the VM process if the + VM was started in separate mode. + + + + + + + + This is a per-VM setting. You can specify any combination of + properties. If all properties are specified, the VM cannot be + shut down. + + + + + + + Default Action when Terminating the VM + + + You can define a specific action for terminating a VM. In + contrast to the setting decribed in the previous section, this + setting allows only one action when the user terminates the VM. + No exit menu is shown. Use the following command: + + +$ VBoxManage setextradata VM-name GUI/DefaultCloseAction action + + + action is one of the following: + + + + + + + SaveState + + + + + Save the VM state before terminating the VM process. + + + + + + + Shutdown + + + + + The VM is shut down by sending the ACPI power-off event to + the guest. + + + + + + + PowerOff + + + + + The VM is powered off. + + + + + + + PowerOffRestoringSnapshot + + + + + The VM is powered off and the saved state returns to the + last snapshot. + + + + + + + Detach + + + + + Terminate the frontend but leave the VM process running. + + + + + + + + This is a per-VM setting. You can specify any combination of + properties. If all properties are specified, the VM cannot be + shut down. + + + + + + + Action for Handling a Guru Meditation + + + A VM runs into a Guru Meditation if there is a problem which + cannot be fixed by other means than terminating the process. The + default is to show a message window which instructs the user to + open a bug report. + + + + This behavior can be configured as follows: + + +$ VBoxManage setextradata VM-name GUI/GuruMeditationHandler mode + + + mode is one of the following: + + + + + + + Default + + + + + A message window is shown. After the user confirmed, the + VM is terminated. + + + + + + + PowerOff + + + + + The VM is immediately powered-off without showing any + message window. The VM logfile will show information about + what happened. + + + + + + + Ignore + + + + + The VM is left in stuck mode. Execution is stopped but no + message window is shown. The VM has to be powered off + manually. + + + + + + + + This is a per-VM setting. + + + + + + + Configuring Automatic Mouse Capturing + + + By default, the mouse is captured if the user clicks on the + guest window and the guest expects relative mouse coordinates at + this time. This happens if the pointing device is configured as + PS/2 mouse and the guest has not yet started the &product-name; + Guest Additions. For instance, the guest is booting or the Guest + Additions are not installed, or if the pointing device is + configured as a USB tablet but the guest has no USB driver + loaded yet. Once the Guest Additions become active or the USB + guest driver is started, the mouse capture is automatically + released. + + + + The default behavior is sometimes not desired. Therefore it can + be configured as follows: + + +VBoxManage setextradata VM-name GUI/MouseCapturePolicy mode + + + mode is one of the following: + + + + + + + Default + + + + + The default behavior as described above. + + + + + + + HostComboOnly + + + + + The mouse is only captured if the Host Key is toggled. + + + + + + + Disabled + + + + + The mouse is never captured, also not by toggling the Host + Key + + + + + + + + This is a per-VM setting. + + + + + + + Requesting Legacy Full-Screen Mode + + + &product-name; uses special window manager facilities to switch + a multi-screen machine to full-screen on a multi-monitor host + system. However, not all window managers provide these + facilities correctly. &product-name; can be configured to use a + legacy method of switching to full-screen mode instead, by using + the command: + + +VBoxManage setextradata global GUI/Fullscreen/LegacyMode true + + + You can go back to the default method by using the following + command: + + +VBoxManage setextradata global GUI/Fullscreen/LegacyMode + + + This is a global setting. + + + + + + + Removing Certain Modes of Networking From the GUI + + + It is possible to remove networking modes from &product-name; + GUI. To do this, use the following command: + + +VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes property[,property...] + + + property is one of the following: + + + + + + + NAT + + + + + Remove the NAT option + from the GUI. + + + + + + + NATNetwork + + + + + Remove the NAT network + option from the GUI. + + + + + + + BridgedAdapter + + + + + Remove the Bridged + networking option from the GUI. + + + + + + + InternalNetwork + + + + + Remove the Internal + networking option from the GUI. + + + + + + + HostOnlyAdapter + + + + + Remove the Host Only + networking option from the GUI. + + + + + + + GenericDriver + + + + + Remove the Generic + networking option from the GUI. + + + + + + + + This is a global setting. You can specify any combination of + properties. To restore the default behavior, use the following + command: + + +VBoxManage setextradata global GUI/RestrictedNetworkAttachmentTypes + + + + + + + + Starting the &product-name; Web Service Automatically + + + The &product-name; web service, vboxwebsrv, is + used for controlling &product-name; remotely. It is documented in + detail in the &product-name; Software Development Kit (SDK). See + . Web service start scripts are + available for supported host operating systems. The following + sections describe how to use the scripts. The &product-name; web + service is never started automatically as a result of a standard + installation. + + + + + Linux: Starting the Web Service With init + + + On Linux, the web service can be automatically started during + host boot by adding appropriate parameters to the file + /etc/default/virtualbox. There is one + mandatory parameter, VBOXWEB_USER, which must + be set to the user which will later start the VMs. The + parameters in the following table all start with the + VBOXWEB_ prefix string. For example: + VBOXWEB_HOST and + VBOXWEB_PORT. + + + + Web Service Configuration Parameters + + + + + Parameter + + + Description + + + Default + + + + + + + USER + + + The user which the web service runs as + + + + + + HOST + + + The host to bind the web service to + + + localhost + + + + + PORT + + + The port to bind the web service to + + + 18083 + + + + + SSL_KEYFILE + + + Server key and certificate file, in PEM format + + + + + + SSL_PASSWORDFILE + + + File name for password to server key + + + + + + SSL_CACERT + + + CA certificate file, in PEM format + + + + + + SSL_CAPATH + + + CA certificate path + + + + + + SSL_DHFILE + + + DH file name or DH key length in bits + + + + + + SSL_RANDFILE + + + File containing seed for random number generator + + + + + + TIMEOUT + + + Session timeout in seconds, 0 disables timeouts + + + 300 + + + + + CHECK_INTERVAL + + + Frequency of timeout checks in seconds + + + 5 + + + + + THREADS + + + Maximum number of worker threads to run in parallel + + + 100 + + + + + KEEPALIVE + + + Maximum number of requests before a socket will be + closed + + + 100 + + + + + ROTATE + + + Number of log files, 0 disables log rotation + + + 10 + + + + + LOGSIZE + + + Maximum log file size to trigger rotation, in bytes + + + 1MB + + + + + LOGINTERVAL + + + Maximum time interval to trigger log rotation, in + seconds + + + 1 day + + + + +
+ + + Setting the parameter SSL_KEYFILE enables the + SSL/TLS support. Using encryption is strongly encouraged, as + otherwise everything, including passwords, is transferred in + clear text. + + + + + + + Oracle Solaris: Starting the Web Service With SMF + + + On Oracle Solaris hosts, the &product-name; web service daemon + is integrated into the SMF framework. You can change the + parameters, but do not have to if the defaults below already + match your needs: + + +svccfg -s svc:/application/virtualbox/webservice:default setprop config/host=localhost +svccfg -s svc:/application/virtualbox/webservice:default setprop config/port=18083 +svccfg -s svc:/application/virtualbox/webservice:default setprop config/user=root + + + The table in showing the + parameter names and defaults also applies for Oracle Solaris. + The parameter names must be changed to lowercase and a prefix of + config/ has to be added. For example: + config/user or + config/ssl_keyfile. If you make any change, + do not forget to run the following command to put the changes + into effect immediately: + + +svcadm refresh svc:/application/virtualbox/webservice:default + + + If you forget the above command then the previous settings are + used when enabling the service. Check the current property + settings as follows: + + +svcprop -p config svc:/application/virtualbox/webservice:default + + + When everything is configured correctly you can start the + &product-name; web service with the following command: + + +svcadm enable svc:/application/virtualbox/webservice:default + + + For more information about SMF, please refer to the Oracle + Solaris documentation. + + + + + + + Mac OS X: Starting the Web Service With launchd + + + On Mac OS X, launchd is used to start the &product-name; + webservice. An example configuration file can be found in + $HOME/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist. + It can be enabled by changing the Disabled + key from true to false. To + manually start the service use the following command: + + +launchctl load ~/Library/LaunchAgents/org.virtualbox.vboxwebsrv.plist + + + For additional information on how launchd services could be + configured see: + + + + . + + + + + + + + + &product-name; Watchdog + + + The memory ballooning service, formerly known as + VBoxBalloonCtrl, was renamed to VBoxWatchdog. + This service now incorporates the following host services that are + meant to be run in a server environment: + + + + + + + Memory ballooning control. + This service automatically takes care of a VM's configured + memory balloon. See . This + service is useful for server environments where VMs may + dynamically require more or less memory during runtime. + + + + The service periodically checks a VM's current memory balloon + and its free guest RAM and automatically adjusts the current + memory balloon by inflating or deflating it accordingly. This + handling only applies to running VMs having recent Guest + Additions installed. + + + + + + Host isolation detection. + This service provides a way to detect whether the host cannot + reach the specific &product-name; server instance anymore and + take appropriate actions, such as shutting down, saving the + current state or even powering down certain VMs. + + + + + + + All configuration values can be either specified using the command + line or global extradata, whereas command line values always have + a higher priority when set. Some of the configuration values also + be specified on a per-VM basis. So the overall lookup order is: + command line, per-VM basis extradata if available, global + extradata. + + + + + Memory Ballooning Control + + + The memory ballooning control inflates and deflates the memory + balloon of VMs based on the VMs free memory and the desired + maximum balloon size. + + + + To set up the memory ballooning control the maximum ballooning + size a VM can reach needs to be set. This can be specified using + the command line, as follows: + + +--balloon-max <Size in MB> + + + Using a per-VM basis extradata value, as follows: + + +VBoxManage setextradata <VM-Name> VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax <Size in MB> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonSizeMax <Size in MB> + + + + If no maximum ballooning size is specified by at least one of + the parameters above, no ballooning will be performed at all. + + + + + Setting the ballooning increment in MB can be either done using + command line, as follows: + + +--balloon-inc <Size in MB> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonIncrementMB <Size in MB> + + + The default ballooning increment is 256 MB if not specified. + + + + The same options apply for a ballooning decrement. Using the + command line, as follows: + + +--balloon-dec <Size in MB> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonDecrementMB <Size in MB> + + + The default ballooning decrement is 128 MB if not specified. + + + + The lower limit in MB for a balloon can be defined using the + command line, as follows: + + +--balloon-lower-limit <Size in MB> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/BalloonCtrl/BalloonLowerLimitMB <Size in MB> + + + The default lower limit is 128 MB if not specified. + + + + + + + Host Isolation Detection + + + To detect whether a host is being isolated, that is, the host + cannot reach the &product-name; server instance anymore, the + host needs to set an alternating value to a global extradata + value within a time period. If this value is not set within that + time period a timeout occurred and the so-called host isolation + response will be performed to the VMs handled. Which VMs are + handled can be controlled by defining VM groups and assigning + VMs to those groups. By default no groups are set, meaning that + all VMs on the server will be handled when no host response is + received within 30 seconds. + + + + Set the groups handled by the host isolation detection using the + following command line: + + +--apimon-groups=<string[,stringN]> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/Groups <string[,stringN]> + + + Set the host isolation timeout using the following command line: + + +--apimon-isln-timeout=<ms> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationTimeoutMS <ms> + + + Set the actual host isolation response using the following + command line: + + +--apimon-isln-response=<cmd> + + + Using a global extradata value, as follows: + + +VBoxManage setextradata global VBoxInternal2/Watchdog/APIMonitor/IsolationResponse <cmd> + + + The following response commands are available: + + + + + + + none. This has no effect. + + + + + + pause. Pauses the execution of a VM. + + + + + + poweroff. Shuts down the VM by pressing + the virtual power button. The VM will not have the chance of + saving any data or veto the shutdown process. + + + + + + save. Saves the current machine state and + powers off the VM afterwards. If saving the machine state + fails the VM will be paused. + + + + + + shutdown. Shuts down the VM in a gentle + way by sending an ACPI shutdown event to + the VM's operating system. The OS then has the chance of + doing a clean shutdown. + + + + + + + + + + More Information + + + For more advanced options and parameters like verbose logging + check the built-in command line help accessible with + . + + + + + + + Linux: Starting the Watchdog Service With init + + + On Linux, the watchdog service can be automatically started + during host boot by adding appropriate parameters to the file + /etc/default/virtualbox. There is one + mandatory parameter, VBOXWATCHDOG_USER, which + must be set to the user which will later start the VMs. For + backward compatibility you can also specify + VBOXBALLOONCTRL_USER. + + + + The parameters in the following table all start with the + VBOXWATCHDOG_ prefix string. For example: + VBOXWATCHDOG_BALLOON_INTERVAL and + VBOXWATCHDOG_LOGSIZE. Legacy parameters such + as VBOXBALLOONCTRL_INTERVAL can still be + used. + + + + &product-name; Watchdog Configuration Parameters + + + + + Parameter + + + Description + + + Default + + + + + + + USER + + + The user which the watchdog service runs as + + + + + + ROTATE + + + Number of log files, 0 disables log rotation + + + 10 + + + + + LOGSIZE + + + Maximum log file size to trigger rotation, in bytes + + + 1MB + + + + + LOGINTERVAL + + + Maximum time interval to trigger log rotation, in + seconds + + + 1 day + + + + + BALLOON_INTERVAL + + + Interval for checking the balloon size, in + milliseconds + + + 30000 + + + + + BALLOON_INCREMENT + + + Balloon size increment, in megabytes + + + 256 + + + + + BALLOON_DECREMENT + + + Balloon size decrement, in megabytes + + + 128 + + + + + BALLOON_LOWERLIMIT + + + Balloon size lower limit, in megabytes + + + 64 + + + + + BALLOON_SAFETYMARGIN + + + Free memory required for decreasing the balloon size, + in megabytes + + + 1024 + + + + +
+ + + + + + Oracle Solaris: Starting the Watchdog Service With SMF + + + On Oracle Solaris hosts, the &product-name; watchdog service + daemon is integrated into the SMF framework. You can change the + parameters, but do not have to if the defaults already match + your needs: + + +svccfg -s svc:/application/virtualbox/balloonctrl:default setprop \ + config/balloon_interval=10000 +svccfg -s svc:/application/virtualbox/balloonctrl:default setprop \ +config/balloon_safetymargin=134217728 + + + also applies + for Oracle Solaris. The parameter names must be changed to + lowercase and a prefix of config/ has to be + added. For example: config/user or + config/balloon_safetymargin. If you made any + change, do not forget to run the following command to put the + changes into effect immediately: + + +svcadm refresh svc:/application/virtualbox/balloonctrl:default + + + If you forget the above command then the previous settings will + be used when enabling the service. Check the current property + settings with the following command: + + +svcprop -p config svc:/application/virtualbox/balloonctrl:default + + + When everything is configured correctly you can start the + &product-name; watchdog service with the following command: + + +svcadm enable svc:/application/virtualbox/balloonctrl:default + + + For more information about SMF, please refer to the Oracle + Solaris documentation. + + + + + + + + + Other Extension Packs + + + Another extension pack called VNC is available. This extension + pack is open source and replaces the previous integration of the + VNC remote access protocol. This is experimental code, and is + initially available in the &product-name; source code package + only. It is to a large portion code contributed by users, and is + not supported in any way by Oracle. + + + + The keyboard handling is severely limited, and only the US + keyboard layout works. Other keyboard layouts will have at least + some keys which produce the wrong results, often with quite + surprising effects, and for layouts which have significant + differences to the US keyboard layout it is most likely unusable. + + + + It is possible to install both the &product-name; Extension Pack + and VNC, but only one VRDE module can be active at any time. The + following command switches to the VNC VRDE module in VNC: + + +VBoxManage setproperty vrdeextpack VNC + + + Configuring the remote access works very similarly to VRDP, see + , with some limitations. VNC does not + support specifying several port numbers, and the authentication is + done differently. VNC can only deal with password authentication, + and there is no option to use password hashes. This leaves no + other choice than having a clear-text password in the VM + configuration, which can be set with the following command: + + +VBoxManage modifyvm VM-name --vrdeproperty VNCPassword=secret + + + The user is responsible for keeping this password secret, and it + should be removed when a VM configuration is passed to another + person, for whatever purpose. Some VNC servers claim to have + encrypted passwords in the configuration. This is not true + encryption, it is only concealing the passwords, which is only as + secure as using clear-text passwords. + + + + The following command switches back to VRDP, if installed: + + +VBoxManage setproperty vrdeextpack "&product-name; Extension Pack" + + + + + + Starting Virtual Machines During System Boot + + + You can start VMs automatically during system boot on Linux, + Oracle Solaris, and Mac OS X platforms for all users. + + + + + Linux: Starting the Autostart Service With init + + + On Linux, the autostart service is activated by setting two + variables in /etc/default/virtualbox. The + first one is VBOXAUTOSTART_DB which contains + an absolute path to the autostart database directory. The + directory should have write access for every user who should be + able to start virtual machines automatically. Furthermore the + directory should have the sticky bit set. The second variable is + VBOXAUTOSTART_CONFIG which points the service + to the autostart configuration file which is used during boot to + determine whether to allow individual users to start a VM + automatically and configure startup delays. The configuration + file can be placed in /etc/vbox and + contains several options. One is + default_policy which controls whether the + autostart service allows or denies to start a VM for users which + are not in the exception list. The exception list starts with + exception_list and contains a comma separated + list with usernames. Furthermore a separate startup delay can be + configured for every user to avoid overloading the host. A + sample configuration is given below: + + + +# Default policy is to deny starting a VM, the other option is "allow". +default_policy = deny + +# Bob is allowed to start virtual machines but starting them +# will be delayed for 10 seconds +bob = { + allow = true + startup_delay = 10 +} + +# Alice is not allowed to start virtual machines, useful to exclude certain users +# if the default policy is set to allow. +alice = { + allow = false +} + + + + Any user who wants to enable autostart for individual machines + must set the path to the autostart database directory with the + following command: + + +VBoxManage setproperty autostartdbpath autostart-directory + + + + + + Oracle Solaris: Starting the Autostart Service With SMF + + + On Oracle Solaris hosts, the &product-name; autostart daemon is + integrated into the SMF framework. To enable it you must point + the service to an existing configuration file which has the same + format as on Linux, see . For + example: + + +# svccfg -s svc:/application/virtualbox/autostart:default setprop \ + config/config=/etc/vbox/autostart.cfg + + + When everything is configured correctly you can start the + &product-name; autostart service with the following command: + + +# svcadm enable svc:/application/virtualbox/autostart:default + + + For more information about SMF, see the Oracle Solaris + documentation. + + + + + + + Mac OS X: Starting the Autostart Service With launchd + + + On Mac OS X, launchd is used to start the &product-name; + autostart service. An example configuration file can be found in + /Applications/VirtualBox.app/Contents/MacOS/org.virtualbox.vboxautostart.plist. + To enable the service copy the file to + /Library/LaunchDaemons and change the + Disabled key from true to + false. Furthermore replace the second + parameter to an existing configuration file which has the same + format as on Linux, see . + + + + To manually start the service use the following command: + + +# launchctl load /Library/LaunchDaemons/org.virtualbox.vboxautostart.plist + + + For additional information on how launchd services can be + configured see: + + + + . + + + + + + + Windows: Starting the Autostart Service + + + On Windows, autostart functionality consist of two components. + The first component is a configuration file where the + administrator can both set a delayed start for the VMs and + temporarily disable autostarting for a particular user. The + configuration file should be located in a folder accessible by + all required users but it should have permissions allowing only + reading by everyone but administrators. The configuration file + contains several options. The + default_policy controls whether the autostart + service allows or denies starting of a VM for users that are not + in the exception list. The exception list starts with + exception_list and contains a comma separated + list with usernames. Furthermore, a separate startup delay can + be configured for every user to avoid overloading the host. A + sample configuration is given below: + + + + # Default policy is to deny starting a VM, the other option is "allow". + default_policy = deny + + # Bob is allowed to start virtual machines but starting them + # will be delayed for 10 seconds + bob = { + allow = true + startup_delay = 10 + } + + # Alice is not allowed to start virtual machines, useful to exclude certain users + # if the default policy is set to allow. + alice = { + allow = false + } + + + + The user name can be specified using the following forms: + "user", "domain\user", ".\user" and "user@domain". An + administrator must add the + VBOXAUTOSTART_CONFIG environment variable + into system variables containing the path to the configuration + file described above. The environment variable tells the + autostart services which configuration file is used. + + + + The second component of autostart functionality is a Windows + service. Every instance of this works on behalf of a particular + user using their credentials. + + + + To enable autostarting for a particular user, a member of the + administrators group must run the following command: + + +VBoxAutostartSvc install --user=user [--password-file=password_file] + + + The password file should contain the password followed by a line + break. The rest of the file is ignored. The user will be asked + for a password if the password file is not specified. + + + + To disable autostarting for particular user, a member of the + administrators group must run the following command: + + +VBoxAutostartSvc delete --user=user + + + If a user has changed their password then a member of the + administrators group must either reinstall the service or change + the service credentials using Windows Service Manager. Due to + Windows security policies, the autostart service cannot be + installed for users with empty passwords. + + + + Finally, the user should define which VMs should be started at + boot. The user should run the following command for every VM + they wish to start at boot: + + +VBoxManage modifyvm VM name or UUID --autostart-enabled on + + + The user can remove a particular VM from the VMs starting at + boot by running the following command: + + +VBoxManage modifyvm VM name or UUID --autostart-enabled off + + + + + + + + &product-name; Expert Storage Management + + + In case the snapshot model of &product-name; is not sufficient it + is possible to enable a special mode which makes it possible to + reconfigure storage attachments while the VM is paused. The user + has to make sure that the disk data stays consistent to the guest + because unlike with hotplugging the guest is not informed about + detached or newly attached media. + + + + The expert storage management mode can be enabled per VM + executing: + + +$ VBoxManage setextradata VM-name "VBoxInternal2/SilentReconfigureWhilePaused" 1 + + + You can reconfigure storage attachments later while the VM is + paused by using the VBoxManage storageattach + command. + + + + + + + Handling of Host Power Management Events + + + Some host power management events are handled by &product-name;. + The actual behavior depends on the platform: + + + + + + + Host Suspends. This event is + generated when the host is about to suspend, that is, the host + saves the state to some non-volatile storage and powers off. + + + + This event is currently only handled on Windows hosts and Mac + OS X hosts. When this event is generated, &product-name; will + pause all running VMs. + + + + + + Host Resumes. This event is + generated when the host woke up from the suspended state. + + + + This event is currently only handled on Windows hosts and Mac + OS X hosts. When this event is generated, &product-name; will + resume all VMs which are where paused before. + + + + + + Battery Low. The battery + level reached a critical level, usually less than 5 percent + charged. + + + + This event is currently only handled on Windows hosts and Mac + OS X hosts. When this event is generated, &product-name; will + save the state and terminate all VMs in preparation of a + potential host powerdown. + + + + The behavior can be configured. By executing the following + command, no VM is saved: + + +$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 0 + + + This is a global setting as well as a per-VM setting. The + per-VM value has higher precedence than the global value. The + following command will save the state of all VMs but will not + save the state of VM "foo": + + +$ VBoxManage setextradata global "VBoxInternal2/SavestateOnBatteryLow" 1 +$ VBoxManage setextradata "foo" "VBoxInternal2/SavestateOnBatteryLow" 0 + + + The first line is actually not required as by default the + savestate action is performed. + + + + + + + + + + Passing Through SSE4.1/SSE4.2 Instructions + + + To provide SSE 4.1/SSE 4.2 support to guests, the host CPU has to + implement these instruction sets. The instruction sets are exposed + to guests by default, but it is possible to disable the + instructions for certain guests by using the following commands: + + +$ VBoxManage setextradata VM-name \ +VBoxInternal/CPUM/IsaExts/SSE4.1 0 +$ VBoxManage setextradata VM-name \ +VBoxInternal/CPUM/IsaExts/SSE4.2 0 + + + These are per-VM settings which are enabled by default. + + + + + + + Support for Keyboard Indicator Synchronization + + + This feature makes the host keyboard indicators (LEDs) match those + of the VM's emulated keyboard when the machine window is active. + It is currently implemented for Mac OS X and Windows hosts. This + feature is enabled by default on supported host OSes. You can + disable this feature by running the following command: + + +$ VBoxManage setextradata VM-name GUI/HidLedsSync 0 + + + This is a per-VM setting that is enabled by default. + + + + + + + Capturing USB Traffic for Selected Devices + + + You can capture USB traffic for single USB devices or on the root + hub level, which captures the traffic of all USB devices attached + to the root hub. &product-name; stores the traffic in a format + which is compatible with Wireshark. To capture the traffic of a + specific USB device it must be attached to the VM with + VBoxManage using the following command: + + +VBoxManage controlvm VM-name usbattach device uuid|address --capturefile filename + + + In order to enable capturing on the root hub use the following + command while the VM is not running: + + +VBoxManage setextradata VM-name \ +VBoxInternal/Devices/usb-ehci/0/LUN#0/Config/CaptureFilename filename + + + The command above enables capturing on the root hub attached to + the EHCI controller. To enable it for the OHCI or XHCI controller + replace usb-ehci with + usb-ohci or usb-xhci, + respectively. + + + + + + + Configuring the Heartbeat Service + + + &product-name; ships a simple heartbeat service. Once the Guest + Additions are active, the guest sends frequent heartbeat pings to + the host. If the guest stops sending the heartbeat pings without + properly terminating the service, the VM process will log this + event in the VBox.log file. In the future it might be possible to + configure dedicated actions but for now there is only a warning in + the log file. + + + + There are two parameters to configure. The heartbeat + interval defines the time between two heartbeat pings. + The default value is 2 seconds, that is, the heartbeat service of + the &product-name; Guest Additions will send a heartbeat ping + every two seconds. The value in nanoseconds can be configured like + this: + + +VBoxManage setextradata VM-name \ +VBoxInternal/Devices/VMMDev/0/Config/HeartbeatInterval 2000000000 + + + The heartbeat timeout defines the time the + host waits starting from the last heartbeat ping before it defines + the guest as unresponsive. The default value is 2 times the + heartbeat interval (4 seconds) and can be configured as following, + in nanoseconds: + + +VBoxManage setextradata VM-name \ +VBoxInternal/Devices/VMMDev/0/Config/HeartbeatTimeout 4000000000 + + + If the heartbeat timeout expires, there will be a log message like + VMMDev: HeartBeatCheckTimer: Guest seems to be + unresponsive. Last heartbeat received 5 seconds ago. If + another heartbeat ping arrives after this warning, there will be a + log message like VMMDev: GuestHeartBeat: Guest is + alive. + + + + + + + Encryption of Disk Images + + + &product-name; enables you to transparently encrypt the data + stored in hard disk images for the guest. It does not depend on a + specific image format to be used. Images which have the data + encrypted are not portable between &product-name; and other + virtualization software. + + + + &product-name; uses the AES algorithm in XTS mode and supports + 128-bit or 256-bit data encryption keys (DEK). The DEK is stored + encrypted in the medium properties and is decrypted during VM + startup by entering a password which was chosen when the image was + encrypted. + + + + Since the DEK is stored as part of the VM configuration file, it + is important that it is kept safe. Losing the DEK means that the + data stored in the disk images is lost irrecoverably. Having + complete and up to date backups of all data related to the VM is + the responsibility of the user. + + + + + Limitations of Disk Encryption + + + There are some limitations the user needs to be aware of when + using this feature: + + + + + + + This feature is part of the &product-name; Extension Pack, + which needs to be installed. Otherwise disk encryption is + unavailable. + + + + + + Since encryption works only on the stored user data, it is + currently not possible to check for metadata integrity of + the disk image. Attackers might destroy data by removing or + changing blocks of data in the image or change metadata + items such as the disk size. + + + + + + Exporting appliances which contain encrypted disk images is + not possible because the OVF specification does not support + this. All images are therefore decrypted during export. + + + + + + The DEK is kept in memory while the VM is running to be able + to decrypt data read and encrypt data written by the guest. + While this should be obvious the user needs to be aware of + this because an attacker might be able to extract the key on + a compromised host and decrypt the data. + + + + + + When encrypting or decrypting the images, the password is + passed in clear text using the &product-name; API. This + needs to be kept in mind, especially when using third party + API clients which make use of the webservice where the + password might be transmitted over the network. The use of + HTTPS is mandatory in such a case. + + + + + + Encrypting images with differencing images is only possible + if there are no snapshots or a linear chain of snapshots. + This limitation may be addressed in a future &product-name; + version. + + + + + + The disk encryption feature can protect the content of the + disks configured for a VM only. It does not cover any other + data related to a VM, including saved state or the + configuration file itself. + + + + + + + + + + Encrypting Disk Images + + + Encrypting disk images can be done either using the GUI or + VBoxManage. While the GUI is easier to use, + it works on a per VM basis and encrypts all disk images attached + to the specific VM. With VBoxManage one can + encrypt individual images, including all differencing images. To + encrypt an unencrypted medium with + VBoxManage, use: + + +VBoxManage encryptmedium uuid|filename \ +--newpassword filename|- --cipher cipher-ID --newpasswordid "ID + + + To supply the encryption password point + VBoxManage to the file where the password is + stored or specify to let VBoxManage ask you + for the password on the command line. + + + + The cipher parameter specifies the cipher to use for encryption + and can be either AES-XTS128-PLAIN64 or + AES-XTS256-PLAIN64. The specified password + identifier can be freely chosen by the user and is used for + correct identification when supplying multiple passwords during + VM startup. + + + + If the user uses the same password when encrypting multiple + images and also the same password identifier, the user needs to + supply the password only once during VM startup. + + + + + + + Starting a VM with Encrypted Images + + + When a VM is started using the GUI, a dialog will open where the + user needs to enter all passwords for all encrypted images + attached to the VM. If another frontend like VBoxHeadless is + used, the VM will be paused as soon as the guest tries to access + an encrypted disk. The user needs to provide the passwords + through VBoxManage using the following + command: + + +VBoxManage controlvm uuid|vmname addencpassword ID password [--removeonsuspend yes|no] + + + ID must be the same as the password + identifier supplied when encrypting the images. + password is the password used when + encrypting the images. Optionally, you can specify + to specify whether to + remove the password from VM memory when the VM is suspended. + Before the VM can be resumed, the user needs to supply the + passwords again. This is useful when a VM is suspended by a host + suspend event and the user does not want the password to remain + in memory. + + + + + + + Decrypting Encrypted Images + + + In some circumstances it might be required to decrypt previously + encrypted images. This can be done in the GUI for a complete VM + or using VBoxManage with the following + command: + + +VBoxManage encryptmedium uuid|filename --oldpassword file|- + + + The only required parameter is the password the image was + encrypted with. The options are the same as for encrypting + images. + + + + + + + + + Paravirtualized Debugging + + + This section covers debugging of guest operating systems using + interfaces supported by paravirtualization providers. + + + + + Paravirtualized debugging significantly alter guest operating + system behaviour and should only be used by expert users for + debugging and diagnostics. + + + + + These debug options are specified as a string of key-value pairs + separated by commas. An empty string disables paravirtualized + debugging. + + + + + Hyper-V Debug Options + + + All of the options listed below are optional, and thus the + default value specified will be used when the corresponding + key-value pair is not specified. + + + + + + + Key: + enabled + + + + Value: 0 or 1 + + + + Default: 0 + + + + Specify 1 to enable the Hyper-V debug + interface. If this key-value pair is not specified or the + value is not 1, the Hyper-V debug + interface is disabled regardless of other key-value pairs + being present. + + + + + + Key: + address + + + + Value: IPv4 address + + + + Default: 127.0.0.1 + + + + Specify the IPv4 address where the remote debugger is + connected. + + + + + + Key: + port + + + + Value: UDP port number + + + + Default: 50000 + + + + Specify the UDP port number where the remote debugger is + connected. + + + + + + Key: + vendor + + + + Value: Hyper-V vendor signature reported by CPUID to the + guest + + + + Default: When debugging is enabled: Microsoft + Hv, otherwise: VBoxVBoxVBox + + + + Specify the Hyper-V vendor signature which is exposed to the + guest by CPUID. For debugging Microsoft Windows guests, it + is required the hypervisor reports the Microsoft vendor. + + + + + + Key: + hypercallinterface + + + + + Value: 0 or 1 + + + + Default: 0 + + + + Specify whether hypercalls should be suggested for + initiating debug data transfers between host and guest + rather than MSRs when requested by the guest. + + + + + + Key: vsinterface + + + + + Value: 0 or 1 + + + + Default: When debugging is enabled, 1, + otherwise 0 + + + + Specify whether to expose the VS#1 virtualization service + interface to the guest. This interface is required for + debugging Microsoft Windows 10 32-bit guests, but is + optional for other Windows versions. + + + + + + + + Setting up Windows Guests for Debugging with the Hyper-V + Paravirtualization Provider + + + Windows supports debugging over a serial cable, USB, IEEE 1394 + Firewire, and Ethernet. USB and IEEE 1394 are not applicable + for virtual machines, and Ethernet requires Windows 8 or + later. While a serial connection is universally usable, it is + slow. + + + + Debugging using the Hyper-V debug transport, supported on + Windows Vista and later, offers significant benefits. It + provides excellent performance due to direct host-to-guest + transfers, it is easy to set up and requires minimal support + from the hypervisor. It can be used with the debugger running + on the same host as the VM or with the debugger and VM on + separate machines connected over a network. + + + + Prerequisites + + + + + + + A VM configured for Hyper-V paravirtualization running a + Windows Vista or newer Windows guest. You can check the + effective paravirtualization provider for your VM with the + output of the following VBoxManage + command: + + +$ VBoxManage showvminfo VM-name + + + + + A sufficiently up-to-date version of the Microsoft WinDbg + debugger required to debug the version of Windows in your + VM. + + + + + + While Windows 8 and newer Windows guests ship with Hyper-V + debug support, Windows 7 and Vista do not. To use Hyper-V + debugging with a Windows 7 or Vista guest, copy the file + kdvm.dll from a Windows 8.0 + installation. This file is typically located in + C:\Windows\System32. Copy it to the + same location in your Windows 7/Vista guest. Make sure you + copy the 32-bit or 64-bit version of the DLL which matches + your guest OS. + + + + + Only Windows 8.0 ships kdvm.dll. + Windows 8.1 and newer Windows versions do not. + + + + + + + + VM and Guest Configuration + + + + + + + Power off the VM. + + + + + + Enable the debug options with the following + VBoxManage command: + + +$ VBoxManage modifyvm VM-name --paravirtdebug "enabled=1" + + + The above command assumes your debugger will connect to + your host machine on UDP port 50000. However, if you need + to run the debugger on a remote machine you may specify + the remote address and port here. For example: + + +$ VBoxManage modifyvm VM-name \ +--paravirtdebug "enabled=1,address=192.168.32.1,port=55000" + + + See for the complete set + of options. + + + + + + Start the VM. + + + + + + In the guest, start an elevated command prompt and execute + the following commands: + + + + + + + For a Windows 8 or newer Windows guest: + + +bcdedit /dbgsettings net hostip:5.5.5.5 port:50000 key:1.2.3.4 + + + + + For a Windows 7 or Vista guest: + + +bcdedit /set loadoptions host_ip=5.5.5.5,host_port=50000,encryption_key=1.2.3.4 + +bcdedit /set dbgtransport kdvm.dll + + + The IP address and port in the + bcdedit command are ignored when + using the Hyper-V debug transport. Any valid IP and a + port number greater than 49151 and lower than 65536 + can be entered. + + + + The encryption key in the bcdedit + command is relevant and must be valid. The key + "1.2.3.4" used in the above example is valid and may + be used if security is not a concern. If you do not + specify any encryption key, bcdedit + will generate one for you and you will need to copy + this key to later enter in Microsoft WinDbg on the + remote end. This encryption key is used to encrypt the + debug data exchanged between Windows and the debugger. + + + + + + Run one or more of the following commands to enable + debugging for the appropriate phase or component of + your Windows guest: + + +bcdedit /set debug on + +bcdedit /set bootdebug on + +bcdedit /set {bootmgr} bootdebug on + + + Please note that the bootdebug + options are only effective on Windows 8 or newer when + using the Hyper-V debug transport. Refer to Microsoft + Windows documentation for detailed explanation of + bcdedit options. + + + + + + + + + Start Microsoft WinDbg on your host machine or remote + host. + + + + From the File menu, + select Kernel Debug. On + the NET tab, specify the + UDP port number you used in the + paravirtdebug options. If you did not + specify any, leave it as 50000. Ensure that the UDP port + is not blocked by a firewall or other security software. + + + + In the Key field, enter + 1.2.3.4 or the encryption key from the + bcdedit command in your Windows guest. + + + + Click OK to start + listening for connections. Microsoft WinDbg typically + shows a Waiting to Reconnect message during this phase. + + + + Alternatively, to directly start a debug session, run + WinDbg from the command line as follows : + + +windbg.exe -k net:port=50000,key=1.2.3.4 + + + See the WinDbg documentation for the complete command line + syntax. + + + + + + Reboot your Windows guest and it should then connect as a + debuggee with Microsoft WinDbg. + + + + + + + + + + + + + + PC Speaker Passthrough + + + As an experimental feature, primarily due to being limited to + Linux host only and unknown Linux distribution coverage, + &product-name; supports passing through the PC speaker to the + host. The PC speaker, sometimes called the system speaker, is a + way to produce audible feedback such as beeps without the need for + regular audio and sound card support. + + + + The PC speaker passthrough feature in &product-name; handles beeps + only. Advanced PC speaker use by the VM, such as PCM audio, will + not work, resulting in undefined host behavior. + + + + Producing beeps on Linux is a very complex topic. &product-name; + offers a collection of options, in an attempt to make this work + deterministically and reliably on as many Linux distributions and + system configurations as possible. These are summarized in the + following table. + + + + PC Speaker Configuration Options + + + + + Code + + + Device + + + Notes + + + + + + + 1 + + + /dev/input/by-path/platform-pcspkr-event-spkr + + + Direct host PC speaker use. + + + + + 2 + + /dev/tty + + Uses the terminal association of the VM process. VM + needs to be started on a virtual console. + + + + + 3 + + + /dev/tty0 or + /dev/vc/0 + + + Can only be used by user root or + users with cap_sys_tty_config + capability. + + + + + 9 + + + A user-specified console or evdev device path. + + + As for codes 1 to 3, but with a custom device path. + + + + + 70 + + + /dev/tty + + + Standard beep only. Loses frequency and length. See code + 2. + + + + + 79 + + + A user-specified terminal device path. + + + As for code 70, but with a custom device path. + + + + + 100 + + + All of the above. + + + Tries all the available codes. + + + + +
+ + + To enable PC speaker passthrough use the following command: + + +VBoxManage setextradata VM-name "VBoxInternal/Devices/i8254/0/Config/PassthroughSpeaker" N + + + Replace N with the code representing + the case you want to use. Changing this setting takes effect when + you next start the VM. It is safe to enable PC speaker passthrough + on all host OSes. It will only have an effect on Linux. + + + + The VM log file, VBox.log, contains lines + with the prefix PIT: speaker: showing the PC + speaker passthrough setup activities. It gives hints which device + it picked or why it failed. + + + + Enabling PC speaker passthrough for the VM is usually the simple + part. The real difficulty is making sure that &product-name; can + access the necessary device, because in a typical Linux install + most of them can only be accessed by user root. + You should follow the preferred way to persistently change this, + such as by referring to your distribution's documentation. Since + there are countless Linux distribution variants, we can only give + the general hints that there is often a way to give the X11 + session user access to additional devices, or you need to find a + working solution using a udev configuration file. If everything + fails you might try setting the permissions using a script which + is run late enough in the host system startup. + + + + Sometimes additional rules are applied by the kernel to limit + access. For example, that the VM process must have the same + controlling terminal as the device configured to be used for + beeping, something which is often very difficult to achieve for + GUI applications such as &product-name;. The table above contains + some hints, but in general refer to the Linux documentation. + + + + If you have trouble getting any beeps even if the device + permissions are set up and VBox.log confirms that it uses evdev or + console for the PC speaker control, check if your system has a PC + speaker. Some systems do not have one. Other complications can + arise from Linux rerouting the PC speaker output to a sound card. + Check if the beeps are audible if you connect speakers to your + sound card. Today almost all systems have one. Finally, check if + the audio mixer control has a channel named "beep", which could be + hidden in the mixer settings, and that it is not muted. + + + + + + + Accessing USB devices Exposed Over the Network with USB/IP + + + &product-name; supports passing through USB devices which are + exposed over the network using the USB over IP protocol without + the need to configure the client side provided by the kernel and + usbip tools. Furthermore, this feature works with &product-name; + running on any supported host, rather than just Linux alone, as is + the case with the official client. + + + + To enable support for passing through USB/IP devices, use the + following command to add the device server that exports the + devices: + + +VBoxManage usbdevsource add unique-name --backend USB-IP --address device-server[:port] + + + USB devices exported on the device server are then accessible + through the GUI or VBoxManage, like any USB + devices attached locally. This can be used multiple times to + access different device servers. + + + + To remove a device server, the following command can be used: + + +$ VBoxManage usbdevsource remove unique-name + + + + Setting up USB/IP Support on a Linux System + + + This section gives a brief overview on how to set up a Linux + based system to act as a USB device server. The system on the + server requires that the usbip-core.ko and + usbip-host.ko kernel drivers are available, + and that the USB/IP tools package is installed. The particular + installation method for the necessary tools depends on which + distribution is used. For example, for Debian based systems, use + the following command to install the required tools: + + +$ apt-get install usbip-utils + + + To check whether the necessary tools are already installed use + the following command: + + + +$ usbip list -l + + + + This should produce output similar to that shown in the example + below: + + + + - busid 4-2 (0bda:0301) + Realtek Semiconductor Corp. : multicard reader (0bda:0301) + + - busid 5-1 (046d:c52b) + Logitech, Inc. : Unifying Receiver (046d:c52b) + + + + If everything is installed, the USB/IP server needs to be + started as root using the following command: + + +# usbipd -D + + + See the documentation for the installed distribution to + determine how to start the service when the system boots. + + + + By default, no device on the server is exported. This must be + done manually for each device. To export a device use the + following command: + + +# usbip bind -b "bus identifier" + + + To export the multicard reader in the previous example: + + +# usbip bind -b 4-2 + + + + + + Security Considerations + + + The communication between the server and client is unencrypted + and there is no authorization required to access exported + devices. An attacker might sniff sensitive data or gain control + over a device. To mitigate this risk, the device should be + exposed over a local network to which only trusted clients have + access. To access the device remotely over a public network, a + VPN solution should be used to provide the required level of + security protection. + + + + + + + + + Using Hyper-V with &product-name; + + + &product-name; can be used on a Windows host where Hyper-V is + running. This is an experimental feature. + + + + No configuration is required. &product-name; detects Hyper-V + automatically and uses Hyper-V as the virtualization engine for + the host system. The CPU icon in the VM window status bar + indicates that Hyper-V is being used. + + + + + When using this feature, some host systems might experience + significant &product-name; performance degradation. + + + + + + + + Nested Virtualization + + + &product-name; supports nested + virtualization. This feature enables the passthrough of + hardware virtualization functions to the guest VM. That means that + you can install a hypervisor, such as &product-name;, Oracle VM + Server or KVM, on an &product-name; guest. You can then create and + run VMs within the guest VM. + + + + Hardware virtualization features not present on the host CPU will + not be exposed to the guest. In addition, some features such as + nested paging are not yet supported for passthrough to the guest. + + + + You can enable the nested virtualization feature in one of the + following ways: + + + + + + + From the VirtualBox Manager, select the + Enable Nested VT-x/AMD-V + check box on the Processor + tab. To disable the feature, deselect the check box. + + + + + + Use the option of the + VBoxManage modifyvm command to enable or + disable nested virtualization. See + . + + + + + + + + + + diff --git a/doc/manual/en_US/user_BasicConcepts.xml b/doc/manual/en_US/user_BasicConcepts.xml new file mode 100644 index 00000000..ad3d8302 --- /dev/null +++ b/doc/manual/en_US/user_BasicConcepts.xml @@ -0,0 +1,3037 @@ + + +%all.entities; +]> + + + Configuring Virtual Machines + + + This chapter provides detailed steps for configuring an + &product-name; virtual machine (VM). For an introduction to + &product-name; and steps to get your first virtual machine running, + see . + + + + You have considerable latitude when deciding what virtual hardware + to provide to the guest. Use virtual hardware to communicate with + the host system or with other guests. For example, you can use + virtual hardware in the following ways: + + + + + + + Have &product-name; present an ISO CD-ROM image to a guest + system as if it were a physical CD-ROM. + + + + + + Provide a guest system access to the physical network through + its virtual network card. + + + + + + Provide the host system, other guests, and computers on the + Internet access to the guest system. + + + + + + + + Supported Guest Operating Systems + + + Because &product-name; is designed to provide a generic + virtualization environment for x86 systems, it can run guest + operating systems (OSes) of any kind. + + + + The following guest OS platforms are supported: + + + + + + + Platforms With Full Support. + These guest OS platforms qualify for Oracle Premier Support. + See . + + + + + + Platforms With Limited + Support. These legacy guest OS platforms can be + used with &product-name;, but only qualify for best + effort support. Therefore, resolution of customer + issues is not guaranteed. See + . + + + + + + + Guest Operating Systems With Full Support + + + + + Operating System + + + Comments + + + + + + + Windows 10 (32-bit and 64-bit) + + + Insider preview builds are not supported + + + + + Windows 8 and 8.1 (32-bit and 64-bit) + + + + + + Windows Server 2019 (64-bit) + + + + + + Windows Server 2016 (64-bit) + + + + + + Windows Server 2012 and 2012 R2 (64-bit) + + + + + + Solaris 11 (32-bit and 64-bit) + + + + + + Solaris 10 8/11 Update 10 and later (32-bit and 64-bit) + + + + + + Oracle Linux 8 (64-bit) + + + Includes Red Hat Enterprise Linux 8, CentOS 8 + + + + + Oracle Linux 7 (64-bit) + + + Includes Red Hat Enterprise Linux 7, CentOS 7 + + + + + Oracle Linux 6 (32-bit and 64-bit) + + + Includes Red Hat Enterprise Linux 6, CentOS 6 + + + + + Ubuntu 16.04 LTS (Xenial Xerus) (32-bit and 64-bit) + + + + + + Ubuntu 18.04 LTS (Bionic Beaver) (64-bit) + + + + + + Ubuntu 20.04 LTS (Focal Fossa) (64-bit) + + + + + + SUSE Linux Enterprise Server 15 (64-bit) + + + + + + SUSE Linux Enterprise Server 12 (64-bit) + + + + + +
+ + + Legacy Guest Operating Systems With Limited Support + + + + + Operating System + + + Comments + + + + + + + Windows 7 (32-bit and 64-bit) + + + + + + Windows Vista SP2 and later (32-bit and 64-bit) + + + + + + Windows XP (32-bit) + + + + + + Windows Vista (32-bit) + + + + + + Windows Server 2008 and 2008 R2 (32-bit and 64-bit) + + + + + + Windows Server 2003 (32-bit and 64-bit) + + + + + + Oracle Linux 5 (32-bit and 64-bit) + + + Includes Red Hat Enterprise Linux 5, CentOS 5 + + + + + Ubuntu 14.04.5 LTS (Trusty Tahr) (32-bit and 64-bit) + + + + + + OS/2 Warp 4.5 + + + + + +
+ + + + Mac OS X Guests + + + &product-name; enables you to install and execute unmodified + versions of Mac OS X guests on supported host hardware. Note + that this feature is experimental and thus unsupported. + + + + &product-name; is the first product to provide the modern PC + architecture expected by OS X without requiring any of the + modifications used by competing virtualization solutions. For + example, some competing solutions perform modifications to the + Mac OS X install DVDs, such as a different boot loader and + replaced files. + + + + Be aware of the following important issues before you attempt to + install a Mac OS X guest: + + + + + + + Mac OS X is commercial, licensed software and contains + both license and technical + restrictions that limit its use to certain + hardware and usage scenarios. You must understand and comply + with these restrictions. + + + + In particular, Apple prohibits the installation of most + versions of Mac OS X on non-Apple hardware. + + + + These license restrictions are also enforced on a technical + level. Mac OS X verifies that it is running on Apple + hardware. Most DVDs that accompany Apple hardware check for + the exact model. These restrictions are + not circumvented by &product-name; and + continue to apply. + + + + + + Only CPUs that are known + and tested by Apple are supported. As a result, if your + Intel CPU is newer than the Mac OS X build, or if you have a + non-Intel CPU, you will likely encounter a panic during + bootup with an "Unsupported CPU" exception. + + + + Ensure that you use the Mac OS X DVD that comes with your + Apple hardware. + + + + + + The Mac OS X installer expects the hard disk to be + partitioned. So, the installer will not + offer a partition selection to you. Before you can install + the software successfully, start the Disk Utility from the + Tools menu and partition the hard disk. Close the Disk + Utility and proceed with the installation. + + + + + + In addition, Mac OS X support in &product-name; is an + experimental feature. See . + + + + + + + + + + 64-bit Guests + + + + Be sure to enable I/O APIC + for virtual machines that you intend to use in 64-bit mode. + This is especially true for 64-bit Windows VMs. See + . For 64-bit + Windows guests, ensure that the VM uses the + Intel networking device + because there is no 64-bit driver support for the AMD PCNet + card. See . + + + + + If you use the Create VM wizard + of the VirtualBox Manager, &product-name; automatically uses the + correct settings for each selected 64-bit OS type. See + . + + + + + + + + + Unattended Guest Installation + + + &product-name; can install a guest OS automatically. You only need + to provide the installation medium and a few other parameters, + such as the name of the default user. + + + + Performing an unattended guest installation involves the following + steps: + + + + + + + Create a new VM. Use one of + the following methods: + + + + + + + The VirtualBox Manager, see + . + + + + + + The VBoxManage createvm command, see + . + + + + + + + For the new VM, choose the guest OS type and accept the + default settings for that OS. The following sections in this + chapter describe how to change the settings for a VM. + + + + + + Prepare the VM for unattended guest + installation. Use the VBoxManage + unattended command, see + . + + + + During this step, &product-name; scans the installation medium + and changes certain parameters to ensure a seamless + installation as a guest running on &product-name;. + + + + + + Start the VM. Use the + VirtualBox Manager or the VBoxManage + startvm command. + + + + When you start the VM, the unattended installation is + performed automatically. + + + + The installation operation changes the boot device order to + boot the virtual hard disk first and then the virtual DVD + drive. If the virtual hard disk is empty prior to the + automatic installation, the VM boots from the virtual DVD + drive and begins the installation. + + + + If the virtual hard disk contains a bootable OS, the + installation operation exits. In this case, change the boot + device order manually by pressing F12 during the BIOS splash + screen. + + + + + + + describes how + to perform an unattended guest installation for an Oracle Linux + guest. + + + + + An Example of Unattended Guest Installation + + + The following example shows how to perform an unattended guest + installation for an Oracle Linux VM. The example uses various + VBoxManage commands to prepare the guest VM. + The VBoxManage unattended install command is + then used to install and configure the guest OS. + + + + + + + Create the virtual machine. + + +# VM="ol7-autoinstall" +# VBoxManage list ostypes +# VBoxManage createvm --name $VM --ostype "Oracle_64" --register + + + Note the following: + + + + + + + The $VM variable represents the name of the VM. + + + + + + The VBoxManage list ostypes command + lists the guest OSes supported by &product-name;, + including the name used for each OS in the + VBoxManage commands. + + + + + + A 64-bit Oracle Linux 7 VM is created and registered + with &product-name;. + + + + + + The VM has a unique UUID. + + + + + + An XML settings file is generated. + + + + + + + + + Create a virtual hard disk and storage devices for the VM. + + +# VBoxManage createhd --filename /VirtualBox/$VM/$VM.vdi --size 32768 +# VBoxManage storagectl $VM --name "SATA Controller" --add sata --controller IntelAHCI +# VBoxManage storageattach $VM --storagectl "SATA Controller" --port 0 --device 0 \ +--type hdd --medium /VirtualBox/$VM/$VM.vdi +# VBoxManage storagectl $VM --name "IDE Controller" --add ide +# VBoxManage storageattach $VM --storagectl "IDE Controller" --port 0 --device 0 \ +--type dvddrive --medium /u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso + + + The previous commands do the following: + + + + + + + Create a 32768 MB virtual hard disk. + + + + + + Create a SATA storage controller and attach the virtual + hard disk. + + + + + + Create an IDE storage controller for a virtual DVD drive + and attach an Oracle Linux installation ISO. + + + + + + + + + (Optional) Configure some settings for the VM. + + +# VBoxManage modifyvm $VM --ioapic on +# VBoxManage modifyvm $VM --boot1 dvd --boot2 disk --boot3 none --boot4 none +# VBoxManage modifyvm $VM --memory 8192 --vram 128 + + + The previous commands do the following: + + + + + + + Enable I/O APIC for the motherboard of the VM. + + + + + + Configure the boot device order for the VM. + + + + + + Allocate 8192 MB of RAM and 128 MB of video RAM to the + VM. + + + + + + + + + Perform an unattended install of the OS. + + +# VBoxManage unattended install $VM \ +--iso=/u01/Software/OL/OracleLinux-R7-U6-Server-x86_64-dvd.iso \ +--user=login --full-user-name=name --password password \ +--install-additions --time-zone=CET + + + The previous command does the following: + + + + + + + Specifies an Oracle Linux ISO as the installation ISO. + + + + + + Specifies a login name, full name, and login password + for a default user on the guest OS. + + + + Note that the specified password is also used for the + root user account on the guest. + + + + + + Installs the Guest Additions on the VM. + + + + + + Sets the time zone for the guest OS to Central European + Time (CET). + + + + + + + + + Start the virtual machine. + + + + This step completes the unattended installation process. + + +# VBoxManage startvm $VM --type headless + + + The VM starts in headless mode, which means that the + VirtualBox Manager window does not open. + + + + + + (Optional) Update the guest OS to use the latest Oracle + Linux packages. + + + + On the guest VM, run the following command: + + +# yum update + + + + + + + + + + + Emulated Hardware + + + &product-name; virtualizes nearly all hardware of the host. + Depending on a VM's configuration, the guest will see the + following virtual hardware: + + + + + + + Input devices. &product-name; + can emulate a standard PS/2 keyboard and mouse. These devices + are supported by most guest OSes. + + + + In addition, &product-name; can provide virtual USB input + devices to avoid having to capture mouse and keyboard, as + described in . + + + + + + Graphics. The default + &product-name; graphics device for Windows guests is an SVGA + device. For Linux guests, the default graphics device emulates + a VMware SVGA graphics device. See + . + + + + For legacy guest OSes, a VGA-compatible graphics device is + available. + + + + + + Storage. &product-name; + emulates the most common types of hard disk controllers. See + . Whereas supporting + only one of these controllers would be enough for + &product-name; by itself, this multitude of storage adapters + is required for compatibility with other hypervisors. Windows + is very selective about its boot devices, and migrating VMs + between hypervisors is very difficult or impossible if the + storage controllers are different. + + + + + + Networking. See + . + + + + + + USB. &product-name; emulates + these types of USB host controllers: xHCI, EHCI, and OHCI. + While xHCI handles all USB transfer speeds, some legacy guest + OSes may not support xHCI. Note that for some legacy Windows + guests, third party drivers must be installed for xHCI + support. + + + + Legacy guest OSes typically support OHCI and EHCI. These two + controllers are needed because OHCI only handles USB low-speed + and full-speed devices (both USB 1.x and 2.0), while EHCI only + handles high-speed devices (USB 2.0 only). + + + + The emulated USB controllers do not communicate directly with + devices on the host. Instead they communicate with a virtual + USB layer which abstracts the USB protocol and enables the use + of remote USB devices. + + + + + + Audio. See + . + + + + + + + + + + General Settings + + + In the Settings window, under + General, you can configure the + most fundamental aspects of the virtual machine such as memory and + essential hardware. The following tabs are available. + + + + + Basic Tab + + + In the Basic tab of the + General settings category, you + can find these settings: + + + + + + + Name: The name of the the + VM, as shown in the list of VMs in the main VirtualBox + Manager window. Using this name, &product-name; also saves + the VM's configuration files. If you change the name, + &product-name; renames these files as well. As a result, you + can only use characters which are allowed for file names on + your host OS. + + + + Note that internally, &product-name; uses unique identifiers + (UUIDs) to identify virtual machines. You can display these + using the VBoxManage commands. + + + + + + Type: The type of the guest + OS for the VM. This is the same setting that is specified in + the New Virtual Machine + wizard. See . + + + + Whereas the default settings of a newly created VM depend on + the selected OS type, changing the type later has no effect + on VM settings. This value is purely informational and + decorative. + + + + + + Version: The version of the + guest OS for the VM. This is the same setting that is + specified in the New Virtual + Machine wizard. See + . + + + + + + + + + + Advanced Tab + + + The following settings are available in the + Advanced tab: + + + + + + + Snapshot Folder: By + default, &product-name; saves snapshot data together with + your other &product-name; configuration data. See + . With this setting, you + can specify any other folder for each VM. + + + + + + Shared Clipboard: You can + select here whether the clipboard of the guest OS should be + shared with that of your host. If you select + Bidirectional, then + &product-name; will always make sure that both clipboards + contain the same data. If you select + Host to Guest or + Guest to Host, then + &product-name; will only ever copy clipboard data in one + direction. + + + + Clipboard sharing requires that the &product-name; Guest + Additions be installed. In such a case, this setting has no + effect. See . + + + + For security reasons, the shared clipboard is disabled by + default. This setting can be changed at any time using the + Shared Clipboard menu item + in the Devices menu of the + virtual machine. + + + + + + Drag and Drop: This setting + enables support for drag and drop. Select an object, such as + a file, from the host or guest and directly copy or open it + on the guest or host. Multiple drag and drop modes for a VM + enable restricting of access in either direction. + + + + For drag and drop to work the Guest Additions need to be + installed on the guest. + + + + + Drag and drop is disabled by default. This setting can be + changed at any time using the Drag + and Drop menu item in the + Devices menu of the + virtual machine. + + + + + See . + + + + + + + + + + Description Tab + + + On the Description tab you can + enter a description for your virtual machine. This has no effect + on the functionality of the machine, but you may find this space + useful to note down things such as the configuration of a + virtual machine and the software that has been installed into + it. + + + + To insert a line break into the + Description text field, press + Shift+Enter. + + + + + + + Disk Encryption Tab + + + The Disk Encryption tab enables + you to encrypt disks that are attached to the virtual machine. + + + + To enable disk encryption, select the + Enable Disk Encryption check + box. + + + + Settings are available to configure the cipher used for + encryption and the encryption password. + + + + + All files related to the virtual machine except disk images + are stored unencrypted. + + + + + + + + + + System Settings + + + The System category groups + various settings that are related to the basic hardware that is + presented to the virtual machine. + + + + + As the activation mechanism of Microsoft Windows is sensitive to + hardware changes, if you are changing hardware settings for a + Windows guest, some of these changes may trigger a request for + another activation with Microsoft. + + + + + The following tabs are available. + + + + + Motherboard Tab + + + On the Motherboard tab, you can + configure virtual hardware that would normally be on the + motherboard of a real computer. + + + + + + + Base Memory: Sets the + amount of RAM that is allocated and given to the VM when it + is running. The specified amount of memory will be requested + from the host OS, so it must be available or made available + as free memory on the host when attempting to start the VM + and will not be available to the host while the VM is + running. This is the same setting that was specified in the + New Virtual Machine wizard, + as described in . + + + + Generally, it is possible to change the memory size after + installing the guest OS. But you must not reduce the memory + to an amount where the OS would no longer boot. + + + + + + Boot Order: Determines the + order in which the guest OS will attempt to boot from the + various virtual boot devices. Analogous to a real PC's BIOS + setting, &product-name; can tell a guest OS to start from + the virtual floppy, the virtual CD/DVD drive, the virtual + hard drive (each of these as defined by the other VM + settings), the network, or none of these. + + + + If you select Network, the + VM will attempt to boot from a network using the PXE + mechanism. This needs to be configured in detail on the + command line. See . + + + + + + Chipset: You can select + which chipset will be presented to the virtual machine. + PIIX3 is the default chipset for most guests. For some guest + OSes such as Mac OS X, the PIIX3 chipset is not well + supported. As a result, &product-name; supports an emulation + of the ICH9 chipset, which supports PCI express, three PCI + buses, PCI-to-PCI bridges and Message Signaled Interrupts + (MSI). This enables modern OSes to address more PCI devices + and no longer requires IRQ sharing. Using the ICH9 chipset + it is also possible to configure up to 36 network cards, + compared to a maximum of eight network adapters with PIIX3. + Note that ICH9 support is experimental and not recommended + for guest OSes which do not require it. + + + + + + Pointing Device: The + default virtual pointing device for some guest OSes is the + traditional PS/2 mouse. If set to USB + Tablet, &product-name; reports to the virtual + machine that a USB tablet device is present and communicates + mouse events to the virtual machine through this device. + Another setting is USB Multi-Touch + Tablet, which is suitable for guests running + Windows 8 or later. + + + + Using the virtual USB tablet has the advantage that + movements are reported in absolute coordinates, instead of + as relative position changes. This enables &product-name; to + translate mouse events over the VM window into tablet events + without having to "capture" the mouse in the guest as + described in . This + makes using the VM less tedious even if Guest Additions are + not installed. + + + + + + Enable I/O APIC: Advanced + Programmable Interrupt Controllers (APICs) are an x86 + hardware feature that have replaced Programmable Interrupt + Controllers (PICs). With an I/O APIC, OSes can use more than + 16 interrupt requests (IRQs) and therefore avoid IRQ sharing + for improved reliability. + + + + + Enabling the I/O APIC is required, + especially for 64-bit Windows guest OSes. It is also + required if you want to use more than one virtual CPU in a + virtual machine. + + + + + However, software support for I/O APICs has been unreliable + with some OSes other than Windows. Also, the use of an I/O + APIC slightly increases the overhead of virtualization and + therefore slows down the guest OS a little. + + + + + All Windows OSes install different kernels, depending on + whether an I/O APIC is available. As with ACPI, the I/O + APIC therefore must not be turned off after + installation of a Windows guest OS. Turning it + on after installation will have no effect however. + + + + + + + Enable EFI: Enables + Extensible Firmware Interface (EFI), which replaces the + legacy BIOS and may be useful for certain advanced use + cases. See . + + + + + + Hardware Clock in UTC Time: + If selected, &product-name; will report the system time in + UTC format to the guest instead of the local (host) time. + This affects how the virtual real-time clock (RTC) operates + and may be useful for UNIX-like guest OSes, which typically + expect the hardware clock to be set to UTC. + + + + + + + In addition, you can turn off the Advanced + Configuration and Power Interface (ACPI) which + &product-name; presents to the guest OS by default. + + + + ACPI is the current industry standard to allow OSes to recognize + hardware, configure motherboards and other devices and manage + power. As most computers contain this feature and Windows and + Linux support ACPI, it is also enabled by default in + &product-name;. ACPI can only be turned off using the command + line. See . + + + + + All Windows OSes install different kernels, depending on + whether ACPI is available. This means that ACPI must + not be turned off after installation of a Windows + guest OS. However, turning it on after installation will have + no effect. + + + + + + + + Processor Tab + + + On the Processor tab, you can + configure settings for the CPU used by the virtual machine. + + + + + + + Processor(s): Sets the + number of virtual CPU cores the guest OSes can see. + &product-name; supports symmetrical multiprocessing (SMP) + and can present up to 32 virtual CPU cores to each virtual + machine. + + + + You should not configure virtual machines to use more CPU + cores than are available physically. This includes real + cores, with no hyperthreads. + + + + + + Execution Cap: Configures + the CPU execution cap. This limits the amount of time a host + CPU spends to emulate a virtual CPU. The default setting is + 100%, meaning that there is no limitation. A setting of 50% + implies a single virtual CPU can use up to 50% of a single + host CPU. Note that limiting the execution time of the + virtual CPUs may cause guest timing problems. + + + + A warning is displayed at the bottom of the Processor tab if + an Execution Cap setting is made that may affect system + performance. + + + + + + Enable PAE/NX: Determines + whether the PAE and NX capabilities of the host CPU will be + exposed to the virtual machine. + + + + PAE stands for Physical Address Extension. Normally, if + enabled and supported by the OS, then even a 32-bit x86 CPU + can access more than 4 GB of RAM. This is made possible by + adding another 4 bits to memory addresses, so that with 36 + bits, up to 64 GB can be addressed. Some OSes, such as + Ubuntu Server, require PAE support from the CPU and cannot + be run in a virtual machine without it. + + + + + + Enable Nested VT-x/AMD-V: + Enables nested virtualization, with passthrough of hardware + virtualization functions to the guest VM. + + + + + + + With virtual machines running modern server OSes, &product-name; + also supports CPU hot-plugging. For details, see + . + + + + + + + Acceleration Tab + + + On this tab, you can configure &product-name; to use hardware + virtualization extensions that your host CPU supports. + + + + + + + Paravirtualization + Interface: &product-name; provides + paravirtualization interfaces to improve time-keeping + accuracy and performance of guest OSes. The options + available are documented under the + option in + . For further details + on the paravirtualization providers, see + . + + + + + + Hardware Virtualization: + You can configure hardware virtualization features for each + virtual machine. + + + + + + + Enable Nested Paging: + If the host CPU supports the nested paging (AMD-V) or + EPT (Intel VT-x) features, then you can expect a + significant performance increase by enabling nested + paging in addition to hardware virtualization. For + technical details, see . + For Intel EPT security recommendations, see + . + + + + + + + Advanced users may be interested in technical details about + hardware virtualization. See . + + + + + + + In most cases, the default settings on the + Acceleration tab will work + well. &product-name; selects sensible defaults, depending on the + OS that you selected when you created the virtual machine. In + certain situations, however, you may want to change the + preconfigured defaults. + + + + + + + + + Display Settings + + + The following tabs are available for configuring the display for a + virtual machine. + + + + + Screen Tab + + + + + + Video Memory: Sets the size + of the memory provided by the virtual graphics card + available to the guest, in MB. As with the main memory, the + specified amount will be allocated from the host's resident + memory. Based on the amount of video memory, higher + resolutions and color depths may be available. + + + + The GUI will show a warning if the amount of video memory is + too small to be able to switch the VM into full screen mode. + The minimum value depends on the number of virtual monitors, + the screen resolution and the color depth of the host + display as well as on the use of 3D + acceleration and 2D video + acceleration. A rough estimate is + (color depth / 8) x vertical + pixels x horizontal pixels x + number of screens = number of + bytes. Extra memory may be required if display + acceleration is used. + + + + + + Monitor Count: With this + setting, &product-name; can provide more than one virtual + monitor to a virtual machine. If a guest OS supports + multiple attached monitors, &product-name; can pretend that + multiple virtual monitors are present. Up to eight such + virtual monitors are supported. + + + + The output of the multiple monitors are displayed on the + host in multiple VM windows which are running side by side. + However, in full screen and seamless mode, they use the + available physical monitors attached to the host. As a + result, for full screen and seamless modes to work with + multiple monitors, you will need at least as many physical + monitors as you have virtual monitors configured, or + &product-name; will report an error. + + + + You can configure the relationship between guest and host + monitors using the View + menu by pressing Host key + Home when you are in full screen + or seamless mode. + + + + See also . + + + + + + Scale Factor: Enables + scaling of the display size. For multiple monitor displays, + you can set the scale factor for individual monitors, or + globally for all of the monitors. Use the slider to select a + scaling factor up to 200%. + + + + You can set a default scale factor for all VMs. Use the + Display tab in the Global + Settings dialogs. + + + + + + Graphics Controller: + Specifies the graphics adapter type used by the guest VM. + Note that you must install the Guest Additions on the guest + VM to specify the VBoxSVGA or VMSVGA graphics controller. + The following options are available: + + + + + + + VBoxSVGA: The default + graphics controller for new VMs that use Windows 7 or + later. + + + + This graphics controller improves performance and 3D + support when compared to the legacy VBoxVGA option. + + + + + + VBoxVGA: Use this + graphics controller for legacy guest OSes. This is the + default graphics controller for Windows versions before + Windows 7 and for Oracle Solaris. + + + + 3D acceleration is not supported for this graphics + controller. + + + + + + VMSVGA: Use this + graphics controller to emulate a VMware SVGA graphics + device. This is the default graphics controller for + Linux guests. + + + + + + None: Does not emulate + a graphics adapter type. + + + + + + + + + Enable 3D Acceleration: If + a virtual machine has Guest Additions installed, you can + select here whether the guest should support accelerated 3D + graphics. See . + + + + + + Enable 2D Video + Acceleration: If a virtual machine with Microsoft + Windows has Guest Additions installed, you can select here + whether the guest should support accelerated 2D video + graphics. See . + + + + + + + + + + Remote Display Tab + + + On the Remote Display tab, if + the VirtualBox Remote Display Extension (VRDE) is installed, you + can enable the VRDP server that is built into &product-name;. + This enables you to connect to the console of the virtual + machine remotely with any standard RDP viewer, such as + mstsc.exe that comes with Microsoft Windows. + On Linux and Oracle Solaris systems you can use the standard + open source rdesktop program. These features + are described in . + + + + + + + Enable Server: Select this + check box and configure settings for the remote display + connection. + + + + + + + + + + Recording Tab + + + On the Recording tab you can + enable video and audio recording for a virtual machine and + change related settings. Note that these features can be enabled + and disabled while a VM is running. + + + + + + + Enable Recording: Select + this check box and select a Recording + Mode option. + + + + + + Recording Mode: You can + choose to record video, audio, or both video and audio. + + + + Some settings on the + Recording tab may be grayed + out, depending on the Recording + Mode setting. + + + + + + File Path: The file where + the recording is saved. + + + + + + Frame Size: The video + resolution of the recorded video, in pixels. The drop-down + list enables you to select from common frame sizes. + + + + + + Frame Rate: Use the slider + to set the maximum number of video frames per second (FPS) + to record. Frames that have a higher frequency are skipped. + Increasing this value reduces the number of skipped frames + and increases the file size. + + + + + + Video Quality: Use the + slider to set the the bit rate of the video in kilobits per + second. Increasing this value improves the appearance of the + video at the cost of an increased file size. + + + + + + Audio Quality: Use the + slider to set the quality of the audio recording. Increasing + this value improves the audio quality at the cost of an + increased file size. + + + + + + Screens: For a multiple + monitor display, you can select which screens to record + video from. + + + + + + + As you adjust the video and audio recording settings, the + approximate output file size for a five minute video is shown. + + + + + + + + + Storage Settings + + + The Storage category in the VM + settings enables you to connect virtual hard disk, CD/DVD, and + floppy images and drives to your virtual machine. + + + + In a real computer, so-called storage + controllers connect physical disk drives to the rest of + the computer. Similarly, &product-name; presents virtual storage + controllers to a virtual machine. Under each controller, the + virtual devices, such as hard disks, CD/DVD or floppy drives, + attached to the controller are shown. + + + + + This section gives a quick introduction to the &product-name; + storage settings. See for a full + description of the available storage settings in &product-name;. + + + + + If you have used the Create VM + wizard to create a machine, you will normally see something like + the following: + + +
+ Storage Settings for a Virtual Machine + + + + + +
+ + + Depending on the guest OS type that you selected when you created + the VM, a new VM includes the following storage devices: + + + + + + + IDE controller. A virtual + CD/DVD drive is attached to device 0 on the secondary channel + of the IDE controller. + + + + + + SATA controller. This is a + modern type of storage controller for higher hard disk data + throughput, to which the virtual hard disks are attached. + Initially you will normally have one such virtual disk, but as + shown in the previous screenshot, you can have more than one. + Each is represented by a disk image file, such as a VDI file + in this example. + + + + + + + If you created your VM with an older version of &product-name;, + the default storage layout may differ. You might then only have an + IDE controller to which both the CD/DVD drive and the hard disks + have been attached. This might also apply if you selected an older + OS type when you created the VM. Since older OSes do not support + SATA without additional drivers, &product-name; will make sure + that no such devices are present initially. See + . + + + + &product-name; also provides a floppy + controller. You cannot add devices other than floppy + drives to this controller. Virtual floppy drives, like virtual + CD/DVD drives, can be connected to either a host floppy drive, if + you have one, or a disk image, which in this case must be in RAW + format. + + + + You can modify these media attachments freely. For example, if you + wish to copy some files from another virtual disk that you + created, you can connect that disk as a second hard disk, as in + the above screenshot. You could also add a second virtual CD/DVD + drive, or change where these items are attached. The following + options are available: + + + + + + + To add another virtual hard disk, or a + CD/DVD or floppy drive, select the storage + controller to which it should be added (such as IDE, SATA, + SCSI, SAS, floppy controller) and then click the + Add Disk button below the + tree. You can then either select Optical + Drive or Hard + Disk. If you clicked on a floppy controller, you + can add a floppy drive instead. Alternatively, right-click on + the storage controller and select a menu item there. + + + + A dialog is displayed, enabling you to select an existing disk + image file or to create a new disk image file. Depending on + the type of disk image, the dialog is called + Hard Disk Selector, + Optical Disk Selector, or + Floppy Disk Selector. + + + + See for information on the image + file types that are supported by &product-name;. + + + + For virtual CD/DVD drives, the image files will typically be + in the standard ISO format instead. Most commonly, you will + select this option when installing an OS from an ISO file that + you have obtained from the Internet. For example, most Linux + distributions are available in this way. + + + + Depending on the type of disk image, you can set the following + Attributes for the disk image + in the right part of the Storage settings page: + + + + + + + The device slot of the + controller that the virtual disk is connected to. IDE + controllers have four slots: primary device 0, primary + device 1, secondary device 0, and secondary device 1. By + contrast, SATA and SCSI controllers offer you up to 30 + slots for attaching virtual devices. + + + + + + Solid-state Drive + presents a virtual disk to the guest as a solid-state + device. + + + + + + Hot-pluggable presents a + virtual disk to the guest as a hot-pluggable device. + + + + + + For virtual CD/DVD drives, you can select + Live CD/DVD. This means + that the virtual optical disk is not removed from when the + guest system ejects it. + + + + + + + + + To remove an attachment, + either select it and click on the + Remove icon at the bottom, or + right-click on it and select the menu item. + + + + + + + Removable media, such as CD/DVDs and floppies, can be changed + while the guest is running. Since the + Settings dialog is not available + at that time, you can also access these settings from the + Devices menu of your virtual + machine window. + + + + + + + Audio Settings + + + The Audio section in a virtual + machine's Settings window + determines whether the VM will detect a connected sound card, and + if the audio output should be played on the host system. + + + + To enable audio for a guest, select the + Enable Audio check box. The + following settings are available: + + + + + + + Host Audio Driver: The audio + driver that &product-name; uses on the host. On a Linux host, + depending on your host configuration, you can select between + the OSS, ALSA, or the PulseAudio subsystem. On newer Linux + distributions, the PulseAudio subsystem is preferred. + + + + Only OSS is supported on Oracle Solaris hosts. The Oracle + Solaris Audio audio backend is no longer supported on Oracle + Solaris hosts. + + + + + + Audio Controller: You can + choose between the emulation of an Intel AC'97 controller, an + Intel HD Audio controller, or a SoundBlaster 16 card. + + + + + + Enable Audio Output: Enables + audio output only for the VM. + + + + + + Enable Audio Input: Enables + audio input only for the VM. + + + + + + + + + + Network Settings + + + The Network section in a virtual + machine's Settings window enables + you to configure how &product-name; presents virtual network cards + to your VM, and how they operate. + + + + When you first create a virtual machine, &product-name; by default + enables one virtual network card and selects the Network Address + Translation (NAT) mode for it. This way the guest can connect to + the outside world using the host's networking and the outside + world can connect to services on the guest which you choose to + make visible outside of the virtual machine. + + + + This default setup is good for the majority of &product-name; + users. However, &product-name; is extremely flexible in how it can + virtualize networking. It supports many virtual network cards per + virtual machine. The first four virtual network cards can be + configured in detail in the VirtualBox Manager window. Additional + network cards can be configured using the + VBoxManage command. + + + + Many networking options are available. See + for more information. + + + + + + + Serial Ports + + + &product-name; supports the use of virtual serial ports in a + virtual machine. + + + + Ever since the original IBM PC, personal computers have been + equipped with one or two serial ports, also called COM ports by + DOS and Windows. Serial ports were commonly used with modems, and + some computer mice used to be connected to serial ports before USB + became commonplace. + + + + While serial ports are no longer as common as they used to be, + there are still some important uses left for them. For example, + serial ports can be used to set up a primitive network over a + null-modem cable, in case Ethernet is not available. Also, serial + ports are indispensable for system programmers needing to do + kernel debugging, since kernel debugging software usually + interacts with developers over a serial port. With virtual serial + ports, system programmers can do kernel debugging on a virtual + machine instead of needing a real computer to connect to. + + + + If a virtual serial port is enabled, the guest OS sees a standard + 16550A compatible UART device. Other UART types can be configured + using the VBoxManage modifyvm command. Both + receiving and transmitting data is supported. How this virtual + serial port is then connected to the host is configurable, and the + details depend on your host OS. + + + + You can use either the Settings tabs or the + VBoxManage command to set up virtual serial + ports. For the latter, see + for information on the , + and + options. + + + + You can configure up to four virtual serial ports per virtual + machine. For each device, you must set the following: + + + + + + + Port Number: This determines + the serial port that the virtual machine should see. For best + results, use the traditional values as follows: + + + + + + + COM1: I/O base 0x3F8, IRQ 4 + + + + + + COM2: I/O base 0x2F8, IRQ 3 + + + + + + COM3: I/O base 0x3E8, IRQ 4 + + + + + + COM4: I/O base 0x2E8, IRQ 3 + + + + + + + You can also configure a user-defined serial port. Enter an + I/O base address and interrupt (IRQ). + + + + + + Port Mode: What the virtual + port is connected to. For each virtual serial port, you have + the following options: + + + + + + + Disconnected: The guest + will see the device, but it will behave as if no cable had + been connected to it. + + + + + + Host Device: Connects the + virtual serial port to a physical serial port on your + host. On a Windows host, this will be a name like + COM1. On Linux or Oracle Solaris hosts, + it will be a device node like + /dev/ttyS0. &product-name; will then + simply redirect all data received from and sent to the + virtual serial port to the physical device. + + + + + + Host Pipe: Configure + &product-name; to connect the virtual serial port to a + software pipe on the host. This depends on your host OS, + as follows: + + + + + + + On a Windows host, data will be sent and received + through a named pipe. The pipe name must be in the + format + \\.\pipe\name + where name should identify + the virtual machine but may be freely chosen. + + + + + + On a Mac OS, Linux, or Oracle Solaris host, a local + domain socket is used instead. The socket filename + must be chosen such that the user running + &product-name; has sufficient privileges to create and + write to it. The /tmp directory + is often a good candidate. + + + + On Linux there are various tools which can connect to + a local domain socket or create one in server mode. + The most flexible tool is socat and + is available as part of many distributions. + + + + + + + In this case, you can configure whether &product-name; + should create the named pipe, or the local domain socket + non-Windows hosts, itself or whether &product-name; should + assume that the pipe or socket exists already. With the + VBoxManage command-line options, this + is referred to as server mode or client mode, + respectively. + + + + For a direct connection between two virtual machines, + corresponding to a null-modem cable, simply configure one + VM to create a pipe or socket and another to attach to it. + + + + + + Raw File: Send the + virtual serial port output to a file. This option is very + useful for capturing diagnostic output from a guest. Any + file may be used for this purpose, as long as the user + running &product-name; has sufficient privileges to create + and write to the file. + + + + + + TCP Socket: Useful for + forwarding serial traffic over TCP/IP, acting as a server, + or it can act as a TCP client connecting to other servers. + This option enables a remote machine to directly connect + to the guest's serial port using TCP. + + + + + + + TCP Server: Deselect + the Connect to Existing + Pipe/Socket check box and specify the port + number in the + Path/Address field. + This is typically 23 or 2023. Note that on UNIX-like + systems you will have to use a port a number greater + than 1024 for regular users. + + + + The client can use software such as + PuTTY or the + telnet command line tool to access + the TCP Server. + + + + + + TCP Client: To create + a virtual null-modem cable over the Internet or LAN, + the other side can connect using TCP by specifying + hostname:port + in the Path/Address + field. The TCP socket will act in client mode if you + select the Connect to Existing + Pipe/Socket check box. + + + + + + + + + + + + + Up to four serial ports can be configured per virtual machine, but + you can pick any port numbers out of the above. However, serial + ports cannot reliably share interrupts. If both ports are to be + used at the same time, they must use different interrupt levels, + for example COM1 and COM2, but not COM1 and COM3. + + + + + + + USB Support + + + + USB Settings + + + The USB section in a virtual + machine's Settings window + enables you to configure &product-name;'s sophisticated USB + support. + + + + &product-name; can enable virtual machines to access the USB + devices on your host directly. To achieve this, &product-name; + presents the guest OS with a virtual USB controller. As soon as + the guest system starts using a USB device, it will appear as + unavailable on the host. + + + + + + + + Be careful with USB devices that are currently in use on + the host. For example, if you allow your guest to connect + to your USB hard disk that is currently mounted on the + host, when the guest is activated, it will be disconnected + from the host without a proper shutdown. This may cause + data loss. + + + + + + Oracle Solaris hosts have a few known limitations + regarding USB support. See . + + + + + + + + In addition to allowing a guest access to your local USB + devices, &product-name; even enables your guests to connect to + remote USB devices by use of the VirtualBox Remote Desktop + Extension (VRDE). See . + + + + To enable USB for a VM, select the Enable + USB Controller check box. The following settings are + available: + + + + + + + USB Controller: Selects a + controller with the specified level of USB support, as + follows: + + + + + + + OHCI for USB 1.1 + + + + + + EHCI for USB 2.0. This also enables OHCI. + + + + + + xHCI for USB 3.0. This supports all USB speeds. + + + + + + + + The xHCI and EHCI controllers are shipped as an + &product-name; extension package, which must be installed + separately. See . + + + + + + + USB Device Filters: When + USB support is enabled for a VM, you can determine in detail + which devices will be automatically attached to the guest. + For this, you can create filters by specifying certain + properties of the USB device. USB devices with a matching + filter will be automatically passed to the guest once they + are attached to the host. USB devices without a matching + filter can be passed manually to the guest, for example by + using the Devices, + USB menu. + + + + Clicking on the + button to + the right of the USB Device + Filters window creates a new filter. You can give + the filter a name, for later reference, and specify the + filter criteria. The more criteria you specify, the more + precisely devices will be selected. For instance, if you + specify only a vendor ID of 046d, all devices produced by + Logitech will be available to the guest. If you fill in all + fields, on the other hand, the filter will only apply to a + particular device model from a particular vendor, and not + even to other devices of the same type with a different + revision and serial number. + + + + In detail, the following criteria are available: + + + + + + + Vendor and Product ID. + With USB, each vendor of USB products carries an + identification number that is unique world-wide, called + the vendor ID. Similarly, each line + of products is assigned a product + ID number. Both numbers are commonly written + in hexadecimal, and a colon separates the vendor from + the product ID. For example, + 046d:c016 stands for Logitech as a + vendor, and the M-UV69a Optical Wheel Mouse product. + + + + Alternatively, you can also specify + Manufacturer and + Product by name. + + + + To list all the USB devices that are connected to your + host machine with their respective vendor IDs and + product IDs, use the following command: + + +VBoxManage list usbhost + + + On Windows, you can also see all USB devices that are + attached to your system in the Device Manager. On Linux, + you can use the lsusb command. + + + + + + Serial Number. While + vendor ID and product ID are quite specific to identify + USB devices, if you have two identical devices of the + same brand and product line, you will also need their + serial numbers to filter them out correctly. + + + + + + Remote. This setting + specifies whether the device will be local only, remote + only, such as over VRDP, or either. + + + + + + + On a Windows host, you will need to unplug and reconnect a + USB device to use it after creating a filter for it. + + + + As an example, you could create a new USB filter and specify + a vendor ID of 046d for Logitech, Inc, a manufacturer index + of 1, and "not remote". Then any USB devices on the host + system produced by Logitech, Inc with a manufacturer index + of 1 will be visible to the guest system. + + + + Several filters can select a single device. For example, a + filter which selects all Logitech devices, and one which + selects a particular webcam. + + + + You can deactivate filters without deleting them by + deselecting the check box next to the filter name. + + + + + + + + + + Implementation Notes for Windows and Linux Hosts + + + On Windows hosts, a kernel mode device driver provides USB proxy + support. It implements both a USB monitor, which enables + &product-name; to capture devices when they are plugged in, and + a USB device driver to claim USB devices for a particular + virtual machine. System reboots are not necessary after + installing the driver. Also, you do not need to replug devices + for &product-name; to claim them. + + + + On supported Linux hosts, &product-name; accesses USB devices + through special files in the file system. When &product-name; is + installed, these are made available to all users in the + vboxusers system group. In order to be able + to access USB from guest systems, make sure that you are a + member of this group. + + + + + + + + + Shared Folders + + + Shared folders enable you to easily exchange data between a + virtual machine and your host. This feature requires that the + &product-name; Guest Additions be installed in a virtual machine + and is described in detail in . + + + + + + + User Interface + + + The User Interface section + enables you to change certain aspects of the user interface of + this VM. + + + + + + + Menu Bar: This widget enables + you to disable menus by clicking on the menu to release it, + menu entries by deselecting the check box of the entry to + disable it and the complete menu bar by deselecting the + rightmost check box. + + + + + + Mini ToolBar: In full screen + or seamless mode, &product-name; can display a small toolbar + that contains some of the items that are normally available + from the virtual machine's menu bar. This toolbar reduces + itself to a small gray line unless you move the mouse over it. + With the toolbar, you can return from full screen or seamless + mode, control machine execution or enable certain devices. If + you do not want to see the toolbar, disable this setting. + + + + The second setting enables you to show the toolbar at the top + of the screen, instead of showing it at the bottom. + + + + + + Status Bar: This widget + enables you to disable icons on the status bar by deselecting + the check box of an icon to disable it, to rearrange icons by + dragging and dropping the icon, and to disable the complete + status bar by deselecting the leftmost check box. + + + + + + + + + + Alternative Firmware (EFI) + + + &product-name; includes experimental support for the Extensible + Firmware Interface (EFI), which is an industry standard intended + to replace the legacy BIOS as the primary interface for + bootstrapping computers and certain system services later. + + + + By default, &product-name; uses the BIOS firmware for virtual + machines. To use EFI for a given virtual machine, you can enable + EFI in the machine's Settings + dialog. See . Alternatively, + use the VBoxManage command line interface as + follows: + + +VBoxManage modifyvm "VM name" --firmware efi + + + To switch back to using the BIOS: + + +VBoxManage modifyvm "VM name" --firmware bios + + + One notable user of EFI is Apple Mac OS X. More recent Linux + versions and Windows releases, starting with Vista, also offer + special versions that can be booted using EFI. + + + + Another possible use of EFI in &product-name; is development and + testing of EFI applications, without booting any OS. + + + + Note that the &product-name; EFI support is experimental and will + be enhanced as EFI matures and becomes more widespread. Mac OS X, + Linux, and newer Windows guests are known to work fine. Windows 7 + guests are unable to boot with the &product-name; EFI + implementation. + + + + + Video Modes in EFI + + + EFI provides two distinct video interfaces: GOP (Graphics Output + Protocol) and UGA (Universal Graphics Adapter). Modern OSes, + such as Mac OS X, generally use GOP, while some older ones still + use UGA. &product-name; provides a configuration option to + control the graphics resolution for both interfaces, making the + difference mostly irrelevant for users. + + + + The default resolution is 1024x768. To select a graphics + resolution for EFI, use the following + VBoxManage command: + + +VBoxManage setextradata "VM name" VBoxInternal2/EfiGraphicsResolution HxV + + + Determine the horizontal resolution H and the vertical + resolution V from the following list of default resolutions: + + + + + + + VGA + + + + + 640x480, 32bpp, 4:3 + + + + + + + SVGA + + + + + 800x600, 32bpp, 4:3 + + + + + + + XGA + + + + + 1024x768, 32bpp, 4:3 + + + + + + + XGA+ + + + + + 1152x864, 32bpp, 4:3 + + + + + + + HD + + + + + 1280x720, 32bpp, 16:9 + + + + + + + WXGA + + + + + 1280x800, 32bpp, 16:10 + + + + + + + SXGA + + + + + 1280x1024, 32bpp, 5:4 + + + + + + + SXGA+ + + + + + 1400x1050, 32bpp, 4:3 + + + + + + + WXGA+ + + + + + 1440x900, 32bpp, 16:10 + + + + + + + HD+ + + + + + 1600x900, 32bpp, 16:9 + + + + + + + UXGA + + + + + 1600x1200, 32bpp, 4:3 + + + + + + + WSXGA+ + + + + + 1680x1050, 32bpp, 16:10 + + + + + + + Full HD + + + + + 1920x1080, 32bpp, 16:9 + + + + + + + WUXGA + + + + + 1920x1200, 32bpp, 16:10 + + + + + + + DCI 2K + + + + + 2048x1080, 32bpp, 19:10 + + + + + + + Full HD+ + + + + + 2160x1440, 32bpp, 3:2 + + + + + + + Unnamed + + + + + 2304x1440, 32bpp, 16:10 + + + + + + + QHD + + + + + 2560x1440, 32bpp, 16:9 + + + + + + + WQXGA + + + + + 2560x1600, 32bpp, 16:10 + + + + + + + QWXGA+ + + + + + 2880x1800, 32bpp, 16:10 + + + + + + + QHD+ + + + + + 3200x1800, 32bpp, 16:9 + + + + + + + WQSXGA + + + + + 3200x2048, 32bpp, 16:10 + + + + + + + 4K UHD + + + + + 3840x2160, 32bpp, 16:9 + + + + + + + WQUXGA + + + + + 3840x2400, 32bpp, 16:10 + + + + + + + DCI 4K + + + + + 4096x2160, 32bpp, 19:10 + + + + + + + HXGA + + + + + 4096x3072, 32bpp, 4:3 + + + + + + + UHD+ + + + + + 5120x2880, 32bpp, 16:9 + + + + + + + WHXGA + + + + + 5120x3200, 32bpp, 16:10 + + + + + + + WHSXGA + + + + + 6400x4096, 32bpp, 16:10 + + + + + + + HUXGA + + + + + 6400x4800, 32bpp, 4:3 + + + + + + + 8K UHD2 + + + + + 7680x4320, 32bpp, 16:9 + + + + + + + + If this list of default resolution does not cover your needs, + see . Note that the color depth + value specified in a custom video mode must be specified. Color + depths of 8, 16, 24, and 32 are accepted. EFI assumes a color + depth of 32 by default. + + + + The EFI default video resolution settings can only be changed + when the VM is powered off. + + + + + + + Specifying Boot Arguments + + + It is currently not possible to manipulate EFI variables from + within a running guest. For example, setting the + boot-args variable by running the + nvram tool in a Mac OS X guest will not work. + As an alternative method, + VBoxInternal2/EfiBootArgs extradata can be + passed to a VM in order to set the boot-args + variable. To change the boot-args EFI + variable, use the following command: + + +VBoxManage setextradata "VM name" VBoxInternal2/EfiBootArgs <value> + + + + + + diff --git a/doc/manual/en_US/user_ChangeLog.xml b/doc/manual/en_US/user_ChangeLog.xml new file mode 100644 index 00000000..5a2567e7 --- /dev/null +++ b/doc/manual/en_US/user_ChangeLog.xml @@ -0,0 +1,48 @@ + + +%all.entities; +]> + + + Change Log + + + This section summarizes the changes between &product-name; versions. + Note that this change log is not exhaustive and not all changes are + listed. + + + + &product-name; version numbers consist of three numbers separated by + dots where the first and second number represent the major version + and the third number the minor version. Minor version numbers of + official releases are always even. An odd minor version number + represents an internal development or test build. In addition, each + build contains a revision number. + + + + + + + Change Logs for Legacy Versions + + + To view the change log for a legacy version of VirtualBox see the + documentation for the relevant &product-name; release. + + + + Change logs are also available at: + + + + . + + + + + diff --git a/doc/manual/en_US/user_Frontends.xml b/doc/manual/en_US/user_Frontends.xml new file mode 100644 index 00000000..399b12f0 --- /dev/null +++ b/doc/manual/en_US/user_Frontends.xml @@ -0,0 +1,1210 @@ + + +%all.entities; +]> + + + Remote Virtual Machines + + + + Remote Display (VRDP Support) + + + &product-name; can display virtual machines remotely, meaning that + a virtual machine can execute on one computer even though the + machine will be displayed on a second computer, and the machine + will be controlled from there as well, as if the virtual machine + was running on that second computer. + + + + For maximum flexibility, &product-name; implements remote machine + display through a generic extension interface called the + VirtualBox Remote Desktop Extension (VRDE). The base open source + &product-name; package only provides this interface, while + implementations can be supplied by third parties with + &product-name; extension packages, which must be installed + separately from the base package. See + . + + + + Oracle provides support for the VirtualBox Remote Display Protocol + (VRDP) in such an &product-name; extension package. + + + + VRDP is a backwards-compatible extension to Microsoft's Remote + Desktop Protocol (RDP). As a result, you can use any standard RDP + client to control the remote VM. + + + + Even when the extension is installed, the VRDP server is disabled + by default. It can easily be enabled on a per-VM basis either in + the VirtualBox Manager in the + Display settings, see + , or with the + VBoxManage command, as follows: + + +$ VBoxManage modifyvm VM-name --vrde on + + + By default, the VRDP server uses TCP port 3389. + You will need to change the default port if you run more than one + VRDP server, since the port can only be used by one server at a + time. You might also need to change it on Windows hosts since the + default port might already be used by the RDP server that is built + into Windows itself. Ports 5000 through 5050 are typically not + used and might be a good choice. + + + + The port can be changed either in the + Display settings of the graphical + user interface or with the option of + the VBoxManage modifyvm command. You can + specify a comma-separated list of ports or ranges of ports. Use a + dash between two port numbers to specify a range. The VRDP server + will bind to one of the available ports from + the specified list. For example, VBoxManage modifyvm + VM-name --vrdeport + 5000,5010-5012 configures the server to bind to one of + the ports 5000, 5010, 5011, or 5012. See + . + + + + The actual port used by a running VM can be either queried with + the VBoxManage showvminfo command or seen in + the GUI on the Runtime tab of the + Session Information dialog, which + is accessible from the Machine + menu of the VM window. + + + + &product-name; supports IPv6. If the host OS supports IPv6 the + VRDP server will automatically listen for IPv6 connections in + addition to IPv4. + + + + + Common Third-Party RDP Viewers + + + Since VRDP is backwards-compatible to RDP, you can use any + standard RDP viewer to connect to such a remote virtual machine. + For this to work, you must specify the IP address of your + host system, not of the virtual machine, as + the server address to connect to. You must also specify the port + number that the VRDP server is using. + + + + The following examples are for the most common RDP viewers: + + + + + + + On Windows, you can use the Microsoft Terminal Services + Connector, mstsc.exe, that is included + with Windows. Press the Windows key + R, to display the + Run dialog. Enter + mstsc to start the program. You can also + find the program in Start, + All Programs, + Accessories, + Remote Desktop Connection. + If you use the Run dialog, + you can enter options directly. For example: + + +mstsc 1.2.3.4:3389 + + + Replace 1.2.3.4 with the host IP address, + and 3389 with a different port, if + necessary. + + + + + + + + IPv6 addresses must be enclosed in square brackets to + specify a port. For example: mstsc + [fe80::1:2:3:4]:3389 + + + + + + When connecting to localhost in order to test the + connection, the addresses localhost + and 127.0.0.1 might not work using + mstsc.exe. Instead, the address + 127.0.0.2[:3389] has to be used. + + + + + + + + + + On other systems, you can use the standard open source + rdesktop program. This ships with most + Linux distributions, but &product-name; also comes with a + modified variant of rdesktop for remote + USB support. See . + + + + With rdesktop, use a command line such as + the following: + + +$ rdesktop -a 16 -N 1.2.3.4:3389 + + + Replace 1.2.3.4 with the host IP address, + and 3389 with a different port, if + necessary. The option requests a + color depth of 16 bits per pixel, which we recommend. For + best performance, after installation of the guest operating + system, you should set its display color depth to the same + value. The option enables use of the + NumPad keys. + + + + + + You can use the Remmina remote desktop client with VRDP. + This application is included with some Linux distributions, + such as Debian and Ubuntu. + + + + + + If you run the KDE desktop, you can use + krdc, the KDE RDP viewer. A typical + command line is as follows: + + +$ krdc rdp://1.2.3.4:3389 + + + Replace 1.2.3.4 with the host IP address, + and 3389 with a different port, if + necessary. The rdp:// prefix is required + with krdc to switch it into RDP mode. + + + + + + With Sun Ray thin clients you can use + uttsc, which is part of the Sun Ray + Windows Connector package. See the Sun Ray documentation for + details. + + + + + + + + + + VBoxHeadless, the Remote Desktop Server + + + While any VM started from the VirtualBox Manager is capable of + running virtual machines remotely, it is not convenient to have + to run the full GUI if you never want to have VMs displayed + locally in the first place. In particular, if you are running + server hardware whose only purpose is to host VMs, and all your + VMs are supposed to run remotely over VRDP, then it is pointless + to have a graphical user interface on the server at all. This is + especially true for Linux or Oracle Solaris hosts, as the + VirtualBox Manager comes with dependencies on the Qt and SDL + libraries. This is inconvenient if you would rather not have the + X Window system on your server at all. + + + + &product-name; therefore comes with a front-end called + VBoxHeadless, which produces no visible + output on the host at all, but still can optionally deliver VRDP + data. This front-end has no dependencies on the X Window system + on Linux and Oracle Solaris hosts. + + + + + In legacy releases of &product-name;, the headless server was + called VBoxVRDP. For backwards + compatibility, the &product-name; installation still includes + an executable with that name. + + + + + To start a virtual machine with VBoxHeadless, + you have the following options: + + + + + + + Use the VBoxManage command, as follows: + + +$ VBoxManage startvm VM-name --type headless + + + The option causes &product-name; to + use VBoxHeadless as the front-end to the + internal virtualization engine, instead of the Qt front-end. + + + + + + Use the VBoxHeadless command, as follows: + + +VBoxHeadless --startvm uuid|vmname + + + This way of starting the VM helps troubleshooting problems + reported by VBoxManage startvm, because + you can sometimes see more detailed error messages, + especially for early failures before the VM execution is + started. In normal situations VBoxManage + startvm is preferred, since it runs the VM + directly as a background process which has to be done + explicitly when directly starting with + VBoxHeadless. The full documentation of + the command is in . + + + + + + Start VBoxHeadless from the VirtualBox + Manager GUI, by pressing the Shift key when starting a + virtual machine or by selecting + Headless Start from the + Machine menu. + + + + + + + When you use the VBoxHeadless command to + start a VM, the VRDP server will be enabled according to the VM + configuration. You can override the VM's setting using + command line parameter. To enable the + VRDP server, start the VM as follows: + + +VBoxHeadless --startvm uuid|vmname --vrde on + + + To disable the VRDP server: + + +VBoxHeadless --startvm uuid|vmname --vrde off + + + To have the VRDP server enabled depending on the VM + configuration, as for other front-ends: + + +VBoxHeadless --startvm uuid|vmname --vrde config + + + This command is the same as the following: + + +VBoxHeadless --startvm uuid|vmname + + + If you start the VM with VBoxManage startvm + then the configuration settings of the VM are always used. + + + + + + + Step by Step: Creating a Virtual Machine on a Headless Server + + + The following instructions describe how to create a virtual + machine on a headless server over a network connection. This + example creates a virtual machine, establishes an RDP connection + and installs a guest operating system. All of these tasks are + done without having to touch the headless server. You need the + following prerequisites: + + + + + + + &product-name; on a server machine with a supported host + operating system. The &product-name; Extension Pack for the + VRDP server must be installed, see . + The procedures assume a Linux server is used. + + + + + + An ISO file accessible from the server, containing the + installation data for the guest operating system to install. + Windows XP is used in the example. + + + + + + A terminal connection to that host through which you can + access a command line, such as ssh. + + + + + + An RDP viewer on the remote client. See + for examples. + + + + + + + Note that on the server machine, since we will only use the + headless server, Qt and the X Window system are not required. + + + + + + + On the headless server, create a new virtual machine. For + example: + + +VBoxManage createvm --name "Windows XP" --ostype WindowsXP --register + + + If you do not specify , you will + have to manually use the registervm + command later. + + + + You do not need to specify , but + doing so selects some sensible default values for certain VM + parameters. For example, the RAM size and the type of the + virtual network device. To get a complete list of supported + operating systems you can use the following command: + + +VBoxManage list ostypes + + + + + Make sure the settings for the VM are appropriate for the + guest operating system that we will install. For example: + + +VBoxManage modifyvm "Windows XP" --memory 256 --acpi on --boot1 dvd --nic1 nat + + + + + Create a virtual hard disk for the VM. For example, to + create a 10 GB virtual hard disk: + + +VBoxManage createhd --filename "WinXP.vdi" --size 10000 + + + + + Add an IDE Controller to the new VM. For example: + + +VBoxManage storagectl "Windows XP" --name "IDE Controller" + --add ide --controller PIIX4 + + + + + Set the VDI file you created as the first virtual hard disk + of the new VM. For example: + + +VBoxManage storageattach "Windows XP" --storagectl "IDE Controller" + --port 0 --device 0 --type hdd --medium "WinXP.vdi" + + + + + Attach the ISO file that contains the operating system + installation that you want to install later to the virtual + machine. This is done so that the VM can boot from it. + + +VBoxManage storageattach "Windows XP" --storagectl "IDE Controller" + --port 0 --device 1 --type dvddrive --medium /full/path/to/iso.iso + + + + + Enable the VirtualBox Remote Desktop Extension, the VRDP + server, as follows: + + +VBoxManage modifyvm "Windows XP" --vrde on + + + + + Start the virtual machine using the + VBoxHeadless command: + + +VBoxHeadless --startvm "Windows XP" + + + If the configuration steps worked, you should see a + copyright notice. If you are returned to the command line, + then something did not work correctly. + + + + + + On the client machine, start the RDP viewer and connect to + the server. See for details + of how to use various common RDP viewers. + + + + The installation routine of your guest operating system + should be displayed in the RDP viewer. + + + + + + + + + + Remote USB + + + As a special feature additional to the VRDP support, + &product-name; also supports remote USB devices over the wire. + That is, an &product-name; guest that runs on one computer can + access the USB devices of the remote computer on which the VRDP + data is being displayed the same way as USB devices that are + connected to the actual host. This enables running of virtual + machines on an &product-name; host that acts as a server, where + a client can connect from elsewhere that needs only a network + adapter and a display capable of running an RDP viewer. When USB + devices are plugged into the client, the remote &product-name; + server can access them. + + + + For these remote USB devices, the same filter rules apply as for + other USB devices. See . All you + have to do is specify Remote, or Any, when setting up these + rules. + + + + Accessing remote USB devices is only possible if the RDP client + supports this extension. On Linux and Oracle Solaris hosts, the + &product-name; installation provides a suitable VRDP client + called rdesktop-vrdp. Some versions of + uttsc, a client tailored for the use with Sun + Ray thin clients, also support accessing remote USB devices. RDP + clients for other platforms will be provided in future + &product-name; versions. + + + + To make a remote USB device available to a VM, + rdesktop-vrdp should be started as follows: + + +rdesktop-vrdp -r usb -a 16 -N my.host.address + + + See for further details on how + to properly set up the permissions for USB devices. Furthermore + it is advisable to disable automatic loading of any host driver + on the remote host which might work on USB devices to ensure + that the devices are accessible by the RDP client. If the setup + was properly done on the remote host, plug and unplug events are + visible in the VBox.log file of the VM. + + + + + + + RDP Authentication + + + For each virtual machine that is remotely accessible using RDP, + you can individually determine if and how client connections are + authenticated. For this, use the VBoxManage + modifyvm command with the + option. See + . The following methods of + authentication are available: + + + + + + + The null method means that + there is no authentication at all. Any client can connect to + the VRDP server and thus the virtual machine. This is very + insecure and only to be recommended for private networks. + + + + + + The external method + provides external authentication through a special + authentication library. &product-name; ships with two + special authentication libraries: + + + + + + + The default authentication library, + VBoxAuth, authenticates against user + credentials of the hosts. Depending on the host + platform, this means the following: + + + + + + + On Linux hosts, VBoxAuth.so + authenticates users against the host's PAM system. + + + + + + On Windows hosts, VBoxAuth.dll + authenticates users against the host's WinLogon + system. + + + + + + On Mac OS X hosts, VBoxAuth.dylib + authenticates users against the host's directory + service. + + + + + + + In other words, the external method by default performs + authentication with the user accounts that exist on the + host system. Any user with valid authentication + credentials is accepted. For example, the username does + not have to correspond to the user running the VM. + + + + + + An additional library called + VBoxAuthSimple performs + authentication against credentials configured in the + extradata section of a virtual + machine's XML settings file. This is probably the + simplest way to get authentication that does not depend + on a running and supported guest. The following steps + are required: + + + + + + + Enable VBoxAuthSimple with the + following command: + + +VBoxManage setproperty vrdeauthlibrary "VBoxAuthSimple" + + + + + To enable the library for a particular VM, you must + switch authentication to external, as follows: + + +VBoxManage modifyvm VM-name --vrdeauthtype external + + + Replace VM-name with the + VM name or UUID. + + + + + + You then need to configure users and passwords by + writing items into the machine's extradata. Since + the XML machine settings file, into whose + extradata section the password + needs to be written, is a plain text file, + &product-name; uses hashes to encrypt passwords. The + following command must be used: + + +VBoxManage setextradata VM-name "VBoxAuthSimple/users/user" hash + + + Replace VM-name with the + VM name or UUID, user + with the user name who should be allowed to log in + and hash with the + encrypted password. The following command example + obtains the hash value for the password + secret: + + +$ VBoxManage internalcommands passwordhash "secret" +2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b + + + You then use VBoxManage + setextradata to store this value in the + machine's extradata section. + + + + As a combined example, to set the password for the + user john and the machine + My VM to + secret, use this command: + + +VBoxManage setextradata "My VM" "VBoxAuthSimple/users/john" + 2bb80d537b1da3e38bd30361aa855686bde0eacd7162fef6a25fe97bf527a25b + + + + + + + + + + + The guest authentication + method performs authentication with a special component that + comes with the Guest Additions. As a result, authentication + is not performed on the host, but with the guest user + accounts. + + + + This method is currently still in testing and not yet + supported. + + + + + + + In addition to the methods described above, you can replace the + default external authentication module with any other module. + For this, &product-name; provides a well-defined interface that + enables you to write your own authentication module. This is + described in detail in the &product-name; Software Development + Kit (SDK) reference. See . + + + + + + + RDP Encryption + + + RDP features data stream encryption, which is based on the RC4 + symmetric cipher, with keys up to 128-bit. The RC4 keys are + replaced at regular intervals, every 4096 packets. + + + + RDP provides the following different authentication methods: + + + + + + + RDP 4 authentication was + used historically. With RDP 4, the RDP client does not + perform any checks in order to verify the identity of the + server it connects to. Since user credentials can be + obtained using a man in the middle (MITM) attack, RDP4 + authentication is insecure and should generally not be used. + + + + + + RDP 5.1 authentication + employs a server certificate for which the client possesses + the public key. This way it is guaranteed that the server + possess the corresponding private key. However, as this + hard-coded private key became public some years ago, RDP 5.1 + authentication is also insecure. + + + + + + RDP 5.2 or later + authentication uses Enhanced RDP Security, which means that + an external security protocol is used to secure the + connection. RDP 4 and RDP 5.1 use Standard RDP Security. The + VRDP server supports Enhanced RDP Security with TLS protocol + and, as a part of the TLS handshake, sends the server + certificate to the client. + + + + The Security/Method VRDE property sets + the desired security method, which is used for a connection. + Valid values are as follows: + + + + + + + Negotiate. Both + Enhanced (TLS) and Standard RDP Security connections are + allowed. The security method is negotiated with the + client. This is the default setting. + + + + + + RDP. Only Standard RDP + Security is accepted. + + + + + + TLS. Only Enhanced RDP + Security is accepted. The client must support TLS. + + + + The version of OpenSSL used by &product-name; supports + TLS versions 1.0, 1.1, 1.2, and 1.3. + + + + + + + For example, the following command enables a client to use + either Standard or Enhanced RDP Security connection: + + +vboxmanage modifyvm VM-name --vrdeproperty "Security/Method=negotiate" + + + If the Security/Method property is set to + either Negotiate or TLS, the TLS protocol will be + automatically used by the server, if the client supports + TLS. However, in order to use TLS the server must possess + the Server Certificate, the Server Private Key and the + Certificate Authority (CA) Certificate. The following + example shows how to generate a server certificate. + + + + + + + Create a CA self signed certificate. + + +openssl req -new -x509 -days 365 -extensions v3_ca \ + -keyout ca_key_private.pem -out ca_cert.pem + + + + + Generate a server private key and a request for signing. + + +openssl genrsa -out server_key_private.pem +openssl req -new -key server_key_private.pem -out server_req.pem + + + + + Generate the server certificate. + + +openssl x509 -req -days 365 -in server_req.pem \ + -CA ca_cert.pem -CAkey ca_key_private.pem -set_serial 01 -out server_cert.pem + + + + + + The server must be configured to access the required files. + For example: + + +vboxmanage modifyvm VM-name \ + --vrdeproperty "Security/CACertificate=path/ca_cert.pem" + +vboxmanage modifyvm VM-name \ + --vrdeproperty "Security/ServerCertificate=path/server_cert.pem" + +vboxmanage modifyvm VM-name \ + --vrdeproperty "Security/ServerPrivateKey=path/server_key_private.pem" + + + + + + As the client that connects to the server determines what type + of encryption will be used, with rdesktop, + the Linux RDP viewer, use the or + options. + + + + + + + Multiple Connections to the VRDP Server + + + The VRDP server of &product-name; supports multiple simultaneous + connections to the same running VM from different clients. All + connected clients see the same screen output and share a mouse + pointer and keyboard focus. This is similar to several people + using the same computer at the same time, taking turns at the + keyboard. + + + + The following command enables multiple connection mode: + + +VBoxManage modifyvm VM-name --vrdemulticon on + + + + + + Multiple Remote Monitors + + + To access two or more remote VM displays you have to enable the + VRDP multiconnection mode. See + . + + + + The RDP client can select the virtual monitor number to connect + to using the domain login parameter + (). If the parameter ends with + @ followed by a number, &product-name; + interprets this number as the screen index. The primary guest + screen is selected with @1, the first + secondary screen is @2, and so on. + + + + The Microsoft RDP 6 client does not let you specify a separate + domain name. Instead, enter + domain\username + in the Username field. For + example, @2\name. + name must be supplied, and must be + the name used to log in if the VRDP server is set up to require + credentials. If it is not, you may use any text as the username. + + + + + + + VRDP Video Redirection + + + The VRDP server can redirect video streams from the guest to the + RDP client. Video frames are compressed using the JPEG algorithm + allowing a higher compression ratio than standard RDP bitmap + compression methods. It is possible to increase the compression + ratio by lowering the video quality. + + + + The VRDP server automatically detects video streams in a guest + as frequently updated rectangular areas. As a result, this + method works with any guest operating system without having to + install additional software in the guest. In particular, the + Guest Additions are not required. + + + + On the client side, however, currently only the Windows 7 Remote + Desktop Connection client supports this feature. If a client + does not support video redirection, the VRDP server falls back + to regular bitmap updates. + + + + The following command enables video redirection: + + +VBoxManage modifyvm VM-name --vrdevideochannel on + + + The quality of the video is defined as a value from 10 to 100 + percent, representing a JPEG compression level, where lower + numbers mean lower quality but higher compression. The quality + can be changed using the following command: + + +VBoxManage modifyvm VM-name --vrdevideochannelquality 75 + + + + + + VRDP Customization + + + You can disable display output, mouse and keyboard input, audio, + remote USB, or clipboard individually in the VRDP server. + + + + The following commands change the corresponding server settings: + + +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableDisplay=1 +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableInput=1 +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableUSB=1 +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableAudio=1 +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableClipboard=1 +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableUpstreamAudio=1 + + + To reenable a feature, use a similar command without the + trailing 1. For example: + + +$ VBoxManage modifyvm VM-name --vrdeproperty Client/DisableDisplay= + + + + + + + + Teleporting + + + &product-name; supports teleporting. + Teleporting is moving a virtual machine over a network from one + &product-name; host to another, while the virtual machine is + running. This works regardless of the host operating system that + is running on the hosts. You can teleport virtual machines between + Oracle Solaris and Mac OS X hosts, for example. + + + + Teleporting requires that a machine be currently running on one + host, which is called the source. The host to + which the virtual machine will be teleported is called the + target. The machine on the target is then + configured to wait for the source to contact the target. The + machine's running state will then be transferred from the source + to the target with minimal downtime. + + + + Teleporting happens over any TCP/IP network. The source and the + target only need to agree on a TCP/IP port which is specified in + the teleporting settings. + + + + At this time, there are a few prerequisites for this to work, as + follows: + + + + + + + On the target host, you must configure a virtual machine in + &product-name; with exactly the same hardware settings as the + machine on the source that you want to teleport. This does not + apply to settings which are merely descriptive, such as the VM + name, but obviously for teleporting to work, the target + machine must have the same amount of memory and other hardware + settings. Otherwise teleporting will fail with an error + message. + + + + + + The two virtual machines on the source and the target must + share the same storage, hard disks as well as floppy disks and + CD/DVD images. This means that they either use the same iSCSI + targets or that the storage resides somewhere on the network + and both hosts have access to it using NFS or SMB/CIFS. + + + + This also means that neither the source nor the target machine + can have any snapshots. + + + + + + + To configure teleporting, perform the following steps: + + + + + + + On the target host, configure the virtual + machine to wait for a teleport request to arrive when it is + started, instead of actually attempting to start the machine. + This is done with the following VBoxManage + command: + + +VBoxManage modifyvm targetvmname --teleporter on --teleporterport port + + + targetvmname is the name of the + virtual machine on the target host and + port is a TCP/IP port number to be + used on both the source and the target hosts. For example, use + 6000. See . + + + + + + Start the VM on the target host. Instead of running, the VM + shows a progress dialog, indicating that it is waiting for a + teleport request to arrive. + + + + + + Start the VM on the source host as usual. + When it is running and you want it to be teleported, issue the + following command on the source host: + + +VBoxManage controlvm sourcevmname teleport --host targethost --port port + + + where sourcevmname is the name of + the virtual machine on the source host, which is the machine + that is currently running. + targethost is the host or IP name + of the target host on which the machine is waiting for the + teleport request, and port must be + the same number as specified in the command on the target + host. See . + + + + + + + For testing, you can also teleport machines on the same host. In + that case, use localhost as the hostname on both the source and + the target host. + + + + + In rare cases, if the CPUs of the source and the target are very + different, teleporting can fail with an error message, or the + target may hang. This may happen especially if the VM is running + application software that is highly optimized to run on a + particular CPU without correctly checking that certain CPU + features are actually present. &product-name; filters what CPU + capabilities are presented to the guest operating system. + Advanced users can attempt to restrict these virtual CPU + capabilities with the VBoxManage modifyvm + --cpuid command. See + . + + + + + + + + diff --git a/doc/manual/en_US/user_Glossary.xml b/doc/manual/en_US/user_Glossary.xml new file mode 100644 index 00000000..0b88ca03 --- /dev/null +++ b/doc/manual/en_US/user_Glossary.xml @@ -0,0 +1,700 @@ + + +%all.entities; +]> + + + + A + + ACPI + + + + + Advanced Configuration and Power Interface, an industry + specification for BIOS and hardware extensions to configure PC + hardware and perform power management. Windows 2000 and later, + as well as Linux 2.4 and later support ACPI. Windows can only + enable or disable ACPI support at installation time. + + + + + + + AHCI + + + + + Advanced Host Controller Interface, the interface that + supports SATA devices such as hard disks. See + . + + + + + + + AMD-V + + + + + The hardware virtualization features built into modern AMD + processors. See . + + + + + + + API + + + + + Application Programming Interface. + + + + + + + APIC + + + + + Advanced Programmable Interrupt Controller, a newer version of + the original PC PIC (programmable interrupt controller). Most + modern CPUs contain an on-chip APIC, called a local APIC. Many + systems also contain an I/O APIC (input output APIC) as a + separate chip which provides more than 16 IRQs. Windows 2000 + and later use a different kernel if they detect an I/O APIC + during installation. Therefore, an I/O APIC must not be + removed after installation. + + + + + + + ATA + + + + + Advanced Technology Attachment, an industry standard for hard + disk interfaces which is synonymous with IDE. See + . + + + + + + + + + + + B + + BIOS + + + + + Basic Input/Output System, the firmware built into most + personal computers which is responsible of initializing the + hardware after the computer has been turned on and then + booting an operating system. &product-name; ships with its own + virtual BIOS that runs when a virtual machine is started. + + + + + + + + + + + C + + COM + + + + + Microsoft Component Object Model, a programming infrastructure + for modular software. COM enables applications to provide + application programming interfaces which can be accessed from + various other programming languages and applications. + &product-name; makes use of COM both internally and externally + to provide a comprehensive API to 3rd party developers. + + + + + + + + + + + D + + DHCP + + + + + Dynamic Host Configuration Protocol. This enables a networking + device in a network to acquire its IP address and other + networking details automatically, in order to avoid having to + configure all devices in a network with fixed IP addresses. + &product-name; has a built-in DHCP server that delivers an IP + addresses to a virtual machine when networking is configured + to NAT. See . + + + + + + + + + + + E + + EFI + + + + + Extensible Firmware Interface, a firmware built into computers + which is designed to replace the aging BIOS. Originally + designed by Intel, most modern operating systems can now boot + on computers which have EFI instead of a BIOS built into them. + See . + + + + + + + EHCI + + + + + Enhanced Host Controller Interface, the interface that + implements the USB 2.0 standard. + + + + + + + + + + + G + + GUI + + + + + Graphical User Interface. Commonly used as an antonym to a + "command line interface". In the context of &product-name;, we + sometimes refer to the main graphical + VirtualBox program as the "GUI", to + differentiate it from the VBoxManage + interface. + + + + + + + GUID + + + + + See UUID. + + + + + + + + + + + I + + IDE + + + + + Integrated Drive Electronics, an industry standard for hard + disk interfaces. See . + + + + + + + I/O APIC + + + + + See APIC. + + + + + + + iSCSI + + + + + Internet SCSI. See . + + + + + + + + + + + M + + MAC + + + + + Media Access Control, a part of an Ethernet network card. A + MAC address is a 6-byte number which identifies a network + card. It is typically written in hexadecimal notation where + the bytes are separated by colons, such as + 00:17:3A:5E:CB:08. + + + + + + + MSI + + + + + Message Signaled Interrupts, as supported by modern chipsets + such as the ICH9. See . + As opposed to traditional pin-based interrupts, with MSI, a + small amount of data can accompany the actual interrupt + message. This reduces the amount of hardware pins required and + allows for more interrupts and better performance. + + + + + + + + + + + N + + NAT + + + + + Network Address Translation. A technique to share networking + interfaces by which an interface modifies the source and/or + target IP addresses of network packets according to specific + rules. Commonly employed by routers and firewalls to shield an + internal network from the Internet, &product-name; can use NAT + to easily share a host's physical networking hardware with its + virtual machines. See . + + + + + + + + + + + O + + OVF + + + + + Open Virtualization Format, a cross-platform industry standard + to exchange virtual appliances between virtualization + products. See . + + + + + + + + + + + P + + PAE + + + + + Physical Address Extension. This enables access to more than 4 + GB of RAM, even in 32-bit environments. See + . + + + + + + + PIC + + + + + See APIC. + + + + + + + PXE + + + + + Preboot Execution Environment, an industry standard for + booting PC systems from remote network locations. It includes + DHCP for IP configuration and TFTP for file transfer. Using + UNDI, a hardware independent driver stack for accessing the + network card from bootstrap code is available. + + + + + + + + + + + R + + RDP + + + + + Remote Desktop Protocol, a protocol developed by Microsoft as + an extension to the ITU T.128 and T.124 video conferencing + protocol. With RDP, a PC system can be controlled from a + remote location using a network connection over which data is + transferred in both directions. Typically graphics updates and + audio are sent from the remote machine and keyboard and mouse + input events are sent from the client. An &product-name; + extension package by Oracle provides VRDP, an enhanced + implementation of the relevant standards which is largely + compatible with Microsoft's RDP implementation. See + for details. + + + + + + + + + + + S + + SAS + + + + + Serial Attached SCSI, an industry standard for hard disk + interfaces. See . + + + + + + + SATA + + + + + Serial ATA, an industry standard for hard disk interfaces. See + . + + + + + + + SCSI + + + + + Small Computer System Interface. An industry standard for data + transfer between devices, especially for storage. See + . + + + + + + + SMP + + + + + Symmetrical Multiprocessing, meaning that the resources of a + computer are shared between several processors. These can + either be several processor chips or, as is more common with + modern hardware, multiple CPU cores in one processor. + + + + + + + SSD + + + + + Solid-state drive, uses microchips for storing data in a + computer system. Compared to classical hard-disks they are + having no mechanical components like spinning disks. + + + + + + + + + + + T + + TAR + + + + + A widely used file format for archiving. Originally, this + stood for Tape ARchive and was already supported by very early + UNIX versions for backing up data on tape. The file format is + still widely used today. For example, with OVF archives using + an .ova file extension. See + . + + + + + + + + + + + U + + UUID + + + + + A Universally Unique Identifier, often also called GUID + (Globally Unique Identifier). A UUID is a string of numbers + and letters which can be computed dynamically and is + guaranteed to be unique. Generally, it is used as a global + handle to identify entities. &product-name; makes use of UUIDs + to identify VMs, Virtual Disk Images (VDI files), and other + entities. + + + + + + + + + + + V + + VM + + + + + Virtual Machine. A virtual computer that &product-name; + enables you to run on top of your actual hardware. See + for details. + + + + + + + VMM + + + + + Virtual Machine Manager. The component of &product-name; that + controls VM execution. See + for a list of + &product-name; components. + + + + + + + VRDE + + + + + VirtualBox Remote Desktop Extension. This interface is built + into &product-name; to allow &product-name; extension packages + to supply remote access to virtual machines. An &product-name; + extension package by Oracle provides VRDP support. See + . + + + + + + + VRDP + + + + + See RDP. + + + + + + + VT-x + + + + + The hardware virtualization features built into modern Intel + processors. See . + + + + + + + + + + + X + + xHCI + + + + + eXtended Host Controller Interface, the interface that + implements the USB 3.0 standard. + + + + + + + XML + + + + + The eXtensible Markup Language, a metastandard for all kinds + of textual information. XML only specifies how data in the + document is organized generally and does not prescribe how to + semantically organize content. + + + + + + + XPCOM + + + + + Mozilla Cross Platform Component Object Model, a programming + infrastructure developed by the Mozilla browser project which + is similar to Microsoft COM and enables applications to + provide a modular programming interface. &product-name; makes + use of XPCOM on Linux both internally and externally to + provide a comprehensive API to third-party developers. + + + + + + + + + diff --git a/doc/manual/en_US/user_GuestAdditions.xml b/doc/manual/en_US/user_GuestAdditions.xml new file mode 100644 index 00000000..30d98c19 --- /dev/null +++ b/doc/manual/en_US/user_GuestAdditions.xml @@ -0,0 +1,2478 @@ + + +%all.entities; +]> + + + Guest Additions + + + The previous chapter covered getting started with &product-name; and + installing operating systems in a virtual machine. For any serious + and interactive use, the &product-name; Guest Additions will make + your life much easier by providing closer integration between host + and guest and improving the interactive performance of guest + systems. This chapter describes the Guest Additions in detail. + + + + + Introduction to Guest Additions + + + As mentioned in , the Guest Additions + are designed to be installed inside a virtual + machine after the guest operating system has been installed. They + consist of device drivers and system applications that optimize + the guest operating system for better performance and usability. + See for details on what guest + operating systems are fully supported with Guest Additions by + &product-name;. + + + + The &product-name; Guest Additions for all supported guest + operating systems are provided as a single CD-ROM image file which + is called VBoxGuestAdditions.iso. This image + file is located in the installation directory of &product-name;. + To install the Guest Additions for a particular VM, you mount this + ISO file in your VM as a virtual CD-ROM and install from there. + + + + The Guest Additions offer the following features: + + + + + + + Mouse pointer integration. To + overcome the limitations for mouse support described in + , this feature provides + you with seamless mouse support. You will only have one mouse + pointer and pressing the Host key is no longer required to + free the mouse from being captured by the + guest OS. To make this work, a special mouse driver is + installed in the guest that communicates with the physical + mouse driver on your host and moves the guest mouse pointer + accordingly. + + + + + + Shared folders. These provide + an easy way to exchange files between the host and the guest. + Much like ordinary Windows network shares, you can tell + &product-name; to treat a certain host directory as a shared + folder, and &product-name; will make it available to the guest + operating system as a network share, irrespective of whether + the guest actually has a network. See + . + + + + + + Better video support. While + the virtual graphics card which &product-name; emulates for + any guest operating system provides all the basic features, + the custom video drivers that are installed with the Guest + Additions provide you with extra high and non-standard video + modes, as well as accelerated video performance. + + + + In addition, with Windows, Linux, and Oracle Solaris guests, + you can resize the virtual machine's window if the Guest + Additions are installed. The video resolution in the guest + will be automatically adjusted, as if you had manually entered + an arbitrary resolution in the guest's + Display settings. See + . + + + + If the Guest Additions are installed, 3D graphics and 2D video + for guest applications can be accelerated. See + . + + + + + + Seamless windows. With this + feature, the individual windows that are displayed on the + desktop of the virtual machine can be mapped on the host's + desktop, as if the underlying application was actually running + on the host. See . + + + + + + Generic host/guest communication + channels. The Guest Additions enable you to control + and monitor guest execution. The guest + properties provide a generic string-based mechanism + to exchange data bits between a guest and a host, some of + which have special meanings for controlling and monitoring the + guest. See . + + + + Additionally, applications can be started in a guest from the + host. See . + + + + + + Time synchronization. With + the Guest Additions installed, &product-name; can ensure that + the guest's system time is better synchronized with that of + the host. + + + + For various reasons, the time in the guest might run at a + slightly different rate than the time on the host. The host + could be receiving updates through NTP and its own time might + not run linearly. A VM could also be paused, which stops the + flow of time in the guest for a shorter or longer period of + time. When the wall clock time between the guest and host only + differs slightly, the time synchronization service attempts to + gradually and smoothly adjust the guest time in small + increments to either catch up or lose time. When the + difference is too great, for example if a VM paused for hours + or restored from saved state, the guest time is changed + immediately, without a gradual adjustment. + + + + The Guest Additions will resynchronize the time regularly. See + for how to configure the + parameters of the time synchronization mechanism. + + + + + + Shared clipboard. With the + Guest Additions installed, the clipboard of the guest + operating system can optionally be shared with your host + operating system. See . + + + + + + Automated logins. Also called + credentials passing. See . + + + + + + + Each version of &product-name;, even minor releases, ship with + their own version of the Guest Additions. While the interfaces + through which the &product-name; core communicates with the Guest + Additions are kept stable so that Guest Additions already + installed in a VM should continue to work when &product-name; is + upgraded on the host, for best results, it is recommended to keep + the Guest Additions at the same version. + + + + The Windows and Linux Guest Additions therefore check + automatically whether they have to be updated. If the host is + running a newer &product-name; version than the Guest Additions, a + notification with further instructions is displayed in the guest. + + + + To disable this update check for the Guest Additions of a given + virtual machine, set the value of its + /VirtualBox/GuestAdd/CheckHostVersion guest + property to 0. See + . + + + + + + + Installing and Maintaining Guest Additions + + + Guest Additions are available for virtual machines running + Windows, Linux, Oracle Solaris, or OS/2. The following sections + describe the specifics of each variant in detail. + + + + + Guest Additions for Windows + + + The &product-name; Windows Guest Additions are designed to be + installed in a virtual machine running a Windows operating + system. The following versions of Windows guests are supported: + + + + + + + Microsoft Windows NT 4.0 (any service pack) + + + + + + Microsoft Windows 2000 (any service pack) + + + + + + Microsoft Windows XP (any service pack) + + + + + + Microsoft Windows Server 2003 (any service pack) + + + + + + Microsoft Windows Server 2008 + + + + + + Microsoft Windows Vista (all editions) + + + + + + Microsoft Windows 7 (all editions) + + + + + + Microsoft Windows 8 (all editions) + + + + + + Microsoft Windows 10 RTM build 10240 + + + + + + Microsoft Windows Server 2012 + + + + + + + + Installing the Windows Guest Additions + + + In the Devices menu in the + virtual machine's menu bar, &product-name; has a menu item + Insert Guest Additions CD + Image, which mounts the Guest Additions ISO file + inside your virtual machine. A Windows guest should then + automatically start the Guest Additions installer, which + installs the Guest Additions on your Windows guest. + + + + For other guest operating systems, or if automatic start of + software on a CD is disabled, you need to do a manual start of + the installer. + + + + + For the basic Direct3D acceleration to work in a Windows + guest, you have to install the WDDM video driver available + for Windows Vista or later. + + + + For Windows 8 and later, only the WDDM Direct3D video driver + is available. For basic Direct3D acceleration to work in + Windows XP guests, you have to install the Guest Additions + in Safe Mode. See for + details. + + + + + If you prefer to mount the Guest Additions manually, you can + perform the following steps: + + + + + + + Start the virtual machine in which you have installed + Windows. + + + + + + Select Optical Drives + from the Devices menu in + the virtual machine's menu bar and then + Choose/Create a Disk + Image. This displays the Virtual Media Manager, + described in . + + + + + + In the Virtual Media Manager, click + Add and browse your host + file system for the + VBoxGuestAdditions.iso file. + + + + + + + On a Windows host, this file is in the &product-name; + installation directory, usually in + C:\Program + files\Oracle\VirtualBox. + + + + + + On Mac OS X hosts, this file is in the application + bundle of &product-name;. Right-click on the + &product-name; icon in Finder and choose + Show Package + Contents. The file is located in the + Contents/MacOS folder. + + + + + + On a Linux host, this file is in the + additions folder where you + installed &product-name;, usually + /opt/VirtualBox/. + + + + + + On Oracle Solaris hosts, this file is in the + additions folder where you + installed &product-name;, usually + /opt/VirtualBox. + + + + + + + + + In the Virtual Media Manager, select the ISO file and + click the Add button. + This mounts the ISO file and presents it to your Windows + guest as a CD-ROM. + + + + + + + Unless you have the Autostart feature disabled in your Windows + guest, Windows will now autostart the &product-name; Guest + Additions installation program from the Additions ISO. If the + Autostart feature has been turned off, choose + VBoxWindowsAdditions.exe from the CD/DVD + drive inside the guest to start the installer. + + + + The installer will add several device drivers to the Windows + driver database and then invoke the hardware detection wizard. + + + + Depending on your configuration, it might display warnings + that the drivers are not digitally signed. You must confirm + these in order to continue the installation and properly + install the Additions. + + + + After installation, reboot your guest operating system to + activate the Additions. + + + + + + + Updating the Windows Guest Additions + + + Windows Guest Additions can be updated by running the + installation program again. This replaces the previous + Additions drivers with updated versions. + + + + Alternatively, you can also open the Windows Device Manager + and select Update Driver... + for the following devices: + + + + + + + &product-name; Graphics Adapter + + + + + + &product-name; System Device + + + + + + + For each, choose the option to provide your own driver, click + Have Disk and navigate to the + CD-ROM drive with the Guest Additions. + + + + + + + Unattended Installation + + + To avoid popups when performing an unattended installation of + the &product-name; Guest Additions, the code signing + certificates used to sign the drivers needs to be installed in + the correct certificate stores on the guest operating system. + Failure to do this will cause a typical Windows installation + to display multiple dialogs asking whether you want to install + a particular driver. + + + + + On some Windows versions, such as Windows 2000 and Windows + XP, the user intervention popups mentioned above are always + displayed, even after importing the Oracle certificates. + + + + + Installing the code signing certificates on a Windows guest + can be done automatically. Use the + VBoxCertUtil.exe utility from the + cert folder on the Guest Additions + installation CD. + + + + Use the following steps: + + + + + + + Log in as Administrator on the guest. + + + + + + Mount the &product-name; Guest Additions .ISO. + + + + + + Open a command line window on the guest and change to the + cert folder on the &product-name; + Guest Additions CD. + + + + + + Run the following command: + + +VBoxCertUtil.exe add-trusted-publisher vbox*.cer --root vbox*.cer + + + This command installs the certificates to the certificate + store. When installing the same certificate more than + once, an appropriate error will be displayed. + + + + + + + To allow for completely unattended guest installations, you + can specify a command line parameter to the install launcher: + + +VBoxWindowsAdditions.exe /S + + + This automatically installs the right files and drivers for + the corresponding platform, either 32-bit or 64-bit. + + + + + By default on an unattended installation on a Vista or + Windows 7 guest, there will be the XPDM graphics driver + installed. This graphics driver does not support Windows + Aero / Direct3D on the guest. Instead, the WDDM graphics + driver needs to be installed. To select this driver by + default, add the command line parameter + /with_wddm when invoking the Windows + Guest Additions installer. This is only required for Vista + and Windows 7. + + + + + + For Windows Aero to run correctly on a guest, the guest's + VRAM size needs to be configured to at least 128 MB. + + + + + For more options regarding unattended guest installations, + consult the command line help by using the command: + + +VBoxWindowsAdditions.exe /? + + + + + + Manual File Extraction + + + If you would like to install the files and drivers manually, + you can extract the files from the Windows Guest Additions + setup as follows: + + +VBoxWindowsAdditions.exe /extract + + + To explicitly extract the Windows Guest Additions for another + platform than the current running one, such as 64-bit files on + a 32-bit system, you must use the appropriate platform + installer. Use + VBoxWindowsAdditions-x86.exe or + VBoxWindowsAdditions-amd64.exe with the + /extract parameter. + + + + + + + + + Guest Additions for Linux + + + Like the Windows Guest Additions, the &product-name; Guest + Additions for Linux are a set of device drivers and system + applications which may be installed in the guest operating + system. + + + + The following Linux distributions are officially supported: + + + + + + + Oracle Linux as of version 5, including UEK kernels + + + + + + Fedora as of Fedora Core 4 + + + + + + Red Hat Enterprise Linux as of version 3 + + + + + + SUSE and openSUSE Linux as of version 9 + + + + + + Ubuntu as of version 5.10 + + + + + + + Many other distributions are known to work with the Guest + Additions. + + + + The version of the Linux kernel supplied by default in SUSE and + openSUSE 10.2, Ubuntu 6.10 (all versions) and Ubuntu 6.06 + (server edition) contains a bug which can cause it to crash + during startup when it is run in a virtual machine. The Guest + Additions work in those distributions. + + + + Note that some Linux distributions already come with all or part + of the &product-name; Guest Additions. You may choose to keep + the distribution's version of the Guest Additions but these are + often not up to date and limited in functionality, so we + recommend replacing them with the Guest Additions that come with + &product-name;. The &product-name; Linux Guest Additions + installer tries to detect an existing installation and replace + them but depending on how the distribution integrates the Guest + Additions, this may require some manual interaction. It is + highly recommended to take a snapshot of the virtual machine + before replacing preinstalled Guest Additions. + + + + + Installing the Linux Guest Additions + + + The &product-name; Guest Additions for Linux are provided on + the same virtual CD-ROM file as the Guest Additions for + Windows. See . They also + come with an installation program that guides you through the + setup process. However, due to the significant differences + between Linux distributions, installation may be slightly more + complex when compared to Windows. + + + + Installation generally involves the following steps: + + + + + + + Before installing the Guest Additions, you prepare your + guest system for building external kernel modules. This + works as described in + , except that this + step must be performed in your Linux + guest instead of on a Linux host + system. + + + + If you suspect that something has gone wrong, check that + your guest is set up correctly and run the following + command as root: + + +rcvboxadd setup + + + + + Insert the VBoxGuestAdditions.iso CD + file into your Linux guest's virtual CD-ROM drive, as + described for a Windows guest in + . + + + + + + Change to the directory where your CD-ROM drive is mounted + and run the following command as root: + + +sh ./VBoxLinuxAdditions.run + + + + + + + + + Graphics and Mouse Integration + + + In Linux and Oracle Solaris guests, &product-name; graphics + and mouse integration goes through the X Window System. + &product-name; can use the X.Org variant of the system, or + XFree86 version 4.3 which is identical to the first X.Org + release. During the installation process, the X.Org display + server will be set up to use the graphics and mouse drivers + which come with the Guest Additions. + + + + After installing the Guest Additions into a fresh installation + of a supported Linux distribution or Oracle Solaris system, + many unsupported systems will work correctly too, the guest's + graphics mode will change to fit the size of the + &product-name; window on the host when it is resized. You can + also ask the guest system to switch to a particular resolution + by sending a video mode hint using the + VBoxManage tool. + + + + Multiple guest monitors are supported in guests using the + X.Org server version 1.3, which is part of release 7.3 of the + X Window System version 11, or a later version. The layout of + the guest screens can be adjusted as needed using the tools + which come with the guest operating system. + + + + If you want to understand more about the details of how the + X.Org drivers are set up, in particular if you wish to use + them in a setting which our installer does not handle + correctly, see . + + + + + + + Updating the Linux Guest Additions + + + The Guest Additions can simply be updated by going through the + installation procedure again with an updated CD-ROM image. + This will replace the drivers with updated versions. You + should reboot after updating the Guest Additions. + + + + + + + Uninstalling the Linux Guest Additions + + + If you have a version of the Guest Additions installed on your + virtual machine and wish to remove it without installing new + ones, you can do so by inserting the Guest Additions CD image + into the virtual CD-ROM drive as described above. Then run the + installer for the current Guest Additions with the + uninstall parameter from the path that the + CD image is mounted on in the guest, as follows: + + +sh ./VBoxLinuxAdditions.run uninstall + + + While this will normally work without issues, you may need to + do some manual cleanup of the guest in some cases, especially + of the XFree86Config or xorg.conf file. In particular, if the + Additions version installed or the guest operating system were + very old, or if you made your own changes to the Guest + Additions setup after you installed them. + + + + You can uninstall the Additions as follows: + + +/opt/VBoxGuestAdditions-version/uninstall.sh + + + Replace + /opt/VBoxGuestAdditions-version + with the correct Guest Additions installation directory. + + + + + + + + + Guest Additions for Oracle Solaris + + + Like the Windows Guest Additions, the &product-name; Guest + Additions for Oracle Solaris take the form of a set of device + drivers and system applications which may be installed in the + guest operating system. + + + + The following Oracle Solaris distributions are officially + supported: + + + + + + + Oracle Solaris 11, including Oracle Solaris 11 Express + + + + + + Oracle Solaris 10 4/08 and later + + + + + + + Other distributions may work if they are based on comparable + software releases. + + + + + Installing the Oracle Solaris Guest Additions + + + The &product-name; Guest Additions for Oracle Solaris are + provided on the same ISO CD-ROM as the Additions for Windows + and Linux. They come with an installation program that guides + you through the setup process. + + + + Installation involves the following steps: + + + + + + + Mount the VBoxGuestAdditions.iso file + as your Oracle Solaris guest's virtual CD-ROM drive, + exactly the same way as described for a Windows guest in + . + + + + If the CD-ROM drive on the guest does not get mounted, as + seen with some versions of Oracle Solaris 10, run the + following command as root: + + +svcadm restart volfs + + + + + Change to the directory where your CD-ROM drive is mounted + and run the following command as root: + + +pkgadd -G -d ./VBoxSolarisAdditions.pkg + + + + + Choose 1 and confirm + installation of the Guest Additions package. After the + installation is complete, log out and log in to X server + on your guest, to activate the X11 Guest Additions. + + + + + + + + + + Uninstalling the Oracle Solaris Guest Additions + + + The Oracle Solaris Guest Additions can be safely removed by + removing the package from the guest. Open a root terminal + session and run the following command: + + +pkgrm SUNWvboxguest + + + + + + Updating the Oracle Solaris Guest Additions + + + The Guest Additions should be updated by first uninstalling + the existing Guest Additions and then installing the new ones. + Attempting to install new Guest Additions without removing the + existing ones is not possible. + + + + + + + + + Guest Additions for OS/2 + + + &product-name; also ships with a set of drivers that improve + running OS/2 in a virtual machine. Due to restrictions of OS/2 + itself, this variant of the Guest Additions has a limited + feature set. See for details. + + + + The OS/2 Guest Additions are provided on the same ISO CD-ROM as + those for the other platforms. Mount the ISO in OS/2 as + described previously. The OS/2 Guest Additions are located in + the directory \OS2. + + + + We do not provide an automatic installer at this time. See the + readme.txt file in the CD-ROM directory, + which describes how to install the OS/2 Guest Additions + manually. + + + + + + + + + Shared Folders + + + With the shared folders feature of + &product-name;, you can access files of your host system from + within the guest system. This is similar to how you would use + network shares in Windows networks, except that shared folders do + not require networking, only the Guest Additions. Shared folders + are supported with Windows 2000 or later, Linux, and Oracle + Solaris guests. &product-name; includes experimental support for + Mac OS X and OS/2 guests. + + + + Shared folders physically reside on the host + and are then shared with the guest, which uses a special file + system driver in the Guest Additions to talk to the host. For + Windows guests, shared folders are implemented as a pseudo-network + redirector. For Linux and Oracle Solaris guests, the Guest + Additions provide a virtual file system. + + + + To share a host folder with a virtual machine in &product-name;, + you must specify the path of the folder and choose a + share name that the guest can use to access + the shared folder. This happens on the host. In the guest you can + then use the share name to connect to it and access files. + + + + There are several ways in which shared folders can be set up for a + virtual machine: + + + + + + + In the window of a running VM, you select + Shared Folders from the + Devices menu, or click on the + folder icon on the status bar in the bottom right corner. + + + + + + If a VM is not currently running, you can configure shared + folders in the virtual machine's + Settings dialog. + + + + + + From the command line, you can create shared folders using + VBoxManage, as follows: + + +VBoxManage sharedfolder add "VM name" --name "sharename" --hostpath "C:\test" + + + See . + + + + + + + There are two types of shares: + + + + + + + Permanent shares, that are saved with the VM settings. + + + + + + Transient shares, that are added at runtime and disappear when + the VM is powered off. These can be created using a check box + in the VirtualBox Manager, or by using the + option of the VBoxManage + sharedfolder add command. + + + + + + + Shared folders can either be read-write or read-only. This means + that the guest is either allowed to both read and write, or just + read files on the host. By default, shared folders are read-write. + Read-only folders can be created using a check box in the + VirtualBox Manager, or with the option + of the VBoxManage sharedfolder add command. + + + + &product-name; shared folders also support symbolic links, also + called symlinks, under the following + conditions: + + + + + + + The host operating system must support symlinks. For example, + a Mac OS X, Linux, or Oracle Solaris host is required. + + + + + + Currently only Linux and Oracle Solaris Guest Additions + support symlinks. + + + + + + For security reasons the guest OS is not allowed to create + symlinks by default. If you trust the guest OS to not abuse + the functionality, you can enable creation of symlinks for a + shared folder as follows: + + +VBoxManage setextradata "VM name" VBoxInternal2/SharedFoldersEnableSymlinksCreate/sharename 1 + + + + + + + Manual Mounting + + + You can mount the shared folder from inside a VM, in the same + way as you would mount an ordinary network share: + + + + + + + In a Windows guest, shared folders are browseable and + therefore visible in Windows Explorer. To attach the host's + shared folder to your Windows guest, open Windows Explorer + and look for the folder in My + Networking Places, Entire + Network, &product-name; + Shared Folders. By right-clicking on a shared + folder and selecting Map Network + Drive from the menu that pops up, you can assign + a drive letter to that shared folder. + + + + Alternatively, on the Windows command line, use the + following command: + + +net use x: \\vboxsvr\sharename + + + While vboxsvr is a fixed name, note that + vboxsrv would also work, replace + x: with the drive letter that you + want to use for the share, and + sharename with the share name + specified with VBoxManage. + + + + + + In a Linux guest, use the following command: + + +mount -t vboxsf [-o OPTIONS] sharename mountpoint + + + To mount a shared folder during boot, add the following + entry to /etc/fstab: + + +sharename mountpoint vboxsf defaults 0 0 + + + + + In a Oracle Solaris guest, use the following command: + + +mount -F vboxfs [-o OPTIONS] sharename mountpoint + + + Replace sharename, use a + lowercase string, with the share name specified with + VBoxManage or the VirtualBox Manager. + Replace mountpoint with the path + where you want the share to be mounted on the guest, such as + /mnt/share. The usual mount rules + apply. For example, create this directory first if it does + not exist yet. + + + + Here is an example of mounting the shared folder for the + user jack on Oracle Solaris: + + +$ id +uid=5000(jack) gid=1(other) +$ mkdir /export/home/jack/mount +$ pfexec mount -F vboxfs -o uid=5000,gid=1 jackshare /export/home/jack/mount +$ cd ~/mount +$ ls +sharedfile1.mp3 sharedfile2.txt +$ + + + Beyond the standard options supplied by the + mount command, the following are + available: + + +iocharset CHARSET + + + This option sets the character set used for I/O operations. + Note that on Linux guests, if the + iocharset option is not specified, then + the Guest Additions driver will attempt to use the character + set specified by the CONFIG_NLS_DEFAULT kernel option. If + this option is not set either, then UTF-8 is used. + + +convertcp CHARSET + + + This option specifies the character set used for the shared + folder name. This is UTF-8 by default. + + + + The generic mount options, documented in the + mount manual page, apply also. Especially + useful are the options uid, + gid and mode, as they + can allow access by normal users in read/write mode, + depending on the settings, even if root has mounted the + filesystem. + + + + + + In an OS/2 guest, use the VBoxControl + command to manage shared folders. For example: + + +VBoxControl sharedfolder use D: MyShareName +VBoxControl sharedfolder unuse D: +VBoxControl sharedfolder list + + + As with Windows guests, shared folders can also be accessed + via UNC using \\VBoxSF\, + \\VBoxSvr\ or + \\VBoxSrv\ as the server name and the + shared folder name as sharename. + + + + + + + + + + Automatic Mounting + + + &product-name; provides the option to mount shared folders + automatically. When automatic mounting is enabled for a shared + folder, the Guest Additions service will mount it for you + automatically. For Windows or OS/2, a preferred drive letter can + also be specified. For Linux or Oracle Solaris, a mount point + directory can also be specified. + + + + If a drive letter or mount point is not specified, or is in use + already, an alternative location is found by the Guest Additions + service. The service searches for an alternative location + depending on the guest OS, as follows: + + + + + + + Windows and OS/2 guests. + Search for a free drive letter, starting at + Z:. If all drive letters are assigned, + the folder is not mounted. + + + + + + Linux and Oracle Solaris + guests. Folders are mounted under the + /media directory. The folder name is + normalized (no spaces, slashes or colons) and is prefixed + with sf_. + + + + For example, if you have a shared folder called + myfiles, it will appear as + /media/sf_myfiles in the guest. + + + + The guest properties + /VirtualBox/GuestAdd/SharedFolders/MountDir + and the more generic + /VirtualBox/GuestAdd/SharedFolders/MountPrefix + can be used to override the automatic mount directory and + prefix. See . + + + + + + + Access to an automatically mounted shared folder is granted to + everyone in a Windows guest, including the guest user. For Linux + and Oracle Solaris guests, access is restricted to members of + the group vboxsf and the + root user. + + + + + + + + + Drag and Drop + + + &product-name; enables you to drag and drop content from the host + to the guest, and vice versa. For this to work the latest version + of the Guest Additions must be installed on the guest. + + + + Drag and drop transparently allows copying or opening files, + directories, and even certain clipboard formats from one end to + the other. For example, from the host to the guest or from the + guest to the host. You then can perform drag and drop operations + between the host and a VM, as it would be a native drag and drop + operation on the host OS. + + + + At the moment drag and drop is implemented for Windows-based and + X-Windows-based systems, both on the host and guest side. As + X-Windows supports many different drag and drop protocols only the + most common one, XDND, is supported for now. Applications using + other protocols, such as Motif or OffiX, will not be recognized by + &product-name;. + + + + In the context of using drag and drop, the origin of the data is + called the source. That is, where the actual + data comes from and is specified. The + destination specifies where the data from the + source should go to. Transferring data from the source to the + destination can be done in various ways, such as copying, moving, + or linking. + + + + + At the moment only copying of data is supported. Moving or + linking is not yet implemented. + + + + + When transferring data from the host to the guest OS, the host in + this case is the source, whereas the guest OS is the destination. + However, when transferring data from the guest OS to the host, the + guest OS this time became the source and the host is the + destination. + + + + For security reasons drag and drop can be configured at runtime on + a per-VM basis either using the Drag and + Drop menu item in the + Devices menu of the virtual + machine, as shown below, or the VBoxManage + command. + + +
+ Drag and Drop Menu Options + + + + + +
+ + + The following drag and drop modes are available: + + + + + + + Disabled. Disables the drag + and drop feature entirely. This is the default when creating a + new VM. + + + + + + Host To Guest. Enables drag + and drop operations from the host to the guest only. + + + + + + Guest To Host. Enables drag + and drop operations from the guest to the host only. + + + + + + Bidirectional. Enables drag + and drop operations in both directions: from the host to the + guest, and from the guest to the host. + + + + + + + + Drag and drop support depends on the frontend being used. At the + moment, only the VirtualBox Manager frontend provides this + functionality. + + + + + To use the VBoxManage command to control the + current drag and drop mode, see . The + modifyvm and controlvm + commands enable setting of a VM's current drag and drop mode from + the command line. + + + + + Supported Formats + + + As &product-name; can run on a variety of host operating systems + and also supports a wide range of guests, certain data formats + must be translated after transfer. This is so that the + destination operating system, which receives the data, is able + to handle them in an appropriate manner. + + + + + When dragging files no data conversion is done in any way. For + example, when transferring a file from a Linux guest to a + Windows host the Linux-specific line endings are not converted + to Windows line endings. + + + + + The following formats are handled by the &product-name; drag and + drop service: + + + + + + + Plain text: From + applications such as text editors, internet browsers and + terminal windows. + + + + + + Files: From file managers + such as Windows Explorer, Nautilus, and Finder. + + + + + + Directories: For + directories, the same formats apply as for files. + + + + + + + + + + Known Limitations + + + The following limitations are known for drag and drop: + + + + On Windows hosts, dragging and dropping content between + UAC-elevated (User Account Control) programs and + non-UAC-elevated programs is not allowed. If you start + &product-name; with Administrator privileges then drag and drop + will not work with Windows Explorer, which runs with regular + user privileges by default. + + + + On Linux hosts and guests, programs can query for drag and drop + data while the drag operation is still in progress. For example, + on LXDE using the PCManFM file manager. This currently is not + supported. As a workaround, a different file manager, such as + Nautilus, can be used instead. + + + + + + + + + Hardware-Accelerated Graphics + + + + Hardware 3D Acceleration (OpenGL and Direct3D 8/9) + + + The &product-name; Guest Additions contain experimental hardware + 3D support for Windows, Linux, and Oracle Solaris guests. + + + + With this feature, if an application inside your virtual machine + uses 3D features through the OpenGL or Direct3D 8/9 programming + interfaces, instead of emulating them in software, which would + be slow, &product-name; will attempt to use your host's 3D + hardware. This works for all supported host platforms, provided + that your host operating system can make use of your accelerated + 3D hardware in the first place. + + + + The 3D acceleration feature currently has the following + preconditions: + + + + + + + It is only available for certain Windows, Linux, and Oracle + Solaris guests. In particular: + + + + + + + 3D acceleration with Windows guests requires Windows + 2000 or later. Apart from on Windows 2000 guests, both + OpenGL and Direct3D 8/9 are supported on an experimental + basis. + + + + + + OpenGL on Linux requires kernel 2.6.27 or later, as well + as X.org server version 1.5 or later. Ubuntu 10.10 and + Fedora 14 have been tested and confirmed as working. + + + + + + OpenGL on Oracle Solaris guests requires X.org server + version 1.5 or later. + + + + + + + + + The Guest Additions must be installed. + + + + + For the basic Direct3D acceleration to work in a Windows + Guest, &product-name; needs to replace Windows system + files in the virtual machine. As a result, the Guest + Additions installation program offers Direct3D + acceleration as an option that must be explicitly enabled. + Also, you must install the Guest Additions in Safe Mode. + This does not apply to the WDDM + Direct3D video driver available for Windows Vista and + later. See for details. + + + + + + + Because 3D support is still experimental at this time, it is + disabled by default and must be manually + enabled in the VM settings. See + . + + + + + Untrusted guest systems should not be allowed to use the + 3D acceleration features of &product-name;, just as + untrusted host software should not be allowed to use 3D + acceleration. Drivers for 3D hardware are generally too + complex to be made properly secure and any software which + is allowed to access them may be able to compromise the + operating system running them. In addition, enabling 3D + acceleration gives the guest direct access to a large body + of additional program code in the &product-name; host + process which it might conceivably be able to use to crash + the virtual machine. + + + + + + + + To enable Aero theme support, the &product-name; WDDM video + driver must be installed, which is available with the Guest + Additions installation. The WDDM driver is not installed by + default for Vista and Windows 7 guests and must be + manually selected in the Guest Additions + installer by clicking No in the + Would You Like to Install Basic Direct3D + Support dialog displayed when the Direct3D feature is + selected. + + + + The Aero theme is not enabled by default on Windows. See your + Windows platform documentation for details of how to enable the + Aero theme. + + + + Technically, &product-name; implements 3D acceleration by + installing an additional hardware 3D driver inside the guest + when the Guest Additions are installed. This driver acts as a + hardware 3D driver and reports to the guest operating system + that the virtual hardware is capable of 3D hardware + acceleration. When an application in the guest then requests + hardware acceleration through the OpenGL or Direct3D programming + interfaces, these are sent to the host through a special + communication tunnel implemented by &product-name;. The + host then performs the requested 3D + operation using the host's programming interfaces. + + + + + + + Hardware 2D Video Acceleration for Windows Guests + + + The &product-name; Guest Additions contain experimental hardware + 2D video acceleration support for Windows guests. + + + + With this feature, if an application such as a video player + inside your Windows VM uses 2D video overlays to play a movie + clip, then &product-name; will attempt to use your host's video + acceleration hardware instead of performing overlay stretching + and color conversion in software, which would be slow. This + currently works for Windows, Linux and Mac OS X host platforms, + provided that your host operating system can make use of 2D + video acceleration in the first place. + + + + Hardware 2D video acceleration currently has the following + preconditions: + + + + + + + Only available for Windows guests, running Windows XP or + later. + + + + + + Guest Additions must be installed. + + + + + + Because 2D support is still experimental at this time, it is + disabled by default and must be manually + enabled in the VM settings. See + . + + + + + + + Technically, &product-name; implements this by exposing video + overlay DirectDraw capabilities in the Guest Additions video + driver. The driver sends all overlay commands to the host + through a special communication tunnel implemented by + &product-name;. On the host side, OpenGL is then used to + implement color space transformation and scaling. + + + + + + + + + Seamless Windows + + + With the seamless windows feature of + &product-name;, you can have the windows that are displayed within + a virtual machine appear side by side next to the windows of your + host. This feature is supported for the following guest operating + systems, provided that the Guest Additions are installed: + + + + + + + Windows guests. + + + + + + Supported Linux or Oracle Solaris guests running the X Window + System. + + + + + + + After seamless windows are enabled, &product-name; suppresses the + display of the desktop background of your guest, allowing you to + run the windows of your guest operating system seamlessly next to + the windows of your host. + + +
+ Seamless Windows on a Host Desktop + + + + + +
+ + + To enable seamless mode, after starting the virtual machine, press + the Host key + L. The Host key is + normally the right control key. This will enlarge the size of the + VM's display to the size of your host screen and mask out the + guest operating system's background. To disable seamless windows + and go back to the normal VM display, press the Host key + L + again. + + + + + + + Guest Properties + + + &product-name; enables requests of some properties from a running + guest, provided that the &product-name; Guest Additions are + installed and the VM is running. This provides the following + advantages: + + + + + + + A number of predefined VM characteristics are automatically + maintained by &product-name; and can be retrieved on the host. + For example, to monitor VM performance and statistics. + + + + + + Arbitrary string data can be exchanged between guest and host. + This works in both directions. + + + + + + + To accomplish this, &product-name; establishes a private + communication channel between the &product-name; Guest Additions + and the host, and software on both sides can use this channel to + exchange string data for arbitrary purposes. Guest properties are + simply string keys to which a value is attached. They can be set, + or written to, by either the host and the guest. They can also be + read from both sides. + + + + In addition to establishing the general mechanism of reading and + writing values, a set of predefined guest properties is + automatically maintained by the &product-name; Guest Additions to + allow for retrieving interesting guest data such as the guest's + exact operating system and service pack level, the installed + version of the Guest Additions, users that are currently logged + into the guest OS, network statistics and more. These predefined + properties are all prefixed with /VirtualBox/ + and organized into a hierarchical tree of keys. + + + + Some of this runtime information is shown when you select + Session Information Dialog from a + virtual machine's Machine menu. + + + + A more flexible way to use this channel is with the + VBoxManage guestproperty command. See + . For example, to have + all the available guest properties for a + given running VM listed with their respective values, use this + command: + + +$ VBoxManage guestproperty enumerate "Windows Vista III" +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2019 Oracle Corporation +All rights reserved. + +Name: /VirtualBox/GuestInfo/OS/Product, value: Windows Vista Business Edition, + timestamp: 1229098278843087000, flags: +Name: /VirtualBox/GuestInfo/OS/Release, value: 6.0.6001, + timestamp: 1229098278950553000, flags: +Name: /VirtualBox/GuestInfo/OS/ServicePack, value: 1, + timestamp: 1229098279122627000, flags: +Name: /VirtualBox/GuestAdd/InstallDir, + value: C:/Program Files/Oracle/VirtualBox + Guest Additions, timestamp: 1229098279269739000, flags: +Name: /VirtualBox/GuestAdd/Revision, value: 40720, + timestamp: 1229098279345664000, flags: +Name: /VirtualBox/GuestAdd/Version, value: version-number, + timestamp: 1229098279479515000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxControl.exe, value: version-numberr40720, + timestamp: 1229098279651731000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxHook.dll, value: version-numberr40720, + timestamp: 1229098279804835000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxDisp.dll, value: version-numberr40720, + timestamp: 1229098279880611000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxMRXNP.dll, value: version-numberr40720, + timestamp: 1229098279882618000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxService.exe, value: version-numberr40720, + timestamp: 1229098279883195000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxTray.exe, value: version-numberr40720, + timestamp: 1229098279885027000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxGuest.sys, value: version-numberr40720, + timestamp: 1229098279886838000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxMouse.sys, value: version-numberr40720, + timestamp: 1229098279890600000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxSF.sys, value: version-numberr40720, + timestamp: 1229098279893056000, flags: +Name: /VirtualBox/GuestAdd/Components/VBoxVideo.sys, value: version-numberr40720, + timestamp: 1229098279895767000, flags: +Name: /VirtualBox/GuestInfo/OS/LoggedInUsers, value: 1, + timestamp: 1229099826317660000, flags: +Name: /VirtualBox/GuestInfo/OS/NoLoggedInUsers, value: false, + timestamp: 1229098455580553000, flags: +Name: /VirtualBox/GuestInfo/Net/Count, value: 1, + timestamp: 1229099826299785000, flags: +Name: /VirtualBox/HostInfo/GUI/LanguageID, value: C, + timestamp: 1229098151272771000, flags: +Name: /VirtualBox/GuestInfo/Net/0/V4/IP, value: 192.168.2.102, + timestamp: 1229099826300088000, flags: +Name: /VirtualBox/GuestInfo/Net/0/V4/Broadcast, value: 255.255.255.255, + timestamp: 1229099826300220000, flags: +Name: /VirtualBox/GuestInfo/Net/0/V4/Netmask, value: 255.255.255.0, + timestamp: 1229099826300350000, flags: +Name: /VirtualBox/GuestInfo/Net/0/Status, value: Up, + timestamp: 1229099826300524000, flags: +Name: /VirtualBox/GuestInfo/OS/LoggedInUsersList, value: username, + timestamp: 1229099826317386000, flags: + + + To query the value of a single property, use the + get subcommand as follows: + + +$ VBoxManage guestproperty get "Windows Vista III" "/VirtualBox/GuestInfo/OS/Product" +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2019 Oracle Corporation +All rights reserved. + +Value: Windows Vista Business Edition + + + To add or change guest properties from the guest, use the tool + VBoxControl. This tool is included in the Guest + Additions. When started from a Linux guest, this tool requires + root privileges for security reasons. + + +$ sudo VBoxControl guestproperty enumerate +VirtualBox Guest Additions Command Line Management Interface Version version-number +(C) 2005-2019 Oracle Corporation +All rights reserved. + +Name: /VirtualBox/GuestInfo/OS/Release, value: 2.6.28-18-generic, + timestamp: 1265813265835667000, flags: <NULL> +Name: /VirtualBox/GuestInfo/OS/Version, value: #59-Ubuntu SMP Thu Jan 28 01:23:03 UTC 2010, + timestamp: 1265813265836305000, flags: <NULL> + ... + + + For more complex needs, you can use the &product-name; programming + interfaces. See . + + + + + Using Guest Properties to Wait on VM Events + + + The properties /VirtualBox/HostInfo/VBoxVer, + /VirtualBox/HostInfo/VBoxVerExt or + /VirtualBox/HostInfo/VBoxRev can be waited on + to detect that the VM state was restored from saved state or + snapshot: + + +$ VBoxControl guestproperty wait /VirtualBox/HostInfo/VBoxVer + + + Similarly the + /VirtualBox/HostInfo/ResumeCounter can be + used to detect that a VM was resumed from the paused state or + saved state. + + + + + + + + + Guest Control File Manager + + + The Guest Control File Manager is a feature of the Guest Additions + that enables easy copying and moving of files between a guest and + the host system. Other file management operations provide support + to create new folders and to rename or delete files. + + +
+ Guest Control File Manager + + + + + +
+ + + The Guest Control File Manager works by mounting the host file + system. Guest users must authenticate and create a guest session + before they can transfer files. + + + + + Using the Guest Control File Manager + + + The following steps describe how to use the Guest Control File + Manager. + + + + + + + Open the Guest Control File Manager. + + + + In the guest VM, select + Machine, + File Manager. + + + + The left pane shows the files on the host system. + + + + + + Create a guest session. + + + + At the bottom of the Guest Control File Manager, enter + authentication credentials for a user on the guest system. + + + + Click Create Session. + + + + The contents of the guest VM file system appears in the + right pane of the Guest Control File Manager. + + + + + + Transfer files between the guest and the host system by + using the move and copy file transfer icons. + + + + You can copy and move files from a guest to the host system + or from the host system to the guest. + + + + + + Close the Guest Control File Manager. + + + + Click Close to end the + guest session. + + + + + + + + + + + + Guest Control of Applications + + + The Guest Additions enable starting of applications inside a guest + VM from the host system. This feature can be used to automate + deployment of software within the guest. + + + + For this to work, the application needs to be installed on the + guest. No additional software needs to be installed on the host. + Additionally, text mode output to stdout and stderr can be shown + on the host for further processing. There are options to specify + user credentials and a timeout value, in milliseconds, to limit + the time the application is able to run. + + + + The Guest Additions for Windows allow for automatic updating. This + applies for already installed Guest Additions versions. Also, + copying files from host to the guest as well as remotely creating + guest directories is available. + + + + To use these features, use the &product-name; command line. See + . + + + + + + + Memory Overcommitment + + + In server environments with many VMs, the Guest Additions can be + used to share physical host memory between several VMs. This + reduces the total amount of memory in use by the VMs. If memory + usage is the limiting factor and CPU resources are still + available, this can help with running more VMs on each host. + + + + + Memory Ballooning + + + The Guest Additions can change the amount of host memory that a + VM uses, while the machine is running. Because of how this is + implemented, this feature is called memory + ballooning. + + + + + + + + &product-name; supports memory ballooning only on 64-bit + hosts. It is not supported on Mac OS X hosts. + + + + + + Memory ballooning does not work with large pages enabled. + To turn off large pages support for a VM, run + VBoxManage modifyvm + vmname --largepages + off + + + + + + + + Normally, to change the amount of memory allocated to a virtual + machine, you have to shut down the virtual machine entirely and + modify its settings. With memory ballooning, memory that was + allocated for a virtual machine can be given to another virtual + machine without having to shut the machine down. + + + + When memory ballooning is requested, the &product-name; Guest + Additions, which run inside the guest, allocate physical memory + from the guest operating system on the kernel level and lock + this memory down in the guest. This ensures that the guest will + not use that memory any longer. No guest applications can + allocate it, and the guest kernel will not use it either. + &product-name; can then reuse this memory and give it to another + virtual machine. + + + + The memory made available through the ballooning mechanism is + only available for reuse by &product-name;. It is + not returned as free memory to the host. + Requesting balloon memory from a running guest will therefore + not increase the amount of free, unallocated memory on the host. + Effectively, memory ballooning is therefore a memory + overcommitment mechanism for multiple virtual machines while + they are running. This can be useful to temporarily start + another machine, or in more complicated environments, for + sophisticated memory management of many virtual machines that + may be running in parallel depending on how memory is used by + the guests. + + + + At this time, memory ballooning is only supported through + VBoxManage. Use the following command to + increase or decrease the size of the memory balloon within a + running virtual machine that has Guest Additions installed: + + +VBoxManage controlvm "VM name" guestmemoryballoon n + + + where VM name is the name or UUID of + the virtual machine in question and n + is the amount of memory to allocate from the guest in megabytes. + See . + + + + You can also set a default balloon that will automatically be + requested from the VM every time after it has started up with + the following command: + + +VBoxManage modifyvm "VM name" --guestmemoryballoon n + + + By default, no balloon memory is allocated. This is a VM + setting, like other modifyvm settings, and + therefore can only be set while the machine is shut down. See + . + + + + + + + Page Fusion + + + Whereas memory ballooning simply reduces the amount of RAM that + is available to a VM, Page Fusion works differently. It avoids + memory duplication between several similar running VMs. + + + + In a server environment running several similar VMs on the same + host, lots of memory pages are identical. For example, if the + VMs are using identical operating systems. &product-name;'s Page + Fusion technology can efficiently identify these identical + memory pages and share them between multiple VMs. + + + + + &product-name; supports Page Fusion only on 64-bit hosts, and + it is not supported on Mac OS X hosts. Page Fusion currently + works only with Windows 2000 and later guests. + + + + + The more similar the VMs on a given host are, the more + efficiently Page Fusion can reduce the amount of host memory + that is in use. It therefore works best if all VMs on a host run + identical operating systems. Instead of having a complete copy + of each operating system in each VM, Page Fusion identifies the + identical memory pages in use by these operating systems and + eliminates the duplicates, sharing host memory between several + machines. This is called deduplication. If + a VM tries to modify a page that has been shared with other VMs, + a new page is allocated again for that VM with a copy of the + shared page. This is called copy on write. + All this is fully transparent to the virtual machine. + + + + You may be familiar with this kind of memory overcommitment from + other hypervisor products, which call this feature + page sharing or same page + merging. However, Page Fusion differs significantly + from those other solutions, whose approaches have several + drawbacks: + + + + + + + Traditional hypervisors scan all guest + memory and compute checksums, also called hashes, for every + single memory page. Then, they look for pages with identical + hashes and compare the entire content of those pages. If two + pages produce the same hash, it is very likely that the + pages are identical in content. This process can take rather + long, especially if the system is not idling. As a result, + the additional memory only becomes available after a + significant amount of time, such as hours or sometimes days. + Even worse, this kind of page sharing algorithm generally + consumes significant CPU resources and increases the + virtualization overhead by 10 to 20%. + + + + Page Fusion in &product-name; uses logic in the + &product-name; Guest Additions to quickly identify memory + cells that are most likely identical across VMs. It can + therefore achieve most of the possible savings of page + sharing almost immediately and with almost no overhead. + + + + + + Page Fusion is also much less likely to be confused by + identical memory that it will eliminate, just to learn + seconds later that the memory will now change and having to + perform a highly expensive and often service-disrupting + reallocation. + + + + + + + At this time, Page Fusion can only be controlled with + VBoxManage, and only while a VM is shut down. + To enable Page Fusion for a VM, use the following command: + + +VBoxManage modifyvm "VM name" --pagefusion on + + + You can observe Page Fusion operation using some metrics. + RAM/VMM/Shared shows the total amount of + fused pages, whereas the per-VM metric + Guest/RAM/Usage/Shared will return the amount + of fused memory for a given VM. See + for information on how to + query metrics. + + + + + Enabling Page Fusion might indirectly increase the chances for + malicious guests to successfully attack other VMs running on + the same host. See . + + + + + + + + + + Controlling Virtual Monitor Topology + + + + X11/Wayland Desktop Environments + + + The Guest Additions provide services for controlling the guest + system's monitor topology. Monitor topology means the resolution + of each virtual monitor and its state (disabled/enabled). The + resolution of a virtual monitor can be modified from the host + side either by resizing the window that hosts the virtual monitor, + through the view menu or through + VBoxManage controlvm "vmname" setscreenlayout. + On guest operating systems with X11/Wayland desktops this is + put into effect by either of two following services: + + + + VBoxClient --vmsvga + VBoxDRMClient + + + + Here are some details about guest screen resolution control + functionality: + + + + + + + On X11/Wayland desktops the resizing service is started during + desktop session initialization, that is desktop login. On X11 + desktops VBoxClient --vmsvga handles screen + topology through the RandR extension. + On Wayland clients VBoxDRMClient is used. The + decision is made automatically at each desktop session start. + + + + + On 32 bit guest operating systems VBoxDRMClient + is always used, in order to work around bugs. + + + + + Since the mentioned monitor topology control services are + initialized during the desktop session start, it is impossible + to control the monitor resolution of display managers such as + gdm, lightdm. This default behavior can be changed by setting + the guest property /VirtualBox/GuestAdd/DRMResize + of the virtual machine to any value. Please refer to + for updating guest + properties. When this guest property is set then + VBoxDRMClient is started during the guest OS boot + and stays active all the time, for both ithe display manager + login screen and the desktop session. + + + + + + + + Known Limitations + + VBoxDRMClient is not able to handle arbitrary guest + monitor topologies. Specifically, disabling a guest monitor + (except the last one) invalidates the monitor topology due to + limitations in the Linux kernel module vmwgfx.ko. + iFor example, when the guest is configured to have 4 monitors + it is not recommended to disable the 2nd or 3rd monitor. + + + + + + + + + diff --git a/doc/manual/en_US/user_Installation.xml b/doc/manual/en_US/user_Installation.xml new file mode 100644 index 00000000..41c36afe --- /dev/null +++ b/doc/manual/en_US/user_Installation.xml @@ -0,0 +1,1405 @@ + + +%all.entities; +]> + + + Installation Details + + + As installation of &product-name; varies depending on your host + operating system, the following sections provide installation + instructions for Windows, Mac OS X, Linux, and Oracle Solaris. + + + + + Installing on Windows Hosts + + + + Prerequisites + + + For the various versions of Windows that are supported as host + operating systems, please refer to + . + + + + In addition, Windows Installer must be present on your system. + This should be the case for all supported Windows platforms. + + + + + + + Performing the Installation + + + The &product-name; installation can be started in either of the + following ways: + + + + + + + By double-clicking on the executable file. + + + + + + By entering the following command: + + +VirtualBox-<version>-<revision>-Win.exe -extract + + + This will extract the installer into a temporary directory, + along with the .MSI file. Run the following command to + perform the installation: + + +msiexec /i VirtualBox-<version>-<revision>-Win.msi + + + + + + Using either way displays the installation + Welcome dialog and enables you + to choose where to install &product-name;, and which components + to install. In addition to the &product-name; application, the + following components are available: + + + + + + + USB support. This package + contains special drivers for your Windows host that + &product-name; requires to fully support USB devices inside + your virtual machines. + + + + + + Networking. This package + contains extra networking drivers for your Windows host that + &product-name; needs to support Bridged Networking. This + enables your VM's virtual network cards to be accessed from + other machines on your physical network. + + + + + + Python support. This + package contains Python scripting support for the + &product-name; API, see . + For this to work, an already working Windows Python + installation on the system is required. + + + + See, for example: + . + + + + + Python version at least 2.6 is required. Python 3 is also + supported. + + + + + + + + Depending on your Windows configuration, you may see warnings + about unsigned drivers, or similar. Click + Continue for these warnings, as + otherwise &product-name; might not function correctly after + installation. + + + + The installer will create an &product-name; group in the Windows + Start menu, which enables you + to launch the application and access its documentation. + + + + With standard settings, &product-name; will be installed for all + users on the local system. If this is not wanted, you must + invoke the installer by first extracting as follows: + + +VirtualBox.exe -extract + + + Then, run either of the following commands on the extracted .MSI + file. This will install &product-name; only for the current + user. + + +VirtualBox.exe -msiparams ALLUSERS=2 + +msiexec /i VirtualBox-<version>-Win.msi ALLUSERS=2 + + + If you do not want to install all features of &product-name;, + you can set the optional ADDLOCAL parameter + to explicitly name the features to be installed. The following + features are available: + + + + + + + VBoxApplication + + + + + Main binaries of &product-name;. + + + + + This feature must not be absent, since it contains the + minimum set of files to have working &product-name; + installation. + + + + + + + + VBoxUSB + + + + + USB support. + + + + + + + VBoxNetwork + + + + + All networking support. This includes the VBoxNetworkFlt + and VBoxNetworkAdp features. + + + + + + + VBoxNetworkFlt + + + + + Bridged networking support. + + + + + + + VBoxNetworkAdp + + + + + Host-only networking support + + + + + + + VBoxPython + + + + + Python support + + + + + + + + For example, to only install USB support along with the main + binaries, run either of the following commands: + + +VirtualBox.exe -msiparams ADDLOCAL=VBoxApplication,VBoxUSB + +msiexec /i VirtualBox-<version>-Win.msi ADDLOCAL=VBoxApplication,VBoxUSB + + + The user is able to choose between NDIS5 and NDIS6 host network + filter drivers during the installation. This is done using a + command line parameter, NETWORKTYPE. The + NDIS6 driver is the default for most supported Windows hosts. + For some legacy Windows versions, the installer will + automatically select the NDIS5 driver and this cannot be + changed. + + + + You can force an install of the legacy NDIS5 host network filter + driver by specifying NETWORKTYPE=NDIS5. For + example, to install the NDIS5 driver on Windows 7 use either of + the following commands: + + +VirtualBox.exe -msiparams NETWORKTYPE=NDIS5 + +msiexec /i VirtualBox-<version>-Win;.msi NETWORKTYPE=NDIS5 + + + + + + Uninstallation + + + As &product-name; uses the standard Microsoft Windows installer, + &product-name; can be safely uninstalled at any time. Click the + program entry in the Add/Remove + Programs list in the Windows Control Panel. + + + + + + + Unattended Installation + + + Unattended installations can be performed using the standard MSI + support. + + + + + + + Public Properties + + + Public properties can be specified with the MSI API, to control + additional behavior and features of the Windows host installer. + Use either of the following commands: + + +VirtualBox.exe -msiparams NAME=VALUE [...] + +msiexec /i VirtualBox-<version>-Win.msi NAME=VALUE [...] + + + The following public properties are available. + + + + + + + VBOX_INSTALLDESKTOPSHORTCUT + + + + Specifies whether or not an &product-name; icon on the + desktop should be created. + + + + Set to 1 to enable, 0 + to disable. Default is 1. + + + + + + VBOX_INSTALLQUICKLAUNCHSHORTCUT + + + + Specifies whether or not an &product-name; icon in the Quick + Launch Bar should be created. + + + + Set to 1 to enable, 0 + to disable. Default is 1. + + + + + + VBOX_REGISTERFILEEXTENSIONS + + + + Specifies whether or not the file extensions .vbox, + .vbox-extpack, .ovf, .ova, .vdi, .vmdk, .vhd and .vdd should + be associated with &product-name;. Files of these types then + will be opened with &product-name;. + + + + Set to 1 to enable, 0 + to disable. Default is 1. + + + + + + VBOX_START + + + + Specifies whether to start &product-name; right after + successful installation. + + + + Set to 1 to enable, 0 + to disable. Default is 1. + + + + + + + + + + + + Installing on Mac OS X Hosts + + + + Performing the Installation + + + For Mac OS X hosts, &product-name; ships in a + dmg disk image file. Perform the following + steps to install on a Mac OS X host: + + + + + + + Double-click on the dmg file, to mount + the contents. + + + + + + A window opens, prompting you to double-click on the + VirtualBox.pkg installer file displayed + in that window. + + + + + + This starts the installer, which enables you to select where + to install &product-name;. + + + + + + An &product-name; icon is added to the + Applications folder in the Finder. + + + + + + + + + + Uninstallation + + + To uninstall &product-name;, open the disk image + dmg file and double-click on the uninstall + icon shown. + + + + + + + Unattended Installation + + + To perform a non-interactive installation of &product-name; you + can use the command line version of the installer application. + + + + Mount the dmg disk image file, as described + in the installation procedure, or use the following command + line: + + +hdiutil attach /path/to/VirtualBox-xyz.dmg + + + Open a terminal session and run the following command: + + +sudo installer -pkg /Volumes/VirtualBox/VirtualBox.pkg -target /Volumes/Macintosh\ HD + + + + + + + + Installing on Linux Hosts + + + + Prerequisites + + + For the various versions of Linux that are supported as host + operating systems, see . + + + + You may need to install the following packages on your Linux + system before starting the installation. Some systems will do + this for you automatically when you install &product-name;. + + + + + + + Qt 5.3.2 or later. Qt 5.6.2 or later is recommended. + + + + + + SDL 1.2.7 or later. This graphics library is typically + called libsdl or similar. + + + + + + + + These packages are only required if you want to run the + &product-name; graphical user interfaces. In particular, + VirtualBox, the graphical VirtualBox + Manager, requires both Qt and SDL. If you only want to run + VBoxHeadless, neither Qt nor SDL are + required. + + + + + + + + The &product-name; Kernel Modules + + + In order to run other operating systems in virtual machines + alongside your main operating system, &product-name; needs to + integrate very tightly with your system. To do this it installs + a driver module called vboxdrv into the + system kernel. The kernel is the part of the operating system + which controls your processor and physical hardware. Without + this kernel module, you can still use the VirtualBox Manager to + configure virtual machines, but they will not start. + + + + Network drivers called vboxnetflt and + vboxnetadp are also installed. They enable + virtual machines to make more use of your computer's network + capabilities and are needed for any virtual machine networking + beyond the basic NAT mode. + + + + Since distributing driver modules separately from the kernel is + not something which Linux supports well, the &product-name; + install process creates the modules on the system where they + will be used. This means that you may need to install some + software packages from the distribution which are needed for the + build process. Required packages may include the following: + + + + + + + GNU compiler (GCC) + + + + + + GNU Make (make) + + + + + + Kernel header files + + + + + + + Also ensure that all system updates have been installed and that + your system is running the most up-to-date kernel for the + distribution. + + + + + The running kernel and the kernel header files must be updated + to matching versions. + + + + + The following list includes some details of the required files + for some common distributions. Start by finding the version name + of your kernel, using the command uname -r in + a terminal. The list assumes that you have not changed too much + from the original installation, in particular that you have not + installed a different kernel type. + + + + + + + With Debian and Ubuntu-based distributions, you must install + the correct version of the + linux-headers, usually whichever of + linux-headers-generic, + linux-headers-amd64, + linux-headers-i686 or + linux-headers-i686-pae best matches the + kernel version name. Also, the + linux-kbuild package if it exists. + Basic Ubuntu releases should have the correct packages + installed by default. + + + + + + On Fedora, Red Hat, Oracle Linux and many other RPM-based + systems, the kernel version sometimes has a code of letters + or a word close to the end of the version name. For example + "uek" for the Oracle Unbreakable Enterprise Kernel or + "default" or "desktop" for the standard kernels. In this + case, the package name is + kernel-uek-devel or equivalent. If + there is no such code, it is usually + kernel-devel. + + + + + + On some SUSE and openSUSE Linux versions, you may need to + install the kernel-source and + kernel-syms packages. + + + + + + + If you suspect that something has gone wrong with module + installation, check that your system is set up as described + above and try running the following command, as root: + + +rcvboxdrv setup + + + + Kernel Modules and UEFI Secure Boot + + + If you are running on a system using UEFI (Unified Extensible + Firmware Interface) Secure Boot, you may need to sign the + following kernel modules before you can load them: + + + + + + + vboxdrv + + + + + + vboxnetadp + + + + + + vboxnetflt + + + + + + vboxpci + + + + + + + See your system documentation for details of the kernel module + signing process. + + + + + + + + + Performing the Installation + + + &product-name; is available in a number of package formats + native to various common Linux distributions. See + . In addition, there is an + alternative generic installer (.run) which you can use on + supported Linux distributions. + + + + + Installing &product-name; from a Debian or Ubuntu Package + + + Download the appropriate package for your distribution. The + following example assumes that you are installing to a 64-bit + Ubuntu Xenial system. Use dpkg to install + the Debian package,as follows: + + +sudo dpkg -i virtualbox-version-number_Ubuntu_xenial_amd64.deb + + + The installer will also try to build kernel modules suitable + for the current running kernel. If the build process is not + successful you will be shown a warning and the package will be + left unconfigured. Look at + /var/log/vbox-install.log to find out why + the compilation failed. You may have to install the + appropriate Linux kernel headers, see + . After correcting any + problems, run the following command: + + +sudo rcvboxdrv setup + + + This will start a second attempt to build the module. + + + + If a suitable kernel module was found in the package or the + module was successfully built, the installation script will + attempt to load that module. If this fails, please see + for + further information. + + + + Once &product-name; has been successfully installed and + configured, you can start it by clicking + VirtualBox in your + Start menu or from the + command line. See . + + + + + + + Using the Alternative Generic Installer (VirtualBox.run) + + + The alternative generic installer performs the following + steps: + + + + + + + Unpacks the application files to the target directory + /opt/VirtualBox/, which cannot be + changed. + + + + + + Builds and installs the &product-name; kernel modules: + vboxdrv, vboxnetflt, + and vboxnetadp. + + + + + + Creates /sbin/rcvboxdrv, an init + script to start the &product-name; kernel module. + + + + + + Creates a new system group called + vboxusers. + + + + + + Creates symbolic links in /usr/bin to + a shell script /opt/VirtualBox/VBox + which does some sanity checks and dispatches to the actual + executables: VirtualBox, + VBoxVRDP, + VBoxHeadless and + VBoxManage. + + + + + + Creates + /etc/udev/rules.d/60-vboxdrv.rules, a + description file for udev, if that is present, which makes + the USB devices accessible to all users in the + vboxusers group. + + + + + + Writes the installation directory to + /etc/vbox/vbox.cfg. + + + + + + + The installer must be executed as root with either + install or uninstall as + the first parameter. For example: + + +sudo ./VirtualBox.run install + + + Or if you do not have the sudo command + available, run the following as root instead: + + +./VirtualBox.run install + + + Add every user who needs to access USB devices from a + VirtualBox guests to the group vboxusers. + Either use the OS user management tools or run the following + command as root: + + +sudo usermod -a -G vboxusers username + + + + The usermod command of some older Linux + distributions does not support the + option, which adds the user to the given group without + affecting membership of other groups. In this case, find out + the current group memberships with the + groups command and add all these groups + in a comma-separated list to the command line after the + option. For example: usermod -G + group1,group2,vboxusers + username. + + + + + + + + Performing a Manual Installation + + + If you cannot use the shell script installer described in + , you can perform + a manual installation. Run the installer as follows: + + +./VirtualBox.run --keep --noexec + + + This will unpack all the files needed for installation in the + directory install under the current + directory. The &product-name; application files are contained + in VirtualBox.tar.bz2 which you can + unpack to any directory on your system. For example: + + +sudo mkdir /opt/VirtualBox +sudo tar jxf ./install/VirtualBox.tar.bz2 -C /opt/VirtualBox + + + To run the same example as root, use the following commands: + + +mkdir /opt/VirtualBox +tar jxf ./install/VirtualBox.tar.bz2 -C /opt/VirtualBox + + + The sources for &product-name;'s kernel module are provided in + the src directory. To build the module, + change to the directory and use the following command: + + +make + + + If everything builds correctly, run the following command to + install the module to the appropriate module directory: + + +sudo make install + + + In case you do not have sudo, switch the user account to root + and run the following command: + + +make install + + + The &product-name; kernel module needs a device node to + operate. The above make command will tell + you how to create the device node, depending on your Linux + system. The procedure is slightly different for a classical + Linux setup with a /dev directory, a + system with the now deprecated devfs and a + modern Linux system with udev. + + + + On certain Linux distributions, you might experience + difficulties building the module. You will have to analyze the + error messages from the build system to diagnose the cause of + the problems. In general, make sure that the correct Linux + kernel sources are used for the build process. + + + + Note that the /dev/vboxdrv kernel module + device node must be owned by root:root and must be + read/writable only for the user. + + + + Next, you install the system initialization script for the + kernel module and activate the initialization script using the + right method for your distribution, as follows: + + +cp /opt/VirtualBox/vboxdrv.sh /sbin/rcvboxdrv + + + This example assumes you installed &product-name; to the + /opt/VirtualBox directory. + + + + Create a configuration file for &product-name;, as follows: + + +mkdir /etc/vbox +echo INSTALL_DIR=/opt/VirtualBox > /etc/vbox/vbox.cfg + + + Create the following symbolic links: + + +ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VirtualBox +ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxManage +ln -sf /opt/VirtualBox/VBox.sh /usr/bin/VBoxHeadless + + + + + + Updating and Uninstalling &product-name; + + + Before updating or uninstalling &product-name;, you must + terminate any virtual machines which are currently running and + exit the &product-name; or VBoxSVC applications. To update + &product-name;, simply run the installer of the updated + version. To uninstall &product-name;, run the installer as + follows: + + +sudo ./VirtualBox.run uninstall + + + As root, you can use the following command: + + +./VirtualBox.run uninstall + + + You can uninstall the .run package as follows: + + +/opt/VirtualBox/uninstall.sh + + + To manually uninstall &product-name;, perform the manual + installation steps in reverse order. + + + + + + + Automatic Installation of Debian Packages + + + The Debian packages will request some user feedback when + installed for the first time. The debconf system is used to + perform this task. To prevent any user interaction during + installation, default values can be defined. A file + vboxconf can contain the following debconf + settings: + + +virtualbox virtualbox/module-compilation-allowed boolean true +virtualbox virtualbox/delete-old-modules boolean true + + + The first line enables compilation of the vboxdrv kernel + module if no module was found for the current kernel. The + second line enables the package to delete any old vboxdrv + kernel modules compiled by previous installations. + + + + These default settings can be applied prior to the + installation of the &product-name; Debian package, as follows: + + +debconf-set-selections vboxconf + + + In addition there are some common configuration options that + can be set prior to the installation. See + . + + + + + + + Automatic Installation of RPM Packages + + + The RPM format does not provide a configuration system + comparable to the debconf system. See + for how to set some + common installation options provided by &product-name;. + + + + + + + Automatic Installation Options + + + To configure the installation process for .deb and .rpm + packages, you can create a response file named + /etc/default/virtualbox. The automatic + generation of the udev rule can be prevented with the + following setting: + + +INSTALL_NO_UDEV=1 + + + The creation of the group vboxusers can be prevented as + follows: + + +INSTALL_NO_GROUP=1 + + + If the following line is specified, the package installer will + not try to build the vboxdrv kernel module + if no module fitting the current kernel was found. + + +INSTALL_NO_VBOXDRV=1 + + + + + + + + The vboxusers Group + + + The Linux installers create the system user group + vboxusers during installation. Any system + user who is going to use USB devices from &product-name; guests + must be a member of that group. A user can be made a member of + the group vboxusers either by using the + desktop user and group tools, or with the following command: + + +sudo usermod -a -G vboxusers username + + + + + + Starting &product-name; on Linux + + + The easiest way to start an &product-name; program is by running + the program of your choice (VirtualBox, + VBoxManage, or + VBoxHeadless) from a terminal. These are + symbolic links to VBox.sh that start the + required program for you. + + + + The following detailed instructions should only be of interest + if you wish to execute &product-name; without installing it + first. You should start by compiling the + vboxdrv kernel module and inserting it into + the Linux kernel. &product-name; consists of a service daemon, + VBoxSVC, and several application programs. + The daemon is automatically started if necessary. All + &product-name; applications will communicate with the daemon + through UNIX local domain sockets. There can be multiple daemon + instances under different user accounts and applications can + only communicate with the daemon running under the user account + as the application. The local domain socket resides in a + subdirectory of your system's directory for temporary files + called .vbox-<username>-ipc. In case + of communication problems or server startup problems, you may + try to remove this directory. + + + + All &product-name; applications (VirtualBox, + VBoxManage, and + VBoxHeadless) require the &product-name; + directory to be in the library path, as follows: + + +LD_LIBRARY_PATH=. ./VBoxManage showvminfo "Windows XP" + + + + + + + + Installing on Oracle Solaris Hosts + + + For the specific versions of Oracle Solaris that are supported as + host operating systems, see . + + + + If you have a previously installed instance of &product-name; on + your Oracle Solaris host, please uninstall it first before + installing a new instance. See + for uninstall + instructions. + + + + + Performing the Installation + + + &product-name; is available as a standard Oracle Solaris + package. Download the &product-name; SunOS package, which + includes the 64-bit version of &product-name;. The + installation must be performed as root and from the global + zone. This is because the &product-name; installer + loads kernel drivers, which cannot be done from non-global + zones. To verify which zone you are currently in, execute the + zonename command. + + + + To start installation, run the following commands: + + +gunzip -cd VirtualBox-version-number-SunOS.tar.gz | tar xvf - + + + The &product-name; kernel package is integrated into the main + package. Install the &product-name; package as follows: + + +pkgadd -d VirtualBox-version-number-SunOS.pkg + + + The installer will then prompt you to enter the package you wish + to install. Choose 1 or + all and proceed. Next the + installer will ask you if you want to allow the postinstall + script to be executed. Choose y + and proceed, as it is essential to execute this script which + installs the &product-name; kernel module. Following this + confirmation the installer will install &product-name; and + execute the postinstall setup script. + + + + Once the postinstall script has been executed your installation + is now complete. You may now safely delete the uncompressed + package and autoresponse files from your + system. &product-name; is installed in + /opt/VirtualBox. + + + + + If you need to use &product-name; from non-global zones, see + . + + + + + + + + The vboxuser Group + + + The installer creates the system user group + vboxuser during installation for Oracle + Solaris hosts that support the USB features required by + &product-name;. Any system user who is going to use USB devices + from &product-name; guests must be a member of this group. A + user can be made a member of this group either by using the + desktop user and group tools or by running the following command + as root: + + +usermod -G vboxuser username + + + Note that adding an active user to the + vboxuser group will require the user to log + out and then log in again. This should be done manually after + successful installation of the package. + + + + + + + Starting &product-name; on Oracle Solaris + + + The easiest way to start an &product-name; program is by running + the program of your choice (VirtualBox, + VBoxManage, or + VBoxHeadless) from a terminal. These are + symbolic links to VBox.sh that start the + required program for you. + + + + Alternatively, you can directly invoke the required programs + from /opt/VirtualBox. Using the links + provided is easier as you do not have to enter the full path. + + + + You can configure some elements of the + VirtualBox Qt GUI, such as fonts and colours, + by running VBoxQtconfig from the terminal. + + + + + + + Uninstallation + + + Uninstallation of &product-name; on Oracle Solaris requires root + permissions. To perform the uninstallation, start a root + terminal session and run the following command: + + +pkgrm SUNWvbox + + + After confirmation, this will remove &product-name; from your + system. + + + + + + + Unattended Installation + + + To perform a non-interactive installation of &product-name; + there is a response file named + autoresponse. The installer uses this for + responses to inputs, rather than prompting the user. + + + + Extract the tar.gz package as described in + . Then open a root + terminal session and run the following command: + + +pkgadd -d VirtualBox-version-number-SunOS-x86 -n -a autoresponse SUNWvbox + + + To perform a non-interactive uninstallation, open a root + terminal session and run the following command: + + +pkgrm -n -a /opt/VirtualBox/autoresponse SUNWvbox + + + + + + Configuring a Zone for Running &product-name; + + + Assuming that &product-name; has already been installed into + your zone, you need to give the zone access to &product-name;'s + device node. This is done by performing the following steps. + Start a root terminal and run the following command: + + +zonecfg -z vboxzone + + + Replace vboxzone with the name of the + zone where you intend to run &product-name;. + + + + Use zonecfg to add the + device resource and match + properties to the zone, as follows: + + +zonecfg:vboxzone>add device +zonecfg:vboxzone:device>set match=/dev/vboxdrv +zonecfg:vboxzone:device>end +zonecfg:vboxzone>add device +zonecfg:vboxzone:device>set match=/dev/vboxdrvu +zonecfg:vboxzone:device>end +zonecfg:vboxzone>exit + + + On Oracle Solaris 11 or later, you may also add a device for + /dev/vboxusbmon, similar to that shown + above. + + + + If you are not using sparse root zones, you will need to + loopback mount /opt/VirtualBox from the + global zone into the non-global zone at the same path. This is + specified below using the dir attribute and + the special attribute. For example: + + +zonecfg:vboxzone>add fs +zonecfg:vboxzone:device>set dir=/opt/VirtualBox +zonecfg:vboxzone:device>set special=/opt/VirtualBox +zonecfg:vboxzone:device>set type=lofs +zonecfg:vboxzone:device>end +zonecfg:vboxzone>exit + + + Reboot the zone using zoneadm and you should + be able to run &product-name; from within the configured zone. + + + + + + + diff --git a/doc/manual/en_US/user_Introduction.xml b/doc/manual/en_US/user_Introduction.xml new file mode 100644 index 00000000..a75280eb --- /dev/null +++ b/doc/manual/en_US/user_Introduction.xml @@ -0,0 +1,4801 @@ + + +%all.entities; +]> + + + First Steps + + + Welcome to &product-name;. + + + + &product-name; is a cross-platform virtualization application. What + does that mean? For one thing, it installs on your existing Intel or + AMD-based computers, whether they are running Windows, Mac OS X, + Linux, or Oracle Solaris operating systems (OSes). Secondly, it + extends the capabilities of your existing computer so that it can + run multiple OSes, inside multiple virtual machines, at the same + time. As an example, you can run Windows and Linux on your Mac, run + Windows Server 2016 on your Linux server, run Linux on your Windows + PC, and so on, all alongside your existing applications. You can + install and run as many virtual machines as you like. The only + practical limits are disk space and memory. + + + + &product-name; is deceptively simple yet also very powerful. It can + run everywhere from small embedded systems or desktop class machines + all the way up to datacenter deployments and even Cloud + environments. + + + + The following screenshot shows how &product-name;, installed on an + Apple Mac OS X computer, is running Windows Server 2016 in a virtual + machine window. + + +
+ Windows Server 2016 Virtual Machine, Displayed on a Mac OS X Host + + + + + +
+ + + In this User Manual, we will begin simply with a quick introduction + to virtualization and how to get your first virtual machine running + with the easy-to-use &product-name; graphical user interface. + Subsequent chapters will go into much more detail covering more + powerful tools and features, but fortunately, it is not necessary to + read the entire User Manual before you can use &product-name;. + + + + You can find a summary of &product-name;'s capabilities in + . For existing &product-name; + users who just want to find out what is new in this release, see the + . + + + + + Why is Virtualization Useful? + + + The techniques and features that &product-name; provides are + useful in the following scenarios: + + + + + + + Running multiple operating systems + simultaneously. &product-name; enables you to run + more than one OS at a time. This way, you can run software + written for one OS on another, such as Windows software on + Linux or a Mac, without having to reboot to use it. Since you + can configure what kinds of virtual + hardware should be presented to each such OS, you can install + an old OS such as DOS or OS/2 even if your real computer's + hardware is no longer supported by that OS. + + + + + + Easier software + installations. Software vendors can use virtual + machines to ship entire software configurations. For example, + installing a complete mail server solution on a real machine + can be a tedious task. With &product-name;, such a complex + setup, often called an appliance, can be + packed into a virtual machine. Installing and running a mail + server becomes as easy as importing such an appliance into + &product-name;. + + + + + + Testing and disaster + recovery. Once installed, a virtual machine and its + virtual hard disks can be considered a + container that can be arbitrarily frozen, + woken up, copied, backed up, and transported between hosts. + + + + On top of that, with the use of another &product-name; feature + called snapshots, one can save a + particular state of a virtual machine and revert back to that + state, if necessary. This way, one can freely experiment with + a computing environment. If something goes wrong, such as + problems after installing software or infecting the guest with + a virus, you can easily switch back to a previous snapshot and + avoid the need of frequent backups and restores. + + + + Any number of snapshots can be created, allowing you to travel + back and forward in virtual machine time. You can delete + snapshots while a VM is running to reclaim disk space. + + + + + + Infrastructure consolidation. + Virtualization can significantly reduce hardware and + electricity costs. Most of the time, computers today only use + a fraction of their potential power and run with low average + system loads. A lot of hardware resources as well as + electricity is thereby wasted. So, instead of running many + such physical computers that are only partially used, one can + pack many virtual machines onto a few powerful hosts and + balance the loads between them. + + + + + + + + + + Some Terminology + + + When dealing with virtualization, and also for understanding the + following chapters of this documentation, it helps to acquaint + oneself with a bit of crucial terminology, especially the + following terms: + + + + + + + Host operating system (host + OS). This is the OS of the physical computer on + which &product-name; was installed. There are versions of + &product-name; for Windows, Mac OS X, Linux, and Oracle + Solaris hosts. See . + + + + Most of the time, this manual discusses all &product-name; + versions together. There may be platform-specific differences + which we will point out where appropriate. + + + + + + Guest operating system (guest + OS). This is the OS that is running inside the + virtual machine. Theoretically, &product-name; can run any x86 + OS such as DOS, Windows, OS/2, FreeBSD, and OpenBSD. But to + achieve near-native performance of the guest code on your + machine, we had to go through a lot of optimizations that are + specific to certain OSes. So while your favorite OS + may run as a guest, we officially support + and optimize for a select few, which include the most common + OSes. + + + + See . + + + + + + Virtual machine (VM). This is + the special environment that &product-name; creates for your + guest OS while it is running. In other words, you run your + guest OS in a VM. Normally, a VM is shown + as a window on your computer's desktop. Depending on which of + the various frontends of &product-name; you use, the VM might + be shown in full screen mode or remotely on another computer. + + + + Internally, &product-name; treats a VM as a set of parameters + that specify its behavior. Some parameters describe hardware + settings, such as the amount of memory and number of CPUs + assigned. Other parameters describe the state information, + such as whether the VM is running or saved. + + + + You can view these VM settings in the VirtualBox Manager + window, the Settings dialog, + and by running the VBoxManage command. See + . + + + + + + Guest Additions. This refers + to special software packages which are shipped with + &product-name; but designed to be installed + inside a VM to improve performance of the + guest OS and to add extra features. See + . + + + + + + + + + + Features Overview + + + The following is a brief outline of &product-name;'s main + features: + + + + + + + Portability. &product-name; + runs on a large number of 64-bit host operating systems. See + . + + + + &product-name; is a so-called hosted + hypervisor, sometimes referred to as a type + 2 hypervisor. Whereas a + bare-metal or type 1 + hypervisor would run directly on the hardware, &product-name; + requires an existing OS to be installed. It can thus run + alongside existing applications on that host. + + + + To a very large degree, &product-name; is functionally + identical on all of the host platforms, and the same file and + image formats are used. This enables you to run virtual + machines created on one host on another host with a different + host OS. For example, you can create a virtual machine on + Windows and then run it under Linux. + + + + In addition, virtual machines can easily be imported and + exported using the Open Virtualization Format (OVF), an + industry standard created for this purpose. You can even + import OVFs that were created with a different virtualization + software. See . + + + + For users of &oci; the functionality extends to exporting and + importing virtual machines to and from the cloud. This + simplifies development of applications and deployment to the + production environment. See + . + + + + + + Guest Additions: shared folders, + seamless windows, 3D virtualization. The + &product-name; Guest Additions are software packages which can + be installed inside of supported guest + systems to improve their performance and to provide additional + integration and communication with the host system. After + installing the Guest Additions, a virtual machine will support + automatic adjustment of video resolutions, seamless windows, + accelerated 3D graphics and more. See + . + + + + In particular, Guest Additions provide for shared + folders, which let you access files on the host + system from within a guest machine. See + . + + + + + + Great hardware support. Among + other features, &product-name; supports the following: + + + + + + + Guest multiprocessing + (SMP). &product-name; can present up to 32 + virtual CPUs to each virtual machine, irrespective of how + many CPU cores are physically present on your host. + + + + + + USB device support. + &product-name; implements a virtual USB controller and + enables you to connect arbitrary USB devices to your + virtual machines without having to install device-specific + drivers on the host. USB support is not limited to certain + device categories. See . + + + + + + Hardware compatibility. + &product-name; virtualizes a vast array of virtual + devices, among them many devices that are typically + provided by other virtualization platforms. That includes + IDE, SCSI, and SATA hard disk controllers, several virtual + network cards and sound cards, virtual serial and parallel + ports and an Input/Output Advanced Programmable Interrupt + Controller (I/O APIC), which is found in many computer + systems. This enables easy cloning of disk images from + real machines and importing of third-party virtual + machines into &product-name;. + + + + + + Full ACPI support. The + Advanced Configuration and Power Interface (ACPI) is fully + supported by &product-name;. This enables easy cloning of + disk images from real machines or third-party virtual + machines into &product-name;. With its unique + ACPI power status support, + &product-name; can even report to ACPI-aware guest OSes + the power status of the host. For mobile systems running + on battery, the guest can thus enable energy saving and + notify the user of the remaining power, for example in + full screen modes. + + + + + + Multiscreen resolutions. + &product-name; virtual machines support screen resolutions + many times that of a physical screen, allowing them to be + spread over a large number of screens attached to the host + system. + + + + + + Built-in iSCSI support. + This unique feature enables you to connect a virtual + machine directly to an iSCSI storage server without going + through the host system. The VM accesses the iSCSI target + directly without the extra overhead that is required for + virtualizing hard disks in container files. See + . + + + + + + PXE Network boot. The + integrated virtual network cards of &product-name; fully + support remote booting using the Preboot Execution + Environment (PXE). + + + + + + + + + Multigeneration branched + snapshots. &product-name; can save arbitrary + snapshots of the state of the virtual machine. You can go back + in time and revert the virtual machine to any such snapshot + and start an alternative VM configuration from there, + effectively creating a whole snapshot tree. See + . You can create and delete + snapshots while the virtual machine is running. + + + + + + VM groups. &product-name; + provides a groups feature that enables the user to organize + and control virtual machines collectively, as well as + individually. In addition to basic groups, it is also possible + for any VM to be in more than one group, and for groups to be + nested in a hierarchy. This means you can have groups of + groups. In general, the operations that can be performed on + groups are the same as those that can be applied to individual + VMs: Start, Pause, Reset, Close (Save state, Send Shutdown, + Poweroff), Discard Saved State, Show in File System, Sort. + + + + + + Clean architecture and unprecedented + modularity. &product-name; has an extremely modular + design with well-defined internal programming interfaces and a + clean separation of client and server code. This makes it easy + to control it from several interfaces at once. For example, + you can start a VM simply by clicking on a button in the + &product-name; graphical user interface and then control that + machine from the command line, or even remotely. See + . + + + + Due to its modular architecture, &product-name; can also + expose its full functionality and configurability through a + comprehensive software development kit + (SDK), which enables integration of &product-name; + with other software systems. See + . + + + + + + Remote machine display. The + VirtualBox Remote Desktop Extension (VRDE) enables + high-performance remote access to any running virtual machine. + This extension supports the Remote Desktop Protocol (RDP) + originally built into Microsoft Windows, with special + additions for full client USB support. + + + + The VRDE does not rely on the RDP server that is built into + Microsoft Windows. Instead, the VRDE is plugged directly into + the virtualization layer. As a result, it works with guest + OSes other than Windows, even in text mode, and does not + require application support in the virtual machine either. The + VRDE is described in detail in . + + + + On top of this special capacity, &product-name; offers you + more unique features: + + + + + + + Extensible RDP + authentication. &product-name; already supports + Winlogon on Windows and PAM on Linux for RDP + authentication. In addition, it includes an easy-to-use + SDK which enables you to create arbitrary interfaces for + other methods of authentication. See + . + + + + + + USB over RDP. Using RDP + virtual channel support, &product-name; also enables you + to connect arbitrary USB devices locally to a virtual + machine which is running remotely on an &product-name; RDP + server. See . + + + + + + + + + + + + + Supported Host Operating Systems + + + Currently, &product-name; runs on the following host OSes: + + + + + + + Windows hosts (64-bit): + + + + + + + Windows 8.1 + + + + + + Windows 10 RTM (1507 / 2015 LTSB) build 10240 + + + + + + Windows 10 Anniversary Update (1607 / 2016 LTSB) build + 14393 + + + + + + Windows 10 Fall Creators Update (1709) build 16299 + + + + + + Windows 10 April 2018 Update (1803) build 17134 + + + + + + Windows 10 October 2018 Update (1809 / 2019 LTSC) build + 17763 + + + + + + Windows 10 May 2019 Update (19H1 / 1903) build 18362 + + + + + + Windows 10 November 2019 Update (19H2 / 1909) build 18363 + + + + + + Windows Server 2012 + + + + + + Windows Server 2012 R2 + + + + + + Windows Server 2016 + + + + + + Windows Server 2019 + + + + + + + + + Mac OS X hosts (64-bit): + + + + + + + 10.13 (High Sierra) + + + + + + 10.14 (Mojave) + + + + + + 10.15 (Catalina) + + + + + + + Intel hardware is required. See also + . + + + + + + Linux hosts (64-bit). + Includes the following: + + + + + + + Ubuntu 18.04 LTS, 19.03 and 19.10 + + + + + + Debian GNU/Linux 9 ("Stretch") and 10 ("Buster") + + + + + + Oracle Linux 6, 7 and 8 + + + + + + CentOS/Red Hat Enterprise Linux 6, 7 and 8 + + + + + + Fedora 30 and 31 + + + + + + Gentoo Linux + + + + + + SUSE Linux Enterprise server 12 and 15 + + + + + + openSUSE Leap 15.1 + + + + + + + It should be possible to use &product-name; on most systems + based on Linux kernel 2.6, 3.x, 4.x or 5.x using either the + &product-name; installer or by doing a manual installation. + See . However, the + formally tested and supported Linux distributions are those + for which we offer a dedicated package. + + + + Note that Linux 2.4-based host OSes are no longer supported. + + + + + + Oracle Solaris hosts (64-bit + only). The following versions are supported with + the restrictions listed in : + + + + + + + Oracle Solaris 11 + + + + + + + + + + Note that any feature which is marked as + experimental is not supported. Feedback and + suggestions about such features are welcome. + + + + + Host CPU Requirements + + + SSE2 (Streaming SIMD Extensions 2) support is required for host + CPUs. + + + + + + + + + Installing &product-name; and Extension Packs + + + &product-name; comes in many different packages, and installation + depends on your host OS. If you have installed software before, + installation should be straightforward. On each host platform, + &product-name; uses the installation method that is most common + and easy to use. If you run into trouble or have special + requirements, see for details + about the various installation methods. + + + + &product-name; is split into the following components: + + + + + + + Base package. The base + package consists of all open source components and is licensed + under the GNU General Public License V2. + + + + + + Extension packs. Additional + extension packs can be downloaded which extend the + functionality of the &product-name; base package. Currently, + Oracle provides a single extension pack, available from: + . The extension pack + provides the following added functionality: + + + + + + + The virtual USB 2.0 (EHCI) device. See + . + + + + + + The virtual USB 3.0 (xHCI) device. See + . + + + + + + VirtualBox Remote Desktop Protocol (VRDP) support. See + . + + + + + + Host webcam passthrough. See + . + + + + + + Intel PXE boot ROM. + + + + + + + + Disk image encryption with AES algorithm. See + . + + + + + + Cloud integration features. See . + + + + + + + &product-name; extension packages have a + .vbox-extpack file name extension. To + install an extension, simply double-click on the package file + and a Network Operations + Manager window is shown to guide you through the + required steps. + + + + To view the extension packs that are currently installed, + start the VirtualBox Manager, as shown in + . From the + File menu, select + Preferences. In the window + that displays, go to the + Extensions category. This + shows you the extensions which are currently installed, and + enables you to remove a package or add a new package. + + + + Alternatively, you can use the VBoxManage + command line. See . + + + + + + + + + + Starting &product-name; + + + After installation, you can start &product-name; as follows: + + + + + + + On a Windows host, in the + Programs menu, click on the + item in the VirtualBox group. + On some Windows platforms, you can also enter + VirtualBox in the search box of the + Start menu. + + + + + + On a Mac OS X host, in the Finder, double-click on the + VirtualBox item in the + Applications folder. You may want to drag this item onto your + Dock. + + + + + + On a Linux or Oracle Solaris host, depending on your desktop + environment, an &product-name; item may have been placed in + either the System or System Tools group of your + Applications menu. + Alternatively, you can enter VirtualBox in + a terminal window. + + + + + + + When you start &product-name; for the first time, a window like + the following is displayed: + + +
+ VirtualBox Manager Window, After Initial Startup + + + + + +
+ + + This window is called the VirtualBox + Manager. The left pane will later list all your virtual + machines. Since you have not yet created any virtual machines, + this list is empty. The Tools + button provides access to user tools, such as the Virtual Media + Manager. + + + + The pane on the right displays the properties of the currently + selected virtual machine. Since you do not have any machines yet, + the pane displays a welcome message. + + + + The buttons on the right pane are used to create and work with + VMs. + + + + The following figure gives an idea of what &product-name; might + look like after you have created some VMs. + + +
+ VirtualBox Manager Window, After Creating Virtual Machines + + + + + +
+ + + + + + Creating Your First Virtual Machine + + + Click New in the VirtualBox + Manager window. A wizard is shown, to guide you through setting up + a new virtual machine (VM). + + +
+ Creating a New Virtual Machine: Name and Operating System + + + + + +
+ + + On the following pages, the wizard will ask you for the bare + minimum of information that is needed to create a VM, in + particular: + + + + + + + The Name of the VM you choose + is shown in the machine list of the VirtualBox Manager window + and is also used for the VM's files on disk. + + + + Be sure to assign each VM an informative name that describes + the OS and software running on the VM. For example, + Windows 10 with Visio. + + + + + + The Machine Folder is the + location where VMs are stored on your computer. The default + folder location is shown. + + + + + + For Operating System Type, + select the OS that you want to install. The supported OSes are + grouped. If you want to install something very unusual that is + not listed, select Other. + Depending on your selection, &product-name; will enable or + disable certain VM settings that your guest OS may require. + This is particularly important for 64-bit guests. See + . It is therefore + recommended to always set it to the correct value. + + + + + + On the next page, select the Memory + (RAM) that &product-name; should allocate every + time the virtual machine is started. The amount of memory + given here will be taken away from your host machine and + presented to the guest OS, which will report this size as the + virtual computer's installed RAM. + + + + + Choose this setting carefully. The memory you give to the VM + will not be available to your host OS while the VM is + running, so do not specify more than you can spare. + + + + For example, if your host machine has 4 GB of RAM and you + enter 2048 MB as the amount of RAM for a particular virtual + machine, you will only have 2 GB left for all the other + software on your host while the VM is running. If you run + two VMs at the same time, even more memory will be allocated + for the second VM, which may not even be able to start if + that memory is not available. + + + + On the other hand, you should specify as much as your guest + OS and your applications will require to run properly. A + guest OS may require at least 1 or 2 GB of memory to install + and boot up. For best performance, more memory than that may + be required. + + + + + Always ensure that the host OS has enough RAM remaining. If + insufficient RAM remains, the system might excessively swap + memory to the hard disk, which effectively brings the host + system to a standstill. + + + + As with the other settings, you can change this setting later, + after you have created the VM. + + + + + + Next, you must specify a Virtual Hard + Disk for your VM. + + + + There are many and potentially complicated ways in which + &product-name; can provide hard disk space to a VM, see + , but the most common way is to use + a large image file on your physical hard disk, whose contents + &product-name; presents to your VM as if it were a complete + hard disk. This file then represents an entire hard disk, so + you can even copy it to another host and use it with another + &product-name; installation. + + + + The wizard displays the following window: + + +
+ Creating a New Virtual Machine: Hard Disk + + + + + +
+ + + At this screen, you have the following options: + + + + + + + To create a new, empty virtual hard disk, click the + Create button. + + + + + + You can pick an existing disk image + file. + + + + The drop-down list presented in the window lists all disk + images which are currently remembered by &product-name;. + These disk images are currently attached to a virtual + machine, or have been attached to a virtual machine. + + + + Alternatively, click on the small + folder icon next to the + drop-down list. In the displayed file dialog, you can + click Add to select any + disk image file on your host disk. + + + + + + + If you are using &product-name; for the first time, you will + want to create a new disk image. Click the + Create button. + + + + This displays another window, the Create + Virtual Hard Disk Wizard wizard. This wizard helps + you to create a new disk image file in the new virtual + machine's folder. + + + + &product-name; supports the following types of image files: + + + + + + + A dynamically allocated + file only grows in size when the guest actually + stores data on its virtual hard disk. Therefore, this file + is small initially. As the drive is filled with data, the + file grows to the specified size. + + + + + + A fixed-size file + immediately occupies the file specified, even if only a + fraction of that virtual hard disk space is actually in + use. While occupying much more space, a fixed-size file + incurs less overhead and is therefore slightly faster than + a dynamically allocated file. + + + + + + + For details about the differences, see + . + + + + To prevent your physical hard disk (host OS) from filling up, + &product-name; limits the size of the image file. But the + image file must be large enough to hold the contents of the + guest OS and the applications you want to install. For a + Windows or Linux guest, you will probably need several + gigabytes for any serious use. The limit of the image file + size can be changed later, see + . + + +
+ Creating a New Virtual Machine: File Location and Size + + + + + +
+ + + After having selected or created your image file, click + Next to go to the next page. + + + + + + Click Create, to create your + new virtual machine. The virtual machine is displayed in the + list on the left side of the VirtualBox Manager window, with + the name that you entered initially. + + + + + + + + After becoming familiar with the use of wizards, consider using + the Expert Mode available in some wizards. Where available, this + is selectable using a button, and speeds up the process of using + wizards. + + + + + + + + Running Your Virtual Machine + + + To start a virtual machine, you have several options: + + + + + + + Double-click on the VM's entry in the list in the VirtualBox + Manager window. + + + + + + Select the VM's entry in the list in the VirtualBox Manager + window, and click Start at + the top of the window. + + + + + + Go to the VirtualBox VMs folder in your + system user's home directory. Find the subdirectory of the + machine you want to start and double-click on the machine + settings file. This file has a .vbox file + extension. + + + + + + + Starting a virtual machine displays a new window, and the virtual + machine which you selected will boot up. Everything which would + normally be seen on the virtual system's monitor is shown in the + window. See the screenshot image in + . + + + + In general, you can use the virtual machine as you would use a + real computer. There are couple of points worth mentioning + however. + + + + + Starting a New VM for the First Time + + + When a VM is started for the first time, the + First Start Wizard, is + displayed. This wizard helps you to select an installation + medium. Since the VM is created empty, it would otherwise behave + just like a real computer with no OS installed. It will do + nothing and display an error message that no bootable OS was + found. + + + + For this reason, the wizard helps you to select a medium to + install an OS from. + + + + + + + If you have physical CD or DVD media from which you want to + install your guest OS, such as a Windows installation CD or + DVD, put the media into your host's CD or DVD drive. + + + + In the wizard's drop-down list of installation media, select + Host Drive with the correct + drive letter. In the case of a Linux host, choose a device + file. This will allow your VM to access the media in your + host drive, and you can proceed to install from there. + + + + + + If you have downloaded installation media from the Internet + in the form of an ISO image file such as with a Linux + distribution, you would normally burn this file to an empty + CD or DVD and proceed as described above. With + &product-name; however, you can skip this step and mount the + ISO file directly. &product-name; will then present this + file as a CD or DVD-ROM drive to the virtual machine, much + like it does with virtual hard disk images. + + + + In this case, the wizard's drop-down list contains a list of + installation media that were previously used with + &product-name;. + + + + If your medium is not in the list, especially if you are + using &product-name; for the first time, click the small + folder icon next to the drop-down list to display a standard + file dialog. Here you can pick an image file on your host + disks. + + + + + + + After completing the choices in the wizard, you will be able to + install your OS. + + + + + + + Capturing and Releasing Keyboard and Mouse + + + &product-name; provides a virtual USB tablet device to new + virtual machines through which mouse events are communicated to + the guest OS. If you are running a modern guest OS that can + handle such devices, mouse support may work out of the box + without the mouse being captured as + described below. See . + + + + Otherwise, if the virtual machine detects only standard PS/2 + mouse and keyboard devices, since the OS in the virtual machine + does not know that it is not running on a real computer, it + expects to have exclusive control over your keyboard and mouse. + But unless you are running the VM in full screen mode, your VM + needs to share keyboard and mouse with other applications and + possibly other VMs on your host. + + + + After installing a guest OS and before you install the Guest + Additions, described later, either your VM or the rest of your + computer can "own" the keyboard and the mouse. Both cannot own + the keyboard and mouse at the same time. You will see a + second mouse pointer which is always + confined to the limits of the VM window. You activate the VM by + clicking inside it. + + + + To return ownership of keyboard and mouse to your host OS, + &product-name; reserves a special key on your keyboard: the + Host key. By default, this is the + right Ctrl key on your keyboard. On a Mac + host, the default Host key is the left Command key. You can + change this default in the &product-name; Global Settings. See + . The current setting for the + Host key is always displayed at the bottom right of your VM + window. + + +
+ Host Key Setting on the Virtual Machine Task Bar + + + + + + +
+ + + This means the following: + + + + + + + Your keyboard is owned by + the VM if the VM window on your host desktop has the + keyboard focus. If you have many windows open in your guest + OS, the window that has the focus in your VM is used. This + means that if you want to enter text within your VM, click + on the title bar of your VM window first. + + + + To release keyboard ownership, press the Host key. As + explained above, this is typically the right Ctrl key. + + + + Note that while the VM owns the keyboard, some key + sequences, such as Alt+Tab, will no longer be seen by the + host, but will go to the guest instead. After you press the + Host key to reenable the host keyboard, all key presses will + go through the host again, so that sequences such as Alt+Tab + will no longer reach the guest. For technical reasons it may + not be possible for the VM to get all keyboard input even + when it does own the keyboard. Examples of this are the + Ctrl+Alt+Del sequence on Windows hosts or single keys + grabbed by other applications on X11 hosts such as the GNOME + desktop Locate Pointer feature. + + + + + + Your mouse is owned by the + VM only after you have clicked in the VM window. The host + mouse pointer will disappear, and your mouse will drive the + guest's pointer instead of your normal mouse pointer. + + + + Note that mouse ownership is independent of that of the + keyboard. Even after you have clicked on a titlebar to be + able to enter text into the VM window, your mouse is not + necessarily owned by the VM yet. + + + + To release ownership of your mouse by the VM, press the Host + key. + + + + + + + As this behavior is inconvenient, &product-name; provides a set + of tools and device drivers for guest systems called the + &product-name; Guest Additions. These tools make VM keyboard and + mouse operations much more seamless. Most importantly, the Guest + Additions suppress the second "guest" mouse pointer and make + your host mouse pointer work directly in the guest. See + . + + + + + + + Typing Special Characters + + + Some OSes expect certain key combinations to initiate certain + procedures. The key combinations that you type into a VM might + target the host OS, the &product-name; software, or the guest + OS. The recipient of these keypresses depends on a number of + factors, including the key combination itself. + + + + + + + Host OSes reserve certain key combinations for themselves. + For example, you cannot use the + Ctrl+Alt+Delete combination + to reboot the guest OS in your VM because this key + combination is usually hard-wired into the host OS. So, even + though both the Windows and Linux OSes intercept this key + combination, only the host OS would be rebooted. + + + + On Linux and Oracle Solaris hosts, which use the X Window + System, the key combination + Ctrl+Alt+Backspace normally + resets the X server and restarts the entire graphical user + interface. As the X server intercepts this combination, + pressing it will usually restart your + host graphical user interface and kill + all running programs, including &product-name;, in the + process. + + + + On Linux hosts supporting virtual terminals, the key + combination Ctrl+Alt+Fx, + where Fx is one of the function keys from F1 to F12, + normally enables you to switch between virtual terminals. As + with Ctrl+Alt+Delete, these + combinations are intercepted by the host OS and therefore + always switch terminals on the host. + + + + If, instead, you want to send these key combinations to the + guest OS in the virtual machine, you + will need to use one of the following methods: + + + + + + + Use the items in the + Input, + Keyboard menu of the + virtual machine window. This menu includes the settings + Insert Ctrl+Alt+Delete + and Insert + Ctrl+Alt+Backspace. However, the latter + setting affects only Linux guests or Oracle Solaris + guests. + + + + This menu also includes an option for inserting the Host + key combination. + + + + + + Use special key combinations with the Host key, which is + normally the right Control key. &product-name; then + translates the following key combinations for the VM: + + + + + + + Host key + Del + sends Ctrl+Alt+Del + to reboot the guest OS. + + + + + + Host key + + Backspace sends + Ctrl+Alt+Backspace + to restart the graphical user interface of a Linux + or Oracle Solaris guest. + + + + + + Host key + Function + key. For example, use this key + combination to simulate + Ctrl+Alt+Fx to + switch between virtual terminals in a Linux guest. + + + + + + + + + + + + For some other keyboard combinations such as + Alt+Tab to switch between + open windows, &product-name; enables you to configure + whether these combinations will affect the host or the + guest, if a virtual machine currently has the focus. This is + a global setting for all virtual machines and can be found + under File, + Preferences, + Input. + + + + + + A soft keyboard can be used to input key combinations in the + guest. See . + + + + + + + + + + Changing Removable Media + + + While a virtual machine is running, you can change removable + media in the Devices menu of + the VM's window. Here you can select in detail what + &product-name; presents to your VM as a CD, DVD, or floppy + drive. + + + + The settings are the same as those available for the VM in the + Settings dialog of the + &product-name; main window. But as the + Settings dialog is disabled + while the VM is in the Running or Saved state, the + Devices menu saves you from + having to shut down and restart the VM every time you want to + change media. + + + + Using the Devices menu, you can + attach the host drive to the guest or select a floppy or DVD + image, as described in . + + + + The Devices menu also includes + an option for creating a virtual ISO (VISO) from selected files + on the host. + + + + + + + Resizing the Machine's Window + + + You can resize the VM's window while that VM is running. When + you do, the window is scaled as follows: + + + + + + + If you have scaled mode + enabled, then the virtual machine's screen will be scaled to + the size of the window. This can be useful if you have many + machines running and want to have a look at one of them + while it is running in the background. Alternatively, it + might be useful to enlarge a window if the VM's output + screen is very small, for example because you are running an + old OS in it. + + + + To enable scaled mode, press Host key + + C, or select Scaled + Mode from the + View menu in the VM window. + To leave scaled mode, press Host key + + C again. + + + + The aspect ratio of the guest screen is preserved when + resizing the window. To ignore the aspect ratio, press + Shift during the resize + operation. + + + + See for additional remarks. + + + + + + If you have the Guest Additions installed and they support + automatic resizing, the + Guest Additions will automatically adjust the screen + resolution of the guest OS. For example, if you are running + a Windows guest with a resolution of 1024x768 pixels and you + then resize the VM window to make it 100 pixels wider, the + Guest Additions will change the Windows display resolution + to 1124x768. + + + + See . + + + + + + Otherwise, if the window is bigger than the VM's screen, the + screen will be centered. If it is smaller, then scroll bars + will be added to the machine window. + + + + + + + + + + Saving the State of the Machine + + + When you click on the Close + button of your virtual machine window, at the top right of the + window, just like you would close any other window on your + system, &product-name; asks you whether you want to save or + power off the VM. As a shortcut, you can also press + Host key + Q. + + +
+ Closing Down a Virtual Machine + + + + + +
+ + + The difference between the three options is crucial. They mean + the following: + + + + + + + Save the machine state: + With this option, &product-name; + freezes the virtual machine by + completely saving its state to your local disk. + + + + When you start the VM again later, you will find that the VM + continues exactly where it was left off. All your programs + will still be open, and your computer resumes operation. + Saving the state of a virtual machine is thus in some ways + similar to suspending a laptop computer by closing its lid. + + + + + + Send the shutdown signal. + This will send an ACPI shutdown signal to the virtual + machine, which has the same effect as if you had pressed the + power button on a real computer. This should trigger a + proper shutdown mechanism from within the VM. + + + + + + Power off the machine: With + this option, &product-name; also stops running the virtual + machine, but without saving its state. + + + + + This is equivalent to pulling the power plug on a real + computer without shutting it down properly. If you start + the machine again after powering it off, your OS will have + to reboot completely and may begin a lengthy check of its + virtual system disks. As a result, this should not + normally be done, since it can potentially cause data loss + or an inconsistent state of the guest system on disk. + + + + + As an exception, if your virtual machine has any snapshots, + see , you can use this option to + quickly restore the current + snapshot of the virtual machine. In that case, + powering off the machine will not disrupt its state, but any + changes made since that snapshot was taken will be lost. + + + + + + + The Discard button in the + VirtualBox Manager window discards a virtual machine's saved + state. This has the same effect as powering it off, and the same + warnings apply. + + + + + + + + + Using VM Groups + + + VM groups enable the user to create ad hoc groups of VMs, and to + manage and perform functions on them collectively, as well as + individually. + + + + The following figure shows VM groups displayed in VirtualBox + Manager. + + +
+ Groups of Virtual Machines + + + + + + +
+ + + The following features are available for groups: + + + + + + + Create a group using the VirtualBox Manager. Do one of the + following: + + + + + + + Drag one VM on top of another VM. + + + + + + Select multiple VMs and select + Group from the + right-click menu. + + + + + + + + + Create and manage a group using the command line. Do one of + the following: + + + + + + + Create a group and assign a VM. For example: + + +VBoxManage modifyvm "vm01" --groups "/TestGroup" + + + This command creates a group "TestGroup" and attaches the + VM "vm01" to that group. + + + + + + Detach a VM from the group, and delete the group if empty. + For example: + + +VBoxManage modifyvm "vm01" --groups "" + + + This command detaches all groups from the VM "vm01" and + deletes the empty group. + + + + + + + + + Create multiple groups. For example: + + +VBoxManage modifyvm "vm01" --groups "/TestGroup,/TestGroup2" + + + This command creates the groups "TestGroup" and "TestGroup2", + if they do not exist, and attaches the VM "vm01" to both of + them. + + + + + + Create nested groups, having a group hierarchy. For example: + + +VBoxManage modifyvm "vm01" --groups "/TestGroup/TestGroup2" + + + This command attaches the VM "vm01" to the subgroup + "TestGroup2" of the "TestGroup" group. + + + + + + The following is a summary of group commands: Start, Pause, + Reset, Close (save state, send shutdown signal, poweroff), + Discard Saved State, Show in File System, Sort. + + + + + + + + + + Snapshots + + + With snapshots, you can save a particular state of a virtual + machine for later use. At any later time, you can revert to that + state, even though you may have changed the VM considerably since + then. A snapshot of a virtual machine is thus similar to a machine + in Saved state, but there can be many of them, and these saved + states are preserved. + + + + To see the snapshots of a virtual machine, click on the machine + name in VirtualBox Manager. Then click the + List icon next to the machine + name, and select Snapshots. Until + you take a snapshot of the machine, the list of snapshots will be + empty except for the Current + State item, which represents the "now" point in the + lifetime of the virtual machine. + + + + + Taking, Restoring, and Deleting Snapshots + + + There are three operations related to snapshots, as follows: + + + + + + + Take a snapshot. This makes + a copy of the machine's current state, to which you can go + back at any given time later. + + + + + + + If your VM is running, select Take + Snapshot from the + Machine pull-down menu + of the VM window. + + + + + + If your VM is in either the Saved or the Powered Off + state, as displayed next to the VM name in the + &product-name; main window, click the + List icon next to the + machine name and select + Snapshots. The + snapshots window is shown. Do one of the following: + + + + + + + Click the Take + icon. + + + + + + Right-click on the Current + State item in the list and select + Take. + + + + + + + + + + In either case, a window is displayed prompting you for a + snapshot name. This name is purely for reference purposes to + help you remember the state of the snapshot. For example, a + useful name would be "Fresh installation from scratch, no + Guest Additions", or "Service Pack 3 just installed". You + can also add a longer text in the + Description field. + + + + Your new snapshot will then appear in the snapshots list. + Underneath your new snapshot, you will see an item called + Current State, signifying + that the current state of your VM is a variation based on + the snapshot you took earlier. If you later take another + snapshot, you will see that they are displayed in sequence, + and that each subsequent snapshot is derived from an earlier + one. + + +
+ Snapshots List For a Virtual Machine + + + + + +
+ + + &product-name; imposes no limits on the number of snapshots + you can take. The only practical limitation is disk space on + your host. Each snapshot stores the state of the virtual + machine and thus occupies some disk space. See + for details on what is + stored in a snapshot. + + + + + + Restore a snapshot. In the + list of snapshots, right-click on any snapshot you have + taken and select Restore. + By restoring a snapshot, you go back or forward in time. The + current state of the machine is lost, and the machine is + restored to the exact state it was in when the snapshot was + taken. + + + + + Restoring a snapshot will affect the virtual hard drives + that are connected to your VM, as the entire state of the + virtual hard drive will be reverted as well. This means + also that all files that have been created since the + snapshot and all other file changes will be + lost. In order to prevent such data loss while + still making use of the snapshot feature, it is possible + to add a second hard drive in + write-through mode using the + VBoxManage interface and use it to + store your data. As write-through hard drives are + not included in snapshots, they + remain unaltered when a machine is reverted. See + . + + + + + To avoid losing the current state when restoring a snapshot, + you can create a new snapshot before the restore operation. + + + + By restoring an earlier snapshot and taking more snapshots + from there, it is even possible to create a kind of + alternate reality and to switch between these different + histories of the virtual machine. This can result in a whole + tree of virtual machine snapshots, as shown in the + screenshot above. + + + + + + Delete a snapshot. This + does not affect the state of the virtual machine, but only + releases the files on disk that &product-name; used to store + the snapshot data, thus freeing disk space. To delete a + snapshot, right-click on the snapshot name in the snapshots + tree and select Delete. + Snapshots can be deleted even while a machine is running. + + + + + Whereas taking and restoring snapshots are fairly quick + operations, deleting a snapshot can take a considerable + amount of time since large amounts of data may need to be + copied between several disk image files. Temporary disk + files may also need large amounts of disk space while the + operation is in progress. + + + + + There are some situations which cannot be handled while a VM + is running, and you will get an appropriate message that you + need to perform this snapshot deletion when the VM is shut + down. + + + + + + + + + + Snapshot Contents + + + Think of a snapshot as a point in time that you have preserved. + More formally, a snapshot consists of the following: + + + + + + + The snapshot contains a complete copy of the VM settings, + including the hardware configuration, so that when you + restore a snapshot, the VM settings are restored as well. + For example, if you changed the hard disk configuration or + the VM's system settings, that change is undone when you + restore the snapshot. + + + + The copy of the settings is stored in the machine + configuration, an XML text file, and thus occupies very + little space. + + + + + + The complete state of all the virtual disks attached to the + machine is preserved. Going back to a snapshot means that + all changes that had been made to the machine's disks, file + by file and bit by bit, will be undone as well. Files that + were since created will disappear, files that were deleted + will be restored, changes to files will be reverted. + + + + Strictly speaking, this is only true for virtual hard disks + in "normal" mode. You can configure disks to behave + differently with snapshots, see + . In technical terms, it is + not the virtual disk itself that is restored when a snapshot + is restored. Instead, when a snapshot is taken, + &product-name; creates differencing images which contain + only the changes since the snapshot were taken. When the + snapshot is restored, &product-name; throws away that + differencing image, thus going back to the previous state. + This is both faster and uses less disk space. For the + details, which can be complex, see + . + + + + Creating the differencing image as such does not occupy much + space on the host disk initially, since the differencing + image will initially be empty and grow dynamically later + with each write operation to the disk. The longer you use + the machine after having created the snapshot, however, the + more the differencing image will grow in size. + + + + + + If you took a snapshot while the machine was running, the + memory state of the machine is also saved in the snapshot. + This is in the same way that memory can be saved when you + close a VM window. When you restore such a snapshot, + execution resumes at exactly the point when the snapshot was + taken. + + + + The memory state file can be as large as the memory size of + the VM and will therefore occupy considerable disk space. + + + + + + + + + + + + Virtual Machine Configuration + + + When you select a virtual machine from the list in the VirtualBox + Manager window, you will see a summary of that machine's settings + on the right. + + + + Clicking on Settings displays a + window, where you can configure many of the properties of the + selected VM. But be careful when changing VM settings. It is + possible to change all VM settings after installing a guest OS, + but certain changes might prevent a guest OS from functioning + correctly if done after installation. + + + + + The Settings button is disabled + while a VM is either in the Running or Saved state. This is + because the Settings dialog + enables you to change fundamental characteristics of the virtual + machine that is created for your guest OS. For example, the + guest OS may not perform well if half of its memory is taken + away. As a result, if the + Settings button is disabled, + shut down the current VM first. + + + + + &product-name; provides a wide range of parameters that can be + changed for a virtual machine. The various settings that can be + changed in the Settings window + are described in detail in . Even + more parameters are available when using the + VBoxManage command line interface. See + . + + + + + + + Removing and Moving Virtual Machines + + + You can remove a VM from &product-name; or move the VM and its + associated files, such as disk images, to another location on the + host. + + + + + + + Removing a VM. To remove a + VM, right-click on the VM in the VirtualBox Manager's machine + list and select Remove. + + + + The confirmation dialog enables you to specify whether to only + remove the VM from the list of machines or to remove the files + associated with the VM. + + + + Note that the Remove menu + item is disabled while a VM is running. + + + + + + Moving a VM. To move a VM to + a new location on the host, right-click on the VM in the + VirtualBox Manager's machine list and select + Move. + + + + The file dialog prompts you to specify a new location for the + VM. + + + + When you move a VM, &product-name; configuration files are + updated automatically to use the new location on the host. + + + + Note that the Move menu item + is disabled while a VM is running. + + + + You can also use the VBoxManage movevm + command to move a VM. See . + + + + + + + For information about removing or moving a disk image file from + &product-name;, see . + + + + + + + Cloning Virtual Machines + + + You can create a full copy or a linked copy of an existing VM. + This copy is called a clone. You might use a + cloned VM to experiment with a VM configuration, to test different + guest OS levels, or to back up a VM. + + + + The Clone Virtual Machine wizard + guides you through the cloning process. + + +
+ The Clone Virtual Machine Wizard + + + + + +
+ + + Start the wizard by clicking + Clone in the right-click menu of + the VirtualBox Manager's machine list or in the + Snapshots view of the selected + VM. + + + + Specify a new Name for the clone. + You can choose a Path for the + cloned virtual machine, otherwise &product-name; uses the default + machines folder. + + + + The Clone Type option specifies + whether to create a clone linked to the source VM or to create a + fully independent clone: + + + + + + + Full Clone: Copies all + dependent disk images to the new VM folder. A full clone can + operate fully without the source VM. + + + + + + Linked Clone: Creates new + differencing disk images based on the source VM disk images. + If you select the current state of the source VM as the clone + point, &product-name; creates a new snapshot. + + + + + + + The Snapshots option specifies + whether to create a clone of the current machine state only or of + everything. + + + + + + + Everything: Clones the + current machine state and all its snapshots. + + + + + + Current Machine State and All + Children:. Clones a VM snapshot and all its child + snapshots. + + + + + + + The following clone options are available: + + + + + + + MAC Address Policy: Specifies + how to retain network card MAC addresses when cloning the VM. + + + + For example, the Generate New MAC + Addresses For All Network Adapters value assigns a + new MAC address to each network card during cloning. This is + the default setting. This is the best option when both the + source VM and the cloned VM must operate on the same network. + Other values enable you to retain the existing MAC addresses + in the cloned VM. + + + + + + Keep Disk Names: Retains the + disk image names when cloning the VM. + + + + + + Keep Hardware UUIDs: Retains + the hardware universally unique identifiers (UUIDs) when + cloning the VM. + + + + + + + The duration of the clone operation depends on the size and number + of attached disk images. In addition, the clone operation saves + all the differencing disk images of a snapshot. + + + + Note that the Clone menu item is + disabled while a machine is running. + + + + You can also use the VBoxManage clonevm command + to clone a VM. See . + + + + + + + Importing and Exporting Virtual Machines + + + &product-name; can import and export virtual machines in the + following formats: + + + + + + + Open Virtualization Format + (OVF). This is the industry-standard format. See + . + + + + + + Cloud service formats. Export + to and import from cloud services such as &oci; is supported. + See . + + + + + + + + About the OVF Format + + + OVF is a cross-platform standard supported by many + virtualization products which enables the creation of ready-made + virtual machines that can then be imported into a hypervisor + such as &product-name;. &product-name; makes OVF import and + export easy to do, using the VirtualBox Manager window or the + command-line interface. + + + + Using OVF enables packaging of virtual + appliances. These are disk images, together with + configuration settings that can be distributed easily. This way + one can offer complete ready-to-use software packages, including + OSes with applications, that need no configuration or + installation except for importing into &product-name;. + + + + + The OVF standard is complex, and support in &product-name; is + an ongoing process. In particular, no guarantee is made that + &product-name; supports all appliances created by other + virtualization software. For a list of known limitations, see + . + + + + + Appliances in OVF format can appear in the following variants: + + + + + + + They can come in several files, as one or several disk + images, typically in the widely-used VMDK format. See + . They also include a textual + description file in an XML dialect with an + .ovf extension. These files must then + reside in the same directory for &product-name; to be able + to import them. + + + + + + Alternatively, the above files can be packed together into a + single archive file, typically with an + .ova extension. Such archive files use + a variant of the TAR archive format and can therefore be + unpacked outside of &product-name; with any utility that can + unpack standard TAR files. + + + + + + + + OVF cannot describe snapshots that were taken for a virtual + machine. As a result, when you export a virtual machine that + has snapshots, only the current state of the machine will be + exported. The disk images in the export will have a + flattened state identical to the current + state of the virtual machine. + + + + + + + + Importing an Appliance in OVF Format + + + The following steps show how to import an appliance in OVF + format. + + + + + + + Double-click on the OVF or OVA file. + + + + &product-name; creates file type associations automatically + for any OVF and OVA files on your host OS. + + + + + + Select File, + Import Appliance from the + VirtualBox Manager window. + + + + From the file dialog, go to the file with either the + .ovf or the .ova + file extension. + + + + Click Import to open the + Appliance Settings screen. + + +
+ Appliance Settings Screen for Import Appliance + + + + + + +
+ + + This screen shows the VMs described in the OVF or OVA file + and enables you to change the VM settings. + + + + By default, membership of VM groups is preserved on import + for VMs that were initially exported from &product-name;. + You can change this behavior by using the + Primary Group + setting for the VM. + + + + The following global settings apply to all of the VMs that + you import: + + + + + + + Base Folder: Specifies + the directory on the host in which to store the imported + VMs. + + + + If an appliance has multiple VMs, you can specify a + different directory for each VM by editing the + Base Folder setting for + the VM. + + + + + + MAC Address Policy: + Reinitializes the MAC addresses of network cards in your + VMs prior to import, by default. You can override the + default behavior and preserve the MAC addresses on + import. + + + + + + Import Hard Drives as + VDI: Imports hard drives in the VDI format + rather than in the default VMDK format. + + + + + + + + + Click Import to import the + appliance. + + + + &product-name; copies the disk images and creates local VMs + with the settings described on the + Appliance Settings screen. + The imported VMs are shown in the list of VMs in VirtualBox + Manager. + + + + Because disk images are large, the VMDK images that are + included with virtual appliances are shipped in a compressed + format that cannot be used directly by VMs. So, the images + are first unpacked and copied, which might take several + minutes. + + + + + + + You can use the VBoxManage import command to + import an appliance. See . + + + + + + + Exporting an Appliance in OVF Format + + + The following steps show how to export an appliance in OVF + format. + + + + + + + Select File, + Export Appliance to open + the Export Virtual + Appliance wizard. + + + + From the initial window, you can combine several VMs into an + OVF appliance. + + + + Select one or more VMs to export, and click + Next. + + + + + + The Appliance Settings + screen enables you to select the following settings: + + + + + + + Format: Selects the + Open Virtualization + Format value for the output files. + + + + The &oci; value exports + the appliance to &oci;. See + . + + + + + + File: Selects the + location in which to store the exported files. + + + + + + MAC Address Policy: + Specifies whether to retain or reassign network card MAC + addresses on export. + + + + + + Write Manifest File: + Enables you to include a manifest file in the exported + archive file. + + + + + + Include ISO Image + Files: Enables you to include ISO image files + in the exported archive file. + + + + + + + + + Click Next to show the + Virtual System Settings + screen. + + + + You can edit settings for the virtual appliance. For + example, you can change the name of the virtual appliance or + add product information, such as vendor details or license + text. + + + + Double-click the appropriate field to change its value. + + + + + + Click Export to begin the + export process. Note that this operation might take several + minutes. + + + + + + + You can use the VBoxManage export command to + export an appliance. See . + + + + + + + + + Integrating with &oci; + + + This section describes how to use the features of &product-name; + to integrate with &oci;. + + + + Integrating with &oci; involves the following steps: + + + + + + + Prepare for &oci; + Integration. Before using &product-name; with &oci; + there are some initial configuration steps you may need to do. + See . + + + + + + Use &product-name; with + &oci;. + describes how you can use &product-name; with &oci;. + + + + + + + + Preparing for &oci; Integration + + + Perform the following configuration steps before using + &product-name; to integrate with your &oci; account. + + + + + + + Install the Extension Pack. + Cloud integration features are only available when you + install the &product-name; Extension Pack. See + . + + + + + + Create a key pair. Generate + an API signing key pair that is used for API requests to + &oci;. See . + + + + Upload the public key of the key pair from your client + device to the cloud service. See + . + + + + + + Create a cloud profile. The + cloud profile contains resource identifiers for your cloud + account, such as your user OCID, and details of your key + pair. See . + + + + + + + + + + Creating an API Signing Key Pair + + + + + To use the cloud integration features of &product-name;, you + must generate an API signing key pair that is used for API + requests to &oci;. + + + + Your API requests are signed with your private key, and &oci; + uses the public key to verify the authenticity of the request. + You must upload the public key to the &oci; Console. + + + + + This key pair is not the same SSH key that you use to access + compute instances on &oci;. + + + + + + + + (Optional) Create a .oci directory to + store the key pair. + + +$ mkdir ~/.oci + + + The key pair is usually installed in the + .oci folder in your home directory. For + example, ~/.oci on a Linux system. + + + + + + Generate the private key. + + + + Use the openssl command. + + + + + + + To generate a private key with a passphrase: + + +$ openssl genrsa -out ~/.oci/oci_api_key.pem -aes128 2048 + + + + + To generate a private key without a passphrase: + + +$ openssl genrsa -out ~/.oci/oci_api_key.pem 2048 + + + + + + + + Change permissions for the private key. + + +$ chmod 600 ~/.oci/oci_api_key.pem + + + Generate the public key. + + +$ openssl rsa -pubout -in ~/.oci/oci_api_key.pem -out ~/.oci/oci_api_key_public.pem + + + + + + + + + Uploading the Public Key to &oci; + + + Use the following steps to upload your public key to &oci;. + + + + + + + Log in to the &oci; Console. + + + + + + Display the User Settings + page. + + + + Click Profile, + User Settings. + + + + + + Display your current API signing keys. + + + + Click Resources, + API Keys. + + + + + + Upload the public key. + + + + Click Add Public Key. + + + + The Add Public Key dialog + is displayed. + + +
+ Upload Public Key Dialog in &oci; Console + + + + + + +
+ + + Select one of the following options: + + + + + + + Choose Public Key File. + This option enables you to browse to the public key file + on your local hard disk. + + + + + + Paste Public Keys. This + option enables you to paste the contents of the public + key file into the window in the dialog box. + + + + + + + Click Add to upload the + public key. + + + + + + + + + + Creating a Cloud Profile + + + &product-name; uses a cloud profile to + connect to &oci;. A cloud profile is a text file that contains + details of your key files and Oracle Cloud Identifier (OCID) + resource identifiers for your cloud account, such as the + following: + + + + + + + Fingerprint of the public + key. To obtain the fingerprint, you can use the + openssl command: + + +$ openssl rsa -pubout -outform DER -in ~/.oci/oci_api_key.pem | openssl md5 -c + + + + + Location of the private key on the + client device. Specify the full path to the + private key. + + + + + + (Optional) Passphrase for the private + key.. This is only required if the key is + encrypted. + + + + + + Region. Shown on the &oci; + Console. Click + Administration, + Tenancy Details. + + + + + + Tenancy OCID. Shown on the + &oci; Console. Click + Administration, + Tenancy Details. + + + + A link enables you to copy the Tenancy OCID. + + + + + + Compartment OCID. Shown on + the &oci; Console. Click + Identity, + Compartments. + + + + A link enables you to copy the Compartment OCID. + + + + + + User OCID. Shown on the + &oci; Console. Click + Profile, + User Settings. + + + + A link enables you to copy the User OCID. + + + + + + + You can create a cloud profile in the following ways: + + + + + + + Automatically, by using the Cloud + Profile Manager. See + . + + + + The Cloud Profile Manager is a component of &product-name; + that enables you to create, edit, and manage cloud profiles + for your cloud service accounts. + + + + + + Automatically, by using the VBoxManage + cloudprofile command. See + . + + + + + + Manually, by creating an oci_config + file in your &product-name; global configuration directory. + For example, this is + $HOME/.config/VirtualBox/oci_config on + a Linux host. + + + + + + Manually, by creating a config file in + your &oci; configuration directory. For example, this is + $HOME/.oci/config on a Linux host. + + + + This is the same file that is used by the &oci; command line + interface. + + + + &product-name; automatically uses the + config file if no cloud profile file is + present in your global configuration directory. + Alternatively, you can import this file manually into the + Cloud Profile Manager. + + + + + + + + + + Using the Cloud Profile Manager + + + This section describes how to use the Cloud Profile Manager to + create a cloud profile. + + + + To open the Cloud Profile Manager click + File, + Cloud Profile Manager in the + VirtualBox Manager window. + + +
+ The Cloud Profile Manager + + + + + +
+ + + You can use the Cloud Profile Manager in the following ways: + + + + + + + To create a new cloud profile automatically + + + + + + To create a cloud profile by importing settings from your + &oci; configuration file. + + + + + + + Perform the following steps to create a new cloud profile + automatically, using the Cloud Profile Manager: + + + + + + + Click the Add icon and + specify a Name for the + profile. + + + + + + Click Properties and + specify the following property values for the profile: + + + + + + + Compartment OCID + + + + + + Fingerprint of the public key + + + + + + Location of the private key on the client device + + + + + + + + Region OCID + + + + + + Tenancy OCID + + + + + + User OCID + + + + + + + Some of these are settings for your &oci; account, which you + can view from the &oci; Console. + + + + + + Click Apply to save your + changes. + + + + The cloud profile settings are saved in the + oci_config file in your &product-name; + global settings directory. + + + + + + + Perform the following steps to import an existing &oci; + configuration file into the Cloud Profile Manager: + + + + + + + Ensure that a config file is present in + your &oci; configuration directory. For example, this is + $HOME/.oci/config on a Linux host. + + + + + + Click the Import icon to + open a dialog that prompts you to import cloud profiles from + external files. + + + + + This action overwrites any cloud profiles that are in your + &product-name; global settings directory. + + + + + + + Click Import. + + + + Your cloud profile settings are saved to the + oci_config file in your &product-name; + global settings directory. + + + + + + Click Properties to show + the cloud profile settings. + + + + Double-click on the appropriate field to change the value. + + + + + + Click Apply to save your + changes. + + + + + + + + + + Using &product-name; With &oci; + + + This section describes how you can use &product-name; with &oci; + to do the following tasks: + + + + + + + Export an &product-name; VM to &oci;. See + . + + + + + + Import a cloud instance into &product-name;. See + . + + + + + + Create a new cloud instance from a custom image stored on + &oci;. See . + + + + + + Use the VBoxManage commands to integrate + with &oci; and perform cloud operations. See + . + + + + + + + + + + Exporting an Appliance to &oci; + + + &product-name; supports the export of VMs to an &oci; service. + The exported VM is stored on &oci; as a custom Linux image. You + can configure whether a cloud instance is created and started + after the export process has completed. + + + + + Before you export a VM to &oci;, you must prepare the VM as + described in . + + + + + Use the following steps to export a VM to &oci;: + + + + + + + Select File, + Export Appliance to open + the Export Virtual + Appliance wizard. + + + + Select a VM to export and click + Next to open the + Appliance Settings screen. + + + + + + From the Format drop-down + list, select &oci;. + + + + In the Account drop-down + list, select the cloud profile for your &oci; account. + + + + The list after the Account + field shows the profile settings for your cloud account. + + +
+ Appliance Settings Screen, Showing Cloud Profile and Machine Creation + Settings + + + + + +
+ + + In the Machine Creation + field, select an option to configure settings for a cloud + instance created when you export to &oci;. The options + enable you to do one of the following: + + + + + + + Configure settings for the cloud instance + after you have finished exporting + the VM. + + + + + + Configure settings for the cloud instance + before you start to export the VM. + + + + + + Do not create a cloud instance when you export the VM. + + + + + + + Click Next to make an API + request to the &oci; service and open the + Virtual System Settings + screen. + + + + + + (Optional) Edit storage settings used for the exported + virtual machine in &oci;. You can change the following + settings: + + + + + + + The name of the bucket used to store the exported files. + + + + + + Whether to store the custom image in &oci;. + + + + + + The name for the custom image in &oci;. + + + + + + The launch mode for the custom image. + + + + Paravirtualized mode + gives improved performance and should be suitable for + most &product-name; VMs. + + + + Emulated mode is + suitable for legacy OS images. + + + + + + + Click Export to continue. + + + + + + Depending on the selection in the + Machine Creation field, the + Cloud Virtual Machine + Settings screen may be displayed before or after + export. This screen enables you to configure settings for + the cloud instance, such as Shape and Disk Size. + + + + Click Create. The VM is + exported to &oci;. + + + + Depending on the Machine + Creation setting, a cloud instance may be started + after upload to &oci; is completed. + + + + + + Monitor the export process by using the &oci; Console. + + + + + + + You can also use the VBoxManage export + command to export a VM to &oci;. See + . + + + + + Preparing a VM for Export to &oci; + + + &oci; provides the option to import a custom Linux image. + Before an &product-name; image can be exported to &oci;, the + custom image needs to be prepared to ensure that instances + launched from the custom image can boot correctly and that + network connections will work. This section provides advice on + how to prepare a Linux image for export from &product-name;. + + + + The following list shows some tasks to consider when preparing + an Oracle Linux VM for export: + + + + + + + Use DHCP for network + addresses. Configure the VM to use a DHCP + server to allocate network addresses, rather than using a + static IP address. The &oci; instance will then be + allocated an IP address automatically. + + + + + + Do not specify a MAC + address. The network interface configuration + for the VM must not specify the MAC address. + + + + Remove the HWADDR setting from the + /etc/sysconfig/ifcfg-devicename + network script. + + + + + + Disable persistent network device + naming rules. This means that the &oci; + instance will use the same network device names as the VM. + + + + + + + Change the GRUB kernel parameters. + + + + Add net.ifnames=0 and + biosdevname=0 as kernel parameter + values to the GRUB_CMDLINE_LINUX + variable. + + + + + + Update the GRUB configuration. + + +# grub2-mkconfig -o /boot/grub2/grub.cfg + + + + + Disable any udev rules for network + device naming. + + + + For example, if an automated udev + rule exists for net-persistence: + + +# cd /etc/udev/rules.d +# rm -f 70-persistent-net.rules +# ln -s /dev/null /etc/udev/rules.d/70-persistent-net.rules + + + + + + + + Enable the serial + console. This enables you to troubleshoot the + instance when it is running on &oci;. + + + + + + + Edit the /etc/default/grub file, + as follows: + + + + + + + Remove the resume setting from + the kernel parameters. This setting slows down + boot time significantly. + + + + + + Replace GRUB_TERMINAL="gfxterm" + with GRUB_TERMINAL="console + serial". This configures use of the + serial console instead of a graphical terminal. + + + + + + Add GRUB_SERIAL_COMMAND="serial --unit=0 + --speed=115200". This configures the + serial connection. + + + + + + Add console=tty0 + console=ttyS0,115200 to the + GRUB_CMDLINE_LINUX variable. + This adds the serial console to the Linux kernel + boot parameters. + + + + + + + + + Regenerate the GRUB configuration. + + +# grub2-mkconfig -o /boot/grub2/grub.cfg + + + + + To verify the changes, reboot the machine and run the + dmesg command to look for the + updated kernel parameters. + + +# dmesg |grep console=ttyS0 + + + + + + + + Enable paravirtualized device + support. You do this by adding the + virtio drivers to the + initrd for the VM. + + + + + + + This procedure works only on machines with a Linux + kernel of version 3.4 or later. Check that the VM is + running a supported kernel: + + +# uname -a + + + + + Use the dracut tool to rebuild + initrd. Add the + qemu module, as follows: + + +# dracut –-logfile /var/log/Dracut.log –-force –-add qemu + + + + + Verify that the virtio drivers are + now present in initrd. + + + # lsinitrd |grep virtio + + + + + + + + + For more information about importing a custom Linux image into + &oci;, see also: + + + + + + + + + + + + + Importing an Instance from &oci; + + + Perform the following steps to import a cloud instance from + &oci; into &product-name;: + + + + + + + Select File, + Import Appliance to open + the Import Virtual + Appliance wizard. + + + + In the Source drop-down + list, select &oci;. + + + + In the Account drop-down + list, select the cloud profile for your &oci; account. + + + + The list after the Account + field shows the profile settings for your cloud account. + + + + Choose the required cloud instance from the list in the + Machines field. + + + + Click Next to make an API + request to the &oci; service and display the + Appliance Settings screen. + + + + + + (Optional) Edit settings for the new local virtual machine. + + + + For example, you can edit the VM name and description. + + +
+ Import Cloud Instance Screen, Showing Profile Settings and VM Settings + + + + + +
+ + + Click Import to import the + instance from &oci;. + + + + + + Monitor the import process by using the &oci; Console. + + + + + + + You can also use the VBoxManage import + command to import an instance from &oci;. See + . + + + + + Importing an Instance: Overview of Events + + + The following describes the sequence of events when you import + an instance from &oci;. + + + + + + + A custom image is created from the boot volume of the + instance. + + + + + + The custom image is exported to an &oci; object and is + stored using Object Storage in the bucket specified by the + user. + + + + + + The &oci; object is downloaded to the local host. The + object is a TAR archive which contains a boot volume of + the instance in QCOW2 format and a JSON file containing + metadata related to the instance. + + + + + + The boot volume of the instance is extracted from the + archive and a new VMDK image is created by converting the + boot volume into the VMDK format. The VMDK image is + registered with &product-name;. + + + + + + A new VM is created using the VMDK image for the cloud + instance. + + + + By default, the new VM is not started after import from + &oci;. + + + + + + The downloaded TAR archive is deleted after a successful + import. + + + + + + + + + + + + Creating New Cloud Instances from a Custom Image + + + You can use &product-name; to create new instances from a custom + image on your cloud service. + + + + describes how to create a + custom image when you are exporting a VM to &oci;. Using a + custom image means that you can quickly create cloud instances + without having to upload your image to the cloud service every + time. + + + + Perform the following steps to create a new cloud instance on + &oci;: + + + + + + + Select File, + New Cloud VM to open the + Create Cloud Virtual + Machine wizard. + + + + + + From the Destination + drop-down list, select + &oci;. + + + + In the Account drop-down + list, select the cloud profile for your &oci; account. + + + + The list after the Account + field shows the profile settings for your cloud account. + + + + In the Images list, select + from the custom images available on &oci;. + + +
+ New Cloud VM Wizard, Showing List of Custom Images + + + + + +
+ + + Click Next to make an API + request to the &oci; service and open the + Cloud Virtual Machine + Settings screen. + + + + + + (Optional) Edit settings used for the new instance on &oci;. + + + + For example, you can edit the Disk Size and Shape used for + the VM instance and the networking configuration. + + + + Click Create to create the + new cloud instance. + + + + + + Monitor the instance creation process by using the &oci; + Console. + + + + + + + You can also use the VBoxManage cloud + instance command to create and manage instances on a + cloud service. See . + + + + + + + Using VBoxManage Commands With &oci; + + + This section includes some examples of how + VBoxManage commands can be used to integrate + with &oci; and perform common cloud operations. + + + + Creating a Cloud Profile + + + + To create a cloud profile called vbox-oci: + + +VBoxManage cloudprofile --provider "OCI" --profile="vbox-oci" add \ +--clouduser="ocid1.user.oc1..." --keyfile="/home/username/.oci/oci_api_key.pem" \ +--tenancy="ocid1.tenancy.oc1..." --compartment="ocid1.compartment.oc1..." --region="us-ashburn-1" + + + + The new cloud profile is added to the + oci_config file in your &product-name; + global configuration directory. For example, this is + $HOME/.VirtualBox/oci_config on a Windows + host. + + + + Listing Cloud Instances + + + + To list the instances in your &oci; compartment: + + +VBoxManage cloud --provider="OCI" --profile="vbox-oci" list instances + + + + Exporting an &product-name; VM to the + Cloud + + + + To export a VM called myVM and create a cloud + instance called myVM_Cloud: + + +VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \ +--cloudprofile "vbox-oci" --cloudbucket myBucket \ +--cloudshape VM.Standard2.1 --clouddomain US-ASHBURN-AD-1 --clouddisksize 50 \ +--cloudocivcn ocid1.vcn.oc1... --cloudocisubnet ocid1.subnet.oc1... \ +--cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true + + + + Importing a Cloud Instance Into + &product-name; + + + + To import a cloud instance and create an &product-name; VM + called oci_Import: + + +VBoxManage import OCI:// --cloud --vmname oci_Import --memory 4000 +--cpus 3 --ostype FreeBSD_64 --cloudprofile "vbox-oci" +--cloudinstanceid ocid1.instance.oc1... --cloudbucket myBucket + + + + Creating a New Cloud Instance From a + Custom Image + + + + To create a new cloud instance from a custom image on &oci;: + + +VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance create \ +--domain-name="oraclecloud.com" --image-id="ocid1.image.oc1..." --display-name="myInstance" \ +--shape="VM.Standard2.1" --subnet="ocid1.subnet.oc1..." + + + Terminating a Cloud Instance + + + + To terminate an instance in your compartment on &oci;: + + +VBoxManage cloud --provider="OCI" --profile="vbox-oci" instance terminate \ +--id="ocid1.instance.oc1..." + + + For more details about the available commands for cloud + operations, see . + + + + + + + + + Global Settings + + + The Global Settings dialog can be + displayed using the File menu, by + clicking the Preferences item. + This dialog offers a selection of settings, most of which apply to + all virtual machines of the current user. The + Extensions option applies to the + entire system. + + + + The following settings are available: + + + + + + + General. Enables the user to + specify the default folder or directory for VM files, and the + VRDP Authentication Library. + + + + + + Input. Enables the user to + specify the Host key. This is the key that toggles whether the + cursor is in the focus of the VM or the Host OS windows, see + . The Host key is also used + to trigger certain VM actions, see + . + + + + + + Update. Enables the user to + specify various settings for Automatic Updates. + + + + + + Language. Enables the user to + specify the GUI language. + + + + + + Display. Enables the user to + specify the screen resolution, and its width and height. A + default scale factor can be specified for all guest screens. + + + + + + Network. Enables the user to + configure the details of NAT networks. See + . + + + + + + Extensions. Enables the user + to list and manage the installed extension packages. + + + + + + Proxy. Enables the user to + configure a HTTP Proxy Server. + + + + + + + + + + Alternative Front-Ends + + + As briefly mentioned in , + &product-name; has a very flexible internal design that enables + you to use multiple interfaces to control the same virtual + machines. For example, you can start a virtual machine with the + VirtualBox Manager window and then stop it from the command line. + With &product-name;'s support for the Remote Desktop Protocol + (RDP), you can even run virtual machines remotely on a headless + server and have all the graphical output redirected over the + network. + + + + The following front-ends are shipped in the standard + &product-name; package: + + + + + + + VirtualBox. This is the + VirtualBox Manager, a graphical user interface that uses the + Qt toolkit. This interface is described throughout this + manual. While this is the simplest and easiest front-end to + use, some of the more advanced &product-name; features are not + included. + + + + + + VBoxManage. A command-line + interface for automated and detailed control of every aspect + of &product-name;. See + . + + + + + + VBoxHeadless. A front-end + that produces no visible output on the host at all, but can + act as a RDP server if the VirtualBox Remote Desktop Extension + (VRDE) is installed and enabled for the VM. As opposed to the + other graphical interfaces, the headless front-end requires no + graphics support. This is useful, for example, if you want to + host your virtual machines on a headless Linux server that has + no X Window system installed. See + . + + + + + + + If the above front-ends still do not satisfy your particular + needs, it is possible to create yet another front-end to the + complex virtualization engine that is the core of &product-name;, + as the &product-name; core neatly exposes all of its features in a + clean API. See . + + + + + + + Soft Keyboard + + + &product-name; provides a soft keyboard that + enables you to input keyboard characters on the guest. A soft + keyboard is an on-screen keyboard that can be used as an + alternative to a physical keyboard. See + for details of how to use the + soft keyboard. + + + + + For best results, ensure that the keyboard layout configured on + the guest OS matches the keyboard layout used by the soft + keyboard. &product-name; does not do this automatically. + + + +
+ Soft Keyboard in a Guest Virtual Machine + + + + + +
+ + + The soft keyboard can be used in the following scenarios: + + + + + + + When the physical keyboard on the host is not the same as the + keyboard layout configured on the guest. For example, if the + guest is configured to use an international keyboard, but the + host keyboard is US English. + + + + + + To send special key combinations to the guest. Note that some + common key combinations are also available in the + Input, + Keyboard menu of the guest VM + window. See . + + + + + + For guests in kiosk mode, where a physical keyboard is not + present. + + + + + + When using nested virtualization, the soft keyboard provides a + method of sending key presses to a guest. + + + + + + + By default, the soft keyboard includes some common international + keyboard layouts. You can copy and modify these to meet your own + requirements. See . + + + + + Using the Soft Keyboard + + + + + + Display the soft keyboard. + + + + In the guest VM window, select + Input, + Keyboard, + Soft Keyboard. + + + + + + Select the required keyboard layout. + + + + The name of the current keyboard layout is displayed in the + task bar of the soft keyboard window. This is the previous + keyboard layout that was used. + + + + Click the Layout List icon + in the task bar of the soft keyboard window. The + Layout List window is + displayed. + + + + Select the required keyboard layout from the entries in the + Layout List window. + + + + The keyboard display graphic is updated to show the + available input keys. + + + + + + Use the soft keyboard to enter keyboard characters on the + guest. + + + + + + + Modifier keys such as Shift, Ctrl, and Alt are available + on the soft keyboard. Click once to select the modifier + key, click twice to lock the modifier key. + + + + The Reset the Keyboard and Release + All Keys icon can be used to release all + pressed modifier keys, both on the host and the guest. + + + + + + To change the look of the soft keyboard, click the + Settings icon in the + task bar. You can change colors used in the keyboard + graphic, and can hide or show sections of the keyboard, + such as the NumPad or multimedia keys. + + + + + + + + + + + + + Creating a Custom Keyboard Layout + + + You can use one of the supplied default keyboard layouts as the + starting point to create a custom keyboard layout. + + + + + To permananently save a custom keyboard layout, you must save + it to file. Otherwise, any changes you make are discarded when + you close down the Soft + Keyboard window. + + + + Custom keyboard layouts that you save are stored as an XML + file on the host, in the keyboardLayouts + folder in the global configuration data directory. For + example, in + $HOME/.config/VirtualBox/keyboardLayouts + on a Linux host. + + + + + + + + Display the Layout List. + + + + Click the Layout List icon + in the task bar of the soft keyboard window. + + + + + + Make a copy of an existing keyboard layout. + + + + Highlight the required layout and click the + Copy the Selected Layout + icon. + + + + A new layout entry with a name suffix of + -Copy is created. + + + + + + Edit the new keyboard layout. + + + + Highlight the new layout in the Layout + List and click the Edit the + Selected Layout icon. + + + + Enter a new name for the layout. + + + + Edit keys in the new layout. Click on the key that you want + to edit and enter new key captions in the + Captions fields. + + + + The keyboard graphic is updated with the new captions. + + + + + + (Optional) Save the layout to file. This means that your + custom keyboard layout will be available for future use. + + + + Highlight the new layout in the Layout + List and click the Save the + Selected Layout into File icon. + + + + Any custom layouts that you create can later be removed from + the Layout List, by highlighting and clicking the + Delete the Selected Layout + icon. + + + + + + + + + + diff --git a/doc/manual/en_US/user_KnownIssues.xml b/doc/manual/en_US/user_KnownIssues.xml new file mode 100644 index 00000000..e7e3c633 --- /dev/null +++ b/doc/manual/en_US/user_KnownIssues.xml @@ -0,0 +1,464 @@ + + +%all.entities; +]> + + + Known Limitations + + + + Experimental Features + + + Some &product-name; features are labeled as experimental. Such + features are provided on an "as-is" basis and are not formally + supported. However, feedback and suggestions about such features + are welcome. A comprehensive list of experimental features is as + follows: + + + + + + + Hardware 3D acceleration support for Windows, Linux, and + Oracle Solaris guests + + + + + + Hardware 2D video playback acceleration support for Windows + guests + + + + + + + + Mac OS X guests (Mac OS X hosts only) + + + + + + ICH9 chipset emulation + + + + + + EFI firmware + + + + + + Host CD/DVD drive passthrough + + + + + + Support of iSCSI using internal networking + + + + + + Using &product-name; and Hyper-V on the same host + + + + + + + + + + Known Issues + + + The following section describes known problems with this release + of &product-name;. Unless marked otherwise, these issues are + planned to be fixed in later releases. + + + + + + + Poor performance when using &product-name; and + Hyper-V on the same host. To + fix this, certain Windows features like "Hyper-V Platform", + "Virtual Machine Platform" and "Windows Hypervisor Platform" + must be turned off, followed by a host reboot. + + + + Additionally, the Microsoft Device Guard and Credential Guard + hardware readiness tool might have to be used in order to turn + off more features. For example, by running the following + command: + + +.\DG_Readiness_Tool_vX.X.ps1 -Disable -AutoReboot + + + + Disabling Device Guard and Credential Guard features will + have an impact on the overall security of the host. Please + contact your Administrator beforehand regarding this. + + + + + + + The following Guest SMP (multiprocessor) + limitations exist: + + + + + + + Poor performance with + 32-bit guests on AMD CPUs. This affects mainly Windows and + Oracle Solaris guests, but possibly also some Linux kernel + revisions. Partially solved for 32-bit Windows NT, 2000, + XP, and 2003 guests. Requires the Guest Additions to be + installed. + + + + + + Poor performance with + 32-bit guests on certain Intel CPU models that do not + include virtual APIC hardware optimization support. This + affects mainly Windows and Oracle Solaris guests, but + possibly also some Linux kernel revisions. Partially + solved for 32-bit Windows NT, 2000, XP, and 2003 guests. + Requires the Guest Additions to be installed. + + + + + + + + + NX (no execute, data execution + prevention) only works for guests running on 64-bit + hosts and requires that hardware virtualization be enabled. + + + + + + Guest control. On Windows + guests, a process started using the guest control execute + support will not be able to display a graphical user interface + unless the user account under which it is + running is currently logged in and has a desktop session. + + + + Also, to use accounts without or with an empty password, the + guest's group policy must be changed. To do so, open the group + policy editor on the command line by typing + gpedit.msc, open the key Computer + Configuration\Windows Settings\Security Settings\Local + Policies\Security Options and change the value of + Accounts: Limit local account use of blank passwords + to console logon only to Disabled. + + + + + + Compacting virtual disk images is + limited to VDI files. The VBoxManage + modifymedium --compact command is currently only + implemented for VDI files. At the moment the only way to + optimize the size of a virtual disk images in other formats, + such as VMDK or VHD, is to clone the image and then use the + cloned image in the VM configuration. + + + + + + OVF import/export: + + + + + + + OVF localization, with multiple languages in a single OVF + file, is not yet supported. + + + + + + Some OVF sections like StartupSection, + DeploymentOptionSection, and InstallSection are ignored. + + + + + + OVF environment documents, including their property + sections and appliance configuration with ISO images, are + not yet supported. + + + + + + Remote files using HTTP or other mechanisms are not yet + supported. + + + + + + + + + Neither scale mode nor + seamless mode work correctly + with guests using OpenGL 3D features, such as with + Compiz-enabled window managers. + + + + + + The RDP server in the &product-name; extension pack supports + only audio streams in format 22.05kHz stereo 16-bit. If the + RDP client requests any other audio format there will be no + audio. + + + + + + Preserving the aspect ratio in scale mode works only on + Windows hosts and on Mac OS X hosts. + + + + + + On Mac OS X hosts, the + following features are not yet implemented: + + + + + + + Numlock emulation + + + + + + CPU frequency metric + + + + + + Memory ballooning + + + + + + + + + Mac OS X guests: + + + + + + + Mac OS X guests can only run on a certain host hardware. + For details about license and host hardware limitations. + See and check the + Apple software license conditions. + + + + + + &product-name; does not provide Guest Additions for Mac OS + X at this time. + + + + + + The graphics resolution currently defaults to 1024x768 as + Mac OS X falls back to the built-in EFI display support. + See for more information on + how to change EFI video modes. + + + + + + Mac OS X guests only work with one CPU assigned to the VM. + Support for SMP will be provided in a future release. + + + + + + Depending on your system and version of Mac OS X, you + might experience guest hangs after some time. This can be + fixed by turning off energy saving. Set the timeout to + "Never" in the system preferences. + + + + + + By default, the &product-name; EFI enables debug output of + the Mac OS X kernel to help you diagnose boot problems. + Note that there is a lot of output and not all errors are + fatal. They would also show when using a physical Apple + Macintosh computer. You can turn off these messages by + using the following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal2/EfiBootArgs" " " + + + To revert to the previous behavior, use the following + command: + + +$ VBoxManage setextradata VM-name "VBoxInternal2/EfiBootArgs" "" + + + + + It is currently not possible to start a Mac OS X guest in + safe mode by specifying the option in + VBoxInternal2/EfiBootArgs extradata. + + + + + + + + + Oracle Solaris hosts: + + + + + + + USB support on Oracle Solaris hosts requires Oracle + Solaris 11 version snv_124 or later. Webcams and other + isochronous devices are known to have poor performance. + + + + + + Host Webcam passthrough is restricted to 640x480 frames at + 20 frames per second due to limitations in the Oracle + Solaris V4L2 API. This may be addressed in a future Oracle + Solaris release. + + + + + + No ACPI information, such as battery status or power + source, is reported to the guest. + + + + + + No support for using wireless adapters with bridged + networking. + + + + + + Crossbow-based bridged networking on Oracle Solaris 11 + hosts does not work directly with aggregate links. + However, you can use dladm to manually + create a VNIC over the aggregate link and use that with a + VM. This limitation does not exist in Oracle Solaris 11u1 + build 17 and later. + + + + + + + + + Neither virtio nor Intel PRO/1000 drivers for + Windows XP guests support + segmentation offloading. Therefore Windows XP guests have + slower transmission rates comparing to other guest types. + Refer to MS Knowledge base article 842264 for additional + information. + + + + + + Guest Additions for OS/2. + Seamless windows and automatic guest resizing will probably + never be implemented due to inherent limitations of the OS/2 + graphics system. + + + + + + Some guest operating systems predating ATAPI CD-ROMs may + exhibit long delays or entirely fail to boot in certain + configurations. This is most likely to happen when an + IDE/ATAPI CD-ROM exists alone on a primary or secondary IDE + channel. + + + + Affected operating systems are MS OS/2 1.21: fails to boot + with an error message referencing COUNTRY.SYS and MS OS/2 1.3: + long boot delays. To avoid such problems, disable the emulated + IDE/ATAPI CD-ROM. The guest OS cannot use this device, anyway. + + + + + + + + diff --git a/doc/manual/en_US/user_Networking.xml b/doc/manual/en_US/user_Networking.xml new file mode 100644 index 00000000..24c05596 --- /dev/null +++ b/doc/manual/en_US/user_Networking.xml @@ -0,0 +1,1562 @@ + + +%all.entities; +]> + + + Virtual Networking + + + As mentioned in , &product-name; + provides up to eight virtual PCI Ethernet cards for each virtual + machine. For each such card, you can individually select the + following: + + + + + + + The hardware that will be virtualized. + + + + + + The virtualization mode that the virtual card operates in, with + respect to your physical networking hardware on the host. + + + + + + + Four of the network cards can be configured in the + Network section of the + Settings dialog in the graphical + user interface of &product-name;. You can configure all eight + network cards on the command line using VBoxManage + modifyvm. See . + + + + This chapter explains the various networking settings in more + detail. + + + + + Virtual Networking Hardware + + + For each card, you can individually select what kind of + hardware will be presented to the virtual + machine. &product-name; can virtualize the following types of + networking hardware: + + + + + + + AMD PCNet PCI II (Am79C970A) + + + + + + AMD PCNet FAST III (Am79C973), the default setting + + + + + + Intel PRO/1000 MT Desktop (82540EM) + + + + + + Intel PRO/1000 T Server (82543GC) + + + + + + Intel PRO/1000 MT Server (82545EM) + + + + + + Paravirtualized network adapter (virtio-net) + + + + + + + The PCNet FAST III is the default because it is supported by + nearly all operating systems, as well as by the GNU GRUB boot + manager. As an exception, the Intel PRO/1000 family adapters are + chosen for some guest operating system types that no longer ship + with drivers for the PCNet card, such as Windows Vista. + + + + The Intel PRO/1000 MT Desktop type works with Windows Vista and + later versions. The T Server variant of the Intel PRO/1000 card is + recognized by Windows XP guests without additional driver + installation. The MT Server variant facilitates OVF imports from + other platforms. + + + + The Paravirtualized network adapter (virtio-net) is special. If + you select this adapter, then &product-name; does + not virtualize common networking hardware + that is supported by common guest operating systems. Instead, + &product-name; expects a special software interface for + virtualized environments to be provided by the guest, thus + avoiding the complexity of emulating networking hardware and + improving network performance. &product-name; provides support for + the industry-standard virtio networking + drivers, which are part of the open source KVM project. + + + + The virtio networking drivers are available for the following + guest operating systems: + + + + + + + Linux kernels version 2.6.25 or later can be configured to + provide virtio support. Some distributions have also + back-ported virtio to older kernels. + + + + + + For Windows 2000, XP, and Vista, virtio drivers can be + downloaded and installed from the KVM project web page: + + + + . + + + + + + + &product-name; also has limited support for jumbo + frames. These are networking packets with more than + 1500 bytes of data, provided that you use the Intel card + virtualization and bridged networking. Jumbo frames are not + supported with the AMD networking devices. In those cases, jumbo + packets will silently be dropped for both the transmit and the + receive direction. Guest operating systems trying to use this + feature will observe this as a packet loss, which may lead to + unexpected application behavior in the guest. This does not cause + problems with guest operating systems in their default + configuration, as jumbo frames need to be explicitly enabled. + + + + + + + Introduction to Networking Modes + + + Each of the networking adapters can be separately configured to + operate in one of the following modes: + + + + + + + Not attached. In this mode, + &product-name; reports to the guest that a network card is + present, but that there is no connection. This is as if no + Ethernet cable was plugged into the card. Using this mode, it + is possible to pull the virtual Ethernet + cable and disrupt the connection, which can be useful to + inform a guest operating system that no network connection is + available and enforce a reconfiguration. + + + + + + Network Address Translation + (NAT). If all you want is to browse the Web, + download files, and view email inside the guest, then this + default mode should be sufficient for you, and you can skip + the rest of this section. Please note that there are certain + limitations when using Windows file sharing. See + . + + + + + + NAT Network. A NAT network is + a type of internal network that allows outbound connections. + See . + + + + + + Bridged networking. This is + for more advanced networking needs, such as network + simulations and running servers in a guest. When enabled, + &product-name; connects to one of your installed network cards + and exchanges network packets directly, circumventing your + host operating system's network stack. + + + + + + Internal networking. This can + be used to create a different kind of software-based network + which is visible to selected virtual machines, but not to + applications running on the host or to the outside world. + + + + + + Host-only networking. This + can be used to create a network containing the host and a set + of virtual machines, without the need for the host's physical + network interface. Instead, a virtual network interface, + similar to a loopback interface, is created on the host, + providing connectivity among virtual machines and the host. + + + + + + Generic networking. Rarely + used modes which share the same generic network interface, by + allowing the user to select a driver which can be included + with &product-name; or be distributed in an extension pack. + + + + The following sub-modes are available: + + + + + + + UDP Tunnel: Used to + interconnect virtual machines running on different hosts + directly, easily, and transparently, over an existing + network infrastructure. + + + + + + VDE (Virtual Distributed Ethernet) + networking: Used to connect to a Virtual + Distributed Ethernet switch on a Linux or a FreeBSD host. + At the moment this option requires compilation of + &product-name; from sources, as the Oracle packages do not + include it. + + + + + + + + + + The following table provides an overview of the most important + networking modes. + + + + Overview of Networking Modes + + + + + + + + + + Mode + + VM→Host + + + VM←Host + + + VM1↔VM2 + + + VM→Net/LAN + + + VM←Net/LAN + + + + + + + Host-only + + + + + + + + + + + + + + + – + + + – + + + + + Internal + + + – + + + – + + + + + + + – + + + – + + + + + Bridged + + + + + + + + + + + + + + + + + + + + + + + + + NAT + + + + + + + Port forward + + + – + + + + + + + Port forward + + + + + NATservice + + + + + + + Port forward + + + + + + + + + + + Port forward + + + + +
+ + + The following sections describe the available network modes in + more detail. + + + + + + + Network Address Translation (NAT) + + + Network Address Translation (NAT) is the simplest way of accessing + an external network from a virtual machine. Usually, it does not + require any configuration on the host network and guest system. + For this reason, it is the default networking mode in + &product-name;. + + + + A virtual machine with NAT enabled acts much like a real computer + that connects to the Internet through a router. The router, in + this case, is the &product-name; networking engine, which maps + traffic from and to the virtual machine transparently. In + &product-name; this router is placed between each virtual machine + and the host. This separation maximizes security since by default + virtual machines cannot talk to each other. + + + + The disadvantage of NAT mode is that, much like a private network + behind a router, the virtual machine is invisible and unreachable + from the outside internet. You cannot run a server this way unless + you set up port forwarding. See . + + + + The network frames sent out by the guest operating system are + received by &product-name;'s NAT engine, which extracts the TCP/IP + data and resends it using the host operating system. To an + application on the host, or to another computer on the same + network as the host, it looks like the data was sent by the + &product-name; application on the host, using an IP address + belonging to the host. &product-name; listens for replies to the + packages sent, and repacks and resends them to the guest machine + on its private network. + + + + + Even though the NAT engine separates the VM from the host, the + VM has access to the host's loopback interface and the network + services running on it. The host's loopback interface is + accessible as IP address 10.0.2.2. This access to the host's + loopback interface can be extremely useful in some cases, for + example when running a web application under development in the + VM and the database server on the loopback interface on the + host. + + + + + The virtual machine receives its network address and configuration + on the private network from a DHCP server integrated into + &product-name;. The IP address thus assigned to the virtual + machine is usually on a completely different network than the + host. As more than one card of a virtual machine can be set up to + use NAT, the first card is connected to the private network + 10.0.2.0, the second card to the network 10.0.3.0 and so on. If + you need to change the guest-assigned IP range, see + . + + + + + Configuring Port Forwarding with NAT + + + As the virtual machine is connected to a private network + internal to &product-name; and invisible to the host, network + services on the guest are not accessible to the host machine or + to other computers on the same network. However, like a physical + router, &product-name; can make selected services available to + the world outside the guest through port + forwarding. This means that &product-name; listens to + certain ports on the host and resends all packets which arrive + there to the guest, on the same or a different port. + + + + To an application on the host or other physical or virtual + machines on the network, it looks as though the service being + proxied is actually running on the host. This also means that + you cannot run the same service on the same ports on the host. + However, you still gain the advantages of running the service in + a virtual machine. For example, services on the host machine or + on other virtual machines cannot be compromised or crashed by a + vulnerability or a bug in the service, and the service can run + in a different operating system than the host system. + + + + To configure port forwarding you can use the graphical + Port Forwarding editor which + can be found in the Network + Settings dialog for network adaptors configured to + use NAT. Here, you can map host ports to guest ports to allow + network traffic to be routed to a specific port in the guest. + + + + Alternatively, the command line tool + VBoxManage can be used. See + . + + + + You will need to know which ports on the guest the service uses + and to decide which ports to use on the host. You may want to + use the same ports on the guest and on the host. You can use any + ports on the host which are not already in use by a service. For + example, to set up incoming NAT connections to an + ssh server in the guest, use the following + command: + + +VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,,2222,,22" + + + In the above example, all TCP traffic arriving on port 2222 on + any host interface will be forwarded to port 22 in the guest. + The protocol name tcp is a mandatory + attribute defining which protocol should be used for forwarding, + udp could also be used. The name + guestssh is purely descriptive and will be + auto-generated if omitted. The number after + denotes the network card, as with other + VBoxManage commands. + + + + To remove this forwarding rule, use the following command: + + +VBoxManage modifyvm "VM name" --natpf1 delete "guestssh" + + + If for some reason the guest uses a static assigned IP address + not leased from the built-in DHCP server, it is required to + specify the guest IP when registering the forwarding rule, as + follows: + + +VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,,2222,10.0.2.19,22" + + + This example is identical to the previous one, except that the + NAT engine is being told that the guest can be found at the + 10.0.2.19 address. + + + + To forward all incoming traffic from a + specific host interface to the guest, specify the IP of that + host interface as follows: + + +VBoxManage modifyvm "VM name" --natpf1 "guestssh,tcp,127.0.0.1,2222,,22" + + + This example forwards all TCP traffic arriving on the localhost + interface at 127.0.0.1 through port 2222 to port 22 in the + guest. + + + + It is possible to configure incoming NAT connections while the + VM is running, see . + + + + + + + PXE Booting with NAT + + + PXE booting is now supported in NAT mode. The NAT DHCP server + provides a boot file name of the form + vmname.pxe if + the directory TFTP exists in the directory + where the user's VirtualBox.xml file is + kept. It is the responsibility of the user to provide + vmname.pxe. + + + + + + + NAT Limitations + + + There are some limitations of NAT mode which users should be + aware of, as follows: + + + + + + + ICMP protocol limitations. + Some frequently used network debugging tools, such as + ping or traceroute, + rely on the ICMP protocol for sending and receiving + messages. &product-name; ICMP support has some limitations, + meaning ping should work but some other + tools may not work reliably. + + + + + + Receiving of UDP + broadcasts. The guest does not reliably receive + UDP broadcasts. In order to save resources, it only listens + for a certain amount of time after the guest has sent UDP + data on a particular port. As a consequence, NetBios name + resolution based on broadcasts does not always work, but + WINS always works. As a workaround, you can use the numeric + IP of the desired server in the + \\server\share + notation. + + + + + + Some protocols are not + supported. Protocols other than TCP and UDP are + not supported. GRE is not supported. This means some VPN + products, such as PPTP from Microsoft, cannot be used. There + are other VPN products which use only TCP and UDP. + + + + + + Forwarding host ports below + 1024. On UNIX-based hosts, such as Linux, Oracle + Solaris, and Mac OS X, it is not possible to bind to ports + below 1024 from applications that are not run by + root. As a result, if you try to + configure such a port forwarding, the VM will refuse to + start. + + + + + + + These limitations normally do not affect standard network use. + But the presence of NAT has also subtle effects that may + interfere with protocols that are normally working. One example + is NFS, where the server is often configured to refuse + connections from non-privileged ports, which are those ports not + below 1024. + + + + + + + + + Network Address Translation Service + + + The Network Address Translation (NAT) service works in a similar + way to a home router, grouping the systems using it into a network + and preventing systems outside of this network from directly + accessing systems inside it, but letting systems inside + communicate with each other and with systems outside using TCP and + UDP over IPv4 and IPv6. + + + + A NAT service is attached to an internal network. Virtual machines + which are to make use of it should be attached to that internal + network. The name of internal network is chosen when the NAT + service is created and the internal network will be created if it + does not already exist. The following is an example command to + create a NAT network: + + +VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable + + + Here, natnet1 is the name of the internal network to be used and + 192.168.15.0/24 is the network address and mask of the NAT service + interface. By default in this static configuration the gateway + will be assigned the address 192.168.15.1, the address following + the interface address, though this is subject to change. To attach + a DHCP server to the internal network, modify the example command + as follows: + + +VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable --dhcp on + + + To add a DHCP server to an existing network, use the following + command: + + +VBoxManage natnetwork modify --netname natnet1 --dhcp on + + + To disable the DHCP server, use the following command: + + +VBoxManage natnetwork modify --netname natnet1 --dhcp off + + + A DHCP server provides a list of registered nameservers, but does + not map servers from the 127/8 network. + + + + To start the NAT service, use the following command: + + +VBoxManage natnetwork start --netname natnet1 + + + If the network has a DHCP server attached then it will start + together with the NAT network service. + + + + To stop the NAT network service, together with any DHCP server: + + +VBoxManage natnetwork stop --netname natnet1 + + + To delete the NAT network service: + + +VBoxManage natnetwork remove --netname natnet1 + + + This command does not remove the DHCP server if one is enabled on + the internal network. + + + + Port-forwarding is supported, using the + switch for IPv4 and + for IPv6. For example: + + +VBoxManage natnetwork modify \ + --netname natnet1 --port-forward-4 "ssh:tcp:[]:1022:[192.168.15.5]:22" + + + This adds a port-forwarding rule from the host's TCP 1022 port to + the port 22 on the guest with IP address 192.168.15.5. Host port, + guest port and guest IP are mandatory. To delete the rule, use the + following command: + + +VBoxManage natnetwork modify --netname natnet1 --port-forward-4 delete ssh + + + It is possible to bind a NAT service to specified interface. For + example: + + +VBoxManage setextradata global "NAT/win-nat-test-0/SourceIp4" 192.168.1.185 + + + To see the list of registered NAT networks, use the following + command: + + +VBoxManage list natnetworks + + + NAT networks can also be created, deleted, and configured using + the VirtualBox Manager. Click + File, + Preferences and select the + Network page. + + + + + Even though the NAT service separates the VM from the host, the + VM has access to the host's loopback interface and the network + services running on it. The host's loopback interface is + accessible as IP address 10.0.2.2 (assuming the default + configuration, in other configurations it's the respective + address in the configured IPv4 or IPv6 network range). This + access to the host's loopback interface can be extremely useful + in some cases, for example when running a web application under + development in the VM and the database server on the loopback + interface on the host. + + + + + + + + Bridged Networking + + + With bridged networking, &product-name; uses a device driver on + your host system that filters data from your + physical network adapter. This driver is therefore called a + net filter driver. This enables + &product-name; to intercept data from the physical network and + inject data into it, effectively creating a new network interface + in software. When a guest is using such a new software interface, + it looks to the host system as though the guest were physically + connected to the interface using a network cable. The host can + send data to the guest through that interface and receive data + from it. This means that you can set up routing or bridging + between the guest and the rest of your network. + + + + + Even though TAP interfaces are no longer necessary on Linux for + bridged networking, you can still use TAP + interfaces for certain advanced setups, since you can connect a + VM to any host interface. + + + + + To enable bridged networking, open the + Settings dialog of a virtual + machine, go to the Network page + and select Bridged Network in the + drop-down list for the Attached + To field. Select a host interface from the list at the + bottom of the page, which contains the physical network interfaces + of your systems. On a typical MacBook, for example, this will + allow you to select between en1: AirPort, which is the wireless + interface, and en0: Ethernet, which represents the interface with + a network cable. + + + + + Bridging to a wireless interface is done differently from + bridging to a wired interface, because most wireless adapters do + not support promiscuous mode. All traffic has to use the MAC + address of the host's wireless adapter, and therefore + &product-name; needs to replace the source MAC address in the + Ethernet header of an outgoing packet to make sure the reply + will be sent to the host interface. When &product-name; sees an + incoming packet with a destination IP address that belongs to + one of the virtual machine adapters it replaces the destination + MAC address in the Ethernet header with the VM adapter's MAC + address and passes it on. &product-name; examines ARP and DHCP + packets in order to learn the IP addresses of virtual machines. + + + + + Depending on your host operating system, the following limitations + apply: + + + + + + + Mac OS X hosts. Functionality + is limited when using AirPort, the Mac's wireless networking + system, for bridged networking. Currently, &product-name; + supports only IPv4 and IPv6 over AirPort. For other protocols, + such as IPX, you must choose a wired interface. + + + + + + Linux hosts. Functionality is + limited when using wireless interfaces for bridged networking. + Currently, &product-name; supports only IPv4 and IPv6 over + wireless. For other protocols, such as IPX, you must choose a + wired interface. + + + + Also, setting the MTU to less than 1500 bytes on wired + interfaces provided by the sky2 driver on the Marvell Yukon II + EC Ultra Ethernet NIC is known to cause packet losses under + certain conditions. + + + + Some adapters strip VLAN tags in hardware. This does not allow + you to use VLAN trunking between VM and the external network + with pre-2.6.27 Linux kernels, or with host operating systems + other than Linux. + + + + + + Oracle Solaris hosts. There + is no support for using wireless interfaces. Filtering guest + traffic using IPFilter is also not completely supported due to + technical restrictions of the Oracle Solaris networking + subsystem. These issues may be addressed in later releases of + Oracle Solaris 11. + + + + On Oracle Solaris 11 hosts build 159 and above, it is possible + to use Oracle Solaris Crossbow Virtual Network Interfaces + (VNICs) directly with &product-name; without any additional + configuration other than each VNIC must be exclusive for every + guest network interface. + + + + When using VLAN interfaces with &product-name;, they must be + named according to the PPA-hack naming scheme, such as + e1000g513001. Otherwise, the guest may receive packets in an + unexpected format. + + + + + + + + + + Internal Networking + + + Internal Networking is similar to bridged networking in that the + VM can directly communicate with the outside world. However, the + outside world is limited to other VMs on the same host which + connect to the same internal network. + + + + Even though technically, everything that can be done using + internal networking can also be done using bridged networking, + there are security advantages with internal networking. In bridged + networking mode, all traffic goes through a physical interface of + the host system. It is therefore possible to attach a packet + sniffer such as Wireshark to the host interface and log all + traffic that goes over it. If, for any reason, you prefer two or + more VMs on the same machine to communicate privately, hiding + their data from both the host system and the user, bridged + networking therefore is not an option. + + + + Internal networks are created automatically as needed. There is no + central configuration. Every internal network is identified simply + by its name. Once there is more than one active virtual network + card with the same internal network ID, the &product-name; support + driver will automatically wire the cards and + act as a network switch. The &product-name; support driver + implements a complete Ethernet switch and supports both + broadcast/multicast frames and promiscuous mode. + + + + In order to attach a VM's network card to an internal network, set + its networking mode to Internal Networking. There are two ways to + accomplish this: + + + + + + + Use the VM's Settings dialog + in the VirtualBox Manager. In the + Network category of the + settings dialog, select Internal + Network from the drop-down list of networking + modes. Select the name of an existing internal network from + the drop-down list below, or enter a new name into the + Name field. + + + + + + Use the command line, for example: + + +VBoxManage modifyvm "VM name" --nic<x> intnet + + + Optionally, you can specify a network name with the command: + + +VBoxManage modifyvm "VM name" --intnet<x> "network name" + + + If you do not specify a network name, the network card will be + attached to the network intnet by default. + + + + + + + Unless you configure the virtual network cards in the guest + operating systems that are participating in the internal network + to use static IP addresses, you may want to use the DHCP server + that is built into &product-name; to manage IP addresses for the + internal network. See . + + + + As a security measure, by default, the Linux implementation of + internal networking only allows VMs running under the same user ID + to establish an internal network. However, it is possible to + create a shared internal networking interface, accessible by users + with different user IDs. + + + + + + + Host-Only Networking + + + Host-only networking can be thought of as a hybrid between the + bridged and internal networking modes. As with bridged networking, + the virtual machines can talk to each other and the host as if + they were connected through a physical Ethernet switch. As with + internal networking, a physical networking interface need not be + present, and the virtual machines cannot talk to the world outside + the host since they are not connected to a physical networking + interface. + + + + When host-only networking is used, &product-name; creates a new + software interface on the host which then appears next to your + existing network interfaces. In other words, whereas with bridged + networking an existing physical interface is used to attach + virtual machines to, with host-only networking a new + loopback interface is created on the host. + And whereas with internal networking, the traffic between the + virtual machines cannot be seen, the traffic on the loopback + interface on the host can be intercepted. + + + + Host-only networking is particularly useful for preconfigured + virtual appliances, where multiple virtual machines are shipped + together and designed to cooperate. For example, one virtual + machine may contain a web server and a second one a database, and + since they are intended to talk to each other, the appliance can + instruct &product-name; to set up a host-only network for the two. + A second, bridged, network would then connect the web server to + the outside world to serve data to, but the outside world cannot + connect to the database. + + + + To enable a host-only network interface for a virtual machine, do + either of the following: + + + + + + + Go to the Network page in the + virtual machine's Settings + dialog and select an Adapter + tab. Ensure that the Enable Network + Adapter check box is selected and choose + Host-Only Adapter for the + Attached To field. + + + + + + On the command line, use VBoxManage modifyvm + "vmname + --nicx hostonly. See + . + + + + + + + For host-only networking, as with internal networking, you may + find the DHCP server useful that is built into &product-name;. + This is enabled by default and manages the IP addresses in the + host-only network. Without the DHCP server you would need to + configure all IP addresses statically. + + + + + + + In the VirtualBox Manager you can configure the DHCP server by + choosing File, + Host Network Manager. The + Host Network Manager lists all host-only networks which are + presently in use. Select the network name and then use the + DHCP Server tab to configure + DHCP server settings. + + + + + + Alternatively, you can use the VBoxManage + dhcpserver command. See + . + + + + + + + + On Linux and Mac OS X hosts the number of host-only interfaces + is limited to 128. There is no such limit for Oracle Solaris and + Windows hosts. + + + + + + + + UDP Tunnel Networking + + + This networking mode enables you to interconnect virtual machines + running on different hosts. + + + + Technically this is done by encapsulating Ethernet frames sent or + received by the guest network card into UDP/IP datagrams, and + sending them over any network available to the host. + + + + UDP Tunnel mode has the following parameters: + + + + + + + Source UDP port: The port on + which the host listens. Datagrams arriving on this port from + any source address will be forwarded to the receiving part of + the guest network card. + + + + + + Destination address: IP + address of the target host of the transmitted data. + + + + + + Destination UDP port: Port + number to which the transmitted data is sent. + + + + + + + When interconnecting two virtual machines on two different hosts, + their IP addresses must be swapped. On a single host, source and + destination UDP ports must be swapped. + + + + In the following example, host 1 uses the IP address 10.0.0.1 and + host 2 uses IP address 10.0.0.2. To configure using the + command-line: + + + VBoxManage modifyvm "VM 01 on host 1" --nic<x> generic + VBoxManage modifyvm "VM 01 on host 1" --nicgenericdrv<x> UDPTunnel + VBoxManage modifyvm "VM 01 on host 1" --nicproperty<x> dest=10.0.0.2 + VBoxManage modifyvm "VM 01 on host 1" --nicproperty<x> sport=10001 + VBoxManage modifyvm "VM 01 on host 1" --nicproperty<x> dport=10002 + + VBoxManage modifyvm "VM 02 on host 2" --nic<y> generic + VBoxManage modifyvm "VM 02 on host 2" --nicgenericdrv<y> UDPTunnel + VBoxManage modifyvm "VM 02 on host 2" --nicproperty<y> dest=10.0.0.1 + VBoxManage modifyvm "VM 02 on host 2" --nicproperty<y> sport=10002 + VBoxManage modifyvm "VM 02 on host 2" --nicproperty<y> dport=10001 + + + Of course, you can always interconnect two virtual machines on the + same host, by setting the destination address parameter to + 127.0.0.1 on both. It will act similarly to an internal network in + this case. However, the host can see the network traffic which it + could not in the normal internal network case. + + + + + On UNIX-based hosts, such as Linux, Oracle Solaris, and Mac OS + X, it is not possible to bind to ports below 1024 from + applications that are not run by root. As a + result, if you try to configure such a source UDP port, the VM + will refuse to start. + + + + + + + + VDE Networking + + + Virtual Distributed Ethernet (VDE) is a flexible, virtual network + infrastructure system, spanning across multiple hosts in a secure + way. It enables L2/L3 switching, including spanning-tree protocol, + VLANs, and WAN emulation. It is an optional part of &product-name; + which is only included in the source code. + + + + VDE is a project developed by Renzo Davoli, Associate Professor at + the University of Bologna, Italy. + + + + The basic building blocks of the infrastructure are VDE switches, + VDE plugs, and VDE wires which interconnect the switches. + + + + The &product-name; VDE driver has a single parameter: VDE network. + This is the name of the VDE network switch socket to which the VM + will be connected. + + + + The following basic example shows how to connect a virtual machine + to a VDE switch. + + + + + + + Create a VDE switch: + + +vde_switch -s /tmp/switch1 + + + + + Configure VMs using the command-line: + + +VBoxManage modifyvm "VM name" --nic<x> generic + +VBoxManage modifyvm "VM name" --nicgenericdrv<x> VDE + + + To connect to an automatically allocated switch port: + + +VBoxManage modifyvm "VM name" --nicproperty<x> network=/tmp/switch1 + + + To connect to a specific switch port + n: + + +VBoxManage modifyvm "VM name" --nicproperty<x> network=/tmp/switch1[<n>] + + + This command can be useful for VLANs. + + + + + + (Optional) Map between a VDE switch port and a VLAN. + + + + Using the switch command line: + + +vde$ vlan/create <VLAN> + +vde$ port/setvlan <port> <VLAN> + + + + + + VDE is available on Linux and FreeBSD hosts only. It is only + available if the VDE software and the VDE plugin library from the + VirtualSquare project are installed on the host system. + + + + + For Linux hosts, the shared library libvdeplug.so must be + available in the search path for shared libraries. + + + + + For more information on setting up VDE networks, please see the + documentation accompanying the software. See also + . + + + + + + + Limiting Bandwidth for Network Input/Output + + + &product-name; supports limiting of the maximum bandwidth used for + network transmission. Several network adapters of one VM may share + limits through bandwidth groups. It is possible to have more than + one such limit. + + + + + &product-name; shapes VM traffic only in the transmit direction, + delaying the packets being sent by virtual machines. It does not + limit the traffic being received by virtual machines. + + + + + Limits are configured through VBoxManage. The + following example creates a bandwidth group named Limit, sets the + limit to 20 Mbps and assigns the group to the first and second + adapters of the VM: + + +VBoxManage bandwidthctl "VM name" add Limit --type network --limit 20m +VBoxManage modifyvm "VM name" --nicbandwidthgroup1 Limit +VBoxManage modifyvm "VM name" --nicbandwidthgroup2 Limit + + + All adapters in a group share the bandwidth limit, meaning that in + the example above the bandwidth of both adapters combined can + never exceed 20 Mbps. However, if one adapter does not require + bandwidth the other can use the remaining bandwidth of its group. + + + + The limits for each group can be changed while the VM is running, + with changes being picked up immediately. The following example + changes the limit for the group created in the previous example to + 100 Kbps: + + +VBoxManage bandwidthctl "VM name" set Limit --limit 100k + + + To completely disable shaping for the first adapter of VM use the + following command: + + +VBoxManage modifyvm "VM name" --nicbandwidthgroup1 none + + + It is also possible to disable shaping for all adapters assigned + to a bandwidth group while VM is running, by specifying the zero + limit for the group. For example, for the bandwidth group named + Limit: + + +VBoxManage bandwidthctl "VM name" set Limit --limit 0 + + + + + + Improving Network Performance + + + &product-name; provides a variety of virtual network adapters that + can be attached to the host's network in a number of ways. + Depending on which types of adapters and attachments are used the + network performance will be different. Performance-wise the virtio + network adapter is preferable over Intel PRO/1000 emulated + adapters, which are preferred over the PCNet family of adapters. + Both virtio and Intel PRO/1000 adapters enjoy the benefit of + segmentation and checksum offloading. Segmentation offloading is + essential for high performance as it allows for less context + switches, dramatically increasing the sizes of packets that cross + the VM/host boundary. + + + + + Neither virtio nor Intel PRO/1000 drivers for Windows XP support + segmentation offloading. Therefore Windows XP guests never reach + the same transmission rates as other guest types. Refer to MS + Knowledge base article 842264 for additional information. + + + + + Three attachment types: Internal, Bridged, and Host-Only, have + nearly identical performance. The Internal type is a little bit + faster and uses less CPU cycles as the packets never reach the + host's network stack. The NAT attachment type is the slowest and + most secure of all attachment types, as it provides network + address translation. The generic driver attachment is special and + cannot be considered as an alternative to other attachment types. + + + + The number of CPUs assigned to VM does not improve network + performance and in some cases may hurt it due to increased + concurrency in the guest. + + + + Here is a short summary of things to check in order to improve + network performance: + + + + + + + Whenever possible use the virtio network adapter. Otherwise, + use one of the Intel PRO/1000 adapters. + + + + + + Use a Bridged attachment instead of NAT. + + + + + + Make sure segmentation offloading is enabled in the guest OS. + Usually it will be enabled by default. You can check and + modify offloading settings using the + ethtool command on Linux guests. + + + + + + Perform a full detailed analysis of network traffic on the + VM's network adaptor using a third party tool such as + Wireshark. To do this, a promiscuous mode policy needs to be + used on the VM's network adaptor. Use of this mode is only + possible on the following network types: NAT Network, Bridged + Adapter, Internal Network, and Host-Only Adapter. + + + + To setup a promiscuous mode policy, either select from the + drop down list located in the Network + Settings dialog for the network adaptor or use the + command line tool VBoxManage. See + . + + + + Promiscuous mode policies are as follows: + + + + + + + deny, which hides any traffic not + intended for the VM's network adaptor. This is the default + setting. + + + + + + allow-vms, which hides all host traffic + from the VM's network adaptor, but allows it to see + traffic from and to other VMs. + + + + + + allow-all, which removes all + restrictions. The VM's network adaptor sees all traffic. + + + + + + + + + + + diff --git a/doc/manual/en_US/user_Preface.xml b/doc/manual/en_US/user_Preface.xml new file mode 100644 index 00000000..8f21579c --- /dev/null +++ b/doc/manual/en_US/user_Preface.xml @@ -0,0 +1,93 @@ + + + %all.entities; +]> + + + Preface + + + The &product-name; User Manual provides an + introduction to using &product-name;. The manual provides + information on how to install &product-name; and use it to create + and configure virtual machines. + + + + + Audience + + + This document is intended for both new and existing users of + &product-name;. It is assumed that readers are familiar with Web + technologies and have a general understanding of Windows and UNIX + platforms. + + + + + + + Related Documents + + + The documentation for this product is available at: + + + + + + + + + + + Conventions + + + The following text conventions are used in this document: + + + + + + + boldface: Boldface type + indicates graphical user interface elements associated with an + action, or terms defined in text or the glossary. + + + + + + italic: Italic type indicates book + titles, emphasis, or placeholder variables for which you + supply particular values. + + + + + + monospace: Monospace type indicates + commands within a paragraph, URLs, code in examples, text that + appears on the screen, or text that you enter. + + + + + + + + + + + + + + diff --git a/doc/manual/en_US/user_PrivacyPolicy.xml b/doc/manual/en_US/user_PrivacyPolicy.xml new file mode 100644 index 00000000..8e165edb --- /dev/null +++ b/doc/manual/en_US/user_PrivacyPolicy.xml @@ -0,0 +1,93 @@ + + +%all.entities; +]> + + + &product-name; Privacy Information + + + Version 5, Dec 13, 2012 + + + + The Oracle Privacy Policies posted on + + apply to your personal data collected and used by Oracle. The + following privacy information describes in more detail which + information is exchanged between the &product-name; application and + Oracle, and which information is collected by the virtualbox.org + website. + + + + § 1 virtualbox.org. The + "virtualbox.org" website logs anonymous usage information such as + your IP address, geographical location, browser type, referral + source, length of visit and number of page views while you visit + (collectively, "anonymous data"). In addition, but only if you + choose to register, the website's bug tracking and forum services + store the data you choose to reveal upon registration, such as your + user name and contact information. + + + + § 2 Cookies. The virtualbox.org + website, the bug tracker and the forum services use cookies to + identify and track the visiting web browser and, if you have + registered, to facilitate login. Most browsers allow you to refuse + to accept cookies. While you can still visit the website with + cookies disabled, logging into the bug tracker and forum services + will most likely not work without them. + + + + § 3 &product-name; registration + process. The &product-name; application may ask that the + user optionally register with Oracle. If you choose to register, + your name, e-mail address, country and company will be submitted to + Oracle and stored together with the IP address of the submitter as + well as product version and platform being used. + + + + § 4 Update notifications. The + &product-name; application may contact Oracle to find out whether a + new version of &product-name; has been released and notify the user + if that is the case. In the process, anonymous data such as your IP + address and a non-identifying counter, together with the product + version and the platform being used, is sent so that the server can + find out whether an update is available. By default, this check is + performed once a day. You change this interval or disable these + checks altogether in the &product-name; preferences. + + + + § 5 Usage of personal information. + Oracle may use anonymous and personal data collected by the means + above for statistical purposes as well as to automatically inform + you about new notices related to your posts on the bug tracker and + forum services, to administer the website and to contact you due to + technical issues. Oracle may also inform you about new product + releases related to &product-name;. + + + + In no event will personal data without your express consent be + provided to any third parties, unless Oracle may be required to do + so by law or in connection with legal proceedings. + + + + § 6 Updates. Oracle may update the + privacy policy at any time by posting a new version at + + and the privacy information will be kept up to date in the + documentation which comes with the &product-name; application. You + should check these places occasionally to ensure you are happy with + any changes. + + + diff --git a/doc/manual/en_US/user_Security.xml b/doc/manual/en_US/user_Security.xml new file mode 100644 index 00000000..e0387e9e --- /dev/null +++ b/doc/manual/en_US/user_Security.xml @@ -0,0 +1,729 @@ + + +%all.entities; +]> + + + Security Guide + + + + General Security Principles + + + The following principles are fundamental to using any application + securely. + + + + + + + Keep software up to date. One + of the principles of good security practise is to keep all + software versions and patches up to date. Activate the + &product-name; update notification to get notified when a new + &product-name; release is available. When updating + &product-name;, do not forget to update the Guest Additions. + Keep the host operating system as well as the guest operating + system up to date. + + + + + + Restrict network access to critical + services. Use proper means, for instance a + firewall, to protect your computer and your guests from + accesses from the outside. Choosing the proper networking mode + for VMs helps to separate host networking from the guest and + vice versa. + + + + + + Follow the principle of least + privilege. The principle of least privilege states + that users should be given the least amount of privilege + necessary to perform their jobs. Always execute &product-name; + as a regular user. We strongly discourage anyone from + executing &product-name; with system privileges. + + + + Choose restrictive permissions when creating configuration + files, for instance when creating /etc/default/virtualbox, see + . Mode 0600 is preferred. + + + + + + Monitor system activity. + System security builds on three pillars: good security + protocols, proper system configuration and system monitoring. + Auditing and reviewing audit records address the third + requirement. Each component within a system has some degree of + monitoring capability. Follow audit advice in this document + and regularly monitor audit records. + + + + + + Keep up to date on latest security + information. Oracle continually improves its + software and documentation. Check this note yearly for + revisions. + + + + + + + + + + Secure Installation and Configuration + + + + Installation Overview + + + The &product-name; base package should be downloaded only from a + trusted source, for instance the official website + . The integrity of the + package should be verified with the provided SHA256 checksum + which can be found on the official website. + + + + General &product-name; installation instructions for the + supported hosts can be found in . + + + + On Windows hosts, the installer can be used to disable USB + support, support for bridged networking, support for host-only + networking and the Python language binding. See + . All these features are + enabled by default but disabling some of them could be + appropriate if the corresponding functionality is not required + by any virtual machine. The Python language bindings are only + required if the &product-name; API is to be used by external + Python applications. In particular USB support and support for + the two networking modes require the installation of Windows + kernel drivers on the host. Therefore disabling those selected + features can not only be used to restrict the user to certain + functionality but also to minimize the surface provided to a + potential attacker. + + + + The general case is to install the complete &product-name; + package. The installation must be done with system privileges. + All &product-name; binaries should be executed as a regular user + and never as a privileged user. + + + + The &product-name; Extension Pack provides additional features + and must be downloaded and installed separately, see + . As for the base package, the + SHA256 checksum of the extension pack should be verified. As the + installation requires system privileges, &product-name; will ask + for the system password during the installation of the extension + pack. + + + + + + + Post Installation Configuration + + + Normally there is no post installation configuration of + &product-name; components required. However, on Oracle Solaris + and Linux hosts it is necessary to configure the proper + permissions for users executing VMs and who should be able to + access certain host resources. For instance, Linux users must be + member of the vboxusers group to be able to + pass USB devices to a guest. If a serial host interface should + be accessed from a VM, the proper permissions must be granted to + the user to be able to access that device. The same applies to + other resources like raw partitions, DVD/CD drives, and sound + devices. + + + + + + + + + Security Features + + + This section outlines the specific security mechanisms offered by + &product-name;. + + + + + The Security Model + + + One property of virtual machine monitors (VMMs) like + &product-name; is to encapsulate a guest by executing it in a + protected environment, a virtual machine, running as a user + process on the host operating system. The guest cannot + communicate directly with the hardware or other computers but + only through the VMM. The VMM provides emulated physical + resources and devices to the guest which are accessed by the + guest operating system to perform the required tasks. The VM + settings control the resources provided to the guest, for + example the amount of guest memory or the number of guest + processors and the enabled features for that guest. For example + remote control, certain screen settings and others. See + . + + + + + + + Secure Configuration of Virtual Machines + + + Several aspects of a virtual machine configuration are subject + to security considerations. + + + + + Networking + + + The default networking mode for VMs is NAT which means that + the VM acts like a computer behind a router, see + . The guest is part of a private + subnet belonging to this VM and the guest IP is not visible + from the outside. This networking mode works without any + additional setup and is sufficient for many purposes. Keep in + mind that NAT allows access to the host operating system's + loopback interface. + + + + If bridged networking is used, the VM acts like a computer + inside the same network as the host, see + . In this case, the guest has + the same network access as the host and a firewall might be + necessary to protect other computers on the subnet from a + potential malicious guest as well as to protect the guest from + a direct access from other computers. In some cases it is + worth considering using a forwarding rule for a specific port + in NAT mode instead of using bridged networking. + + + + Some setups do not require a VM to be connected to the public + network at all. Internal networking, see + , or host-only networking, + see , are often sufficient + to connect VMs among each other or to connect VMs only with + the host but not with the public network. + + + + + + + VRDP Remote Desktop Authentication + + + When using the &product-name; Extension Pack provided by + Oracle for VRDP remote desktop support, you can optionally use + various methods to configure RDP authentication. The "null" + method is very insecure and should be avoided in a public + network. See . + + + + + + + Clipboard + + + The shared clipboard enables users to share data between the + host and the guest. Enabling the clipboard in Bidirectional + mode enables the guest to read and write the host clipboard. + The Host to Guest mode and the Guest to Host mode limit the + access to one direction. If the guest is able to access the + host clipboard it can also potentially access sensitive data + from the host which is shared over the clipboard. + + + + If the guest is able to read from and/or write to the host + clipboard then a remote user connecting to the guest over the + network will also gain this ability, which may not be + desirable. As a consequence, the shared clipboard is disabled + for new machines. + + + + + + + Shared Folders + + + If any host folder is shared with the guest then a remote user + connected to the guest over the network can access these files + too as the folder sharing mechanism cannot be selectively + disabled for remote users. + + + + + + + 3D Graphics Acceleration + + + Enabling 3D graphics using the Guest Additions exposes the + host to additional security risks. See + . + + + + + + + CD/DVD Passthrough + + + Enabling CD/DVD passthrough enables the guest to perform + advanced operations on the CD/DVD drive, see + . This could induce a security + risk as a guest could overwrite data on a CD/DVD medium. + + + + + + + USB Passthrough + + + Passing USB devices to the guest provides the guest full + access to these devices, see . + For instance, in addition to reading and writing the content + of the partitions of an external USB disk the guest will be + also able to read and write the partition table and hardware + data of that disk. + + + + + + + + + Configuring and Using Authentication + + + The following components of &product-name; can use passwords for + authentication: + + + + + + + When using remote iSCSI storage and the storage server + requires authentication, an initiator secret can optionally + be supplied with the VBoxManage + storageattach command. As long as no settings + password is provided, by using the command line option + , then this secret is + stored unencrypted in the machine + configuration and is therefore potentially readable on the + host. See and + . + + + + + + When using the &product-name; web service to control an + &product-name; host remotely, connections to the web service + are authenticated in various ways. This is described in + detail in the &product-name; Software Development Kit (SDK) + reference. See . + + + + + + + + + + + + Potentially Insecure Operations + + + The following features of &product-name; can present security + problems: + + + + + + + Enabling 3D graphics using the Guest Additions exposes the + host to additional security risks. See + . + + + + + + When teleporting a machine, the data stream through which + the machine's memory contents are transferred from one host + to another is not encrypted. A third party with access to + the network through which the data is transferred could + therefore intercept that data. An SSH tunnel could be used + to secure the connection between the two hosts. But when + considering teleporting a VM over an untrusted network the + first question to answer is how both VMs can securely access + the same virtual disk image with a reasonable performance. + + + + + + When Page Fusion, see , + is enabled, it is possible that a side-channel opens up that + enables a malicious guest to determine the address space of + another VM running on the same host layout. For example, + where DLLs are typically loaded. This information leak in + itself is harmless, however the malicious guest may use it + to optimize attack against that VM through unrelated attack + vectors. It is recommended to only enable Page Fusion if you + do not think this is a concern in your setup. + + + + + + When using the &product-name; web service to control an + &product-name; host remotely, connections to the web + service, over which the API calls are transferred using SOAP + XML, are not encrypted. They use plain HTTP by default. This + is a potential security risk. For details about the web + service, see . + + + + The web services are not started by default. See + to find out how to start + this service and how to enable SSL/TLS support. It has to be + started as a regular user and only the VMs of that user can + be controlled. By default, the service binds to localhost + preventing any remote connection. + + + + + + Traffic sent over a UDP Tunnel network attachment is not + encrypted. You can either encrypt it on the host network + level, with IPsec, or use encrypted protocols in the guest + network, such as SSH. The security properties are similar to + bridged Ethernet. + + + + + + Because of shortcomings in older Windows versions, using + &product-name; on Windows versions older than Vista with + Service Pack 1 is not recommended. + + + + + + + + + + Encryption + + + The following components of &product-name; use encryption to + protect sensitive data: + + + + + + + When using the &product-name; Extension Pack provided by + Oracle for VRDP remote desktop support, RDP data can + optionally be encrypted. See . + Only the Enhanced RDP Security method (RDP5.2) with TLS + protocol provides a secure connection. Standard RDP Security + (RDP4 and RDP5.1) is vulnerable to a man-in-the-middle + attack. + + + + + + When using the &product-name; Extension Pack provided by + Oracle for disk encryption, the data stored in disk images + can optionally be encrypted. See + . This feature covers disk + image content only. All other data for a virtual machine is + stored unencrypted, including the VM's memory and device + state which is stored as part of a saved state, both when + created explicitly or part of a snapshot of a running VM. + + + + + + + + + + + + + + Security Recommendations + + + This section contains security recommendations for specific + issues. By default VirtualBox will configure the VMs to run in a + secure manner, however this may not always be possible without + additional user actions such as host OS or firmware configuration + changes. + + + + + CVE-2018-3646 + + + This security issue affect a range of Intel CPUs with nested + paging. AMD CPUs are expected not to be impacted (pending direct + confirmation by AMD). Also the issue does not affect VMs running + with hardware virtualization disabled or with nested paging + disabled. + + + + For more information about nested paging, see + . + + + + The following mitigation options are available. + + + + + Disable Nested Paging + + + By disabling nested paging (EPT), the VMM will construct page + tables shadowing the ones in the guest. It is no possible for + the guest to insert anything fishy into the page tables, since + the VMM carefully validates each entry before shadowing it. + + + + As a side effect of disabling nested paging, several CPU + features will not be made available to the guest. Among these + features are AVX, AVX2, XSAVE, AESNI, and POPCNT. Not all + guests may be able to cope with dropping these features after + installation. Also, for some guests, especially in SMP + configurations, there could be stability issues arising from + disabling nested paging. Finally, some workloads may + experience a performance degradation. + + + + + + + Flushing the Level 1 Data Cache + + + This aims at removing potentially sensitive data from the + level 1 data cache when running guest code. However, it is + made difficult by hyper-threading setups sharing the level 1 + cache and thereby potentially letting the other thread in a + pair refill the cache with data the user does not want the + guest to see. In addition, flushing the level 1 data cache is + usually not without performance side effects. + + + + Up to date CPU microcode is a prerequisite for the cache + flushing mitigations. Some host OSes may install these + automatically, though it has traditionally been a task best + performed by the system firmware. So, please check with your + system / mainboard manufacturer for the latest firmware + update. + + + + We recommend disabling hyper threading on the host. This is + traditionally done from the firmware setup, but some OSes also + offers ways disable HT. In some cases it may be disabled by + default, but please verify as the effectiveness of the + mitigation depends on it. + + + + The default action taken by VirtualBox is to flush the level 1 + data cache when a thread is scheduled to execute guest code, + rather than on each VM entry. This reduces the performance + impact, while making the assumption that the host OS will not + handle security sensitive data from interrupt handlers and + similar without taking precautions. + + + + A more aggressive flushing option is provided via the + VBoxManage modifyvm + option. When enabled + the level 1 data cache will be flushed on every VM entry. The + performance impact is greater than with the default option, + though this of course depends on the workload. Workloads + producing a lot of VM exits (like networking, VGA access, and + similiar) will probably be most impacted. + + + + For users not concerned by this security issue, the default + mitigation can be disabled using the VBoxManage + modifyvm name --l1d-flush-on-sched off command. + + + + + + + + + CVE-2018-12126, CVE-2018-12127, CVE-2018-12130, CVE-2019-11091 + + + These security issues affect a range of Intel CPUs starting with + Nehalem. The CVE-2018-12130 also affects some Atom Silvermont, + Atom Airmont, and Knights family CPUs, however the scope is so + limited that the host OS should deal with it and &product-name; + is therefore not affected. Leaks only happens when entering and + leaving C states. + + + + The following mitigation option is available. + + + + + Buffer Overwriting and Disabling Hyper-Threading + + + First, up to date CPU microcode is a prerequisite for the + buffer overwriting (clearing) mitigations. Some host OSes may + install these automatically, though it has traditionally been + a task best performed by the system firmware. Please check + with your system or mainboard manufacturer for the latest + firmware update. + + + + This mitigation aims at removing potentially sensitive data + from the affected buffers before running guest code. Since + this means additional work each time the guest is scheduled, + there might be some performance side effects. + + + + We recommend disabling hyper-threading (HT) on hosts affected + by CVE-2018-12126 and CVE-2018-12127, because the affected + sets of buffers are normally shared between thread pairs and + therefore cause leaks between the threads. This is + traditionally done from the firmware setup, but some OSes also + offers ways disable HT. In some cases it may be disabled by + default, but please verify as the effectiveness of the + mitigation depends on it. + + + + The default action taken by &product-name; is to clear the + affected buffers when a thread is scheduled to execute guest + code, rather than on each VM entry. This reduces the + performance impact, while making the assumption that the host + OS will not handle security sensitive data from interrupt + handlers and similar without taking precautions. + + + + The VBoxManage modifyvm command provides a + more aggressive flushing option is provided by means of the + option. When enabled + the affected buffers will be cleared on every VM entry. The + performance impact is greater than with the default option, + though this of course depends on the workload. Workloads + producing a lot of VM exits (like networking, VGA access, and + similiar) will probably be most impacted. + + + + For users not concerned by this security issue, the default + mitigation can be disabled using the VBoxManage + modifyvm name --mds-clear-on-sched off command. + + + + + + + + + diff --git a/doc/manual/en_US/user_Storage.xml b/doc/manual/en_US/user_Storage.xml new file mode 100644 index 00000000..56f28d14 --- /dev/null +++ b/doc/manual/en_US/user_Storage.xml @@ -0,0 +1,1800 @@ + + +%all.entities; +]> + + + Virtual Storage + + + As the virtual machine will most probably expect to see a hard disk + built into its virtual computer, &product-name; must be able to + present real storage to the guest as a virtual hard disk. There are + presently three methods by which to achieve this: + + + + + + + &product-name; can use large image files on a real hard disk and + present them to a guest as a virtual hard disk. This is the most + common method, described in . + + + + + + iSCSI storage servers can be attached to &product-name;. This is + described in . + + + + + + You can allow a virtual machine to access one of your host disks + directly. This is an advanced feature, described in + . + + + + + + + Each such virtual storage device, such as an image file, iSCSI + target, or physical hard disk, needs to be connected to the virtual + hard disk controller that &product-name; presents to a virtual + machine. This is explained in the next section. + + + + + Hard Disk Controllers + + + In a computing device, hard disks and CD/DVD drives are connected + to a device called a hard disk controller, which drives hard disk + operation and data transfers. &product-name; can emulate the most + common types of hard disk controllers typically found in computing + devices: IDE, SATA (AHCI), SCSI, SAS, USB-based, NVMe and + virtio-scsi mass storage devices. + + + + + + + IDE (ATA) controllers are a + backwards-compatible yet very advanced extension of the disk + controller in the IBM PC/AT (1984). Initially, this interface + worked only with hard disks, but was later extended to also + support CD-ROM drives and other types of removable media. In + physical PCs, this standard uses flat ribbon parallel cables + with 40 or 80 wires. Each such cable can connect two devices, + called device 0 and device 1, to a controller. Typical PCs had + two connectors for such cables. As a result, support for up to + four IDE devices was most common: primary device 0, primary + device 1, secondary device 0, and secondary device 1. + + + + In &product-name;, each virtual machine may have one IDE + controller enabled, which gives you up to four virtual storage + devices that you can attach to the machine. By default, one of + these virtual storage devices, device 0 on the secondary + channel, is preconfigured to be the virtual machine's virtual + CD/DVD drive. However, you can change the default setting. + + + + Even if your guest OS has no support for SCSI or SATA devices, + it should always be able to see an IDE controller. + + + + You can also select which exact type of IDE controller + hardware &product-name; should present to the virtual machine: + PIIX3, PIIX4, or ICH6. This makes no difference in terms of + performance, but if you import a virtual machine from another + virtualization product, the OS in that machine may expect a + particular controller type and crash if it is not found. + + + + After you have created a new virtual machine with the + New Virtual Machine wizard of + the VirtualBox Manager, you will typically see one IDE + controller in the machine's + Storage settings. The virtual + CD/DVD drive will be attached to one of the four ports of this + controller. + + + + + + Serial ATA (SATA) is a more + recent standard than IDE. Compared to IDE, it supports both + much higher speeds and more devices per controller. Also, with + physical hardware, devices can be added and removed while the + system is running. The standard interface for SATA controllers + is called Advanced Host Controller Interface (AHCI). + + + + Like a real SATA controller, &product-name;'s virtual SATA + controller operates faster and also consumes fewer CPU + resources than the virtual IDE controller. Also, this enables + you to connect up to 30 virtual hard disks to one machine + instead of just three, when compared to the &product-name; IDE + controller with a DVD drive attached. + + + + For this reason, depending on the selected guest OS, + &product-name; uses SATA as the default for newly created + virtual machines. One virtual SATA controller is created by + default, and the default disk that is created with a new VM is + attached to this controller. + + + + + The entire SATA controller and the virtual disks attached to + it, including those in IDE compatibility mode, will not be + seen by OSes that do not have device support for AHCI. In + particular, there is no support for AHCI in + Windows versions before Windows Vista. Legacy + Windows versions such as Windows XP, even with SP3 + installed, will not see such disks unless you install + additional drivers. It is possible to switch from IDE to + SATA after installation by installing the SATA drivers and + changing the controller type in the VM + Settings dialog. + + + + &product-name; recommends the Intel Matrix Storage drivers, + which can be downloaded from + . + + + + + To add a SATA controller to a machine for which it has not + been enabled by default, either because it was created by an + earlier version of &product-name;, or because SATA is not + supported by default by the selected guest OS, do the + following. Go to the Storage + page of the machine's + Settings dialog, click + Add Controller under the + Storage Tree box and then select Add + SATA Controller. The new controller appears as a + separate PCI device in the virtual machine, and you can add + virtual disks to it. + + + + To change the IDE compatibility mode settings for the SATA + controller, see . + + + + + + SCSI is another established + industry standard, standing for Small Computer System + Interface. SCSI is as a generic interface for data transfer + between all kinds of devices, including storage devices. SCSI + is still used for connecting some hard disks and tape devices, + but it has mostly been displaced in commodity hardware. It is + still in common use in high-performance workstations and + servers. + + + + Primarily for compatibility with other virtualization + software, &product-name; optionally supports LSI Logic and + BusLogic SCSI controllers, to each of which up to fifteen + virtual hard disks can be attached. + + + + To enable a SCSI controller, on the + Storage page of a virtual + machine's Settings dialog, + click Add Controller under + the Storage Tree box and then select Add + SCSI Controller. The new controller appears as a + separate PCI device in the virtual machine. + + + + + As with the other controller types, a SCSI controller will + only be seen by OSes with device support for it. Windows + 2003 and later ships with drivers for the LSI Logic + controller, while Windows NT 4.0 and Windows 2000 ships with + drivers for the BusLogic controller. Windows XP ships with + drivers for neither. + + + + + + + Serial Attached SCSI (SAS) is + another bus standard which uses the SCSI command set. As + opposed to SCSI physical devices, serial cables are used + instead of parallel cables. This simplifies physical device + connections. In some ways, therefore, SAS is to SCSI what SATA + is to IDE: it enables more reliable and faster connections. + + + + To support high-end guests which require SAS controllers, + &product-name; emulates a LSI Logic SAS controller, which can + be enabled much the same way as a SCSI controller. At this + time, up to 255 devices can be connected to the SAS + controller. + + + + + As with SATA, the SAS controller will only be seen by OSes + with device support for it. In particular, there + is no support for SAS in Windows before Windows + Vista. So Windows XP, even SP3, will not see such + disks unless you install additional drivers. + + + + + + + The USB mass storage device + class is a standard to connect external storage + devices like hard disks or flash drives to a host through USB. + All major OSes support these devices and ship generic drivers + making third-party drivers superfluous. In particular, legacy + OSes without support for SATA controllers may benefit from USB + mass storage devices. + + + + The virtual USB storage controller offered by &product-name; + works differently to the other storage controller types. While + most storage controllers appear as a single PCI device to the + guest with multiple disks attached to it, the USB-based + storage controller does not appear as virtual storage + controller. Each disk attached to the controller appears as a + dedicated USB device to the guest. + + + + + Booting from drives attached using USB is only supported + when EFI is used as the BIOS lacks USB support. + + + + + + + Non volatile memory express + (NVMe) is a standard for connecting non volatile + memory (NVM) directly over PCI Express to lift the bandwidth + limitation of the previously used SATA protocol for + solid-state devices. Unlike other standards the command set is + very simple in order to achieve maximum throughput and is not + compatible with ATA or SCSI. OSes need to support NVMe devices + to make use of them. For example, Windows 8.1 added native + NVMe support. For Windows 7, native support was added with an + update. + + + + The NVMe controller is part of the extension pack. + + + + + Booting from drives attached using NVMe is only supported + when EFI is used as the BIOS lacks the appropriate driver. + + + + + + + Virtual I/O Device SCSI is a + standard to connect virtual storage devices like hard disks or + optical drives to a VM. Recent Linux and Windows versions + support these devices, but Windows needs additional drivers. + Currently virtio-scsi controller support is experimental. + + + + + The virtio-scsi controller will only be seen by OSes with + device support for it. In particular, there is no + built-in support in Windows. So Windows will not + see such disks unless you install additional drivers. + + + + + + + + In summary, &product-name; gives you the following categories of + virtual storage slots: + + + + + + + Four slots attached to the traditional IDE controller, which + are always present. One of these is typically a virtual CD/DVD + drive. + + + + + + 30 slots attached to the SATA controller, if enabled and + supported by the guest OS. + + + + + + 15 slots attached to the SCSI controller, if enabled and + supported by the guest OS. + + + + + + Up to 255 slots attached to the SAS controller, if enabled and + supported by the guest OS. + + + + + + Eight slots attached to the virtual USB controller, if enabled + and supported by the guest OS. + + + + + + Up to 255 slots attached to the NVMe controller, if enabled + and supported by the guest OS. + + + + + + Up to 256 slots attached to the virtio-scsi controller, if + enabled and supported by the guest OS. + + + + + + + Given this large choice of storage controllers, you may not know + which one to choose. In general, you should avoid IDE unless it is + the only controller supported by your guest. Whether you use SATA, + SCSI, or SAS does not make any real difference. The variety of + controllers is only supplied by &product-name; for compatibility + with existing hardware and other hypervisors. + + + + + + + Disk Image Files (VDI, VMDK, VHD, HDD) + + + Disk image files reside on the host system and are seen by the + guest systems as hard disks of a certain geometry. When a guest OS + reads from or writes to a hard disk, &product-name; redirects the + request to the image file. + + + + Like a physical disk, a virtual disk has a size, or capacity, + which must be specified when the image file is created. As opposed + to a physical disk however, &product-name; enables you to expand + an image file after creation, even if it has data already. See + . + + + + &product-name; supports the following types of disk image files: + + + + + + + VDI. Normally, &product-name; + uses its own container format for guest hard disks. This is + called a Virtual Disk Image (VDI) file. This format is used + when you create a new virtual machine with a new disk. + + + + + + VMDK. &product-name; also + fully supports the popular and open VMDK container format that + is used by many other virtualization products, such as VMware. + + + + + + VHD. &product-name; also + fully supports the VHD format used by Microsoft. + + + + + + HDD. Image files of Parallels + version 2 (HDD format) are also supported. + + + + Due to lack of documentation of the format, newer versions + such as 3 and 4 are not supported. You can however convert + such image files to version 2 format using tools provided by + Parallels. + + + + + + + Irrespective of the disk capacity and format, as mentioned in + , there are two options for + creating a disk image: fixed-size or dynamically allocated. + + + + + + + Fixed-size. If you create a + fixed-size image, an image file will be created on your host + system which has roughly the same size as the virtual disk's + capacity. So, for a 10 GB disk, you will have a 10 GB file. + Note that the creation of a fixed-size image can take a long + time depending on the size of the image and the write + performance of your hard disk. + + + + + + Dynamically allocated. For + more flexible storage management, use a dynamically allocated + image. This will initially be very small and not occupy any + space for unused virtual disk sectors, but will grow every + time a disk sector is written to for the first time, until the + drive reaches the maximum capacity chosen when the drive was + created. While this format takes less space initially, the + fact that &product-name; needs to expand the image file + consumes additional computing resources, so until the disk + file size has stabilized, write operations may be slower than + with fixed size disks. However, after a time the rate of + growth will slow and the average penalty for write operations + will be negligible. + + + + + + + + + + The Virtual Media Manager + + + &product-name; keeps track of all the hard disk, CD/DVD-ROM, and + floppy disk images which are in use by virtual machines. These are + often referred to as known media and come + from two sources: + + + + + + + All media currently attached to virtual machines. + + + + + + Registered media, for compatibility with legacy &product-name; + versions. + + + + + + + The known media can be viewed and changed using the + Virtual Media Manager, which you + can access from the File menu in + the VirtualBox Manager window. + + +
+ The Virtual Media Manager + + + + + +
+ + + The known media are conveniently grouped in separate tabs for the + supported formats. These formats are: + + + + + + + Hard disk images, either in &product-name;'s own Virtual Disk + Image (VDI) format, or in the third-party formats listed in + . + + + + + + CD/DVD images in standard ISO format. + + + + + + Floppy images in standard RAW format. + + + + + + + For each image, the Virtual Media Manager shows you the full path + of the image file and other information, such as the virtual + machine the image is currently attached to. + + + + The Virtual Media Manager enables you to do the following: + + + + + + + Add an image to the known + media. + + + + + + Create a new disk image. + + + + + + + For virtual hard disks, the Create + Virtual Hard Disk wizard is shown. + + + + + + For optical disks, the VISO + Creator screen is shown. This enables you to + create a virtual ISO from selected files on the host. + + + + + + For floppy disks, the Floppy Disk + Creator screen is shown. + + + + + + + + + Copy an image to create + another one. + + + + For virtual hard disks, you can specify one of the following + target types: VDI, VHD, or VMDK. + + + + + + Move an image to another + location. + + + + A file dialog prompts you for the new image file location. + + + + When you use the Virtual Media Manager to move a disk image, + &product-name; updates all related configuration files + automatically. + + + + + Always use the Virtual Media Manager or the + VBoxManage modifymedium command to move a + disk image. + + + + If you use a file management feature of the host OS to move + a disk image to a new location, run the VBoxManage + modifymedium + command to configure the new path of the disk image on the + host file system. This command updates the &product-name; + configuration automatically. + + + + + + + Remove an image from the + known media. You can optionally delete the image file when + removing the image. + + + + + + Release an image to detach it + from a VM. This action only applies if the image is currently + attached to a VM as a virtual hard disk. + + + + + + Search for an image by name + or UUID. + + + + + + View and edit the Properties + of a disk image. + + + + Available properties include the following: + + + + + + + Type: Specifies the + snapshot behavior of the disk. See + . + + + + + + Location: Specifies the + location of the disk image file on the host system. You + can use a file dialog to browse for the disk image + location. + + + + + + Description: Specifies a + short description of the disk image. + + + + + + Size: Specifies the size + of the disk image. You can use the slider to increase or + decrease the disk image size. + + + + + + Information: Specifies + detailed information about the disk image. + + + + + + + + + Refresh the property values + of the selected disk image. + + + + + + + To perform these actions, highlight the medium in the Virtual + Media Manager and then do one of the following: + + + + + + + Click an icon in the Virtual Media Manager task bar. + + + + + + Right-click the medium and select an option. + + + + + + + Use the Storage page in a VM's + Settings dialog to create a new + disk image. By default, disk images are stored in the VM's folder. + + + + You can copy hard disk image files to other host systems and then + import them in to VMs from the host system. However, some Windows + guest OSes may require that you configure the new VM in a similar + way to the old one. + + + + + Do not simply make copies of virtual disk images. If you import + such a second copy into a VM, &product-name; issues an error + because &product-name; assigns a universally unique identifier + (UUID) to each disk image to ensure that it is only used one + time. See . Also, if you want to + copy a VM to another system, use the &product-name; import and + export features. See . + + + + + + + + Special Image Write Modes + + + For each virtual disk image supported by &product-name;, you can + determine separately how it should be affected by write operations + from a virtual machine and snapshot operations. This applies to + all of the aforementioned image formats (VDI, VMDK, VHD, or HDD) + and irrespective of whether an image is fixed-size or dynamically + allocated. + + + + By default, images are in normal mode. To + mark an existing image with one of the non-standard modes listed + below, use VBoxManage modifymedium. See + . Alternatively, use + VBoxManage storageattach to attach the image to + a VM and specify the argument. See + . + + + + The available virtual disk image modes are as follows: + + + + + + + Normal images have no + restrictions on how guests can read from and write to the + disk. This is the default image mode. + + + + When you take a snapshot of your virtual machine as described + in , the state of a normal hard + disk is recorded together with the snapshot, and when + reverting to the snapshot, its state will be fully reset. + + + + The image file itself is not reset. Instead, when a snapshot + is taken, &product-name; freezes the + image file and no longer writes to it. For the write + operations from the VM, a second, + differencing image file is created which + receives only the changes to the original image. See + . + + + + While you can attach the same normal image to more than one + virtual machine, only one of these virtual machines attached + to the same image file can be executed simultaneously, as + otherwise there would be conflicts if several machines write + to the same image file. + + + + + + Write-through hard disks are + completely unaffected by snapshots. Their state is + not saved when a snapshot is taken, and + not restored when a snapshot is restored. + + + + + + Shareable hard disks are a + variant of write-through hard disks. In principle they behave + exactly the same. Their state is not + saved when a snapshot is taken, and not restored when a + snapshot is restored. The difference only shows if you attach + such disks to several VMs. Shareable disks may be attached to + several VMs which may run concurrently. This makes them + suitable for use by cluster filesystems between VMs and + similar applications which are explicitly prepared to access a + disk concurrently. Only fixed size images can be used in this + way, and dynamically allocated images are rejected. + + + + + This is an expert feature, and misuse can lead to data loss, + as regular filesystems are not prepared to handle + simultaneous changes by several parties. + + + + + + + Immutable images only + remember write accesses temporarily while the virtual machine + is running. All changes are lost when the virtual machine is + powered on the next time. As a result, as opposed to Normal + images, the same immutable image can be used with several + virtual machines without restrictions. + + + + Creating an immutable image makes little sense since it would + be initially empty and lose its contents with every machine + restart. You would have a disk that is always unformatted when + the machine starts up. Instead, you can first create a normal + image and then later mark it as immutable when you decide that + the contents are useful. + + + + If you take a snapshot of a machine with immutable images, + then on every machine power-up, those images are reset to the + state of the last (current) snapshot, instead of the state of + the original immutable image. + + + + + As a special exception, immutable images are + not reset if they are attached to a + machine in a saved state or whose last snapshot was taken + while the machine was running. This is called an + online snapshot. As a result, if the + machine's current snapshot is an online snapshot, its + immutable images behave exactly like the a normal image. To + reenable the automatic resetting of such images, delete the + current snapshot of the machine. + + + + + &product-name; never writes to an immutable image directly at + all. All write operations from the machine are directed to a + differencing image. The next time the VM is powered on, the + differencing image is reset so that every time the VM starts, + its immutable images have exactly the same content. + + + + The differencing image is only reset when the machine is + powered on from within &product-name;, not when you reboot by + requesting a reboot from within the machine. This is also why + immutable images behave as described above when snapshots are + also present, which use differencing images as well. + + + + If the automatic discarding of the differencing image on VM + startup does not fit your needs, you can turn it off using the + parameter of VBoxManage + modifymedium. See + . + + + + + + Multiattach mode images can + be attached to more than one virtual machine at the same time, + even if these machines are running simultaneously. For each + virtual machine to which such an image is attached, a + differencing image is created. As a result, data that is + written to such a virtual disk by one machine is not seen by + the other machines to which the image is attached. Each + machine creates its own write history of the multiattach + image. + + + + Technically, a multiattach image behaves identically to an + immutable image except the differencing image is not reset + every time the machine starts. + + + + This mode is useful for sharing files which are almost never + written, for instance picture galleries, where every guest + changes only a small amount of data and the majority of the + disk content remains unchanged. The modified blocks are stored + in differencing images which remain relatively small and the + shared content is stored only once at the host. + + + + + + Read-only images are used + automatically for CD/DVD images, since CDs/DVDs can never be + written to. + + + + + + + The following scenario illustrates the differences between the + various image modes, with respect to snapshots. + + + + Assume you have installed your guest OS in your VM, and you have + taken a snapshot. Later, your VM is infected with a virus and you + would like to go back to the snapshot. With a normal hard disk + image, you simply restore the snapshot, and the earlier state of + your hard disk image will be restored as well and your virus + infection will be undone. With an immutable hard disk, all it + takes is to shut down and power on your VM, and the virus + infection will be discarded. With a write-through image however, + you cannot easily undo the virus infection by means of + virtualization, but will have to disinfect your virtual machine + like a real computer. + + + + You might find write-through images useful if you want to preserve + critical data irrespective of snapshots. As you can attach more + than one image to a VM, you may want to have one immutable image + for the OS and one write-through image for your data files. + + + + + + + Differencing Images + + + The previous section mentioned differencing images and how they + are used with snapshots, immutable images, and multiple disk + attachments. This section describes in more detail how + differencing images work. + + + + A differencing image is a special disk image that only holds the + differences to another image. A differencing image by itself is + useless, it must always refer to another image. The differencing + image is then typically referred to as a + child, which holds the differences to its + parent. + + + + When a differencing image is active, it receives all write + operations from the virtual machine instead of its parent. The + differencing image only contains the sectors of the virtual hard + disk that have changed since the differencing image was created. + When the machine reads a sector from such a virtual hard disk, it + looks into the differencing image first. If the sector is present, + it is returned from there. If not, &product-name; looks into the + parent. In other words, the parent becomes + read-only. It is never written to again, but + it is read from if a sector has not changed. + + + + Differencing images can be chained. If another differencing image + is created for a virtual disk that already has a differencing + image, then it becomes a grandchild of the + original parent. The first differencing image then becomes + read-only as well, and write operations only go to the + second-level differencing image. When reading from the virtual + disk, &product-name; needs to look into the second differencing + image first, then into the first if the sector was not found, and + then into the original image. + + + + There can be an unlimited number of differencing images, and each + image can have more than one child. As a result, the differencing + images can form a complex tree with parents, siblings, and + children, depending on how complex your machine configuration is. + Write operations always go to the one active + differencing image that is attached to the machine, and for read + operations, &product-name; may need to look up all the parents in + the chain until the sector in question is found. You can view such + a tree in the Virtual Media Manager. + + +
+ Differencing Images, Shown in Virtual Media Manager + + + + + +
+ + + In all of these situations, from the point of view of the virtual + machine, the virtual hard disk behaves like any other disk. While + the virtual machine is running, there is a slight run-time I/O + overhead because &product-name; might need to look up sectors + several times. This is not noticeable however since the tables + with sector information are always kept in memory and can be + looked up quickly. + + + + Differencing images are used in the following situations: + + + + + + + Snapshots. When you create a + snapshot, as explained in the previous section, &product-name; + freezes the images attached to the + virtual machine and creates differencing images for each image + that is not in write-through mode. From + the point of view of the virtual machine, the virtual disks + continue to operate before, but all write operations go into + the differencing images. Each time you create another + snapshot, for each hard disk attachment, another differencing + image is created and attached, forming a chain or tree. + + + + In the above screenshot, you see that the original disk image + is now attached to a snapshot, representing the state of the + disk when the snapshot was taken. + + + + If you restore a snapshot, and want to go + back to the exact machine state that was stored in the + snapshot, the following happens: + + + + + + + &product-name; copies the virtual machine settings that + were copied into the snapshot back to the virtual machine. + As a result, if you have made changes to the machine + configuration since taking the snapshot, they are undone. + + + + + + If the snapshot was taken while the machine was running, + it contains a saved machine state, and that state is + restored as well. After restoring the snapshot, the + machine will then be in Saved state and resume execution + from there when it is next started. Otherwise the machine + will be in Powered Off state and do a full boot. + + + + + + For each disk image attached to the machine, the + differencing image holding all the write operations since + the current snapshot was taken is thrown away, and the + original parent image is made active again. If you + restored the root snapshot, then this will be the root + disk image for each attachment. Otherwise, some other + differencing image descended from it. This effectively + restores the old machine state. + + + + + + + If you later delete a snapshot in order + to free disk space, for each disk attachment, one of the + differencing images becomes obsolete. In this case, the + differencing image of the disk attachment cannot simply be + deleted. Instead, &product-name; needs to look at each sector + of the differencing image and needs to copy it back into its + parent. This is called "merging" images and can be a + potentially lengthy process, depending on how large the + differencing image is. It can also temporarily need a + considerable amount of extra disk space, before the + differencing image obsoleted by the merge operation is + deleted. + + + + + + Immutable images. When an + image is switched to immutable mode, a differencing image is + created as well. As with snapshots, the parent image then + becomes read-only, and the differencing image receives all the + write operations. Every time the virtual machine is started, + all the immutable images which are attached to it have their + respective differencing image thrown away, effectively + resetting the virtual machine's virtual disk with every + restart. + + + + + + + + + + Cloning Disk Images + + + You can duplicate hard disk image files on the same host to + quickly produce a second virtual machine with the same OS setup. + However, you should only make copies of + virtual disk images using the utility supplied with + &product-name;. See . + This is because &product-name; assigns a UUID to each disk image, + which is also stored inside the image, and &product-name; will + refuse to work with two images that use the same number. If you do + accidentally try to reimport a disk image which you copied + normally, you can make a second copy using the VBoxManage + clonevm command and import that instead. + + + + Note that Linux distributions identify the boot hard disk from the + ID of the drive. The ID &product-name; reports for a drive is + determined from the UUID of the virtual disk image. So if you + clone a disk image and try to boot the copied image the guest + might not be able to determine its own boot disk as the UUID + changed. In this case you have to adapt the disk ID in your boot + loader script, for example + /boot/grub/menu.lst. The disk ID looks like + the following: + + +scsi-SATA_VBOX_HARDDISK_VB5cfdb1e2-c251e503 + + + The ID for the copied image can be determined as follows: + + +hdparm -i /dev/sda + + + + + + Host Input/Output Caching + + + &product-name; can optionally disable the I/O caching that the + host OS would otherwise perform on disk image files. + + + + Traditionally, &product-name; has opened disk image files as + normal files, which results in them being cached by the host OS + like any other file. The main advantage of this is speed: when the + guest OS writes to disk and the host OS cache uses delayed + writing, the write operation can be reported as completed to the + guest OS quickly while the host OS can perform the operation + asynchronously. Also, when you start a VM a second time and have + enough memory available for the OS to use for caching, large parts + of the virtual disk may be in system memory, and the VM can access + the data much faster. + + + + Note that this applies only to image files. Buffering does not + occur for virtual disks residing on remote iSCSI storage, which is + the more common scenario in enterprise-class setups. See + . + + + + While buffering is a useful default setting for virtualizing a few + machines on a desktop computer, there are some disadvantages to + this approach: + + + + + + + Delayed writing through the host OS cache is less secure. When + the guest OS writes data, it considers the data written even + though it has not yet arrived on a physical disk. If for some + reason the write does not happen, such as power failure or + host crash, the likelihood of data loss increases. + + + + + + Disk image files tend to be very large. Caching them can + therefore quickly use up the entire host OS cache. Depending + on the efficiency of the host OS caching, this may slow down + the host immensely, especially if several VMs run at the same + time. For example, on Linux hosts, host caching may result in + Linux delaying all writes until the host cache is nearly full + and then writing out all these changes at once, possibly + stalling VM execution for minutes. This can result in I/O + errors in the guest as I/O requests time out there. + + + + + + Physical memory is often wasted as guest OSes typically have + their own I/O caches, which may result in the data being + cached twice, in both the guest and the host caches, for + little effect. + + + + + + + If you decide to disable host I/O caching for the above reasons, + &product-name; uses its own small cache to buffer writes, but no + read caching since this is typically already performed by the + guest OS. In addition, &product-name; fully supports asynchronous + I/O for its virtual SATA, SCSI, and SAS controllers through + multiple I/O threads. + + + + Since asynchronous I/O is not supported by IDE controllers, for + performance reasons, you may want to leave host caching enabled + for your VM's virtual IDE controllers. + + + + For this reason, &product-name; enables you to configure whether + the host I/O cache is used for each I/O controller separately. + Either select the Use Host I/O + Cache check box in the + Storage settings for a given + virtual storage controller, or use the following + VBoxManage command to disable the host I/O + cache for a virtual storage controller: + + +VBoxManage storagectl "VM name" --name <controllername> --hostiocache off + + + See . + + + + For the above reasons, &product-name; uses SATA controllers by + default for new virtual machines. + + + + + + + Limiting Bandwidth for Disk Images + + + &product-name; supports limiting of the maximum bandwidth used for + asynchronous I/O. Additionally it supports sharing limits through + bandwidth groups for several images. It is possible to have more + than one such limit. + + + + Limits are configured using VBoxManage. The + example below creates a bandwidth group named Limit, sets the + limit to 20 MB per second, and assigns the group to the attached + disks of the VM: + + +VBoxManage bandwidthctl "VM name" add Limit --type disk --limit 20M +VBoxManage storageattach "VM name" --storagectl "SATA" --port 0 --device 0 --type hdd + --medium disk1.vdi --bandwidthgroup Limit +VBoxManage storageattach "VM name" --storagectl "SATA" --port 1 --device 0 --type hdd + --medium disk2.vdi --bandwidthgroup Limit + + + All disks in a group share the bandwidth limit, meaning that in + the example above the bandwidth of both images combined can never + exceed 20 MBps. However, if one disk does not require bandwidth + the other can use the remaining bandwidth of its group. + + + + The limits for each group can be changed while the VM is running, + with changes being picked up immediately. The example below + changes the limit for the group created in the example above to 10 + MBps: + + +VBoxManage bandwidthctl "VM name" set Limit --limit 10M + + + + + + CD/DVD Support + + + Virtual CD/DVD drives by default support only reading. The medium + configuration is changeable at runtime. You can select between the + following options to provide the medium data: + + + + + + + Host Drive defines that the + guest can read from the medium in the host drive. + + + + + + Image file gives the guest + read-only access to the data in the image. This is typically + an ISO file. + + + + + + Empty means a drive without + an inserted medium. + + + + + + + Changing between the above, or changing a medium in the host drive + that is accessed by a machine, or changing an image file will + signal a medium change to the guest OS. The guest OS can then + react to the change, for example by starting an installation + program. + + + + Medium changes can be prevented by the guest, and &product-name; + reflects that by locking the host drive if appropriate. You can + force a medium removal in such situations by using the VirtualBox + Manager or the VBoxManage command line tool. + Effectively this is the equivalent of the emergency eject which + many CD/DVD drives provide, with all associated side effects. The + guest OS can issue error messages, just like on real hardware, and + guest applications may misbehave. Use this with caution. + + + + + The identification string of the drive provided to the guest, + displayed by configuration tools such as the Windows Device + Manager, is always VBOX CD-ROM, irrespective of the current + configuration of the virtual drive. This is to prevent hardware + detection from being triggered in the guest OS every time the + configuration is changed. + + + + + The standard CD/DVD emulation enables reading of standard data CD + and DVD formats only. As an experimental feature, for additional + capabilities, it is possible to give the guest direct access to + the CD/DVD host drive by enabling passthrough + mode. Depending on the host hardware, this may potentially enable + the following things to work: + + + + + + + CD/DVD writing from within the guest, if the host DVD drive is + a CD/DVD writer + + + + + + Playing audio CDs + + + + + + Playing encrypted DVDs + + + + + + + To enable host drive passthrough you can use the + option of the VBoxManage + storageattach command. See + . + + + + Even if passthrough is enabled, unsafe commands, such as updating + the drive firmware, will be blocked. Video CD formats are never + supported, not even in passthrough mode, and cannot be played from + a virtual machine. + + + + On Oracle Solaris hosts, passthrough requires running + &product-name; with real root permissions due to security measures + enforced by the host. + + + + + + + iSCSI Servers + + + iSCSI stands for Internet SCSI and is a + standard that supports use of the SCSI protocol over Internet + (TCP/IP) connections. Especially with the advent of Gigabit + Ethernet, it has become affordable to attach iSCSI storage servers + simply as remote hard disks to a computer network. In iSCSI + terminology, the server providing storage resources is called an + iSCSI target, while the client connecting to + the server and accessing its resources is called an + iSCSI initiator. + + + + &product-name; can transparently present iSCSI remote storage to a + virtual machine as a virtual hard disk. The guest OS will not see + any difference between a virtual disk image (VDI file) and an + iSCSI target. To achieve this, &product-name; has an integrated + iSCSI initiator. + + + + &product-name;'s iSCSI support has been developed according to the + iSCSI standard and should work with all standard-conforming iSCSI + targets. To use an iSCSI target with &product-name;, you must use + the command line. See . + + + + + + + vboximg-mount: A Utility for FUSE Mounting a Virtual Disk Image + + + vboximg-mount is a command line utility for Mac + OS and Linux hosts that provides raw access to an &product-name; + virtual disk image on the host system. Use this utility to mount, + view, and optionally modify the disk image contents. + + + + The utility is based on Filesystem in Userspace (FUSE) technology + and uses the VirtualBox runtime engine. Ensure that &product-name; + is running on the host system. + + + + + When using vboximg-mount, ensure that the + following conditions apply: + + + + + + + The disk image is not being used by any other systems, such + as by guest VMs. + + + + + + No VMs are running on the host system. + + + + + + + + Raw access using FUSE is preferred over direct loopback mounting + of virtual disk images, because it is snapshot aware. It can + selectively merge disk differencing images in an exposed virtual + hard disk, providing historical or up-to-date representations of + the virtual disk contents. + + + + vboximg-mount enables you to view information + about registered VMs, their attached disk media, and any + snapshots. Also, you can view partition information for a disk + image. + + + + The vboximg-mount command includes experimental + read-only access to file systems inside a VM disk image. This + feature enables you to extract some files from the disk image + without starting the VM and without requiring third-party file + system drivers on the host system. FAT, NTFS, ext2, ext3, and ext4 + file systems are supported. + + + + Use the option to view information about + the vboximg-mount command usage. The complete + command reference is described in + . + + + + When vboximg-mount mounts an &product-name; + disk image, it creates a one level deep file system at a mount + point that you specify. The file system includes a device node + that represents the synthesized disk image as a readable or + readable-writeable bytestream. This bytestream can be mounted + either by using the host OS or by using other FUSE-based file + systems. + + + + + Viewing Detailed Information About a Virtual Disk Image + + + The following examples show how to use the + vboximg-mount command to view information + about virtual disk images. + + + + The following command outputs detailed information about all + registered VMs and associated snapshots: + + +$ vboximg-mount --list --verbose + + ------------------------------------------------------ + VM Name: "macOS High Sierra 10.13" + UUID: 3887d96d-831c-4187-a55a-567c504ff0e1 + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vbox + ----------------------- + HDD base: "macOS High Sierra 10.13.vdi" + UUID: f9ea7173-6869-4aa9-b487-68023a655980 + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vdi + + Diff 1: + UUID: 98c2bac9-cf37-443d-a935-4e879b70166d + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ + Snapshots/{98c2bac9-cf37-443d-a935-4e879b70166d}.vdi + Diff 2: + UUID: f401f381-7377-40b3-948e-3c61241b1a42 + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ + Snapshots/{f401f381-7377-40b3-948e-3c61241b1a42}.vdi + ----------------------- + HDD base: "simple_fixed_disk.vdi" + UUID: ffba4d7e-1277-489d-8173-22ca7660773d + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/simple_fixed_disk.vdi + + Diff 1: + UUID: aecab681-0d2d-468b-8682-93f79dc97a48 + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ + Snapshots/{aecab681-0d2d-468b-8682-93f79dc97a48}.vdi + Diff 2: + UUID: 70d6b34d-8422-47fa-8521-3b6929a1971c + Location: /Volumes/work/vm_guests/macOS High Sierra 10.13/ + Snapshots/{70d6b34d-8422-47fa-8521-3b6929a1971c}.vdi + ------------------------------------------------------ + VM Name: "debian" + UUID: 5365ab5f-470d-44c0-9863-dad532ee5905 + Location: /Volumes/work/vm_guests/debian/debian.vbox + ----------------------- + HDD base: "debian.vdi" + UUID: 96d2e92e-0d4e-46ab-a0f1-008fdbf997e7 + Location: /Volumes/work/vm_guests/debian/ol7.vdi + + Diff 1: + UUID: f9cc866a-9166-42e9-a503-bbfe9b7312e8 + Location: /Volumes/work/vm_guests/debian/Snapshots/ + {f9cc866a-9166-42e9-a503-bbfe9b7312e8}.vdi + + + The following command outputs partition information about the + specified disk image: + + +$ vboximg-mount --image=f9ea7173-6869-4aa9-b487-68023a655980 --list + + Virtual disk image: + + Path: /Volumes/work/vm_guests/macOS High Sierra 10.13/macOS High Sierra 10.13.vdi + UUID: f9ea7173-6869-4aa9-b487-68023a655980 + + # Start Sectors Size Offset Type + 1 40 409599 199.9M 20480 EFI System + 2 409640 67453071 32.1G 209735680 Hierarchical File System Plus (HFS+) + 3 67862712 1269535 107.8M 34745708544 Apple Boot (Recovery HD) + + + + + + Mounting a Virtual Disk Image + + + The following steps show how to use the + vboximg-mount command to mount a partition of + a virtual disk image on the host OS. + + + + + + + Create a mount point on the host OS. For example: + + +$ mkdir macos_sysdisk + + + + + Show partition information about the virtual disk image. + + +$ vboximg-mount --image=uuid --list + + + where uuid is the UUID of the + disk image. + + + + + + Use vboximg-mount to perform a FUSE mount + of a partition on the virtual disk image. For example: + + +$ vboximg-mount --image=uuid -p 2 macos_sysdisk + + + where uuid is the UUID for the + disk image. + + + + In this example, partition 2 is mounted on the + macos_sysdisk mount point. The mount + includes all snapshots for the disk image. + + + + + + Use the host OS to mount the vhdd device + node. The FUSE-mounted device node represents the virtual + disk image. + + +$ ls macos_sysdisk + macOS High Sierra 10.13.vdi vhdd +$ sudo mount macos_sysdisk/vhdd /mnt + + + + + + + + + diff --git a/doc/manual/en_US/user_Technical.xml b/doc/manual/en_US/user_Technical.xml new file mode 100644 index 00000000..6fe245aa --- /dev/null +++ b/doc/manual/en_US/user_Technical.xml @@ -0,0 +1,941 @@ + + +%all.entities; +]> + + + Technical Background + + + This chapter provides additional information for readers who are + familiar with computer architecture and technology and wish to find + out more about how &product-name; works under the + hood. The contents of this chapter are not required + reading in order to use &product-name; successfully. + + + + + Where &product-name; Stores its Files + + + In &product-name;, a virtual machine and its settings are + described in a virtual machine settings file in XML format. In + addition, most virtual machines have one or more virtual hard + disks. These are typically represented by disk images, such as + those in VDI format. The location of these files may vary, + depending on the host operating system. See + . + + + + Global configuration data for &product-name; is maintained in + another location on the host. See + . + + + + + The Machine Folder + + + By default, each virtual machine has a directory on your host + computer where all the files of that machine are stored: the XML + settings file, with a .vbox file extension, + and its disk images. This is called the machine + folder. + + + + By default, this machine folder is located in a common folder + called VirtualBox VMs, which &product-name; + creates in the current system user's home directory. The + location of this home directory depends on the conventions of + the host operating system, as follows: + + + + + + + On Windows, this is the location returned by the + SHGetFolderPath function of the Windows + system library Shell32.dll, asking for the user profile. A + typical location is + C:\Users\username. + + + + + + On Linux, Mac OS X, and Oracle Solaris, this is generally + taken from the environment variable + $HOME, except for the user + root where it is taken from the account + database. This is a workaround for the frequent trouble + caused by users using &product-name; in combination with the + tool sudo, which by default does not + reset the environment variable $HOME. + + + + A typical location on Linux and Oracle Solaris is + /home/username + and on Mac OS X is + /Users/username. + + + + + + + For simplicity, we abbreviate the location of the home directory + as $HOME. Using that convention, the common + folder for all virtual machines is $HOME/VirtualBox + VMs. + + + + As an example, when you create a virtual machine called "Example + VM", &product-name; creates the following: + + + + + + + A machine folder: $HOME/VirtualBox VMs/Example + VM/ + + + + + + In the machine folder, a settings file: Example + VM.vbox + + + + + + In the machine folder, a virtual disk image: + Example VM.vdi. + + + + + + + This is the default layout if you use the + Create New Virtual Machine + wizard described in . Once you + start working with the VM, additional files are added. Log files + are in a subfolder called Logs, and if you + have taken snapshots, they are in a + Snapshots subfolder. For each VM, you can + change the location of its snapshots folder in the VM settings. + + + + You can change the default machine folder by selecting + Preferences from the + File menu in the &product-name; + main window. Then, in the displayed window, click on the + General tab. Alternatively, use + the VBoxManage setproperty machinefolder + command. See . + + + + + + + Global Settings + + + In addition to the files for the virtual machines, + &product-name; maintains global configuration data in the + following directory: + + + + + + + Linux and Oracle Solaris: + $HOME/.config/VirtualBox. + + + + + + Windows: + $HOME/.VirtualBox. + + + + + + Mac OS X: + $HOME/Library/VirtualBox. + + + + + + + &product-name; creates this configuration directory + automatically, if necessary. You can specify an alternate + configuration directory by either setting the + VBOX_USER_HOME environment variable, or on + Linux or Oracle Solaris by using the standard + XDG_CONFIG_HOME variable. Since the global + VirtualBox.xml settings file points to all + other configuration files, this enables switching between + several &product-name; configurations. + + + + In this configuration directory, &product-name; stores its + global settings file, an XML file called + VirtualBox.xml. This file includes global + configuration options and a list of registered virtual machines + with pointers to their XML settings files. + + + + + + + Summary of Configuration Data Locations + + + The following table gives a brief overview of the configuration + data locations on an &product-name; host. + + + + Configuration File Locations + + + + + Setting + + + Location + + + + + + + Default machines folder + + + $HOME/VirtualBox VMs + + + + + Default disk image location + + + In each machine's folder + + + + + Machine settings file extension + + + .vbox + + + + + Media registry + + + Each machine settings file + + + + + + Media registration is done automatically when a + storage medium is attached to a VM + + + + +
+ + + + + + &product-name; XML Files + + + &product-name; uses XML for both the machine settings files and + the global configuration file, + VirtualBox.xml. + + + + All &product-name; XML files are versioned. When a new settings + file is created, for example because a new virtual machine is + created, &product-name; automatically uses the settings format + of the current &product-name; version. These files may not be + readable if you downgrade to an earlier version of + &product-name;. However, when &product-name; encounters a + settings file from an earlier version, such as after upgrading + &product-name;, it attempts to preserve the settings format as + much as possible. It will only silently upgrade the settings + format if the current settings cannot be expressed in the old + format, for example because you enabled a feature that was not + present in an earlier version of &product-name;. + + + + In such cases, &product-name; backs up the old settings file in + the virtual machine's configuration directory. If you need to go + back to the earlier version of &product-name;, then you will + need to manually copy these backup files back. + + + + We intentionally do not document the specifications of the + &product-name; XML files, as we must reserve the right to modify + them in the future. We therefore strongly suggest that you do + not edit these files manually. &product-name; provides complete + access to its configuration data through its the + VBoxManage command line tool, see + and its API, see + . + + + + + + + + + &product-name; Executables and Components + + + &product-name; was designed to be modular and flexible. When the + &product-name; graphical user interface (GUI) is opened and a VM + is started, at least the following three processes are running: + + + + + + + VBoxSVC, the &product-name; service process + which always runs in the background. This process is started + automatically by the first &product-name; client process and + exits a short time after the last client exits. The first + &product-name; service can be the GUI, + VBoxManage, + VBoxHeadless, the web service amongst + others. The service is responsible for bookkeeping, + maintaining the state of all VMs, and for providing + communication between &product-name; components. This + communication is implemented using COM/XPCOM. + + + + + When we refer to clients here, we mean + the local clients of a particular VBoxSVC + server process, not clients in a network. &product-name; + employs its own client/server design to allow its processes + to cooperate, but all these processes run under the same + user account on the host operating system, and this is + totally transparent to the user. + + + + + + + The GUI process, VirtualBoxVM, a client + application based on the cross-platform Qt library. When + started without the option, this + application acts as the VirtualBox Manager, displaying the VMs + and their settings. It then communicates settings and state + changes to VBoxSVC and also reflects + changes effected through other means, such as the + VBoxManage command. + + + + + + If the VirtualBoxVM client application is + started with the argument, it loads + the VMM library which includes the actual hypervisor and then + runs a virtual machine and provides the input and output for + the guest. + + + + + + + Any &product-name; front-end, or client, will communicate with the + service process and can both control and reflect the current + state. For example, either the VM selector or the VM window or + VBoxManage can be used to pause the running VM, and other + components will always reflect the changed state. + + + + The &product-name; GUI application is only one of several + available front ends, or clients. The complete list shipped with + &product-name; is as follows: + + + + + + + VirtualBoxVM: The Qt front end implementing + the VirtualBox Manager and running VMs. + + + + + + VBoxManage: A less user-friendly but more + powerful alternative. See . + + + + + + VBoxHeadless: A VM front end which does not + directly provide any video output and keyboard or mouse input, + but enables redirection through the VirtualBox Remote Desktop + Extension. See . + + + + + + vboxwebsrv: The &product-name; web service + process which enables control of an &product-name; host + remotely. This is described in detail in the &product-name; + Software Development Kit (SDK) reference. See + . + + + + + + The &product-name; Python shell: A Python alternative to + VBoxManage. This is also described in the + SDK reference. + + + + + + + Internally, &product-name; consists of many more or less separate + components. You may encounter these when analyzing &product-name; + internal error messages or log files. These include the following: + + + + + + + IPRT: A portable runtime library which abstracts file access, + threading, and string manipulation. Whenever &product-name; + accesses host operating features, it does so through this + library for cross-platform portability. + + + + + + VMM (Virtual Machine Monitor): The heart of the hypervisor. + + + + + + EM (Execution Manager): Controls execution of guest code. + + + + + + TRPM (Trap Manager): Intercepts and processes guest traps and + exceptions. + + + + + + HM (Hardware Acceleration Manager): Provides support for VT-x + and AMD-V. + + + + + + GIM (Guest Interface Manager): Provides support for various + paravirtualization interfaces to the guest. + + + + + + PDM (Pluggable Device Manager): An abstract interface between + the VMM and emulated devices which separates device + implementations from VMM internals and makes it easy to add + new emulated devices. Through PDM, third-party developers can + add new virtual devices to &product-name; without having to + change &product-name; itself. + + + + + + PGM (Page Manager): A component that controls guest paging. + + + + + + TM (Time Manager): Handles timers and all aspects of time + inside guests. + + + + + + CFGM (Configuration Manager): Provides a tree structure which + holds configuration settings for the VM and all emulated + devices. + + + + + + SSM (Saved State Manager): Saves and loads VM state. + + + + + + VUSB (Virtual USB): A USB layer which separates emulated USB + controllers from the controllers on the host and from USB + devices. This component also enables remote USB. + + + + + + DBGF (Debug Facility): A built-in VM debugger. + + + + + + &product-name; emulates a number of devices to provide the + hardware environment that various guests need. Most of these + are standard devices found in many PC compatible machines and + widely supported by guest operating systems. For network and + storage devices in particular, there are several options for + the emulated devices to access the underlying hardware. These + devices are managed by PDM. + + + + + + Guest Additions for various guest operating systems. This is + code that is installed from within a virtual machine. See + . + + + + + + The "Main" component is special. It ties all the above bits + together and is the only public API that &product-name; + provides. All the client processes listed above use only this + API and never access the hypervisor components directly. As a + result, third-party applications that use the &product-name; + Main API can rely on the fact that it is always well-tested + and that all capabilities of &product-name; are fully exposed. + It is this API that is described in the &product-name; SDK. + See . + + + + + + + + + + Hardware Virtualization + + + &product-name; enables software in the virtual machine to run + directly on the processor of the host, but an array of complex + techniques is employed to intercept operations that would + interfere with your host. Whenever the guest attempts to do + something that could be harmful to your computer and its data, + &product-name; steps in and takes action. In particular, for lots + of hardware that the guest believes to be accessing, + &product-name; simulates a certain virtual + environment according to how you have configured a virtual + machine. For example, when the guest attempts to access a hard + disk, &product-name; redirects these requests to whatever you have + configured to be the virtual machine's virtual hard disk. This is + normally an image file on your host. + + + + Unfortunately, the x86 platform was never designed to be + virtualized. Detecting situations in which &product-name; needs to + take control over the guest code that is executing, as described + above, is difficult. To achieve this, &product-name; uses + hardware virtualization. + + + + Intel and AMD processors have support for hardware virtualization. + This means that these processors can help &product-name; to + intercept potentially dangerous operations that a guest operating + system may be attempting and also makes it easier to present + virtual hardware to a virtual machine. + + + + These hardware features differ between Intel and AMD processors. + Intel named its technology VT-x, AMD calls theirs AMD-V. The Intel + and AMD support for virtualization is very different in detail, + but not very different in principle. + + + + + On many systems, the hardware virtualization features first need + to be enabled in the BIOS before &product-name; can use them. + + + + + Enabling hardware virtualization is required + in the following scenarios: + + + + + + + Certain rare guest operating systems like OS/2 make use of + very esoteric processor instructions. For virtual machines + that are configured to use such an operating system, hardware + virtualization is enabled automatically. + + + + + + &product-name;'s 64-bit guest and multiprocessing (SMP) + support both require hardware virtualization to be enabled. + This is not much of a limitation since the vast majority of + 64-bit and multicore CPUs ship with hardware virtualization. + The exceptions to this rule are some legacy Intel and AMD + CPUs. + + + + + + + + Do not run other hypervisors, either open source or commercial + virtualization products, together with &product-name;. While + several hypervisors can normally be + installed in parallel, do not attempt to + run several virtual machines from competing + hypervisors at the same time. &product-name; cannot track what + another hypervisor is currently attempting to do on the same + host, and especially if several products attempt to use hardware + virtualization features such as VT-x, this can crash the entire + host. + + + + + See for a technical discussion of + hardware virtualization. + + + + + + + Details About Hardware Virtualization + + + With Intel VT-x, there are two distinct modes of CPU operation: + VMX root mode and non-root mode. + + + + + + + In root mode, the CPU operates much like older generations of + processors without VT-x support. There are four privilege + levels, called rings, and the same instruction set is + supported, with the addition of several virtualization + specific instruction. Root mode is what a host operating + system without virtualization uses, and it is also used by a + hypervisor when virtualization is active. + + + + + + In non-root mode, CPU operation is significantly different. + There are still four privilege rings and the same instruction + set, but a new structure called VMCS (Virtual Machine Control + Structure) now controls the CPU operation and determines how + certain instructions behave. Non-root mode is where guest + systems run. + + + + + + + Switching from root mode to non-root mode is called "VM entry", + the switch back is "VM exit". The VMCS includes a guest and host + state area which is saved/restored at VM entry and exit. Most + importantly, the VMCS controls which guest operations will cause + VM exits. + + + + The VMCS provides fairly fine-grained control over what the guests + can and cannot do. For example, a hypervisor can allow a guest to + write certain bits in shadowed control registers, but not others. + This enables efficient virtualization in cases where guests can be + allowed to write control bits without disrupting the hypervisor, + while preventing them from altering control bits over which the + hypervisor needs to retain full control. The VMCS also provides + control over interrupt delivery and exceptions. + + + + Whenever an instruction or event causes a VM exit, the VMCS + contains information about the exit reason, often with + accompanying detail. For example, if a write to the CR0 register + causes an exit, the offending instruction is recorded, along with + the fact that a write access to a control register caused the + exit, and information about source and destination register. Thus + the hypervisor can efficiently handle the condition without + needing advanced techniques such as CSAM and PATM described above. + + + + VT-x inherently avoids several of the problems which software + virtualization faces. The guest has its own completely separate + address space not shared with the hypervisor, which eliminates + potential clashes. Additionally, guest OS kernel code runs at + privilege ring 0 in VMX non-root mode, obviating the problems by + running ring 0 code at less privileged levels. For example the + SYSENTER instruction can transition to ring 0 without causing + problems. Naturally, even at ring 0 in VMX non-root mode, any I/O + access by guest code still causes a VM exit, allowing for device + emulation. + + + + The biggest difference between VT-x and AMD-V is that AMD-V + provides a more complete virtualization environment. VT-x requires + the VMX non-root code to run with paging enabled, which precludes + hardware virtualization of real-mode code and non-paged + protected-mode software. This typically only includes firmware and + OS loaders, but nevertheless complicates VT-x hypervisor + implementation. AMD-V does not have this restriction. + + + + Of course hardware virtualization is not perfect. Compared to + software virtualization, the overhead of VM exits is relatively + high. This causes problems for devices whose emulation requires + high number of traps. One example is a VGA device in 16-color + mode, where not only every I/O port access but also every access + to the framebuffer memory must be trapped. + + + + + + + Paravirtualization Providers + + + &product-name; enables the exposure of a paravirtualization + interface, to facilitate accurate and efficient execution of + software within a virtual machine. These interfaces require the + guest operating system to recognize their presence and make use of + them in order to leverage the benefits of communicating with the + &product-name; hypervisor. + + + + Most modern, mainstream guest operating systems, including Windows + and Linux, ship with support for one or more paravirtualization + interfaces. Hence, there is typically no need to install + additional software in the guest to take advantage of this + feature. + + + + Exposing a paravirtualization provider to the guest operating + system does not rely on the choice of host platforms. For example, + the Hyper-V paravirtualization provider can + be used for VMs to run on any host platform supported by + &product-name; and not just Windows. + + + + &product-name; provides the following interfaces: + + + + + + + Minimal: Announces the + presence of a virtualized environment. Additionally, reports + the TSC and APIC frequency to the guest operating system. This + provider is mandatory for running any Mac OS X guests. + + + + + + KVM: Presents a Linux KVM + hypervisor interface which is recognized by Linux kernels + version 2.6.25 or later. &product-name;'s implementation + currently supports paravirtualized clocks and SMP spinlocks. + This provider is recommended for Linux guests. + + + + + + Hyper-V: Presents a Microsoft + Hyper-V hypervisor interface which is recognized by Windows 7 + and newer operating systems. &product-name;'s implementation + currently supports paravirtualized clocks, APIC frequency + reporting, guest debugging, guest crash reporting and relaxed + timer checks. This provider is recommended for Windows guests. + + + + + + + + + + Nested Paging and VPIDs + + + In addition to normal hardware virtualization, your processor may + also support the following additional sophisticated techniques: + + + + + + + Nested paging implements some memory management in hardware, + which can greatly accelerate hardware virtualization since + these tasks no longer need to be performed by the + virtualization software. + + + + With nested paging, the hardware provides another level of + indirection when translating linear to physical addresses. + Page tables function as before, but linear addresses are now + translated to "guest physical" addresses first and not + physical addresses directly. A new set of paging registers now + exists under the traditional paging mechanism and translates + from guest physical addresses to host physical addresses, + which are used to access memory. + + + + Nested paging eliminates the overhead caused by VM exits and + page table accesses. In essence, with nested page tables the + guest can handle paging without intervention from the + hypervisor. Nested paging thus significantly improves + virtualization performance. + + + + On AMD processors, nested paging has been available starting + with the Barcelona (K10) architecture. They now call it rapid + virtualization indexing (RVI). Intel added support for nested + paging, which they call extended page tables (EPT), with their + Core i7 (Nehalem) processors. + + + + If nested paging is enabled, the &product-name; hypervisor can + also use large pages to reduce TLB usage + and overhead. This can yield a performance improvement of up + to 5%. To enable this feature for a VM, you use the + VBoxManage modifyvm --largepages command. + See . + + + + If you have an Intel CPU with EPT, please consult + for security concerns + regarding EPT. + + + + + + On Intel CPUs, a hardware feature called Virtual Processor + Identifiers (VPIDs) can greatly accelerate context switching + by reducing the need for expensive flushing of the processor's + Translation Lookaside Buffers (TLBs). + + + + To enable these features for a VM, you use the + VBoxManage modifyvm --vtxvpid and + VBoxManage modifyvm --largepages commands. + See . + + + + + + + + diff --git a/doc/manual/en_US/user_ThirdParty.xml b/doc/manual/en_US/user_ThirdParty.xml new file mode 100644 index 00000000..e13f8ea2 --- /dev/null +++ b/doc/manual/en_US/user_ThirdParty.xml @@ -0,0 +1,4813 @@ + + +%all.entities; +]> + + + Third-Party Materials and Licenses + + + &product-name; incorporates materials from several Open Source + software projects. Therefore the use of these materials by + &product-name; is governed by different Open Source licenses. This + document reproduces these licenses and provides a list of the + materials used and their respective licensing conditions. Section 1 + contains a list of the materials used. Section 2 reproduces the + applicable Open Source licenses. For each material, a reference to + its license is provided. + + + + The source code for the materials listed below as well as the rest + of the &product-name; code which is released as open source are + available at + , + both as tarballs for particular releases and as a live SVN + repository. + + + + + Third-Party Materials + + + + + + &product-name; contains portions of QEMU which is governed by + the licenses in + and + and + + + + (C) 2003-2005 Fabrice Bellard; Copyright (C) 2004-2005 Vassili + Karpov (malc); Copyright (c) 2004 Antony T Curtis; Copyright + (C) 2003 Jocelyn Mayer + + + + + + &product-name; contains code which is governed by the license + in and + + + + Copyright 2004 by the Massachusetts Institute of Technology. + + + + + + &product-name; contains code of the BOCHS VGA BIOS which is + governed by the license in + and + + + + Copyright (C) 2001, 2002 the LGPL VGABios developers Team. + + + + + + &product-name; contains code of the BOCHS ROM BIOS which is + governed by the license in + and + + + + Copyright (C) 2002 MandrakeSoft S.A.; Copyright (C) 2004 + Fabrice Bellard; Copyright (C) 2005 Struan Bartlett. + + + + + + &product-name; contains the zlib library which is governed by + the license in + and + + + + Copyright (C) 1995-2003 Jean-loup Gailly and Mark Adler. + + + + + + &product-name; may contain OpenSSL which is governed by the + license in + and + + + + Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com). This + product includes software written by Tim Hudson + (tjh@cryptsoft.com). + + + + + + &product-name; may contain NSPR and XPCOM which is governed by + the license in + and + + + + Copyright (C) The Authors. + + + + + + &product-name; contains Slirp which is governed by the license + in and + was written by Danny Gasparovski. + + + + Copyright (C) 1995, 1996 All Rights Reserved. + + + + + + &product-name; contains liblzf which is governed by the + license in + and + + + + Copyright (C) 2000-2005 Marc Alexander Lehmann + <schmorp@schmorp.de> + + + + + + &product-name; may ship with a modified copy of rdesktop which + is governed by the license in + and + + + + Copyright (C) Matthew Chapman and others. + + + + + + &product-name; may ship with a copy of kchmviewer which is + governed by the license in + and + + + + Copyright (C) George Yunaev and others. + + + + + + &product-name; may contain Etherboot which is governed by the + license in + with the exception that aggregating Etherboot with another + work does not require the other work to be released under the + same license (see + ). + Etherboot is + + + + Copyright (C) Etherboot team. + + + + + + &product-name; may contain iPXE which is governed by the + license in + and + + + + Copyright (C) Michael Brown <mbrown@fensystems.co.uk> + and others. + + + + + + &product-name; contains code from Wine which is governed by + the license in + and + + + + Copyright 1993 Bob Amstadt, Copyright 1996 Albrecht Kleine, + Copyright 1997 David Faure, Copyright 1998 Morten Welinder, + Copyright 1998 Ulrich Weigand, Copyright 1999 Ove Koven + + + + + + &product-name; contains code from lwIP which is governed by + the license in + and + + + + Copyright (C) 2001, 2002 Swedish Institute of Computer + Science. + + + + + + &product-name; contains libxml which is governed by the + license in + and + + + + Copyright (C) 1998-2003 Daniel Veillard. + + + + + + &product-name; contains libxslt which is governed by the + license in + and + + + + Copyright (C) 2001-2002 Daniel Veillard and Copyright (C) + 2001-2002 Thomas Broyer, Charlie Bozeman and Daniel Veillard. + + + + + + &product-name; contains code from the gSOAP XML web services + tools, which are licensed under the license in + + and + + + + Copyright (C) 2000-2007, Robert van Engelen, Genivia Inc., and + others. + + + + + + &product-name; ships with the application tunctl (shipped as + VBoxTunctl) from the User-mode Linux suite which is governed + by the license in + and + + + + Copyright (C) 2002 Jeff Dike. + + + + + + &product-name; contains code from Chromium, an OpenGL + implementation, which is goverened by the licenses in + + and + + + + Copyright (C) Stanford University, The Regents of the + University of California, Red Hat, and others. + + + + + + &product-name; contains libcurl which is governed by the + license in + and + + + + Copyright (C) 1996-2009, Daniel Stenberg. + + + + + + &product-name; contains dnsproxy which is governed by the + license in + and + + + + Copyright (c) 2003, 2004, 2005 Armin Wolfermann. + + + + + + &product-name; may contain iniparser which is governed by the + license in + and + + + + Copyright (c) 2000-2008 by Nicolas Devillard. + + + + + + &product-name; contains some code from libgd which is governed + by the license in + and + + + + Copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 + Pierre-Alain Joye (pierre@libgd.org). + + + + + + &product-name; contains code from the EFI Development Kit II + which is governed by the license in + and + + + + Copyright (c) 2004-2008, Intel Corporation. + + + + + + &product-name; contains libjpeg which is governed by the + license in + and + + + + Copyright (C) 1991-2010, Thomas G. Lane, Guido Vollbeding. + + + + + + &product-name; may contain x86 SIMD extension for IJG JPEG + library which is governed by the license in + + and + + + + Copyright 2009 Pierre Ossman <ossman@cendio.se> for + Cendio AB; Copyright 2010 D. R. Commander; Copyright (C) + 1999-2006, MIYASAKA Masaru. + + + + + + &product-name; may ship a copy of Qt which is governed by the + license in + and + + + + Copyright (C) 2010, 2011 Nokia Corporation and/or its + subsidiary(-ies). + + + + + + &product-name; contains parts of the FreeBSD kernel which is + governed by the license in + . + + + + + + &product-name; contains parts of the NetBSD kernel which is + governed by the license in + . + + + + + + &product-name; contains portions of liblightdm-gobject which + is governed by the license in + and + + + + Copyright (C) 2010-2013 Canonical Ltd.; Copyright (C) + 2010-2011 Robert Ancell. + + + + + + &product-name; contains portions of glib which is governed by + the license in + and + + + + Copyright (C) 1995-2011 The Glib team + + + + + + &product-name; contains portions of PCRE which is governed by + the license in + and + + + + Copyright (c) 1997-2012 University of Cambridge; Copyright(c) + 2009-2012 Zoltan Herczeg; Copyright (c) 2007-2012, Google Inc. + + + + + + &product-name; contains portions of libffi which is governed + by the license in + and + + + + Copyright (c) 1996-2012 Anthony Green, Red Hat, Inc and + others. See source files for details. + + + + + + &product-name; contains portions of FLTK which is governed by + the licenses in + and + and + + + + Copyright (C) 1991-2012 The FLTK team + + + + + + &product-name; contains portions of Expat which is governed by + the license in + and + + + + Copyright (c) 1998, 1999, 2000 Thai Open Source Software + Center Ltd and Clark Cooper; Copyright (c) 2001, 2002, 2003, + 2004, 2005, 2006 Expat maintainers. + + + + + + &product-name; contains portions of Fontconfig which is + governed by the license in + and + + + + Copyright (C) 2001, 2003 Keith Packard + + + + + + &product-name; contains portions of Freetype which is governed + by the license in + and + + + + Copyright 2012 The FreeType Project (www.freetype.org). All + rights reserved. + + + + + + &product-name; may contain code from the WebM VP8 Codec SDK + which is governed by the license in + and + + + + Copyright (c) 2010, The WebM Project authors. All rights + reserved. + + + + + + &product-name; may contain code from libopus ("Opus") which is + governed by the license in + and + + + + Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, + Jean-Marc Valin, Timothy B. Terriberry, CSIRO, Gregory + Maxwell, Mark Borgerding, Erik de Castro Lopo + + + + + + &product-name; may contain portions of FUSE for macOS which is + governed by the licenses in + and + and + + + + Copyright (c) 2011-2017 Benjamin Fleischer; Copyright (c) + 2011-2012 Erik Larsson All rights reserved. + + + + + + + + + + Third-Party Licenses + + + + GNU General Public License (GPL) + + + GNU GENERAL PUBLIC LICENSE Version 2, June 1991 + + + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + + + + 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + + + + Everyone is permitted to copy and distribute verbatim copies of + this license document, but changing it is not allowed. + + + + Preamble + + + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General + Public License is intended to guarantee your freedom to share + and change free software--to make sure the software is free for + all its users. This General Public License applies to most of + the Free Software Foundation's software and to any other program + whose authors commit to using it. (Some other Free Software + Foundation software is covered by the GNU Library General Public + License instead.) You can apply it to your programs, too. + + + + When we speak of free software, we are referring to freedom, not + price. Our General Public Licenses are designed to make sure + that you have the freedom to distribute copies of free software + (and charge for this service if you wish), that you receive + source code or can get it if you want it, that you can change + the software or use pieces of it in new free programs; and that + you know you can do these things. + + + + To protect your rights, we need to make restrictions that forbid + anyone to deny you these rights or to ask you to surrender the + rights. These restrictions translate to certain responsibilities + for you if you distribute copies of the software, or if you + modify it. + + + + For example, if you distribute copies of such a program, whether + gratis or for a fee, you must give the recipients all the rights + that you have. You must make sure that they, too, receive or can + get the source code. And you must show them these terms so they + know their rights. + + + + We protect your rights with two steps: (1) copyright the + software, and (2) offer you this license which gives you legal + permission to copy, distribute and/or modify the software. + + + + Also, for each author's protection and ours, we want to make + certain that everyone understands that there is no warranty for + this free software. If the software is modified by someone else + and passed on, we want its recipients to know that what they + have is not the original, so that any problems introduced by + others will not reflect on the original authors' reputations. + + + + Finally, any free program is threatened constantly by software + patents. We wish to avoid the danger that redistributors of a + free program will individually obtain patent licenses, in effect + making the program proprietary. To prevent this, we have made it + clear that any patent must be licensed for everyone's free use + or not licensed at all. + + + + The precise terms and conditions for copying, distribution and + modification follow. + + + + GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, + DISTRIBUTION AND MODIFICATION + + + + 0. This License applies to any program or other work which + contains a notice placed by the copyright holder saying it may + be distributed under the terms of this General Public License. + The "Program", below, refers to any such program or work, and a + "work based on the Program" means either the Program or any + derivative work under copyright law: that is to say, a work + containing the Program or a portion of it, either verbatim or + with modifications and/or translated into another language. + (Hereinafter, translation is included without limitation in the + term "modification".) Each licensee is addressed as "you". + + + + Activities other than copying, distribution and modification are + not covered by this License; they are outside its scope. The act + of running the Program is not restricted, and the output from + the Program is covered only if its contents constitute a work + based on the Program (independent of having been made by running + the Program). Whether that is true depends on what the Program + does. + + + + 1. You may copy and distribute verbatim copies of the Program's + source code as you receive it, in any medium, provided that you + conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep + intact all the notices that refer to this License and to the + absence of any warranty; and give any other recipients of the + Program a copy of this License along with the Program. + + + + You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + + + + 2. You may modify your copy or copies of the Program or any + portion of it, thus forming a work based on the Program, and + copy and distribute such modifications or work under the terms + of Section 1 above, provided that you also meet all of these + conditions: + + + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + + + b) You must cause any work that you distribute or publish, that + in whole or in part contains or is derived from the Program or + any part thereof, to be licensed as a whole at no charge to all + third parties under the terms of this License. + + + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you + provide a warranty) and that users may redistribute the program + under these conditions, and telling the user how to view a copy + of this License. (Exception: if the Program itself is + interactive but does not normally print such an announcement, + your work based on the Program is not required to print an + announcement.) + + + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the + Program, and can be reasonably considered independent and + separate works in themselves, then this License, and its terms, + do not apply to those sections when you distribute them as + separate works. But when you distribute the same sections as + part of a whole which is a work based on the Program, the + distribution of the whole must be on the terms of this License, + whose permissions for other licensees extend to the entire + whole, and thus to each and every part regardless of who wrote + it. + + + + Thus, it is not the intent of this section to claim rights or + contest your rights to work written entirely by you; rather, the + intent is to exercise the right to control the distribution of + derivative or collective works based on the Program. + + + + In addition, mere aggregation of another work not based on the + Program with the Program (or with a work based on the Program) + on a volume of a storage or distribution medium does not bring + the other work under the scope of this License. + + + + 3. You may copy and distribute the Program (or a work based on + it, under Section 2) in object code or executable form under the + terms of Sections 1 and 2 above provided that you also do one of + the following: + + + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Sections 1 and 2 above on a medium customarily used for software + interchange; or, + + + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a + medium customarily used for software interchange; or, + + + + c) Accompany it with the information you received as to the + offer to distribute corresponding source code. (This alternative + is allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + + + + The source code for a work means the preferred form of the work + for making modifications to it. For an executable work, complete + source code means all the source code for all modules it + contains, plus any associated interface definition files, plus + the scripts used to control compilation and installation of the + executable. However, as a special exception, the source code + distributed need not include anything that is normally + distributed (in either source or binary form) with the major + components (compiler, kernel, and so on) of the operating system + on which the executable runs, unless that component itself + accompanies the executable. + + + + If distribution of executable or object code is made by offering + access to copy from a designated place, then offering equivalent + access to copy the source code from the same place counts as + distribution of the source code, even though third parties are + not compelled to copy the source along with the object code. + + + + 4. You may not copy, modify, sublicense, or distribute the + Program except as expressly provided under this License. Any + attempt otherwise to copy, modify, sublicense or distribute the + Program is void, and will automatically terminate your rights + under this License. However, parties who have received copies, + or rights, from you under this License will not have their + licenses terminated so long as such parties remain in full + compliance. + + + + 5. You are not required to accept this License, since you have + not signed it. However, nothing else grants you permission to + modify or distribute the Program or its derivative works. These + actions are prohibited by law if you do not accept this License. + Therefore, by modifying or distributing the Program (or any work + based on the Program), you indicate your acceptance of this + License to do so, and all its terms and conditions for copying, + distributing or modifying the Program or works based on it. + + + + 6. Each time you redistribute the Program (or any work based on + the Program), the recipient automatically receives a license + from the original licensor to copy, distribute or modify the + Program subject to these terms and conditions. You may not + impose any further restrictions on the recipients' exercise of + the rights granted herein. You are not responsible for enforcing + compliance by third parties to this License. + + + + 7. If, as a consequence of a court judgment or allegation of + patent infringement or for any other reason (not limited to + patent issues), conditions are imposed on you (whether by court + order, agreement or otherwise) that contradict the conditions of + this License, they do not excuse you from the conditions of this + License. If you cannot distribute so as to satisfy + simultaneously your obligations under this License and any other + pertinent obligations, then as a consequence you may not + distribute the Program at all. For example, if a patent license + would not permit royalty-free redistribution of the Program by + all those who receive copies directly or indirectly through you, + then the only way you could satisfy both it and this License + would be to refrain entirely from distribution of the Program. + + + + If any portion of this section is held invalid or unenforceable + under any particular circumstance, the balance of the section is + intended to apply and the section as a whole is intended to + apply in other circumstances. + + + + It is not the purpose of this section to induce you to infringe + any patents or other property right claims or to contest + validity of any such claims; this section has the sole purpose + of protecting the integrity of the free software distribution + system, which is implemented by public license practices. Many + people have made generous contributions to the wide range of + software distributed through that system in reliance on + consistent application of that system; it is up to the + author/donor to decide if he or she is willing to distribute + software through any other system and a licensee cannot impose + that choice. + + + + This section is intended to make thoroughly clear what is + believed to be a consequence of the rest of this License. + + + + 8. If the distribution and/or use of the Program is restricted + in certain countries either by patents or by copyrighted + interfaces, the original copyright holder who places the Program + under this License may add an explicit geographical distribution + limitation excluding those countries, so that distribution is + permitted only in or among countries not thus excluded. In such + case, this License incorporates the limitation as if written in + the body of this License. + + + + 9. The Free Software Foundation may publish revised and/or new + versions of the General Public License from time to time. Such + new versions will be similar in spirit to the present version, + but may differ in detail to address new problems or concerns. + + + + Each version is given a distinguishing version number. If the + Program specifies a version number of this License which applies + to it and "any later version", you have the option of following + the terms and conditions either of that version or of any later + version published by the Free Software Foundation. If the + Program does not specify a version number of this License, you + may choose any version ever published by the Free Software + Foundation. + + + + 10. If you wish to incorporate parts of the Program into other + free programs whose distribution conditions are different, write + to the author to ask for permission. For software which is + copyrighted by the Free Software Foundation, write to the Free + Software Foundation; we sometimes make exceptions for this. Our + decision will be guided by the two goals of preserving the free + status of all derivatives of our free software and of promoting + the sharing and reuse of software generally. + + + + NO WARRANTY + + + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE + LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT + WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY + AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE + QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE + PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY + SERVICING, REPAIR OR CORRECTION. + + + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO + IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY + MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE + LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, + INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR + INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS + OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY + YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH + ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + + + END OF TERMS AND CONDITIONS + + + + + + + GNU Lesser General Public License (LGPL) + + + GNU LESSER GENERAL PUBLIC LICENSE Version 2.1, February 1999 + + + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. 59 + Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is + permitted to copy and distribute verbatim copies of this license + document, but changing it is not allowed. + + + + [This is the first released version of the Lesser GPL. It also + counts as the successor of the GNU Library Public License, + version 2, hence the version number 2.1.] + + + + Preamble + + + + The licenses for most software are designed to take away your + freedom to share and change it. By contrast, the GNU General + Public Licenses are intended to guarantee your freedom to share + and change free software--to make sure the software is free for + all its users. + + + + This license, the Lesser General Public License, applies to some + specially designated software packages--typically libraries--of + the Free Software Foundation and other authors who decide to use + it. You can use it too, but we suggest you first think carefully + about whether this license or the ordinary General Public + License is the better strategy to use in any particular case, + based on the explanations below. + + + + When we speak of free software, we are referring to freedom of + use, not price. Our General Public Licenses are designed to make + sure that you have the freedom to distribute copies of free + software (and charge for this service if you wish); that you + receive source code or can get it if you want it; that you can + change the software and use pieces of it in new free programs; + and that you are informed that you can do these things. + + + + To protect your rights, we need to make restrictions that forbid + distributors to deny you these rights or to ask you to surrender + these rights. These restrictions translate to certain + responsibilities for you if you distribute copies of the library + or if you modify it. + + + + For example, if you distribute copies of the library, whether + gratis or for a fee, you must give the recipients all the rights + that we gave you. You must make sure that they, too, receive or + can get the source code. If you link other code with the + library, you must provide complete object files to the + recipients, so that they can relink them with the library after + making changes to the library and recompiling it. And you must + show them these terms so they know their rights. + + + + We protect your rights with a two-step method: (1) we copyright + the library, and (2) we offer you this license, which gives you + legal permission to copy, distribute and/or modify the library. + + + + To protect each distributor, we want to make it very clear that + there is no warranty for the free library. Also, if the library + is modified by someone else and passed on, the recipients should + know that what they have is not the original version, so that + the original author's reputation will not be affected by + problems that might be introduced by others. + + + + Finally, software patents pose a constant threat to the + existence of any free program. We wish to make sure that a + company cannot effectively restrict the users of a free program + by obtaining a restrictive license from a patent holder. + Therefore, we insist that any patent license obtained for a + version of the library must be consistent with the full freedom + of use specified in this license. + + + + Most GNU software, including some libraries, is covered by the + ordinary GNU General Public License. This license, the GNU + Lesser General Public License, applies to certain designated + libraries, and is quite different from the ordinary General + Public License. We use this license for certain libraries in + order to permit linking those libraries into non-free programs. + + + + When a program is linked with a library, whether statically or + using a shared library, the combination of the two is legally + speaking a combined work, a derivative of the original library. + The ordinary General Public License therefore permits such + linking only if the entire combination fits its criteria of + freedom. The Lesser General Public License permits more lax + criteria for linking other code with the library. + + + + We call this license the "Lesser" General Public License because + it does Less to protect the user's freedom than the ordinary + General Public License. It also provides other free software + developers Less of an advantage over competing non-free + programs. These disadvantages are the reason we use the ordinary + General Public License for many libraries. However, the Lesser + license provides advantages in certain special circumstances. + + + + For example, on rare occasions, there may be a special need to + encourage the widest possible use of a certain library, so that + it becomes a de-facto standard. To achieve this, non-free + programs must be allowed to use the library. A more frequent + case is that a free library does the same job as widely used + non-free libraries. In this case, there is little to gain by + limiting the free library to free software only, so we use the + Lesser General Public License. + + + + In other cases, permission to use a particular library in + non-free programs enables a greater number of people to use a + large body of free software. For example, permission to use the + GNU C Library in non-free programs enables many more people to + use the whole GNU operating system, as well as its variant, the + GNU/Linux operating system. + + + + Although the Lesser General Public License is Less protective of + the users' freedom, it does ensure that the user of a program + that is linked with the Library has the freedom and the + wherewithal to run that program using a modified version of the + Library. + + + + The precise terms and conditions for copying, distribution and + modification follow. Pay close attention to the difference + between a "work based on the library" and a "work that uses the + library". The former contains code derived from the library, + whereas the latter must be combined with the library in order to + run. + + + + GNU LESSER GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR + COPYING, DISTRIBUTION AND MODIFICATION + + + + 0. This License Agreement applies to any software library or + other program which contains a notice placed by the copyright + holder or other authorized party saying it may be distributed + under the terms of this Lesser General Public License (also + called "this License"). Each licensee is addressed as "you". + + + + A "library" means a collection of software functions and/or data + prepared so as to be conveniently linked with application + programs (which use some of those functions and data) to form + executables. + + + + The "Library", below, refers to any such software library or + work which has been distributed under these terms. A "work based + on the Library" means either the Library or any derivative work + under copyright law: that is to say, a work containing the + Library or a portion of it, either verbatim or with + modifications and/or translated straightforwardly into another + language. (Hereinafter, translation is included without + limitation in the term "modification".) + + + + "Source code" for a work means the preferred form of the work + for making modifications to it. For a library, complete source + code means all the source code for all modules it contains, plus + any associated interface definition files, plus the scripts used + to control compilation and installation of the library. + + + + Activities other than copying, distribution and modification are + not covered by this License; they are outside its scope. The act + of running a program using the Library is not restricted, and + output from such a program is covered only if its contents + constitute a work based on the Library (independent of the use + of the Library in a tool for writing it). Whether that is true + depends on what the Library does and what the program that uses + the Library does. + + + + 1. You may copy and distribute verbatim copies of the Library's + complete source code as you receive it, in any medium, provided + that you conspicuously and appropriately publish on each copy an + appropriate copyright notice and disclaimer of warranty; keep + intact all the notices that refer to this License and to the + absence of any warranty; and distribute a copy of this License + along with the Library. + + + + You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + + + + 2. You may modify your copy or copies of the Library or any + portion of it, thus forming a work based on the Library, and + copy and distribute such modifications or work under the terms + of Section 1 above, provided that you also meet all of these + conditions: + + + + a) The modified work must itself be a software library. + + + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + + + d) If a facility in the modified Library refers to a function or + a table of data to be supplied by an application program that + uses the facility, other than as an argument passed when the + facility is invoked, then you must make a good faith effort to + ensure that, in the event an application does not supply such + function or table, the facility still operates, and performs + whatever part of its purpose remains meaningful. + + + + (For example, a function in a library to compute square roots + has a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function + must be optional: if the application does not supply it, the + square root function must still compute square roots.) + + + + These requirements apply to the modified work as a whole. If + identifiable sections of that work are not derived from the + Library, and can be reasonably considered independent and + separate works in themselves, then this License, and its terms, + do not apply to those sections when you distribute them as + separate works. But when you distribute the same sections as + part of a whole which is a work based on the Library, the + distribution of the whole must be on the terms of this License, + whose permissions for other licensees extend to the entire + whole, and thus to each and every part regardless of who wrote + it. + + + + Thus, it is not the intent of this section to claim rights or + contest your rights to work written entirely by you; rather, the + intent is to exercise the right to control the distribution of + derivative or collective works based on the Library. + + + + In addition, mere aggregation of another work not based on the + Library with the Library (or with a work based on the Library) + on a volume of a storage or distribution medium does not bring + the other work under the scope of this License. + + + + 3. You may opt to apply the terms of the ordinary GNU General + Public License instead of this License to a given copy of the + Library. To do this, you must alter all the notices that refer + to this License, so that they refer to the ordinary GNU General + Public License, version 2, instead of to this License. (If a + newer version than version 2 of the ordinary GNU General Public + License has appeared, then you can specify that version instead + if you wish.) Do not make any other change in these notices. + + + + Once this change is made in a given copy, it is irreversible for + that copy, so the ordinary GNU General Public License applies to + all subsequent copies and derivative works made from that copy. + + + + This option is useful when you wish to copy part of the code of + the Library into a program that is not a library. + + + + 4. You may copy and distribute the Library (or a portion or + derivative of it, under Section 2) in object code or executable + form under the terms of Sections 1 and 2 above provided that you + accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Sections 1 and 2 above on a medium customarily used for software + interchange. + + + + If distribution of object code is made by offering access to + copy from a designated place, then offering equivalent access to + copy the source code from the same place satisfies the + requirement to distribute the source code, even though third + parties are not compelled to copy the source along with the + object code. + + + + 5. A program that contains no derivative of any portion of the + Library, but is designed to work with the Library by being + compiled or linked with it, is called a "work that uses the + Library". Such a work, in isolation, is not a derivative work of + the Library, and therefore falls outside the scope of this + License. + + + + However, linking a "work that uses the Library" with the Library + creates an executable that is a derivative of the Library + (because it contains portions of the Library), rather than a + "work that uses the library". The executable is therefore + covered by this License. Section 6 states terms for distribution + of such executables. + + + + When a "work that uses the Library" uses material from a header + file that is part of the Library, the object code for the work + may be a derivative work of the Library even though the source + code is not. Whether this is true is especially significant if + the work can be linked without the Library, or if the work is + itself a library. The threshold for this to be true is not + precisely defined by law. + + + + If such an object file uses only numerical parameters, data + structure layouts and accessors, and small macros and small + inline functions (ten lines or less in length), then the use of + the object file is unrestricted, regardless of whether it is + legally a derivative work. (Executables containing this object + code plus portions of the Library will still fall under Section + 6.) Otherwise, if the work is a derivative of the Library, you + may distribute the object code for the work under the terms of + Section 6. Any executables containing that work also fall under + Section 6, whether or not they are linked directly with the + Library itself. + + + + 6. As an exception to the Sections above, you may also combine + or link a "work that uses the Library" with the Library to + produce a work containing portions of the Library, and + distribute that work under terms of your choice, provided that + the terms permit modification of the work for the customer's own + use and reverse engineering for debugging such modifications. + + + + You must give prominent notice with each copy of the work that + the Library is used in it and that the Library and its use are + covered by this License. You must supply a copy of this License. + If the work during execution displays copyright notices, you + must include the copyright notice for the Library among them, as + well as a reference directing the user to the copy of this + License. Also, you must do one of these things: + + + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable + linked with the Library, with the complete machine-readable + "work that uses the Library", as object code and/or source code, + so that the user can modify the Library and then relink to + produce a modified executable containing the modified Library. + (It is understood that the user who changes the contents of + definitions files in the Library will not necessarily be able to + recompile the application to use the modified definitions.) + + + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer + system, rather than copying library functions into the + executable, and (2) will operate properly with a modified + version of the library, if the user installs one, as long as the + modified version is interface-compatible with the version that + the work was made with. + + + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + + + d) If distribution of the work is made by offering access to + copy from a designated place, offer equivalent access to copy + the above specified materials from the same place. + + + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + + + For an executable, the required form of the "work that uses the + Library" must include any data and utility programs needed for + reproducing the executable from it. However, as a special + exception, the materials to be distributed need not include + anything that is normally distributed (in either source or + binary form) with the major components (compiler, kernel, and so + on) of the operating system on which the executable runs, unless + that component itself accompanies the executable. + + + + It may happen that this requirement contradicts the license + restrictions of other proprietary libraries that do not normally + accompany the operating system. Such a contradiction means you + cannot use both them and the Library together in an executable + that you distribute. + + + + 7. You may place library facilities that are a work based on the + Library side-by-side in a single library together with other + library facilities not covered by this License, and distribute + such a combined library, provided that the separate distribution + of the work based on the Library and of the other library + facilities is otherwise permitted, and provided that you do + these two things: + + + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + + + 8. You may not copy, modify, sublicense, link with, or + distribute the Library except as expressly provided under this + License. Any attempt otherwise to copy, modify, sublicense, link + with, or distribute the Library is void, and will automatically + terminate your rights under this License. However, parties who + have received copies, or rights, from you under this License + will not have their licenses terminated so long as such parties + remain in full compliance. + + + + 9. You are not required to accept this License, since you have + not signed it. However, nothing else grants you permission to + modify or distribute the Library or its derivative works. These + actions are prohibited by law if you do not accept this License. + Therefore, by modifying or distributing the Library (or any work + based on the Library), you indicate your acceptance of this + License to do so, and all its terms and conditions for copying, + distributing or modifying the Library or works based on it. + + + + 10. Each time you redistribute the Library (or any work based on + the Library), the recipient automatically receives a license + from the original licensor to copy, distribute, link with or + modify the Library subject to these terms and conditions. You + may not impose any further restrictions on the recipients' + exercise of the rights granted herein. You are not responsible + for enforcing compliance by third parties with this License. + + + + 11. If, as a consequence of a court judgment or allegation of + patent infringement or for any other reason (not limited to + patent issues), conditions are imposed on you (whether by court + order, agreement or otherwise) that contradict the conditions of + this License, they do not excuse you from the conditions of this + License. If you cannot distribute so as to satisfy + simultaneously your obligations under this License and any other + pertinent obligations, then as a consequence you may not + distribute the Library at all. For example, if a patent license + would not permit royalty-free redistribution of the Library by + all those who receive copies directly or indirectly through you, + then the only way you could satisfy both it and this License + would be to refrain entirely from distribution of the Library. + + + + If any portion of this section is held invalid or unenforceable + under any particular circumstance, the balance of the section is + intended to apply, and the section as a whole is intended to + apply in other circumstances. + + + + It is not the purpose of this section to induce you to infringe + any patents or other property right claims or to contest + validity of any such claims; this section has the sole purpose + of protecting the integrity of the free software distribution + system which is implemented by public license practices. Many + people have made generous contributions to the wide range of + software distributed through that system in reliance on + consistent application of that system; it is up to the + author/donor to decide if he or she is willing to distribute + software through any other system and a licensee cannot impose + that choice. + + + + This section is intended to make thoroughly clear what is + believed to be a consequence of the rest of this License. + + + + 12. If the distribution and/or use of the Library is restricted + in certain countries either by patents or by copyrighted + interfaces, the original copyright holder who places the Library + under this License may add an explicit geographical distribution + limitation excluding those countries, so that distribution is + permitted only in or among countries not thus excluded. In such + case, this License incorporates the limitation as if written in + the body of this License. + + + + 13. The Free Software Foundation may publish revised and/or new + versions of the Lesser General Public License from time to time. + Such new versions will be similar in spirit to the present + version, but may differ in detail to address new problems or + concerns. + + + + Each version is given a distinguishing version number. If the + Library specifies a version number of this License which applies + to it and "any later version", you have the option of following + the terms and conditions either of that version or of any later + version published by the Free Software Foundation. If the + Library does not specify a license version number, you may + choose any version ever published by the Free Software + Foundation. + + + + 14. If you wish to incorporate parts of the Library into other + free programs whose distribution conditions are incompatible + with these, write to the author to ask for permission. For + software which is copyrighted by the Free Software Foundation, + write to the Free Software Foundation; we sometimes make + exceptions for this. Our decision will be guided by the two + goals of preserving the free status of all derivatives of our + free software and of promoting the sharing and reuse of software + generally. + + + + NO WARRANTY + + + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO + WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE + LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT + HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT + WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY + AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE + QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE + LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY + SERVICING, REPAIR OR CORRECTION. + + + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO + IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY + MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE + LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, + INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR + INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS + OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY + YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH + ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + + + + END OF TERMS AND CONDITIONS + + + + + + + Mozilla Public License (MPL) + + + MOZILLA PUBLIC LICENSE Version 1.1 + + + + 1. Definitions. + + + + 1.0.1. "Commercial Use" means distribution or otherwise making + the Covered Code available to a third party. + + + + 1.1. "Contributor" means each entity that creates or contributes + to the creation of Modifications. + + + + 1.2. "Contributor Version" means the combination of the Original + Code, prior Modifications used by a Contributor, and the + Modifications made by that particular Contributor. + + + + 1.3. "Covered Code" means the Original Code or Modifications or + the combination of the Original Code and Modifications, in each + case including portions thereof. + + + + 1.4. "Electronic Distribution Mechanism" means a mechanism + generally accepted in the software development community for the + electronic transfer of data. + + + + 1.5. "Executable" means Covered Code in any form other than + Source Code. + + + + 1.6. "Initial Developer" means the individual or entity + identified as the Initial Developer in the Source Code notice + required by Exhibit A. + + + + 1.7. "Larger Work" means a work which combines Covered Code or + portions thereof with code not governed by the terms of this + License. + + + + 1.8. "License" means this document. + + + + 1.8.1. "Licensable" means having the right to grant, to the + maximum extent possible, whether at the time of the initial + grant or subsequently acquired, any and all of the rights + conveyed herein. + + + + 1.9. "Modifications" means any addition to or deletion from the + substance or structure of either the Original Code or any + previous Modifications. When Covered Code is released as a + series of files, a Modification is: + + + + A. Any addition to or deletion from the contents of a file + containing Original Code or previous Modifications. + + + + B. Any new file that contains any part of the Original Code or + previous Modifications. + + + + 1.10. "Original Code" means Source Code of computer software + code which is described in the Source Code notice required by + Exhibit A as Original Code, and which, at the time of its + release under this License is not already Covered Code governed + by this License. + + + + 1.10.1. "Patent Claims" means any patent claim(s), now owned or + hereafter acquired, including without limitation, method, + process, and apparatus claims, in any patent Licensable by + grantor. + + + + 1.11. "Source Code" means the preferred form of the Covered Code + for making modifications to it, including all modules it + contains, plus any associated interface definition files, + scripts used to control compilation and installation of an + Executable, or source code differential comparisons against + either the Original Code or another well known, available + Covered Code of the Contributor's choice. The Source Code can be + in a compressed or archival form, provided the appropriate + decompression or de-archiving software is widely available for + no charge. + + + + 1.12. "You" (or "Your") means an individual or a legal entity + exercising rights under, and complying with all of the terms of, + this License or a future version of this License issued under + Section 6.1. For legal entities, "You" includes any entity which + controls, is controlled by, or is under common control with You. + For purposes of this definition, "control" means (a) the power, + direct or indirect, to cause the direction or management of such + entity, whether by contract or otherwise, or (b) ownership of + more than fifty percent (50%) of the outstanding shares or + beneficial ownership of such entity. + + + + 2. Source Code License. + + + + 2.1. The Initial Developer Grant. The Initial Developer hereby + grants You a world-wide, royalty-free, non-exclusive license, + subject to third party intellectual property claims: + + + + (a) under intellectual property rights (other than patent or + trademark) Licensable by Initial Developer to use, reproduce, + modify, display, perform, sublicense and distribute the Original + Code (or portions thereof) with or without Modifications, and/or + as part of a Larger Work; and + + + + (b) under Patents Claims infringed by the making, using or + selling of Original Code, to make, have made, use, practice, + sell, and offer for sale, and/or otherwise dispose of the + Original Code (or portions thereof). + + + + (c) the licenses granted in this Section 2.1(a) and (b) are + effective on the date Initial Developer first distributes + Original Code under the terms of this License. + + + + (d) Notwithstanding Section 2.1(b) above, no patent license is + granted: 1) for code that You delete from the Original Code; 2) + separate from the Original Code; or 3) for infringements caused + by: i) the modification of the Original Code or ii) the + combination of the Original Code with other software or devices. + + + + 2.2. Contributor Grant. Subject to third party intellectual + property claims, each Contributor hereby grants You a + world-wide, royalty-free, non-exclusive license + + + + (a) under intellectual property rights (other than patent or + trademark) Licensable by Contributor, to use, reproduce, modify, + display, perform, sublicense and distribute the Modifications + created by such Contributor (or portions thereof) either on an + unmodified basis, with other Modifications, as Covered Code + and/or as part of a Larger Work; and + + + + (b) under Patent Claims infringed by the making, using, or + selling of Modifications made by that Contributor either alone + and/or in combination with its Contributor Version (or portions + of such combination), to make, use, sell, offer for sale, have + made, and/or otherwise dispose of: 1) Modifications made by that + Contributor (or portions thereof); and 2) the combination of + Modifications made by that Contributor with its Contributor + Version (or portions of such combination). + + + + (c) the licenses granted in Sections 2.2(a) and 2.2(b) are + effective on the date Contributor first makes Commercial Use of + the Covered Code. + + + + (d) Notwithstanding Section 2.2(b) above, no patent license is + granted: 1) for any code that Contributor has deleted from the + Contributor Version; 2) separate from the Contributor Version; + 3) for infringements caused by: i) third party modifications of + Contributor Version or ii) the combination of Modifications made + by that Contributor with other software (except as part of the + Contributor Version) or other devices; or 4) under Patent Claims + infringed by Covered Code in the absence of Modifications made + by that Contributor. + + + + 3. Distribution Obligations. + + + + 3.1. Application of License. The Modifications which You create + or to which You contribute are governed by the terms of this + License, including without limitation Section 2.2. The Source + Code version of Covered Code may be distributed only under the + terms of this License or a future version of this License + released under Section 6.1, and You must include a copy of this + License with every copy of the Source Code You distribute. You + may not offer or impose any terms on any Source Code version + that alters or restricts the applicable version of this License + or the recipients' rights hereunder. However, You may include an + additional document offering the additional rights described in + Section 3.5. + + + + 3.2. Availability of Source Code. Any Modification which You + create or to which You contribute must be made available in + Source Code form under the terms of this License either on the + same media as an Executable version or via an accepted + Electronic Distribution Mechanism to anyone to whom you made an + Executable version available; and if made available via + Electronic Distribution Mechanism, must remain available for at + least twelve (12) months after the date it initially became + available, or at least six (6) months after a subsequent version + of that particular Modification has been made available to such + recipients. You are responsible for ensuring that the Source + Code version remains available even if the Electronic + Distribution Mechanism is maintained by a third party. + + + + 3.3. Description of Modifications. You must cause all Covered + Code to which You contribute to contain a file documenting the + changes You made to create that Covered Code and the date of any + change. You must include a prominent statement that the + Modification is derived, directly or indirectly, from Original + Code provided by the Initial Developer and including the name of + the Initial Developer in (a) the Source Code, and (b) in any + notice in an Executable version or related documentation in + which You describe the origin or ownership of the Covered Code. + + + + 3.4. Intellectual Property Matters + + + + (a) Third Party Claims. If Contributor has knowledge that a + license under a third party's intellectual property rights is + required to exercise the rights granted by such Contributor + under Sections 2.1 or 2.2, Contributor must include a text file + with the Source Code distribution titled "LEGAL" which describes + the claim and the party making the claim in sufficient detail + that a recipient will know whom to contact. If Contributor + obtains such knowledge after the Modification is made available + as described in Section 3.2, Contributor shall promptly modify + the LEGAL file in all copies Contributor makes available + thereafter and shall take other steps (such as notifying + appropriate mailing lists or newsgroups) reasonably calculated + to inform those who received the Covered Code that new knowledge + has been obtained. + + + + (b) Contributor APIs. If Contributor's Modifications include an + application programming interface and Contributor has knowledge + of patent licenses which are reasonably necessary to implement + that API, Contributor must also include this information in the + LEGAL file. + + + + 3.5. Required Notices. You must duplicate the notice in Exhibit + A in each file of the Source Code. If it is not possible to put + such notice in a particular Source Code file due to its + structure, then You must include such notice in a location (such + as a relevant directory) where a user would be likely to look + for such a notice. If You created one or more Modification(s) + You may add your name as a Contributor to the notice described + in Exhibit A. You must also duplicate this License in any + documentation for the Source Code where You describe recipients' + rights or ownership rights relating to Covered Code. You may + choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of + Covered Code. However, You may do so only on Your own behalf, + and not on behalf of the Initial Developer or any Contributor. + You must make it absolutely clear than any such warranty, + support, indemnity or liability obligation is offered by You + alone, and You hereby agree to indemnify the Initial Developer + and every Contributor for any liability incurred by the Initial + Developer or such Contributor as a result of warranty, support, + indemnity or liability terms You offer. + + + + 3.6. Distribution of Executable Versions. You may distribute + Covered Code in Executable form only if the requirements of + Section 3.1-3.5 have been met for that Covered Code, and if You + include a notice stating that the Source Code version of the + Covered Code is available under the terms of this License, + including a description of how and where You have fulfilled the + obligations of Section 3.2. The notice must be conspicuously + included in any notice in an Executable version, related + documentation or collateral in which You describe recipients' + rights relating to the Covered Code. You may distribute the + Executable version of Covered Code or ownership rights under a + license of Your choice, which may contain terms different from + this License, provided that You are in compliance with the terms + of this License and that the license for the Executable version + does not attempt to limit or alter the recipient's rights in the + Source Code version from the rights set forth in this License. + If You distribute the Executable version under a different + license You must make it absolutely clear that any terms which + differ from this License are offered by You alone, not by the + Initial Developer or any Contributor. You hereby agree to + indemnify the Initial Developer and every Contributor for any + liability incurred by the Initial Developer or such Contributor + as a result of any such terms You offer. + + + + 3.7. Larger Works. You may create a Larger Work by combining + Covered Code with other code not governed by the terms of this + License and distribute the Larger Work as a single product. In + such a case, You must make sure the requirements of this License + are fulfilled for the Covered Code. + + + + 4. Inability to Comply Due to Statute or Regulation.If it is + impossible for You to comply with any of the terms of this + License with respect to some or all of the Covered Code due to + statute, judicial order, or regulation then You must: (a) comply + with the terms of this License to the maximum extent possible; + and (b) describe the limitations and the code they affect. Such + description must be included in the LEGAL file described in + Section 3.4 and must be included with all distributions of the + Source Code. Except to the extent prohibited by statute or + regulation, such description must be sufficiently detailed for a + recipient of ordinary skill to be able to understand it. + + + + 5. Application of this License. This License applies to code to + which the Initial Developer has attached the notice in Exhibit A + and to related Covered Code. + + + + 6. Versions of the License. + + + + 6.1. New Versions. Netscape Communications Corporation + ("Netscape") may publish revised and/or new versions of the + License from time to time. Each version will be given a + distinguishing version number. + + + + 6.2. Effect of New Versions. Once Covered Code has been + published under a particular version of the License, You may + always continue to use it under the terms of that version. You + may also choose to use such Covered Code under the terms of any + subsequent version of the License published by Netscape. No one + other than Netscape has the right to modify the terms applicable + to Covered Code created under this License. + + + + 6.3. Derivative Works. If You create or use a modified version + of this License (which you may only do in order to apply it to + code which is not already Covered Code governed by this + License), You must (a) rename Your license so that the phrases + "Mozilla", "MOZILLAPL", "MOZPL", "Netscape", "MPL", "NPL" or any + confusingly similar phrase do not appear in your license (except + to note that your license differs from this License) and (b) + otherwise make it clear that Your version of the license + contains terms which differ from the Mozilla Public License and + Netscape Public License. (Filling in the name of the Initial + Developer, Original Code or Contributor in the notice described + in Exhibit A shall not of themselves be deemed to be + modifications of this License.) + + + + 7. DISCLAIMER OF WARRANTY. + + + + COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, + INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE COVERED CODE + IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE + OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY AND + PERFORMANCE OF THE COVERED CODE IS WITH YOU. SHOULD ANY COVERED + CODE PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL + DEVELOPER OR ANY OTHER CONTRIBUTOR) ASSUME THE COST OF ANY + NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF + WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE + OF ANY COVERED CODE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS + DISCLAIMER. + + + + 8. TERMINATION. + + + + 8.1. This License and the rights granted hereunder will + terminate automatically if You fail to comply with terms herein + and fail to cure such breach within 30 days of becoming aware of + the breach. All sublicenses to the Covered Code which are + properly granted shall survive any termination of this License. + Provisions which, by their nature, must remain in effect beyond + the termination of this License shall survive. + + + + 8.2. If You initiate litigation by asserting a patent + infringement claim (excluding declaratory judgment actions) + against Initial Developer or a Contributor (the Initial + Developer or Contributor against whom You file such action is + referred to as "Participant") alleging that: + + + + (a) such Participant's Contributor Version directly or + indirectly infringes any patent, then any and all rights granted + by such Participant to You under Sections 2.1 and/or 2.2 of this + License shall, upon 60 days notice from Participant terminate + prospectively, unless if within 60 days after receipt of notice + You either: (i) agree in writing to pay Participant a mutually + agreeable reasonable royalty for Your past and future use of + Modifications made by such Participant, or (ii) withdraw Your + litigation claim with respect to the Contributor Version against + such Participant. If within 60 days of notice, a reasonable + royalty and payment arrangement are not mutually agreed upon in + writing by the parties or the litigation claim is not withdrawn, + the rights granted by Participant to You under Sections 2.1 + and/or 2.2 automatically terminate at the expiration of the 60 + day notice period specified above. + + + + (b) any software, hardware, or device, other than such + Participant's Contributor Version, directly or indirectly + infringes any patent, then any rights granted to You by such + Participant under Sections 2.1(b) and 2.2(b) are revoked + effective as of the date You first made, used, sold, + distributed, or had made, Modifications made by that + Participant. + + + + 8.3. If You assert a patent infringement claim against + Participant alleging that such Participant's Contributor Version + directly or indirectly infringes any patent where such claim is + resolved (such as by license or settlement) prior to the + initiation of patent infringement litigation, then the + reasonable value of the licenses granted by such Participant + under Sections 2.1 or 2.2 shall be taken into account in + determining the amount or value of any payment or license. + + + + 8.4. In the event of termination under Sections 8.1 or 8.2 + above, all end user license agreements (excluding distributors + and resellers) which have been validly granted by You or any + distributor hereunder prior to termination shall survive + termination. + + + + 9. LIMITATION OF LIABILITY. UNDER NO CIRCUMSTANCES AND UNDER NO + LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR + OTHERWISE, SHALL YOU, THE INITIAL DEVELOPER, ANY OTHER + CONTRIBUTOR, OR ANY DISTRIBUTOR OF COVERED CODE, OR ANY SUPPLIER + OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY + INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY + CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF + GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY + AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY + SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES. + THIS LIMITATION OF LIABILITY SHALL NOT APPLY TO LIABILITY FOR + DEATH OR PERSONAL INJURY RESULTING FROM SUCH PARTY'S NEGLIGENCE + TO THE EXTENT APPLICABLE LAW PROHIBITS SUCH LIMITATION. SOME + JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF + INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THIS EXCLUSION AND + LIMITATION MAY NOT APPLY TO YOU. + + + + 10. U.S. GOVERNMENT END USERS. The Covered Code is a "commercial + item," as that term is defined in 48 C.F.R. 2.101 (Oct. 1995), + consisting of "commercial computer software" and "commercial + computer software documentation," as such terms are used in 48 + C.F.R. 12.212 (Sept. 1995). Consistent with 48 C.F.R. 12.212 and + 48 C.F.R. 227.7202-1 through 227.7202-4 (June 1995), all U.S. + Government End Users acquire Covered Code with only those rights + set forth herein. + + + + 11. MISCELLANEOUS. This License represents the complete + agreement concerning subject matter hereof. If any provision of + this License is held to be unenforceable, such provision shall + be reformed only to the extent necessary to make it enforceable. + This License shall be governed by California law provisions + (except to the extent applicable law, if any, provides + otherwise), excluding its conflict-of-law provisions. With + respect to disputes in which at least one party is a citizen of, + or an entity chartered or registered to do business in the + United States of America, any litigation relating to this + License shall be subject to the jurisdiction of the Federal + Courts of the Northern District of California, with venue lying + in Santa Clara County, California, with the losing party + responsible for costs, including without limitation, court costs + and reasonable attorneys' fees and expenses. The application of + the United Nations Convention on Contracts for the International + Sale of Goods is expressly excluded. Any law or regulation which + provides that the language of a contract shall be construed + against the drafter shall not apply to this License. + + + + 12. RESPONSIBILITY FOR CLAIMS. As between Initial Developer and + the Contributors, each party is responsible for claims and + damages arising, directly or indirectly, out of its utilization + of rights under this License and You agree to work with Initial + Developer and Contributors to distribute such responsibility on + an equitable basis. Nothing herein is intended or shall be + deemed to constitute any admission of liability. + + + + 13. MULTIPLE-LICENSED CODE. Initial Developer may designate + portions of the Covered Code as "Multiple-Licensed". + "Multiple-Licensed" means that the Initial Developer permits you + to utilize portions of the Covered Code under Your choice of the + NPL or the alternative licenses, if any, specified by the + Initial Developer in the file described in Exhibit A. + + + + EXHIBIT A -Mozilla Public License. + + + + ``The contents of this file are subject to the Mozilla Public + License Version 1.1 (the "License"); you may not use this file + except in compliance with the License. You may obtain a copy of + the License at http://www.mozilla.org/MPL/ + + + + Software distributed under the License is distributed on an "AS + IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or + implied. See the License for the specific language governing + rights and limitations under the License. + + + + The Original Code is ______________________________________. + + + + The Initial Developer of the Original Code is + ________________________. Portions created by + ______________________ are Copyright (C) ______ + _______________________. All Rights Reserved. + + + + Contributor(s): ______________________________________. + + + + Alternatively, the contents of this file may be used under the + terms of the _____ license (the "[___] License"), in which case + the provisions of [______] License are applicable instead of + those above. If you wish to allow use of your version of this + file only under the terms of the [____] License and not to allow + others to use your version of this file under the MPL, indicate + your decision by deleting the provisions above and replace them + with the notice and other provisions required by the [___] + License. If you do not delete the provisions above, a recipient + may use your version of this file under either the MPL or the + [___] License." + + + + [NOTE: The text of this Exhibit A may differ slightly from the + text of the notices in the Source Code files of the Original + Code. You should use the text of this Exhibit A rather than the + text found in the Original Code Source Code for Your + Modifications.] + + + + + + + MIT License + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + + + + + + + X Consortium License (X11) + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + + + + + + + zlib License + + + This software is provided 'as-is', without any express or + implied warranty. In no event will the authors be held liable + for any damages arising from the use of this software. + + + + Permission is granted to anyone to use this software for any + purpose, including commercial applications, and to alter it and + redistribute it freely, subject to the following restrictions: + + + + 1. The origin of this software must not be misrepresented; you + must not claim that you wrote the original software. If you use + this software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + + + + 2. Altered source versions must be plainly marked as such, and + must not be misrepresented as being the original software. + + + + 3. This notice may not be removed or altered from any source + distribution. + + +Jean-loup Gailly Mark Adler +jloup@gzip.org madler@alumni.caltech.edu + + + + + + OpenSSL License + + + This package is an SSL implementation written by Eric Young + (eay@cryptsoft.com). The implementation was written so as to + conform with Netscape's SSL. + + + + This library is free for commercial and non-commercial use as + long as the following conditions are adhered to. The following + conditions apply to all code found in this distribution, be it + the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The + SSL documentation included with this distribution is covered by + the same copyright terms except that the holder is Tim Hudson + (tjh@cryptsoft.com). + + + + Copyright remains Eric Young's, and as such any Copyright + notices in the code are not to be removed. If this package is + used in a product, Eric Young should be given attribution as the + author of the parts of the library used. This can be in the form + of a textual message at program startup or in documentation + (online or textual) provided with the package. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + 1. Redistributions of source code must retain the copyright + notice, this list of conditions and the following disclaimer. + + + + 2. Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + + + 3. All advertising materials mentioning features or use of this + software must display the following acknowledgement: "This + product includes cryptographic software written by Eric Young + (eay@cryptsoft.com)" The word 'cryptographic' can be left out if + the routines from the library being used are not cryptographic + related :-). + + + + 4. If you include any Windows specific code (or a derivative + thereof) from the apps directory (application code) you must + include an acknowledgement: "This product includes software + written by Tim Hudson (tjh@cryptsoft.com)" + + + + THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR + OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + The licence and distribution terms for any publicly available + version or derivative of this code cannot be changed. i.e. this + code cannot simply be copied and put under another distribution + licence [including the GNU Public Licence.] + + + + + + + Slirp License + + + Copyright (c) 1995,1996 Danny Gasparovski. All rights reserved. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + 1. Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + 2. Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + + + 3. All advertising materials mentioning features or use of this + software must display the following acknowledgment: This product + includes software developed by Danny Gasparovski. + + + + THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED + WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL DANNY GASPAROVSKI OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + liblzf License + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + 1. Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + 2. Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + + + 3. The name of the author may not be used to endorse or promote + products derived from this software without specific prior + written permission. + + + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + libpng License + + + The PNG Reference Library is supplied "AS IS". The Contributing + Authors and Group 42, Inc. disclaim all warranties, expressed or + implied, including, without limitation, the warranties of + merchantability and of fitness for any purpose. The Contributing + Authors and Group 42, Inc. assume no liability for direct, + indirect, incidental, special, exemplary, or consequential + damages, which may result from the use of the PNG Reference + Library, even if advised of the possibility of such damage. + + + + Permission is hereby granted to use, copy, modify, and + distribute this source code, or portions hereof, for any + purpose, without fee, subject to the following restrictions: + + + + 1. The origin of this source code must not be misrepresented. + + + + 2. Altered versions must be plainly marked as such and must not + be misrepresented as being the original source. + + + + 3. This Copyright notice may not be removed or altered from any + source or altered source distribution. + + + + The Contributing Authors and Group 42, Inc. specifically permit, + without fee, and encourage the use of this source code as a + component to supporting the PNG file format in commercial + products. If you use this source code in a product, + acknowledgment is not required but would be appreciated. + + + + + + + lwIP License + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + 1. Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + 2. Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials provided + with the distribution. + + + + 3. The name of the author may not be used to endorse or promote + products derived from this software without specific prior + written permission. + + + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, + THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + libxml License + + + Except where otherwise noted in the source code (e.g. the files + hash.c, list.c and the trio files, which are covered by a + similar licence but with different Copyright notices) all the + files are: + + + + Copyright (C) 1998-2003 Daniel Veillard. All Rights Reserved. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE + FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + + + + Except as contained in this notice, the name of Daniel Veillard + shall not be used in advertising or otherwise to promote the + sale, use or other dealings in this Software without prior + written authorization from him. + + + + + + + libxslt Licenses + + + Licence for libxslt except libexslt: + + + + Copyright (C) 2001-2002 Daniel Veillard. All Rights Reserved. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE DANIEL VEILLARD BE LIABLE + FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION + OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + + + + Except as contained in this notice, the name of Daniel Veillard + shall not be used in advertising or otherwise to promote the + sale, use or other dealings in this Software without prior + written authorization from him. + + + + Licence for libexslt: + + + + Copyright (C) 2001-2002 Thomas Broyer, Charlie Bozeman and + Daniel Veillard. All Rights Reserved. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF + CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN + CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + + + + Except as contained in this notice, the name of the authors + shall not be used in advertising or otherwise to promote the + sale, use or other dealings in this Software without prior + written authorization from him. + + + + + + + gSOAP Public License Version 1.3a + + + The gSOAP public license is derived from the Mozilla Public + License (MPL1.1). The sections that were deleted from the + original MPL1.1 text are 1.0.1, 2.1.(c),(d), 2.2.(c),(d), + 8.2.(b), 10, and 11. Section 3.8 was added. The modified + sections are 2.1.(b), 2.2.(b), 3.2 (simplified), 3.5 (deleted + the last sentence), and 3.6 (simplified). + + + + 1 DEFINITIONS + + + + 1.1. "Contributor" means each entity that creates or contributes + to the creation of Modifications. + + + + 1.2. "Contributor Version" means the combination of the Original + Code, prior Modifications used by a Contributor, and the + Modifications made by that particular Contributor. + + + + 1.3. "Covered Code" means the Original Code, or Modifications or + the combination of the Original Code, and Modifications, in each + case including portions thereof. + + + + 1.4. "Electronic Distribution Mechanism" means a mechanism + generally accepted in the software development community for the + electronic transfer of data. + + + + 1.5. "Executable" means Covered Code in any form other than + Source Code. + + + + 1.6. "Initial Developer" means the individual or entity + identified as the Initial Developer in the Source Code notice + required by Exhibit A. + + + + 1.7. "Larger Work" means a work which combines Covered Code or + portions thereof with code not governed by the terms of this + License. + + + + 1.8. "License" means this document. + + + + 1.8.1. "Licensable" means having the right to grant, to the + maximum extent possible, whether at the time of the initial + grant or subsequently acquired, any and all of the rights + conveyed herein. + + + + 1.9. "Modifications" means any addition to or deletion from the + substance or structure of either the Original Code or any + previous Modifications. When Covered Code is released as a + series of files, a Modification is: + + + + A. Any addition to or deletion from the contents of a file + containing Original Code or previous Modifications. + + + + B. Any new file that contains any part of the Original Code, or + previous Modifications. + + + + 1.10. "Original Code" means Source Code of computer software + code which is described in the Source Code notice required by + Exhibit A as Original Code, and which, at the time of its + release under this License is not already Covered Code governed + by this License. + + + + 1.10.1. "Patent Claims" means any patent claim(s), now owned or + hereafter acquired, including without limitation, method, + process, and apparatus claims, in any patent Licensable by + grantor. + + + + 1.11. "Source Code" means the preferred form of the Covered Code + for making modifications to it, including all modules it + contains, plus any associated interface definition files, + scripts used to control compilation and installation of an + Executable, or source code differential comparisons against + either the Original Code or another well known, available + Covered Code of the Contributor's choice. The Source Code can be + in a compressed or archival form, provided the appropriate + decompression or de-archiving software is widely available for + no charge. + + + + 1.12. "You" (or "Your") means an individual or a legal entity + exercising rights under, and complying with all of the terms of, + this License or a future version of this License issued under + Section 6.1. For legal entities, "You" includes any entity which + controls, is controlled by, or is under common control with You. + For purposes of this definition, "control" means (a) the power, + direct or indirect, to cause the direction or management of such + entity, whether by contract or otherwise, or (b) ownership of + more than fifty percent (50%) of the outstanding shares or + beneficial ownership of such entity. + + + + 2 SOURCE CODE LICENSE. + + + + 2.1. The Initial Developer Grant. + + + + The Initial Developer hereby grants You a world-wide, + royalty-free, non-exclusive license, subject to third party + intellectual property claims: + + + + (a) under intellectual property rights (other than patent or + trademark) Licensable by Initial Developer to use, reproduce, + modify, display, perform, sublicense and distribute the Original + Code (or portions thereof) with or without Modifications, and/or + as part of a Larger Work; and + + + + (b) under patents now or hereafter owned or controlled by + Initial Developer, to make, have made, use and sell ("offer to + sell and import") the Original Code, Modifications, or portions + thereof, but solely to the extent that any such patent is + reasonably necessary to enable You to utilize, alone or in + combination with other software, the Original Code, + Modifications, or any combination or portions thereof. + + + + (c) + + + + (d) + + + + 2.2. Contributor Grant. + + + + Subject to third party intellectual property claims, each + Contributor hereby grants You a world-wide, royalty-free, + non-exclusive license + + + + (a) under intellectual property rights (other than patent or + trademark) Licensable by Contributor, to use, reproduce, modify, + display, perform, sublicense and distribute the Modifications + created by such Contributor (or portions thereof) either on an + unmodified basis, with other Modifications, as Covered Code + and/or as part of a Larger Work; and + + + + (b) under patents now or hereafter owned or controlled by + Contributor, to make, have made, use and sell ("offer to sell + and import") the Contributor Version (or portions thereof), but + solely to the extent that any such patent is reasonably + necessary to enable You to utilize, alone or in combination with + other software, the Contributor Version (or portions thereof). + + + + (c) + + + + (d) + + + + 3 DISTRIBUTION OBLIGATIONS. + + + + 3.1. Application of License. + + + + The Modifications which You create or to which You contribute + are governed by the terms of this License, including without + limitation Section 2.2. The Source Code version of Covered Code + may be distributed only under the terms of this License or a + future version of this License released under Section 6.1, and + You must include a copy of this License with every copy of the + Source Code You distribute. You may not offer or impose any + terms on any Source Code version that alters or restricts the + applicable version of this License or the recipients' rights + hereunder. However, You may include an additional document + offering the additional rights described in Section 3.5. + + + + 3.2. Availability of Source Code. + + + + Any Modification created by You will be provided to the Initial + Developer in Source Code form and are subject to the terms of + the License. 3.3. Description of Modifications. + + + + You must cause all Covered Code to which You contribute to + contain a file documenting the changes You made to create that + Covered Code and the date of any change. You must include a + prominent statement that the Modification is derived, directly + or indirectly, from Original Code provided by the Initial + Developer and including the name of the Initial Developer in (a) + the Source Code, and (b) in any notice in an Executable version + or related documentation in which You describe the origin or + ownership of the Covered Code. + + + + 3.4. Intellectual Property Matters. + + + + (a) Third Party Claims. If Contributor has knowledge that a + license under a third party's intellectual property rights is + required to exercise the rights granted by such Contributor + under Sections 2.1 or 2.2, Contributor must include a text file + with the Source Code distribution titled "LEGAL" which describes + the claim and the party making the claim in sufficient detail + that a recipient will know whom to contact. If Contributor + obtains such knowledge after the Modification is made available + as described in Section 3.2, Contributor shall promptly modify + the LEGAL file in all copies Contributor makes available + thereafter and shall take other steps (such as notifying + appropriate mailing lists or newsgroups) reasonably calculated + to inform those who received the Covered Code that new knowledge + has been obtained. + + + + (b) Contributor APIs. If Contributor's Modifications include an + application programming interface and Contributor has knowledge + of patent licenses which are reasonably necessary to implement + that API, Contributor must also include this information in the + LEGAL file. + + + + (c) Representations. Contributor represents that, except as + disclosed pursuant to Section 3.4(a) above, Contributor believes + that Contributor's Modifications are Contributor's original + creation(s) and/or Contributor has sufficient rights to grant + the rights conveyed by this License. + + + + 3.5. Required Notices. You must duplicate the notice in Exhibit + A in each file of the Source Code. If it is not possible to put + such notice in a particular Source Code file due to its + structure, then You must include such notice in a location (such + as a relevant directory) where a user would be likely to look + for such a notice. If You created one or more Modification(s) + You may add your name as a Contributor to the notice described + in Exhibit A. You must also duplicate this License in any + documentation for the Source Code where You describe recipients' + rights or ownership rights relating to Covered Code. You may + choose to offer, and to charge a fee for, warranty, support, + indemnity or liability obligations to one or more recipients of + Covered Code. However, You may do so only on Your own behalf, + and not on behalf of the Initial Developer or any Contributor. + + + + 3.6. Distribution of Executable Versions. You may distribute + Covered Code in Executable form only if the requirements of + Section 3.1-3.5 have been met for that Covered Code. You may + distribute the Executable version of Covered Code or ownership + rights under a license of Your choice, which may contain terms + different from this License, provided that You are in compliance + with the terms of this License and that the license for the + Executable version does not attempt to limit or alter the + recipient's rights in the Source Code version from the rights + set forth in this License. If You distribute the Executable + version under a different license You must make it absolutely + clear that any terms which differ from this License are offered + by You alone, not by the Initial Developer or any Contributor. + If you distribute executable versions containing Covered Code as + part of a product, you must reproduce the notice in Exhibit B in + the documentation and/or other materials provided with the + product. + + + + 3.7. Larger Works. You may create a Larger Work by combining + Covered Code with other code not governed by the terms of this + License and distribute the Larger Work as a single product. In + such a case, You must make sure the requirements of this License + are fulfilled for the Covered Code. + + + + 3.8. Restrictions. You may not remove any product + identification, copyright, proprietary notices or labels from + gSOAP. + + + + 4 INABILITY TO COMPLY DUE TO STATUTE OR REGULATION. + + + + If it is impossible for You to comply with any of the terms of + this License with respect to some or all of the Covered Code due + to statute, judicial order, or regulation then You must: (a) + comply with the terms of this License to the maximum extent + possible; and (b) describe the limitations and the code they + affect. Such description must be included in the LEGAL file + described in Section 3.4 and must be included with all + distributions of the Source Code. Except to the extent + prohibited by statute or regulation, such description must be + sufficiently detailed for a recipient of ordinary skill to be + able to understand it. + + + + 5 APPLICATION OF THIS LICENSE. + + + + This License applies to code to which the Initial Developer has + attached the notice in Exhibit A and to related Covered Code. + + + + 6 VERSIONS OF THE LICENSE. + + + + 6.1. New Versions. + + + + Grantor may publish revised and/or new versions of the License + from time to time. Each version will be given a distinguishing + version number. + + + + 6.2. Effect of New Versions. + + + + Once Covered Code has been published under a particular version + of the License, You may always continue to use it under the + terms of that version. You may also choose to use such Covered + Code under the terms of any subsequent version of the License. + + + + 6.3. Derivative Works. + + + + If You create or use a modified version of this License (which + you may only do in order to apply it to code which is not + already Covered Code governed by this License), You must (a) + rename Your license so that the phrase "gSOAP" or any + confusingly similar phrase do not appear in your license (except + to note that your license differs from this License) and (b) + otherwise make it clear that Your version of the license + contains terms which differ from the gSOAP Public License. + (Filling in the name of the Initial Developer, Original Code or + Contributor in the notice described in Exhibit A shall not of + themselves be deemed to be modifications of this License.) + + + + 7 DISCLAIMER OF WARRANTY. + + + + COVERED CODE IS PROVIDED UNDER THIS LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, WHETHER EXPRESS, IMPLIED OR + STATUTORY, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES + OF MERCHANTABILITY, OF FITNESS FOR A PARTICULAR PURPOSE, + NONINFRINGEMENT OF THIRD PARTY INTELLECTUAL PROPERTY RIGHTS, AND + ANY WARRANTY THAT MAY ARISE BY REASON OF TRADE USAGE, CUSTOM, OR + COURSE OF DEALING. WITHOUT LIMITING THE FOREGOING, YOU + ACKNOWLEDGE THAT THE SOFTWARE IS PROVIDED "AS IS" AND THAT THE + AUTHORS DO NOT WARRANT THE SOFTWARE WILL RUN UNINTERRUPTED OR + ERROR FREE. LIMITED LIABILITY THE ENTIRE RISK AS TO RESULTS AND + PERFORMANCE OF THE SOFTWARE IS ASSUMED BY YOU. UNDER NO + CIRCUMSTANCES WILL THE AUTHORS BE LIABLE FOR ANY SPECIAL, + INDIRECT, INCIDENTAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES OF ANY + KIND OR NATURE WHATSOEVER, WHETHER BASED ON CONTRACT, WARRANTY, + TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, + ARISING OUT OF OR IN ANY WAY RELATED TO THE SOFTWARE, EVEN IF + THE AUTHORS HAVE BEEN ADVISED ON THE POSSIBILITY OF SUCH DAMAGE + OR IF SUCH DAMAGE COULD HAVE BEEN REASONABLY FORESEEN, AND + NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF ANY + EXCLUSIVE REMEDY PROVIDED. SUCH LIMITATION ON DAMAGES INCLUDES, + BUT IS NOT LIMITED TO, DAMAGES FOR LOSS OF GOODWILL, LOST + PROFITS, LOSS OF DATA OR SOFTWARE, WORK STOPPAGE, COMPUTER + FAILURE OR MALFUNCTION OR IMPAIRMENT OF OTHER GOODS. IN NO EVENT + WILL THE AUTHORS BE LIABLE FOR THE COSTS OF PROCUREMENT OF + SUBSTITUTE SOFTWARE OR SERVICES. YOU ACKNOWLEDGE THAT THIS + SOFTWARE IS NOT DESIGNED FOR USE IN ON-LINE EQUIPMENT IN + HAZARDOUS ENVIRONMENTS SUCH AS OPERATION OF NUCLEAR FACILITIES, + AIRCRAFT NAVIGATION OR CONTROL, OR LIFE-CRITICAL APPLICATIONS. + THE AUTHORS EXPRESSLY DISCLAIM ANY LIABILITY RESULTING FROM USE + OF THE SOFTWARE IN ANY SUCH ON-LINE EQUIPMENT IN HAZARDOUS + ENVIRONMENTS AND ACCEPTS NO LIABILITY IN RESPECT OF ANY ACTIONS + OR CLAIMS BASED ON THE USE OF THE SOFTWARE IN ANY SUCH ON-LINE + EQUIPMENT IN HAZARDOUS ENVIRONMENTS BY YOU. FOR PURPOSES OF THIS + PARAGRAPH, THE TERM "LIFE-CRITICAL APPLICATION" MEANS AN + APPLICATION IN WHICH THE FUNCTIONING OR MALFUNCTIONING OF THE + SOFTWARE MAY RESULT DIRECTLY OR INDIRECTLY IN PHYSICAL INJURY OR + LOSS OF HUMAN LIFE. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN + ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY COVERED CODE IS + AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. + + + + 8 TERMINATION. + + + + 8.1. + + + + This License and the rights granted hereunder will terminate + automatically if You fail to comply with terms herein and fail + to cure such breach within 30 days of becoming aware of the + breach. All sublicenses to the Covered Code which are properly + granted shall survive any termination of this License. + Provisions which, by their nature, must remain in effect beyond + the termination of this License shall survive. + + + + 8.2. + + + + 8.3. + + + + If You assert a patent infringement claim against Participant + alleging that such Participant's Contributor Version directly or + indirectly infringes any patent where such claim is resolved + (such as by license or settlement) prior to the initiation of + patent infringement litigation, then the reasonable value of the + licenses granted by such Participant under Sections 2.1 or 2.2 + shall be taken into account in determining the amount or value + of any payment or license. + + + + 8.4. In the event of termination under Sections 8.1 or 8.2 + above, all end user license agreements (excluding distributors + and resellers) which have been validly granted by You or any + distributor hereunder prior to termination shall survive + termination. + + + + 9 LIMITATION OF LIABILITY. + + + + UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT + (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL YOU, THE + INITIAL DEVELOPER, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF + COVERED CODE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE + TO ANY PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT + LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, + COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL + DAMAGES OR LOSSES, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED + OF THE POSSIBILITY OF SUCH DAMAGES. THIS LIMITATION OF LIABILITY + SHALL NOT APPLY TO LIABILITY FOR DEATH OR PERSONAL INJURY + RESULTING FROM SUCH PARTY'S NEGLIGENCE TO THE EXTENT APPLICABLE + LAW PROHIBITS SUCH LIMITATION. SOME JURISDICTIONS DO NOT ALLOW + THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL + DAMAGES, SO THIS EXCLUSION AND LIMITATION MAY NOT APPLY TO YOU. + + + + 10 U.S. GOVERNMENT END USERS. + + + + 11 MISCELLANEOUS. + + + + 12 RESPONSIBILITY FOR CLAIMS. + + + + As between Initial Developer and the Contributors, each party is + responsible for claims and damages arising, directly or + indirectly, out of its utilization of rights under this License + and You agree to work with Initial Developer and Contributors to + distribute such responsibility on an equitable basis. Nothing + herein is intended or shall be deemed to constitute any + admission of liability. + + + + EXHIBIT A. + + + + "The contents of this file are subject to the gSOAP Public + License Version 1.3 (the "License"); you may not use this file + except in compliance with the License. You may obtain a copy of + the License at + . + Software distributed under the License is distributed on an "AS + IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or + implied. See the License for the specific language governing + rights and limitations under the License. + + + + The Original Code of the gSOAP Software is: stdsoap.h, + stdsoap2.h, stdsoap.c, stdsoap2.c, stdsoap.cpp, stdsoap2.cpp, + soapcpp2.h, soapcpp2.c, soapcpp2_lex.l, soapcpp2_yacc.y, + error2.h, error2.c, symbol2.c, init2.c, soapdoc2.html, and + soapdoc2.pdf, httpget.h, httpget.c, stl.h, stldeque.h, + stllist.h, stlvector.h, stlset.h. + + + + The Initial Developer of the Original Code is Robert A. van + Engelen. Portions created by Robert A. van Engelen are Copyright + (C) 2001-2004 Robert A. van Engelen, Genivia inc. All Rights + Reserved. + + + + Contributor(s): "________________________." [Note: The text of + this Exhibit A may differ slightly form the text of the notices + in the Source Code files of the Original code. You should use + the text of this Exhibit A rather than the text found in the + Original Code Source Code for Your Modifications.] + + + + EXHIBIT B. + + + + "Part of the software embedded in this product is gSOAP + software. Portions created by gSOAP are Copyright (C) 2001-2004 + Robert A. van Engelen, Genivia inc. All Rights Reserved. THE + SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR + BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE." + + + + + + + Chromium Licenses + + + + Main License + + + Copyright (c) 2002, Stanford University All rights reserved. + + + + Some portions of Chromium are copyrighted by individiual + organizations. Please see the files COPYRIGHT.LLNL and + COPYRIGHT.REDHAT for more information. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the + following conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the + following disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the + following disclaimer in the documentation and/or other + materials provided with the distribution. + + + + + + Neither the name of Stanford University nor the names of + its contributors may be used to endorse or promote + products derived from this software without specific prior + written permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR + OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, + EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + COPYRIGHT.LLNL File + + + This Chromium distribution contains information and code which + is covered under the following notice: + + + + Copyright (c) 2002, The Regents of the University of + California. Produced at the Lawrence Livermore National + Laboratory For details, contact: Randall Frank + (rjfrank@llnl.gov). UCRL-CODE-2002-058 All rights reserved. + + + + This file is part of Chromium. For details, see accompanying + documentation. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the + following conditions are met: + + + + Redistributions of source code must retain the above copyright + notice, this list of conditions and the disclaimer below. + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the disclaimer + (as noted below) in the documentation and/or other materials + provided with the distribution. + + + + Neither the name of the UC/LLNL nor the names of its + contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE REGENTS OF THE UNIVERSITY OF + CALIFORNIA, THE U.S. DEPARTMENT OF ENERGY OR CONTRIBUTORS BE + LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER + CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, + STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF + ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + + + Additional BSD Notice + + + + 1. This notice is required to be provided under our contract + with the U.S. Department of Energy (DOE). This work was + produced at the University of California, Lawrence Livermore + National Laboratory under Contract No. W-7405-ENG-48 with the + DOE. + + + + 2. Neither the United States Government nor the University of + California nor any of their employees, makes any warranty, + express or implied, or assumes any liability or responsibility + for the accuracy, completeness, or usefulness of any + information, apparatus, product, or process disclosed, or + represents that its use would not infringe privately-owned + rights. + + + + 3. Also, reference herein to any specific commercial products, + process, or services by trade name, trademark, manufacturer or + otherwise does not necessarily constitute or imply its + endorsement, recommendation, or favoring by the United States + Government or the University of California. The views and + opinions of authors expressed herein do not necessarily state + or reflect those of the United States Government or the + University of California, and shall not be used for + advertising or product endorsement purposes. + + + + + + + COPYRIGHT.REDHAT File + + + This Chromium distribution contains information and code which + is covered under the following notice: + + + + Copyright 2001,2002 Red Hat Inc., Durham, North Carolina. + + + + All Rights Reserved. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation on the rights to + use, copy, modify, merge, publish, distribute, sublicense, + and/or sell copies of the Software, and to permit persons to + whom the Software is furnished to do so, subject to the + following conditions: + + + + The above copyright notice and this permission notice + (including the next paragraph) shall be included in all copies + or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY + KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL RED HAT AND/OR + THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR + OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + + + + + + + + curl License + + + COPYRIGHT AND PERMISSION NOTICE + + + + Copyright (c) 1996 - 2009, Daniel Stenberg, daniel@haxx.se. + + + + All rights reserved. + + + + Permission to use, copy, modify, and distribute this software + for any purpose with or without fee is hereby granted, provided + that the above copyright notice and this permission notice + appear in all copies. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR + OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR + OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + + + Except as contained in this notice, the name of a copyright + holder shall not be used in advertising or otherwise to promote + the sale, use or other dealings in this Software without prior + written authorization of the copyright holder. + + + + + + + libgd License + + + Portions copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, + 2001, 2002 by Cold Spring Harbor Laboratory. Funded under Grant + P41-RR02188 by the National Institutes of Health. + + + + Portions copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002 by + Boutell.Com, Inc. + + + + Portions relating to GD2 format copyright 1999, 2000, 2001, 2002 + Philip Warner. + + + + Portions relating to PNG copyright 1999, 2000, 2001, 2002 Greg + Roelofs. + + + + Portions relating to gdttf.c copyright 1999, 2000, 2001, 2002 + John Ellson (ellson@lucent.com). + + + + Portions relating to gdft.c copyright 2001, 2002 John Ellson + (ellson@lucent.com). + + + + Portions copyright 2000, 2001, 2002, 2003, 2004, 2005, 2006, + 2007 Pierre-Alain Joye (pierre@libgd.org). + + + + Portions relating to JPEG and to color quantization copyright + 2000, 2001, 2002, Doug Becker and copyright (C) 1994, 1995, + 1996, 1997, 1998, 1999, 2000, 2001, 2002, Thomas G. Lane. This + software is based in part on the work of the Independent JPEG + Group. See the file README-JPEG.TXT for more information. + + + + Portions relating to WBMP copyright 2000, 2001, 2002 Maurice + Szmurlo and Johan Van den Brande. + + + + Permission has been granted to copy, distribute and modify gd in + any context without fee, including a commercial application, + provided that this notice is present in user-accessible + supporting documentation. + + + + This does not affect your ownership of the derived work itself, + and the intent is to assure proper credit for the authors of gd, + not to interfere with your productive use of gd. If you have + questions, ask. "Derived works" includes all programs that + utilize the library. Credit must be given in user-accessible + documentation. + + + + This software is provided "AS IS." The copyright holders + disclaim all warranties, either express or implied, including + but not limited to implied warranties of merchantability and + fitness for a particular purpose, with respect to this code and + accompanying documentation. + + + + Although their code does not appear in gd, the authors wish to + thank David Koblas, David Rowley, and Hutchison Avenue Software + Corporation for their prior contributions. + + + + + + + BSD License from Intel + + + All rights reserved. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of the Intel Corporation nor the names of + its contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + libjpeg License + + + The authors make NO WARRANTY or representation, either express + or implied, with respect to this software, its quality, + accuracy, merchantability, or fitness for a particular purpose. + This software is provided "AS IS", and you, its user, assume the + entire risk as to its quality and accuracy. + + + + This software is copyright (C) 1991-2010, Thomas G. Lane, Guido + Vollbeding. All Rights Reserved except as specified below. + + + + Permission is hereby granted to use, copy, modify, and + distribute this software (or portions thereof) for any purpose, + without fee, subject to these conditions: + + + + (1) If any part of the source code for this software is + distributed, then this README file must be included, with this + copyright and no-warranty notice unaltered; and any additions, + deletions, or changes to the original files must be clearly + indicated in accompanying documentation. + + + + (2) If only executable code is distributed, then the + accompanying documentation must state that "this software is + based in part on the work of the Independent JPEG Group". + + + + (3) Permission for use of this software is granted only if the + user accepts full responsibility for any undesirable + consequences; the authors accept NO LIABILITY for damages of any + kind. + + + + These conditions apply to any software derived from or based on + the IJG code, not just to the unmodified library. If you use our + work, you ought to acknowledge us. + + + + Permission is NOT granted for the use of any IJG author's name + or company name in advertising or publicity relating to this + software or products derived from it. This software may be + referred to only as "the Independent JPEG Group's software". + + + + We specifically permit and encourage the use of this software as + the basis of commercial products, provided that all warranty or + liability claims are assumed by the product vendor. + + + + ansi2knr.c is included in this distribution by permission of L. + Peter Deutsch, sole proprietor of its copyright holder, Aladdin + Enterprises of Menlo Park, CA. ansi2knr.c is NOT covered by the + above copyright and conditions, but instead by the usual + distribution terms of the Free Software Foundation; principally, + that you must include source code if you redistribute it. (See + the file ansi2knr.c for full details.) However, since ansi2knr.c + is not needed as part of any program generated from the IJG + code, this does not limit you more than the foregoing paragraphs + do. + + + + The Unix configuration script "configure" was produced with GNU + Autoconf. It is copyright by the Free Software Foundation but is + freely distributable. The same holds for its supporting scripts + (config.guess, config.sub, ltmain.sh). Another support script, + install-sh, is copyright by X Consortium but is also freely + distributable. + + + + The IJG distribution formerly included code to read and write + GIF files. To avoid entanglement with the Unisys LZW patent, GIF + reading support has been removed altogether, and the GIF writer + has been simplified to produce "uncompressed GIFs". This + technique does not use the LZW algorithm; the resulting GIF + files are larger than usual, but are readable by all standard + GIF decoders. + + + + We are required to state that + + + + "The Graphics Interchange Format(c) is the Copyright property of + CompuServe Incorporated. GIF(sm) is a Service Mark property of + CompuServe Incorporated." + + + + + + + x86 SIMD Extension for IJG JPEG Library License + + + Copyright 2009 Pierre Ossman <ossman@cendio.se> for Cendio + AB + + + + Copyright 2010 D. R. Commander + + + + Based on + + + + x86 SIMD extension for IJG JPEG library - version 1.02 + + + + Copyright (C) 1999-2006, MIYASAKA Masaru. + + + + This software is provided 'as-is', without any express or + implied warranty. In no event will the authors be held liable + for any damages arising from the use of this software. + + + + Permission is granted to anyone to use this software for any + purpose, including commercial applications, and to alter it and + redistribute it freely, subject to the following restrictions: + + + + 1. The origin of this software must not be misrepresented; you + must not claim that you wrote the original software. If you use + this software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + + + + 2. Altered source versions must be plainly marked as such, and + must not be misrepresented as being the original software. + + + + 3. This notice may not be removed or altered from any source + distribution. + + + + + + + FreeBSD License + + + The compilation of software known as FreeBSD is distributed + under the following terms: + + + + Copyright (c) 1992-2009 The FreeBSD Project. All rights + reserved. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS + IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + + + + + + + NetBSD License + + + Copyright (c) 1992, 1993 The Regents of the University of + California. All rights reserved. + + + + This software was developed by the Computer Systems Engineering + group at Lawrence Berkeley Laboratory under DARPA contract BG + 91-66 and contributed to Berkeley. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of the University nor the names of its + contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS + IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND + FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, + INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR + BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF + THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + SUCH DAMAGE. + + + + + + + PCRE License + + + PCRE is a library of functions to support regular expressions + whose syntax and semantics are as close as possible to those of + the Perl 5 language. + + + + Release 8 of PCRE is distributed under the terms of the "BSD" + licence, as specified below. The documentation for PCRE, + supplied in the "doc" directory, is distributed under the same + terms as the software itself. + + + + The basic library functions are written in C and are + freestanding. Also included in the distribution is a set of C++ + wrapper functions, and a just-in-time compiler that can be used + to optimize pattern matching. These are both optional features + that can be omitted when the library is built. + + + + THE BASIC LIBRARY FUNCTIONS. Written by: Philip Hazel; Email + local part: ph10; Email domain: cam.ac.uk University of + Cambridge Computing Service, Cambridge, England. Copyright (c) + 1997-2012 University of Cambridge All rights reserved. + + + + PCRE JUST-IN-TIME COMPILATION SUPPORT. Written by: Zoltan + Herczeg; Email local part: hzmester; Emain domain: freemail.hu + Copyright(c) 2010-2012 Zoltan Herczeg All rights reserved. + + + + STACK-LESS JUST-IN-TIME COMPILER. Written by: Zoltan Herczeg; + Email local part: hzmester; Emain domain: freemail.hu + Copyright(c) 2009-2012 Zoltan Herczeg All rights reserved. + + + + THE C++ WRAPPER FUNCTIONS. Contributed by: Google Inc. Copyright + (c) 2007-2012, Google Inc. All rights reserved. + + + + THE "BSD" LICENCE. Redistribution and use in source and binary + forms, with or without modification, are permitted provided that + the following conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of the University of Cambridge nor the name + of Google Inc. nor the names of their contributors may be + used to endorse or promote products derived from this + software without specific prior written permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + libffi License + + + Copyright (c) 1996-2012 Anthony Green, Red Hat, Inc and others. + See source files for details. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the ``Software''), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED ``AS IS'', WITHOUT WARRANTY OF ANY + KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE + AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + + + + + + + FLTK License + + + December 11, 2001 + + + + The FLTK library and included programs are provided under the + terms of the GNU Library General Public License (LGPL) with the + following exceptions: + + + + + + + Modifications to the FLTK configure script, config header + file, and makefiles by themselves to support a specific + platform do not constitute a modified or derivative work. + + + + The authors do request that such modifications be + contributed to the FLTK project - send all contributions + through the "Software Trouble Report" on the following page: + + + + http://www.fltk.org/str.php + + + + + + Widgets that are subclassed from FLTK widgets do not + constitute a derivative work. + + + + + + Static linking of applications and widgets to the FLTK + library does not constitute a derivative work and does not + require the author to provide source code for the + application or widget, use the shared FLTK libraries, or + link their applications or widgets against a user-supplied + version of FLTK. + + + + If you link the application or widget to a modified version + of FLTK, then the changes to FLTK must be provided under the + terms of the LGPL in sections 1, 2, and 4. + + + + + + You do not have to provide a copy of the FLTK license with + programs that are linked to the FLTK library, nor do you + have to identify the FLTK license in your program or + documentation as required by section 6 of the LGPL. + + + + However, programs must still identify their use of FLTK. The + following example statement can be included in user + documentation to satisfy this requirement: + + + + [program/widget] is based in part on the work of the FLTK + project (http://www.fltk.org). + + + + + + + + + + Expat License + + + Copyright (c) 1998, 1999, 2000 Thai Open Source Software Center + Ltd and Clark Cooper + + + + Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006 Expat + maintainers. + + + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated documentation + files (the "Software"), to deal in the Software without + restriction, including without limitation the rights to use, + copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the + Software is furnished to do so, subject to the following + conditions: + + + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES + OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT + HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + OTHER DEALINGS IN THE SOFTWARE. + + + + + + + Fontconfig License + + + Copyright (C) 2001, 2003 Keith Packard + + + + Permission to use, copy, modify, distribute, and sell this + software and its documentation for any purpose is hereby granted + without fee, provided that the above copyright notice appear in + all copies and that both that copyright notice and this + permission notice appear in supporting documentation, and that + the name of the author(s) not be used in advertising or + publicity pertaining to distribution of the software without + specific, written prior permission. The authors make no + representations about the suitability of this software for any + purpose. It is provided "as is" without express or implied + warranty. + + + + THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS + SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY + AND FITNESS, IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY + SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER + IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, + ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF + THIS SOFTWARE. + + + + + + + Freetype License + + + 2006-Jan-27 + + + + Copyright 1996-2002, 2006 by David Turner, Robert Wilhelm, and + Werner Lemberg + + + + + Introduction + + + The FreeType Project is distributed in several archive + packages; some of them may contain, in addition to the + FreeType font engine, various tools and contributions which + rely on, or relate to, the FreeType Project. + + + + This license applies to all files found in such packages, and + which do not fall under their own explicit license. The + license affects thus the FreeType font engine, the test + programs, documentation and makefiles, at the very least. + + + + This license was inspired by the BSD, Artistic, and IJG + (Independent JPEG Group) licenses, which all encourage + inclusion and use of free software in commercial and freeware + products alike. As a consequence, its main points are that: + + + + + + + We don't promise that this software works. However, we + will be interested in any kind of bug reports. (`as is' + distribution) + + + + + + You can use this software for whatever you want, in parts + or full form, without having to pay us. (`royalty-free' + usage) + + + + + + You may not pretend that you wrote this software. If you + use it, or only parts of it, in a program, you must + acknowledge somewhere in your documentation that you have + used the FreeType code. (`credits') + + + + + + + We specifically permit and encourage the inclusion of this + software, with or without modifications, in commercial + products. We disclaim all warranties covering The FreeType + Project and assume no liability related to The FreeType + Project. + + + + Finally, many people asked us for a preferred form for a + credit/disclaimer to use in compliance with this license. We + thus encourage you to use the following text: + + + + Portions of this software are copyright (C) <year> The + FreeType Project (www.freetype.org). All rights reserved. + + + + Please replace <year> with the value from the FreeType + version you actually use. + + + + + + + Legal Terms + + + 0. Definitions + + + + Throughout this license, the terms `package', `FreeType + Project', and `FreeType archive' refer to the set of files + originally distributed by the authors (David Turner, Robert + Wilhelm, and Werner Lemberg) as the `FreeType Project', be + they named as alpha, beta or final release. + + + + `You' refers to the licensee, or person using the project, + where `using' is a generic term including compiling the + project's source code as well as linking it to form a + `program' or `executable'. This program is referred to as `a + program using the FreeType engine'. + + + + This license applies to all files distributed in the original + FreeType Project, including all source code, binaries and + documentation, unless otherwise stated in the file in its + original, unmodified form as distributed in the original + archive. If you are unsure whether or not a particular file is + covered by this license, you must contact us to verify this. + + + + The FreeType Project is copyright (C) 1996-2000 by David + Turner, Robert Wilhelm, and Werner Lemberg. All rights + reserved except as specified below. + + + + 1. No Warranty + + + + THE FREETYPE PROJECT IS PROVIDED `AS IS' WITHOUT WARRANTY OF + ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT + LIMITED TO, WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + PARTICULAR PURPOSE. IN NO EVENT WILL ANY OF THE AUTHORS OR + COPYRIGHT HOLDERS BE LIABLE FOR ANY DAMAGES CAUSED BY THE USE + OR THE INABILITY TO USE, OF THE FREETYPE PROJECT. + + + + 2. Redistribution + + + + This license grants a worldwide, royalty-free, perpetual and + irrevocable right and license to use, execute, perform, + compile, display, copy, create derivative works of, distribute + and sublicense the FreeType Project (in both source and object + code forms) and derivative works thereof for any purpose; and + to authorize others to exercise some or all of the rights + granted herein, subject to the following conditions: + + + + + + + Redistribution of source code must retain this license + file (`FTL.TXT') unaltered; any additions, deletions or + changes to the original files must be clearly indicated in + accompanying documentation. The copyright notices of the + unaltered, original files must be preserved in all copies + of source files. + + + + + + Redistribution in binary form must provide a disclaimer + that states that the software is based in part of the work + of the FreeType Team, in the distribution documentation. + We also encourage you to put an URL to the FreeType web + page in your documentation, though this isn't mandatory. + + + + + + + These conditions apply to any software derived from or based + on the FreeType Project, not just the unmodified files. If you + use our work, you must acknowledge us. However, no fee need be + paid to us. + + + + 3. Advertising + + + + Neither the FreeType authors and contributors nor you shall + use the name of the other for commercial, advertising, or + promotional purposes without specific prior written + permission. + + + + We suggest, but do not require, that you use one or more of + the following phrases to refer to this software in your + documentation or advertising materials: `FreeType Project', + `FreeType Engine', `FreeType library', or `FreeType + Distribution'. + + + + As you have not signed this license, you are not required to + accept it. However, as the FreeType Project is copyrighted + material, only this license, or another one contracted with + the authors, grants you the right to use, distribute, and + modify it. Therefore, by using, distributing, or modifying the + FreeType Project, you indicate that you understand and accept + all the terms of this license. + + + + 4. Contacts + + + + There are two mailing lists related to FreeType: + + + + + + + freetype@nongnu.org + + + + Discusses general use and applications of FreeType, as + well as future and wanted additions to the library and + distribution. If you are looking for support, start in + this list if you haven't found anything to help you in the + documentation. + + + + + + freetype-devel@nongnu.org + + + + Discusses bugs, as well as engine internals, design + issues, specific licenses, porting, etc. + + + + + + + Our home page can be found at + + + + http://www.freetype.org + + + + + + + + + VPX License + + + Copyright (c) 2010, The WebM Project authors. All rights + reserved. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of Google, nor the WebM Project, nor the + names of its contributors may be used to endorse or promote + products derived from this software without specific prior + written permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + Opus License + + + Copyright 2001-2011 Xiph.Org, Skype Limited, Octasic, Jean-Marc + Valin, Timothy B. Terriberry, CSIRO, Gregory Maxwell, Mark + Borgerding, Erik de Castro Lopo + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of Internet Society, IETF or IETF Trust, + nor the names of specific contributors, may be used to + endorse or promote products derived from this software + without specific prior written permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. Opus is subject to the + royalty-free patent licenses which are specified at: Xiph.Org + Foundation: https://datatracker.ietf.org/ipr/1524/ Microsoft + Corporation: https://datatracker.ietf.org/ipr/1914/ Broadcom + Corporation: https://datatracker.ietf.org/ipr/1526/ + + + + + + + FUSE for macOS License + + + Copyright (c) 2011-2017 Benjamin Fleischer; Copyright (c) + 2011-2012 Erik Larsson; All rights reserved. + + + + Redistribution and use in source and binary forms, with or + without modification, are permitted provided that the following + conditions are met: + + + + + + + Redistributions of source code must retain the above + copyright notice, this list of conditions and the following + disclaimer. + + + + + + Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following + disclaimer in the documentation and/or other materials + provided with the distribution. + + + + + + Neither the name of the copyright holder nor the names of + its contributors may be used to endorse or promote products + derived from this software without specific prior written + permission. + + + + + + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND + CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF + USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF + THE POSSIBILITY OF SUCH DAMAGE. + + + + + + + diff --git a/doc/manual/en_US/user_Troubleshooting.xml b/doc/manual/en_US/user_Troubleshooting.xml new file mode 100644 index 00000000..d179266c --- /dev/null +++ b/doc/manual/en_US/user_Troubleshooting.xml @@ -0,0 +1,1872 @@ + + +%all.entities; +]> + + + Troubleshooting + + + This chapter provides answers to commonly asked questions. In order + to improve your user experience with &product-name;, it is + recommended to read this section to learn more about common pitfalls + and get recommendations on how to use the product. + + + + + Procedures and Tools + + + + Categorizing and Isolating Problems + + + More often than not, a virtualized guest behaves like a physical + system. Any problems that a physical machine would encounter, a + virtual machine will encounter as well. If, for example, + Internet connectivity is lost due to external issues, virtual + machines will be affected just as much as physical ones. + + + + If a true &product-name; problem is encountered, it helps to + categorize and isolate the problem first. Here are some of the + questions that should be answered before reporting a problem: + + + + + + + Is the problem specific to a certain guest OS? Or a specific + release of a guest OS? Especially with Linux guest related + problems, the issue may be specific to a certain + distribution and version of Linux. + + + + + + Is the problem specific to a certain host OS? Problems are + usually not host OS specific, because most of the + &product-name; code base is shared across all supported + platforms, but especially in the areas of networking and USB + support, there are significant differences between host + platforms. Some GUI related issues are also host specific. + + + + + + Is the problem specific to certain host hardware? This + category of issues is typically related to the host CPU. + Because of significant differences between VT-x and AMD-V, + problems may be specific to one or the other technology. The + exact CPU model may also make a difference because different + CPUs support different features, which may affect certain + aspects of guest CPU operation. + + + + + + Is the problem specific to guest SMP? That is, is it related + to the number of virtual CPUs (VCPUs) in the guest? Using + more than one CPU usually significantly affects the internal + operation of a guest OS. + + + + + + Is the problem specific to the Guest Additions? In some + cases, this is obvious, such as a shared folders problem. In + other cases such as display problems, it may be less + obvious. If the problem is Guest Additions specific, is it + also specific to a certain version of the Guest Additions? + + + + + + Is the problem specific to a certain environment? Some + problems are related to a particular environment external to + the VM. This usually involves network setup. Certain + configurations of external servers such as DHCP or PXE may + expose problems which do not occur with other, similar + servers. + + + + + + Is the problem a regression? Knowing that an issue is a + regression usually makes it significantly easier to find the + solution. In this case, it is crucial to know which version + is affected and which is not. + + + + + + + + + + Collecting Debugging Information + + + For problem determination, it is often important to collect + debugging information which can be analyzed by &product-name; + support. This section contains information about what kind of + information can be obtained. + + + + Every time &product-name; starts up a VM, a so-called + release log file is created, containing + lots of information about the VM configuration and runtime + events. The log file is called VBox.log and + resides in the VM log file folder, which is + $HOME/VirtualBox + VMs/VM-name/Logs by + default. + + + + When starting a VM, the configuration file of the last run will + be renamed to .1, up to + .3. Sometimes when there is a problem, it + is useful to have a look at the logs. Also when requesting + support for &product-name;, supplying the corresponding log file + is mandatory. + + + + For convenience, for each virtual machine, the VirtualBox + Manager window can show these logs in a window. To access it, + select a virtual machine from the list on the left and select + Show Log from the + Machine menu. + + + + The release log file, VBox.log, contains a + wealth of diagnostic information, such as Host OS type and + version, &product-name; version and build. It also includes a + complete dump of the guest's configuration (CFGM), detailed + information about the host CPU type and supported features, + whether hardware virtualization is enabled, information about + VT-x/AMD-V setup, state transitions (such as creating, running, + paused, stopping), guest BIOS messages, Guest Additions + messages, device-specific log entries and, at the end of + execution, final guest state and condensed statistics. + + + + In case of crashes, it is very important to collect + crash dumps. This is true for both host and + guest crashes. For information about enabling core dumps on + Linux, Oracle Solaris, and Mac OS X systems, refer to the + following core dump article on the &product-name; website: + + + + . + + + + You can also use VBoxManage debugvm to create + a dump of a complete virtual machine. See + . + + + + For network related problems, it is often helpful to capture a + trace of network traffic. If the traffic is routed through an + adapter on the host, it is possible to use Wireshark or a + similar tool to capture the traffic there. However, this often + also includes a lot of traffic unrelated to the VM. + + + + &product-name; provides an ability to capture network traffic + only on a specific VM's network adapter. Refer to the following + network tracing article on the &product-name; website for + information on enabling this capture: + + + + . + + + + The trace files created by &product-name; are in + .pcap format and can be easily analyzed + with Wireshark. + + + + + + + Using the VBoxBugReport Command to Collect Debug Information + Automatically + + + The VBoxBugReport command is used to collect + debug information automatically for an &product-name; + installation. This command can be useful when you need to gather + information to send to Oracle Support. + + + + The following examples show how to use + VBoxBugReport. + + + + By default, the command collects VBoxSVC + process logs, device settings, and global configuration data for + an &product-name; host. + + +$ VBoxBugReport + ... + 0% - collecting VBoxSVC.log.10... + 7% - collecting VBoxSVC.log.9... + ... + 64% - collecting VBoxSVC.log.1... + 71% - collecting VBoxSVC.log... + 78% - collecting VirtualBox.xml... + 85% - collecting HostUsbDevices... + 92% - collecting HostUsbFilters... +100% - compressing... + +Report was written to '2019-03-26-13-32-02-bugreport.tgz' + + + The results are saved as a compressed tar file archive in the + same directory where the command is run. + + + + To specify a different output file location: + + +$ VBoxBugReport --output ~/debug/bug004.tgz + + + To output all debug information to a single text file, rather + than a tgz file: + + +$ VBoxBugReport --text + + + To collect information for a specific VM, called + Windows_10: + + +$ VBoxBugReport Windows_10 + + + This command collects machine settings, guest properties, and + log files for the specified VM. Global configuration information + for the host is also included. + + + + To collect information for several VMs, called + Windows_7, Windows_8, and + Windows_10: + + +$ VBoxBugReport Windows_7 Windows_8 Windows_10 + + + To collect information for all VMs: + + +$ VBoxBugReport --all + + + To show a full list of the available command options, run + VBoxBugReport --help. + + + + + + + The Built-In VM Debugger + + + &product-name; includes a built-in VM debugger, which advanced + users may find useful. This debugger enables you to examine and, + to some extent, control the VM state. + + + + + Use the VM debugger at your own risk. There is no support for + it, and the following documentation is only made available for + advanced users with a very high level of familiarity with the + x86/AMD64 machine instruction set, as well as detailed + knowledge of the PC architecture. A degree of familiarity with + the internals of the guest OS in question may also be very + helpful. + + + + + The VM debugger is available in all regular production versions + of &product-name;, but it is disabled by default because the + average user will have little use for it. There are two ways to + access the debugger: + + + + + + + Using a debugger console window displayed alongside the VM + + + + + + Using the telnet protocol on port 5000 + + + + + + + The debugger can be enabled in the following ways: + + + + + + + Start the VM directly using VirtualBoxVM + --startvm, with an additional + , , or + argument. See the + VirtualBoxVM --help command usage help + for details. + + + + + + Set the VBOX_GUI_DBG_ENABLED or + VBOX_GUI_DBG_AUTO_SHOW environment + variable to true before launching the + &product-name; process. Setting these variables, only their + presence is checked, is effective even when the first + &product-name; process is the VM selector window. VMs + subsequently launched from the selector will have the + debugger enabled. + + + + + + Set the GUI/Dbg/Enabled extra data item + to true before launching the VM. This can + be set globally or on a per VM basis. + + + + + + + A new Debug menu entry is added + to the &product-name; application. This menu enables the user to + open the debugger console. + + + + The VM debugger command syntax is loosely modeled on Microsoft + and IBM debuggers used on DOS, OS/2, and Windows. Users familiar + with symdeb, CodeView, or the OS/2 kernel debugger will find the + &product-name; VM debugger familiar. + + + + The most important command is help. This will + print brief usage help for all debugger commands. The set of + commands supported by the VM debugger changes frequently and the + help command is always up-to-date. + + + + A brief summary of frequently used commands is as follows: + + + + + + + stop: Stops the VM execution and enables + single stepping + + + + + + g: Continue VM execution + + + + + + t: Single step an instruction + + + + + + rg, rh, and + r: Print the guest, hypervisor, and + current registers + + + + + + kg, kh, and + k: Print the guest, hypervisor, and + current call stack + + + + + + da, db, + dw, dd, + dq: Print memory contents as ASCII, + bytes, words, dwords, and qwords + + + + + + u: Unassemble memory + + + + + + dg: Print the guest's GDT + + + + + + di: Print the guest's IDT + + + + + + dl: Print the guest's LDT + + + + + + dt: Print the guest's TSS + + + + + + dp*: Print the guest's page table + structures + + + + + + bp and br: Set a + normal and recompiler breakpoint + + + + + + bl: List breakpoints + + + + + + bc: Clear a breakpoint + + + + + + writecore: Write a VM core file to disk. + See + + + + + + + See the built-in help for other available + commands. + + + + The VM debugger supports symbolic debugging, although symbols + for guest code are often not available. For Oracle Solaris + guests, the detect command automatically + determines the guest OS version and locates kernel symbols in + guest's memory. Symbolic debugging is then available. For Linux + guests, the detect commands also determines + the guest OS version, but there are no symbols in the guest's + memory. Kernel symbols are available in the file + /proc/kallsyms on Linux guests. This file + must be copied to the host, for example using + scp. The loadmap debugger + command can be used to make the symbol information available to + the VM debugger. Note that the kallsyms + file contains the symbols for the currently loaded modules. If + the guest's configuration changes, the symbols will change as + well and must be updated. + + + + For all guests, a simple way to verify that the correct symbols + are loaded is the k command. The guest is + normally idling and it should be clear from the symbolic + information that the guest operating system's idle loop is being + executed. + + + + Another group of debugger commands is the set of + info commands. Running info + help provides complete usage information. The + information commands provide ad-hoc data pertinent to various + emulated devices and aspects of the VMM. There is no general + guideline for using the info commands, the + right command to use depends entirely on the problem being + investigated. Some of the info commands are + as follows: + + + + + + + cfgm: Print a branch of the configuration + tree + + + + + + cpuid: Display the guest CPUID leaves + + + + + + ioport: Print registered I/O port ranges + + + + + + mmio: Print registered MMIO ranges + + + + + + mode: Print the current paging mode + + + + + + pit: Print the i8254 PIT state + + + + + + pic: Print the i8259A PIC state + + + + + + ohci, ehci, + xhci: Print a subset of the OHCI, EHCI, + and xHCI USB controller state + + + + + + pcnet0: Print the PCnet state + + + + + + vgatext: Print the contents of the VGA + framebuffer formatted as standard text mode + + + + + + timers: Print all VM timers + + + + + + + The output of the info commands generally + requires in-depth knowledge of the emulated device or + &product-name; VMM internals. However, when used properly, the + information provided can be invaluable. + + + + + + + VM Core Format + + + &product-name; uses the 64-bit ELF format for its VM core files + created by VBoxManage debugvm, see + . The VM core file contain + the memory and CPU dumps of the VM and can be useful for + debugging your guest OS. The 64-bit ELF object format + specification can be obtained at: + + + + . + + + + The overall layout of the VM core format is as follows: + + +[ ELF 64 Header] +[ Program Header, type PT_NOTE ] + → offset to COREDESCRIPTOR +[ Program Header, type PT_LOAD ] - one for each contiguous physical memory range + → Memory offset of range + → File offset +[ Note Header, type NT_VBOXCORE ] +[ COREDESCRIPTOR ] + → Magic + → VM core file version + → VBox version + → Number of vCPUs etc. +[ Note Header, type NT_VBOXCPU ] - one for each vCPU +[ vCPU 1 Note Header ] + [ DBGFCORECPU - vCPU 1 dump ] +[ Additional Notes + Data ] - currently unused +[ Memory dump ] + + + The memory descriptors contain physical addresses relative to + the guest and not virtual addresses. Regions of memory such as + MMIO regions are not included in the core file. + + + + The relevant data structures and definitions can be found in the + &product-name; sources under the following header files: + include/VBox/dbgfcorefmt.h, + include/iprt/x86.h and + src/VBox/Runtime/include/internal/ldrELFCommon.h. + + + + The VM core file can be inspected using + elfdump and GNU readelf or + other similar utilities. + + + + + + + + + General Troubleshooting + + + + Guest Shows IDE/SATA Errors for File-Based Images on Slow Host File + System + + + Occasionally, some host file systems provide very poor writing + performance and as a consequence cause the guest to time out + IDE/SATA commands. This is normal behavior and should normally + cause no real problems, as the guest should repeat commands that + have timed out. However, guests such as some Linux versions have + severe problems if a write to an image file takes longer than + about 15 seconds. Some file systems however require more than a + minute to complete a single write, if the host cache contains a + large amount of data that needs to be written. + + + + The symptom for this problem is that the guest can no longer + access its files during large write or copying operations, + usually leading to an immediate hang of the guest. + + + + In order to work around this problem, the true fix is to use a + faster file system that does not exhibit such unacceptable write + performance, it is possible to flush the image file after a + certain amount of data has been written. This interval is + normally infinite, but can be configured individually for each + disk of a VM. + + + + For IDE disks use the following command: + + +VBoxManage setextradata VM-name +"VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/FlushInterval" [b] + + + For SATA disks use the following command: + + +VBoxManage setextradata VM-name +"VBoxInternal/Devices/ahci/0/LUN#[x]/Config/FlushInterval" [b] + + + [x] specifies the + disk. For IDE, 0 represents device 0 on the + primary channel, 1 represents device 1 on the + primary channel, 2 represents device 0 on the + secondary channel, and 3 represents device 1 + on the secondary channel. For SATA, use values between + 0 and 29. This + configuration option applies to disks only. Do not use this + option for CD or DVD drives. + + + + The unit of the interval + ([b]) is the + number of bytes written since the last flush. The value for it + must be selected so that the occasional long write delays do not + occur. Since the proper flush interval depends on the + performance of the host and the host filesystem, finding the + optimal value that makes the problem disappear requires some + experimentation. Values between 1000000 and 10000000 (1 to 10 + megabytes) are a good starting point. Decreasing the interval + both decreases the probability of the problem and the write + performance of the guest. Setting the value unnecessarily low + will cost performance without providing any benefits. An + interval of 1 will cause a flush for each write operation and + should solve the problem in any case, but has a severe write + performance penalty. + + + + Providing a value of 0 for + [b] is treated as + an infinite flush interval, effectively disabling this + workaround. Removing the extra data key by specifying no value + for [b] has the + same effect. + + + + + + + Responding to Guest IDE/SATA Flush Requests + + + If desired, the virtual disk images can be flushed when the + guest issues the IDE FLUSH CACHE command. Normally these + requests are ignored for improved performance. The parameters + below are only accepted for disk drives. They must not be set + for DVD drives. + + + + To enable flushing for IDE disks, issue the following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/Devices/piix3ide/0/LUN#[x]/Config/IgnoreFlush" 0 + + + [x] specifies the + disk. Enter 0 for device 0 on the primary + channel, 1 for device 1 on the primary + channel, 2 for device 0 on the secondary + channel, or 3 for device 1 on the secondary + channel. + + + + To enable flushing for SATA disks, issue the following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/Devices/ahci/0/LUN#[x]/Config/IgnoreFlush" 0 + + + The value [x] that selects the disk can be a value between 0 and + 29. + + + + Note that this does not affect the flushes performed according + to the configuration described in + . Restoring the + default of ignoring flush commands is possible by setting the + value to 1 or by removing the key. + + + + + + + Performance Variation with Frequency Boosting + + + Many multicore processors support some form of frequency + boosting, which means that if only one core is utilized, it can + run possibly 50% faster or even more than the rated CPU + frequency. This causes measured performance to vary somewhat as + a function of the momentary overall system load. The exact + behavior depends strongly on the specific processor model. + + + + As a consequence, benchmarking on systems which utilize + frequency boosting may produce unstable and non-repeatable + results. This is especially true if benchmark runs are short, of + the order of seconds. To obtain stable results, benchmarks must + be run over longer periods of time and with a constant system + load apart from the VM being tested. + + + + + + + Frequency Scaling Effect on CPU Usage + + + On some hardware platforms and operating systems, CPU frequency + scaling may cause CPU usage reporting to be highly misleading. + This happens in situations when the host CPU load is significant + but not heavy, such as between 15% to 30% of the maximum. + + + + Most operating systems determine CPU usage in terms of time + spent, measuring for example how many nanoseconds the systems or + a process was active within one second. However, in order to + save energy, systems can significantly scale down CPU speed when + the system is not fully loaded. When the CPU is running at for + example one half of its maximum speed, the same number of + instructions will take roughly twice as long to execute compared + to running at full speed. + + + + Depending on the specific hardware and host OS, this effect can + very significantly skew the CPU usage reported by the OS. The + reported CPU usage can be several times higher than what it + would have been had the CPU been running at full speed. The + effect can be observed both on the host OS and in a guest OS. + + + + + + + Inaccurate Windows CPU Usage Reporting + + + CPU usage reporting tools which come with Windows, such as Task + Manager or Resource Monitor, do not take the time spent + processing hardware interrupts into account. If the interrupt + load is heavy, with thousands of interrupts per second, CPU + usage may be significantly underreported. + + + + This problem affects Windows as both host and guest OS. + Sysinternals tools, such as Process Explorer, do not suffer from + this problem. + + + + + + + Poor Performance Caused by Host Power Management + + + On some hardware platforms and operating systems, virtualization + performance is negatively affected by host CPU power management. + The symptoms may be choppy audio in the guest or erratic guest + clock behavior. + + + + Some of the problems may be caused by firmware and/or host + operating system bugs. Therefore, updating the firmware and + applying operating systems fixes is recommended. + + + + For optimal virtualization performance, the C1E power state + support in the system's BIOS should be disabled, if such a + setting is available. Not all systems support the C1E power + state. On Intel systems, the Intel C State + setting should be disabled. Disabling other power management + settings may also improve performance. However, a balance + between performance and power consumption must always be + considered. + + + + + + + GUI: 2D Video Acceleration Option is Grayed Out + + + To use 2D Video Acceleration within &product-name;, your host's + video card should support certain OpenGL extensions. On startup, + &product-name; checks for those extensions, and, if the test + fails, this option is silently grayed out. + + + + To find out why it has failed, you can manually execute the + following command: + + +$ VBoxTestOGL --log "log_file_name" --test 2D + + + It will list the required OpenGL extensions one by one and will + show you which one failed the test. This usually means that you + are running an outdated or misconfigured OpenGL driver on your + host. It can also mean that your video chip is lacking required + functionality. + + + + + + + + + Windows Guests + + + + No USB 3.0 Support in Windows 7 Guests + + + If a Windows 7 or Windows Server 2008 R2 guest is configured for + USB 3.0 (xHCI) support, the guest OS will not have any USB + support at all. This happens because Windows 7 predates USB 3.0 + and therefore does not ship with any xHCI drivers. Microsoft + also does not offer any vendor-provided xHCI drivers through + Windows Update. + + + + To solve this problem, it is necessary to download and install + the Intel xHCI driver in the guest. Intel offers the driver as + the USB 3.0 eXtensible Host Controller (xHCI) driver for Intel 7 + Series/C216 chipsets. + + + + Note that the driver only supports Windows 7 and Windows Server + 2008 R2. The driver package includes support for both 32-bit and + 64-bit OS variants. + + + + + + + Windows Bluescreens After Changing VM Configuration + + + Changing certain virtual machine settings can cause Windows + guests to fail during start up with a bluescreen. This may + happen if you change VM settings after installing Windows, or if + you copy a disk image with an already installed Windows to a + newly created VM which has settings that differ from the + original machine. + + + + This applies in particular to the following settings: + + + + + + + The ACPI and I/O APIC settings should never be changed after + installing Windows. Depending on the presence of these + hardware features, the Windows installation program chooses + special kernel and device driver versions and will fail to + startup should these hardware features be removed. Enabling + them for a Windows VM which was installed without them does + not cause any harm. However, Windows will not use these + features in this case. + + + + + + Changing the storage controller hardware will cause bootup + failures as well. This might also apply to you if you copy a + disk image from an older version of &product-name; to a new + virtual machine. The default subtype of IDE controller + hardware used by &product-name; is PIIX4. Make sure that the + storage controller settings are identical. + + + + + + + + + + Windows 0x101 Bluescreens with SMP Enabled (IPI Timeout) + + + If a VM is configured to have more than one processor + (symmetrical multiprocessing, SMP), some configurations of + Windows guests crash with an 0x101 error message, indicating a + timeout for interprocessor interrupts (IPIs). These interrupts + synchronize memory management between processors. + + + + According to Microsoft, this is due to a race condition in + Windows. A hotfix is available from Microsoft. + + + + If this does not help, please reduce the number of virtual + processors to 1. + + + + + + + Windows 2000 Installation Failures + + + When installing Windows 2000 guests, you might run into one of + the following issues: + + + + + + + Installation reboots, usually during component registration. + + + + + + Installation fills the whole hard disk with empty log files. + + + + + + Installation complains about a failure installing + msgina.dll. + + + + + + + These problems are all caused by a bug in the hard disk driver + of Windows 2000. After issuing a hard disk request, there is a + race condition in the Windows driver code which leads to + corruption if the operation completes too fast. For example, the + hardware interrupt from the IDE controller arrives too soon. + With physical hardware, there is a guaranteed delay in most + systems so the problem is usually hidden there. However, it + should be possible to also reproduce it on physical hardware. In + a virtual environment, it is possible for the operation to be + done immediately, especially on very fast systems with multiple + CPUs, and the interrupt is signaled sooner than on a physical + system. The solution is to introduce an artificial delay before + delivering such interrupts. This delay can be configured for a + VM using the following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/Devices/piix3ide/0/Config/IRQDelay" 1 + + + This sets the delay to one millisecond. In case this does not + help, increase it to a value between 1 and 5 milliseconds. + Please note that this slows down disk performance. After + installation, you should be able to remove the key, or set it to + 0. + + + + + + + How to Record Bluescreen Information from Windows Guests + + + When Windows guests run into a kernel crash, they display a + bluescreen error. Depending on how Windows is configured, the + information will remain on the screen until the machine is + restarted or it will reboot automatically. During installation, + Windows is usually configured to reboot automatically. With + automatic reboots, there is no chance to record the bluescreen + information which might be important for problem determination. + + + + &product-name; provides a method of halting a guest when it + wants to perform a reset. In order to enable this feature, use + the following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/PDM/HaltOnReset" 1 + + + + + + No Networking in Windows Vista Guests + + + With Windows Vista, Microsoft dropped support for the AMD PCNet + card that legacy versions of &product-name; used to provide as + the default virtual network card. For Windows Vista guests, + &product-name; now uses an Intel E1000 card by default. + + + + If, for some reason, you still want to use the AMD card, you + need to download the PCNet driver from the AMD website. This + driver is available for 32-bit Windows only. You can transfer it + into the virtual machine using a shared folder. See + . + + + + + + + Windows Guests may Cause a High CPU Load + + + Several background applications of Windows guests, especially + virus scanners, are known to increase the CPU load notably even + if the guest appears to be idle. We recommend to deactivate + virus scanners within virtualized guests if possible. + + + + + + + Long Delays When Accessing Shared Folders + + + The performance for accesses to shared folders from a Windows + guest might be decreased due to delays during the resolution of + the &product-name; shared folders name service. To fix these + delays, add the following entries to the file + \windows\system32\drivers\etc\lmhosts of + the Windows guest: + + +255.255.255.255 VBOXSVR #PRE +255.255.255.255 VBOXSRV #PRE + + + After doing this change, a reboot of the guest is required. + + + + + + + USB Tablet Coordinates Wrong in Windows 98 Guests + + + If a Windows 98 VM is configured to use the emulated USB tablet + (absolute pointing device), the coordinate translation may be + incorrect and the pointer is restricted to the upper left + quarter of the guest's screen. + + + + The USB HID (Human Interface Device) drivers in Windows 98 are + very old and do not handle tablets in the same way as modern + operating systems do. To work around the problem, use the + following command: + + +$ VBoxManage setextradata VM-name "VBoxInternal/USB/HidMouse/0/Config/CoordShift" 0 + + + To restore the default behavior, remove the key or set its value + to 1. + + + + + + + Windows Guests are Removed From an Active Directory Domain After + Restoring a Snapshot + + + If a Windows guest is a member of an Active Directory domain and + the snapshot feature of &product-name; is used, it could be + removed from the Active Direcory domain after you restore an + older snapshot. + + + + This is caused by automatic machine password changes performed + by Windows at regular intervals for security purposes. You can + disable this feature as shown in the following article from + Microsoft: + . + + + + + + + Windows 3.x Limited to 64 MB RAM + + + Windows 3.x guests are typically limited to 64 MB RAM, even if a + VM is assigned much more memory. While Windows 3.1 is + theoretically capable of using up to 512 MB RAM, it only uses + memory available through the XMS interface. Versions of + HIMEM.SYS, the Microsoft XMS manager, shipped with MS-DOS and + Microsoft Windows 3.x can only use up to 64 MB on standard PCs. + + + + This is a known HIMEM.SYS limitation. Windows 3.1 memory limits + are described in detail in Microsoft Knowledge base article KB + 84388. + + + + It is possible for Windows 3.x guests to utilize more than 64 MB + RAM if a different XMS provider is used. That could be a newer + HIMEM.SYS version, such as that shipped with Windows 98, or a + more capable third-party memory manager, such as QEMM. + + + + + + + + + Linux and X11 Guests + + + + Linux Guests May Cause a High CPU load + + + Some Linux guests may cause a high CPU load even if the guest + system appears to be idle. This can be caused by a high timer + frequency of the guest kernel. Some Linux distributions, for + example Fedora, ship a Linux kernel configured for a timer + frequency of 1000Hz. We recommend to recompile the guest kernel + and to select a timer frequency of 100Hz. + + + + Linux kernels shipped with Red Hat Enterprise Linux, as well as + kernels of related Linux distributions, such as CentOS and + Oracle Linux, support a kernel parameter + divider=N. Hence, such kernels support a + lower timer frequency without recompilation. We suggest you add + the kernel parameter divider=10 to select a + guest kernel timer frequency of 100Hz. + + + + + + + Buggy Linux 2.6 Kernel Versions + + + The following bugs in Linux kernels prevent them from executing + correctly in &product-name;, causing VM boot crashes: + + + + + + + The Linux kernel version 2.6.18, and some 2.6.17 versions, + introduced a race condition that can cause boot crashes in + &product-name;. Please use a kernel version 2.6.19 or later. + + + + + + With hardware virtualization and the I/O APIC enabled, + kernels before 2.6.24-rc6 may panic on boot with the + following message: + + +Kernel panic - not syncing: IO-APIC + timer doesn't work! Boot with +apic=debug and send a report. Then try booting with the 'noapic' option + + + If you see this message, either disable hardware + virtualization or the I/O APIC as described in + , or upgrade the guest to + a newer kernel. + + + + See + + for details about the kernel fix. + + + + + + + + + + Shared Clipboard, Auto-Resizing, and Seamless Desktop in X11 Guests + + + Guest desktop services in guests running the X11 window system + such as Oracle Solaris and Linux, are provided by a guest + service called VBoxClient, which runs under + the ID of the user who started the desktop session and is + automatically started using the following command lines when + your X11 user session is started if you are using a common + desktop environment such as Gnome or KDE. + + +$ VBoxClient --clipboard +$ VBoxClient --display +$ VBoxClient --seamless + + + If a particular desktop service is not working correctly, it is + worth checking whether the process which should provide it is + running. + + + + The VBoxClient processes create files in the + user's home directory with names of the form + .vboxclient-*.pid when they are running in + order to prevent a given service from being started twice. It + can happen due to misconfiguration that these files are created + owned by root and not deleted when the services are stopped, + which will prevent them from being started in future sessions. + If the services cannot be started, you may wish to check whether + these files still exist. + + + + + + + + + Oracle Solaris Guests + + + + Certain Oracle Solaris 10 Releases May Take a Long Time to Boot with SMP + + + When using more than one CPU, Oracle Solaris 10 10/08, and + Oracle Solaris 10 5/09 may take a long time to boot and may + print warnings on the system console regarding failures to read + from disk. This is a bug in Oracle Solaris 10 which affects + specific physical and virtual configurations. It is caused by + trying to read microcode updates from the boot disk when the + disk interrupt is reassigned to a not yet fully initialized + secondary CPU. Disk reads will time out and fail, triggering + delays of about 45 seconds and warnings. + + + + The recommended solution is upgrading to at least Oracle Solaris + 10 10/09 which includes a fix for this problem. Alternative + solutions include restricting the number of virtual CPUs to one + or possibly using a different storage controller. + + + + + + + + + Windows Hosts + + + + VBoxSVC Out-of-Process COM Server Issues + + + &product-name; makes use of the Microsoft Component Object Model + (COM) for interprocess and intraprocess communication. This + enables &product-name; to share a common configuration among + different virtual machine processes and provide several user + interface options based on a common architecture. All global + status information and configuration is maintained by the + process VBoxSVC.exe, which is an + out-of-process COM server. Whenever an &product-name; process is + started, it requests access to the COM server and Windows + automatically starts the process. Note that it should never be + started by the end user. + + + + When the last process disconnects from the COM server, it will + terminate itself after some seconds. The &product-name; + configuration XML files are maintained and owned by the COM + server and the files are locked whenever the server runs. + + + + In some cases, such as when a virtual machine is terminated + unexpectedly, the COM server will not notice that the client is + disconnected and stay active for a longer period of 10 minutes + or so, keeping the configuration files locked. In other rare + cases the COM server might experience an internal error and + subsequently other processes fail to initialize it. In these + situations, it is recommended to use the Windows task manager to + kill the process VBoxSVC.exe. + + + + + + + CD and DVD Changes Not Recognized + + + In case you have assigned a physical CD or DVD drive to a guest + and the guest does not notice when the medium changes, make sure + that the Windows media change notification (MCN) feature is not + turned off. This is represented by the following key in the + Windows registry: + + +HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Cdrom\Autorun + + + Certain applications may disable this key against Microsoft's + advice. If it is set to 0, change it to 1 and reboot your + system. &product-name; relies on Windows notifying it of media + changes. + + + + + + + Sluggish Response When Using Microsoft RDP Client + + + If connecting to a Virtual Machine using the Microsoft RDP + client, called a Remote Desktop Connection, there can be large + delays between input such as moving the mouse over a menu and + output. This is because this RDP client collects input for a + certain time before sending it to the RDP server. + + + + The interval can be decreased by setting a Windows registry key + to smaller values than the default of 100. The key does not + exist initially and must be of type DWORD. The unit for its + values is milliseconds. Values around 20 are suitable for + low-bandwidth connections between the RDP client and server. + Values around 4 can be used for a gigabit Ethernet connection. + Generally values below 10 achieve a performance that is very + close to that of the local input devices and screen of the host + on which the Virtual Machine is running. + + + + Depending whether the setting should be changed for an + individual user or for the system, set either of the following. + + +HKEY_CURRENT_USER\Software\Microsoft\Terminal Server Client\Min Send Interval + +HKEY_LOCAL_MACHINE\Software\Microsoft\Terminal Server Client\Min Send Interval + + + + + + Running an iSCSI Initiator and Target on a Single System + + + Deadlocks can occur on a Windows host when attempting to access + an iSCSI target running in a guest virtual machine with an iSCSI + initiator, such as a Microsoft iSCSI Initiator, that is running + on the host. This is caused by a flaw in the Windows cache + manager component, and causes sluggish host system response for + several minutes, followed by a "Delayed Write Failed" error + message in the system tray or in a separate message window. The + guest is blocked during that period and may show error messages + or become unstable. + + + + Setting the VBOX_DISABLE_HOST_DISK_CACHE + environment variable to 1 enables a + workaround for this problem until Microsoft addresses the issue. + For example, open a command prompt window and start + &product-name; like this: + + +set VBOX_DISABLE_HOST_DISK_CACHE=1 +VirtualBox + + + While this will decrease guest disk performance, especially + writes, it does not affect the performance of other applications + running on the host. + + + + + + + Bridged Networking Adapters Missing + + + If no bridged adapters show up in the + Networking section of the VM + settings, this typically means that the bridged networking + driver was not installed properly on your host. This could be + due to the following reasons: + + + + + + + The maximum allowed filter count was reached on the host. In + this case, the MSI log would mention the + 0x8004a029 error code returned on NetFlt + network component install, as follows: + + +VBoxNetCfgWinInstallComponent: Install failed, hr (0x8004a029) + + + You can try to increase the maximum filter count in the + Windows registry using the following key: + + +HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Network\MaxNumFilters + + + The maximum number allowed is 14. After a reboot, try to + reinstall &product-name;. + + + + + + The INF cache is corrupt. In this case, the install log at + %windir%\inf\setupapi.dev.log would + typically mention the failure to find a suitable driver + package for either the sun_VBoxNetFlt or + sun_VBoxNetFltmp components. The solution + then is to uninstall &product-name;, remove the INF cache + (%windir%\inf\INFCACHE.1), reboot and + try to reinstall &product-name;. + + + + + + + + + + Host-Only Networking Adapters Cannot be Created + + + If a host-only adapter cannot be created, either with the + VirtualBox Manager or the VBoxManage command, + then the INF cache is probably corrupt. In this case, the + install log at + %windir%\inf\setupapi.dev.log would + typically mention the failure to find a suitable driver package + for the sun_VBoxNetAdp component. Again, as + with the bridged networking problem described above, the + solution is to uninstall &product-name;, remove the INF cache + (%windir%\inf\INFCACHE.1), reboot and try + to reinstall &product-name;. + + + + + + + + + Linux Hosts + + + + Linux Kernel Module Refuses to Load + + + If the &product-name; kernel module, vboxdrv, + refuses to load you may see an Error inserting vboxdrv: + Invalid argument message. As root, check the output of + the dmesg command to find out why the load + failed. Most probably the kernel disagrees with the version of + gcc used to compile the module. Make sure + that you use the same compiler that was used to build the + kernel. + + + + + + + Linux Host CD/DVD or Floppy Disk Drive Not Found + + + If you have configured a virtual machine to use the host's CD or + DVD drive or floppy disk drive, but this does not appear to + work, make sure that the current user has permission to access + the corresponding Linux device file. For example, for a CD or + DVD drive this may be /dev/hdc, + /dev/scd0, /dev/cdrom + or similar. On most distributions, the user must be added to a + corresponding group, usually called cdrom or + cdrw or floppy. + + + + On supported Linux distributions, &product-name; uses + udev to locate hardware such as CD/DVD drives + and floppy disk drives. + + + + + + + Strange Guest IDE Error Messages When Writing to CD or DVD + + + If the experimental CD or DVD writer support is enabled with an + incorrect host or guest configuration, it is possible that any + attempt to access the CD or DVD writer fails and simply results + in guest kernel error messages for Linux guests or application + error messages for Windows guests. &product-name; performs the + usual consistency checks when a VM is powered up. In particular, + it aborts with an error message if the device for the CD or DVD + writer is not writable by the user starting the VM. But + &product-name; cannot detect all misconfigurations. The + necessary host and guest OS configuration is not specific for + &product-name;, but a few frequent problems are listed here + which occurred in connection with &product-name;. + + + + Special care must be taken to use the correct device. The + configured host CD or DVD device file name, in most cases + /dev/cdrom, must point to the device that + allows writing to the CD or DVD unit. For CD or DVD writer units + connected to a SCSI controller or to a IDE controller that + interfaces to the Linux SCSI subsystem, common for some SATA + controllers, this must refer to the SCSI device node, such as + /dev/scd0. Even for IDE CD or DVD writer + units this must refer to the appropriate SCSI CD-ROM device + node, such as /dev/scd0, if the + ide-scsi kernel module is loaded. This module + is required for CD or DVD writer support with some early 2.6 + kernels. Many Linux distributions load this module whenever a CD + or DVD writer is detected in the system, even if the kernel + would support CD or DVD writers without the module. + &product-name; supports the use of IDE device files, such as + /dev/hdc, provided the kernel supports this + and the ide-scsi module is not loaded. + + + + Similar rules, except that within the guest the CD or DVD writer + is always an IDE device, apply to the guest configuration. Since + this setup is very common, it is likely that the default + configuration of the guest works as expected. + + + + + + + VBoxSVC IPC Issues + + + On Linux, &product-name; makes use of a custom version of + Mozilla XPCOM (cross platform component object model) for + interprocess and intraprocess communication (IPC). The process + VBoxSVC serves as a communication hub between + different &product-name; processes and maintains the global + configuration, such as the XML database. When starting an + &product-name; component, the processes + VBoxSVC and VBoxXPCOMIPCD + are started automatically. They are only accessible from the + user account they are running under. VBoxSVC + owns the &product-name; configuration database which normally + resides in ~/.config/VirtualBox, or the + appropriate configuration directory for your operating system. + While it is running, the configuration files are locked. + Communication between the various &product-name; components and + VBoxSVC is performed through a local domain + socket residing in + /tmp/.vbox-username-ipc. + In case there are communication problems, such as an + &product-name; application cannot communicate with + VBoxSVC, terminate the daemons and remove the + local domain socket directory. + + + + + + + USB Not Working + + + If USB is not working on your Linux host, make sure that the + current user is a member of the vboxusers + group. Please keep in mind that group membership does not take + effect immediately but rather at the next login. If available, + the newgrp command may avoid the need for a + logout and login. + + + + + + + PAX/grsec Kernels + + + Linux kernels including the grsec patch, see + , and derivates have + to disable PAX_MPROTECT for the VBox binaries + to be able to start a VM. The reason is that &product-name; has + to create executable code on anonymous memory. + + + + + + + Linux Kernel vmalloc Pool Exhausted + + + When running a large number of VMs with a lot of RAM on a Linux + system, say 20 VMs with 1 GB of RAM each, additional VMs might + fail to start with a kernel error saying that the vmalloc pool + is exhausted and should be extended. The error message also + tells you to specify vmalloc=256MB in your + kernel parameter list. If adding this parameter to your GRUB or + LILO configuration makes the kernel fail to boot, with an error + message such as failed to mount the root + partition, then you have probably run into a memory + conflict of your kernel and initial RAM disk. This can be solved + by adding the following parameter to your GRUB configuration: + + +uppermem 524288 + + + + + + + + Oracle Solaris Hosts + + + + Cannot Start VM, Not Enough Contiguous Memory + + + The ZFS file system is known to use nearly all available RAM as + cache if the default system settings are not changed. This may + lead to a heavy fragmentation of the host memory preventing + &product-name; VMs from being started. We recommend to limit the + ZFS cache by adding the following line to + /etc/system, where + xxxx bytes is the amount of memory + usable for the ZFS cache. + + +set zfs:zfs_arc_max = xxxx + + + + + + diff --git a/doc/manual/en_US/user_VBoxManage.xml b/doc/manual/en_US/user_VBoxManage.xml new file mode 100644 index 00000000..a488350e --- /dev/null +++ b/doc/manual/en_US/user_VBoxManage.xml @@ -0,0 +1,8969 @@ + + + +%all.entities; +]> + + + VBoxManage + + + + Introduction + + + As briefly mentioned in , + VBoxManage is the command-line interface to + &product-name;. With it, you can completely control &product-name; + from the command line of your host operating system. + VBoxManage supports all the features that the + graphical user interface gives you access to, but it supports a + lot more than that. It exposes all the features of the + virtualization engine, even those that cannot be accessed from the + GUI. + + + + You will need to use the command line if you want to do the + following: + + + + + + + Use a different user interface than the main GUI such as the + VBoxHeadless server. + + + + + + Control some of the more advanced and experimental + configuration settings for a VM. + + + + + + + There are two main things to keep in mind when using + VBoxManage. First, + VBoxManage must always be used with a specific + subcommand, such as list or + createvm or startvm. All the + subcommands that VBoxManage supports are + described in detail in . + + + + Second, most of these subcommands require that you specify a + particular virtual machine after the subcommand. There are two + ways you can do this: + + + + + + + You can specify the VM name, as it is shown in the + &product-name; GUI. Note that if that name contains spaces, + then you must enclose the entire name in double quotes. This + is always required with command line arguments that contain + spaces. For example: + + +VBoxManage startvm "Windows XP" + + + + + You can specify the UUID, which is the internal unique + identifier that &product-name; uses to refer to the virtual + machine. Assuming that the VM called "Windows XP" has the UUID + shown below, the following command has the same effect as the + previous example: + + +VBoxManage startvm 670e746d-abea-4ba6-ad02-2a3b043810a5 + + + + + + You can enter VBoxManage list vms to have all + currently registered VMs listed with all their settings, including + their respective names and UUIDs. + + + + Some typical examples of how to control &product-name; from the + command line are listed below: + + + + + + + To create a new virtual machine from the command line and + immediately register it with &product-name;, use + VBoxManage createvm with the + option, as follows: + + +$ VBoxManage createvm --name "SUSE 10.2" --register +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2018 Oracle Corporation +All rights reserved. + +Virtual machine 'SUSE 10.2' is created. +UUID: c89fc351-8ec6-4f02-a048-57f4d25288e5 +Settings file: '/home/username/.config/VirtualBox/Machines/SUSE 10.2/SUSE 10.2.xml' + + + As can be seen from the above output, a new virtual machine + has been created with a new UUID and a new XML settings file. + + + + For more details, see + . + + + + + + To show the configuration of a particular VM, use + VBoxManage showvminfo. See + for details + and an example. + + + + + + To change settings while a VM is powered off, use + VBoxManage modifyvm. For example: + + +VBoxManage modifyvm "Windows XP" --memory 512 + + + See also . + + + + + + To change the storage configuration, such as to add a storage + controller and then a virtual disk, use VBoxManage + storagectl and VBoxManage + storageattach. See + and + . + + + + + + To control VM operation, use one of the following: + + + + + + + To start a VM that is currently powered off, use + VBoxManage startvm. See + . + + + + + + To pause or save a VM that is currently running or change + some of its settings, use VBoxManage + controlvm. See + . + + + + + + + + + + + + + Commands Overview + + + When running VBoxManage without parameters or + when supplying an invalid command line, the following command + syntax list is shown. Note that the output will be slightly + different depending on the host platform. If in doubt, check the + output of VBoxManage for the commands available + on your particular host. + + + + + + Each time VBoxManage is invoked, only one + command can be executed. However, a command might support several + subcommands which then can be invoked in one single call. The + following sections provide detailed reference information on the + different commands. + + + + + + + General Options + + + + + + : Show the version of this tool + and exit. + + + + + + : Suppress the output of the logo + information. This option is useful for scripts. + + + + + + : Specifiy a settings password. + + + + + + : Specify a file containing + the settings password. + + + + + + + The settings password is used for certain settings which need to + be stored in encrypted form for security reasons. At the moment, + the only encrypted setting is the iSCSI initiator secret, see + . As long as no + settings password is specified, this information is stored in + plain text. After using the + option once, it + must be always used. Otherwise, the encrypted setting cannot be + unencrypted. + + + + + + + VBoxManage list + + + The list command gives relevant information + about your system and information about &product-name;'s current + settings. + + + + The following subcommands are available with VBoxManage + list: + + + + + + + vms: Lists all virtual machines currently + registered with &product-name;. By default this displays a + compact list with each VM's name and UUID. If you also specify + or , this will be a + detailed list as with the showvminfo + command, see . + + + + + + runningvms: Lists all currently running + virtual machines by their unique identifiers (UUIDs) in the + same format as with vms. + + + + + + ostypes: Lists all guest operating systems + presently known to &product-name;, along with the identifiers + used to refer to them with the modifyvm + command. + + + + + + hostdvds, hostfloppies: + Lists the DVD, floppy, bridged networking, and host-only + networking interfaces on the host, along with the name used to + access them from within &product-name;. + + + + + + intnets: Displays information about the + internal networks. + + + + + + bridgedifs, hostonlyifs, + natnets, dhcpservers: + Lists the bridged network interfaces, host-only network + interfaces, NAT network interfaces, and DHCP servers currently + available on the host. See + . + + + + + + hostinfo: Displays information about the + host system, such as CPUs, memory size, and operating system + version. + + + + + + hostcpuids: Lists the CPUID parameters for + the host CPUs. This can be used for a more fine grained + analyis of the host's virtualization capabilities. + + + + + + hddbackends: Lists all known virtual disk + back-ends of &product-name;. For each such format, such as + VDI, VMDK, or RAW, this subcommand lists the back-end's + capabilities and configuration. + + + + + + hdds, dvds, + floppies: Shows information about virtual + disk images currently in use by &product-name;, including all + their settings, the unique identifiers (UUIDs) associated with + them by &product-name; and all files associated with them. + This is the command-line equivalent of the Virtual Media + Manager. See . + + + + + + usbhost: Shows information about USB + devices attached to the host, including information useful for + constructing USB filters and whether they are currently in use + by the host. + + + + + + usbfilters: Lists all global USB filters + registered with &product-name; and displays the filter + parameters. Global USB filters are for devices which are + accessible to all virtual machines. + + + + + + systemproperties: Displays some global + &product-name; settings, such as minimum and maximum guest RAM + and virtual hard disk size, folder settings and the current + authentication library in use. + + + + + + extpacks: Displays all &product-name; + extension packs that are currently installed. See + and + . + + + + + + groups: Displays details of the VM Groups. + See . + + + + + + webcams: Displays a list of webcams + attached to the running VM. The output format is a list of + absolute paths or aliases that were used for attaching the + webcams to the VM using the webcam attach command. + + + + + + screenshotformats: Displays a list of + available screenshot formats. + + + + + + cloudproviders: Displays a list of cloud + providers that are supported by &product-name;. &oci; is an + example of a cloud provider. + + + + + + cloudprofiles: Displays a list of cloud + profiles that have been configured. + + + + Cloud profiles are used when exporting VMs to a cloud service. + See . + + + + + + + + + + VBoxManage showvminfo + + + The showvminfo command shows information about + a particular virtual machine. This is the same information as + VBoxManage list vms --long would show for all + virtual machines. + + + + You will see information as shown in the following example. + + +$ VBoxManage showvminfo "Windows XP" +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2018 Oracle Corporation +All rights reserved. + +Name: Windows XP +Guest OS: Other/Unknown +UUID: 1bf3464d-57c6-4d49-92a9-a5cc3816b7e7 +Config file: /home/username/.config/VirtualBox/Machines/Windows XP/Windows XP.xml +Memory size: 512MB +VRAM size: 12MB +Number of CPUs: 2 +Boot menu mode: message and menu +Boot Device (1): DVD +Boot Device (2): HardDisk +Boot Device (3): Not Assigned +Boot Device (4): Not Assigned +ACPI: on +IOAPIC: on +... + + + + Use the option to produce the + same output, but in machine readable format with a property=value + string on each line. For example: + + + +... +groups="/" +ostype="Oracle (64-bit)" +UUID="457af700-bc0a-4258-aa3c-13b03da171f2" +... + + + + + + + VBoxManage registervm/unregistervm + + + The registervm command enables + you to import a virtual machine definition in an XML file into + &product-name;. The machine must not conflict with one already + registered in &product-name; and it may not have any hard or + removable disks attached. It is advisable to place the definition + file in the machines folder before registering it. + + + + + When creating a new virtual machine with VBoxManage + createvm, as shown in + , you can directly specify + the option to avoid having to + register it separately. + + + + + The unregistervm command unregisters a virtual + machine. If is also specified, the + following files will also be deleted automatically: + + + + + + + All hard disk image files, including differencing files, which + are used by the machine and not shared with other machines. + + + + + + Saved state files that the machine created. One if the machine + was in Saved state and one for each online snapshot. + + + + + + The machine XML file and its backups. + + + + + + The machine log files. + + + + + + The machine directory, if it is empty after having deleted all + of the above files. + + + + + + + + + + VBoxManage createvm + + + The VBoxManage createvm command creates a new + XML virtual machine definition file. + + + + You must specify the name of the VM by using . This name is used by + default as the file name of the settings file that has the + .xml extension and the machine folder, which + is a subfolder of the + .config/VirtualBox/Machines folder. Note that + the machine folder path name varies based on the OS type and the + &product-name; version. + + + + Ensure that the VM name conforms to the host OS's file name + requirements. If you later rename the VM, the file and folder + names will be updated to match the new name automatically. + + + + The + option specifies the machine folder path name. Note that the names + of the file and the folder do not change if you rename the VM. + + + + The option assigns the VM to the specified groups. Note + that group IDs always start with + / so that they can be nested. By + default, each VM is assigned membership to the + / group. + + + + The + option specifies the guest OS to run in the VM. Run the + VBoxManage list ostypes command to see the + available OS types. + + + + The option + specifies the universal unique identifier (UUID) of the VM. The + UUID must be unique within the namespace of the host or of its VM + group memberships. By default, the VBoxManage + command automatically generates the UUID. + + + + The --default option applies a + default hardware configuration for the specified guest OS. By + default, the VM is created with minimal hardware. + + + + The option registers the VM with your + &product-name; installation. By default, the VBoxManage + createvm command creates only the XML configuration for + the VM but does not registered the VM. If you do not register the + VM at creation, you can run the VBoxManage + registervm command after you create the VM. + + + + + + + VBoxManage modifyvm + + + This command changes the properties of a registered virtual + machine which is not running. Most of the properties that this + command makes available correspond to the VM settings that the + VirtualBox Manager displays in each VM's + Settings dialog. These are + described in . However, some of + the more advanced settings are only available through the + VBoxManage interface. + + + + These commands require that the machine is powered off, neither + running nor in a Saved state. Some machine settings can also be + changed while a machine is running. Those settings will then have + a corresponding subcommand with the VBoxManage + controlvm subcommand. See + . + + + + + General Settings + + + The following general settings are available through + VBoxManage modifyvm: + + + + + + + --name <name>: + Changes the VM's name and can be used to rename the internal + virtual machine files, as described in + . + + + + + + --groups <group>, + ...: Changes the group membership of a VM. + Groups always start with a + / and can be nested. By + default VMs are in group /. + + + + + + --description <desc>: + Changes the VM's description, which is a way to record + details about the VM in a way which is meaningful for the + user. The GUI interprets HTML formatting, the command line + allows arbitrary strings potentially containing multiple + lines. + + + + + + --ostype <ostype>: + Specifies what guest operating system is supposed to run in + the VM. To learn about the various identifiers that can be + used here, use VBoxManage list ostypes. + + + + + + --iconfile + <filename>: Specifies the absolute + path on the host file system for the &product-name; icon to + be displayed in the VM. + + + + + + --memory + <memorysize>: Sets the amount of RAM, + in MB, that the virtual machine should allocate for itself + from the host. See . + + + + + + --pagefusion on|off: + Enables and disables the Page Fusion feature. Page Fusion is + disabled by default. The Page Fusion feature minimises + memory duplication between VMs with similar configurations + running on the same host. See + . + + + + + + --vram <vramsize>: + Sets the amount of RAM that the virtual graphics card should + have. See . + + + + + + --acpi on|off and + --ioapic on|off: Determines + whether the VM has ACPI and I/O APIC support. See + . + + + + + + --pciattach <host PCI address [@ guest + PCI bus address]>: Attaches a specified + PCI network controller on the host to a specified PCI bus on + the guest. + + + + + + + + --pcidetach <host PCI + address>: Detaches a specified PCI + network controller on the host from the attached PCI bus on + the guest. + + + + + + + + --hardwareuuid + <uuid>: The UUID presented to the + guest through memory tables (DMI/SMBIOS), hardware, and + guest properties. By default this is the same as the VM + UUID. This setting is useful when cloning a VM. Teleporting + takes care of this automatically. + + + + + + --cpus <cpucount>: + Sets the number of virtual CPUs for the virtual machine, see + . If CPU hot-plugging + is enabled, this then sets the maximum + number of virtual CPUs that can be plugged into the virtual + machines. + + + + + + --cpuhotplug on|off: + Enables CPU hot-plugging. When enabled, virtual CPUs can be + added to and removed from a virtual machine while it is + running. See . + + + + + + --plugcpu|unplugcpu + <id>: If CPU hot-plugging is enabled, + this setting adds or removes a virtual CPU on the virtual + machine. <id> + specifies the index of the virtual CPU to be added or + removed and must be a number from 0 to the maximum number of + CPUs configured with the + --cpus option. CPU 0 can + never be removed. + + + + + + --cpuexecutioncap + <1-100>: Controls how much CPU time a + virtual CPU can use. A value of 50 implies a single virtual + CPU can use up to 50% of a single host CPU. + + + + + + --pae on|off: Enables and + disables PAE. See . + + + + + + --longmode on|off: Enables + and disables long mode. See + . + + + + + + --spec-ctrl on|off: Enables + and disables the exposure of speculation control interfaces + to the guest, provided they are available on the host. + Depending on the host CPU and workload, enabling speculation + control may significantly reduce performance. + + + + + + --cpu-profile <host|intel + 80[86|286|386]>: Enables specification + of a profile for guest CPU emulation. Specify either one + based on the host system CPU (host), or one from a number of + older Intel Micro-architectures: 8086, 80286, 80386. + + + + + + --hpet on|off: Enables and + disables a High Precision Event Timer (HPET) which can + replace the legacy system timers. This is turned off by + default. Note that Windows supports a HPET only from Vista + onwards. + + + + + + --hwvirtex on|off: Enables + and disables the use of hardware virtualization extensions, + such as Intel VT-x or AMD-V, in the processor of your host + system. See . + + + + + + --triplefaultreset on|off: + Enables resetting of the guest instead of triggering a Guru + Meditation. Some guests raise a triple fault to reset the + CPU so sometimes this is desired behavior. Works only for + non-SMP guests. + + + + + + --apic on|off: Enables and + disables I/O APIC. With I/O APIC, operating systems can use + more than 16 interrupt requests (IRQs) thus avoiding IRQ + sharing for improved reliability. This setting is enabled by + default. See . + + + + + + --x2apic on|off: Enables + and disables CPU x2APIC support. CPU x2APIC support helps + operating systems run more efficiently on high core count + configurations, and optimizes interrupt distribution in + virtualized environments. This setting is enabled by + default. Disable this setting when using host or guest + operating systems that are incompatible with x2APIC support. + + + + + + --paravirtprovider + none|default|legacy|minimal|hyperv|kvm: + Specifies which paravirtualization interface to provide to + the guest operating system. Specifying + none explicitly turns off + exposing any paravirtualization interface. The option + default selects an + appropriate interface when starting the VM, depending on the + guest OS type. This is the default option chosen when + creating new VMs. The + legacy option is used for + VMs which were created with older &product-name; versions + and will pick a paravirtualization interface when starting + the VM with &product-name; 5.0 and newer. The + minimal provider is + mandatory for Mac OS X guests. + kvm and + hyperv are recommended for + Linux and Windows guests respectively. These options are + explained in . + + + + + + --paravirtdebug <keyword=value> + [,<keyword=value> ...]: Specifies + debugging options specific to the paravirtualization + provider configured for this VM. See the provider specific + options in for a list of + supported keyword-value pairs for each provider. + + + + + + --nestedpaging on|off: If + hardware virtualization is enabled, this additional setting + enables or disables the use of the nested paging feature in + the processor of your host system. See + and + . + + + + + + --largepages on|off: If + hardware virtualization and nested + paging are enabled, for Intel VT-x only, an additional + performance improvement of up to 5% can be obtained by + enabling this setting. This causes the hypervisor to use + large pages to reduce TLB use and overhead. + + + + + + --vtxvpid on|off: If + hardware virtualization is enabled, for Intel VT-x only, + this additional setting enables or disables the use of the + tagged TLB (VPID) feature in the processor of your host + system. See . + + + + + + --vtxux on|off: If hardware + virtualization is enabled, for Intel VT-x only, this setting + enables or disables the use of the unrestricted guest mode + feature for executing your guest. + + + + + + --nested-hw-virt on|off: If + hardware virtualization is enabled, this setting enables or + disables passthrough of hardware virtualization features to + the guest. See . + + + + + + --accelerate3d on|off: If + the Guest Additions are installed, this setting enables or + disables hardware 3D acceleration. See + . + + + + + + --accelerate2dvideo on|off: + If the Guest Additions are installed, this setting enables + or disables 2D video acceleration. See + . + + + + + + --chipset piix3|ich9: By + default, &product-name; emulates an Intel PIIX3 chipset. + Usually there is no reason to change the default setting + unless this is required to relax some of its constraints. + See . + + + + + + You can influence the BIOS logo that is displayed when a + virtual machine starts up with a number of settings. By + default, an &product-name; logo is displayed. + + + + With --bioslogofadein + on|off and + --bioslogofadeout on|off, + you can determine whether the logo should fade in and out, + respectively. + + + + With --bioslogodisplaytime + <msec> you can set how long the logo + should be visible, in milliseconds. + + + + With --bioslogoimagepath + <imagepath> you can replace the image + that is shown with your own logo. The image must be an + uncompressed 256 color BMP file without color space + information (Windows 3.0 format). The image must not be + bigger than 640 x 480. + + + + + + --biosbootmenu + disabled|menuonly|messageandmenu: Specifies + whether the BIOS enables the user to select a temporary boot + device. The menuonly option + suppresses the message, but the user can still press F12 to + select a temporary boot device. + + + + + + --biosapic + x2apic|apic|disabled: Specifies the + firmware APIC level to be used. Options are: x2apic, apic or + disabled (no apic or x2apic) respectively. + + + + Note that if x2apic is specified and x2APIC is unsupported + by the VCPU, biosapic downgrades to apic, if supported. + Otherwise biosapic downgrades to disabled. Similarly, if + apic is specified, and APIC is unsupported, a downgrade to + disabled results. + + + + + + --biossystemtimeoffset + <ms>: Specifies a fixed time offset, + in milliseconds, of the guest relative to the host time. If + the offset is positive, the guest time runs ahead of the + host time. + + + + + + --biospxedebug on|off: + Enables or disables additional debugging output when using + the Intel PXE boot ROM. The output is written to the release + log file. See . + + + + + + --system-uuid-le on|off: + Enables or disables representing the system UUID in little + endian form. The default value is on for + new VMs. For old VMs the setting is off + to keep the content of the DMI/SMBIOS table unchanged, which + can be important for Windows license activation. + + + + + + --boot<1-4> + none|floppy|dvd|disk|net: Specifies the + boot order for the virtual machine. There are four + slots, which the VM will try to access + from 1 to 4, and for each of which you can set a device that + the VM should attempt to boot from. + + + + + + --rtcuseutc on|off: Sets + the real-time clock (RTC) to operate in UTC time. See + . + + + + + + --graphicscontroller + none|vboxvga|vmsvga|vboxsvga: Specifies the + use of a graphics controller, with an option to choose a + specific type. See . + + + + + + --snapshotfolder + default|<path>: Specifies the folder + where snapshots are kept for a virtual machine. + + + + + + --firmware + bios|efi|efi32|efi64: Specifies the + firmware to be used to boot the VM: Available options are: + BIOS, or one of the EFI options: efi, efi32, or efi64. Use + EFI options with care. + + + + + + --guestmemoryballoon + <size> Sets the default size of the + guest memory balloon. This is the memory allocated by the + &product-name; Guest Additions from the guest operating + system and returned to the hypervisor for reuse by other + virtual machines. + <size> must be + specified in megabytes. The default size is 0 megabytes. See + . + + + + + + --defaultfrontend + default|<name>: Specifies the default + frontend to be used when starting this VM. See + . + + + + + + --vm-process-priority + default|flat|low|normal|high: Specifies the + priority scheme of the VM process to be used when starting + this VM and during VM execution. See + . + + + + + + + + + + Networking Settings + + + The following networking settings are available through + VBoxManage modifyvm. With all these settings, + the decimal number directly following the option name, 1-N in + the list below, specifies the virtual network adapter whose + settings should be changed. + + + + + + + --nic<1-N> + none|null|nat|natnetwork|bridged|intnet|hostonly|generic: + Configures the type of networking for each of the VM's + virtual network cards. Options are: not present + (none), not connected to + the host (null), use + network address translation + (nat), use the new network + address translation engine + (natnetwork), bridged + networking (bridged), or + use internal networking + (intnet), host-only + networking (hostonly), or + access rarely used sub-modes + (generic). These options + correspond to the modes described in + . + + + + + + --nictype<1-N> + Am79C970A|Am79C973|Am79C970|82540EM|82543GC|82545EM|virtio: + Enables you to specify the networking hardware that + &product-name; presents to the guest for a specified VM + virtual network card. See . + + + + + + --cableconnected<1-N> + on|off: Enables you to temporarily + disconnect a virtual network interface, as if a network + cable had been pulled from a real network card. This might + be useful, for example for resetting certain software + components in the VM. + + + + + + With the nictrace options, + you can optionally trace network traffic by dumping it to a + file, for debugging purposes. + + + + With --nictrace<1-N> + on|off, you can enable network tracing for + a particular virtual network card. + + + + If enabled, you must specify with + --nictracefile<1-N> + <filename> the absolute path of the + file the trace should be logged to. + + + + + + --nicproperty<1-N> + <paramname>="paramvalue": This + option, in combination with + nicgenericdrv enables you + to pass parameters to rarely-used network backends. + + + + These parameters are backend engine-specific, and are + different between UDP Tunnel and the VDE backend drivers. + For examples, see . + + + + + + --nicspeed<1-N> + <kbps>: Only has an effect if generic + networking has been enabled for a particular virtual network + card. See the --nic option. + This mode enables access to rarely used networking + sub-modes, such as VDE network or UDP Tunnel. This option + specifies the throughput rate in KBps. + + + + + + --nicbootprio<1-N> + <priority>: Specifies the order in + which NICs are tried for booting over the network, using + PXE. The priority is an integer in the 0 to 4 range. + Priority 1 is the highest, priority 4 is low. Priority 0, + which is the default unless otherwise specified, is the + lowest. + + + + Note that this option only has an effect when the Intel PXE + boot ROM is used. + + + + + + --nicpromisc<1-N> + deny|allow-vms|allow-all: Enables you to + specify how promiscuous mode is handled for the specified VM + virtual network card. This setting is only relevant for + bridged networking. deny, + the default setting, hides any traffic not intended for the + VM. allow-vms hides all + host traffic from the VM, but allows the VM to see traffic + to and from other VMs. + allow-all removes this + restriction completely. + + + + + + --nicbandwidthgroup<1-N> + none|<name>: Adds and removes an + assignment of a bandwidth group for the specified virtual + network interface. Specifying + none removes any current + bandwidth group assignment from the specified virtual + network interface. Specifying + <name> adds an + assignment of a bandwidth group to the specified virtual + network interface. + + + + See . + + + + + + --bridgeadapter<1-N> + none|<devicename>: Only has an effect + if bridged networking has been enabled for a virtual network + card. See the --nic option. + Use this option to specify which host interface the given + virtual network interface will use. See + . + + + + + + --hostonlyadapter<1-N> + none|<devicename>: Only has an effect + if host-only networking has been enabled for a virtual + network card. See the --nic + option. Use this option to specify which host-only + networking interface the given virtual network interface + will use. See . + + + + + + --intnet<1-N> + network: Only has an effect if internal + networking has been enabled for a virtual network card. See + the --nic option. Use this + option to specify the name of the internal network. See + . + + + + + + --nat-network<1-N> <network + name>: If the networking type is set to + natnetwork, not + nat, then this setting + specifies the name of the NAT network this adapter is + connected to. Optional. + + + + + + --nicgenericdrv<1-N> <backend + driver>: Only has an effect if generic + networking has been enabled for a virtual network card. See + the --nic option. This mode + enables you to access rarely used networking sub-modes, such + as VDE network or UDP Tunnel. + + + + + + --macaddress<1-N> + auto|<mac>: With this option you can + set the MAC address of a particular network adapter on the + VM. Normally, each network adapter is assigned a random + address by &product-name; at VM creation. + + + + + + + + NAT Networking Settings + + + The following NAT networking settings are available through + VBoxManage modifyvm. With all these + settings, the decimal number directly following the option + name, 1-N in the list below, specifies the virtual network + adapter whose settings should be changed. + + + + + + + --natnet<1-N> + <network>|default: If the + networking type is set to + nat, not + natnetwork, then this + setting specifies the IP address range to be used for this + network. See . + + + + + + --natpf<1-N> + [<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>], + <guestport>: Defines a NAT + port-forwarding rule. See . + + + + + + --natpf<1-N> delete + <name>: Deletes a NAT + port-forwarding rule. See . + + + + + + --nattftpprefix<1-N> + <prefix>: Defines a prefix for the + built-in TFTP server. For example, where the boot file is + located. See and + . + + + + + + --nattftpfile<1-N> + <bootfile>: Defines the TFT boot + file. See . + + + + + + --nattftpserver<1-N> + <tftpserver>: Defines the TFTP + server address to boot from. See + . + + + + + + --nattbindip<1-N> + <ip;>: &product-name;'s NAT engine + normally routes TCP/IP packets through the default + interface assigned by the host's TCP/IP stack. Use this + setting to instruct the NAT engine to bind to a specified + IP address instead. See + . + + + + + + --natdnspassdomain<1-N> + on|off: Specifies whether the built-in + DHCP server passes the domain name for network name + resolution. + + + + + + --natdnsproxy<1-N> + on|off: Makes the NAT engine proxy all + guest DNS requests to the host's DNS servers. See + . + + + + + + --natdnshostresolver<1-N> + on|off: Makes the NAT engine use the + host's resolver mechanisms to handle DNS requests. See + . + + + + + + --natsettings<1-N> + [<mtu>],[<socksnd>],[<sockrcv>],[<tcpsnd>], + [<tcprcv>]: Controls several NAT + settings. See . + + + + + + --nataliasmode<1-N> + default|[log],[proxyonly],[sameports]: + Defines behaviour of the NAT engine core: log - enables + logging, proxyonly - switches off aliasing mode and makes + NAT transparent, sameports - enforces the NAT engine to + send packets through the same port as they originated on, + default - disable all aliasing modes. See + . + + + + + + + + + + + + Miscellaneous Settings + + + The following hardware settings, such as serial port, audio, + clipboard, drag and drop, monitor, and USB settings are + available through VBoxManage modifyvm: + + + + + + + --mouse + <ps2|usb|usbtablet|usbmultitouch>: + Specifies the mode of the mouse to be used in the VM. + Available options are: ps2, usb, usbtablet, usbmultitouch. + + + + + + --keyboard <ps2|usb>: + Specifies the mode of the keyboard to be used in the VM. + Available options are: ps2, usb. + + + + + + --uart<1-N> off|<I/O base> + <IRQ>: Configures virtual serial + ports for the VM. See . + + + + + + --uartmode<1-N> + <arg>: Controls how &product-name; + connects a given virtual serial port, configured with the + --uartX setting, to the + host on which the virtual machine is running. As described + in , for each such port, you + can specify <arg> as + one of the following options: + + + + + + + disconnected: Even + though the serial port is shown to the guest, it has no + "other end". This is like a real COM port without a + cable. + + + + + + server + <pipename>: On a Windows host, + this tells &product-name; to create a named pipe on the + host named + <pipename> and + connect the virtual serial device to it. Note that + Windows requires that the name of a named pipe begins + with \\.\pipe\. + + + + On a Linux host, instead of a named pipe, a local domain + socket is used. + + + + + + client + <pipename>: Operates as for + server, except that the + pipe, or local domain socket, is not created by + &product-name; but is assumed to exist already. + + + + + + tcpserver <port>: + Configures &product-name; to create a TCP socket on the + host with TCP + <port> and + connect the virtual serial device to it. Note that + UNIX-like systems require ports over 1024 for normal + users. + + + + + + tcpclient + <hostname:port>: Operates as for + tcpserver, except that + the TCP socket is not created by &product-name;, but is + assumed to exist already. + + + + + + file <file>: + Redirects the serial port output to a raw file + <file> specified by its absolute path on the host + file system. + + + + + + <devicename>: If, + instead of the above options, the device name of a + physical hardware serial port of the host is specified, + the virtual serial port is connected to that hardware + port. On a Windows host, the device name will be a COM + port such as COM1. On a + Linux host, the device name will be + /dev/ttyS0 or similar. This enables + you to wire up a real serial port to a virtual machine. + + + + + + + + + uarttype <1-N> + 16450|16550A|16750: Configures the UART + type for a virtual serial port. The default UART type is + 16550A. + + + + + + --lptmode<1-N> + <Device>: Specifies the Device Name + of the parallel port that the Parallel Port feature will be + using. Use this before + --lpt. This feature depends + on the host operating system. For Windows hosts, use a + device name such as lpt1. On Linux hosts, use a device name + such as /dev/lp0. + + + + + + --lpt<1-N> <I/O base> + <IRQ>: Specifies the I/O address of + the parallel port and the IRQ number that the Parallel Port + feature will be using. Optional. Use this + after + --lptmod. I/O base address + and IRQ are the values that guest sees. For example, the + values avalable under guest Device Manager. + + + + + + --audio + none|null|dsound|oss|alsa|pulse|coreaudio: + Specifies whether the VM should have audio support, and if + so, which type. The list of supported audio types depends on + the host and can be determined with VBoxManage + modifyvm. + + + + + + --audiocontroller + ac97|hda|sb16: Specifies the audio + controller to be used with the VM. + + + + + + --audiocodec + stac9700|ad1980|stac9221|sb16: Specifies + the audio codec to be used with the VM. + + + + + + --audioin on: Specifies + whether capturing audio from the host is enabled or + disabled. + + + + + + --audioout on: Specifies + whether audio playback from the guest is enabled or + disabled. + + + + + + --clipboard-mode + disabled|hosttoguest|guesttohost|bidirectional: + Configues how the guest or host operating system's clipboard + should be shared with the host or guest. See + . This setting requires + that the Guest Additions be installed in the virtual + machine. + + + + + + --clipboard-file-transfers + enabled|disabled: Specifies if clipboard + file transfers are allowed between host and guest OSes or + not. + + + + + + --draganddrop + disabled|hosttoguest|guesttohost|bidirectional: + Specifies the drag and drop mode to use between the host and + the virtual machine. See . + This requires that the Guest Additions be installed in the + virtual machine. + + + + + + --monitorcount + <count>: Enables multi-monitor + support. See . + + + + + + --usb on|off: Enables and + disables the VM's virtual USB controller. See + . + + + + + + --usbehci on|off: Enables + and disables the VM's virtual USB 2.0 controller. See + . + + + + + + --usbxhci on|off: Enables + and disables the VM's virtual USB 3.0 controller. See + . + + + + + + --usbrename <oldname> + <newname>: Enables renaming of the + VM's virtual USB controller from <oldname> to + <newname>. + + + + + + + + + + Recording Settings + + + The VBoxManage modifyvm command enables you + to modify recording settings for video recording, audio + recording, or both. + + + + Use the following options to update the recording settings: + + + + + + + enables or disables the + recording of a VM session into a WebM/VP8 file. When this + option value is on, + recording begins when the VM session starts. + + + + + + enables + you to specify which VM screens to record. The recording for + each screen that you specify is saved to its own file. + + + + + + specifies the + file in which to save the recording. + + + + + + specifies the maximum + size of the recorded video file in megabytes. The recording + stops when the file reaches the specified size. If this + value is zero, the recording continues until you stop the + recording. + + + + + + specifies the + maximum amount time to record in seconds. The recording + stops after the specified number of seconds elapses. If this + value is zero, the recording continues until you stop the + recording. + + + + + + specifies additional video-recording options + in a comma-separated keyword-value format. For example, + foo=bar,a=b. + + + + Only use this option only if you are an advanced user. For + information about keywords, see Oracle VM + VirtualBox Programming Guide and Reference. + + + + + + specifies the + maximum number of video frames per second (FPS) to record. + Frames that have a higher frequency are skipped. Increasing + this value reduces the number of skipped frames and + increases the file size. + + + + + + specifies the + bit rate of the video in kilobits per second. Increasing + this value improves the appearance of the video at the cost + of an increased file size. + + + + + + + specifies the video resolution of the recorded video in + pixels. + + + + + + + + + + Remote Machine Settings + + + The following settings that affect remote machine behavior are + available through VBoxManage modifyvm: + + + + + + + --vrde on|off: Enables and + disables the VirtualBox Remote Desktop Extension (VRDE) + server. + + + + + + --vrdeproperty + "TCP/Ports|Address=<value>": Sets the + port numbers and IP address on the VM that the VRDE server + can bind to. + + + + + + + For TCP/Ports, <value> should be a port or a range + of ports that the VRDE server can bind to. + default or + 0 means port 3389, the + standard port for RDP. See the description for the + --vrdeport option in + . + + + + + + For TCP/Address, <value> should be the IP address + of the host network interface that the VRDE server will + bind to. If specified, the server will accept + connections only on the specified host network + interface. See the description for the + --vrdeaddress option in + . + + + + + + + + + --vrdeproperty + "VideoChannel/Enabled|Quality|DownscaleProtection=<value>": + Sets the VRDP video redirection properties. + + + + + + + For VideoChannel/Enabled, <value> can be set to + "1", switching the VRDP video channel on. See + . + + + + + + For VideoChannel/Quality, <value> should be set + between 10 and 100% inclusive, representing a JPEG + compression level on the VRDE server video channel. + Lower values mean lower quality but higher compression. + See . + + + + + + For VideoChannel/DownscaleProtection, <value> can + be set to "1" to enable the videochannel downscale + protection feature. When enabled, if a video's size + equals the shadow buffer size, then it is regarded as a + full screen video, and is displayed. But if its size is + between fullscreen and the downscale threshold then it + is not displayed, as it could be an + application window, which would be unreadable when + downscaled. When the downscale protection feature is + disabled, an attempt is always made to display videos. + + + + + + + + + --vrdeproperty + "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1": + Disables one of the VRDE server features: Display, Input, + Audio or USB respectively. To reenable a feature, use + "Client/DisableDisplay=" for example. See + . + + + + + + --vrdeproperty + "Client/DisableClipboard|DisableUpstreamAudio=1": + Disables one of the VRDE server features: Clipboard or + UpstreamAudio respectively. To reenable a feature, use + "Client/DisableClipboard=" for example. See + . + + + + + + --vrdeproperty + "Client/DisableRDPDR=1": Disables the VRDE + server feature: RDP device redirection for smart cards. To + reenable this feature, use "Client/DisableRDPR=". + + + + + + --vrdeproperty + "H3DRedirect/Enabled=1": Enables the VRDE + server feature: 3D redirection. To disable this feature, use + "H3DRedirect/Enabled=". + + + + + + --vrdeproperty + "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>": + Sets the desired security method and path of server + certificate, path of server private key, path of CA + certificate, that are used for a connection. + + + + + + + --vrdeproperty + "Security/Method=<value>" sets + the desired security method, which is used for a + connection. Valid values are: + + + + + + + Negotiate: Both + Enhanced (TLS) and Standard RDP Security connections + are allowed. The security method is negotiated with + the client. This is the default setting. + + + + + + RDP: Only Standard + RDP Security is accepted. + + + + + + TLS: Only Enhanced + RDP Security is accepted. The client must support + TLS. + + + + + + + See . + + + + + + --vrdeproperty + "Security/ServerCertificate=<value>" + where <value> is the absolute path of the server + certificate. See . + + + + + + --vrdeproperty + "Security/ServerPrivateKey=<value>" + where <value> is the absolute path of the server + private key. See . + + + + + + --vrdeproperty + "Security/CACertificate=<value>" + where <value> is the absolute path of the CA self + signed certificate. See . + + + + + + + + + --vrdeproperty + "Audio/RateCorrectionMode|LogPath=<value>" + sets the audio connection mode, or path of the audio + logfile. + + + + + + + --vrdeproperty + "Audio/RateCorrectionMode=<value>" + where <value> is the desired rate correction mode. + Allowed values are: + + + + + + + VRDP_AUDIO_MODE_VOID: + No mode specified, use to unset any Audio mode + already set. + + + + + + VRDP_AUDIO_MODE_RC: + Rate correction mode. + + + + + + VRDP_AUDIO_MODE_LPF: + Low pass filter mode. + + + + + + VRDP_AUDIO_MODE_CS: + Client sync mode to prevent underflow or overflow of + the client queue. + + + + + + + + + --vrdeproperty + "Audio/LogPath=<value>" where + <value> is the absolute path of the Audio log + file. + + + + + + + + + --vrdeextpack + default|<name>: Specifies the library + to use for accessing the VM remotely. The default is to use + the RDP code which is part of the &product-name; Extension + Pack. + + + + + + --vrdeport + default|<ports>: A port or a range of + ports the VRDE server can bind to. + default or + 0 means port 3389, the + standard port for RDP. You can specify a comma-separated + list of ports or ranges of ports. Use a dash between two + port numbers to specify a range. The VRDE server will bind + to one of the available ports from the + specified list. Only one machine can use a given port at a + time. For example, the option --vrdeport + 5000,5010-5012 will tell the server to bind + to one of following ports: 5000, 5010, 5011, or 5012. + + + + + + --vrdeaddress <IP + address>: The IP address of the host + network interface the VRDE server will bind to. If + specified, the server will accept connections only on the + specified host network interface. + + + + The setting can be used to specify whether the VRDP server + should accept either IPv4, IPv6, or both connections: + + + + + + + Only IPv4: --vrdeaddress + "0.0.0.0" + + + + + + Only IPv6: --vrdeaddress + "::" + + + + + + Both IPv6 and IPv4: --vrdeaddress + "" + + + + This is the default setting. + + + + + + + + + --vrdeauthtype + null|external|guest: Enables you to + indicate use of authorization, and specify how authorization + will be performed. See . + + + + + + --vrdeauthlibrary + default|<name>: Specifies the library + used for RDP authentication. See + . + + + + + + --vrdemulticon on|off: + Enables multiple connections to be made to the same VRDE + server, if the server supports this feature. See + . + + + + + + --vrdereusecon on|off: This + specifies the VRDE server behavior when multiple connections + are disabled. When this option is enabled, the server will + allow a new client to connect and will drop the existing + connection. When this option is disabled, the default + setting, a new connection will not be accepted if there is + already a client connected to the server. + + + + + + --vrdevideochannel on|off: + Enables video redirection, if it is supported by the VRDE + server. See . + + + + + + --vrdevideochannelquality + <percent>: Specifies the image + quality for video redirection. See + . + + + + + + + + + + Teleporting Settings + + + With the following commands for VBoxManage + modifyvm you can configure a machine to be a target + for teleporting. See . + + + + + + + --teleporter on|off: + Enables and disables the teleporter feature whereby when the + machine is started, it waits to receive a teleporting + request from the network instead of booting normally. + Teleporting requests are received on the port and address + specified using the following parameters. + + + + + + --teleporterport + <port>, + --teleporteraddress + <address>: These settings must be + used with --teleporter. + They specify the port and address the virtual machine should + listen to in order to receive a teleporting request sent + from another virtual machine. + <port> can be any + free TCP/IP port number, such as 6000. + <address> can be any + IP address or hostname and specifies the TCP/IP socket to + bind to. The default is 0.0.0.0, which means any address. + + + + + + --teleporterpassword + <password>: If this optional setting + is used, then the teleporting request will only succeed if + the source machine specifies the same password as the one + given with this command. + + + + + + --teleporterpasswordfile + <password>: If this optional setting + is used, then the teleporting request will only succeed if + the source machine specifies the same password as the one + specified in the file give with this command. Use + stdin to read the password + from stdin. + + + + + + --cpuid <leaf> <eax> <ebx> + <ecx> <edx>: Advanced users can + use this setting before a teleporting operation, to restrict + the virtual CPU capabilities that &product-name; presents to + the guest operating system. This must be run on both the + source and the target machines involved in the teleporting + and will then modify what the guest sees when it executes + the CPUID machine + instruction. This might help with misbehaving applications + that wrongly assume that certain CPU capabilities are + present. The meaning of the parameters is hardware + dependent, refer to the AMD or Intel processor + documentation. + + + + + + + + + + Debugging Settings + + + The following settings are only relevant for low-level VM + debugging. Regular users will never need these settings. + + + + + + + --tracing-enabled on|off: + Enables the tracebuffer. This consumes some memory for the + tracebuffer and adds extra overhead. + + + + + + --tracing-config + <config-string>: Enables tracing + configuration. In particular, this defines which group of + tracepoints are enabled. + + + + + + --tracing-allow-vm-access + on|off: Enables and disables VM access to + the tracebuffer. By default, this setting is disabled. + + + + + + + + + + USB Card Reader Settings + + + The following setting defines access to a USB Card Reader by the + guest environment. USB card readers are typically used for + accessing data on memory cards such as CompactFlash (CF), Secure + Digital (SD), or MultiMediaCard (MMC). + + + + + + + --usbcardreader on|off: + Enables and disables the USB card reader interface. + + + + + + + + + + Autostarting VMs During Host System Boot + + + These settings configure the VM autostart feature, which + automatically starts the VM at host system boot-up. Note that + there are prerequisites that need to be addressed before using + this feature. See . + + + + + + + --autostart-enabled on|off: + Enables and disables VM autostart at host system boot-up, + using the specified user name. + + + + + + --autostart-delay + <seconds>: Specifies a delay, in + seconds, following host system boot-up, before the VM + autostarts. + + + + + + + + + + + + VBoxManage movevm + + + This command moves a virtual machine to a new location on the + host. + + + + Associated files of the virtual machine, such as settings files + and disk image files, are moved to the new location. The + &product-name; configuration is updated automatically. + + + + The movevm subcommand requires the name of the + virtual machine which should be moved. + + + + Also required is the type of move operation, specified by + --type basic. Other types of move + operation may be supported in future releases. + + + + The --folder setting configures + the new location on the host file system. Enter a relative + pathname or a full pathname. + + + + + + + VBoxManage import + + + This command imports one or more virtual machines into + &product-name;. You can import from either of the following: + + + + + + + A virtual appliance in OVF format. + + + + + + A cloud service, such as &oci;. Only a single cloud instance + can be imported. + + + + + + + See for more details on importing VMs into + &product-name;. + + + + + Import from OVF + + + The import subcommand takes at least the path + name of an OVF file as input and expects the disk images, if + needed, to be in the same directory as the OVF file. Many + additional command-line options are supported. These enable you + to control in detail what is being imported and to modify the + import parameters, depending on the content of the OVF file. + + + + It is therefore recommended to first run the + import subcommand with the + --dry-run or + -n option. This will then print + a description of the appliance's contents to the screen how it + would be imported into &product-name;, together with the + optional command-line options to influence the import behavior. + + + + Use of the --options + keepallmacs|keepnatmacs|keepdisknames option + enables additional fine tuning of the import operation. The + first two options enable you to specify how the MAC addresses of + every virtual network card should be handled. They can either be + reinitialized, which is the default setting, left unchanged + (keepallmacs) or left unchanged + when the network type is NAT + (keepnatmacs). If you add + keepdisknames all new disk + images are assigned the same names as the originals, otherwise + they are renamed. + + + + As an example, the following is a screen output for a sample + appliance containing a Windows XP guest: + + +VBoxManage import WindowsXp.ovf --dry-run + Interpreting WindowsXp.ovf... + OK. + Virtual system 0: + 0: Suggested OS type: "WindowsXP" + (change with "--vsys 0 --ostype <type>"; use "list ostypes" to list all) + 1: Suggested VM name "Windows XP Professional_1" + (change with "--vsys 0 --vmname <name>") + 2: Suggested VM group "/" + (change with "--vsys 0 --group <group>") + 3: Suggested VM settings file name "/home/klaus/VirtualBox VMs/dummy2 2/dummy2 2.vbox" + (change with "--vsys 0 --settingsfile <filename>") + 4: Suggested VM base folder "/home/klaus/VirtualBox VMs" + (change with "--vsys 0 --basefolder <path>") + 5: End-user license agreement + (display with "--vsys 0 --eula show"; + accept with "--vsys 0 --eula accept") + 6: Number of CPUs: 1 + (change with "--vsys 0 --cpus <n>") + 7: Guest memory: 956 MB (change with "--vsys 0 --memory <MB>") + 8: Sound card (appliance expects "ensoniq1371", can change on import) + (disable with "--vsys 0 --unit 5 --ignore") + 9: USB controller + (disable with "--vsys 0 --unit 6 --ignore") + 10: Network adapter: orig bridged, config 2, extra type=bridged + 11: Floppy + (disable with "--vsys 0 --unit 8 --ignore") + 12: SCSI controller, type BusLogic + (change with "--vsys 0 --unit 9 --scsitype {BusLogic|LsiLogic}"; + disable with "--vsys 0 --unit 9 --ignore") + 13: IDE controller, type PIIX4 + (disable with "--vsys 0 --unit 10 --ignore") + 14: Hard disk image: source image=WindowsXp.vmdk, + target path=/home/user/disks/WindowsXp.vmdk, controller=9;channel=0 + (change controller with "--vsys 0 --unit 11 --controller <id>"; + disable with "--vsys 0 --unit 11 --ignore") + + + The individual configuration items are numbered, and depending + on their type support different command-line options. The import + subcommand can be directed to ignore many such items with a + --vsys X --unit Y --ignore + option, where X is the number of the virtual system and Y the + item number, as printed on the screen. X is zero, unless there + are several virtual system descriptions in the appliance. + + + + In the above example, Item #1 specifies the name of the target + machine in &product-name;. Items #12 and #13 specify hard disk + controllers, respectively. Item #14 describes a hard disk image. + In this case, the additional + --controller option indicates + which item the disk image should be connected to, with the + default coming from the OVF file. + + + + You can combine several items for the same virtual system using + the --vsys option. For example, + to import a machine as described in the OVF, but without the + sound card and without the USB controller, and with the disk + image connected to the IDE controller instead of the SCSI + controller, use the following command: + + +VBoxManage import WindowsXp.ovf + --vsys 0 --unit 8 --ignore --unit 9 --ignore --unit 14 --controller 13 + + + + + + Import from &oci; + + + As the result of this operation, a file with the suffix + .oci is downloaded to the local host. This + file is a TAR archive which contains a bootable instance image + in QCOW2 format and a JSON file with some metadata related to + the imported instance. + + + + The downloaded file is deleted after a successful import. If + import fails, the downloaded file may not be deleted and the + VBoxSVC log file may indicate the location where the file was + stored. + + + + During import the bootable image is extracted from the archive + and converted into VMDK format. The JSON file is also extracted + and stored in the VM machine folder. + + + + The command syntax for importing an &oci; instance begins with + VBoxManage import OCI:// --cloud. + + + + You can list the available &oci; VM instances and their IDs by + using the following command: + + +VBoxManage cloud --provider=OCI --profile=cloud-profile-name list instances + + + To import a VM from a cloud service such as &oci;, use the + option to specify the import from the + Cloud. Some of the following options are settings for the VM, + for others you must enter an Oracle Cloud Identifier (OCID) for + a resource. Use the Oracle Cloud Infrastructure Console to view + OCIDs. + + + + The following parameters can be specified: + + + + + + + : Specifies a new name for the + imported VM. This name is used as the VM name by + &product-name;. + + + + + + : The ID of an existing + instance in the Cloud. + + + + + + : Specifies the cloud profile + that is used to connect to the cloud service provider. The + cloud profile contains your &oci; account details, such as + your user OCID and the fingerprint for your public key. To + use a cloud profile, you must have the required permissions + on &oci;. + + + + + + : Specifies the bucket name in + which to store the object created from an instance bootable + volume. In &oci;, a bucket is a logical container for + storing objects. + + + + + + + The following import options have the same meaning as for OVF + import: + + + + + + + : An OS type supported by + &product-name;. Use the VBoxManage list + ostypes command to see the whole list of supported + OSes. If the type was not set, the + Unknown type is used. + + + + + + : The folder where the new VM + is stored. + + + + + + : A string describing the VM. + + + + + + : The amount of RAM memory assigned + for the VM, in MB. If this option is not set either the + default memory size for the OS type is used, or the value is + taken from the &oci; instance. + + + + + + : the number of virtual CPUs assigned + for the VM. If this option is not set, either the default + virtual CPUs setting for the OS type is used, or the value + is taken from the &oci; instance. + + + + + + + The import options , + , , + , are not + valid for cloud import. + + + + The following example shows a typical command line for importing + an instance from &oci;: + + +# VBoxManage import OCI:// --cloud --vmname import_from_oci --memory 4000 + --cpus 3 --ostype FreeBSD_64 --cloudprofile "standard user" + --cloudinstanceid ocid1.instance.oc1.iad.abuwc... --cloudbucket myBucket + + + + + + + + VBoxManage export + + + This command exports one or more virtual machines from + &product-name;. You can export to either of the following: + + + + + + + A virtual appliance in OVF format, including copying their + virtual disk images to compressed VMDK. + + + + + + A cloud service, such as &oci;. A single VM can be exported in + VMDK format. + + + + + + + See for more details on exporting VMs from + &product-name;. + + + + + Export to OVF + + + List the machine, or the machines, that you would like to export + to the same OVF file and specify the target OVF file after an + additional --output or + -o option. Note that the + directory of the target OVF file will also receive the exported + disk images in the compressed VMDK format, regardless of the + original format, and should have enough disk space left for + them. + + + + Beside a simple export of a given virtual machine, you can + append several product information to the appliance file. Use + --product, + --producturl, + --vendor, + --vendorurl, + --version and + --description to specify this + additional information. For legal reasons you may add a license + text or the content of a license file by using the + --eula and + --eulafile option respectively. + + + + As with OVF import, you use the --vsys + X option to apply these options to the correct + virtual machine. + + + + For virtualization products which are not fully compatible with + the OVF standard 1.0 you can enable an OVF 0.9 legacy mode with + the --legacy09 option. Other + options are --ovf09, + --ovf10, + --ovf20. + + + + To specify options controlling the exact content of the + appliance file, you can use to + request the creation of a manifest file, which enables detection + of corrupted appliances on import, the additional export of DVD + images, and the exclusion of MAC addresses. You can specify a + list of options, such as . For details, check the help output of + VBoxManage export. + + + + + + + Export to &oci; + + + By default, an exported disk image is converted into stream VMDK + format. This ensures compatibility with &oci;. + + + + List the machine that you want to export to &oci; and specify + the target cloud service provider by using the + --output or + -o option. + + + + To export a VM to a cloud service such as &oci;, use the + option to specify the VM to export. + This option works in the same way as the + option for OVF export. + + + + Some of the following options are settings for the VM instance. + As a result, you must enter an Oracle Cloud Identifier (OCID) + for a resource. Use the &oci; Console to view OCIDs. + + + + + + + : Specifies the short name of + the cloud service provider to which you export. For &oci;, + enter OCI://. + + + + + + + number-of-virtual-system: + Specifies a number that identifies the VM that you are + exporting. Numbering starts at + 0 for the first VM. + + + + + + name: + Specifies the name of the exported VM. This name is used as + the VM instance name in &oci;. + + + + + + + cloud-profile-name: Specifies the + cloud profile that is used to connect to the cloud service + provider. The cloud profile contains your &oci; account + details, such as your user OCID and the fingerprint for your + public key. See . + + + + To use a cloud profile, you must have the required + permissions on &oci;. + + + + + + + shape: Specifies the shape used + for the VM instance. The shape defines the number of CPUs + and the amount of memory allocated to the VM instance. The + shape must be compatible with the exported image. + + + + + + + domain: Specifies the + availability domain to use for the VM instance. Enter the + full name of the availability domain. + + + + + + + disk-size-in-GB: Specifies the + disk size used for the exported disk image in gigabytes. The + minimum value is 50 GB and the maximum value is 300 GB. + + + + + + + bucket-name: Specifies the bucket + in which to store the uploaded files. In &oci;, a bucket is + a logical container for storing objects. + + + + + + + OCI-vcn-ID: Specifies the virtual + cloud network (VCN) to use for the VM instance. Enter the + OCID for the VCN. + + + + + + + OCI-subnet-ID: Specifies the + subnet of the VCN to use for the VM instance. Enter the OCID + for the subnet. + + + + + + : Specifies + whether to store the exported disk image in Oracle Object + Storage. + + + + + + : + Specifies whether to start the VM instance after the export + to &oci; completes. + + + + + + : Specifies + whether to enable a public IP address for the VM instance. + + + + + + + The following example shows a typical command line for exporting + a VM to &oci;. + + +# VBoxManage export myVM --output OCI:// --cloud 0 --vmname myVM_Cloud \ +--cloudprofile "standard user" --cloudbucket myBucket \ +--cloudshape VM.Standard2.1 --clouddomain US-ASHBURN-AD-1 --clouddisksize 50 \ +--cloudocivcn ocid1.vcn.oc1.iad.aaaa... --cloudocisubnet ocid1.subnet.oc1.iad.aaaa... \ +--cloudkeepobject true --cloudlaunchinstance true --cloudpublicip true + + + + + + + + VBoxManage startvm + + + This command starts a virtual machine that is currently in the + Powered Off or Saved states. + + + + The optional --type specifier + determines whether the machine will be started in a window or + whether the output should go through + VBoxHeadless, with VRDE enabled or not. See + . The list of types is subject to + change, and it is not guaranteed that all types are accepted by + any product variant. + + + + The global or per-VM default value for the VM frontend type will + be taken if the type is not explicitly specified. If none of these + are set, the GUI variant will be started. + + + + The following values are allowed: + + + + + + + gui + + + + + Starts a VM showing a GUI window. This is the default. + + + + + + + headless + + + + + Starts a VM without a window for remote display only. + + + + + + + separate + + + + + Starts a VM with a detachable UI. Technically, it is a + headless VM with user interface in a separate process. This + is an experimental feature as it lacks certain + functionality, such as 3D acceleration. + + + + + + + + + If you experience problems with starting virtual machines with + particular frontends and there is no conclusive error + information, consider starting virtual machines directly by + running the respective front-end, as this can give additional + error information. + + + + + + + + VBoxManage controlvm + + + The controlvm subcommand enables you to change + the state of a virtual machine that is currently running. The + following can be specified: + + + + + + + VBoxManage controlvm <vm> pause: + Temporarily puts a virtual machine on hold, without + permanently changing its state. The VM window is gray, to + indicate that the VM is currently paused. This is equivalent + to selecting the Pause item + in the Machine menu of the + GUI. + + + + + + Use VBoxManage controlvm <vm> resume: + Undoes a previous pause command. This is + equivalent to selecting the + Resume item in the + Machine menu of the GUI. + + + + + + VBoxManage controlvm <vm> reset: Has + the same effect on a virtual machine as pressing the Reset + button on a real computer. A cold reboot of the virtual + machine is done, which immediately restarts and reboots the + guest operating system. The state of the VM is not saved + beforehand, and data may be lost. This is equivalent to + selecting the Reset item in + the Machine menu of the GUI. + + + + + + VBoxManage controlvm <vm> poweroff: + Has the same effect on a virtual machine as pulling the power + cable on a real computer. The state of the VM is not saved + beforehand, and data may be lost. This is equivalent to + selecting the Close item in + the Machine menu of the GUI, + or clicking the VM window's close button, and then selecting + Power Off the Machine in the + displayed dialog. + + + + After this, the VM's state will be Powered Off. From that + state, it can be started again. See + . + + + + + + VBoxManage controlvm <vm> savestate: + Saves the current state of the VM to disk and then stops the + VM. This is equivalent to selecting the + Close item in the + Machine menu of the GUI or + clicking the VM window's close button, and then selecting + Save the Machine State in the + displayed dialog. + + + + After this, the VM's state will be Saved. From this state, it + can be started again. See + . + + + + + + VBoxManage controlvm <vm> + acpipowerbutton: Sends an ACPI shutdown signal to + the VM, as if the power button on a real computer had been + pressed. So long as the VM is running a fairly modern guest + operating system providing ACPI support, this should trigger a + proper shutdown mechanism from within the VM. + + + + + + VBoxManage controlvm <vm> keyboardputscancode + <hex> [<hex>...]: Sends commands using + keycodes to the VM. Keycodes are documented in the public + domain. For example: + http://www.win.tue.nl/~aeb/linux/kbd/scancodes-1.html. + + + + + + VBoxManage controlvm "VM name" teleport --hostname + <name> --port <port> [--passwordfile <file> + | --password <password>]: Makes the machine + the source of a teleporting operation and initiates a teleport + to the given target. See . If + the optional password is specified, it must match the password + that was given to the modifyvm command for + the target machine. See + . + + + + + + + The following extra options are available with + controlvm that do not directly affect the VM's + running state: + + + + + + + setlinkstate<1-N> + on|off: Connects or disconnects virtual + network cables from their network interfaces. + + + + + + nic<1-N> + null|nat|bridged|intnet|hostonly|generic|natnetwork[<devicename>]: + Specifies the type of networking that should be made available + on the specified VM virtual network card. They available types + are: not connected to the host + (null), use network address + translation (nat), bridged + networking (bridged), + communicate with other virtual machines using internal + networking (intnet), + host-only networking + (hostonly), natnetwork + networking (natnetwork), or + access to rarely used submodes + (generic). These options + correspond to the modes which are described in detail in + . + + + + + + With the nictrace options, + you can optionally trace network traffic by dumping it to a + file, for debugging purposes. + + + + nictrace<1-N> on|off: + Enables network tracing for a particular virtual network card. + + + + Before enabling you should specify a file name to which the + trace should be logged. This can be done with the + nictracefile<1-N> + <filename> option to + VBoxManage controlvm at runtime or with the + <filename> option to + VBoxManage modifyvm otherwise. + + + + + + nicpromisc<1-N> + deny|allow-vms|allow-all: Specifies how the + promiscious mode is handled for the specified VM virtual + network card. This setting is only relevant for bridged + networking. The default setting of + deny hides any traffic not + intended for this VM. + allow-vms hides all host + traffic from this VM but enables the VM to see traffic to and + from other VMs. allow-all + removes this restriction completely. + + + + + + nicproperty<1-N> + <paramname>="paramvalue": This option, + in combination with + nicgenericdrv enables you to + pass parameters to rarely-used network backends. + + + + Those parameters are backend engine-specific, and are + different between UDP Tunnel and the VDE backend drivers. See + . + + + + + + natpf<1-N> + [<name>],tcp|udp,[<hostip>],<hostport>,[<guestip>], + <guestport>: Specifies a NAT + port-forwarding rule. See . + + + + + + natpf<1-N> delete + <name>: Deletes a NAT port-forwarding + rule. See . + + + + + + The guestmemoryballoon<balloon size in + MB>: Changes the size of the guest memory + balloon. This is the memory allocated by the &product-name; + Guest Additions from the guest operating system and returned + to the hypervisor for reuse by other virtual machines. This + must be specified in megabytes. See + . + + + + + + usbattach<uuid|address> [--capturefile + <filename>] + + + + and usbdetach <uuid|address> + [--capturefile <filename>]: Makes host + USB devices visible or invisible to the virtual machine on the + fly, without the need for creating filters first. The USB + devices can be specified by UUID (unique identifier) or by + address on the host system. Use the + --capturefile option to + specify the absolute path of a file for writing activity + logging data. + + + + You can use VBoxManage list usbhost to + locate this information. + + + + + + audioin on: Selects whether + capturing audio from the host is enabled or disabled. + + + + + + audioout on: Selects whether + audio playback from the guest is enabled or disabled. + + + + + + clipboard mode + disabled|hosttoguest|guesttohost|bidirectional: + Selects how the guest or host operating system's clipboard + should be shared with the host or guest. See + . This requires that the + Guest Additions be installed in the virtual machine. + + + + + + clipboard filetransfers + enabled|disabled: Specifies if clipboard file + transfers are allowed between host and guest OSes or not. + + + + + + draganddrop + disabled|hosttoguest|guesttohost|bidirectional: + Selects the current drag and drop mode being used between the + host and the virtual machine. See + . This requires that the Guest + Additions be installed in the virtual machine. + + + + + + vrde on|off: Enables and + disables the VRDE server, if it is installed. + + + + + + vrdeport + default|<ports>: Changes the port or a + range of ports that the VRDE server can bind to. + default or + 0 means port 3389, the + standard port for RDP. See the description for the + --vrdeport option in + . + + + + + + vrdeproperty + "TCP/Ports|Address=<value>": Sets the + port numbers and IP address on the VM to which the VRDE server + can bind. + + + + + + + For TCP/Ports, <value> should be a port or a range + of ports to which the VRDE server can bind. + default or + 0 means port 3389, the + standard port for RDP. See the description for the + --vrdeport option in + . + + + + + + For TCP/Address, <value>: The IP address of the host + network interface that the VRDE server will bind to. If + specified, the server will accept connections only on the + specified host network interface. See the description for + the --vrdeaddress option + in + . + + + + + + + + + vrdeproperty + "VideoChannel/Enabled|Quality|DownscaleProtection=<value>": + Sets the VRDP video redirection properties. + + + + + + + For VideoChannel/Enabled, <value> can be set to "1" + switching the VRDP video channel on. See + . + + + + + + For VideoChannel/Quality, <value> should be set + between 10 and 100% inclusive, representing a JPEG + compression level on the VRDE server video channel. Lower + values mean lower quality but higher compression. See + . + + + + + + For VideoChannel/DownscaleProtection, <value> can be + set to "1" to enable the videochannel downscale protection + feature. When enabled, if a video's size equals the shadow + buffer size, then it is regarded as a full screen video, + and is displayed. If its size is between fullscreen and + the downscale threshold it is not displayed, as it could + be an application window, which would be unreadable when + downscaled. When the downscale protection feature is + disabled, an attempt is always made to display videos. + + + + + + + + + vrdeproperty + "Client/DisableDisplay|DisableInput|DisableAudio|DisableUSB=1": + Disables one of the VRDE server features: Display, Input, + Audio, or USB. To reenable a feature, use + "Client/DisableDisplay=" for example. See + . + + + + + + vrdeproperty + "Client/DisableClipboard|DisableUpstreamAudio=1". + Disables one of the VRDE server features: Clipboard or + UpstreamAudio. To reenable a feature, use + "Client/DisableClipboard=" for example. See + . + + + + + + vrdeproperty + "Client/DisableRDPDR=1": Disables the VRDE + server feature: RDP device redirection for smart cards. To + reenable this feature, use "Client/DisableRDPR=". + + + + + + vrdeproperty + "H3DRedirect/Enabled=1": Enables the VRDE + server feature: 3D redirection. To disable this feature, use + "H3DRedirect/Enabled=". + + + + + + vrdeproperty + "Security/Method|ServerCertificate|ServerPrivateKey|CACertificate=<value>": + Sets the desired security method, path of the server + certificate, path of the server private key, and path of CA + certificate, used for a connection. + + + + + + + vrdeproperty + "Security/Method=<value>": Sets the + desired security method, which is used for a connection. + Valid values are as follows: + + + + + + + Negotiate: Both + Enhanced (TLS) and Standard RDP Security connections + are allowed. The security method is negotiated with + the client. This is the default setting. + + + + + + RDP: Only Standard + RDP Security is accepted. + + + + + + TLS: Only Enhanced + RDP Security is accepted. The client must support TLS. + + + + + + + See . + + + + + + vrdeproperty + "Security/ServerCertificate=<value>" + where <value> is the absolute path of the server + certificate. See . + + + + + + vrdeproperty + "Security/ServerPrivateKey=<value>" + where <value> is the absolute path of the server + private key. See . + + + + + + vrdeproperty + "Security/CACertificate=<value>" + where <value> is the absolute path of the CA self + signed certificate. See . + + + + + + + + + vrdeproperty + "Audio/RateCorrectionMode|LogPath=<value>": + Sets the audio connection mode, or path of the audio logfile. + + + + + + + vrdeproperty + "Audio/RateCorrectionMode=<value>" + where <value> is the desired rate correction mode, + allowed values are: + + + + + + + VRDP_AUDIO_MODE_VOID: + No mode specified, use to unset any Audio mode already + set. + + + + + + VRDP_AUDIO_MODE_RC: + Rate correction mode. + + + + + + VRDP_AUDIO_MODE_LPF: + Low pass filter mode. + + + + + + VRDP_AUDIO_MODE_CS: + Client sync mode to prevent underflow or overflow of + the client queue. + + + + + + + + + vrdeproperty + "Audio/LogPath=<value>" where + <value> is the absolute path of the audio log file. + + + + + + + + + vrdevideochannelquality + <percent>: Sets the image quality for + video redirection. See . + + + + + + setvideomodehint: Requests + that the guest system change to a particular video mode. This + requires that the Guest Additions be installed, and will not + work for all guest systems. + + + + + + screenshotpng: Takes a + screenshot of the guest display and saves it in PNG format. + + + + + + recording on|off enables or + disables the recording of a VM session into a WebM/VP8 file. + When this option value is on, + recording begins when the VM session starts. + + + + + + recordingscreens + all|screen-ID + [screen-ID ...] + enables you to specify which VM screens to record. The + recording for each screen that you specify is saved to its own + file. You cannot modify this setting while recording is + enabled. + + + + + + recordingfile + filename specifies + the file in which to save the recording. You cannot modify + this setting while recording is enabled. + + + + + + recordingvideores + widthxheight + specifies the resolution of the recorded video in pixels. You + cannot modify this setting while recording is enabled. + + + + + + + + recordingvideorate + bit-rate specifies + the bit rate of the video in kilobits per second. Increasing + this value improves the appearance of the video at the cost of + an increased file size. You cannot modify this setting while + recording is enabled. + + + + + + recordingvideofps + fps specifies the + maximum number of video frames per second (FPS) to record. + Frames that have a higher frequency are skipped. Increasing + this value reduces the number of skipped frames and increases + the file size. You cannot modify this setting while recording + is enabled. + + + + + + + + recordingmaxtime + seconds specifies + the maximum amount time to record in seconds. The recording + stops after the specified number of seconds elapses. If this + value is zero, the recording continues until you stop the + recording. + + + + + + recordingmaxsize + MB specifies the + maximum size of the recorded video file in megabytes. The + recording stops when the file reaches the specified size. If + this value is zero, the recording continues until you stop the + recording. You cannot modify this setting while recording is + enabled. + + + + + + recordingopts + keyword=value[,keyword=value + ...] specifies additional recording options + in a comma-separated keyword-value format. For example, + foo=bar,a=b. You cannot + modify this setting while recording is enabled. + + + + Only use this option only if you are an advanced user. For + information about keywords, see Oracle VM VirtualBox + Programming Guide and Reference. + + + + + + setcredentials: Used for + remote logins on Windows guests. See + . + + + + + + teleport --host <name> --port + <port>: Configures a VM as a target for + teleporting. <name> specifies the virtual machine name. + <port> specifies the port on the virtual machine which + should listen for teleporting requests from other virtual + machines. It can be any free TCP/IP port number, such as 6000. + See . + + + + + + + --maxdowntime + <msec>: Specifies the maximum + downtime, in milliseconds, for the teleporting target VM. + Optional. + + + + + + --password + <password>: The teleporting request + will only succeed if the source machine specifies the same + password as the one given with this command. Optional. + + + + + + --passwordfile <password + file>: The teleporting request will + only succeed if the source machine specifies the same + password as the one specified in the password file with + the path specified with this command. Use + stdin to read the + password from stdin. Optional. + + + + + + + + + plugcpu|unplugcpu <id>: + If CPU hot-plugging is enabled, this setting adds and removes + a virtual CPU to the virtual machine. + <id> specifies the + index of the virtual CPU to be added or removed and must be a + number from 0 to the maximum number of CPUs configured. CPU 0 + can never be removed. + + + + + + The cpuexecutioncap + <1-100>: Controls how much CPU time a + virtual CPU can use. A value of 50 implies a single virtual + CPU can use up to 50% of a single host CPU. + + + + + + vm-process-priority + default|flat|low|normal|high: Changes the + priority scheme of the VM process. See + . + + + + + + webcam attach <path|alias> + [<keyword=value>[;<keyword=value>...]]: + Attaches a webcam to a running VM. Specify the absolute path + of the webcam on the host operating system, or use its alias, + obtained by using the command: VBoxManage list + webcams. + + + + Note that alias '.0' means the default video input device on + the host operating system, '.1', '.2', etc. mean first, + second, etc. video input device. The device order is + host-specific. + + + + The optional settings parameter is a + ; delimited list of + name-value pairs, enabling configuration of the emulated + webcam device. + + + + The following settings are supported: + + + + MaxFramerate: Specifies the highest rate in frames per second, + at which video frames are sent to the guest. Higher frame + rates increase CPU load, so this setting can be useful when + there is a need to reduce CPU load. The default setting is + no maximum limit, thus + enabling the guest to use all frame rates supported by the + host webcam. + + + + MaxPayloadTransferSize: Specifies the maximum number of bytes + the emulated webcam can send to the guest in one buffer. The + default setting is 3060 bytes, which is used by some webcams. + Higher values can slightly reduce CPU load, if the guest is + able to use larger buffers. Note that higher + MaxPayloadTransferSize values may be not supported by some + guest operating systems. + + + + + + webcam detach + <path|alias>: Detaches a webcam from a + running VM. Specify the absolute path of the webcam on the + host, or use its alias obtained from the webcam + list command. + + + + Please note the following points, relating to specific host + operating systems: + + + + + + + Windows hosts: When the webcam device is detached from the + host, the emulated webcam device is automatically detached + from the guest. + + + + + + Mac OS X hosts: OS X version 10.7 or newer is required. + + + + When the webcam device is detached from the host, the + emulated webcam device remains attached to the guest and + must be manually detached using the VBoxManage + controlvm webcam detach command. + + + + + + Linux hosts: When the webcam is detached from the host, + the emulated webcam device is automatically detached from + the guest only if the webcam is streaming video. If the + emulated webcam is inactive, it should be manually + detached using the VBoxManage controlvm webcam + detach command. + + + + + + + + + webcam list: Lists webcams + attached to the running VM. The output is a list of absolute + paths or aliases that were used for attaching the webcams to + the VM using the webcam attach command. + + + + + + addencpassword <id> <password + file>|- [--removeonsuspend + <yes|no>]: Supplies an encrypted VM + specified by <id> with the encryption password to enable + a headless start. Either specify the absolute path of a + password file on the host file system: <password file>, + or use to instruct + VBoxManage to prompt the user for the + encryption password. + + + + --removeonsuspend + <yes|no>: Specifies whether to remove + the passsword or keep the password in VM memory when the VM is + suspended. If the VM has been suspended and the password has + been removed, the user needs to resupply the password before + the VM can be resumed. This feature is useful in cases where + the user does not want the password to be stored in VM memory, + and the VM is suspended by a host suspend event. + + + + + On &product-name; versions 5.0 and later, data stored on + hard disk images can be transparently encrypted for the + guest. &product-name; uses the AES algorithm in XTS mode and + supports 128 or 256 bit data encryption keys (DEK). The DEK + is stored encrypted in the medium properties, and is + decrypted during VM startup by supplying the encryption + password. + + + + + The VBoxManage encryptmedium command is + used to create a DEK encrypted medium. See + . When starting an + encrypted VM from the &product-name; GUI, the user will be + prompted for the encryption password. + + + + For a headless encrypted VM start, use the following command: + + + + VBoxManage startvm "vmname" --type headless + + + + Then supply the required encryption password as follows: + + + + VBoxManage "vmname" controlvm "vmname" addencpassword ... + + + + + + + + removeencpassword <id>: + Removes encryption password authorization for password + <id> for all encrypted media attached to the VM. + + + + + + removeallencpasswords: + Removes encryption password authorization for all passwords + for all encrypted media attached to the VM. + + + + + + changeuartmode <1-N>: + Changes the connection mode for a given virtual serial port. + + + + + + + + + + VBoxManage discardstate + + + This command discards the saved state of a virtual machine which + is not currently running. This will cause the VM's operating + system to restart next time you start it. This is the equivalent + of pulling out the power cable on a physical machine, and should + be avoided if possible. + + + + + + + VBoxManage adoptstate + + + If you have a Saved state file (.sav) that is + separate from the VM configuration, you can use this command to + adopt the file. This will change the VM to + saved state and when you start it, &product-name; will attempt to + restore it from the saved state file you indicated. This command + should only be used in special setups. + + + + + + + VBoxManage closemedium + + + This command removes a hard disk, DVD, or floppy image from a + &product-name; media registry. + + +VBoxManage closemedium [disk|dvd|floppy] <uuid|filename> + [--delete] + + + Optionally, you can request that the image be deleted. You will + get appropriate diagnostics that the deletion failed, however the + image will become unregistered in any case. + + + + + + + VBoxManage storageattach + + + This command attaches, modifies, and removes a storage medium + connected to a storage controller that was previously added with + the storagectl command. The syntax is as + follows: + + +VBoxManage storageattach <uuid|vmname> + --storagectl <name> + [--port <number>] + [--device <number>] + [--type dvddrive|hdd|fdd] + [--medium none|emptydrive|additions| + <uuid>|<filename>|host:<drive>|iscsi] + [--mtype normal|writethrough|immutable|shareable + readonly|multiattach] + [--comment <text>] + [--setuuid <uuid>] + [--setparentuuid <uuid>] + [--passthrough on|off] + [--tempeject on|off] + [--nonrotational on|off] + [--discard on|off] + [--hotpluggable on|off] + [--bandwidthgroup name|none] + [--forceunmount] + [--server <name>|<ip>] + [--target <target>] + [--tport <port>] + [--lun <lun>] + [--encodedlun <lun>] + [--username <username>] + [--password <password>] + [--passwordfile <file>] + [--initiator <initiator>] + [--intnet] + + + A number of parameters are commonly required. Some parameters are + required only for iSCSI targets. + + + + The common parameters are as follows: + + + + + + + uuid|vmname + + + + + The VM UUID or VM Name. Mandatory. + + + + + + + --storagectl + + + + + Name of the storage controller. Mandatory. The list of the + storage controllers currently attached to a VM can be + obtained with VBoxManage showvminfo. See + . + + + + + + + --port + + + + + The number of the storage controller's port which is to be + modified. Mandatory, unless the storage controller has only + a single port. + + + + + + + --device + + + + + The number of the port's device which is to be modified. + Mandatory, unless the storage controller has only a single + device per port. + + + + + + + --type + + + + + Define the type of the drive to which the medium is being + attached, detached, or modified. This argument can only be + omitted if the type of medium can be determined from either + the medium given with the + --medium argument or from a + previous medium attachment. + + + + + + + --medium + + + + + Specifies what is to be attached. The following values are + supported: + + + + + + + none: Any existing + device should be removed from the given slot. + + + + + + emptydrive: For a + virtual DVD or floppy drive only, this makes the device + slot behave like a removeable drive into which no media + has been inserted. + + + + + + additions: For a + virtual DVD drive only, this attaches the + VirtualBox Guest Additions image to + the given device slot. + + + + + + If a UUID is specified, it must be the UUID of a storage + medium that is already known to &product-name;. For + example, because it has been attached to another virtual + machine. See for + details of how to list known media. This medium is then + attached to the given device slot. + + + + + + If a filename is specified, it must be the full path of + an existing disk image in ISO, RAW, VDI, VMDK, or other + format. The disk image is then attached to the given + device slot. + + + + + + host:<drive>: For + a virtual DVD or floppy drive only, this connects the + given device slot to the specified DVD or floppy drive + on the host computer. + + + + + + iscsi: For virtual hard + disks only, this is used for specifying an iSCSI target. + In this case, additional parameters must be given. These + are described below. + + + + + + + Some of the above changes, in particular for removeable + media such as floppies and CDs/DVDs, can be effected while a + VM is running. Others, such as device changes or changes in + hard disk device slots, require the VM to be powered off. + + + + + + + --mtype + + + + + Defines how this medium behaves with respect to snapshots + and write operations. See . + + + + + + + --comment + + + + + An optional description that you want to have stored with + this medium. For example, for an iSCSI target, "Big storage + server downstairs". This is purely descriptive and not + needed for the medium to function correctly. + + + + + + + --setuuid, --setparentuuid + + + + + Modifies the UUID or parent UUID of a medium before + attaching it to a VM. This is an expert option. + Inappropriate use can make the medium unusable or lead to + broken VM configurations if any other VM is referring to the + same media already. The most frequently used variant is + --setuuid "", which assigns + a new random UUID to an image. This option is useful for + resolving duplicate UUID errors if you duplicated an image + using a file copy utility. + + + + + + + --passthrough + + + + + For a virtual DVD drive only, you can enable DVD writing + support. This feature is currently experimental, see + . + + + + + + + --tempeject + + + + + For a virtual DVD drive only, you can configure the behavior + for guest-triggered medium eject. If this is set to on, the + eject has only a temporary effect. If the VM is powered off + and restarted the originally configured medium will be still + in the drive. + + + + + + + --nonrotational + + + + + Enables you to enable the non-rotational flag for virtual + hard disks. Some guests, such as Windows 7 or later, treat + such disks like SSDs and do not perform disk fragmentation + on such media. + + + + + + + --discard + + + + + Enables the auto-discard feature for a virtual hard disks. + This specifies that a VDI image will be shrunk in response + to the trim command from the guest OS. The following + requirements must be met: + + + + + + + The disk format must be VDI. + + + + + + The size of the cleared area must be at least 1 MB. + + + + + + &product-name; will only trim whole 1 MB blocks. The + VDIs themselves are organized into 1 MB blocks, so this + will only work if the space being trimmed is at least a + 1 MB contiguous block at a 1 MB boundary. On Windows, + occasional defragmentation with defrag.exe + /D, or on Linux running btrfs + filesystem defrag as a background cron job may + be beneficial. + + + + + + + + The Guest OS must be configured to issue the + trim command, and typically this means + that the guest OS is made to see the disk as an SSD. Ext4 + supports the -o discard mount flag. Mac OS X probably + requires additional settings. Windows should automatically + detect and support SSDs, at least in versions 7, 8, and + 10. The Linux exFAT driver from Samsung supports the + trim command. + + + + + It is unclear whether Microsoft's implementation of exFAT + supports this feature, even though that file system was + originally designed for flash. + + + + Alternatively, there are other methods to issue trim. For + example, the Linux fstrim command, part + of the util-linux package. Earlier solutions required a user + to zero out unused areas, using zerofree or similar, and to + compact the disk. This is only possible when the VM is + offline. + + + + + + + --bandwidthgroup + + + + + Sets the bandwidth group to use for the given device. See + . + + + + + + + --forceunmount + + + + + For a virtual DVD or floppy drive only, this forcibly + unmounts the DVD/CD/Floppy or mounts a new DVD/CD/Floppy + even if the previous one is locked down by the guest for + reading. See . + + + + + + + + When iscsi is used with the + --medium parameter for iSCSI + support, additional parameters must or can be used. See also + . + + + + + + + --server + + + + + The host name or IP address of the iSCSI target. Required. + + + + + + + --target + + + + + Target name string. This is determined by the iSCSI target + and used to identify the storage resource. Required. + + + + + + + --tport + + + + + TCP/IP port number of the iSCSI service on the target. + Optional. + + + + + + + --lun + + + + + Logical Unit Number of the target resource. Optional. Often, + this value is zero. + + + + + + + --encodedlun + + + + + Hex-encoded Logical Unit Number of the target resource. + Optional. Often, this value is zero. + + + + + + + --username, --password, + --passwordfile + + + + + Username and password, called the initiator secret, for + target authentication, if required. Optional. + + + + + Username and password are stored without encryption, in + clear text, in the XML machine configuration file if no + settings password is provided. When a settings password is + specified for the first time, the password is stored in + encrypted form. As an alternative to providing the + password on the command line, a reference to a file + containing the text can be provided using the + passwordfile option. + + + + + + + + --initiator + + + + + iSCSI Initiator. Optional. + + + + Microsoft iSCSI Initiator is a system, such as a server that + attaches to an IP network and initiates requests and + receives responses from an iSCSI target. The SAN components + in Microsoft iSCSI Initiator are largely analogous to Fibre + Channel SAN components, and they include the following: + + + + + + + To transport blocks of iSCSI commands over the IP + network, an iSCSI driver must be installed on the iSCSI + host. An iSCSI driver is included with Microsoft iSCSI + Initiator. + + + + + + A gigabit Ethernet adapter that transmits 1000 megabits + per second (Mbps) is recommended for the connection to + an iSCSI target. Like standard 10/100 adapters, most + gigabit adapters use a preexisting Category 5 or + Category 6E cable. Each port on the adapter is + identified by a unique IP address. + + + + + + An iSCSI target is any device that receives iSCSI + commands. The device can be an end node, such as a + storage device, or it can be an intermediate device, + such as a network bridge between IP and Fibre Channel + devices. Each port on the storage array controller or + network bridge is identified by one or more IP addresses + + + + + + + + + + --intnet + + + + + If specified, connect to the iSCSI target using Internal + Networking. This needs further configuration, see + . + + + + + + + + + + + VBoxManage storagectl + + + This command attaches, modifies, and removes a storage controller. + After this, virtual media can be attached to the controller with + the storageattach command. + + + + The syntax for this command is as follows: + + +VBoxManage storagectl <uuid|vmname> + --name <name> + [--add ide|sata|scsi|floppy|sas|usb|pcie] + [--controller LSILogic|LSILogicSAS|BusLogic| + IntelAhci|PIIX3|PIIX4|ICH6|I82078| + USB|NVMe|VirtIO] + [--portcount <1-30>] + [--hostiocache on|off] + [--bootable on|off] + [--rename <name>] + [--remove] + + + The parameters are as follows: + + + + + + + uuid|vmname + + + + + The VM UUID or VM Name. Mandatory. + + + + + + + --name + + + + + Specifies the name of the storage controller. Mandatory. + + + + + + + --add + + + + + Specifies the type of the system bus to which the storage + controller must be connected. + + + + + + + --controller + + + + + Enables a choice of chipset type being emulated for the + given storage controller. + + + + + + + --portcount + + + + + This specifies the number of ports the storage controller + should support. + + + + + + + --hostiocache + + + + + Configures the use of the host I/O cache for all disk images + attached to this storage controller. See + . + + + + + + + --bootable + + + + + Specifies whether this controller is bootable. + + + + + + + --rename + + + + + Specifies a new name for the storage controller. + + + + + + + --remove + + + + + Removes the storage controller from the VM configuration. + + + + + + + + + + + VBoxManage bandwidthctl + + + This command creates, deletes, modifies, and shows bandwidth + groups of the given virtual machine. + + +VBoxManage bandwidthctl <uuid|vmname> + add <name> --type disk|network --limit <MBps>[k|m|g|K|M|G] | + set <name> --limit <MBps>[k|m|g|K|M|G] | + remove <name> | + list [--machinereadable] + + + The following subcommands are available: + + + + + + + add: Creates a new bandwidth group of a + given type. + + + + + + set: Modifies the limit for an existing + bandwidth group. + + + + + + remove: Deletes a bandwidth group. + + + + + + list: Shows all bandwidth groups defined + for the given VM. Use the + --machinereadable option to + produce the same output, but in machine readable format. This + is of the form: name="value" on a line by line basis. + + + + + + + The parameters are as follows: + + + + + + + uuid|vmname + + + + + The VM UUID or VM Name. Mandatory. + + + + + + + --name + + + + + Name of the bandwidth group. Mandatory. + + + + + + + --type + + + + + Type of the bandwidth group. Mandatory. Two types are + supported: disk and + network. See + or + for the + description of a particular type. + + + + + + + --limit + + + + + Specifies the limit for the given bandwidth group. This can + be changed while the VM is running. The default unit is + megabytes per second. The unit can be changed by specifying + one of the following suffixes: + k for kilobits per second, + m for megabits per second, + g for gigabits per second, + K for kilobytes per second, + M for megabytes per second, + G for gigabytes per second. + + + + + + + + + The network bandwidth limits apply only to the traffic being + sent by virtual machines. The traffic being received by VMs is + unlimited. + + + + + + To remove a bandwidth group it must not be referenced by any + disks or adapters in the running VM. + + + + + + + + VBoxManage showmediuminfo + + + This command shows information about a medium, notably its size, + its size on disk, its type, and the virtual machines which use it. + + + + + For compatibility with earlier versions of &product-name;, the + showvdiinfo command is also supported and + mapped internally to the showmediuminfo + command. + + + +VBoxManage showmediuminfo [disk|dvd|floppy] <uuid|filename> + + + The medium must be specified either by its UUID, if the medium is + registered, or by its filename. Registered images can be listed + using VBoxManage list hdds, VBoxManage + list dvds, or VBoxManage list + floppies, as appropriate. See + . + + + + + + + VBoxManage createmedium + + + This command creates a new medium. The syntax is as follows: + + +VBoxManage createmedium [disk|dvd|floppy] --filename <filename> + [--size <megabytes>|--sizebyte <bytes>] + [--diffparent <uuid>|<filename> + [--format VDI|VMDK|VHD] (default: VDI) + [--variant Standard,Fixed,Split2G,Stream,ESX] + + + The parameters are as follows: + + + + + + + --filename <filename> + + + + + Specifies a file name <filename> as an absolute path + on the host file system. Mandatory. + + + + + + + --size <megabytes> + + + + + Specifies the image capacity, in 1 MB units. Optional. + + + + + + + --diffparent + <uuid>|<filename> + + + + + Specifies the differencing image parent, either as a UUID or + by the absolute pathname of the file on the host file + system. Useful for sharing a base box disk image among + several VMs. + + + + + + + --format VDI|VMDK|VHD + + + + + Specifies the file format for the output file. Available + options are VDI, VMDK, VHD. The default format is VDI. + Optional. + + + + + + + --variant + + + + + Specifies any required file format variants for the output + file. This is a comma-separated list of variant flags. + Options are Standard,Fixed,Split2G,Stream,ESX. Not all + combinations are supported, and specifying mutually + incompatible flags results in an error message. Optional. + + + + + + + + + For compatibility with earlier versions of &product-name;, the + createvdi and createhd + commands are also supported and mapped internally to the + createmedium command. + + + + + + + + VBoxManage modifymedium + + + With the modifymedium command, you can change + the characteristics of a disk image after it has been created. + + +VBoxManage modifymedium [disk|dvd|floppy] <uuid|filename> + [--type normal|writethrough|immutable|shareable| + readonly|multiattach] + [--autoreset on|off] + [--property <name=[value]>] + [--compact] + [--resize <megabytes>|--resizebyte <bytes>] + [--move <path>] + [--setlocation <path>] + + + + For compatibility with earlier versions of &product-name;, the + modifyvdi and modifyhd + commands are also supported and mapped internally to the + modifymedium command. + + + + + The disk image to modify must be specified either by its UUID, if + the medium is registered, or by its filename. Registered images + can be listed using VBoxManage list hdds, see + . A filename must be specified + as a valid path, either as an absolute path or as a relative path + starting from the current directory. + + + + The following options are available: + + + + + + + With the --type argument, you + can change the type of an existing image between the normal, + immutable, write-through and other modes. See + . + + + + + + For immutable hard disks only, the --autoreset + on|off option determines whether the disk is + automatically reset on every VM startup. See + . By default, autoreset is on. + + + + + + The --compact option can be + used to compact disk images. Compacting removes blocks that + only contains zeroes. Using this option will shrink a + dynamically allocated image. It will reduce the + physical size of the image without + affecting the logical size of the virtual disk. Compaction + works both for base images and for differencing images created + as part of a snapshot. + + + + For this operation to be effective, it is required that free + space in the guest system first be zeroed out using a suitable + software tool. For Windows guests, you can use the + sdelete tool provided by Microsoft. Run + sdelete -z in the guest to zero the free + disk space, before compressing the virtual disk image. For + Linux, use the zerofree utility which + supports ext2/ext3 filesystems. For Mac OS X guests, use the + diskutil secureErase freespace 0 + / command from an elevated Terminal. + + + + Please note that compacting is currently only available for + VDI images. A similar effect can be achieved by zeroing out + free blocks and then cloning the disk to any other dynamically + allocated format. You can use this workaround until compacting + is also supported for disk formats other than VDI. + + + + + + The --resize x option, where + x is the desired new total space in megabytes enables you to + change the capacity of an existing image. This adjusts the + logical size of a virtual disk without + affecting the physical size much. + + + + This option currently works only for VDI and VHD formats, and + only for the dynamically allocated variants. It can only be + used to expand, but not shrink, the capacity. For example, if + you originally created a 10 GB disk which is now full, you can + use the --resize 15360 + command to change the capacity to 15 GB (15,360 MB) without + having to create a new image and copy all data from within a + virtual machine. Note however that this only changes the drive + capacity. You will typically next need to use a partition + management tool inside the guest to adjust the main partition + to fill the drive. + + + + The --resizebyte x option + does almost the same thing, except that x is expressed in + bytes instead of megabytes. + + + + + + The --move <path> + option can be used to relocate a medium to a different + location <path> on the host file system. The path can be + either relative to the current directory or absolute. + + + + + + The --setlocation + <path> option can be used to set the + new location <path> of the medium on the host file + system if the medium has been moved for any reasons. The path + can be either relative to the current directory or absolute. + + + + + The new location is used as is, without any sanity checks. + The user is responsible for setting the correct path. + + + + + + + + + + + VBoxManage clonemedium + + + This command duplicates a virtual disk, DVD, or floppy medium to a + new medium, usually an image file, with a new unique identifier + (UUID). The new image can be transferred to another host system or + reimported into &product-name; using the Virtual Media Manager. + See and . + The syntax is as follows: + + +VBoxManage clonemedium [disk|dvd|floppy] <uuid|inputfile> <uuid|outputfile> + + [--format VDI|VMDK|VHD|RAW|<other>] + [--variant Standard,Fixed,Split2G,Stream,ESX] + [--existing] + + + The medium to clone as well as the target image must be described + either by its UUIDs, if the mediums are registered, or by its + filename. Registered images can be listed by VBoxManage + list hdds. See . A + filename must be specified as valid path, either as an absolute + path or as a relative path starting from the current directory. + + + + The following options are available: + + + + + + + --format + + + + + Set a file format for the output file different from the + file format of the input file. + + + + + + + --variant + + + + + Set a file format variant for the output file. This is a + comma-separated list of variant flags. Not all combinations + are supported, and specifying inconsistent flags will result + in an error message. + + + + + + + --existing + + + + + Perform the clone operation to an already existing + destination medium. Only the portion of the source medium + which fits into the destination medium is copied. This means + if the destination medium is smaller than the source only a + part of it is copied, and if the destination medium is + larger than the source the remaining part of the destination + medium is unchanged. + + + + + + + + + For compatibility with earlier versions of &product-name;, the + clonevdi and clonehd + commands are still supported and mapped internally to the + clonemedium command. + + + + + + + + VBoxManage mediumproperty + + + This command sets, gets, or deletes a medium property. The syntax + is as follows: + + +VBoxManage mediumproperty [disk|dvd|floppy] set <uuid|filename> + <property> <value> + + + + + + Use <disk|dvd|floppy> + to optionally specify the type of medium: disk (hard drive), + dvd, or floppy. + + + + + + Use <uuid|filename> to + supply either the UUID or absolute path of the medium or + image. + + + + + + Use <property> to + supply the name of the property. + + + + + + Use <value> to supply + the property value. + + + + + +VBoxManage mediumproperty [disk|dvd|floppy] get <uuid|filename> + <property> + + + + + + Use <disk|dvd|floppy> + to optionally specify the type of medium: disk (hard drive), + dvd, or floppy. + + + + + + Use <uuid|filename> to + supply either the UUID or absolute path of the medium or + image. + + + + + + Use <property> to + supply the name of the property. + + + + + +VBoxManage mediumproperty [disk|dvd|floppy] delete <uuid|filename> + <property> + + + + + + Use <disk|dvd|floppy> + to optionally specify the type of medium: disk (hard drive), + dvd, or floppy. + + + + + + Use <uuid|filename> to + supply either the UUID or absolute path of the medium or + image. + + + + + + Use <property> to + supply the name of the property. + + + + + + + + + + VBoxManage encryptmedium + + + This command is used to create a DEK encrypted medium or image. + See . + + + + The syntax is as follows: + + +VBoxManage encryptmedium <uuid|filename> + [--newpassword <file|->] + [--oldpassword <file|->] + [--cipher <cipher id>] + [--newpasswordid <password id>] + + + + + + Use <uuid|filename> to + supply the UUID or absolute path of the medium or image to be + encrypted. + + + + + + Use --newpassword + <file|-> to supply a new encryption + password. Either specify the absolute pathname of a password + file on the host operating system, or + - to prompt you for the + password on the command line. Always use the + --newpasswordid option with + this option. + + + + + + Use --oldpassword + <file|-> to supply any old encryption + password. Either specify the absolute pathname of a password + file on the host operating system, or + - to prompt you for the old + password on the command line. + + + + Use this option to gain access to an encrypted medium or image + to either change its password using + --newpassword or change its + encryption using --cipher. + + + + + + Use --cipher <cipher> + to specify the cipher to use for encryption. This can be + either AES-XTS128-PLAIN64 or + AES-XTS256-PLAIN64. + + + + Use this option to change any existing encryption on the + medium or image, or to set up new encryption on it for the + first time. + + + + + + Use --newpasswordid <password + id> to supply the new password identifier. + This can be chosen by the user, and is used for correct + identification when supplying multiple passwords during VM + startup. + + + + If the user uses the same password when encrypting multiple + images and also the same password identifier, the user needs + to supply the password only once during VM startup. + + + + + + + + + + VBoxManage checkmediumpwd + + + This command is used to check the current encryption password on a + DEK encrypted medium or image. See + . + + + + The syntax is as follows: + + +VBoxManage checkmediumpwd <uuid|filename> + <pwd file|-> + + + + + + Use <uuid|filename> to + supply the UUID or absolute path of the medium or image to be + checked. + + + + + + Use <pwd file|-> to + supply the password identifier to be checked. Either specify + the absolute pathname of a password file on the host operating + system, or - to prompt you + for the password on the command line. + + + + + + + + + + VBoxManage convertfromraw + + + This command converts a raw disk image to an &product-name; Disk + Image (VDI) file. The syntax is as follows: + + +VBoxManage convertfromraw <filename> <outputfile> + [--format VDI|VMDK|VHD] + [--variant Standard,Fixed,Split2G,Stream,ESX] + [--uuid <uuid>] +VBoxManage convertfromraw stdin <outputfile> <bytes> + [--format VDI|VMDK|VHD] + [--variant Standard,Fixed,Split2G,Stream,ESX] + [--uuid <uuid>] + + + The parameters are as follows: + + + + + + + --bytes + + + + + The size of the image file, in bytes, provided through + stdin. + + + + + + + --format + + + + + Select the disk image format to create. The default format + is VDI. Other options are VMDK and VHD. + + + + + + + --variant + + + + + Choose a file format variant for the output file. This is a + comma-separated list of variant flags. Not all combinations + are supported, and specifying inconsistent flags will result + in an error message. + + + + + + + --uuid + + + + + Specify the UUID of the output file. + + + + + + + + The stdin form of the command forces + VBoxManage to read the content of the disk + image from standard input. This useful when using the command in a + pipe. + + + + + For compatibility with earlier versions of &product-name;, the + convertdd command is also supported and + mapped internally to the convertfromraw + command. + + + + + + + + VBoxManage getextradata/setextradata + + + These commands enable you to attach and retrieve string data for a + virtual machine or for an &product-name; configuration, by + specifying global instead of a + virtual machine name. You must specify a keyword as a text string + to associate the data with, which you can later use to retrieve + it. For example: + + +VBoxManage setextradata Fedora5 installdate 2006.01.01 +VBoxManage setextradata SUSE10 installdate 2006.02.02 + + + This example would associate the string "2006.01.01" with the + keyword installdate for the virtual machine Fedora5, and + "2006.02.02" on the machine SUSE10. You could then retrieve the + information as follows: + + +VBoxManage getextradata Fedora5 installdate + + + This would return the following: + + +VirtualBox Command Line Management Interface Version version-number +(C) 2005-2018 Oracle Corporation +All rights reserved. + +Value: 2006.01.01 + + + You could retrieve the information for all keywords as follows: + + +VBoxManage getextradata Fedora5 enumerate + + + To remove a keyword, the setextradata command + must be run without specifying data, only the keyword. For + example: + + +VBoxManage setextradata Fedora5 installdate + + + + + + VBoxManage setproperty + + + This command is used to change global settings which affect the + entire &product-name; installation. Some of these correspond to + the settings in the Preferences + dialog in the VirtualBox Manager. The following properties are + available: + + + + + + + machinefolder + + + + + Specifies the default folder in which virtual machine + definitions are kept. See . + + + + + + + hwvirtexclusive + + + + + Specifies whether &product-name; will make exclusive use of + the hardware virtualization extensions (Intel VT-x or AMD-V) + of the host system's processor. See + . If you wish to share these + extensions with other hypervisors running at the same time, + you must disable this setting. Doing so has negative + performance implications. + + + + + + + vrdeauthlibrary + + + + + Specifies which library to use when external authentication + has been selected for a particular virtual machine. See + . + + + + + + + websrvauthlibrary + + + + + Specifies which library the web service uses to authenticate + users. For details about the &product-name; web service, see + the &product-name; SDK reference, + . + + + + + + + vrdeextpack + + + + + Specifies which library implements the VirtualBox Remote + Desktop Extension. + + + + + + + loghistorycount + + + + + Selects how many rotated VM logs are retained. + + + + + + + autostartdbpath + + + + + Selects the path to the autostart database. See + . + + + + + + + defaultfrontend + + + + + Selects the global default VM frontend setting. See + . + + + + + + + logginglevel + + + + + Configures the VBoxSVC release logging details. See + . + + + + + + + proxymode + + + + + Configures the mode for an HTTP proxy server. + + + + + + + proxyurl + + + + + Configures the URL for an HTTP proxy server. Used when a + manual proxy is configured using the + manual setting of the + proxymode property. + + + + + + + + + + + VBoxManage usbfilter add/modify/remove + +VBoxManage usbfilter add <index,0-N> + --target <uuid|vmname>global + --name <string> + --action ignore|hold (global filters only) + [--active yes|no (yes)] + [--vendorid <XXXX> (null)] + [--productid <XXXX> (null)] + [--revision <IIFF> (null)] + [--manufacturer <string> (null)] + [--product <string> (null)] + [--remote yes|no (null, VM filters only)] + [--serialnumber <string> (null)] + [--maskedinterfaces <XXXXXXXX>] + + +VBoxManage usbfilter modify <index,0-N> + --target <uuid|vmname>global + [--name <string>] + [--action ignore|hold (global filters only)] + [--active yes|no] + [--vendorid <XXXX>] + [--productid <XXXX>] + [--revision <IIFF>] + [--manufacturer <string>] + [--product <string>] + [--remote yes|no (null, VM filters only)] + [--serialnumber <string>] + [--maskedinterfaces <XXXXXXXX>] + + +VBoxManage usbfilter remove <index,0-N> + --target <uuid|vmname>global + + + + The usbfilter commands are used for working + with USB filters in virtual machines, or global filters which + affect the whole &product-name; setup. Global filters are applied + before machine-specific filters, and may be used to prevent + devices from being captured by any virtual machine. Global filters + are always applied in a particular order, and only the first + filter which fits a device is applied. For example, if the first + global filter says to hold, or make available, a particular + Kingston memory stick device and the second filter says to ignore + all Kingston devices. That particular Kingston memory stick will + be available to any machine with the appropriate filter, but no + other Kingston device will. + + + + When creating a USB filter using usbfilter add, + you must supply three or four mandatory parameters. The index + specifies the position in the list at which the filter should be + placed. If there is already a filter at that position, then it and + the following ones will be shifted back one place. Otherwise, the + new filter will be added onto the end of the list. The + target parameter selects the + virtual machine that the filter should be attached to or use + global to apply it to all virtual + machines. name is a name for the + new filter. For global filters, + action says whether to allow VMs + access to devices that fit the filter description (hold) or not to + give them access (ignore). In addition, you should specify + parameters to filter by. You can find the parameters for devices + attached to your system using VBoxManage list + usbhost. Finally, you can specify whether the filter + should be active. For local filters, whether they are for local + devices, remote devices over an RDP connection, or either. + + + + When you modify a USB filter using usbfilter + modify, you must specify the filter by index and by + target, which is either a virtual machine or + global. See the output of + VBoxManage list usbfilters to find global + filter indexes and VBoxManage showvminfo to + find indexes for individual machines. The properties which can be + changed are the same as for usbfilter add. To + remove a filter, use usbfilter remove and + specify the index and the target. + + + + The following is a list of the additional usbfilter + add and usbfilter modify options, + with details of how to use them. + + + + + + + --action ignore|hold: + Specifies whether devices that fit the filter description are + allowed access by machines (hold), or have access denied + (ignore). Applies to global filters only. + + + + + + --active yes|no: Specifies + whether the USB Filter is active or temporarily disabled. For + usbfilter create the default + is active. + + + + + + --vendorid <XXXX>|"": + Specifies a vendor ID filter. The string representation for an + exact match has the form XXXX, where X is the hexadecimal + digit, including leading zeroes. + + + + + + --productid <XXXX>|"": + Specifies a product ID filter. The string representation for + an exact match has the form XXXX, where X is the hexadecimal + digit, including leading zeroes. + + + + + + --revision <IIFF>|"": + Specifies a revision ID filter. The string representation for + an exact match has the form IIFF, where I is the decimal digit + of the integer part of the revision, and F is the decimal + digit of its fractional part, including leading and trailing + zeros. Note that for interval filters, it is best to use the + hexadecimal form, because the revision is stored as a 16-bit + packed BCD value. Therefore, the expression int:0x0100-0x0199 + will match any revision from 1.0 to 1.99 inclusive. + + + + + + --manufacturer + <string>|"": Specifies a manufacturer + ID filter, as a string. + + + + + + --product <string>|"": + Specifies a product ID filter, as a string. + + + + + + --remote yes|no"": Specifies + a remote filter, indicating whether the device is physically + connected to a remote VRDE client or to a local host machine. + Applies to VM filters only. + + + + + + --serialnumber + <string>|"": Specifies a serial number + filter, as a string. + + + + + + --maskedinterfaces + <XXXXXXXX>: Specifies a masked + interface filter, for hiding one or more USB interfaces from + the guest. The value is a bit mask where the set bits + correspond to the USB interfaces that should be hidden, or + masked off. This feature only works on Linux hosts. + + + + + + + + + + VBoxManage guestproperty + + + The guestproperty commands enable you to get or + set properties of a running virtual machine. See + . Guest properties are + arbitrary keyword-value string pairs which can be written to and + read from by either the guest or the host, so they can be used as + a low-volume communication channel for strings, provided that a + guest is running and has the Guest Additions installed. In + addition, a number of values whose keywords begin with + /VirtualBox/are automatically set + and maintained by the Guest Additions. + + + + The following subcommands are available, where + <vm> can either be a VM + name or a VM UUID, as with the other VBoxManage + commands: + + + + + + + enumerate <vm> [--patterns + <pattern>]: Lists all the guest + properties that are available for the given VM, including the + value. This list will be very limited if the guest's service + process cannot be contacted, for example because the VM is not + running or the Guest Additions are not installed. + + + + If --patterns <pattern> + is specified, it acts as a filter to only list properties that + match the given pattern. The pattern can contain the following + wildcard characters: + + + + + + + * (asterisk): Represents + any number of characters. For example, + "/VirtualBox*" would + match all properties beginning with "/VirtualBox". + + + + + + ? (question mark): + Represents a single arbitrary character. For example, + "fo?" would match both + "foo" and "for". + + + + + + | (pipe symbol): Can be + used to specify multiple alternative patterns. For + example, "s*|t*" would + match anything starting with either "s" or "t". + + + + + + + + + get <vm> + <property>: Retrieves the value of a + single property only. If the property cannot be found, for + example because the guest is not running, the following + message is shown: + + +No value set! + + + + + set <vm> <property> [<value> + [--flags <flags>]]: Enables you to set + a guest property by specifying the keyword and value. If + <value> is omitted, the + property is deleted. With + --flags, you can specify + additional behavior. You can combine several flags by + separating them with commas. + + + + + + + TRANSIENT: The value will + not be stored with the VM data when the VM exits. + + + + + + TRANSRESET: The value + will be deleted as soon as the VM restarts or exits. + + + + + + RDONLYGUEST: The value + can only be changed by the host, but the guest can only + read it. + + + + + + RDONLYHOST: The value can + only be changed by the guest, but the host can only read + it. + + + + + + READONLY: The value + cannot be changed at all. + + + + + + + + + wait <vm> <pattern> --timeout + <timeout>: Waits for a particular value + described by the pattern string to change or to be deleted or + created. The pattern rules are the same as for the + enumerate subcommand. + + + + + + delete <vm> + <property>: Deletes a guest property + which has been set previously. + + + + + + + + + + VBoxManage guestcontrol + + + The guestcontrol commands enable control of the + guest from the host. See + for an introduction. + + + + The guestcontrol command has two sets of + subcommands. The first set requires guest credentials to be + specified, the second does not. + + + + The first set of subcommands is of the following form: + + +VBoxManage guestcontrol <uuid|vmname> <sub-command> + [--username <name> ] + [--passwordfile <file> | --password <password>] + [--domain <domain> ] + [-v|--verbose] [-q|quiet] ... + + + + The common options are as follows: + + + + [--username <name> ] + [--passwordfile <file> | --password <password>] + [--domain <domain> ] + [-v|--verbose] [-q|quiet] + + + + The common options for the first set of subcommands are explained + in the following list. + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --username <name> + + + + + Specifies the user name on guest OS under which the process + should run. This user name must already exist on the guest + OS. If unspecified, the host user name is used. Optional + + + + + + + --passwordfile + <file>|--password + + + + + Specifies the absolute path on guest file system of password + file containing the password for the specified user account + or password for the specified user account. Optional. If + both are omitted, empty password is assumed. + + + + + + + --domain <domain> + + + + + User domain for Windows guests. Optional. + + + + + + + -v|--verbose + + + + + Makes the subcommand execution more verbose. Optional + + + + + + + -q|--quiet + + + + + Makes the subcommand execution quieter. Optional. + + + + + + + + The first set of subcommands are as follows: + + + + + + + run: Executes a guest + program, forwarding stdout, stderr, and stdin to and from the + host until it completes. + + +VBoxManage guestcontrol <uuid|vmname> run [common-options] + --exe <path to executable> [--timeout <msec>] + [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] + [--ignore-operhaned-processes] [--profile] + [--no-wait-stdout|--wait-stdout] + [--no-wait-stderr|--wait-stderr] + [--dos2unix] [--unix2dos] + -- <program/arg0> [argument1] ... [argumentN]] + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --exe <path to + executable> + + + + + Specifies the absolute path of the executable on the + guest OS file system. Mandatory. For example: + C:\Windows\System32\calc.exe. + + + + + + + --timeout <msec> + + + + + Specifies the maximum time, in microseconds, that the + executable can run, during which + VBoxManage receives its output. + Optional. If unspecified, VBoxManage + waits indefinitely for the process to end, or an error + occurs. + + + + + + + -E|--putenv + <NAME>=<VALUE> + + + + + Sets, modifies, and unsets environment variables in the + environment in which the program will run. Optional. + + + + The guest process is created with the standard default + guest OS environment. Use this option to modify that + default environment. To set or modify a variable use: + <NAME>=<VALUE>. + To unset a variable use: + <NAME>= + + + + Any spaces in names and values should be enclosed by + quotes. + + + + To set, modify, and unset multiple variables, use + multiple instances of the + --E|--putenv option. + + + + + + + --unquoted-args + + + + + Disables escaped double quoting, such as \"fred\", on + arguments passed to the executed program. Optional. + + + + + + + --ignore-operhaned-processes + + + + + Ignore orphaned processes. Not yet implemented. + Optional. + + + + + + + --profile + + + + + Use Profile. Not yet implemented. Optional. + + + + + + + --no-wait-stdout|--wait-stdout + + + + + Does not wait or waits until the guest process ends and + receives its exit code and reason/flags. In the case of + --wait-stdout, + VBoxManage receives its stdout while + the process runs. Optional. + + + + + + + --no-wait-stderr|--wait-stderr + + + + + Does not wait or waits until the guest process ends and + receives its exit code, error messages, and flags. In + the case of + --wait-stderr, + VBoxManage receives its stderr while + the process runs. Optional. + + + + + + + --dos2unix + + + + + Converts output from DOS/Windows guests to + UNIX/Linux-compatible line endings, CR + LF to LF. Not + yet implemented. Optional. + + + + + + + --unix2dos + + + + + Converts output from a UNIX/Linux guests to + DOS/Windows-compatible line endings, LF to CR + LF. Not + yet implemented. Optional. + + + + + + + [-- <program/arg0> + [<argument1>] ... + [<argumentN>]] + + + + + Specifies the program name, followed by one or more + arguments to pass to the program. Optional. + + + + Any spaces in arguments should be enclosed by quotes. + + + + + + + + + On Windows there are certain limitations for graphical + applications. See . + + + + + Examples of using the guestcontrol run + command are as follows: + + +VBoxManage --nologo guestcontrol "My VM" run --exe "/bin/ls" + --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr + +VBoxManage --nologo guestcontrol "My VM" run --exe "c:\\windows\\system32\\ipconfig.exe" + --username foo --passwordfile bar.txt --wait-exit --wait-stdout + + + Note that the double backslashes in the second example are + only required on UNIX hosts. + + + + + For certain commands a user name of an existing user account + on the guest must be specified. Anonymous executions are not + supported for security reasons. A user account password, + however, is optional and depends on the guest's OS security + policy or rules. If no password is specified for a given + user name, an empty password will be used. On certain OSes + like Windows the security policy may needs to be adjusted in + order to allow user accounts with an empty password set. + Also, global domain rules might apply and therefore cannot + be changed. + + + + + Starting at &product-name; 4.1.2 guest process execution by + default is limited to serve up to five guest processes at a + time. If a new guest process gets started which would exceed + this limit, the oldest not running guest process will be + discarded in order to be able to run that new process. Also, + retrieving output from this old guest process will not be + possible anymore then. If all five guest processes are still + active and running, starting a new guest process will result + in an appropriate error message. + + + + To raise or lower the guest process execution limit, either + use the guest property + /VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept + or VBoxService command line by specifying + --control-procs-max-kept + needs to be modified. A restart of the guest OS is required + afterwards. To serve unlimited guest processes, a value of + 0 needs to be set, but this + is not recommended. + + + + + + start: Executes a guest + program until it completes. + + +VBoxManage guestcontrol <uuid|vmname> start [common-options] + [--exe <path to executable>] [--timeout <msec>] + [-E|--putenv <NAME>[=<VALUE>]] [--unquoted-args] + [--ignore-operhaned-processes] [--profile] + -- <program/arg0> [argument1] ... [argumentN]] + + + + Where the options are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --exe <path to + executable> + + + + + Specifies the absolute path of the executable on the + guest OS file system. Mandatory. For example: + C:\Windows\System32\calc.exe + + + + + + + --timeout <msec> + + + + + Specifies the maximum time, in microseconds, that the + executable can run. Optional. If unspecified, + VBoxManage waits indefinitely for the + process to end, or an error occurs. + + + + + + + -E|--putenv + <NAME>=<VALUE> + + + + + Sets, modifies, and unsets environment variables in the + environment in which the program will run. Optional. + + + + The guest process is created with the standard default + guest OS environment. Use this option to modify that + default environment. To set or modify a variable use: + <NAME>=<VALUE>. + To unset a variable use: + <NAME>= + + + + Any spaces in names and values should be enclosed by + quotes. + + + + To set, modify, or unset multiple variables, use + multiple instances of the + --E|--putenv option. + + + + + + + --unquoted-args + + + + + Disables escaped double quoting, such as \"fred\", on + arguments passed to the executed program. Optional. + + + + + + + --ignore-operhaned-processes + + + + + Ignores orphaned processes. Not yet implemented. + Optional. + + + + + + + --profile + + + + + Use a profile. Not yet implemented. Optional. + + + + + + + [-- <program/arg0> + [<argument1>] ... + [<argumentN>]] + + + + + Specifies the program name, followed by one or more + arguments to pass to the program. Optional. + + + + Any spaces in arguments should be enclosed by quotes. + + + + + + + + + On Windows there are certain limitations for graphical + applications. See . + + + + + Examples of using the guestcontrol start + command are as follows: + + +VBoxManage --nologo guestcontrol "My VM" start --exe "/bin/ls" + --username foo --passwordfile bar.txt --wait-exit --wait-stdout -- -l /usr + +VBoxManage --nologo guestcontrol "My VM" start --exe "c:\\windows\\system32\\ipconfig.exe" + --username foo --passwordfile bar.txt --wait-exit --wait-stdout + + + Note that the double backslashes in the second example are + only required on UNIX hosts. + + + + + For certain commands a user name of an existing user account + on the guest must be specified. Anonymous executions are not + supported for security reasons. A user account password, + however, is optional and depends on the guest's OS security + policy or rules. If no password is specified for a given + user name, an empty password will be used. On certain OSes + like Windows the security policy may needs to be adjusted in + order to allow user accounts with an empty password set. + Also, global domain rules might apply and therefore cannot + be changed. + + + + + Starting at &product-name; 4.1.2 guest process execution by + default is limited to serve up to five guest processes at a + time. If a new guest process gets started which would exceed + this limit, the oldest not running guest process will be + discarded in order to be able to run that new process. Also, + retrieving output from this old guest process will not be + possible anymore then. If all five guest processes are still + active and running, starting a new guest process will result + in an appropriate error message. + + + + To raise or lower the guest process execution limit, either + use the guest property + /VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept + or VBoxService command line by specifying + --control-procs-max-kept + needs to be modified. A restart of the guest OS is required + afterwards. To serve unlimited guest processes, a value of + 0 needs to be set, but this + is not recommended. + + + + + + copyfrom: Copies files from + the guest to the host file system. Only available with Guest + Additions 4.0 or later installed. + + +VBoxManage guestcontrol <uuid|vmname> copyfrom [common-options] + [--follow] [--R|recursive] + --target-directory <host-dst-dir> + <guest-src0> [<guest-src1> [...]] + + + Where the parameters are as follows: + + + + + + + <uid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --follow + + + + + Enables symlink following on the guest file system. + Optional. + + + + + + + -R|--recursive + + + + + Enables recursive copying of files and directories from + the specified guest file system directory. Optional. + + + + + + + --target-directory + <host-dst-dir> + + + + + Specifies the absolute path of the host file system + destination directory. Mandatory. For example: + C:\Temp. + + + + + + + <guest-src0> [<guest-src1> + [...]] + + + + + Specifies the absolute paths of guest file system files + to be copied. Mandatory. For example: + C:\Windows\System32\calc.exe. + Wildcards can be used in the expressions. For example: + C:\Windows\System*\*.dll. + + + + + + + + + + copyto: Copies files from the + host to the guest file system. Only available with Guest + Additions 4.0 or later installed. + + +VBoxManage guestcontrol <uuid|vmname> copyto [common-options] + [--follow] [--R|recursive] + --target-directory <guest-dst> + <host-src0> [<host-src1> [...]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --follow + + + + + Enables symlink following on the host file system. + Optional. + + + + + + + -R|--recursive + + + + + Enables recursive copying of files and directories from + the specified host file system directory. Optional. + + + + + + + --target-directory + <guest-dst> + + + + + Specifies the absolute path of the guest file system + destination directory. Mandatory. For example: + C:\Temp. + + + + + + + <host-src0> [<host-src1> + [...]] + + + + + Specifies the absolute paths of host file system files + to be copied. Mandatory. For example: + C:\Windows\System32\calc.exe. + Wildcards can be used in the expressions. For example: + C:\Windows\System*\*.dll. + + + + + + + + + + md|mkdir|createdir|createdirectory: + Creates one or more directories on the guest file system. Only + available with Guest Additions 4.0 or later installed. + + +VBoxManage guestcontrol <uuid|vmname> md|mkdir|createdir|createdirectory [common-options] + [--parents] [--mode <mode>] + <guest-dir0> [<guest-dir1> [...]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --parents + + + + + Creates any absent parent directories of the specified + directory. Optional. + + + + For example: If specified directory is + D:\Foo\Bar and + D:\Foo is absent, it will be + created. In such a case, had the + --parents option not + been used, this command would have failed. + + + + + + + --mode <mode> + + + + + Specifies the permission mode on the specified + directories, and any parents, if the + --parents option is + used. Currently octal modes only, such as. + 0755, are supported. + + + + + + + <guest-dir0> [<guest-dir1> + [...]] + + + + + Specifies a list of absolute paths of directories to be + created on guest file system. Mandatory. For example: + D:\Foo\Bar. + + + + All parent directories must already exist unless the + switch --parents is + used. For example, in the above example + D:\Foo. The specified user must + have sufficient rights to create the specified + directories, and any parents that need to be created. + + + + + + + + + + rmdir|removedir|removedirectory: + Deletes specified guest file system directories. Only + available with installed Guest Additions 4.3.2 and later. + + +VBoxManage guestcontrol <uuid|vmname> rmdir|removedir|removedirectory [common-options] + [--recursive|-R] + <guest-dir0> [<guest-dir1> [...]] + + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --recursive + + + + + Recursively removes directories and contents. Optional. + + + + + + + <guest-dir0> [<guest-dir1> + [...]] + + + + + Specifies a list of the absolute paths of directories to + be deleted on guest file system. Mandatory. Wildcards + are allowed. For example: + D:\Foo\*Bar. The specified user + must have sufficient rights to delete the specified + directories. + + + + + + + + + + rm|removefile: Deletes + specified files on the guest file system. Only available with + installed Guest Additions 4.3.2 and later. + + +VBoxManage guestcontrol <uuid|vmname> rm|removefile [common-options] + [-f|--force] + <guest-file0> [<guest-file1> [...]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + -f|--force + + + + + Enforce operation and override any requests for + confirmations. Optional. + + + + + + + <guest-file0> [<guest-file1> + [...]] + + + + + Specifies a list of absolute paths of files to be + deleted on guest file system. Mandatory. Wildcards are + allowed. For example: + D:\Foo\Bar\text*.txt. The specified + user should have sufficient rights to delete the + specified files. + + + + + + + + + + mv|move|ren|rename: Renames + files and/or directories on the guest file system. Only + available with installed Guest Additions 4.3.2 and later. + + +VBoxManage guestcontrol <uuid|vmname> mv|move|ren|rename [common-options] + <guest-source0> [<guest-source1> [...]] <guest-dest> + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + <guest-source0> + [<guest-source1> [...]] + + + + + Specifies absolute paths of files or a single directory + to be moved and renamed on guest file system. Mandatory. + Wildcards are allowed in file names. The specified user + should have sufficient rights to access the specified + files. + + + + + + + <dest> + + + + + Specifies the absolute path of the destination file or + directory to which the files are to be moved. Mandatory. + If only one file to be moved, <dest> can be file + or directory, else it must be a directory. The specified + user must have sufficient rights to access the + destination file or directory. + + + + + + + + + + mktemp|createtemp|createtemporary: + Creates a temporary file or directory on the guest file + system, to assist subsequent copying of files from the host to + the guest file systems. By default, the file or directory is + created in the guest's platform specific temp directory. Not + currently supported. Only available with installed Guest + Additions 4.2 and later. + + +VBoxManage guestcontrol <uuid|vmname> mktemp|createtemp|createtemporary [common-options] + [--directory] [--secure] [--mode <mode>] [--tmpdir <directory>] + <template> + + + + The parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --directory + + + + + Creates a temporary directory instead of a file, + specified by the <template> parameter. Optional. + + + + + + + --secure + + + + + Enforces secure file and directory creation. Optional. + The permission mode is set to + 0755. Operation fails + if it cannot be performed securely. + + + + + + + --mode <mode> + + + + + Specifies the permission mode of the specified + directory. Optional. Currently only octal modes, such as + 0755, are supported. + + + + + + + --tmpdir + <directory> + + + + + Specifies the absolute path of the directory on the + guest file system where the file or directory specified + will be created. Optional. If unspecified, the + platform-specific temp directory is used. + + + + + + + <template> + + + + + Specifies a file name without a directory path, + containing at least one sequence of three consecutive X + characters, or ending in X. Mandatory. + + + + + + + + + + stat: Displays file or file + system statuses on the guest. + + +VBoxManage guestcontrol <uuid|vmname> stat [common-options] + <file0> [<file1> [...]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + <file0> [<file1> + [...]] + + + + + Specifies absolute paths of files or file systems on the + guest file system. Mandatory. For example: + /home/foo/a.out. The specified user + should have sufficient rights to access the specified + files or file systems. + + + + + + + + + + + The second set of subcommands is of the form: + + +VBoxManage guestcontrol <uuid|vmname> <sub-command> + [-v|--verbose] [-q|quiet] ... + + + + The common options are as follows: + + + + [-v|--verbose] [-q|--quiet] + + + + Details of the common options for the second set of subcommands + are as follows: + + + + + + + -v|--verbose + + + + + Makes the subcommand execution more verbose. Optional. + + + + + + + -q|--quiet + + + + + Makes the subcommand execution quieter. Optional. + + + + + + + + The second set of subcommands are as follows: + + + + + + + list: Lists guest control + configuration and status data. For example: open guest + sessions, guest processes, and files. + + +VBoxManage guestcontrol <uuid|vmname> list [common-opts] + <all|sessions|processes|files> + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + all|sessions|processes|files + + + + + Indicates whether to list all available data or guest + sessions, processes or files. Mandatory. + + + + + + + + + + closeprocess: Terminates + guest processes specified by PIDs running in a guest session, + specified by the session ID or name. + + +VBoxManage guestcontrol <uuid|vmname> closeprocess [common-options] + --session-id <ID> | --session-name <name or pattern> + <PID0> [<PID1> [...]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --session-id <ID> + + + + + Specifies the guest session by its ID. Optional. + + + + + + + --session-name <name or + pattern> + + + + + Specifies the guest session by its name, or multiple + sessions using a pattern containing wildcards. Optional. + + + + + + + <PID0> [<PID1> + [...]] + + + + + Specifies a list of process identifiers (PIDs) of guest + processes to be terminated. Mandatory. + + + + + + + + + + closesession: Closes + specified guest sessions, specified either by session ID or + name. + + +VBoxManage guestcontrol <uuid|vmname> closesession [common-options] + --session-id <ID> | --session-name <name or pattern> | --all + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --session-id <ID> + + + + + Specifies the guest session to be closed by ID. + Optional. + + + + + + + --session-name <name or + pattern> + + + + + Specifies the guest session to be closed by name. + Optional. Multiple sessions can be specified by using a + pattern containing wildcards. + + + + + + + --all + + + + + Close all guest sessions. Optional. + + + + + + + + + + updatega|updateadditions|updateguestadditions: + Ugrades Guest Additions already installed on the guest. Only + available for already installed Guest Additions 4.0 and later. + + +VBoxManage guestcontrol <uuid|vmname> updatega|updateadditions|updateguestadditions + [common-options] + [--source <New .ISO path>] + [--wait-start] + [-- <argument0> [<argument1> [...]]] + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + --source <New .ISO + path> + + + + + Specifies the absolute path on the guest file system of + the .ISO file for the Guest Additions update. Mandatory. + + + + + + + --wait-start + + + + + Indicates that VBoxManage starts the + usual updating process on the guest and then waits until + the actual Guest Additions updating begins, at which + point VBoxManage self-terminates. + Optional. + + + + Default behavior is that VBoxManage + waits for completion of the Guest Additions update + before terminating. Use of this option is sometimes + necessary, as a running VBoxManage + can affect the interaction between the installer and the + guest OS. + + + + + + + [-- <argument0> [<argument1> + [...]]] + + + + + Specifies optional command line arguments to be supplied + to the Guest Additions updater. Useful for retrofitting + features which are not currently installed. + + + + Arguments containing spaces should be enclosed by + quotes. + + + + + + + + + + watch: Prints current guest + control activity. + + +VBoxManage guestcontrol <uuid|vmname> watch [common-options] + + + + Where the parameters are as follows: + + + + + + + <uuid|vmname> + + + + + Specifies the VM UUID or VM name. Mandatory. + + + + + + + + + + + + + + VBoxManage metrics + + + This command supports monitoring the usage of system resources. + Resources are represented by various metrics associated with the + host system or a particular VM. For example, the host system has a + CPU/Load/User metric that shows + the percentage of time CPUs spend executing in user mode over a + specific sampling period. + + + + Metric data is collected and retained internally. It may be + retrieved at any time with the VBoxManage metrics + query subcommand. The data is available as long as the + background VBoxSVC process is + alive. That process terminates shortly after all VMs and frontends + have been closed. + + + + By default no metrics are collected at all. Metrics collection + does not start until VBoxManage metrics setup + is invoked with a proper sampling interval and the number of + metrics to be retained. The interval is measured in seconds. For + example, to enable collecting the host processor and memory usage + metrics every second and keeping the five most current samples, + the following command can be used: + + +VBoxManage metrics setup --period 1 --samples 5 host CPU/Load,RAM/Usage + + + Metric collection can only be enabled for started VMs. Collected + data and collection settings for a particular VM will disappear as + soon as it shuts down. Use the VBoxManage metrics + list subcommand to see which metrics are currently + available. You can also use the option + with any subcommand that modifies metric settings to find out + which metrics were affected. + + + + Note that the VBoxManage metrics setup + subcommand discards all samples that may have been previously + collected for the specified set of objects and metrics. + + + + To enable or disable metrics collection without discarding the + data, VBoxManage metrics enable and + VBoxManage metrics disable subcommands can be + used. Note that these subcommands expect metrics as parameters, + not submetrics such as CPU/Load + or RAM/Usage. In other words + enabling CPU/Load/User while + disabling CPU/Load/Kernel is not + supported. + + + + The host and VMs have different sets of associated metrics. + Available metrics can be listed with VBoxManage metrics + list subcommand. + + + + A complete metric name may include an aggregate function. The name + has the following form: + Category/Metric[/SubMetric][:aggregate]. + For example, RAM/Usage/Free:min + stands for the minimum amount of available memory over all + retained data if applied to the host object. + + + + Subcommands may apply to all objects and metrics or can be limited + to one object and a list of metrics. If no objects or metrics are + given in the parameters, the subcommands will apply to all + available metrics of all objects. You may use an asterisk + "*" to explicitly specify that + the command should be applied to all objects or metrics. Use + host as the object name to limit + the scope of the command to host-related metrics. To limit the + scope to a subset of metrics, use a metric list with names + separated by commas. + + + + For example, to query metric data on the CPU time spent in user + and kernel modes by the virtual machine named + test, use the following command: + + +VBoxManage metrics query test CPU/Load/User,CPU/Load/Kernel + + + The following list summarizes the available subcommands: + + + + + + + list + + + + + Shows the parameters of the currently existing metrics. Note + that VM-specific metrics are only available when a + particular VM is running. + + + + + + + setup + + + + + Sets the interval between taking two samples of metric data + and the number of samples retained internally. The retained + data is available for displaying with the + query subcommand. The + --list option shows which + metrics have been modified as the result of the command + execution. + + + + + + + enable + + + + + Resumes data collection after it has been stopped with the + disable subcommand. Note that specifying + submetrics as parameters will not enable underlying metrics. + Use --list to find out if + the command worked as expected. + + + + + + + disable + + + + + Suspends data collection without affecting collection + parameters or collected data. Note that specifying + submetrics as parameters will not disable underlying + metrics. Use --list to find + out if the command worked as expected. + + + + + + + query + + + + + Retrieves and displays the currently retained metric data. + + + + + The query subcommand does not remove or + flush retained data. If you query often enough you will + see how old samples are gradually being phased out by new + samples. + + + + + + + + collect + + + + + Sets the interval between taking two samples of metric data + and the number of samples retained internally. The collected + data is displayed periodically until Ctrl+C is pressed, + unless the --detach option + is specified. With the + --detach option, this + subcommand operates the same way as + setup does. The + --list option shows which + metrics match the specified filter. + + + + + + + + + + + VBoxManage natnetwork + + + NAT networks use the Network Address Translation (NAT) service, + which works in a similar way to a home router. It groups systems + using it into a network and prevents outside systems from directly + accessing those inside, while letting systems inside communicate + with each other and outside systems using TCP and UDP over IPv4 + and IPv6. + + + + A NAT service is attached to an internal network. Virtual machines + to make use of one should be attached to it. The name of an + internal network is chosen when the NAT service is created, and + the internal network will be created if it does not already exist. + The following is an example command to create a NAT network: + + +VBoxManage natnetwork add --netname natnet1 --network "192.168.15.0/24" --enable + + + Here, natnet1 is the name of the + internal network to be used and + 192.168.15.0/24 is the network + address and mask of the NAT service interface. By default, in this + static configuration the gateway will be assigned the address + 192.168.15.1, the address after the interface address, though this + is subject to change. + + + + To add a DHCP server to the NAT network after creation, run the + following command: + + +VBoxManage natnetwork modify --netname natnet1 --dhcp on + + + The subcommands for VBoxManage natnetwork are + as follows: + + +VBoxManage natnetwork add --netname <name> + [--network <network>] + [--enable|--disable] + [--dhcp on|off] + [--port-forward-4 <rule>] + [--loopback-4 <rule>] + [--ipv6 on|off] + [--port-forward-6 <rule>] + [--loopback-6 <rule>] + + + + VBoxManage natnetwork add: Creates a new + internal network interface, and adds a NAT network service. This + command is a prerequisite for enabling attachment of VMs to the + NAT network. Parameters are as follows: + + + + + + + --netname <name> + + + + + Where <name> is the name of the new internal network + interface on the host OS. + + + + + + + --network <network> + + + + + Where <network> specifies the static or DHCP network + address and mask of the NAT service interface. The default + is a static network address. + + + + + + + --enable|--disable + + + + + Enables and disables the NAT network service. + + + + + + + --dhcp on|off + + + + + Enables and disables a DHCP server specified by + --netname. Use of this + option also indicates that it is a DHCP server. + + + + + + + --port-forward-4 <rule> + + + + + Enables IPv4 port forwarding, with a rule specified by + <rule>. + + + + + + + --loopback-4 <rule> + + + + + Enables the IPv4 loopback interface, with a rule specified + by <rule>. + + + + + + + --ipv6 on|off + + + + + Enables and disables IPv6. The default setting is IPv4, + disabling IPv6 enables IPv4. + + + + + + + --port-forward-6 <rule> + + + + + Enables IPv6 port forwarding, with a rule specified by + <rule>. + + + + + + + --loopback-6 <rule> + + + + + Enables the IPv6 loopback interface, with a rule specified + by <rule>. + + + + + + +VBoxManage natnetwork remove --netname <name> + + + VBoxManage natnetwork remove: Removes a NAT + network service. Parameters are as follows: + + + + + + + --netname <name> + + + + + Where <name> specifies an existing NAT network + service. Does not remove any DHCP server enabled on the + network. + + + + + + +VBoxManage natnetwork modify --netname <name> + [--network <network>] + [--enable|--disable] + [--dhcp on|off] + [--port-forward-4 <rule>] + [--loopback-4 <rule>] + [--ipv6 on|off] + [--port-forward-6 <rule>] + [--loopback-6 <rule>] + + + + VBoxManage natnetwork modify: Modifies an + existing NAT network service. Parameters are as follows: + + + + + + + --netname <name> + + + + + Where <name> specifies an existing NAT network + service. + + + + + + + --network <network> + + + + + Where <network> specifies the new static or DHCP + network address and mask of the NAT service interface. The + default is a static network address. + + + + + + + --enable|--disable + + + + + Enables and disables the NAT network service. + + + + + + + --dhcp on|off + + + + + Enables and disables a DHCP server. If a DHCP server is not + present, using enable adds a new DHCP server. + + + + + + + --port-forward-4 <rule> + + + + + Enables IPv4 port forwarding, with a rule specified by + <rule>. + + + + + + + --loopback-4 <rule> + + + + + Enables the IPv4 loopback interface, with a rule specified + by <rule>. + + + + + + + --ipv6 on|off + + + + + Enables and disables IPv6. The default setting is IPv4, + disabling IPv6 enables IPv4. + + + + + + + --port-forward-6 <rule> + + + + + Enables IPv6 port forwarding, with a rule specified by + <rule>. + + + + + + + --loopback-6 <rule> + + + + + Enables IPv6 loopback interface, with a rule specified by + <rule>. + + + + + + +VBoxManage natnetwork start --netname <name> + + + + VBoxManage natnetwork start: Starts the + specified NAT network service and any associated DHCP server. + Parameters are as follows: + + + + + + + --netname <name> + + + + + Where <name> specifies an existing NAT network + service. + + + + + + +VBoxManage natnetwork stop --netname <name> + + + + VBoxManage natnetwork stop: Stops the specified + NAT network service and any DHCP server. Parameters are as + follows: + + + + + + + --netname <name> + + + + + Where <name> specifies an existing NAT network + service. + + + + + + +VBoxManage natnetwork list [<pattern>] + + + VBoxManage natnetwork list: Lists all NAT + network services, with optional filtering. Parameters are as + follows: + + + + + + + [<pattern>] + + + + + Where <pattern> is an optional filtering pattern. + + + + + + + + + + + VBoxManage hostonlyif + + + The hostonlyif command enables you to change + the IP configuration of a host-only network interface. For a + description of host-only networking, see + . Each host-only interface is + identified by a name and can either use the internal DHCP server + or a manual IP configuration, both IP4 and IP6. + + + + The following list summarizes the available subcommands: + + + + + + + ipconfig "<name>" + + + + + Configures a host-only interface. + + + + + + + create + + + + + Creates a new vboxnet<N> interface on the host OS. + This command is essential before you can attach VMs to a + host-only network. + + + + + + + remove vboxnet<N> + + + + + Removes a vboxnet<N> interface from the host OS. + + + + + + + + + + + VBoxManage usbdevsource + + + The usbdevsource commands enable you to add and + remove USB devices globally. + + + + The following command adds a USB device. + + +VBoxManage usbdevsource add <source name> + --backend <backend> + --address <address> + + + + Where the command line options are as follows: + + + + + + + <source name>: + Specifies the ID of the source USB device to be added. + Mandatory. + + + + + + --backend <backend>: + Specifies the USB proxy service backend to use. Mandatory. + + + + + + --address <address>: + Specifies the backend specific address. Mandatory. + + + + + + + The following command removes a USB device. + + +VBoxManage usbdevsource remove <source name> + + + + Where the command line options are as follows: + + + + + + + <source name>: + Specifies the ID of the source USB device to be removed. + Mandatory. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/manual/en_US/user_VirtualBoxAPI.xml b/doc/manual/en_US/user_VirtualBoxAPI.xml new file mode 100644 index 00000000..d34e58e6 --- /dev/null +++ b/doc/manual/en_US/user_VirtualBoxAPI.xml @@ -0,0 +1,37 @@ + + +%all.entities; +]> + + + &product-name; Programming Interfaces + + + &product-name; comes with comprehensive support for third-party + developers. The so-called Main API of + &product-name; exposes the entire feature set of the virtualization + engine. It is completely documented and available to anyone who + wishes to control &product-name; programmatically. + + + + The Main API is made available to C++ clients through COM on Windows + hosts or XPCOM on other hosts. Bridges also exist for SOAP, Java and + Python. + + + + All programming information such as documentation, reference + information, header and other interface files, as well as samples + have been split out to a separate Software + Development Kit (SDK). The SDK is available for download + from + . + In particular, the SDK comes with a Programming Guide and Reference + manual in PDF format. This manual contains, among other things, the + information that was previously in this chapter of the User Manual. + + + -- cgit v1.2.3