Hi All,
>
> After a couple of last minute tweaks, it's now commited. Adding some
> documentation section would be a good idea, that can still be done in
> time for next week release :-)
Done.
Attaching a patch for the documentation.
Regards,
Pritesh
commit e32a4948a72659ed4f693f8b57c814b4d60c8dda
Author: Pritesh Kothari <Pritesh.Kothari@xxxxxxx>
Date: Tue Apr 21 13:22:20 2009 +0200
libvirt: VirtualBox Documentation
diff --git a/docs/drivers.html.in b/docs/drivers.html.in
index 344a89a..e281258 100644
--- a/docs/drivers.html.in
+++ b/docs/drivers.html.in
@@ -22,6 +22,7 @@
<li><strong><a href="drvlxc.html">LXC</a></strong></li>
<li><strong><a href="drvtest.html">Test</a></strong></li>
<li><strong><a href="drvopenvz.html">OpenVZ</a></strong></li>
+ <li><strong><a href="drvvbox.html">VirtualBox</a></strong></li>
</ul>
</body>
</html>
diff --git a/docs/drvvbox.html.in b/docs/drvvbox.html.in
new file mode 100644
index 0000000..999e5e6
--- /dev/null
+++ b/docs/drvvbox.html.in
@@ -0,0 +1,136 @@
+<html>
+ <body>
+ <h1>VirtualBox hypervisor driver</h1>
+ <p>
+ The libvirt VirtualBox driver can manage any VirtualBox version
+ from version 2.2 onwards.
+ </p>
+
+ <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 conection 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@xxxxxxxxxxx/session (remote access, SASl/Kerberos)
+ vbox+ssh://user@xxxxxxxxxxx/session (remote access, SSH tunnelled)
+ </pre>
+
+ <h2><a name="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>
+ <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>
+
+ <disk type='file' device='floppy'>
+ <source file='/home/user/tmp/WIN98C.IMG'/>
+ <target dev='fda'/>
+ </disk>
+
+ <!--INTERNAL NETWORK
+ <interface type='internal'>
+ <source name='int_net'/>
+ <model type='am79c970a'/>
+ </interface> -->
+
+ <!--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>
+
+ <!-- HOST ONLY NETWORK
+ <interface type='hostonly'>
+ <source name='vboxnet0'/>
+ <mac address='78:16:3e:4d:c7:9e'/>
+ <model type='82543gc'/>
+ </interface> -->
+
+ <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>
+
+ <!-- VRDP Support
+ <graphics type='rdp' port='3389' auth='guest' reuseconnection='yes'
+ multiconnections='yes' authtimeout='4999' listen='10.16.203.214'/> -->
+
+ <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>
diff --git a/docs/hvsupport.html.in b/docs/hvsupport.html.in
index 42a1d70..f7ec6b3 100644
--- a/docs/hvsupport.html.in
+++ b/docs/hvsupport.html.in
@@ -21,6 +21,7 @@ updated on <i>2008-06-05</i>.
<th><a href="drvqemu.html">QEMU</a></th>
<th><a href="drvkvm.html">KVM</a></th>
<th><a href="remote.html">Remote</a></th>
+ <th><a href="drvvbox.html">VirtualBox</a></th>
</tr>
<tr>
<td> virConnectClose </td>
@@ -29,6 +30,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectGetCapabilities </td>
@@ -37,6 +39,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.1 </td>
<td> ≥ 0.2.1 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectGetHostname </td>
@@ -45,6 +48,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.3.3 </td>
<td> ≥ 0.3.3 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectGetMaxVcpus </td>
@@ -53,6 +57,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virConnectGetType </td>
@@ -61,6 +66,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectGetURI </td>
@@ -69,6 +75,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.3.0 </td>
<td> ≥ 0.3.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectGetVersion </td>
@@ -77,6 +84,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectListDefinedDomains </td>
@@ -85,6 +93,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectListDomains </td>
@@ -93,6 +102,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectNumOfDefinedDomains </td>
@@ -101,6 +111,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectNumOfDomains </td>
@@ -109,6 +120,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectOpen </td>
@@ -117,6 +129,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virConnectOpenAuth </td>
@@ -125,6 +138,7 @@ updated on <i>2008-06-05</i>.
<td> </td>
<td> </td>
<td> </td>
+ <td> </td>
</tr>
<tr>
<td> virConnectOpenReadOnly </td>
@@ -133,6 +147,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainAttachDevice </td>
@@ -141,6 +156,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainBlockPeek </td>
@@ -149,6 +165,7 @@ updated on <i>2008-06-05</i>.
<td> 0.4.3 </td>
<td> 0.4.3 </td>
<td> x </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainBlockStats </td>
@@ -157,6 +174,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.2 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainCoreDump </td>
@@ -165,6 +183,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainCreate </td>
@@ -173,6 +192,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainCreateLinux </td>
@@ -181,6 +201,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainDefineXML </td>
@@ -189,6 +210,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainDestroy </td>
@@ -197,6 +219,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainDetachDevice </td>
@@ -205,6 +228,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainFree </td>
@@ -213,6 +237,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetAutostart </td>
@@ -221,11 +246,12 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.1 </td>
<td> ≥ 0.2.1 </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainGetConnect </td>
<td> 0.3.0 </td>
- <td colspan="4"> not a HV function </td>
+ <td colspan="5"> not a HV function </td>
</tr>
<tr>
<td> virDomainGetID </td>
@@ -234,6 +260,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetInfo </td>
@@ -242,6 +269,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetMaxMemory </td>
@@ -250,6 +278,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetMaxVcpus </td>
@@ -258,6 +287,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainGetName </td>
@@ -266,6 +296,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetOSType </td>
@@ -274,6 +305,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetSchedulerParameters </td>
@@ -282,6 +314,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainGetSchedulerType </td>
@@ -290,6 +323,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainGetUUID </td>
@@ -298,6 +332,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetUUIDString </td>
@@ -306,6 +341,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainGetVcpus </td>
@@ -314,6 +350,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainInterfaceStats </td>
@@ -322,6 +359,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.2 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainGetXMLDesc </td>
@@ -330,6 +368,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainLookupByID </td>
@@ -338,6 +377,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainLookupByName </td>
@@ -346,6 +386,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainLookupByUUID </td>
@@ -354,6 +395,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainLookupByUUIDString </td>
@@ -362,6 +404,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainMigrate </td>
@@ -370,6 +413,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> 0.3.2 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainPinVcpu </td>
@@ -378,6 +422,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainReboot </td>
@@ -386,6 +431,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainRestore </td>
@@ -394,6 +440,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> ≥ 0.3.2 </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainResume </td>
@@ -402,6 +449,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainSave </td>
@@ -410,6 +458,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> ≥ 0.3.2 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainSetAutostart </td>
@@ -418,6 +467,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.1 </td>
<td> ≥ 0.2.1 </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainSetMaxMemory </td>
@@ -434,6 +484,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainSetSchedulerParameters </td>
@@ -442,6 +493,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainSetVcpus </td>
@@ -450,6 +502,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> ≥ 0.3.0 </td>
+ <td> x </td>
</tr>
<tr>
<td> virDomainShutdown </td>
@@ -458,6 +511,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainSuspend </td>
@@ -466,6 +520,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virDomainUndefine </td>
@@ -474,17 +529,18 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virGetVersion </td>
<td> All </td>
<td> All </td>
- <td colspan="3"> Returns -1 if HV unsupported. </td>
+ <td colspan="4"> Returns -1 if HV unsupported. </td>
</tr>
<tr>
<td> virInitialize </td>
<td> 0.1.0 </td>
- <td colspan="4"> not a HV function </td>
+ <td colspan="5"> not a HV function </td>
</tr>
<tr>
<td> virDomainMemoryPeek </td>
@@ -493,6 +549,7 @@ updated on <i>2008-06-05</i>.
<td> 0.4.3 </td>
<td> 0.4.3 </td>
<td> x </td>
+ <td> x </td>
</tr>
<tr>
<td> virNodeGetInfo </td>
@@ -501,6 +558,7 @@ updated on <i>2008-06-05</i>.
<td> ≥ 0.2.0 </td>
<td> ≥ 0.2.0 </td>
<td> ≥ 0.3.0 </td>
+ <td> ≥ 0.6.3 </td>
</tr>
<tr>
<td> virNodeGetFreeMemory </td>
@@ -509,6 +567,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> x </td>
+ <td> x </td>
</tr>
<tr>
<td> virNodeGetCellsFreeMemory </td>
@@ -517,6 +576,7 @@ updated on <i>2008-06-05</i>.
<td> x </td>
<td> x </td>
<td> x </td>
+ <td> x </td>
</tr>
</table>
<h3>Network functions</h3>
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index cabcdf0..00328e1 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -144,6 +144,10 @@
<a href="storage.html">Storage</a>
<span>Driver for the storage management APIs</span>
</li>
+ <li>
+ <a href="drvvbox.html">VirtualBox</a>
+ <span>Driver for VirtualBox</span>
+ </li>
</ul>
</li>
<li>
--
Libvir-list mailing list
Libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list