docs/drvvbox.html.in

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html>
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4     <body>
   5         <h1>VirtualBox hypervisor driver</h1>
   6         <p>
   7         The libvirt VirtualBox driver can manage any VirtualBox version
   8         from version 4.0 onwards
   9         (<span class="since">since libvirt 3.0.0</span>).
  10     </p>
  11
  12     <h2><a id="project">Project Links</a></h2>
  13
  14     <ul>
  15       <li>
  16         The <a href="http://www.virtualbox.org/">VirtualBox</a>
  17         hypervisor
  18       </li>
  19     </ul>
  20
  21     <h2>Connections to VirtualBox driver</h2>
  22
  23     <p>
  24     The libvirt VirtualBox driver provides per-user drivers (the "session" instance).
  25     The uri of the driver protocol is "vbox". Some example connection URIs for the driver are:
  26     </p>
  27
  28 <pre>
  29 vbox:///session                      (local access to per-user instance)
  30 vbox+unix:///session                 (local access to per-user instance)
  31 vbox+tcp://user@example.com/session  (remote access, SASl/Kerberos)
  32 vbox+ssh://user@example.com/session  (remote access, SSH tunnelled)
  33 </pre>
  34
  35     <p>
  36       <strong>NOTE: as of libvirt 1.0.6, the VirtualBox driver will always
  37         run inside the libvirtd daemon, instead of being built-in to the
  38         libvirt.so library directly. This change was required due to the
  39         fact that VirtualBox code is LGPLv2-only licensed, which is not
  40         compatible with the libvirt.so license of LGPLv2-or-later. The
  41         daemon will be auto-started when the first connection to VirtualBox
  42         is requested. This change also means that it will not be possible
  43         to use VirtualBox URIs on the Windows platform, until additional
  44         work is completed to get the libvirtd daemon working there.</strong>
  45     </p>
  46
  47     <h2><a id="xmlconfig">Example domain XML config</a></h2>
  48
  49 <pre>
  50 &lt;domain type='vbox'&gt;
  51   &lt;name&gt;vbox&lt;/name&gt;
  52   &lt;uuid&gt;4dab22b31d52d8f32516782e98ab3fa0&lt;/uuid&gt;
  53
  54   &lt;os&gt;
  55     &lt;type&gt;hvm&lt;/type&gt;
  56     &lt;boot dev='cdrom'/&gt;
  57     &lt;boot dev='hd'/&gt;
  58     &lt;boot dev='fd'/&gt;
  59     &lt;boot dev='network'/&gt;
  60   &lt;/os&gt;
  61
  62   &lt;memory&gt;654321&lt;/memory&gt;
  63   &lt;vcpu&gt;1&lt;/vcpu&gt;
  64
  65   &lt;features&gt;
  66     &lt;pae/&gt;
  67     &lt;acpi/&gt;
  68     &lt;apic/&gt;
  69   &lt;/features&gt;
  70
  71   &lt;devices&gt;
  72     &lt;!--Set IDE controller model to PIIX4 (default PIIX3)--&gt;
  73     &lt;controller type='ide' model='piix4'/&gt;
  74
  75     &lt;controller type='scsi' index='0'/&gt;
  76
  77     &lt;!--VirtualBox SAS Controller--&gt;
  78     &lt;controller type='scsi' index='1' model='lsisas1068'/&gt;
  79
  80     &lt;disk type='file' device='cdrom'&gt;
  81       &lt;source file='/home/user/Downloads/slax-6.0.9.iso'/&gt;
  82       &lt;target dev='hdc'/&gt;
  83       &lt;readonly/&gt;
  84     &lt;/disk&gt;
  85
  86     &lt;disk type='file' device='disk'&gt;
  87       &lt;source file='/home/user/tmp/vbox.vdi'/&gt;
  88       &lt;target dev='hdd'/&gt;
  89     &lt;/disk&gt;
  90
  91     &lt;!--Attach to the SCSI controller (index=0, default)--&gt;
  92     &lt;disk type='file' device='disk'&gt;
  93       &lt;source file='/home/user/tmp/vbox2.vdi'/&gt;
  94       &lt;target dev='sda' bus='scsi'/&gt;
  95     &lt;/disk&gt;
  96
  97     &lt;!--Attach to the SAS controller (index=1)--&gt;
  98     &lt;disk type='file' device='disk'&gt;
  99       &lt;source file='/home/user/tmp/vbox3.vdi'/&gt;
 100       &lt;target dev='sda' bus='scsi'/&gt;
 101       &lt;address type='drive' controller='1' bus='0' target='0' unit='0'/&gt;
 102     &lt;/disk&gt;
 103
 104     &lt;disk type='file' device='floppy'&gt;
 105       &lt;source file='/home/user/tmp/WIN98C.IMG'/&gt;
 106       &lt;target dev='fda'/&gt;
 107     &lt;/disk&gt;
 108
 109     &lt;filesystem type='mount'&gt;
 110       &lt;source dir='/home/user/stuff'/&gt;
 111       &lt;target dir='my-shared-folder'/&gt;
 112     &lt;/filesystem&gt;
 113
 114     &lt;!--BRIDGE--&gt;
 115     &lt;interface type='bridge'&gt;
 116       &lt;source bridge='eth0'/&gt;
 117       &lt;mac address='00:16:3e:5d:c7:9e'/&gt;
 118       &lt;model type='am79c973'/&gt;
 119     &lt;/interface&gt;
 120
 121     &lt;!--NAT--&gt;
 122     &lt;interface type='user'&gt;
 123       &lt;mac address='56:16:3e:5d:c7:9e'/&gt;
 124       &lt;model type='82540eM'/&gt;
 125     &lt;/interface&gt;
 126
 127     &lt;graphics type='desktop'/&gt;
 128
 129     &lt;!--Activate the VRDE server with a port in 3389-3689 range--&gt;
 130     &lt;graphics type='rdp' autoport='yes' multiUser='yes'/&gt;
 131
 132     &lt;sound model='sb16'/&gt;
 133
 134     &lt;parallel type='dev'&gt;
 135       &lt;source path='/dev/pts/1'/&gt;
 136       &lt;target port='0'/&gt;
 137     &lt;/parallel&gt;
 138
 139     &lt;parallel type='dev'&gt;
 140       &lt;source path='/dev/pts/2'/&gt;
 141       &lt;target port='1'/&gt;
 142     &lt;/parallel&gt;
 143
 144     &lt;serial type="dev"&gt;
 145       &lt;source path="/dev/ttyS0"/&gt;
 146       &lt;target port="0"/&gt;
 147     &lt;/serial&gt;
 148
 149     &lt;serial type="pipe"&gt;
 150       &lt;source path="/tmp/serial.txt"/&gt;
 151       &lt;target port="1"/&gt;
 152     &lt;/serial&gt;
 153
 154     &lt;hostdev mode='subsystem' type='usb'&gt;
 155       &lt;source&gt;
 156         &lt;vendor id='0x1234'/&gt;
 157         &lt;product id='0xbeef'/&gt;
 158       &lt;/source&gt;
 159     &lt;/hostdev&gt;
 160
 161     &lt;hostdev mode='subsystem' type='usb'&gt;
 162       &lt;source&gt;
 163         &lt;vendor id='0x4321'/&gt;
 164         &lt;product id='0xfeeb'/&gt;
 165       &lt;/source&gt;
 166     &lt;/hostdev&gt;
 167   &lt;/devices&gt;
 168 &lt;/domain&gt;
 169 </pre>
 170
 171     </body>
 172 </html>