[PATCH] hvsupport page documents libvirt versions and supported hypervisor calls (was: Re: request for libvirt documentation improvement)

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




The patch is attached.

The web page will appear at http://libvirt.org/hvsupport.html within an hour or so.

Rich.

--
Emerging Technologies, Red Hat - http://et.redhat.com/~rjones/
Registered Address: Red Hat UK Ltd, Amberley Place, 107-111 Peascod
Street, Windsor, Berkshire, SL4 1TE, United Kingdom.  Registered in
England and Wales under Company Registration No. 03798903
Index: docs/site.xsl
===================================================================
RCS file: /data/cvs/libvirt/docs/site.xsl,v
retrieving revision 1.21
diff -u -r1.21 site.xsl
--- docs/site.xsl	25 Jun 2007 08:40:39 -0000	1.21
+++ docs/site.xsl	29 Jun 2007 12:41:24 -0000
@@ -57,6 +57,9 @@
       <xsl:when test="$name = '#uri'">
         <xsl:text>uri.html</xsl:text>
       </xsl:when>
+      <xsl:when test="$name = '#HVSupport'">
+        <xsl:text>hvsupport.html</xsl:text>
+      </xsl:when>
       <xsl:when test="$name = ''">
         <xsl:text>unknown.html</xsl:text>
       </xsl:when>
Index: docs/libvir.html
===================================================================
RCS file: /data/cvs/libvirt/docs/libvir.html,v
retrieving revision 1.67
diff -u -r1.67 libvir.html
--- docs/libvir.html	25 Jun 2007 08:40:38 -0000	1.67
+++ docs/libvir.html	29 Jun 2007 12:41:26 -0000
@@ -2543,5 +2543,545 @@
 in future.
 </p>
 
