mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-12-22 13:45:38 +00:00
docs: Convert 'drvvbox' page to rST
Signed-off-by: Peter Krempa <pkrempa@redhat.com> Reviewed-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Peter Krempa
parent
ada572f045
commit
96a0436afb
@ -1,172 +0,0 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<body>
|
||||
<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></h2>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
The <a href="https://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></h2>
|
||||
|
||||
<pre>
|
||||
<domain type='vbox'>
|
||||
<name>vbox</name>
|
||||
<uuid>4dab22b31d52d8f32516782e98ab3fa0</uuid>
|
||||
|
||||
<os>
|
||||
<type>hvm</type>
|
||||
<boot dev='cdrom'/>
|
||||
<boot dev='hd'/>
|
||||
<boot dev='fd'/>
|
||||
<boot dev='network'/>
|
||||
</os>
|
||||
|
||||
<memory>654321</memory>
|
||||
<vcpu>1</vcpu>
|
||||
|
||||
<features>
|
||||
<pae/>
|
||||
<acpi/>
|
||||
<apic/>
|
||||
</features>
|
||||
|
||||
<devices>
|
||||
<!--Set IDE controller model to PIIX4 (default PIIX3)-->
|
||||
<controller type='ide' model='piix4'/>
|
||||
|
||||
<controller type='scsi' index='0'/>
|
||||
|
||||
<!--VirtualBox SAS Controller-->
|
||||
<controller type='scsi' index='1' model='lsisas1068'/>
|
||||
|
||||
<disk type='file' device='cdrom'>
|
||||
<source file='/home/user/Downloads/slax-6.0.9.iso'/>
|
||||
<target dev='hdc'/>
|
||||
<readonly/>
|
||||
</disk>
|
||||
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox.vdi'/>
|
||||
<target dev='hdd'/>
|
||||
</disk>
|
||||
|
||||
<!--Attach to the SCSI controller (index=0, default)-->
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox2.vdi'/>
|
||||
<target dev='sda' bus='scsi'/>
|
||||
</disk>
|
||||
|
||||
<!--Attach to the SAS controller (index=1)-->
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox3.vdi'/>
|
||||
<target dev='sda' bus='scsi'/>
|
||||
<address type='drive' controller='1' bus='0' target='0' unit='0'/>
|
||||
</disk>
|
||||
|
||||
<disk type='file' device='floppy'>
|
||||
<source file='/home/user/tmp/WIN98C.IMG'/>
|
||||
<target dev='fda'/>
|
||||
</disk>
|
||||
|
||||
<filesystem type='mount'>
|
||||
<source dir='/home/user/stuff'/>
|
||||
<target dir='my-shared-folder'/>
|
||||
</filesystem>
|
||||
|
||||
<!--BRIDGE-->
|
||||
<interface type='bridge'>
|
||||
<source bridge='eth0'/>
|
||||
<mac address='00:16:3e:5d:c7:9e'/>
|
||||
<model type='am79c973'/>
|
||||
</interface>
|
||||
|
||||
<!--NAT-->
|
||||
<interface type='user'>
|
||||
<mac address='56:16:3e:5d:c7:9e'/>
|
||||
<model type='82540eM'/>
|
||||
</interface>
|
||||
|
||||
<graphics type='desktop'/>
|
||||
|
||||
<!--Activate the VRDE server with a port in 3389-3689 range-->
|
||||
<graphics type='rdp' autoport='yes' multiUser='yes'/>
|
||||
|
||||
<sound model='sb16'/>
|
||||
|
||||
<parallel type='dev'>
|
||||
<source path='/dev/pts/1'/>
|
||||
<target port='0'/>
|
||||
</parallel>
|
||||
|
||||
<parallel type='dev'>
|
||||
<source path='/dev/pts/2'/>
|
||||
<target port='1'/>
|
||||
</parallel>
|
||||
|
||||
<serial type="dev">
|
||||
<source path="/dev/ttyS0"/>
|
||||
<target port="0"/>
|
||||
</serial>
|
||||
|
||||
<serial type="pipe">
|
||||
<source path="/tmp/serial.txt"/>
|
||||
<target port="1"/>
|
||||
</serial>
|
||||
|
||||
<hostdev mode='subsystem' type='usb'>
|
||||
<source>
|
||||
<vendor id='0x1234'/>
|
||||
<product id='0xbeef'/>
|
||||
</source>
|
||||
</hostdev>
|
||||
|
||||
<hostdev mode='subsystem' type='usb'>
|
||||
<source>
|
||||
<vendor id='0x4321'/>
|
||||
<product id='0xfeeb'/>
|
||||
</source>
|
||||
</hostdev>
|
||||
</devices>
|
||||
</domain>
|
||||
</pre>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
161
docs/drvvbox.rst
Normal file
161
docs/drvvbox.rst
Normal file
@ -0,0 +1,161 @@
|
||||
.. role:: since
|
||||
|
||||
============================
|
||||
VirtualBox hypervisor driver
|
||||
============================
|
||||
|
||||
The libvirt VirtualBox driver can manage any VirtualBox version from version 4.0
|
||||
onwards ( :since:`since libvirt 3.0.0` ).
|
||||
|
||||
Project Links
|
||||
-------------
|
||||
|
||||
- The `VirtualBox <https://www.virtualbox.org/>`__ hypervisor
|
||||
|
||||
Connections to VirtualBox driver
|
||||
--------------------------------
|
||||
|
||||
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:
|
||||
|
||||
::
|
||||
|
||||
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)
|
||||
|
||||
**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.**
|
||||
|
||||
Example domain XML config
|
||||
-------------------------
|
||||
|
||||
::
|
||||
|
||||
<domain type='vbox'>
|
||||
<name>vbox</name>
|
||||
<uuid>4dab22b31d52d8f32516782e98ab3fa0</uuid>
|
||||
|
||||
<os>
|
||||
<type>hvm</type>
|
||||
<boot dev='cdrom'/>
|
||||
<boot dev='hd'/>
|
||||
<boot dev='fd'/>
|
||||
<boot dev='network'/>
|
||||
</os>
|
||||
|
||||
<memory>654321</memory>
|
||||
<vcpu>1</vcpu>
|
||||
|
||||
<features>
|
||||
<pae/>
|
||||
<acpi/>
|
||||
<apic/>
|
||||
</features>
|
||||
|
||||
<devices>
|
||||
<!--Set IDE controller model to PIIX4 (default PIIX3)-->
|
||||
<controller type='ide' model='piix4'/>
|
||||
|
||||
<controller type='scsi' index='0'/>
|
||||
|
||||
<!--VirtualBox SAS Controller-->
|
||||
<controller type='scsi' index='1' model='lsisas1068'/>
|
||||
|
||||
<disk type='file' device='cdrom'>
|
||||
<source file='/home/user/Downloads/slax-6.0.9.iso'/>
|
||||
<target dev='hdc'/>
|
||||
<readonly/>
|
||||
</disk>
|
||||
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox.vdi'/>
|
||||
<target dev='hdd'/>
|
||||
</disk>
|
||||
|
||||
<!--Attach to the SCSI controller (index=0, default)-->
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox2.vdi'/>
|
||||
<target dev='sda' bus='scsi'/>
|
||||
</disk>
|
||||
|
||||
<!--Attach to the SAS controller (index=1)-->
|
||||
<disk type='file' device='disk'>
|
||||
<source file='/home/user/tmp/vbox3.vdi'/>
|
||||
<target dev='sda' bus='scsi'/>
|
||||
<address type='drive' controller='1' bus='0' target='0' unit='0'/>
|
||||
</disk>
|
||||
|
||||
<disk type='file' device='floppy'>
|
||||
<source file='/home/user/tmp/WIN98C.IMG'/>
|
||||
<target dev='fda'/>
|
||||
</disk>
|
||||
|
||||
<filesystem type='mount'>
|
||||
<source dir='/home/user/stuff'/>
|
||||
<target dir='my-shared-folder'/>
|
||||
</filesystem>
|
||||
|
||||
<!--BRIDGE-->
|
||||
<interface type='bridge'>
|
||||
<source bridge='eth0'/>
|
||||
<mac address='00:16:3e:5d:c7:9e'/>
|
||||
<model type='am79c973'/>
|
||||
</interface>
|
||||
|
||||
<!--NAT-->
|
||||
<interface type='user'>
|
||||
<mac address='56:16:3e:5d:c7:9e'/>
|
||||
<model type='82540eM'/>
|
||||
</interface>
|
||||
|
||||
<graphics type='desktop'/>
|
||||
|
||||
<!--Activate the VRDE server with a port in 3389-3689 range-->
|
||||
<graphics type='rdp' autoport='yes' multiUser='yes'/>
|
||||
|
||||
<sound model='sb16'/>
|
||||
|
||||
<parallel type='dev'>
|
||||
<source path='/dev/pts/1'/>
|
||||
<target port='0'/>
|
||||
</parallel>
|
||||
|
||||
<parallel type='dev'>
|
||||
<source path='/dev/pts/2'/>
|
||||
<target port='1'/>
|
||||
</parallel>
|
||||
|
||||
<serial type="dev">
|
||||
<source path="/dev/ttyS0"/>
|
||||
<target port="0"/>
|
||||
</serial>
|
||||
|
||||
<serial type="pipe">
|
||||
<source path="/tmp/serial.txt"/>
|
||||
<target port="1"/>
|
||||
</serial>
|
||||
|
||||
<hostdev mode='subsystem' type='usb'>
|
||||
<source>
|
||||
<vendor id='0x1234'/>
|
||||
<product id='0xbeef'/>
|
||||
</source>
|
||||
</hostdev>
|
||||
|
||||
<hostdev mode='subsystem' type='usb'>
|
||||
<source>
|
||||
<vendor id='0x4321'/>
|
||||
<product id='0xfeeb'/>
|
||||
</source>
|
||||
</hostdev>
|
||||
</devices>
|
||||
</domain>
|
||||
@ -22,7 +22,6 @@ docs_html_in_files = [
|
||||
'csharp',
|
||||
'dbus',
|
||||
'docs',
|
||||
'drvvbox',
|
||||
'drvvirtuozzo',
|
||||
'drvvmware',
|
||||
'drvxen',
|
||||
@ -81,6 +80,7 @@ docs_rst_files = [
|
||||
'drvqemu',
|
||||
'drvsecret',
|
||||
'drvtest',
|
||||
'drvvbox',
|
||||
'errors',
|
||||
'formatbackup',
|
||||
'formatcheckpoint',
|
||||
|
||||
Loading…
Reference in New Issue
Block a user