Codebase list libvirt / upstream/4.7.0 docs / drvvbox.html
upstream/4.7.0

Tree @upstream/4.7.0 (Download .tar.gz)

drvvbox.html @upstream/4.7.0raw · history · blame

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
  <!--
        This file is autogenerated from drvvbox.html.in
        Do not edit this file. Changes will be lost.
      -->
  <!--
        This page was generated at Tue Aug 28 09:04:25 UTC 2018.
      -->
  <head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>
    <link rel="stylesheet" type="text/css" href="main.css"/>
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/>
    <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
    <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
    <link rel="manifest" href="/manifest.json"/>
    <meta name="theme-color" content="#ffffff"/>
    <title>libvirt: VirtualBox hypervisor driver</title>
    <meta name="description" content="libvirt, virtualization, virtualization API"/>
    <script type="text/javascript">
      <!--
          
      function init() {
          window.addEventListener('scroll', function(e){
              var distanceY = window.pageYOffset || document.documentElement.scrollTop,
              shrinkOn = 94
              home = document.getElementById("home");
              links = document.getElementById("jumplinks");
              search = document.getElementById("search");
              body = document.getElementById("body");
              if (distanceY > shrinkOn) {
                  if (home.className != "navhide") {
                      body.className = "navhide"
                      home.className = "navhide"
                      links.className = "navhide"
                      search.className = "navhide"
                  }
              } else {
                  if (home.className == "navhide") {
                      body.className = ""
                      home.className = ""
                      links.className = ""
                      search.className = ""
                  }
              }
          });
      }
      window.onload = init();
           
          -->
    </script>
  </head>
  <body>
    <div id="body">
      <div id="content">
        <h1>VirtualBox hypervisor driver</h1>
        <p>
        The libvirt VirtualBox driver can manage any VirtualBox version
        from version 4.0 onwards
        (<span class="since">since libvirt 3.0.0</span>).
    </p>
        <h2>
          <a id="project">Project Links</a>
          <a class="headerlink" href="#project" title="Permalink to this headline"></a>
        </h2>
        <ul>
          <li>
        The <a href="http://www.virtualbox.org/">VirtualBox</a>
        hypervisor
      </li>
        </ul>
        <h2>Connections to VirtualBox driver</h2>
        <p>
    The libvirt VirtualBox driver provides per-user drivers (the "session" instance).
    The uri of the driver protocol is "vbox". Some example connection URIs for the driver are:
    </p>
        <pre>
vbox:///session                      (local access to per-user instance)
vbox+unix:///session                 (local access to per-user instance)
vbox+tcp://user@example.com/session  (remote access, SASl/Kerberos)
vbox+ssh://user@example.com/session  (remote access, SSH tunnelled)
</pre>
        <p>
          <strong>NOTE: as of libvirt 1.0.6, the VirtualBox driver will always
        run inside the libvirtd daemon, instead of being built-in to the
        libvirt.so library directly. This change was required due to the
        fact that VirtualBox code is LGPLv2-only licensed, which is not
        compatible with the libvirt.so license of LGPLv2-or-later. The
        daemon will be auto-started when the first connection to VirtualBox
        is requested. This change also means that it will not be possible
        to use VirtualBox URIs on the Windows platform, until additional
        work is completed to get the libvirtd daemon working there.</strong>
        </p>
        <h2>
          <a id="xmlconfig">Example domain XML config</a>
          <a class="headerlink" href="#xmlconfig" title="Permalink to this headline"></a>
        </h2>
        <pre>