+<h2><a name="HVSupport">Hypervisor support</a></h2>
+
+<p>
+This page documents which <a href="html/">libvirt calls</a> work on
+which hypervisors.
+</p>
+
+<p>
+This information changes frequently.  This page was last checked or
+updated on <i>2007-06-29</i>.
+</p>
+
+<h3>Domain functions</h3>
+
+<p> x = not supported; empty cell means no information </p>
+
+<table class="top_table">
+<tr>
+  <th> Function </th>
+  <th> Since </th>
+  <th> Xen </th>
+  <th> QEMU </th>
+  <th> KVM </th>
+  <th> <a href="remote.html">Remote</a> </th>
+</tr>
+
+<tr>
+  <td> virConnectClose </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetCapabilities </td>
+  <td> 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetHostname </td>
+  <td> 0.3.0 </td>
+  <td> &ge; 0.3.0 </td>
+  <td>  </td>
+  <td>  </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetMaxVcpus </td>
+  <td> 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetType </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetURI </td>
+  <td> 0.3.0 </td>
+  <td> &ge; 0.3.0 </td>
+  <td>  </td>
+  <td>  </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectGetVersion </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectListDefinedDomains </td>
+  <td> 0.1.5 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectListDomains </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectNumOfDefinedDomains </td>
+  <td> 0.1.5 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectNumOfDomains </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectOpen </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virConnectOpenReadOnly </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainAttachDevice </td>
+  <td> 0.1.9 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainCoreDump </td>
+  <td> 0.1.9 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainCreate </td>
+  <td> 0.1.5 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainCreateLinux </td>
+  <td> All </td>
+  <td> &ge; 0.0.5 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainDefineXML </td>
+  <td> 0.1.5 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainDestroy </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainDetachDevice </td>
+  <td> 0.1.9 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainFree </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetAutostart </td>
+  <td> 0.2.1 </td>
+  <td> x </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetConnect </td>
+  <td> 0.3.0 </td>
+  <td colspan="4"> not a HV function </td>
+</tr>
+<tr>
+  <td> virDomainGetID </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetInfo </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetMaxMemory </td>
+  <td> All </td>
+  <td> All </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetMaxVcpus </td>
+  <td> 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetName </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetOSType </td>
+  <td> All </td>
+  <td> All </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetSchedulerParameters </td>
+  <td> 0.2.3 </td>
+  <td> &ge; 0.2.3 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetSchedulerType </td>
+  <td> 0.2.3 </td>
+  <td> &ge; 0.2.3 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetUUID </td>
+  <td> 0.1.10 </td>
+  <td> &ge; 0.1.10 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetUUIDString </td>
+  <td> 0.1.10 </td>
+  <td> &ge; 0.1.10 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetVcpus </td>
+  <td> 0.1.4 </td>
+  <td> &ge; 0.1.4 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainGetXMLDesc </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainLookupByID </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainLookupByName </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainLookupByUUID </td>
+  <td> 0.1.10 </td>
+  <td> &ge; 0.1.10 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainLookupByUUIDString </td>
+  <td> 0.1.10 </td>
+  <td> &ge; 0.1.10 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainPinVcpu </td>
+  <td> 0.1.4 </td>
+  <td> &ge; 0.1.4 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainReboot </td>
+  <td> 0.1.0 </td>
+  <td> &ge; 0.1.0 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainRestore </td>
+  <td> All </td>
+  <td> All </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainResume </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSave </td>
+  <td> All </td>
+  <td> All </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSetAutostart </td>
+  <td> 0.2.1 </td>
+  <td> x </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.2.1 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSetMaxMemory </td>
+  <td> All </td>
+  <td> All </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSetMemory </td>
+  <td> 0.1.1 </td>
+  <td> &ge; 0.1.1 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSetSchedulerParameters </td>
+  <td> 0.2.3 </td>
+  <td> &ge; 0.2.3 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSetVcpus </td>
+  <td> 0.1.4 </td>
+  <td> &ge; 0.1.4 </td>
+  <td> x </td>
+  <td> x </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainShutdown </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainSuspend </td>
+  <td> All </td>
+  <td> All </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virDomainUndefine </td>
+  <td> 0.1.5 </td>
+  <td> &ge; 0.1.9 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+<tr>
+  <td> virGetVersion </td>
+  <td> All </td>
+  <td> All </td>
+  <td colspan="3"> Returns -1 if HV unsupported. </td>
+</tr>
+<tr>
+  <td> virInitialize </td>
+  <td> 0.1.0 </td>
+  <td colspan="4"> not a HV function </td>
+</tr>
+<tr>
+  <td> virNodeGetInfo </td>
+  <td> 0.1.0 </td>
+  <td> &ge; 0.1.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.2.0 </td>
+  <td> &ge; 0.3.0 </td>
+</tr>
+</table>
+
+<h3>Network functions</h3>
+
+<p>
+Network functions are not hypervisor-specific.  For historical
+reasons they require the QEMU daemon to be running (this
+restriction may be lifted in future).  Most network functions
+first appeared in libvirt 0.2.0.
+</p>
+
+<table class="top_table">
+<tr>
+<th> Function </th>
+<th> Since </th>
+</tr>
+
+<tr>
+  <td> virConnectNumOfNetworks </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virConnectListNetworks </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virConnectNumOfDefinedNetworks </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virConnectListDefinedNetworks </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkCreate </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkCreateXML </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkDefineXML </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkDestroy </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkFree </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetAutostart </td> <td> 0.2.1 </td>
+</tr>
+<tr>
+  <td> virNetworkGetConnect </td> <td> 0.3.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetBridgeName </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetName </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetUUID </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetUUIDString </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkGetXMLDesc </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkLookupByName </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkLookupByUUID </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkLookupByUUIDString </td> <td> 0.2.0 </td>
+</tr>
+<tr>
+  <td> virNetworkSetAutostart </td> <td> 0.2.1 </td>
+</tr>
+<tr>
+  <td> virNetworkUndefine </td> <td> 0.2.0 </td>
+</tr>
+</table>
+
 </body>
 </html>

Attachment: smime.p7s
Description: S/MIME Cryptographic Signature


[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]