docs/drvvbox.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <!--
   5         This file is autogenerated from drvvbox.html.in
   6         Do not edit this file. Changes will be lost.
   7       -->
   8   <head>
   9     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  10     <link rel="stylesheet" type="text/css" href="main.css" />
  11     <link rel="SHORTCUT ICON" href="32favicon.png" />
  12     <title>libvirt: VirtualBox hypervisor driver</title>
  13     <meta name="description" content="libvirt, virtualization, virtualization API" />
  14   </head>
  15   <body>
  16     <div id="header">
  17       <div id="headerLogo"></div>
  18       <div id="headerSearch">
  19         <form action="search.php" enctype="application/x-www-form-urlencoded" method="get"><div>
  20             <input id="query" name="query" type="text" size="12" value="" />
  21             <input id="submit" name="submit" type="submit" value="Search" />
  22           </div></form>
  23       </div>
  24     </div>
  25     <div id="body">
  26       <div id="menu">
  27         <ul class="l0"><li>
  28             <div>
  29               <a title="Front page of the libvirt website" class="inactive" href="index.html">Home</a>
  30             </div>
  31           </li><li>
  32             <div>
  33               <a title="Details of new features and bugs fixed in each release" class="inactive" href="news.html">News</a>
  34             </div>
  35           </li><li>
  36             <div>
  37               <a title="Applications known to use libvirt" class="inactive" href="apps.html">Applications</a>
  38             </div>
  39           </li><li>
  40             <div>
  41               <a title="Get the latest source releases, binary builds and get access to the source repository" class="inactive" href="downloads.html">Downloads</a>
  42             </div>
  43           </li><li>
  44             <div>
  45               <a title="Information for users, administrators and developers" class="active" href="docs.html">Documentation</a>
  46               <ul class="l1"><li>
  47                   <div>
  48                     <a title="How to compile libvirt" class="inactive" href="compiling.html">Compiling</a>
  49                   </div>
  50                 </li><li>
  51                   <div>
  52                     <a title="Information about deploying and using libvirt" class="inactive" href="deployment.html">Deployment</a>
  53                   </div>
  54                 </li><li>
  55                   <div>
  56                     <a title="Overview of the logical subsystems in the libvirt API" class="inactive" href="intro.html">Architecture</a>
  57                   </div>
  58                 </li><li>
  59                   <div>
  60                     <a title="Description of the XML formats used in libvirt" class="inactive" href="format.html">XML format</a>
  61                   </div>
  62                 </li><li>
  63                   <div>
  64                     <a title="Hypervisor specific driver information" class="active" href="drivers.html">Drivers</a>
  65                     <ul class="l2"><li>
  66                         <div>
  67                           <a title="Driver the Xen hypervisor" class="inactive" href="drvxen.html">Xen</a>
  68                         </div>
  69                       </li><li>
  70                         <div>
  71                           <a title="Driver for QEMU, KQEMU, KVM and Xenner" class="inactive" href="drvqemu.html">QEMU / KVM</a>
  72                         </div>
  73                       </li><li>
  74                         <div>
  75                           <a title="Driver for the Linux native container API" class="inactive" href="drvlxc.html">Linux Container</a>
  76                         </div>
  77                       </li><li>
  78                         <div>
  79                           <a title="Pseudo-driver simulating APIs in memory for test suites" class="inactive" href="drvtest.html">Test</a>
  80                         </div>
  81                       </li><li>
  82                         <div>
  83                           <a title="Driver providing secure remote to the libvirt APIs" class="inactive" href="drvremote.html">Remote</a>
  84                         </div>
  85                       </li><li>
  86                         <div>
  87                           <a title="Driver for the OpenVZ container technology" class="inactive" href="drvopenvz.html">OpenVZ</a>
  88                         </div>
  89                       </li><li>
  90                         <div>
  91                           <a title="Driver for the User Mode Linux technology" class="inactive" href="drvuml.html">UML</a>
  92                         </div>
  93                       </li><li>
  94                         <div>
  95                           <a title="Driver for the storage management APIs" class="inactive" href="storage.html">Storage</a>
  96                         </div>
  97                       </li><li>
  98                         <div>
  99                           <span class="active">VirtualBox</span>
 100                         </div>
 101                       </li><li>
 102                         <div>
 103                           <a title="Driver for VMware ESX" class="inactive" href="drvesx.html">VMware ESX</a>
 104                         </div>
 105                       </li><li>
 106                         <div>
 107                           <a title="Driver for VMware Workstation / Player" class="inactive" href="drvvmware.html">VMware Workstation / Player</a>
 108                         </div>
 109                       </li><li>
 110                         <div>
 111                           <a title="Driver for Microsoft Hyper-V" class="inactive" href="drvhyperv.html">Microsoft Hyper-V</a>
 112                         </div>
 113                       </li><li>
 114                         <div>
 115                           <a title="Driver for IBM PowerVM" class="inactive" href="drvphyp.html">IBM PowerVM</a>
 116                         </div>
 117                       </li><li>
 118                         <div>
 119                           <a title="Driver for Parallels Cloud Server" class="inactive" href="drvparallels.html">Parallels</a>
 120                         </div>
 121                       </li><li>
 122                         <div>
 123                           <a title="Driver for bhyve" class="inactive" href="drvbhyve.html">Bhyve</a>
 124                         </div>
 125                       </li></ul>
 126                   </div>
 127                 </li><li>
 128                   <div>
 129                     <a title="Reference manual for the C public API" class="inactive" href="html/index.html">API reference</a>
 130                   </div>
 131                 </li><li>
 132                   <div>
 133                     <a title="Bindings of the libvirt API for other languages" class="inactive" href="bindings.html">Language bindings</a>
 134                   </div>
 135                 </li><li>
 136                   <div>
 137                     <a title="Working on the internals of libvirt API, driver and daemon code" class="inactive" href="internals.html">Internals</a>
 138                   </div>
 139                 </li><li>
 140                   <div>
 141                     <a title="A guide and reference for developing with libvirt" class="inactive" href="devguide.html">Development Guide</a>
 142                   </div>
 143                 </li><li>
 144                   <div>
 145                     <a title="Command reference for virsh" class="inactive" href="virshcmdref.html">Virsh Commands</a>
 146                   </div>
 147                 </li><li>
 148                   <div>
 149                     <a title="Project governance and code of conduct" class="inactive" href="governance.html">Governance</a>
 150                   </div>
 151                 </li></ul>
 152             </div>
 153           </li><li>
 154             <div>
 155               <a title="User contributed content" class="inactive" href="http://wiki.libvirt.org">Wiki</a>
 156             </div>
 157           </li><li>
 158             <div>
 159               <a title="Frequently asked questions" class="inactive" href="http://wiki.libvirt.org/page/FAQ">FAQ</a>
 160             </div>
 161           </li><li>
 162             <div>
 163               <a title="How and where to report bugs and request features" class="inactive" href="bugs.html">Bug reports</a>
 164             </div>
 165           </li><li>
 166             <div>
 167               <a title="How to contact the developers via email and IRC" class="inactive" href="contact.html">Contact</a>
 168             </div>
 169           </li><li>
 170             <div>
 171               <a title="Available test suites for libvirt" class="inactive" href="testsuites.html">Test suites</a>
 172             </div>
 173           </li><li>
 174             <div>
 175               <a title="Miscellaneous links of interest related to libvirt" class="inactive" href="relatedlinks.html">Related Links</a>
 176             </div>
 177           </li><li>
 178             <div>
 179               <a title="Overview of all content on the website" class="inactive" href="sitemap.html">Sitemap</a>
 180             </div>
 181           </li></ul>
 182       </div>
 183       <div id="content">
 184         <h1>VirtualBox hypervisor driver</h1>
 185         <p>
 186         The libvirt VirtualBox driver can manage any VirtualBox version
 187         from version 2.2 onwards.
 188     </p>
 189         <h2>
 190           <a name="project" shape="rect" id="project">Project Links</a>
 191           <a class="headerlink" href="#project" title="Permalink to this headline">¶</a>
 192         </h2>
 193         <ul><li>
 194         The <a href="http://www.virtualbox.org/" shape="rect">VirtualBox</a>
 195         hypervisor
 196       </li></ul>
 197         <h2>Connections to VirtualBox driver</h2>
 198         <p>
 199     The libvirt VirtualBox driver provides per-user drivers (the "session" instance).
 200     The uri of the driver protocol is "vbox". Some example connection URIs for the driver are:
 201     </p>
 202         <pre xml:space="preserve">
 203 vbox:///session                      (local access to per-user instance)
 204 vbox+unix:///session                 (local access to per-user instance)
 205 vbox+tcp://user@example.com/session  (remote access, SASl/Kerberos)
 206 vbox+ssh://user@example.com/session  (remote access, SSH tunnelled)
 207 </pre>
 208         <p>
 209       <strong>NOTE: as of libvirt 1.0.6, the VirtualBox driver will always
 210         run inside the libvirtd daemon, instead of being built-in to the
 211         libvirt.so library directly. This change was required due to the
 212         fact that VirtualBox code is LGPLv2-only licensed, which is not
 213         compatible with the libvirt.so license of LGPLv2-or-later. The
 214         daemon will be auto-started when the first connection to VirtualBox
 215         is requested. This change also means that it will not be possible
 216         to use VirtualBox URIs on the Windows platform, until additional
 217         work is completed to get the libvirtd daemon working there.</strong>
 218     </p>
 219         <h2>
 220           <a name="xmlconfig" shape="rect" id="xmlconfig">Example domain XML config</a>
 221           <a class="headerlink" href="#xmlconfig" title="Permalink to this headline">¶</a>
 222         </h2>
 223         <pre xml:space="preserve">
 224 &lt;domain type='vbox'&gt;
 225   &lt;name&gt;vbox&lt;/name&gt;
 226   &lt;uuid&gt;4dab22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
 227
 228   &lt;os&gt;
 229     &lt;type&gt;hvm&lt;/type&gt;
 230     &lt;boot dev='cdrom'/&gt;
 231     &lt;boot dev='hd'/&gt;
 232     &lt;boot dev='fd'/&gt;
 233     &lt;boot dev='network'/&gt;
 234   &lt;/os&gt;
 235
 236   &lt;memory&gt;654321&lt;/memory&gt;
 237   &lt;vcpu&gt;1&lt;/vcpu&gt;
 238
 239   &lt;features&gt;
 240     &lt;pae/&gt;
 241     &lt;acpi/&gt;
 242     &lt;apic/&gt;
 243   &lt;/features&gt;
 244
 245   &lt;devices&gt;
 246     &lt;disk type='file' device='cdrom'&gt;
 247       &lt;source file='/home/user/Downloads/slax-6.0.9.iso'/&gt;
 248       &lt;target dev='hdc'/&gt;
 249       &lt;readonly/&gt;
 250     &lt;/disk&gt;
 251
 252     &lt;disk type='file' device='disk'&gt;
 253       &lt;source file='/home/user/tmp/vbox.vdi'/&gt;
 254       &lt;target dev='hdd'/&gt;
 255     &lt;/disk&gt;
 256
 257     &lt;disk type='file' device='floppy'&gt;
 258       &lt;source file='/home/user/tmp/WIN98C.IMG'/&gt;
 259       &lt;target dev='fda'/&gt;
 260     &lt;/disk&gt;
 261
 262     &lt;filesystem type='mount'&gt;
 263       &lt;source dir='/home/user/stuff'/&gt;
 264       &lt;target dir='my-shared-folder'/&gt;
 265     &lt;/filesystem&gt;
 266
 267     &lt;!--BRIDGE--&gt;
 268     &lt;interface type='bridge'&gt;
 269       &lt;source bridge='eth0'/&gt;
 270       &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
 271       &lt;model type='am79c973'/&gt;
 272     &lt;/interface&gt;
 273
 274     &lt;!--NAT--&gt;
 275     &lt;interface type='user'&gt;
 276       &lt;mac address='56:16:3e:5d:c7:9e'/&gt;
 277       &lt;model type='82540eM'/&gt;
 278     &lt;/interface&gt;
 279
 280     &lt;sound model='sb16'/&gt;
 281
 282     &lt;parallel type='dev'&gt;
 283       &lt;source path='/dev/pts/1'/&gt;
 284       &lt;target port='0'/&gt;
 285     &lt;/parallel&gt;
 286
 287     &lt;parallel type='dev'&gt;
 288       &lt;source path='/dev/pts/2'/&gt;
 289       &lt;target port='1'/&gt;
 290     &lt;/parallel&gt;
 291
 292     &lt;serial type="dev"&gt;
 293       &lt;source path="/dev/ttyS0"/&gt;
 294       &lt;target port="0"/&gt;
 295     &lt;/serial&gt;
 296
 297     &lt;serial type="pipe"&gt;
 298       &lt;source path="/tmp/serial.txt"/&gt;
 299       &lt;target port="1"/&gt;
 300     &lt;/serial&gt;
 301
 302     &lt;hostdev mode='subsystem' type='usb'&gt;
 303       &lt;source&gt;
 304         &lt;vendor id='0x1234'/&gt;
 305         &lt;product id='0xbeef'/&gt;
 306       &lt;/source&gt;
 307     &lt;/hostdev&gt;
 308
 309     &lt;hostdev mode='subsystem' type='usb'&gt;
 310       &lt;source&gt;
 311         &lt;vendor id='0x4321'/&gt;
 312         &lt;product id='0xfeeb'/&gt;
 313       &lt;/source&gt;
 314     &lt;/hostdev&gt;
 315   &lt;/devices&gt;
 316 &lt;/domain&gt;
 317 </pre>
 318       </div>
 319     </div>
 320     <div id="footer">
 321       <p id="sponsor">
 322             Sponsored by:<br /><a href="http://et.redhat.com/"><img src="et.png" alt="Project sponsored by Red Hat Emerging Technology" /></a></p>
 323     </div>
 324   </body>
 325 </html>