&lt;domain type='vbox'&gt;
  &lt;name&gt;vbox&lt;/name&gt;
  &lt;uuid&gt;4dab22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;

  &lt;os&gt;
    &lt;type&gt;hvm&lt;/type&gt;
    &lt;boot dev='cdrom'/&gt;
    &lt;boot dev='hd'/&gt;
    &lt;boot dev='fd'/&gt;
    &lt;boot dev='network'/&gt;
  &lt;/os&gt;

  &lt;memory&gt;654321&lt;/memory&gt;
  &lt;vcpu&gt;1&lt;/vcpu&gt;

  &lt;features&gt;
    &lt;pae/&gt;
    &lt;acpi/&gt;
    &lt;apic/&gt;
  &lt;/features&gt;

  &lt;devices&gt;
    &lt;!--Set IDE controller model to PIIX4 (default PIIX3)--&gt;
    &lt;controller type='ide' model='piix4'/&gt;

    &lt;controller type='scsi' index='0'/&gt;

    &lt;!--VirtualBox SAS Controller--&gt;
    &lt;controller type='scsi' index='1' model='lsisas1068'/&gt;

    &lt;disk type='file' device='cdrom'&gt;
      &lt;source file='/home/user/Downloads/slax-6.0.9.iso'/&gt;
      &lt;target dev='hdc'/&gt;
      &lt;readonly/&gt;
    &lt;/disk&gt;

    &lt;disk type='file' device='disk'&gt;
      &lt;source file='/home/user/tmp/vbox.vdi'/&gt;
      &lt;target dev='hdd'/&gt;
    &lt;/disk&gt;

    &lt;!--Attach to the SCSI controller (index=0, default)--&gt;
    &lt;disk type='file' device='disk'&gt;
      &lt;source file='/home/user/tmp/vbox2.vdi'/&gt;
      &lt;target dev='sda' bus='scsi'/&gt;
    &lt;/disk&gt;

    &lt;!--Attach to the SAS controller (index=1)--&gt;
    &lt;disk type='file' device='disk'&gt;
      &lt;source file='/home/user/tmp/vbox3.vdi'/&gt;
      &lt;target dev='sda' bus='scsi'/&gt;
      &lt;address type='drive' controller='1' bus='0' target='0' unit='0'/&gt;
    &lt;/disk&gt;

    &lt;disk type='file' device='floppy'&gt;
      &lt;source file='/home/user/tmp/WIN98C.IMG'/&gt;
      &lt;target dev='fda'/&gt;
    &lt;/disk&gt;

    &lt;filesystem type='mount'&gt;
      &lt;source dir='/home/user/stuff'/&gt;
      &lt;target dir='my-shared-folder'/&gt;
    &lt;/filesystem&gt;

    &lt;!--BRIDGE--&gt;
    &lt;interface type='bridge'&gt;
      &lt;source bridge='eth0'/&gt;
      &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
      &lt;model type='am79c973'/&gt;
    &lt;/interface&gt;

    &lt;!--NAT--&gt;
    &lt;interface type='user'&gt;
      &lt;mac address='56:16:3e:5d:c7:9e'/&gt;
      &lt;model type='82540eM'/&gt;
    &lt;/interface&gt;

    &lt;graphics type='desktop'/&gt;

    &lt;!--Activate the VRDE server with a port in 3389-3689 range--&gt;
    &lt;graphics type='rdp' autoport='yes' multiUser='yes'/&gt;

    &lt;sound model='sb16'/&gt;

    &lt;parallel type='dev'&gt;
      &lt;source path='/dev/pts/1'/&gt;
      &lt;target port='0'/&gt;
    &lt;/parallel&gt;

    &lt;parallel type='dev'&gt;
      &lt;source path='/dev/pts/2'/&gt;
      &lt;target port='1'/&gt;
    &lt;/parallel&gt;

    &lt;serial type="dev"&gt;
      &lt;source path="/dev/ttyS0"/&gt;
      &lt;target port="0"/&gt;
    &lt;/serial&gt;

    &lt;serial type="pipe"&gt;
      &lt;source path="/tmp/serial.txt"/&gt;
      &lt;target port="1"/&gt;
    &lt;/serial&gt;

    &lt;hostdev mode='subsystem' type='usb'&gt;
      &lt;source&gt;
        &lt;vendor id='0x1234'/&gt;
        &lt;product id='0xbeef'/&gt;
      &lt;/source&gt;
    &lt;/hostdev&gt;

    &lt;hostdev mode='subsystem' type='usb'&gt;
      &lt;source&gt;
        &lt;vendor id='0x4321'/&gt;
        &lt;product id='0xfeeb'/&gt;
      &lt;/source&gt;
    &lt;/hostdev&gt;
  &lt;/devices&gt;
&lt;/domain&gt;
</pre>
      </div>
    </div>
    <div id="nav">
      <div id="home">
        <a href="index.html">Home</a>
      </div>
      <div id="jumplinks">
        <ul>
          <li>
            <a href="downloads.html">Download</a>
          </li>
          <li>
            <a href="contribute.html">Contribute</a>
          </li>
          <li>
            <a href="docs.html">Docs</a>
          </li>
        </ul>
      </div>
      <div id="search">
        <form action="search.php" enctype="application/x-www-form-urlencoded" method="get">
          <div>
            <input name="query" type="text" size="12" value=""/>
            <input name="submit" type="submit" value="Go"/>
          </div>
        </form>
      </div>
    </div>
    <div id="footer">
      <div id="contact">
        <h3>Contact</h3>
        <ul>
          <li>
            <a href="contact.html#email">email</a>
          </li>
          <li>
            <a href="contact.html#irc">irc</a>
          </li>
        </ul>
      </div>
      <div id="community">
        <h3>Community</h3>
        <ul>
          <li>
            <a href="https://twitter.com/hashtag/libvirt">twitter</a>
          </li>
          <li>
            <a href="https://plus.google.com/communities/109522598353007505282">google+</a>
          </li>
          <li>
            <a href="http://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a>
          </li>
          <li>
            <a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a>
          </li>
        </ul>
      </div>
      <div id="conduct">
            Participants in the libvirt project agree to abide by <a href="governance.html#codeofconduct">the project code of conduct</a></div>
      <br class="clear"/>
    </div>
  </body>
</html>